@allbridge/bridge-core-sdk
    Preparing search index...

    Interface AllbridgeCoreSdkOptions

    interface AllbridgeCoreSdkOptions {
        cachePoolInfoChainSec: number;
        cctpParams: CctpParams;
        coreApiHeaders?: Record<string, string>;
        coreApiHeadersProvider?: () => Promise<Record<string, string> | undefined>;
        coreApiQueryParams?: Record<string, string>;
        coreApiUrl: string;
        jupiterApiKeyHeader?: string;
        jupiterMaxAccounts?: number;
        jupiterUrl: string;
        solanaLookUpTable: string;
        sorobanNetworkPassphrase: string;
        stxHeroApiKey?: string;
        stxIsTestnet?: boolean;
        suiIsTestnet?: boolean;
        tronJsonRpc?: string;
        wormholeMessengerProgramId: string;
    }
    Index

    Properties

    cachePoolInfoChainSec cctpParams coreApiHeaders? coreApiHeadersProvider? coreApiQueryParams? coreApiUrl jupiterApiKeyHeader? jupiterMaxAccounts? jupiterUrl solanaLookUpTable sorobanNetworkPassphrase stxHeroApiKey? stxIsTestnet? suiIsTestnet? tronJsonRpc? wormholeMessengerProgramId

    Properties

    cachePoolInfoChainSec: number

    The number of seconds that pool information taken from the chain will be cached.

    cctpParams: CctpParams
    coreApiHeaders?: Record<string, string>

    A set of headers to be added to all requests to the Core API.

    coreApiHeadersProvider?: () => Promise<Record<string, string> | undefined>

    A function that returns headers to be added to a single Core API request. It is evaluated right before each request

    coreApiQueryParams?: Record<string, string>

    A set of query parameters to be added to all requests to the Core API.

    coreApiUrl: string
    jupiterApiKeyHeader?: string

    Jupiter Api Key Header
    https://dev.jup.ag/docs/api-setup

    jupiterMaxAccounts?: number

    Jupiter v6 'maxAccounts' parameter
    Rough estimate of the max accounts to be used for the quote, so that you can compose with your own accounts
    https://station.jup.ag/docs/apis/swap-api#using-maxaccounts

    jupiterUrl: string

    Jupiter Swap Api
    Default: https://lite-api.jup.ag/swap/v1
    https://dev.jup.ag/docs/swap-api/

    solanaLookUpTable: string
    sorobanNetworkPassphrase: string
    stxHeroApiKey?: string
    stxIsTestnet?: boolean
    suiIsTestnet?: boolean
    tronJsonRpc?: string

    Optional. Will be used in methods
    LiquidityPoolService.getPoolInfoFromChain and LiquidityPoolService.getAmountToBeWithdrawn
    to fetch information from the blockchain with fewer HTTP requests using JSON-RPC API

    wormholeMessengerProgramId: string

    Settings

    Member Visibility

    On This Page

    Properties