Function useRoute

  • useRoute(amountIn, sourceAsset?, sourceAssetChain?, destinationAsset?, destinationAssetChain?, enabled?, allowedBridges?, swapVenues?, smartRelay?, config?, isDirectTransfer?): {
        amountOut: string;
        isLoadingRoute: boolean;
        isValidatingRoute: boolean;
        refresh: (() => Promise<any>);
        routeError: any;
        routeKey: null | string;
        routeResponse: undefined | {
            amountIn: string;
            amountOut: string;
            destinationAsset: Asset;
            destinationAssetChain: ChainData;
            operations: any[];
            response: RouteResponse;
            sourceAsset: Asset;
            sourceAssetChain: ChainData;
            transactionCount: number;
        };
    }

  • React hook to get the Skip Route Quote for an amount, a source token/chain and destination token/chain pair

    Parameters

    • amountIn: string
    • Optional sourceAsset: Asset
    • Optional sourceAssetChain: ChainData
    • Optional destinationAsset: Asset
    • Optional destinationAssetChain: ChainData
    • enabled: boolean = true
    • Optional allowedBridges: BRIDGES[]
    • Optional swapVenues: SwapVenue[]
    • smartRelay: boolean = false
    • Optional config: Partial<PublicConfiguration<any, any, BareFetcher<any>>>
    • Optional isDirectTransfer: boolean

    Returns {
        amountOut: string;
        isLoadingRoute: boolean;
        isValidatingRoute: boolean;
        refresh: (() => Promise<any>);
        routeError: any;
        routeKey: null | string;
        routeResponse: undefined | {
            amountIn: string;
            amountOut: string;
            destinationAsset: Asset;
            destinationAssetChain: ChainData;
            operations: any[];
            response: RouteResponse;
            sourceAsset: Asset;
            sourceAssetChain: ChainData;
            transactionCount: number;
        };
    }

    • amountOut: string
    • isLoadingRoute: boolean
    • isValidatingRoute: boolean
    • Readonly refresh: (() => Promise<any>)
        • (): Promise<any>

        • Returns Promise<any>

    • routeError: any
    • Readonly routeKey: null | string
    • routeResponse: undefined | {
          amountIn: string;
          amountOut: string;
          destinationAsset: Asset;
          destinationAssetChain: ChainData;
          operations: any[];
          response: RouteResponse;
          sourceAsset: Asset;
          sourceAssetChain: ChainData;
          transactionCount: number;
      }

Settings

Member Visibility

Theme