w3-io/W3 Circle Action

Circle CCTP, programmable wallets, transfers, compliance, and fee estimation

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
commandOperation to perform. CCTP on-chain: approve-burn, burn, mint, replace-message (burn/mint auto-detect EVM vs Solana). CCTP off-chain: get-attestation, wait-for-attestation, get-supported-chains, get-domain-info. Wallets: create-wallet-set, create-wallet, get-wallet, list-wallets, get-balance. Transactions: transfer, get-transaction, estimate-fee. Compliance: screen-address. yes
api-keyCircle Platform API key (required for wallet/transaction/compliance commands, not for CCTP)no
entity-secretEntity secret (32-byte hex) for wallet creation and transaction signingno
api-urlCircle Platform API base URL overrideno
iris-urlIRIS API base URL overrideno
sandboxUse IRIS sandbox (testnet) instead of production (default: false)nofalse
rpc-urlJSON-RPC endpoint URL (can also set per-chain env vars like ETHEREUM_SEPOLIA_RPC_URL)no
destination-chainDestination chain name for burn command (e.g. "avalanche-fuji")no
destination-callerRestrict who can call receiveMessage on destination (address). Omit for permissionless.no
message-bytesMessage bytes from burn step (for mint command)no
attestationAttestation from wait-for-attestation (for mint command)no
original-message-bytesOriginal message bytes (for replace-message command)no
original-attestationOriginal attestation (for replace-message command)no
tx-hashSource chain transaction hash for V2 attestation (preferred — instant with fee)no
source-domainCCTP source domain number for V2 attestation (use with tx-hash)no
message-hash0x-prefixed keccak256 hash of the CCTP message (V1 fallback)no
chainChain name (e.g. "ethereum", "arbitrum-sepolia")no
networkFilter chains by network: "mainnet" or "testnet"no
wallet-idWallet UUIDno
wallet-set-idWallet set UUIDno
nameName for wallet set creationno
blockchainsComma-separated blockchain identifiers (e.g. "ETH-SEPOLIA,AVAX-FUJI")no
countNumber of wallets to create (default: 1)no1
blockchainSingle blockchain filter (e.g. "ETH-SEPOLIA")no
page-sizeResults per page for list operations (default: 10)no10
destination-addressRecipient blockchain addressno
token-idCircle token UUIDno
amountTransfer amount as string (e.g. "1.50")no
transaction-idTransaction UUIDno
addressBlockchain address to screen for complianceno
poll-intervalSeconds between attestation polls (default: 5)no5
max-attemptsMaximum attestation poll attempts (default: 60)no60
timeoutRequest timeout in seconds (default: 30)no30
namedescription
resultJSON result of the operation