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

    Interface LiquidityPoolService

    Do not use.

    interface LiquidityPoolService {
        rawTxBuilder: RawPoolTransactionBuilder;
        approve(
            provider: Provider,
            approveData: LiquidityPoolsApproveParams,
        ): Promise<TransactionResponse>;
        checkAllowance(
            provider: Provider,
            params: LiquidityPoolsCheckAllowanceParams,
        ): Promise<boolean>;
        checkAllowance(
            params: LiquidityPoolsCheckAllowanceParams,
        ): Promise<boolean>;
        getAllowance(
            provider: Provider,
            params: LiquidityPoolsGetAllowanceParams,
        ): Promise<string>;
        getAllowance(params: LiquidityPoolsGetAllowanceParams): Promise<string>;
        getAmountToBeDeposited(
            amount: string,
            token: TokenWithChainDetails,
            provider?: Provider,
        ): Promise<string>;
        getAmountToBeWithdrawn(
            amount: string,
            accountAddress: string,
            token: TokenWithChainDetails,
            provider?: Provider,
        ): Promise<string>;
        getPoolInfoFromChain(
            token: TokenWithChainDetails,
            provider?: Provider,
        ): Promise<Required<PoolInfo>>;
        getUserBalanceInfo(
            accountAddress: string,
            token: TokenWithChainDetails,
            provider?: Provider,
        ): Promise<UserBalanceInfo>;
    }
    Index

    Properties

    rawTxBuilder

    Methods

    approve checkAllowance getAllowance getAmountToBeDeposited getAmountToBeWithdrawn getPoolInfoFromChain getUserBalanceInfo

    Properties

    rawTxBuilder: RawPoolTransactionBuilder

    Do not use.

    Methods

    • Calculates the amount of tokens will be withdrawn

      Parameters

      • amount: string

        The float amount of tokens that will be sent

      • accountAddress: string
      • token: TokenWithChainDetails
      • Optionalprovider: Provider

        will be used to access the network

      Returns Promise<string>

      amount

      Do not use.

    Settings

    Member Visibility

    On This Page

    Properties
    Methods