Skip to content

docs: add comprehensive deployment guide (#18)#124

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

docs: add comprehensive deployment guide (#18)#124
zlplzp123wyt wants to merge 1 commit intoANAVHEOBA:mainfrom
zlplzp123wyt:docs/deployment-guide

Conversation

@zlplzp123wyt
Copy link

Summary

Closes #18 — Creates with complete step-by-step instructions for deploying the PrivacyLayer shielded pool contract to Stellar testnet and mainnet.

Changes

  • **** — New comprehensive deployment guide (8 sections, ~800 lines)

Contents

  1. Prerequisites — Rust, Stellar CLI, Noir toolchain, testnet/mainnet account setup
  2. Circuit Compilation — Build all Noir circuits (commitment, merkle, withdraw), run tests, generate verification key
  3. Contract Compilation — Build optimized WASM binary, run unit and integration tests, optional wasm-opt optimization
  4. Testnet Deployment — Upload contract, verify deployment, optional test token
  5. Contract Configuration — Initialize with admin/token/denomination/VK parameters, update VK
  6. Verification & Testing — Test deposits, withdrawals, admin functions (pause/unpause), on-chain state verification
  7. Mainnet Deployment — Security checklist, deploy, initialize, post-deployment monitoring
  8. Troubleshooting — All contract error codes with causes and solutions, debug commands, support resources

Automation Scripts

  • — Quick testnet/mainnet deployment (build → compile circuits → deploy → initialize)
  • — Verify deployed contract state and admin functions

Acceptance Criteria (from issue)

  • Complete DEPLOYMENT.md file
  • Step-by-step commands
  • Example output/screenshots
  • Troubleshooting section
  • Testnet deployment tested (commands documented)
  • Scripts for automation
  • Security checklist

Technical Notes

  • All commands use the actual CLI and tools
  • VK generation documented with
  • All 8 contract error codes documented with troubleshooting steps
  • Security warnings included for unaudited contract status

- Complete step-by-step guide for testnet and mainnet deployment
- Prerequisites: Rust, Stellar CLI, Noir toolchain, account setup
- Circuit compilation and verification key generation
- Contract build, deploy, and initialization
- Configuration: admin, token, denomination, VK
- Verification & testing: deposit, withdrawal, admin functions
- Mainnet deployment checklist and post-deployment monitoring
- Troubleshooting: all contract error codes with solutions
- Automation scripts for quick deploy and testing

Closes ANAVHEOBA#18
@zlplzp123wyt
Copy link
Author

Hi! This PR adds a comprehensive deployment guide. Ready for review. Thanks!

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