Preparing search index...
The search index is not available
Kaspa RPC Client - v1.1.8
Kaspa RPC Client
lib/Client
Client
Class Client
Hierarchy
ClientProvider
Client
Index
Constructors
constructor
Properties
ready
rpc
Methods
connect
disconnect
estimate
Network
Hashes
Per
Second
get
Balance
By
Address
get
Balances
By
Addresses
get
Block
get
Block
Count
get
Block
Dag
Info
get
Block
Template
get
Blocks
get
Coin
Supply
get
Connected
Peer
Info
get
Current
Network
get
Headers
get
Info
get
Mempool
Entries
get
Mempool
Entries
By
Addresses
get
Mempool
Entry
get
Peer
Addresses
get
Selected
Tip
Hash
get
Subnetwork
get
Utxos
By
Addresses
get
Virtual
Selected
Parent
Blue
Score
get
Virtual
Selected
Parent
Chain
From
Block
is
Ready
ping
request
submit
Block
submit
Transaction
subscribe
subscribe
Block
Added
subscribe
New
Block
Template
subscribe
Pruning
PointUTXOSet
Override
subscribe
Utxos
Changed
subscribe
Virtual
Daa
Score
Changed
subscribe
Virtual
Selected
Parent
Blue
Score
Changed
subscribe
Virtual
Selected
Parent
Chain
Changed
un
Subscribe
un
Subscribe
Block
Added
un
Subscribe
New
Block
Template
un
Subscribe
Pruning
PointUTXOSet
Override
un
Subscribe
Utxos
Changed
un
Subscribe
Virtual
Daa
Score
Changed
un
Subscribe
Virtual
Selected
Parent
Blue
Score
Changed
un
Subscribe
Virtual
Selected
Parent
Chain
Changed
Constructors
constructor
new
Client
(
__namedParameters
:
{
host
:
string
;
verbose
?:
boolean
;
}
)
:
Client
Parameters
__namedParameters:
{
host
:
string
;
verbose
?:
boolean
;
}
host
:
string
Optional
verbose
?:
boolean
Returns
Client
Properties
ready
ready
:
boolean
= false
rpc
rpc
:
RpcClient
Methods
connect
connect
(
)
:
Promise
<
unknown
>
Returns
Promise
<
unknown
>
disconnect
disconnect
(
)
:
void
Returns
void
estimate
Network
Hashes
Per
Second
estimate
Network
Hashes
Per
Second
(
data
:
EstimateNetworkHashesPerSecondRequestMessage
)
:
Promise
<
EstimateNetworkHashesPerSecondResponseMessage
>
Parameters
data:
EstimateNetworkHashesPerSecondRequestMessage
Returns
Promise
<
EstimateNetworkHashesPerSecondResponseMessage
>
get
Balance
By
Address
get
Balance
By
Address
(
data
:
GetBalanceByAddressRequestMessage
)
:
Promise
<
GetBalanceByAddressResponseMessage
>
Parameters
data:
GetBalanceByAddressRequestMessage
Returns
Promise
<
GetBalanceByAddressResponseMessage
>
get
Balances
By
Addresses
get
Balances
By
Addresses
(
data
:
GetBalancesByAddressesRequestMessage
)
:
Promise
<
GetBalancesByAddressesResponseMessage
>
Parameters
data:
GetBalancesByAddressesRequestMessage
Returns
Promise
<
GetBalancesByAddressesResponseMessage
>
get
Block
get
Block
(
data
:
GetBlockRequestMessage
)
:
Promise
<
GetBlockResponseMessage
>
Parameters
data:
GetBlockRequestMessage
Returns
Promise
<
GetBlockResponseMessage
>
get
Block
Count
get
Block
Count
(
)
:
Promise
<
GetBlockCountResponseMessage
>
Returns
Promise
<
GetBlockCountResponseMessage
>
get
Block
Dag
Info
get
Block
Dag
Info
(
)
:
Promise
<
GetBlockDagInfoResponseMessage
>
Returns
Promise
<
GetBlockDagInfoResponseMessage
>
get
Block
Template
get
Block
Template
(
data
:
GetBlockTemplateRequestMessage
)
:
Promise
<
GetBlockTemplateResponseMessage
>
Parameters
data:
GetBlockTemplateRequestMessage
Returns
Promise
<
GetBlockTemplateResponseMessage
>
get
Blocks
get
Blocks
(
data
:
GetBlocksRequestMessage
)
:
Promise
<
GetBlocksResponseMessage
>
Parameters
data:
GetBlocksRequestMessage
Returns
Promise
<
GetBlocksResponseMessage
>
get
Coin
Supply
get
Coin
Supply
(
)
:
Promise
<
GetCoinSupplyResponseMessage
>
Returns
Promise
<
GetCoinSupplyResponseMessage
>
get
Connected
Peer
Info
get
Connected
Peer
Info
(
)
:
Promise
<
GetConnectedPeerInfoResponseMessage
>
Returns
Promise
<
GetConnectedPeerInfoResponseMessage
>
get
Current
Network
get
Current
Network
(
)
:
Promise
<
GetCurrentNetworkResponseMessage
>
Returns
Promise
<
GetCurrentNetworkResponseMessage
>
get
Headers
get
Headers
(
data
:
GetHeadersRequestMessage
)
:
Promise
<
GetHeadersResponseMessage
>
Parameters
data:
GetHeadersRequestMessage
Returns
Promise
<
GetHeadersResponseMessage
>
get
Info
get
Info
(
)
:
Promise
<
GetInfoResponseMessage
>
Returns
Promise
<
GetInfoResponseMessage
>
get
Mempool
Entries
get
Mempool
Entries
(
data
:
GetMempoolEntriesRequestMessage
)
:
Promise
<
GetMempoolEntriesResponseMessage
>
Parameters
data:
GetMempoolEntriesRequestMessage
Returns
Promise
<
GetMempoolEntriesResponseMessage
>
get
Mempool
Entries
By
Addresses
get
Mempool
Entries
By
Addresses
(
data
:
GetMempoolEntriesByAddressesRequestMessage
)
:
Promise
<
GetMempoolEntriesByAddressesResponseMessage
>
Parameters
data:
GetMempoolEntriesByAddressesRequestMessage
Returns
Promise
<
GetMempoolEntriesByAddressesResponseMessage
>
get
Mempool
Entry
get
Mempool
Entry
(
data
:
GetMempoolEntryRequestMessage
)
:
Promise
<
GetMempoolEntryResponseMessage
>
Parameters
data:
GetMempoolEntryRequestMessage
Returns
Promise
<
GetMempoolEntryResponseMessage
>
get
Peer
Addresses
get
Peer
Addresses
(
)
:
Promise
<
GetPeerAddressesResponseMessage
>
Returns
Promise
<
GetPeerAddressesResponseMessage
>
get
Selected
Tip
Hash
get
Selected
Tip
Hash
(
)
:
Promise
<
GetSelectedTipHashResponseMessage
>
Returns
Promise
<
GetSelectedTipHashResponseMessage
>
get
Subnetwork
get
Subnetwork
(
data
:
GetSubnetworkRequestMessage
)
:
Promise
<
GetSubnetworkResponseMessage
>
Parameters
data:
GetSubnetworkRequestMessage
Returns
Promise
<
GetSubnetworkResponseMessage
>
get
Utxos
By
Addresses
get
Utxos
By
Addresses
(
data
:
GetUtxosByAddressesRequestMessage
)
:
Promise
<
GetUtxosByAddressesResponseMessage
>
Parameters
data:
GetUtxosByAddressesRequestMessage
Returns
Promise
<
GetUtxosByAddressesResponseMessage
>
get
Virtual
Selected
Parent
Blue
Score
get
Virtual
Selected
Parent
Blue
Score
(
)
:
Promise
<
GetVirtualSelectedParentBlueScoreResponseMessage
>
Returns
Promise
<
GetVirtualSelectedParentBlueScoreResponseMessage
>
get
Virtual
Selected
Parent
Chain
From
Block
get
Virtual
Selected
Parent
Chain
From
Block
(
data
:
GetVirtualSelectedParentChainFromBlockRequestMessage
)
:
Promise
<
GetVirtualSelectedParentChainFromBlockResponseMessage
>
Parameters
data:
GetVirtualSelectedParentChainFromBlockRequestMessage
Returns
Promise
<
GetVirtualSelectedParentChainFromBlockResponseMessage
>
is
Ready
is
Ready
(
)
:
boolean
Returns
boolean
ping
ping
(
)
:
Promise
<
boolean
>
Returns
Promise
<
boolean
>
request
request
<
T
>
(
method
:
string
, data
:
any
)
:
Promise
<
T
>
Type Parameters
T
Parameters
method:
string
data:
any
Returns
Promise
<
T
>
submit
Block
submit
Block
(
data
:
SubmitBlockRequestMessage
)
:
Promise
<
SubmitBlockResponseMessage
>
Parameters
data:
SubmitBlockRequestMessage
Returns
Promise
<
SubmitBlockResponseMessage
>
submit
Transaction
submit
Transaction
(
data
:
SubmitTransactionRequestMessage
)
:
Promise
<
SubmitTransactionResponseMessage
>
Parameters
data:
SubmitTransactionRequestMessage
Returns
Promise
<
SubmitTransactionResponseMessage
>
subscribe
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
>
subscribe
Block
Added
subscribe
Block
Added
(
callback
:
callback
<
BlockAddedNotificationMessage
>
)
:
SubPromise
<
NotifyBlockAddedResponseMessage
>
Parameters
callback:
callback
<
BlockAddedNotificationMessage
>
Returns
SubPromise
<
NotifyBlockAddedResponseMessage
>
subscribe
New
Block
Template
subscribe
New
Block
Template
(
callback
:
callback
<
NewBlockTemplateNotificationMessage
>
)
:
SubPromise
<
NotifyNewBlockTemplateResponseMessage
>
Parameters
callback:
callback
<
NewBlockTemplateNotificationMessage
>
Returns
SubPromise
<
NotifyNewBlockTemplateResponseMessage
>
subscribe
Pruning
PointUTXOSet
Override
subscribe
Pruning
PointUTXOSet
Override
(
callback
:
callback
<
PruningPointUTXOSetOverrideNotificationMessage
>
)
:
SubPromise
<
NotifyPruningPointUTXOSetOverrideResponseMessage
>
Parameters
callback:
callback
<
PruningPointUTXOSetOverrideNotificationMessage
>
Returns
SubPromise
<
NotifyPruningPointUTXOSetOverrideResponseMessage
>
subscribe
Utxos
Changed
subscribe
Utxos
Changed
(
data
:
NotifyUtxosChangedRequestMessage
, callback
:
callback
<
UtxosChangedNotificationMessage
>
)
:
SubPromise
<
NotifyUtxosChangedResponseMessage
>
Parameters
data:
NotifyUtxosChangedRequestMessage
callback:
callback
<
UtxosChangedNotificationMessage
>
Returns
SubPromise
<
NotifyUtxosChangedResponseMessage
>
subscribe
Virtual
Daa
Score
Changed
subscribe
Virtual
Daa
Score
Changed
(
callback
:
callback
<
VirtualDaaScoreChangedNotificationMessage
>
)
:
SubPromise
<
NotifyVirtualDaaScoreChangedResponseMessage
>
Parameters
callback:
callback
<
VirtualDaaScoreChangedNotificationMessage
>
Returns
SubPromise
<
NotifyVirtualDaaScoreChangedResponseMessage
>
subscribe
Virtual
Selected
Parent
Blue
Score
Changed
subscribe
Virtual
Selected
Parent
Blue
Score
Changed
(
callback
:
callback
<
VirtualSelectedParentBlueScoreChangedNotificationMessage
>
)
:
SubPromise
<
NotifyVirtualSelectedParentBlueScoreChangedResponseMessage
>
Parameters
callback:
callback
<
VirtualSelectedParentBlueScoreChangedNotificationMessage
>
Returns
SubPromise
<
NotifyVirtualSelectedParentBlueScoreChangedResponseMessage
>
subscribe
Virtual
Selected
Parent
Chain
Changed
subscribe
Virtual
Selected
Parent
Chain
Changed
(
data
:
NotifyVirtualSelectedParentChainChangedRequestMessage
, callback
:
callback
<
VirtualSelectedParentChainChangedNotificationMessage
>
)
:
SubPromise
<
NotifyVirtualSelectedParentChainChangedResponseMessage
>
Parameters
data:
NotifyVirtualSelectedParentChainChangedRequestMessage
callback:
callback
<
VirtualSelectedParentChainChangedNotificationMessage
>
Returns
SubPromise
<
NotifyVirtualSelectedParentChainChangedResponseMessage
>
un
Subscribe
un
Subscribe
(
method
:
string
, uid
?:
string
)
:
void
Parameters
method:
string
uid:
string
= ""
Returns
void
un
Subscribe
Block
Added
un
Subscribe
Block
Added
(
uid
?:
string
)
:
void
Parameters
uid:
string
= ""
Returns
void
un
Subscribe
New
Block
Template
un
Subscribe
New
Block
Template
(
uid
?:
string
)
:
void
Parameters
uid:
string
= ""
Returns
void
un
Subscribe
Pruning
PointUTXOSet
Override
un
Subscribe
Pruning
PointUTXOSet
Override
(
uid
?:
string
)
:
void
Parameters
uid:
string
= ""
Returns
void
un
Subscribe
Utxos
Changed
un
Subscribe
Utxos
Changed
(
uid
?:
string
)
:
void
Parameters
uid:
string
= ""
Returns
void
un
Subscribe
Virtual
Daa
Score
Changed
un
Subscribe
Virtual
Daa
Score
Changed
(
uid
?:
string
)
:
void
Parameters
uid:
string
= ""
Returns
void
un
Subscribe
Virtual
Selected
Parent
Blue
Score
Changed
un
Subscribe
Virtual
Selected
Parent
Blue
Score
Changed
(
uid
?:
string
)
:
void
Parameters
uid:
string
= ""
Returns
void
un
Subscribe
Virtual
Selected
Parent
Chain
Changed
un
Subscribe
Virtual
Selected
Parent
Chain
Changed
(
uid
?:
string
)
:
void
Parameters
uid:
string
= ""
Returns
void
Settings
Member Visibility
Inherited
Theme
OS
Light
Dark
On This Page
constructor
ready
rpc
connect
disconnect
estimate
Network
Hashes
Per
Second
get
Balance
By
Address
get
Balances
By
Addresses
get
Block
get
Block
Count
get
Block
Dag
Info
get
Block
Template
get
Blocks
get
Coin
Supply
get
Connected
Peer
Info
get
Current
Network
get
Headers
get
Info
get
Mempool
Entries
get
Mempool
Entries
By
Addresses
get
Mempool
Entry
get
Peer
Addresses
get
Selected
Tip
Hash
get
Subnetwork
get
Utxos
By
Addresses
get
Virtual
Selected
Parent
Blue
Score
get
Virtual
Selected
Parent
Chain
From
Block
is
Ready
ping
request
submit
Block
submit
Transaction
subscribe
subscribe
Block
Added
subscribe
New
Block
Template
subscribe
Pruning
PointUTXOSet
Override
subscribe
Utxos
Changed
subscribe
Virtual
Daa
Score
Changed
subscribe
Virtual
Selected
Parent
Blue
Score
Changed
subscribe
Virtual
Selected
Parent
Chain
Changed
un
Subscribe
un
Subscribe
Block
Added
un
Subscribe
New
Block
Template
un
Subscribe
Pruning
PointUTXOSet
Override
un
Subscribe
Utxos
Changed
un
Subscribe
Virtual
Daa
Score
Changed
un
Subscribe
Virtual
Selected
Parent
Blue
Score
Changed
un
Subscribe
Virtual
Selected
Parent
Chain
Changed
Kaspa RPC
Client -
v1.1.8
lib/
Account
Account
lib/
Address
Address
lib/
Client
Client
lib/
Client
Provider
Client
Provider
lib/
Client
Wrapper
Client
Wrapper
lib/
Utils
Utils
lib/
Wallet
Wallet
Config
types/custom-
types
RPC
Submit
Block
Response
Message_
Reject
Reason
Accepted
Transaction
Ids
Add
Peer
Request
Message
Add
Peer
Response
Message
Balances
By
Address
Entry
Ban
Request
Message
Ban
Response
Message
Block
Added
Notification
Message
Estimate
Network
Hashes
Per
Second
Request
Message
Estimate
Network
Hashes
Per
Second
Response
Message
Finality
Conflict
Notification
Message
Finality
Conflict
Resolved
Notification
Message
Get
Balance
By
Address
Request
Message
Get
Balance
By
Address
Response
Message
Get
Balances
By
Addresses
Request
Message
Get
Balances
By
Addresses
Response
Message
Get
Block
Count
Request
Message
Get
Block
Count
Response
Message
Get
Block
Dag
Info
Request
Message
Get
Block
Dag
Info
Response
Message
Get
Block
Request
Message
Get
Block
Response
Message
Get
Block
Template
Request
Message
Get
Block
Template
Response
Message
Get
Blocks
Request
Message
Get
Blocks
Response
Message
Get
Coin
Supply
Request
Message
Get
Coin
Supply
Response
Message
Get
Connected
Peer
Info
Message
Get
Connected
Peer
Info
Request
Message
Get
Connected
Peer
Info
Response
Message
Get
Current
Network
Request
Message
Get
Current
Network
Response
Message
Get
Headers
Request
Message
Get
Headers
Response
Message
Get
Info
Request
Message
Get
Info
Response
Message
Get
Mempool
Entries
By
Addresses
Request
Message
Get
Mempool
Entries
By
Addresses
Response
Message
Get
Mempool
Entries
Request
Message
Get
Mempool
Entries
Response
Message
Get
Mempool
Entry
Request
Message
Get
Mempool
Entry
Response
Message
Get
Peer
Addresses
Known
Address
Message
Get
Peer
Addresses
Request
Message
Get
Peer
Addresses
Response
Message
Get
Selected
Tip
Hash
Request
Message
Get
Selected
Tip
Hash
Response
Message
Get
Subnetwork
Request
Message
Get
Subnetwork
Response
Message
Get
Utxos
By
Addresses
Request
Message
Get
Utxos
By
Addresses
Response
Message
Get
Virtual
Selected
Parent
Blue
Score
Request
Message
Get
Virtual
Selected
Parent
Blue
Score
Response
Message
Get
Virtual
Selected
Parent
Chain
From
Block
Request
Message
Get
Virtual
Selected
Parent
Chain
From
Block
Response
Message
Mempool
Entry
Mempool
Entry
By
Address
New
Block
Template
Notification
Message
Notify
Block
Added
Request
Message
Notify
Block
Added
Response
Message
Notify
Finality
Conflicts
Request
Message
Notify
Finality
Conflicts
Response
Message
Notify
New
Block
Template
Request
Message
Notify
New
Block
Template
Response
Message
Notify
Pruning
PointUTXOSet
Override
Request
Message
Notify
Pruning
PointUTXOSet
Override
Response
Message
Notify
Utxos
Changed
Request
Message
Notify
Utxos
Changed
Response
Message
Notify
Virtual
Daa
Score
Changed
Request
Message
Notify
Virtual
Daa
Score
Changed
Response
Message
Notify
Virtual
Selected
Parent
Blue
Score
Changed
Request
Message
Notify
Virtual
Selected
Parent
Blue
Score
Changed
Response
Message
Notify
Virtual
Selected
Parent
Chain
Changed
Request
Message
Notify
Virtual
Selected
Parent
Chain
Changed
Response
Message
Pruning
PointUTXOSet
Override
Notification
Message
RPCError
Resolve
Finality
Conflict
Request
Message
Resolve
Finality
Conflict
Response
Message
Rpc
Block
Rpc
Block
Header
Rpc
Block
Level
Parents
Rpc
Block
Verbose
Data
Rpc
Outpoint
Rpc
Script
Public
Key
Rpc
Transaction
Rpc
Transaction
Input
Rpc
Transaction
Input
Verbose
Data
Rpc
Transaction
Output
Rpc
Transaction
Output
Verbose
Data
Rpc
Transaction
Verbose
Data
Rpc
Utxo
Entry
Shut
Down
Request
Message
Shut
Down
Response
Message
Stop
Notifying
Pruning
PointUTXOSet
Override
Request
Message
Stop
Notifying
Pruning
PointUTXOSet
Override
Response
Message
Stop
Notifying
Utxos
Changed
Request
Message
Stop
Notifying
Utxos
Changed
Response
Message
Sub
Promise
Submit
Block
Request
Message
Submit
Block
Response
Message
Submit
Transaction
Request
Message
Submit
Transaction
Response
Message
Unban
Request
Message
Unban
Response
Message
Utxos
By
Addresses
Entry
Utxos
Changed
Notification
Message
Virtual
Daa
Score
Changed
Notification
Message
Virtual
Selected
Parent
Blue
Score
Changed
Notification
Message
Virtual
Selected
Parent
Chain
Changed
Notification
Message
callback
Rust
Input
Outpoint
Output
Script
Public
Key
Transaction
UTXO
UTXOEntry
Address
Type
Account
Send
Props
Address
Send
Props
Client
Props
Create
Transaction
Props
IData
Kaspad
Package
Messages
Proto
Pending
Reqs
Queue
Item
Send
All
Props
Send
Common
Props
Send
Output
Props
Send
Transaction
Props
Subscriber
Item
Client
Options
Types
IStream
Set
Timeout
Type
Subscriber
Item
Map
bytes
Generated using
TypeDoc