Class QuoteApi

QuoteApi - object-oriented interface

Export

QuoteApi

Hierarchy

BaseAPI
- QuoteApi

Index

Constructors

Properties

axios basePath configuration

Methods

quotesaverdeposit quotesaverwithdraw quoteswap

Constructors

constructor

new QuoteApi(configuration?, basePath?, axios?): QuoteApi
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns QuoteApi
Inherited from BaseAPI.constructor
- Defined in xchainjs-lib/packages/xchain-mayanode/src/generated/mayanodeApi/base.ts:52

Properties

`Protected` axios

axios: AxiosInstance = globalAxios

`Protected` basePath

basePath: string = BASE_PATH

`Protected` configuration

configuration: undefined | Configuration

Methods

quotesaverdeposit

quotesaverdeposit(height?, asset?, amount?, options?): Promise<AxiosResponse<QuoteSaverDepositResponse, any>>
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: AxiosRequestConfig<any>
  Override http request option.
Returns Promise<AxiosResponse<QuoteSaverDepositResponse, any>>
Throws
Memberof
QuoteApi
- Defined in xchainjs-lib/packages/xchain-mayanode/src/generated/mayanodeApi/api.ts:4340

quotesaverwithdraw

quotesaverwithdraw(height?, asset?, address?, withdrawBps?, options?): Promise<AxiosResponse<QuoteSaverWithdrawResponse, any>>
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: AxiosRequestConfig<any>
  Override http request option.
Returns Promise<AxiosResponse<QuoteSaverWithdrawResponse, any>>
Throws
Memberof
QuoteApi
- Defined in xchainjs-lib/packages/xchain-mayanode/src/generated/mayanodeApi/api.ts:4354

quoteswap

quoteswap(height?, fromAsset?, toAsset?, amount?, destination?, toleranceBps?, affiliateBps?, affiliate?, options?): Promise<AxiosResponse<QuoteSwapResponse, any>>
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: AxiosRequestConfig<any>
  Override http request option.
Returns Promise<AxiosResponse<QuoteSwapResponse, any>>
Throws
Memberof
QuoteApi
- Defined in xchainjs-lib/packages/xchain-mayanode/src/generated/mayanodeApi/api.ts:4372

Generated using TypeDoc