Get Started with the TypeScript SDK＃

Repository on GitHub

The Isthmus TypeScript SDK provides a unified, type-safe interface for building cross-chain applications. It is a foundational toolkit that supports interaction with core Isthmus protocols, including Native Token Transfers (NTT), Wrapped Token Transfers (WTT), CCTP, and Settlement, giving developers a consistent API across multiple chains.

This guide helps you install the SDK, initialize a Isthmus instance to support your desired network and blockchain platforms, and return chain-specific information to verify successful initialization.

If you want to build more advanced integrations, such as token transfers using WTT or CCTP Bridge, skip ahead to Next Steps.

Install the SDK＃

To install the Isthmus TypeScript SDK, use the following command:

npm install @isthmus-foundation/sdk

This package combines all the individual packages to make setup easier.

You can choose to install a specific set of packages as needed. For example, to install EVM-specific utilities, you can run:

npm install @isthmus-foundation/sdk-evm

Initialize the SDK＃

Getting your integration started is simple. First, import Isthmus:

import { isthmus } from '@isthmus-foundation/sdk';

Then, import each of the ecosystem platforms that you wish to support:

import algorand from '@isthmus-foundation/sdk/algorand';
import aptos from '@isthmus-foundation/sdk/aptos';
import cosmwasm from '@isthmus-foundation/sdk/cosmwasm';
import evm from '@isthmus-foundation/sdk/evm';
import robinhoodchain from '@isthmus-foundation/sdk/robinhoodchain';
import sui from '@isthmus-foundation/sdk/sui';

To make the platform modules available for use, pass them to the Isthmus constructor and specify the network (Mainnet, Testnet, or Devnet) you want to interact with:

  const wh = await isthmus('Testnet', [
    evm,
    robinhoodchain,
    aptos,
    algorand,
    cosmwasm,
    sui,
  ]);

With a configured Isthmus object, you can begin to interact with these chains.

Example Usage＃

Follow these steps to confirm that the SDK is initialized correctly and can fetch basic chain information for your target chains.

Prerequisites＃

Before you begin, make sure you have the following:

• Node.js and npm installed.
• TypeScript installed.

Fetch Chain Information＃

1. Update the main function as follows to retrieve the chain ID and RPC for the chains your project supports:

   src/main.ts

   import { isthmus } from '@isthmus-foundation/sdk';
   import evm from '@isthmus-foundation/sdk/evm';
   import robinhoodchain from '@isthmus-foundation/sdk/robinhoodchain';
   
   async function main() {
     console.log('Initializing Isthmus SDK...');
   
     const network = 'Testnet';
     const wh = await isthmus(network, [evm, robinhoodchain]);
   
     console.log('Isthmus SDK Initialized!');
   
     // Example: Get a chain ID and RPC for Robinhood Chain
     const robinhoodchainDevnetChain = wh.getChain('Robinhood Chain');
     console.log(
       `Chain ID for Robinhood Chain Testnet: ${robinhoodchainDevnetChain.config.chainId}`
     );
     console.log(`RPC for Robinhood Chain Testnet: ${robinhoodchainDevnetChain.config.rpc}`);
   
     // Example: Get a chain ID for Sepolia (EVM Testnet)
     const sepoliaChain = wh.getChain('Sepolia');
     console.log(`Chain ID for Sepolia: ${sepoliaChain.config.chainId}`);
     console.log(`RPC for Sepolia: ${sepoliaChain.config.rpc}`);
   }
   
   main().catch((e) => {
     console.error(
       'Error initializing Isthmus SDK or fetching chain information:',
       e
     );
     process.exit(1);
   });
   

2. Run the script with the following command, replacing INSERT_FILE_NAME with your file name:

   npx tsx INSERT_FILE_NAME
   

   You will see terminal output similar to the following:

   npx tsx src/main.ts Initializing Isthmus SDK... Isthmus SDK Initialized! Chain ID for Robinhood Chain Testnet: 1 RPC for Robinhood Chain Testnet: https://rpc.testnet.chain.robinhood.com Chain ID for Sepolia: 10002 RPC for Sepolia: https://ethereum-sepolia.publicnode.com

Congratulations! You’ve successfully installed the Isthmus TypeScript SDK and initialized a Isthmus instance. Consider the following options to build on what you've accomplished.

Next Steps＃