Skip to content

docs: add comprehensive deployment guide#221

Open
wocaoac-cpu wants to merge 1 commit intoANAVHEOBA:mainfrom
wocaoac-cpu:docs/deployment-guide
Open

docs: add comprehensive deployment guide#221
wocaoac-cpu wants to merge 1 commit intoANAVHEOBA:mainfrom
wocaoac-cpu:docs/deployment-guide

Conversation

@wocaoac-cpu
Copy link
Copy Markdown

Summary

  • Add docs/DEPLOYMENT.md with complete step-by-step deployment instructions for the PrivacyLayer privacy pool contract
  • Covers the full deployment lifecycle: prerequisites, circuit compilation, contract compilation, testnet deployment, initialization, configuration, verification, mainnet deployment, and troubleshooting
  • Includes security checklist for mainnet deployment and complete error code reference table

Document Structure

  1. Prerequisites -- Rust/Cargo, Stellar CLI, Noir toolchain, funded testnet account
  2. Circuit Compilation -- Compile all Noir circuits, generate verification keys, export artifacts
  3. Contract Compilation -- Build WASM binary, optimize for size, run tests, generate contract hash
  4. Testnet Deployment -- Deploy contract, initialize with parameters, verify deployment
  5. Configuration -- Admin address, denominations, verifying key updates
  6. Verification -- Test deposit, test withdrawal, verify events and contract state
  7. Mainnet Deployment -- Security checklist, audit requirements, deployment steps, post-deployment verification
  8. Troubleshooting -- Error code table, debug commands, build failure fixes, support resources

Acceptance Criteria

  • Complete DEPLOYMENT.md file
  • Step-by-step commands for every operation
  • Example output for key commands
  • Troubleshooting section with error codes and solutions
  • Security checklist for mainnet deployment
  • All CLI commands use actual stellar contract syntax

Closes #18

Add docs/DEPLOYMENT.md with step-by-step instructions for deploying the
PrivacyLayer privacy pool contract to Stellar Soroban testnet and mainnet.

Covers prerequisites, circuit compilation, contract compilation, testnet
deployment, contract initialization, configuration, verification with
test deposit/withdrawal, mainnet security checklist, and troubleshooting.

Closes ANAVHEOBA#18
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.

[BOUNTY] Create Comprehensive Deployment Guide

1 participant