Skip to content

eco/routes-cli

Repository files navigation

Eco Protocol

Routes CLI

Send assets across chains with a single command.

License: MIT Node.js Version

Routes CLI is a terminal tool for publishing cross-chain intents built on the Eco Routes Protocol. You lock a reward on your source chain; competitive solvers race to deliver the result on your destination chain. Supports EVM (Ethereum, Base, Optimism, and more), and Solana.


See It In Action

$ eco-routes-cli publish --private-key 0xYOUR_PRIVATE_KEY

? Select source chain:        Base
? Select destination chain:   Optimism

? Route token:   USDC
? Route amount:  100

? Reward token:  USDC
? Reward amount: 101

┌─────────────────────────────────────────────┐
│            Intent Summary                   │
├──────────────────┬──────────────────────────┤
│ Source chain     │ Base (8453)              │
│ Destination      │ Optimism (10)            │
│ Route            │ 100 USDC → Optimism      │
│ Reward           │ 101 USDC on Base         │
│ Route deadline   │ 2026-02-26 14:00 UTC     │
│ Reward deadline  │ 2026-02-26 15:00 UTC     │
└──────────────────┴──────────────────────────┘

? Confirm and publish intent? Yes

⠋ Publishing intent...
✔ Intent published — tx: 0xabc123...def456

Quick Start

1. Install globally

npm i -g eco-routes-cli

2. Publish your first EVM intent

eco-routes-cli publish --private-key 0xYOUR_PRIVATE_KEY

Follow the prompts to select source chain (e.g. Base), destination chain (e.g. Optimism), token, and amounts. Done.

Tip: pass --source and --destination to skip chain selection prompts.

Prefer not to pass keys inline? Copy .env.example to .env and set EVM_PRIVATE_KEY (or SVM_PRIVATE_KEY for Solana) — the CLI will pick it up automatically.


What Is an Intent?

An intent describes what you want to happen on the destination chain and what reward you're offering to whoever makes it happen. Solvers — independent actors monitoring the protocol — race to fulfill your intent and claim the reward. The faster the solver, the better the deal for everyone.

This is powered by the Eco Routes Protocol. For the full picture of how intents are encoded, published, and proven, see ARCHITECTURE.md.


Command Reference

Command Description
eco-routes-cli publish Interactive intent publishing wizard
eco-routes-cli publish --source <chain> --destination <chain> Skip chain selection prompts
eco-routes-cli chains List all supported chains
eco-routes-cli tokens List all configured tokens

publish flags:

Flag Alias Description
--source -s Source chain name or ID
--destination -d Destination chain name or ID
--private-key -k EVM private key (overrides EVM_PRIVATE_KEY env)
--private-key-svm SVM private key (overrides SVM_PRIVATE_KEY env)
--recipient Recipient address on the destination chain
--portal-address Portal contract address on the source chain
--prover-address Prover contract address on the source chain
--rpc -r RPC URL override for the source chain
--dry-run Validate and preview without broadcasting
--watch -w Watch for fulfillment after publishing

Private key formats:

Chain Format Example
EVM 0x + 64 hex chars 0xac09...ff80
Tron 64 hex chars, no 0x ac09...ff80
Solana Base58 5Jd7F...
Solana JSON byte array [1,2,3,...]
Solana Comma-separated bytes 1,2,3,...

Configuration Reference

Copy .env.example to .env. All variables except the private keys are optional.

Variable Required Description
EVM_PRIVATE_KEY For EVM chains EVM wallet private key (0x…)
SVM_PRIVATE_KEY For Solana Solana wallet key (base58, array, or bytes)
EVM_RPC_URL No Override RPC for all EVM chains
SVM_RPC_URL No Override Solana RPC (default: mainnet-beta)
SOLVER_URL No Use a custom solver endpoint for quotes
QUOTES_PREPROD No Force preprod quote service (set to true)
PORTAL_ADDRESS_ETH No Override Ethereum portal contract
PORTAL_ADDRESS_BASE No Override Base portal contract
PORTAL_ADDRESS_OPTIMISM No Override Optimism portal contract
PORTAL_ADDRESS_SOLANA No Override Solana portal contract

See .env.example for the complete list of portal address overrides.


Troubleshooting

Issue Fix
Private key error Check the format matches the chain type — see Private key formats above
Chain not found Run eco-routes-cli chains to verify the exact chain name or ID
Insufficient balance Ensure your wallet has the reward token plus gas on the source chain
Quote unavailable Not all chain pairs have live routes yet — try a different pair
RPC timeout Set a custom RPC endpoint via EVM_RPC_URL / TVM_RPC_URL / SVM_RPC_URL

Enable verbose output for more detail:

DEBUG=* eco-routes-cli publish

Going Deeper


License

MIT © Eco Protocol

Built with viem, and @solana/web3.js. Powered by the Eco Routes Protocol.

Eco Protocol

About

No description, website, or topics provided.

Resources

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors