Client | Kaspa RPC Client

Methods

connect

connect(): Promise<unknown>
Returns Promise<unknown>
- Defined in lib/Client.ts:17

disconnect

disconnect(): void
Returns void
- Defined in lib/Client.ts:21

isReady

isReady(): boolean
Returns boolean
- Defined in lib/Client.ts:25

ping

ping(): Promise<boolean>
Returns Promise<boolean>
- Defined in lib/Client.ts:29

request

request<T>(method: string, data: any): Promise<T>
Type Parameters
- T
Parameters
- method: string
- data: any
Returns Promise<T>
- Defined in lib/Client.ts:41

submitBlock

submitBlock(data: SubmitBlockRequestMessage): Promise<SubmitBlockResponseMessage>
Parameters
- data: SubmitBlockRequestMessage
Returns Promise<SubmitBlockResponseMessage>
- Defined in lib/Client.ts:85

submitTransaction

submitTransaction(data: SubmitTransactionRequestMessage): Promise<SubmitTransactionResponseMessage>
Parameters
- data: SubmitTransactionRequestMessage
Returns Promise<SubmitTransactionResponseMessage>
Overrides ClientProvider.submitTransaction
- Defined in lib/Client.ts:99

subscribe<T, R>(method: string, data: any, callback: callback<R>): SubPromise<T>
Type Parameters
- T
- R
Parameters
- method: string
- data: any
- callback: callback<R>
Returns SubPromise<T>
- Defined in lib/Client.ts:45

subscribeBlockAdded

subscribeBlockAdded(callback: callback<BlockAddedNotificationMessage>): SubPromise<NotifyBlockAddedResponseMessage>
Parameters
- callback: callback<BlockAddedNotificationMessage>
Returns SubPromise<NotifyBlockAddedResponseMessage>
- Defined in lib/Client.ts:257

subscribeNewBlockTemplate

subscribeNewBlockTemplate(callback: callback<NewBlockTemplateNotificationMessage>): SubPromise<NotifyNewBlockTemplateResponseMessage>
Parameters
- callback: callback<NewBlockTemplateNotificationMessage>
Returns SubPromise<NotifyNewBlockTemplateResponseMessage>
- Defined in lib/Client.ts:218

subscribePruningPointUTXOSetOverride

subscribePruningPointUTXOSetOverride(callback: callback<PruningPointUTXOSetOverrideNotificationMessage>): SubPromise<NotifyPruningPointUTXOSetOverrideResponseMessage>
Parameters
- callback: callback<PruningPointUTXOSetOverrideNotificationMessage>
Returns SubPromise<NotifyPruningPointUTXOSetOverrideResponseMessage>
- Defined in lib/Client.ts:244

subscribeUtxosChanged

subscribeUtxosChanged(data: NotifyUtxosChangedRequestMessage, callback: callback<UtxosChangedNotificationMessage>): SubPromise<NotifyUtxosChangedResponseMessage>
Parameters
- data: NotifyUtxosChangedRequestMessage
- callback: callback<UtxosChangedNotificationMessage>
Returns SubPromise<NotifyUtxosChangedResponseMessage>
Overrides ClientProvider.subscribeUtxosChanged
- Defined in lib/Client.ts:283

subscribeVirtualDaaScoreChanged

subscribeVirtualDaaScoreChanged(callback: callback<VirtualDaaScoreChangedNotificationMessage>): SubPromise<NotifyVirtualDaaScoreChangedResponseMessage>
Parameters
- callback: callback<VirtualDaaScoreChangedNotificationMessage>
Returns SubPromise<NotifyVirtualDaaScoreChangedResponseMessage>
- Defined in lib/Client.ts:231

subscribeVirtualSelectedParentBlueScoreChanged

subscribeVirtualSelectedParentBlueScoreChanged(callback: callback<VirtualSelectedParentBlueScoreChangedNotificationMessage>): SubPromise<NotifyVirtualSelectedParentBlueScoreChangedResponseMessage>
Parameters
- callback: callback<VirtualSelectedParentBlueScoreChangedNotificationMessage>
Returns SubPromise<NotifyVirtualSelectedParentBlueScoreChangedResponseMessage>
- Defined in lib/Client.ts:270

subscribeVirtualSelectedParentChainChanged

subscribeVirtualSelectedParentChainChanged(data: NotifyVirtualSelectedParentChainChangedRequestMessage, callback: callback<VirtualSelectedParentChainChangedNotificationMessage>): SubPromise<NotifyVirtualSelectedParentChainChangedResponseMessage>
Parameters
- data: NotifyVirtualSelectedParentChainChangedRequestMessage
- callback: callback<VirtualSelectedParentChainChangedNotificationMessage>
Returns SubPromise<NotifyVirtualSelectedParentChainChangedResponseMessage>
- Defined in lib/Client.ts:297

unSubscribe

unSubscribe(method: string, uid?: string): void
Parameters
- method: string
- uid: string = ""
Returns void
- Defined in lib/Client.ts:49

unSubscribeBlockAdded

unSubscribeBlockAdded(uid?: string): void
Parameters
- uid: string = ""
Returns void
- Defined in lib/Client.ts:266

unSubscribeNewBlockTemplate

unSubscribeNewBlockTemplate(uid?: string): void
Parameters
- uid: string = ""
Returns void
- Defined in lib/Client.ts:227

unSubscribePruningPointUTXOSetOverride

unSubscribePruningPointUTXOSetOverride(uid?: string): void
Parameters
- uid: string = ""
Returns void
- Defined in lib/Client.ts:253

unSubscribeUtxosChanged

unSubscribeUtxosChanged(uid?: string): void
Parameters
- uid: string = ""
Returns void
Overrides ClientProvider.unSubscribeUtxosChanged
- Defined in lib/Client.ts:293

unSubscribeVirtualDaaScoreChanged

unSubscribeVirtualDaaScoreChanged(uid?: string): void
Parameters
- uid: string = ""
Returns void
- Defined in lib/Client.ts:240

unSubscribeVirtualSelectedParentBlueScoreChanged

unSubscribeVirtualSelectedParentBlueScoreChanged(uid?: string): void
Parameters
- uid: string = ""
Returns void
- Defined in lib/Client.ts:279

unSubscribeVirtualSelectedParentChainChanged

unSubscribeVirtualSelectedParentChainChanged(uid?: string): void
Parameters
- uid: string = ""
Returns void
- Defined in lib/Client.ts:307

Class Client

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

__namedParameters: { host: string; verbose?: boolean; }

host: string

Optional verbose?: boolean

Returns Client

Properties

ready

rpc

Methods

connect

Returns Promise<unknown>

disconnect

Returns void

estimateNetworkHashesPerSecond

Parameters

data: EstimateNetworkHashesPerSecondRequestMessage

Returns Promise<EstimateNetworkHashesPerSecondResponseMessage>

getBalanceByAddress

Parameters

data: GetBalanceByAddressRequestMessage

Returns Promise<GetBalanceByAddressResponseMessage>

getBalancesByAddresses

Parameters

data: GetBalancesByAddressesRequestMessage

Returns Promise<GetBalancesByAddressesResponseMessage>

getBlock

Parameters

data: GetBlockRequestMessage

Returns Promise<GetBlockResponseMessage>

getBlockCount

Returns Promise<GetBlockCountResponseMessage>

getBlockDagInfo

Returns Promise<GetBlockDagInfoResponseMessage>

getBlockTemplate

Parameters

data: GetBlockTemplateRequestMessage

Returns Promise<GetBlockTemplateResponseMessage>

getBlocks

Parameters

data: GetBlocksRequestMessage

Returns Promise<GetBlocksResponseMessage>

getCoinSupply

Returns Promise<GetCoinSupplyResponseMessage>

getConnectedPeerInfo

Returns Promise<GetConnectedPeerInfoResponseMessage>

getCurrentNetwork

Returns Promise<GetCurrentNetworkResponseMessage>

getHeaders

Parameters

data: GetHeadersRequestMessage

Returns Promise<GetHeadersResponseMessage>

getInfo

Returns Promise<GetInfoResponseMessage>

getMempoolEntries

Parameters

data: GetMempoolEntriesRequestMessage

Returns Promise<GetMempoolEntriesResponseMessage>

getMempoolEntriesByAddresses

Parameters

data: GetMempoolEntriesByAddressesRequestMessage

Returns Promise<GetMempoolEntriesByAddressesResponseMessage>

getMempoolEntry

Parameters

data: GetMempoolEntryRequestMessage

Returns Promise<GetMempoolEntryResponseMessage>

getPeerAddresses

Returns Promise<GetPeerAddressesResponseMessage>

getSelectedTipHash

Returns Promise<GetSelectedTipHashResponseMessage>

getSubnetwork

Parameters

data: GetSubnetworkRequestMessage

__namedParameters: {
host: string;
verbose?: boolean;
}

`Optional` verbose?: boolean