diff --git a/docs/deployments.md b/docs/deployments.md index 164d25e..97b548f 100644 --- a/docs/deployments.md +++ b/docs/deployments.md @@ -2,6 +2,11 @@ Deployed contract addresses for each environment. Update this file after every deployment. +> **Placeholder convention:** Values shown as `` have not been filled in yet +> and must be replaced with the real 56-character Stellar contract ID (starting with `C`) +> before the environment is functional. Values shown as `_(not yet deployed)_` mean the +> contract has never been deployed to that network. + --- ## Staging (Testnet) @@ -22,12 +27,27 @@ Explorer: `https://stellar.expert/explorer/testnet/contract/` | Contract | Contract ID | Deployed At | Deployed By | |---|---|---|---| -| `energy_token` | _(set after first deploy)_ | — | — | -| `audit_registry` | _(set after first deploy)_ | — | — | -| `community_governance` | _(set after first deploy)_ | — | — | +| `energy_token` | `` | — | — | +| `audit_registry` | `` | — | — | +| `community_governance` | `` | — | — | Explorer: `https://stellar.expert/explorer/testnet/contract/` +### Required environment variables (testnet) + +After deploying, set the following in your `.env.local` (see `.env.example`): + +```env +NEXT_PUBLIC_STELLAR_NETWORK=testnet +NEXT_PUBLIC_STELLAR_RPC_URL=https://soroban-testnet.stellar.org +NEXT_PUBLIC_ENERGY_TOKEN_ID= +NEXT_PUBLIC_AUDIT_REGISTRY_ID= +NEXT_PUBLIC_COMMUNITY_GOVERNANCE_ID= +MINTER_SECRET_KEY= +``` + +--- + ## Mainnet | Contract | Contract ID | Deployed At | Deployed By | @@ -38,6 +58,20 @@ Explorer: `https://stellar.expert/explorer/testnet/contract/` Explorer: `https://stellar.expert/explorer/public/contract/` +### Required environment variables (mainnet) + +```env +NEXT_PUBLIC_STELLAR_NETWORK=mainnet +NEXT_PUBLIC_STELLAR_RPC_URL=https://soroban-rpc.stellar.org +NEXT_PUBLIC_ENERGY_TOKEN_ID= +NEXT_PUBLIC_AUDIT_REGISTRY_ID= +NEXT_PUBLIC_COMMUNITY_GOVERNANCE_ID= +MINTER_SECRET_KEY= +``` + +> ⚠️ Mainnet deployments are irreversible. Use a hardware wallet or HSM-backed key. +> Never commit real secret keys — use GitHub Actions secrets in CI/CD. + --- > **How to update this file:** After running the deploy workflow (or manual deploy steps below), paste the contract IDs returned by `stellar contract deploy` into the table above and commit the change.