Class NodesApi

NodesApi - object-oriented interface

Export

NodesApi

Hierarchy

BaseAPI
- NodesApi

Index

Constructors

Properties

axios basePath configuration

Methods

Constructors

constructor

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

node

node(address, height?, options?): Promise<AxiosResponse<Node, any>>
Returns node information 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<Node, any>>
Throws
Memberof
NodesApi
- Defined in xchainjs-lib/packages/xchain-mayanode/src/generated/mayanodeApi/api.ts:3530

nodes

nodes(height?, options?): Promise<AxiosResponse<NodesResponse, any>>
Returns node information for all registered validators.
Parameters
- Optional height: number
  optional block height, defaults to current tip
- Optional options: AxiosRequestConfig<any>
  Override http request option.
Returns Promise<AxiosResponse<NodesResponse, any>>
Throws
Memberof
NodesApi
- Defined in xchainjs-lib/packages/xchain-mayanode/src/generated/mayanodeApi/api.ts:3541

Generated using TypeDoc