Function QuoteApiFactory

Returns {
    quotesaverdeposit(height?, asset?, amount?, options?): AxiosPromise<QuoteSaverDepositResponse>;
    quotesaverwithdraw(height?, asset?, address?, withdrawBps?, options?): AxiosPromise<QuoteSaverWithdrawResponse>;
    quoteswap(height?, fromAsset?, toAsset?, amount?, destination?, toleranceBps?, affiliateBps?, affiliate?, options?): AxiosPromise<QuoteSwapResponse>;
}

• quotesaverdeposit:function

  • quotesaverdeposit(height?, asset?, amount?, options?): AxiosPromise<QuoteSaverDepositResponse>

  • Provide a quote estimate for the provided saver deposit.

    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: any

      Override http request option.

    Returns AxiosPromise<QuoteSaverDepositResponse>

    Throws

• quotesaverwithdraw:function

  • quotesaverwithdraw(height?, asset?, address?, withdrawBps?, options?): AxiosPromise<QuoteSaverWithdrawResponse>

  • Provide a quote estimate for the provided saver withdraw.

    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: any

      Override http request option.

    Returns AxiosPromise<QuoteSaverWithdrawResponse>

    Throws

• quoteswap:function

  • quoteswap(height?, fromAsset?, toAsset?, amount?, destination?, toleranceBps?, affiliateBps?, affiliate?, options?): AxiosPromise<QuoteSwapResponse>

  • Provide a quote estimate for the provided swap.

    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: any

      Override http request option.

    Returns AxiosPromise<QuoteSwapResponse>

    Throws