docs: add contract build, deployment & invocation guide #467 - #535
Open
SMOGZ6783 wants to merge 1 commit into
Open
docs: add contract build, deployment & invocation guide #467#535SMOGZ6783 wants to merge 1 commit into
SMOGZ6783 wants to merge 1 commit into
Conversation
|
@SMOGZ6783 Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
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
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.
Overview
This PR adds a practical, end-to-end Contract Build, Deployment & Invocation Guide for the three Soroban contracts in this repository (
token_transfer,group_treasury,proposals), using the exact tooling the repo pins (contracts/rust-toolchain.toml, Stellar CLI, and the deploy scripts incontracts/scripts/).Related Issue
Closes #467
Changes
📖 Deployment & Invocation Guide
contracts/docs/api-deployment-invocation.mdstellar contract upload/deployand the repo's deploy scripts (testnet), including contract ID capture.token_transfer(transfer/balance/upgrade),group_treasury(deposits, member proposals, voting), andproposals(create → vote → finalize → execute → treasury withdraw).NEXT_PUBLIC_*env vars inapps/web/src/lib/soroban.ts) and backend (TOKEN_TRANSFER_CONTRACT_ID,GROUP_TREASURY_CONTRACT_ID,PROPOSALS_CONTRACT_IDinapps/backend/src/config.ts).RPC_URLvsSTELLAR_RPC_URL, frontend vs backend variable names) and a reference section for scripts, sources, and CI.Verification Results
Acceptance Criteria
Status
Practical build + deploy + invoke guide for the three contracts
✅ Commands, scripts, and expected outputs documented end-to-end
Uses the repo's actual tooling (Stellar CLI, pinned Rust toolchain)
✅ Pinned versions and install links included
Contract ID wiring to frontend & backend documented
✅ Env-var flow explained with config drift notes