Skip to content

docs: add CLAUDE.md development guide #121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
leozc wants to merge 84 commits into from
Closed

docs: add CLAUDE.md development guide #121

leozc wants to merge 84 commits into from

Conversation

@leozc
Copy link
Contributor

@leozc leozc commented Jun 29, 2025

Summary

  • Added comprehensive CLAUDE.md development guide for AI assistants
  • Documents project structure, build process, and common workflows
  • Helps Claude AI understand and work effectively with the ChainStorage codebase

Changes

  • Created CLAUDE.md with:
    • Project overview and quick start guide
    • Build, test, and lint commands
    • Architecture insights including client patterns and supported blockchains
    • Local development setup instructions
    • Common development workflows and tasks

Test plan

  • Verified markdown formatting
  • Tested all documented commands during guide creation
  • Successfully built the project following the guide
  • Ran unit tests to verify test commands

🤖 Generated with Claude Code

ImNumber4 and others added 30 commits January 24, 2024 19:36
@ImNumber4
fix reportingInterval for tally
fc307da
@ImNumber4
switch to log.debug for success with filter case
8512a5b
@HenryYYang
Merge remote-tracking branch 'upstream/master'
219f43a
@HenryYYang
fix broken workflow
14f2192
@HenryYYang
fix broken workflow
d7c72a5
@leozc
Merge branch 'coinbase:master' into master
11f2b57
@leozc
Merge branch 'coinbase:master' into master
0a12563
@aegis-cipherowl
fix merge error for workflow
4f394ca
@aegis-cipherowl
Merge pull request #3 from cipherowl-ai/fix_merge_error
ccba1e0 
fix merge error for workflow
@samsuse
TIT-157 Support BCH and LTC
65ac455
@samsuse
Support ltc mweb address type
bb741c2
@samsuse
validate ltc script pubkey
d262ccd
add metrics for replicator
d174bd6
Figure out the gap and timeSinceLastBlock in replicator execution pha…
a1f4a94 
…se 3
update watermark
cd19fad
@samsuse
TIT-158 Continuous sync replicator
6a844c3
involve channel
af50ed5
fix updateWatermark bug
7bb4cdf
@samsuse
Add new activity to fetch latest block
08fa6ca
@samsuse
Add logger
81cdad9
@samsuse
Fix nil pointer
bf13d3d
@BarryLiii
Merge pull request #6 from cipherowl-ai/replicator-metrics
9393c5a 
Add metrics for replicator
@samsuse
Merge pull request #4 from cipherowl-ai/TIT-157-support-bch-and-ltc
f7dcdc2 
TIT-157 Support BCH and LTC
@samsuse
Review issue fixes
ec2ddce
@samsuse
Merge remote-tracking branch 'origin/master' into TIT-158-continuous-…
6f455ac 
…replicator

# Conflicts:
#	internal/workflow/replicator.go
@samsuse
Reformat code
e1197df
@samsuse
Merge pull request #8 from cipherowl-ai/TIT-158-continuous-replicator
7178a3a 
TIT-158 continuous replicator
@xiaying-peng @aegis-cipherowl
Update README.md (coinbase#103)
07f75a4 
Signed-off-by: Henry Yang <henry.yang@cipherowl.com>
@wangwzhou @aegis-cipherowl
feat: Remove sdk address (coinbase#105)
9b19f71 
* Remove sdk address
@wangwzhou @aegis-cipherowl
feat: Port ethereum beacon support (coinbase#104)
886793e 
* Port ethereum beacon support
samsuse and others added 27 commits March 10, 2025 14:15
@samsuse
uncomment failed test
7c4feaf
@PikaZ76
add fields for TransactionReceipt of Tron;
2493d39 
add test case for Tron address convertion;
@leozc
Merge pull request #27 from PikaZ76/fix/add_tron_fields
12a008e 
Fix/add tron fields
@leozc
Merge pull request #24 from cipherowl-ai/circleci-pipeline
62edbdb 
INF-59 Integrate with CircleCI
@PikaZ76
merge latest from coinbase repo
02cab46
@PikaZ76
fix tron error check
6d8b58b
@PikaZ76
Merge pull request #28 from PikaZ76/sync-coinbase
3380eeb 
Merged latest upstream changes from Coinbase
@BarryLiii
start multiple backfiller
49aaae0
@BarryLiii
Merge pull request #26 from cipherowl-ai/start-multiple-bf
150569e 
Enable support for launching multiple backfillers concurrently
@samsuse
fix ci issues
2cb73ca
@samsuse
Merge pull request #29 from cipherowl-ai/fix-ci-issues
6a42458 
Resolve CircleCI build failures
@zhanwu
use python grpcio-tools to generate python code
71b347b
@zhanwu
Merge pull request #30 from cipherowl-ai/python
072e4c2 
use python grpcio-tools to generate python code
@PikaZ76
fix overwrite bug in Tron Nativate Parser
bc6280d
@PikaZ76
Merge pull request #32 from PikaZ76/fix/TronMetaDataBlockHash
094136d 
fix overwrite bug in Tron Nativate Parser
@samsuse
Validate Anchor Type
c3a8f49
@aegis-cipherowl
replace github.com/coinbase/rosetta-sdk-go with github.com/coinbase/m…
b5f400b 
…esh-sdk-go
@aegis-cipherowl
fix codegen
3ca0283
@aegis-cipherowl
Merge pull request #34 from cipherowl-ai/fix-rosett-to-mesh
5e74433 
replace github.com/coinbase/rosetta-sdk-go with github.com/coinbase/m…
@samsuse
Merge pull request #33 from cipherowl-ai/Validate-PayToAnchor
d0bad9a 
APP-912 Validate anchor pubKey type
@samsuse
fix-vuls
250f5e6
@dnjp
feat(tally): add prometheus metrics reporter
a840823
@aegis-cipherowl
Merge pull request #36 from dnjp/feat/prometheus-reporter
9336fed 
feat(tally): add prometheus metrics reporter
@leozc
Merge pull request #35 from cipherowl-ai/fix-vuls
0855fb6 
Fix critical vulnerabilities
@PikaZ76
fix tron parser of internal Tx for only native token
ab92867
@PikaZ76
Merge pull request #37 from cipherowl-ai/fix/TronNativeTokenInInternalTx
c4537d4 
fix tron parser of internal Tx for only native token
@leozc @claude
docs: add CLAUDE.md development guide
5807490 
Add comprehensive development guide for Claude AI assistant to understand
the ChainStorage project structure, build process, and common workflows.

The guide includes:
- Project overview and architecture insights
- Build and test commands
- Local development setup instructions
- Common development tasks and workflows
- Supported blockchains and design patterns

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
@leozc leozc requested a review from a team as a code owner June 29, 2025 04:03
@cb-heimdall
Copy link
Collaborator

cb-heimdall commented Jun 29, 2025 •
edited
Loading

🟡 Heimdall Review Status

Requirement Status More Info
Reviews 🟡 0/1
Denominator calculation
Show calculation
1 if user is bot 0
1 if user is external 0
2 if repo is sensitive 0
From .codeflow.yml 1
Additional review requirements
Show calculation
Max 0
0
From CODEOWNERS 0
Global minimum 0
Max 1
1
1 if commit is unverified 0
Sum 1

@leozc leozc closed this Jun 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.