Skip to content

docs: fix project structure tree and add examples reference #15

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

Open
mrnetwork0001 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: fix project structure tree and add examples reference #15

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 7 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,11 +114,10 @@ cargo cov-html
```
stellar-cctp/
├── contracts/
│ ├── message-transmitter/ # Message transmission and attestation (v1)
│ ├── message-transmitter-v2/ # Message transmission and attestation (v2)
│ ├── token-messenger-minter/ # Token burning and minting (v1)
│ ├── token-messenger-minter-v2/ # Token burning and minting (v2)
│ ├── message-transmitter-v2/ # Message transmission and attestation
│ ├── token-messenger-minter-v2/ # Token burning and minting
│ └── cctp-forwarder/ # Hook-based message forwarding
├── examples/ # Standalone Stellar↔EVM transfer scripts
├── packages/
│ ├── cctp-interfaces/ # Contract interfaces (MessageHandler, Receiver, Relayer)
│ ├── cctp-roles/ # CCTP-specific roles (Attestable, TokenController, etc.)
Expand All @@ -136,6 +135,10 @@ stellar-cctp/
└── ... # Other shared packages
```

## Examples

See the [examples directory](examples/README.md) for standalone TypeScript scripts demonstrating Stellar↔EVM USDC transfers using CCTP, including both `depositForBurn` (Stellar→EVM) and `mintAndForward` (EVM→Stellar via CCTP Forwarder) flows.

## Submodules

This project uses the `stablecoin-xlm` repository as a git submodule to share the `fiat-token-admin` contract and related packages.
Expand Down