Documentation

Teleporter CLI

The CLI is a command line interface for interacting with the Teleporter contracts.

This directory contains the source code for the Teleporter CLI. The CLI is a command line interface for interacting with the Teleporter contracts. It is written with cobra commands as a Go application.

Build

To build the CLI, run go build from this directory. This will create a binary called teleporter-cli in the current directory.

Usage

The CLI has a number of subcommands. To see the list of subcommands, run ./teleporter-cli help. To see the help for a specific subcommand, run ./teleporter-cli help <subcommand>.

The supported subcommands include:

  • event: given a log event's topics and data, attempts to decode into a Teleporter event in a more readable format.
  • message: given a Teleporter message encoded as a hex string, attempts to decode into a Teleporter message in a more readable format.
  • transaction: given a transaction hash, attempts to decode all relevant TeleporterMessenger and ICM log events in a more readable format.

Last updated on 3/10/2025

On this page

Privacy Policy

We respect your privacy and are committed to protecting your personal data. This privacy policy will inform you about how we look after your personal data and tell you about your privacy rights.

Read full policy