Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 2 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@ We follow a **Feature-Branch-to-Main** workflow. All development work should hap

If you're new to the codebase, start with:
- `docs/wiki/README.md` (high-level contributor wiki)
- `ARCHITECTURE.md` (system overview).
- `ARCHITECTURE.md` (system overview)
- `docs/deployed-contracts.md` (testnet/mainnet contract IDs and the env vars that consume them).

```mermaid
graph TD
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ The repository is organized as a monorepo containing three core packages:

*For a detailed look at how these components interact, see our [Architecture Diagram](ARCHITECTURE.md).*
*New contributor? Start with the in-repo wiki: [docs/wiki/README.md](docs/wiki/README.md).*
*Looking for deployed contract IDs? See [docs/deployed-contracts.md](docs/deployed-contracts.md).*

### API Reference

Expand Down
60 changes: 60 additions & 0 deletions docs/deployed-contracts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# Deployed Contract Registry

This is the single source of truth for deployed Soroban contract IDs across all networks.
Update this file whenever a contract is (re-)deployed.

> **Secrets note**: contract IDs are public addresses — safe to commit. Never commit secret/admin keys here.

---

## Testnet (`Test SDF Network ; September 2015`)

RPC: `https://soroban-testnet.stellar.org`
Explorer: `https://stellar.expert/explorer/testnet`

| Contract | Contract ID | Deploy Date | Version / Commit |
|---|---|---|---|
| `loan_manager` | _not yet recorded_ | — | — |
| `lending_pool` | _not yet recorded_ | — | — |
| `remittance_nft` | _not yet recorded_ | — | — |
| `multisig_governance` | _not yet recorded_ | — | — |
| `token` (USDC-like pool token) | _not yet recorded_ | — | — |

> **How to fill this in**: after running `scripts/deploy.ts`, copy the printed contract IDs into the table above and open a PR. Include the deploy date (YYYY-MM-DD) and the short git commit SHA or release tag.

### Environment variables that consume these IDs

#### Backend (`backend/.env`)

| Contract | Env var |
|---|---|
| `loan_manager` | `LOAN_MANAGER_CONTRACT_ID` |
| `lending_pool` | `LENDING_POOL_CONTRACT_ID` |
| `remittance_nft` | `REMITTANCE_NFT_CONTRACT_ID` |
| `multisig_governance` | `MULTISIG_GOVERNANCE_CONTRACT_ID` |
| `token` | `POOL_TOKEN_ADDRESS` |

#### Frontend (`frontend/.env`)

The frontend does not currently read contract IDs directly from env. It calls the backend API, which resolves contract addresses at runtime using the backend vars above.

---

## Futurenet

No contracts deployed yet.

---

## Mainnet

No contracts deployed yet.

---

## Updating this file

1. Deploy (or redeploy) via `scripts/deploy.ts`.
2. Copy the contract IDs from the deploy output into the relevant table row.
3. Set the same IDs in your local `backend/.env` (and CI secrets for staging/production).
4. Commit the updated table in the same PR as any contract change.
Loading