Squid Dev Documentation
  • Getting Started
    • Overview
    • Get an Integrator ID
    • Integrator Quickstart
  • Widget Integration
    • Add A Widget
      • Swap widget
        • Getting Started
        • Installing the Widget
        • React Installation
        • NextJS Installation
        • Vite Installation
        • Iframe Installation
        • Customization Guide
          • Default User Settings
          • Configuring Content
          • Default Chains and Tokens
          • Configuration Types
          • Collect Fees
        • Information for Integrators
        • Set default chains and tokens via URL
        • Errors
    • Upgrade Your Widget
  • API & SDK Integration
    • API
      • Swap & Bridge Example
      • Staking Example
      • Cross-chain NFT Purchase Example
      • Get Route Status
    • SDK
      • Cross-chain Swap Example
      • Staking Example
      • Cross-chain NFT Purchase Example
      • Get Route Status
    • Key Concepts
      • Route Request Parameters
      • Get a route
      • Execute the route
      • 🪝Hooks
        • How do hooks work
        • Build a preHook
        • Build a postHook
        • Using the full ERC20 or Native balance in a call
        • ❗Transfer the remainder to the user
        • Get a route and execute as normal
      • Express
      • Track status
      • Types
      • Collect Fees
      • Get supported tokens and chains
    • Coral: Intent Swaps
      • Integrating Coral
    • NEW: Bitcoin and Solana
  • Adding Tokens
    • Whitelist a Token
    • Interchain Token(ITS) Listings
      • How To List
    • Circle's EURC Integration Guide
  • Migration
    • Squid v2 vs Squid v1
    • v1 -> v2 Migration
  • Additional Resources
    • Contracts
    • Squid v1 Docs
      • SDK
        • Installing our SDK
        • Get supported tokens and chains
          • Example chains response
          • Example tokens response
        • Set your transfer parameters
        • Get a route
          • Understanding the route response
        • Execute your swap or call
        • Get Route Status
        • Contract calls
          • Code example
          • Creating a ContractCall object
          • Contract call types
          • Approving ERC20s in our multicall
          • Transferring the remainder to a user
        • Collect Fees
          • Fee collector contract addresses
        • Working example!
      • API
        • integratorId
        • API playground
        • Base URLs
        • Get supported tokens and chains
        • Get a route
        • Checking the status of a transaction
        • Error codes
          • V2 API
      • Cosmos
        • Installing our SDK
        • Get supported tokens and chains
          • Example chains response
          • Example tokens response
        • Set your transfer parameters
        • Get a route
          • Cosmos route response
        • Execute your swap or call on Cosmos
        • Get Route Status
        • Cosmos custom calls
        • Working cosmos example!
        • Fallback Addresses
    • Additional Dev Resources
      • Choose How To Integrate Squid
      • Squid x Tenderly
      • Testnet or Mainnet?
      • Understanding Gas Payments
      • Supported Chains and Tokens
      • Request a new supported token
      • Liquidity Sources
        • axlASSET Liquidity
      • Integrator type specific docs
        • DEXs
        • Aggregators
        • NFTs
      • Setting up an EVM signer
      • Setting up Cosmos signer
      • Contract addresses
      • SDK easter eggs
        • Setting toAmount
        • getAllBalances
        • Advanced set up
        • Manually approve a route
        • Manually approve an ERC20
      • Whitelist a token
      • Security & Audits
        • Security
        • Audits
        • Axelar
      • Get an integrator-id
    • Architecture
      • FAQ
      • Liquidity model
      • Architecture
      • General message passing (GMP)
      • Transaction times and fees
      • Fallback behaviour on failed transactions
      • Axelar
    • Brand Assets
      • "Powered by Squid" Policy
    • Audits & Security
    • Contact
  • Changelog
    • SDK
      • v1.3
      • v1.2
    • API
      • v1.9
      • v1.8
      • v1.7
      • v1.6
  • Old v2 Documentation (Deprecated)
    • Whitelist a Token
    • Interchain Token(ITS) Listings
      • How To List
    • Add A Widget
      • Swap widget
        • Getting Started
        • Installing the Widget
        • React Installation
        • NextJS Installation
        • Iframe Installation
        • Customization Guide
          • Default User Settings
          • Theme Customization
          • Configuring Content
          • Default Chains and Tokens
          • Configuration Types
          • Collect fees
        • Information for Integrators
        • Set default chains and tokens via URL
        • Errors
      • Stake widget
        • Installing the Widget
        • Configuration
        • Importing The widget
    • Quick Start
    • API
      • Swap & Bridge Example
      • Staking Example
      • Cross-chain NFT Purchase Example
    • SDK
      • Cross-chain Swap Example
      • Staking Example
      • Cross-chain NFT Purchase Example
    • Key Concepts
      • Route Request Parameters
      • Get a route
      • Execute the route
      • 🪝Hooks
        • How do hooks work
        • Build a preHook
        • Build a postHook
        • Using the full ERC20 or Native balance in a call
        • ❗Transfer the remainder to the user
        • Add your hooks to a route request, or widget
        • Get a route and execute as normal
      • Boost
      • Track status
      • Types
      • Collect Fees
      • Get supported tokens and chains
Powered by GitBook
On this page
  • Introduction
  • Summary to List a Token and Interchain Token on Squid
  • Getting Started
  • List Squid Token Command Flow
  1. Adding Tokens
  2. Interchain Token(ITS) Listings

How To List

PreviousInterchain Token(ITS) ListingsNextCircle's EURC Integration Guide

Last updated 6 months ago

Introduction

This guide will walk you through the process using the Axelar Configs CLI Wizard and allow you to list

Summary to List a Token and Interchain Token on Squid

  1. Access the Interactive Form:

    • Run the wizard command to access the interactive form.

  2. Follow the :

    • Follow the prompts and steps as outlined in the command flow to list your token on Squid.

Getting Started

Before listing a token, ensure your system meets the minimum runtime requirements:

  • git

  • bun >= 1.0 OR npm

To install bun, run the following command:

curl -fsSL https://bun.sh/install | bash

Once you have bun or nodejs installed, clone the Axelar Configs repository:

gh repo clone axelarnetwork/axelar-configs

Navigate into the cloned repository:

cd axelar-configs

Install the necessary dependencies:

codebun i

Running the Wizard

You can start the wizard using one of the following commands:

bun wizard

or

pnpm wizard

or

npm run wizard

The wizard currently allows you to:

  • List an interchain token on Squid

  • Add a Cosmos/EVM chain config

  • Add a Cosmos/EVM asset list config

List Squid Token Command Flow

The command flow for listing a new interchain token on Squid is as follows:

  1. Prompt for Information:

    • The command starts by prompting the user for various details:

      • It asks if the token has been registered via the ITS portal.

      • It requests the URL of the token details, including the token address and environment.

  2. Construct API URLs:

    • The wizard constructs API URLs to search for the token and fetch its details.

  3. Perform API Requests:

    • It performs API requests to search for the token and fetch its details. If the API requests fail, it proceeds with empty data.

  4. Parse Token Details:

    • The fetched token details are parsed into an interchain token configuration.

  5. Save Configuration:

    • The command asks the user if they want to save the configuration to a local file.

    • If the user chooses to save, the local token list configuration is updated with the new token.

  6. Check for Existing Token:

    • It checks if the token already exists in the token list. If it does, the command exits with an error.

  7. Create a Pull Request:

    • If the user opts to create a PR, the wizard performs the following actions:

      • Creates a new Git branch.

      • Adds the updated token list configuration to the branch.

      • Commits the changes.

      • Pushes the branch to the remote repository.


For a detailed command flow and further instructions, refer to the .

By following these steps and command flow, you can successfully list a new Interchain Token on Squid, ensuring it is integrated and available across multiple blockchains using the Interchain Token Service. For more detailed information and examples, visit the

Command Flow
Axelar Configs CLI Wizard README
Axelar Documentation.