Skip to content

docs: clarify contract ID placeholders and env vars in deployments.md #673

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AnnabelJoe merged 2 commits into from
Jun 27, 2026
+37 −3
Merged

docs: clarify contract ID placeholders and env vars in deployments.md #673

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eae9101
docs: clarify contract ID placeholders and env vars in deployments.md
ZainabJanee Jun 26, 2026
de51d6a
Merge branch 'main' into fix/522-deployment-docs
AnnabelJoe Jun 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 37 additions & 3 deletions docs/deployments.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

Deployed contract addresses for each environment. Update this file after every deployment.

> **Placeholder convention:** Values shown as `<PLACEHOLDER>` 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)
Expand All @@ -22,12 +27,27 @@ Explorer: `https://stellar.expert/explorer/testnet/contract/<CONTRACT_ID>`

| 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` | `<TESTNET_ENERGY_TOKEN_ID>` | — | — |
| `audit_registry` | `<TESTNET_AUDIT_REGISTRY_ID>` | — | — |
| `community_governance` | `<TESTNET_COMMUNITY_GOVERNANCE_ID>` | — | — |

Explorer: `https://stellar.expert/explorer/testnet/contract/<CONTRACT_ID>`

### 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=<TESTNET_ENERGY_TOKEN_ID>
NEXT_PUBLIC_AUDIT_REGISTRY_ID=<TESTNET_AUDIT_REGISTRY_ID>
NEXT_PUBLIC_COMMUNITY_GOVERNANCE_ID=<TESTNET_COMMUNITY_GOVERNANCE_ID>
MINTER_SECRET_KEY=<your-testnet-deployer-secret>
```

---

## Mainnet

| Contract | Contract ID | Deployed At | Deployed By |
Expand All @@ -38,6 +58,20 @@ Explorer: `https://stellar.expert/explorer/testnet/contract/<CONTRACT_ID>`

Explorer: `https://stellar.expert/explorer/public/contract/<CONTRACT_ID>`

### 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=<MAINNET_ENERGY_TOKEN_ID>
NEXT_PUBLIC_AUDIT_REGISTRY_ID=<MAINNET_AUDIT_REGISTRY_ID>
NEXT_PUBLIC_COMMUNITY_GOVERNANCE_ID=<MAINNET_COMMUNITY_GOVERNANCE_ID>
MINTER_SECRET_KEY=<your-mainnet-deployer-secret>
```

> ⚠️ 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.
Expand Down
Loading