Class SaversApi

SaversApi - object-oriented interface

Export

SaversApi

Hierarchy

BaseAPI
- SaversApi

Index

Constructors

Properties

axios basePath configuration

Methods

Constructors

constructor

new SaversApi(configuration?, basePath?, axios?): SaversApi
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns SaversApi
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

saver

saver(asset, address, height?, options?): Promise<AxiosResponse<Saver, any>>
Returns the saver position given then savers pool and address.
Parameters
- asset: string
- address: string
- Optional height: number
  optional block height, defaults to current tip
- Optional options: AxiosRequestConfig<any>
  Override http request option.
Returns Promise<AxiosResponse<Saver, any>>
Throws
Memberof
SaversApi
- Defined in xchainjs-lib/packages/xchain-mayanode/src/generated/mayanodeApi/api.ts:4547

savers

savers(asset, height?, options?): Promise<AxiosResponse<SaversResponse, any>>
Returns all savers for the savers pool.
Parameters
- asset: string
- Optional height: number
  optional block height, defaults to current tip
- Optional options: AxiosRequestConfig<any>
  Override http request option.
Returns Promise<AxiosResponse<SaversResponse, any>>
Throws
Memberof
SaversApi
- Defined in xchainjs-lib/packages/xchain-mayanode/src/generated/mayanodeApi/api.ts:4559

Generated using TypeDoc