Class SkipAPI

SkipAPI class provides a range of methods to interact with the Skip API. It includes functionalities such as retrieving supported chains and assets, fetching routing information for token transfers, submitting transactions, and tracking their status. This class acts as an interface for applications to interact with the Skip API.

Constructors

constructor

Methods

getClientID getIbcOriginAssets getIntegratorID getMessages getRecommendedAssets getRecommendedChainAssets getRoute getSupportedAssets getSupportedAssetsForChain getSupportedChains getTxnStatus initializeCache isCacheInitialized setClientID setIntegratorID submitTransaction trackTransaction

Constructors

constructor

Methods

Static getClientID

  • getClientID(): string

  • Returns string

Static getIbcOriginAssets

  • getIbcOriginAssets(args): Promise<{
        error: string;
        success: false;
    } | {
        data: (null | SkipSupportedAsset)[];
        success: true;
    }>

  • Fetches the IBC origin assets based on provided asset details.

    Parameters

    • args: {
          chainId: string;
          denom: string;
      }[]

      Array of objects containing denom and chainId. See the argument structure in SkipSupportedAsset.

    Returns Promise<{
        error: string;
        success: false;
    } | {
        data: (null | SkipSupportedAsset)[];
        success: true;
    }>

    A promise that resolves to an object containing either the origin assets SkipSupportedAsset or an error message.

Static getIntegratorID

  • getIntegratorID(): undefined | string

  • Returns undefined | string

Static getMessages

  • getMessages(args): Promise<{
        data: MsgResponse;
        msgs: SkipMsg[];
        success: true;
    } | {
        error: string;
        success: false;
    }>

  • Retrieves the necessary messages for transaction creation.

    Parameters

    Returns Promise<{
        data: MsgResponse;
        msgs: SkipMsg[];
        success: true;
    } | {
        error: string;
        success: false;
    }>

    A promise that resolves to an object containing transaction messages or an error message.

Static getRecommendedAssets

  • getRecommendedAssets(args): Promise<{
        error: string;
        success: false;
    } | {
        recommendations: RecommendedAssetResponse[];
        success: true;
    }>

  • Fetches recommended chains for a given asset.

    Parameters

    • args: RecommendedAssetRequest

      The request arguments including source asset denom and chain ID, and an optional flag for multi-tx. See RecommendedChainRequest.

    Returns Promise<{
        error: string;
        success: false;
    } | {
        recommendations: RecommendedAssetResponse[];
        success: true;
    }>

    A promise that resolves to an array containing recommended chains RecommendedAssetResponse or an error message.

Static getRecommendedChainAssets

  • getRecommendedChainAssets(args): Promise<{
        error: string;
        success: false;
    } | {
        chains: RecommendedChainResponse;
        success: true;
    }>

  • Fetches recommended chains for a given asset.

    Parameters

    • args: RecommendedChainRequest

      The request arguments including source asset denom and chain ID, and an optional flag for multi-tx.

    Returns Promise<{
        error: string;
        success: false;
    } | {
        chains: RecommendedChainResponse;
        success: true;
    }>

    A promise that resolves to an object containing recommended chains or an error message.

Static getRoute

  • getRoute(args): Promise<{
        error: string;
        success: false;
    } | {
        route: RouteResponse;
        success: true;
    }>

  • Calculates the route for token transfer between two assets.

    Parameters

    • args: RouteRequest

      The arguments required to calculate the route, including source and destination asset details. See RouteRequest.

    Returns Promise<{
        error: string;
        success: false;
    } | {
        route: RouteResponse;
        success: true;
    }>

    A promise that resolves to an object containing the route details RouteResponse or an error message.

Static getSupportedAssets

  • getSupportedAssets(args): Promise<{
        error: string;
        success: false;
    } | {
        assets: Record<string, SkipSupportedAsset[]>;
        success: true;
    }>

  • Retrieves the supported assets for a specified chain.

    Parameters

    Returns Promise<{
        error: string;
        success: false;
    } | {
        assets: Record<string, SkipSupportedAsset[]>;
        success: true;
    }>

    A promise that resolves to an object containing the supported assets for the given chain, or an error message if unsuccessful. See SkipSupportedAsset.

Static getSupportedAssetsForChain

  • getSupportedAssetsForChain(args): Promise<{
        error: string;
        success: false;
    } | {
        assets: SkipSupportedAsset[];
        success: true;
    }>

  • Retrieves the supported assets for a specified chain.

    Parameters

    Returns Promise<{
        error: string;
        success: false;
    } | {
        assets: SkipSupportedAsset[];
        success: true;
    }>

    A promise that resolves to an object containing the supported assets for the given chain, or an error message if unsuccessful. See SkipSupportedAsset.

Static getSupportedChains

  • getSupportedChains(options?): Promise<{
        error: string;
        success: false;
    } | {
        chains: SupportedChain[];
        success: true;
    }>

  • Retrieves the list of supported chains from the Skip API.

    Parameters

    • Optional options: {
          cached?: boolean;
          includeEVM?: boolean;
          includeSVM?: boolean;
          includeTestnets?: boolean;
      }
      • Optional cached?: boolean
      • Optional includeEVM?: boolean
      • Optional includeSVM?: boolean
      • Optional includeTestnets?: boolean

    Returns Promise<{
        error: string;
        success: false;
    } | {
        chains: SupportedChain[];
        success: true;
    }>

    A Promise that resolves to an object containing either a list of supported chains on success, or an error message on failure. See SupportedChains.

Static getTxnStatus

  • getTxnStatus(args): Promise<{
        response: TxStatusResponseJSON;
        success: true;
    } | {
        error: string;
        success: false;
    }>

  • Retrieves the status of a transaction.

    Parameters

    Returns Promise<{
        response: TxStatusResponseJSON;
        success: true;
    } | {
        error: string;
        success: false;
    }>

    A promise resolving to an object containing the transaction status (TxStatusResponseJSON) or an error message.

Static initializeCache

  • initializeCache(storage): void

  • Parameters

    Returns void

Static isCacheInitialized

  • isCacheInitialized(): boolean

  • Returns boolean

Static setClientID

  • setClientID(clientID): void

  • Parameters

    • clientID: string

    Returns void

Static setIntegratorID

  • setIntegratorID(integratorID): void

  • Parameters

    • integratorID: string

    Returns void

Static submitTransaction

  • submitTransaction(args): Promise<{
        response: TransactionResponse;
        success: true;
    } | {
        error: string;
        success: false;
    }>

  • Submits a transaction to the blockchain.

    Parameters

    Returns Promise<{
        response: TransactionResponse;
        success: true;
    } | {
        error: string;
        success: false;
    }>

    A promise that resolves to an object indicating the success of the transaction submission along with the transaction response TransactionResponse or an error message.

Static trackTransaction

  • trackTransaction(args): Promise<{
        response: TransactionResponse;
        success: true;
    } | {
        error: string;
        success: false;
    }>

  • Parameters

    Returns Promise<{
        response: TransactionResponse;
        success: true;
    } | {
        error: string;
        success: false;
    }>

Settings

Member Visibility

Theme

On This Page

constructorgetClientIDgetIbcOriginAssetsgetIntegratorIDgetMessagesgetRecommendedAssetsgetRecommendedChainAssetsgetRoutegetSupportedAssetsgetSupportedAssetsForChaingetSupportedChainsgetTxnStatusinitializeCacheisCacheInitializedsetClientIDsetIntegratorIDsubmitTransactiontrackTransaction