Skip to content

Commit bc4982c

Browse files
authored
Merge pull request #47 from Ummi-001/fix/readme-reserve-contract
docs: add ReserveContract to README.md (#38)
2 parents e92ee1d + e72583b commit bc4982c

1 file changed

Lines changed: 19 additions & 3 deletions

File tree

README.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,13 @@ Handles fund transfers:
3333
- Handles multi-asset transfers
3434
- Reclaims base reserves
3535

36+
### 3. ReserveContract
37+
Stores and exposes the Stellar base reserve configuration:
38+
- Admin-controlled base reserve amount (stored in stroops)
39+
- Distinguishes user funds from network overhead in ephemeral accounts
40+
- TTL management to prevent contract data archival
41+
- Event emission for reserve updates and auditability
42+
3643
## Project Structure
3744

3845
contracts/
@@ -47,13 +54,22 @@ contracts/
4754
│ ├── src/
4855
│ │ ├── lib.rs
4956
│ │ ├── authorization.rs
50-
│ │ └── transfers.rs
57+
│ │ ├── transfers.rs
58+
│ │ ├── storage.rs # State management
59+
│ │ └── errors.rs # Error types
60+
│ └── Cargo.toml
61+
├── reserve_contract/ # ← NEW
62+
│ ├── src/
63+
│ │ ├── lib.rs # Main contract
5164
│ │ ├── storage.rs # State management
65+
│ │ ├── events.rs # Event definitions
5266
│ │ └── errors.rs # Error types
5367
│ └── Cargo.toml
5468
└── shared/
55-
└── types.rs # Shared types
56-
69+
├── src/
70+
│ ├── lib.rs
71+
│ └── types.rs
72+
└── Cargo.toml
5773
## Prerequisites
5874
```bash
5975
# Install Rust

0 commit comments

Comments
 (0)