Class VaultsApi

VaultsApi - object-oriented interface

Export

VaultsApi

Hierarchy

BaseAPI
- VaultsApi

Index

Constructors

Properties

axios basePath configuration

Methods

asgard vault vaultPubkeys yggdrasil

Constructors

constructor

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

asgard

asgard(height?, options?): Promise<AxiosResponse<VaultsResponse, any>>
Returns current asgard vaults.
Parameters
- Optional height: number
  optional block height, defaults to current tip
- Optional options: AxiosRequestConfig<any>
  Override http request option.
Returns Promise<AxiosResponse<VaultsResponse, any>>
Throws
Memberof
VaultsApi
- Defined in xchainjs-lib/packages/xchain-mayanode/src/generated/mayanodeApi/api.ts:5312

vault

vault(pubkey, height?, options?): Promise<AxiosResponse<Vault, any>>
Returns the vault for the provided pubkey.
Parameters
- pubkey: string
- Optional height: number
  optional block height, defaults to current tip
- Optional options: AxiosRequestConfig<any>
  Override http request option.
Returns Promise<AxiosResponse<Vault, any>>
Throws
Memberof
VaultsApi
- Defined in xchainjs-lib/packages/xchain-mayanode/src/generated/mayanodeApi/api.ts:5324

vaultPubkeys

vaultPubkeys(height?, options?): Promise<AxiosResponse<VaultPubkeysResponse, any>>
Returns all pubkeys for current vaults.
Parameters
- Optional height: number
  optional block height, defaults to current tip
- Optional options: AxiosRequestConfig<any>
  Override http request option.
Returns Promise<AxiosResponse<VaultPubkeysResponse, any>>
Throws
Memberof
VaultsApi
- Defined in xchainjs-lib/packages/xchain-mayanode/src/generated/mayanodeApi/api.ts:5335

yggdrasil

yggdrasil(height?, options?): Promise<AxiosResponse<VaultsResponse, any>>
Returns current yggdrasil vaults.
Parameters
- Optional height: number
  optional block height, defaults to current tip
- Optional options: AxiosRequestConfig<any>
  Override http request option.
Returns Promise<AxiosResponse<VaultsResponse, any>>
Throws
Memberof
VaultsApi
- Defined in xchainjs-lib/packages/xchain-mayanode/src/generated/mayanodeApi/api.ts:5346

Generated using TypeDoc