Skip to main content

SDK installation

To use the CCTP SDK in your Go applications, install it using go get:
go get github.com/circlefin/cctp-go
Then import it in your Go code:
import "github.com/circlefin/cctp-go"
The SDK requires Go 1.25.2 or later. Check your Go version with go version.

CLI installation

The CLI tool can be installed directly using go install:
go install github.com/circlefin/cctp-go/cmd/cctp@latest
Make sure the path where Go builds executables is in your PATH variable. This is typically $GOPATH/bin or $HOME/go/bin.

Verify installation

Verify the CLI is installed correctly:
cctp --help
You should see the CLI help output with available commands.

Building from source

If you prefer to build from source or want to contribute:
1

Clone the repository

git clone https://github.com/circlefin/cctp-go
cd cctp-go
2

Install dependencies

go mod download
3

Build the CLI binary

You can use Task or build directly with Go:
task build
4

Run the CLI

./bin/cctp transfer
Or run directly without building:
go run ./cmd/cli transfer

Available build tasks

If you have Task installed, you can use these convenient commands:
task build

CLI wallet setup

To use the CLI, you need your wallet’s private key stored in the Geth keystore format.
Never share your private key or keystore file. Keep them secure and never commit them to version control.

Keystore location

By default, the CLI looks for keystore files in the standard Geth keystore directory. You can specify a custom directory with the --keystore flag:
cctp --keystore ~/.ethereum/keystore transfer

Dependencies

The SDK relies on several key dependencies:
  • ethereum/go-ethereum v1.17.0 - Ethereum client and contract bindings
  • spf13/cobra v1.10.1 - CLI framework
  • charmbracelet/bubbletea v1.3.10 - Terminal UI framework
All dependencies are automatically installed when you run go get or go mod download.

Next steps

Quickstart

Execute your first USDC transfer

CLI usage

Learn how to use the CLI tool

SDK guide

Integrate CCTP into your Go application

Build docs developers (and LLMs) love