Function QuoteApiAxiosParamCreator

  • QuoteApiAxiosParamCreator(configuration?): {
        quotesaverdeposit: ((height?, asset?, amount?, options?) => Promise<RequestArgs>);
        quotesaverwithdraw: ((height?, asset?, address?, withdrawBps?, options?) => Promise<RequestArgs>);
        quoteswap: ((height?, fromAsset?, toAsset?, amount?, destination?, toleranceBps?, affiliateBps?, affiliate?, options?) => Promise<RequestArgs>);
    }

  • QuoteApi - axios parameter creator

    Parameters

    Returns {
        quotesaverdeposit: ((height?, asset?, amount?, options?) => Promise<RequestArgs>);
        quotesaverwithdraw: ((height?, asset?, address?, withdrawBps?, options?) => Promise<RequestArgs>);
        quoteswap: ((height?, fromAsset?, toAsset?, amount?, destination?, toleranceBps?, affiliateBps?, affiliate?, options?) => Promise<RequestArgs>);
    }

    • quotesaverdeposit: ((height?, asset?, amount?, options?) => Promise<RequestArgs>)

      Provide a quote estimate for the provided saver deposit.

      Throws

        • (height?, asset?, amount?, options?): Promise<RequestArgs>

        • Parameters

          • Optional height: number

            optional block height, defaults to current tip

          • Optional asset: string

            the asset to deposit

          • Optional amount: number

            the source asset amount in 1e8 decimals

          • Optional options: AxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • quotesaverwithdraw: ((height?, asset?, address?, withdrawBps?, options?) => Promise<RequestArgs>)

      Provide a quote estimate for the provided saver withdraw.

      Throws

        • (height?, asset?, address?, withdrawBps?, options?): Promise<RequestArgs>

        • Parameters

          • Optional height: number

            optional block height, defaults to current tip

          • Optional asset: string

            the asset to withdraw

          • Optional address: string

            the address for the position

          • Optional withdrawBps: number

            the basis points of the existing position to withdraw

          • Optional options: AxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • quoteswap: ((height?, fromAsset?, toAsset?, amount?, destination?, toleranceBps?, affiliateBps?, affiliate?, options?) => Promise<RequestArgs>)

      Provide a quote estimate for the provided swap.

      Throws

        • (height?, fromAsset?, toAsset?, amount?, destination?, toleranceBps?, affiliateBps?, affiliate?, options?): Promise<RequestArgs>

        • Parameters

          • Optional height: number

            optional block height, defaults to current tip

          • Optional fromAsset: string

            the source asset

          • Optional toAsset: string

            the target asset

          • Optional amount: number

            the source asset amount in 1e8 decimals

          • Optional destination: string

            the destination address, required to generate memo

          • Optional toleranceBps: number

            the maximum basis points from the current feeless swap price to set the limit in the generated memo

          • Optional affiliateBps: number

            the affiliate fee in basis points

          • Optional affiliate: string

            the affiliate (address or mayaname)

          • Optional options: AxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

    Export

Settings

Member Visibility

Theme

Generated using TypeDoc