Skip to content

README.md

Latest commit

 

History

History
112 lines (79 loc) · 2.5 KB

README.md

File metadata and controls

112 lines (79 loc) · 2.5 KB
Raw

ACBU Soroban Smart Contracts

Soroban (Stellar) smart contracts for the ACBU (African Currency Basket Unit) stablecoin platform.

Contracts

  • Minting Contract - Handles USDC → ACBU conversions
  • Burning Contract - Handles ACBU → Fiat redemptions
  • Oracle Contract - Aggregates exchange rates from multiple validators
  • Reserve Tracker Contract - Tracks and verifies reserve balances

Prerequisites

  • Rust 1.87.0 (pinned in rust-toolchain.toml)
  • Soroban CLI (cargo install --locked soroban-cli)
  • Stellar account with XLM for deployment fees

Building

You can use the new Makefile for common commands.

# Build all contracts in the workspace
make build

# Build a specific contract
make build-minting

Testing

# Run all tests in the workspace
make test

# Run tests for a specific contract
make test-minting

Deployment

Testnet

export STELLAR_SECRET_KEY="your-secret-key"
make deploy-testnet

Mainnet

export STELLAR_SECRET_KEY="your-secret-key"
make deploy-mainnet

Git Hooks Setup

After cloning, run:

make setup-hooks

Contract Addresses

After deployment, contract addresses are saved to .soroban/deployment_{network}.json

Development

Git Hooks Setup

After cloning, run:

./scripts/setup-git-hooks.sh

This configures the pre-commit hook for WASM integrity checks.

Project Structure

.
├── acbu_minting/           # Minting contract
├── acbu_burning/           # Burning contract
├── acbu_oracle/            # Oracle contract
├── acbu_reserve_tracker/   # Reserve tracker contract
├── acbu_savings_vault/     # Savings vault contract
├── acbu_lending_pool/      # Lending pool contract
├── acbu_escrow/            # Escrow contract
├── acbu_multisig/          # Multisig shared contract
├── shared/                 # Shared types and utilities
├── scripts/                # Deployment scripts
├── docs/                   # Documentation
└── tests/                  # Integration tests

Adding a New Contract

  1. Create contract directory: mkdir new_contract
  2. Add to workspace Cargo.toml members
  3. Create Cargo.toml and src/lib.rs
  4. Update deployment scripts

Security

  • All admin functions require multisig (3 of 5)
  • Rate limits on transactions
  • Circuit breakers for anomalies
  • Time locks for critical operations

Documentation

See individual contract README files for detailed documentation.