Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive documentation for all INTMAX2 network nodes, providing detailed API references, architectural overviews, and setup instructions for each service component.
- API Documentation: Complete endpoint documentation with request/response schemas
- Architecture Diagrams: Mermaid diagrams showing service interactions and data flows
- Configuration Guides: Environment setup and deployment instructions
Reviewed Changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| withdrawal-server/README.md | Comprehensive docs for withdrawal/claim processing server with API endpoints, database schema, and validation logic |
| validity-prover/README.md | Detailed documentation for blockchain state monitoring, merkle tree management, and ZKP generation service |
| validity-prover-worker/README.md | Documentation for distributed proof generation worker with Redis task management |
| store-vault-server/README.md | Architecture overview for S3-based data storage service with snapshot/historical data handling |
| legacy-store-vault-server/README.md | Documentation for database-backed storage service for local development |
| interfaces/README.md | Complete interface documentation covering API traits, data structures, and utility functions |
| client-sdk/README.md | Comprehensive SDK documentation with strategy engine architecture and usage examples |
| block-builder/README.md | Detailed docs for transaction collection, block construction, and Redis-based coordination |
| balance-prover/README.md | Documentation for stateless ZK proof generation service with circuit descriptions |
|
|
||
| ## Strategy Engine | ||
|
|
||
| The Strategy Engine determines the sequence to incorporate transactions, deposits, and withdrawals into the user state. It ensures that all operations are processed in a consistent order while maintaining the integrity of user balances. |
There was a problem hiding this comment.
The description should clarify what 'consistent order' means in practice. Consider adding that the order is determined by block numbers and timestamps to ensure deterministic state reconstruction.
Suggested change
| The Strategy Engine determines the sequence to incorporate transactions, deposits, and withdrawals into the user state. It ensures that all operations are processed in a consistent order while maintaining the integrity of user balances. | |
| The Strategy Engine determines the sequence to incorporate transactions, deposits, and withdrawals into the user state. It ensures that all operations are processed in a consistent order, where the order is determined by block numbers and timestamps. This mechanism guarantees deterministic state reconstruction while maintaining the integrity of user balances. |
smallbabybear
approved these changes
Oct 29, 2025
signature18632
added a commit
that referenced
this pull request
Oct 31, 2025
* feat: Integrated gnark (#448) * chore: update intmax2-zkp deps * feat: delete circuit dependency * feat: add some data * docs: update readme & testdata * chore: update proof * chore: fix limb error * Single history status (#453) * feat: entry status replace * feat: wip strategy replacement * feat: impl seperate group * feat: optional cursor * feat: impl fetch batch * feat: impl fetch batch wasm --------- Co-authored-by: kbizikav <132550763+kbizikav@users.noreply.github.com> * change os (#458) * feat: add get used memo func for wasm (#469) * feat: add get used memo func for wasm * fix: fix typo for ci * docs: added comprehensive docs for all nodes (#446) * chore: update docs * docs: add block builder docs * docs: add balance prover readme * docs: client sdk * docs: fix client sdk docs * docs: add validity prover docs * docs: add block builder data structure * docs: update block builder * docs: add withdrawal server docs * docs: add validity prover worker tasks * docs: delete legacy store vault server * docs: add pruning docs * docs: update validity prover docs * docs: update * docs: interface * docs: add Troubleshooting * fix: add membership verification during `add_signature` (#465) * fix: add membership verification during add_signature to prevent future panic * Update block-builder/src/app/storage/memory_storage.rs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update block-builder/src/app/storage/memory_storage.rs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * fix: typo for ci --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * feat: add rate limit & reduce max batch size (#464) * feat: add rate limit & reduce max batch size * feat: use wasm time * feat: longer rate limit * feat: remove AGENTS.md * fix: typo * Retry 502 error (#470) --------- Co-authored-by: Baby Bear <132609968+smallbabybear@users.noreply.github.com> --------- Co-authored-by: kbizikav <132550763+kbizikav@users.noreply.github.com> Co-authored-by: signature18632 <intmax18@gmail.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
signature18632
added a commit
that referenced
this pull request
Nov 13, 2025
* feat: Integrated gnark (#448) * chore: update intmax2-zkp deps * feat: delete circuit dependency * feat: add some data * docs: update readme & testdata * chore: update proof * chore: fix limb error * Single history status (#453) * feat: entry status replace * feat: wip strategy replacement * feat: impl seperate group * feat: optional cursor * feat: impl fetch batch * feat: impl fetch batch wasm --------- Co-authored-by: kbizikav <132550763+kbizikav@users.noreply.github.com> * change os (#458) * feat: add get used memo func for wasm (#469) * feat: add get used memo func for wasm * fix: fix typo for ci * docs: added comprehensive docs for all nodes (#446) * chore: update docs * docs: add block builder docs * docs: add balance prover readme * docs: client sdk * docs: fix client sdk docs * docs: add validity prover docs * docs: add block builder data structure * docs: update block builder * docs: add withdrawal server docs * docs: add validity prover worker tasks * docs: delete legacy store vault server * docs: add pruning docs * docs: update validity prover docs * docs: update * docs: interface * docs: add Troubleshooting * fix: add membership verification during `add_signature` (#465) * fix: add membership verification during add_signature to prevent future panic * Update block-builder/src/app/storage/memory_storage.rs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update block-builder/src/app/storage/memory_storage.rs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * fix: typo for ci --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * feat: add rate limit & reduce max batch size (#464) * feat: add rate limit & reduce max batch size * feat: use wasm time * feat: longer rate limit * feat: remove AGENTS.md * fix: typo * Retry 502 error (#470) --------- Co-authored-by: Baby Bear <132609968+smallbabybear@users.noreply.github.com> * fix(client): consume only invalid (#473) --------- Co-authored-by: kbizikav <132550763+kbizikav@users.noreply.github.com> Co-authored-by: signature18632 <intmax18@gmail.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.