Class NetworkApi

NetworkApi - object-oriented interface

Export

NetworkApi

Hierarchy

BaseAPI
- NetworkApi

Index

Constructors

constructor

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

ban

ban(address, height?, options?): Promise<AxiosResponse<BanResponse, any>>
Returns the ban status 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<BanResponse, any>>
Throws
Memberof
NetworkApi
- Defined in xchainjs-lib/packages/xchain-mayanode/src/generated/mayanodeApi/api.ts:3290

constants

constants(height?, options?): Promise<AxiosResponse<ConstantsResponse, any>>
Returns constant configuration, can be overridden by mimir.
Parameters
- Optional height: number
  optional block height, defaults to current tip
- Optional options: AxiosRequestConfig<any>
  Override http request option.
Returns Promise<AxiosResponse<ConstantsResponse, any>>
Throws
Memberof
NetworkApi
- Defined in xchainjs-lib/packages/xchain-mayanode/src/generated/mayanodeApi/api.ts:3301

inboundAddresses

inboundAddresses(height?, options?): Promise<AxiosResponse<InboundAddressesResponse, any>>
Returns the set of asgard addresses that should be used for inbound transactions.
Parameters
- Optional height: number
  optional block height, defaults to current tip
- Optional options: AxiosRequestConfig<any>
  Override http request option.
Returns Promise<AxiosResponse<InboundAddressesResponse, any>>
Throws
Memberof
NetworkApi
- Defined in xchainjs-lib/packages/xchain-mayanode/src/generated/mayanodeApi/api.ts:3312

lastblock

lastblock(height?, options?): Promise<AxiosResponse<LastBlockResponse, any>>
Returns the last block information for all chains.
Parameters
- Optional height: number
  optional block height, defaults to current tip
- Optional options: AxiosRequestConfig<any>
  Override http request option.
Returns Promise<AxiosResponse<LastBlockResponse, any>>
Throws
Memberof
NetworkApi
- Defined in xchainjs-lib/packages/xchain-mayanode/src/generated/mayanodeApi/api.ts:3323

lastblockChain

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

network

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

ragnarok

ragnarok(height?, options?): Promise<AxiosResponse<boolean, any>>
Returns a boolean indicating whether the chain is in ragnarok.
Parameters
- Optional height: number
  optional block height, defaults to current tip
- Optional options: AxiosRequestConfig<any>
  Override http request option.
Returns Promise<AxiosResponse<boolean, any>>
Throws
Memberof
NetworkApi
- Defined in xchainjs-lib/packages/xchain-mayanode/src/generated/mayanodeApi/api.ts:3357

version

version(height?, options?): Promise<AxiosResponse<VersionResponse, any>>
Returns the network's current MAYANode version, the network's next MAYANode version, and the querier's MAYANode version.
Parameters
- Optional height: number
  optional block height, defaults to current tip
- Optional options: AxiosRequestConfig<any>
  Override http request option.
Returns Promise<AxiosResponse<VersionResponse, any>>
Throws
Memberof
NetworkApi
- Defined in xchainjs-lib/packages/xchain-mayanode/src/generated/mayanodeApi/api.ts:3368

Class NetworkApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns NetworkApi

Properties

Protected axios

Protected basePath

Protected configuration

Methods

ban

Parameters

Returns Promise<AxiosResponse<BanResponse, any>>

Throws

Memberof

constants

Parameters

Returns Promise<AxiosResponse<ConstantsResponse, any>>

Throws

Memberof

inboundAddresses

Parameters

Returns Promise<AxiosResponse<InboundAddressesResponse, any>>

Throws

Memberof

lastblock

Parameters

Returns Promise<AxiosResponse<LastBlockResponse, any>>

Throws

Memberof

lastblockChain

Parameters

Returns Promise<AxiosResponse<LastBlockResponse, any>>

Throws

Memberof

network

Parameters

Returns Promise<AxiosResponse<NetworkResponse, any>>

Throws

Memberof

ragnarok

Parameters

Returns Promise<AxiosResponse<boolean, any>>

Throws

Memberof

version

Parameters

Returns Promise<AxiosResponse<VersionResponse, any>>

Throws

Memberof

Settings

Member Visibility

Theme

On This Page

`Protected` axios

`Protected` basePath

`Protected` configuration