Class MimirApi

MimirApi - object-oriented interface

Export

MimirApi

Hierarchy

BaseAPI
- MimirApi

Index

Constructors

constructor

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

mimir

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

mimirAdmin

mimirAdmin(height?, options?): Promise<AxiosResponse<MimirResponse, any>>
Returns current admin mimir configuration.
Parameters
- Optional height: number
  optional block height, defaults to current tip
- Optional options: AxiosRequestConfig<any>
  Override http request option.
Returns Promise<AxiosResponse<MimirResponse, any>>
Throws
Memberof
MimirApi
- Defined in xchainjs-lib/packages/xchain-mayanode/src/generated/mayanodeApi/api.ts:2769

mimirKey

mimirKey(key, height?, options?): Promise<AxiosResponse<number, any>>
Returns current active mimir configuration for the provided key.
Parameters
- key: string
  the mimir key to lookup
- Optional height: number
  optional block height, defaults to current tip
- Optional options: AxiosRequestConfig<any>
  Override http request option.
Returns Promise<AxiosResponse<number, any>>
Throws
Memberof
MimirApi
- Defined in xchainjs-lib/packages/xchain-mayanode/src/generated/mayanodeApi/api.ts:2781

mimirNode

mimirNode(address, height?, options?): Promise<AxiosResponse<MimirResponse, any>>
Returns current node mimir configuration for the provided node address.
Parameters
- address: string
- Optional height: number
  optional block height, defaults to current tip
- Optional options: AxiosRequestConfig<any>
  Override http request option.
Returns Promise<AxiosResponse<MimirResponse, any>>
Throws
Memberof
MimirApi
- Defined in xchainjs-lib/packages/xchain-mayanode/src/generated/mayanodeApi/api.ts:2793

mimirNodes

mimirNodes(height?, options?): Promise<AxiosResponse<MimirNodesResponse, any>>
Returns current node mimir votes.
Parameters
- Optional height: number
  optional block height, defaults to current tip
- Optional options: AxiosRequestConfig<any>
  Override http request option.
Returns Promise<AxiosResponse<MimirNodesResponse, any>>
Throws
Memberof
MimirApi
- Defined in xchainjs-lib/packages/xchain-mayanode/src/generated/mayanodeApi/api.ts:2804

Class MimirApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns MimirApi

Properties

Protected axios

Protected basePath

Protected configuration

Methods

mimir

Parameters

Returns Promise<AxiosResponse<MimirResponse, any>>

Throws

Memberof

mimirAdmin

Parameters

Returns Promise<AxiosResponse<MimirResponse, any>>

Throws

Memberof

mimirKey

Parameters

Returns Promise<AxiosResponse<number, any>>

Throws

Memberof

mimirNode

Parameters

Returns Promise<AxiosResponse<MimirResponse, any>>

Throws

Memberof

mimirNodes

Parameters

Returns Promise<AxiosResponse<MimirNodesResponse, any>>

Throws

Memberof

Settings

Member Visibility

Theme

On This Page

`Protected` axios

`Protected` basePath

`Protected` configuration