docs: add end-to-end integration walkthrough for embedding the SDK - #169
docs: add end-to-end integration walkthrough for embedding the SDK#169latiblack wants to merge 2 commits into
Conversation
Expands docs/INTEGRATION.md with a complete, copy-paste walkthrough covering install -> create round -> commit sealed bid -> open reveal -> settle -> export receipt. Changes: - Full numbered walkthrough with runnable snippets (install, configure, deploy, create round, seal+commit, keeper reveal, clear+settle, export+verify receipt) - Notes on required env/keys and testnet vs mainnet - Keeper service usage guide - Cross-linked from README.md Integration model section - All local links verified via scripts/check-links.js Closes Sub-Rosa-Issue#156
karagozemin
left a comment
There was a problem hiding this comment.
Changes requested: the walkthrough is link-clean but the core copy-paste path is not runnable as written.\n\n- configures testnet RPC/passphrase with , which the repository documents as the mainnet deployment. A reader following the example will query a contract that does not exist on testnet.\n- passes the classic USDC issuer account () as the constructor value and labels it a SAC. The round contract needs the deployed SEP-41 asset contract ID (), otherwise escrow token calls cannot work.\n- tells users to install and invoke through , but is private and defines no entry. That command cannot run.\n\nPlease base the deployment/lifecycle snippets on the existing live scripts and either provide real per-network values or explicit placeholders plus the exact commands that derive them. External links: 5 (pass --external to list)
OK 38 local link(s) checked, 0 allowlisted passes (42 local links), but it cannot catch these executable-example errors.
Replaced because Markdown was corrupted during submission.
karagozemin
left a comment
There was a problem hiding this comment.
Changes requested: the walkthrough is link-clean but the core copy-paste path is not runnable as written.
docs/INTEGRATION.md:64configures testnet RPC/passphrase withCA7KS..., which the repository documents as the mainnet deployment. A reader following the example will query a contract that does not exist on testnet.docs/INTEGRATION.md:109passes the classic USDC issuer account (G...) as the constructorusdcvalue and labels it a SAC. The round contract needs the deployed SEP-41 asset contract ID (C...), otherwise escrow token calls cannot work.docs/INTEGRATION.md:383-390tells users to install and invoke@sub-rosa/keeperthroughnpx sub-rosa-keeper, butservices/keeper/package.jsonis private and defines nobinentry. That command cannot run.
Please base the deployment/lifecycle snippets on the existing live scripts and either provide real per-network values or explicit placeholders plus the exact commands that derive them. node scripts/check-links.js passes (42 local links), but it cannot catch these executable-example errors.
|
Rechecked the current head ( |
- Fix contractId in §2: use placeholder <DEPLOYED_CONTRACT_ID> with note that CA7KS... is mainnet-only (was showing mainnet ID on testnet RPC) - Fix USDC SAC in §3 deploy snippet: use CAPTODB... (C-prefix testnet SAC) instead of GBBD47... (G-prefix classic issuer) - Fix keeper section in §9: use pnpm keeper:watch from monorepo root instead of npm install + npx (keeper is private, no bin entry) - Fix USDC addresses reference table same issuer→SAC fix
|
Hey @karagozemin, thanks for the review. All three issues have been addressed:
Should be runnable as written now. |
- Fix contractId in §2: use placeholder <DEPLOYED_CONTRACT_ID> with note that CA7KS... is mainnet-only (was showing mainnet ID on testnet RPC) - Fix USDC SAC in §3 deploy snippet: use CAPTODB... (C-prefix testnet SAC) instead of GBBD47... (G-prefix classic issuer) - Fix keeper section in §9: use pnpm keeper:watch from monorepo root instead of npm install + npx (keeper is private, no bin entry) - Fix USDC addresses reference table same issuer→SAC fix
e91385f to
d33c1d2
Compare
Expands docs/INTEGRATION.md with a complete, copy-paste walkthrough covering install -> create round -> commit sealed bid -> open reveal -> settle -> export receipt.
Changes:
Closes #156