Skip to content

docs(contracts): add end-to-end local sandbox guide and make target - #2068

Open
maxx-GENIUS wants to merge 1 commit into
DistinctCodes:mainfrom
maxx-GENIUS:docs/contracts-local-sandbox
Open

maxx-GENIUS wants to merge 1 commit into
DistinctCodes:mainfrom
maxx-GENIUS:docs/contracts-local-sandbox

Conversation

@maxx-GENIUS

@maxx-GENIUS maxx-GENIUS commented Oct 26, 2026 •

Copy link
Copy Markdown

Problem

Currently, contributors who want to test or interact with the Soroban smart contracts (payment_escrow) must rely on the public testnet, which introduces network latency, rate limits, and faucet dependencies. Furthermore, there was no documented example or sandbox setup showing how to configure the backend's Soroban settings (SOROBAN_ENABLED=true, STELLAR_NETWORK, RPC URLs, and secret keys) for local development.

Solution

  1. Created contracts/LOCAL.md:

    • Comprehensive end-to-end local sandbox documentation covering architecture, endpoints, and prerequisites (docker, stellar-cli, Rust wasm32-unknown-unknown).
    • Automated sandbox instructions via make sandbox.
    • Step-by-step manual walkthrough: starting the Stellar Quickstart container in standalone mode, configuring the CLI network, funding identities, deploying payment_escrow, initializing the admin, resolving native asset contract IDs, and executing the create -> get_status (1 = LOCKED) -> release -> get_status (2 = RELEASED) lifecycle.
    • Complete backend .env configuration guide and instructions for pointing testnet-integration.spec.ts at the local sandbox.
  2. Added make sandbox Target & Script:

    • Added sandbox target in root Makefile invoking contracts/scripts/sandbox.sh.
    • contracts/scripts/sandbox.sh automates container lifecycle (--stop supported), RPC health checks, identity funding, contract deployment, invocations, and cleanly outputs .env lines.
  3. Documentation Updates:

    • Updated contracts/README.md tooling reference.
    • Added entry to contracts/CHANGELOG.md under ### Added.

Closes #2027

Add `contracts/LOCAL.md` and a root `make sandbox` target with automated
script `contracts/scripts/sandbox.sh` to spin up a standalone Stellar
Quickstart Docker container, configure local CLI networks, fund test
identities, build and deploy `payment_escrow`, execute sample `create`
and `release` invocations, and print copy-pasteable `.env` lines for the
backend Soroban configuration.

Closes DistinctCodes#2027
@vercel

vercel Bot commented Oct 26, 2026

Copy link
Copy Markdown

@maxx-GENIUS is attempting to deploy a commit to the naijabuz's projects Team on Vercel.

A member of the Team first needs to authorize it.

This branch has not been deployed

No deployments
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.

Add an end-to-end local sandbox for contracts (standalone network, deploy, call) to the repo docs

1 participant