Skip to content

deployment-strategy.md

Latest commit

 

History

History
64 lines (47 loc) · 2.27 KB

deployment-strategy.md

File metadata and controls

64 lines (47 loc) · 2.27 KB
Raw

Deployment Strategy

This document describes how LineProof should move from local development to public networks. It is a maintainer runbook, not a claim that production deployments are complete.

Environments

Environment Purpose Requirements
Localnet Fast contract development and SDK integration tests. Docker Compose, Soroban CLI, local identities.
Testnet Public integration testing and pilot queues. Funded testnet accounts, published contract IDs, event monitoring.
Mainnet Production queues for real resources. Audited contracts, multisig admin, release checklist, monitoring.

Local Deployment

make docker-up
make deploy-localnet
make test

Local deployment should produce contract IDs, funded identities, and a repeatable way to reset state with make docker-clean.

Testnet Deployment

Before testnet deployment:

  • Run contract tests and SDK tests.
  • Build release WASM artifacts.
  • Record the git commit, contract checksums, and deployment identities.
  • Publish factory and contract IDs in a release note or deployment manifest.
  • Verify event indexing from at least one independent consumer.

Mainnet Readiness Checklist

  • Independent security review completed.
  • CHANGELOG.md updated with release notes.
  • SECURITY.md disclosure process confirmed.
  • Admin authority controlled by multisig or equivalent governance.
  • Contract upgrade path documented.
  • Escrow flows tested with realistic assets and failure modes.
  • Privacy review confirms no personal data is written on-chain.
  • Incident response contacts and rollback limits are documented.

Deployment Artifacts

Each deployment should record:

  • Network passphrase.
  • Contract IDs.
  • WASM hashes.
  • Deployer address.
  • Admin or governance address.
  • SDK version expected to support the deployment.
  • Known limitations and migration notes.

Rollback and Migration

Smart contract deployments are not rolled back like web services. If a contract version is defective, maintainers should:

  1. Pause new queues when the contract supports pausing.
  2. Publish an advisory with affected contract IDs.
  3. Deploy a fixed implementation.
  4. Migrate only state that has an explicit, audited migration path.
  5. Preserve historical event logs for auditability.