Quickstart Guide

​

Summary

This will walkthrough shows you how to get started with the API by performing a swap of USDC on Noble to TIA on Celestia.

​

Reference Docs

For detailed information on all the Skip Go API endpoints and functionality, please see our reference docs.

​

Example using @skip-go/client package

This example is for browser environments.

​

1. Install @skip-go/client

In your command line terminal, install the @skip-go/client package:

npm i @skip-go/client

​

2. Setup Signers

Optionally, you can set up a signer for each EVM, SVM, or Cosmos SDK ecosystems.

For EVM transactions, You need to install the viem package:

npm i viem

For SVM transactions, You can pick which wallets you want to use in @solana/wallet-adapter-wallets. For this example, we are going to use Phantom wallet:

npm i @solana/wallet-adapter-phantom

Now, let’s create the SkipRouter instance with the signers for each ecosystem!

We are going to use Keplr for Cosmos transactions, MetaMask for EVM transactions, and Phantom for Solana transactions.

import { SkipRouter } from "@skip-router/client";
import { PhantomWalletAdapter } from "@solana/wallet-adapter-phantom";
import { createWalletClient } from "viem";

const skipClient = new SkipRouter({
    getCosmosSigner: async (chainID) => {
        const offlineSigner = window.keplr?.getOfflineSigner(chainID);
        if (!offlineSigner) throw new Error("Keplr not installed");
        return offlineSigner;
    },
    getEVMSigner: async () => {
        const ethereum = window.ethereum;
        if (!ethereum) throw new Error("MetaMask not installed");
        const client = createWalletClient({
        chain: mainnet,
        transport: custom(window.ethereum),
        });
        return client;
    },
    getSVMSigner: async () => {
        const phantom = new PhantomWalletAdapter();
        return phantom;
    }
});

​

3. Request a Quote

Now, we can use the SkipRouter.route function to request a quote & route to swap USDC on Noble to TIA on Celestia:

Just add the following line after the line where you initialized the skipClient:

const route = await skipClient.route({
  sourceAssetDenom: 'uusdc',
  sourceAssetChainID: 'noble-1',
  destAssetDenom: 'utia',
  destAssetChainID: 'celestia',
  amountIn: '1000000', // 1 uusdc
  smartSwapOptions: {
    splitRoutes: true,
  },
});

​

5. Get Required Addresses

Now that we have the route response, we can use our signer to get the list of chains where the user or reeceiver addresses are required for executing the route.

We’ll use these addresses in the next step to populate userAddresses when executing the route with the SkipRouter.executeRoute method.

The requiredChainAddresses field in the output of route gives the chainIDs we need to use.

It’s recommended you keep the address somewhere and have function to get the address from the chainID. In this example we have a function called getAddress that takes the chainID and returns the address.

Add the following snippet to your script after getting the route to retrieve the address associated with each requiredChainAddresses entry:

// get user addresses for each requiredChainAddress
const userAddresses = await Promise.all(
  route.requiredChainAddresses.map(async (chainID) => {
    return {
      chainID: chainID,
      address: await getAddress(chainID),
    };
  })
);

Two things you should notice about this code:

1. The userAddresses array contains objects with {chainID, address}
2. The userAddresses array needs to have the same order and length as the requiredChainAddresses array had

​

4. Execute the route!

Finally, just use the SkipRouter.executeRoute method to create, sign, submit, and track the transaction for you.

Simply add the following snippet below your retrieval code to execute the route:

await skipClient.executeRoute({
  route,
  userAddresses,
  onTransactionCompleted: (chainID, txHash, status) => {
    console.log(
      `Route completed with tx hash: ${txHash} & status: ${status.state}`
    );
  },
});

After the transaction completes, you’ll have additional TIA in your Celestia address!