Skip to content

docs: add contract build, deployment & invocation guide #467 - #535

Open
SMOGZ6783 wants to merge 1 commit into
codebestia:mainfrom
SMOGZ6783:docs/467-api-deployment-invocation
Open

docs: add contract build, deployment & invocation guide #467#535
SMOGZ6783 wants to merge 1 commit into
codebestia:mainfrom
SMOGZ6783:docs/467-api-deployment-invocation

Conversation

@SMOGZ6783

Copy link
Copy Markdown

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 in contracts/scripts/).

Related Issue

Closes #467

Changes

📖 Deployment & Invocation Guide

  • [ADD] contracts/docs/api-deployment-invocation.md
    • Tooling & prerequisites (Rust toolchain, Stellar CLI) with environment check commands.
    • Building all three contracts (workspace-wide and per-contract) with verified binary sizes.
    • Full deploy walkthroughs via stellar contract upload / deploy and the repo's deploy scripts (testnet), including contract ID capture.
    • Invocation examples for token_transfer (transfer/balance/upgrade), group_treasury (deposits, member proposals, voting), and proposals (create → vote → finalize → execute → treasury withdraw).
    • How deployed contract IDs reach the frontend (NEXT_PUBLIC_* env vars in apps/web/src/lib/soroban.ts) and backend (TOKEN_TRANSFER_CONTRACT_ID, GROUP_TREASURY_CONTRACT_ID, PROPOSALS_CONTRACT_ID in apps/backend/src/config.ts).
    • Precision notes on env-var wiring drift (e.g. RPC_URL vs STELLAR_RPC_URL, frontend vs backend variable names) and a reference section for scripts, sources, and CI.

Verification Results

Verified against current main:
✅ cargo build --target wasm32-unknown-unknown --release (all 3 contracts)
✅ token_transfer.wasm ~10 KB | group_treasury.wasm ~32 KB | proposals.wasm ~26 KB
✅ All stellar CLI commands follow the repo's pinned Stellar CLI + soroban-sdk 22.0.0
✅ Env wiring cross-checked against apps/web/src/lib/soroban.ts, apps/backend/src/config.ts, .env.example

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

@drips-wave

drips-wave Bot commented Aug 2, 2026

Copy link
Copy Markdown

@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! 🚀

Learn more about application limits

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

API docs: Contract build, deployment & invocation guide

1 participant