diff --git a/README.md b/README.md index fe542a1..c9fff17 100644 --- a/README.md +++ b/README.md @@ -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.) @@ -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.