Skip to content

chore: document Soroban smart contracts deployment and usage #512

Description

@dotunv

Problem

The smart contract documentation is minimal:

  • contracts/soroban/README.md is generic boilerplate (references a hello_world example that no longer exists)
  • No documentation on contract initialization parameters
  • No documentation on cross-contract call flow (escrow ↔ milestones)
  • No mainnet deployment guide
  • No deployment checklist or rollback procedure

Current State

  • 3 contracts: crowdpay, escrow, milestones
  • crowdpay contract appears unused by the backend (only escrow and milestones are deployed)
  • deploy_crowdpay.sh deploys crowdpay but nothing consumes it
  • backend/src/scripts/deployContracts.js deploys escrow and milestones
  • milestones contract is missing a Makefile

What to Document

  1. Contract architecture and relationships
  2. Initialization parameters for each contract
  3. Cross-contract call flow
  4. Deployment steps (testnet and mainnet)
  5. Contract upgrade/rollback procedures
  6. Whether crowdpay contract should be deprecated or integrated
  7. Add Makefile for milestones contract

Activity

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

Metadata

Metadata

Assignees

Labels

Stellar WaveIssues in the Stellar wave programchoreChore / maintenancemedium-priorityMedium priority

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions