Class TSSApi

TSSApi - object-oriented interface

Export

TSSApi

Hierarchy

BaseAPI
- TSSApi

Index

Constructors

Properties

axios basePath configuration

Methods

keysign keysignPubkey metrics metricsKeygen

Constructors

constructor

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

keysign

keysign(height, options?): Promise<AxiosResponse<KeysignResponse, any>>
Returns keysign information for the provided height - the height being the first block a tx out item appears in the signed-but-unobserved outbound queue.
Parameters
- height: number
- Optional options: AxiosRequestConfig<any>
  Override http request option.
Returns Promise<AxiosResponse<KeysignResponse, any>>
Throws
Memberof
TSSApi
- Defined in xchainjs-lib/packages/xchain-mayanode/src/generated/mayanodeApi/api.ts:4830

keysignPubkey

keysignPubkey(height, pubkey, options?): Promise<AxiosResponse<KeysignResponse, any>>
Returns keysign information for the provided height and pubkey - the height being the block at which a tx out item is scheduled to be signed and moved from the scheduled outbound queue to the outbound queue.
Parameters
- height: number
- pubkey: string
- Optional options: AxiosRequestConfig<any>
  Override http request option.
Returns Promise<AxiosResponse<KeysignResponse, any>>
Throws
Memberof
TSSApi
- Defined in xchainjs-lib/packages/xchain-mayanode/src/generated/mayanodeApi/api.ts:4842

metrics

metrics(height?, options?): Promise<AxiosResponse<MetricsResponse, any>>
Returns keygen and keysign metrics 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<MetricsResponse, any>>
Throws
Memberof
TSSApi
- Defined in xchainjs-lib/packages/xchain-mayanode/src/generated/mayanodeApi/api.ts:4853

metricsKeygen

metricsKeygen(pubkey, height?, options?): Promise<AxiosResponse<KeygenMetricsResponse, any>>
Returns keygen metrics for the provided vault 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<KeygenMetricsResponse, any>>
Throws
Memberof
TSSApi
- Defined in xchainjs-lib/packages/xchain-mayanode/src/generated/mayanodeApi/api.ts:4865

Generated using TypeDoc