Skip to content

smartcontractkit/ccip-tools-ts

Repository files navigation

ccip-tools-ts

TypeScript SDK and CLI for CCIP (Cross-Chain Interoperability Protocol).

Important

This tool is provided under an MIT license and is for convenience and illustration purposes only.

Packages

Package Description Install
@chainlink/ccip-sdk TypeScript SDK for CCIP integration npm install @chainlink/ccip-sdk
@chainlink/ccip-cli Command-line interface npm install -g @chainlink/ccip-cli

Quick Start

Track a CCIP Message (CLI)

ccip-cli show 0xYOUR_TX_HASH \
  -r https://ethereum-sepolia-rpc.publicnode.com \
  -r https://sepolia-rollup.arbitrum.io/rpc

Integrate in Your App (SDK)

import { EVMChain, networkInfo } from '@chainlink/ccip-sdk'

const source = await EVMChain.fromUrl('https://ethereum-sepolia-rpc.publicnode.com')
const router = '0x0BF3dE8c5D3e8A2B34D2BEeB17ABfCeBaf363A59'
const dest = networkInfo('ethereum-testnet-sepolia-arbitrum-1').chainSelector

const fee = await source.getFee(router, dest, {
  receiver: '0xYourAddress',
  data: '0x48656c6c6f',
  extraArgs: { gasLimit: 200_000 },
})

Supported Chains

Chain Family Networks Status
EVM Ethereum, Arbitrum, Optimism, Polygon, Avalanche, Base, etc. Supported
Solana Mainnet, Devnet Supported
Aptos Mainnet, Testnet Supported
Sui Mainnet, Testnet In Development
TON Mainnet, Testnet In Development

Documentation

📖 Full Documentation

Guide Description
Overview Introduction and quick start
SDK Guide SDK usage and patterns
CLI Reference All commands and options
Contributing Development setup
Adding New Chain Implement a new blockchain

Development

Note

NodeJS version v20+ is required. For development of the packages, v24+ is required. npm test will only work with v24+

git clone https://github.com/smartcontractkit/ccip-tools-ts
cd ccip-tools-ts
npm ci
npm test

See CONTRIBUTING.md for details.

Resources

License

MIT

About

Typescript CLI and library to interact with CCIP

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published

Contributors 17

Languages