Constructor
new NodeClient(node)
Create a node client.
Parameters:
| Name | Type | Description |
|---|---|---|
node |
Node |
- Source:
Members
node :Node
Type:
- Source:
Methods
(async) addFilter(data) → {Promise.<void>}
Add data to filter.
Parameters:
| Name | Type | Description |
|---|---|---|
data |
Buffer |
- Source:
Returns:
- Type
- Promise.<void>
bind(type, handler)
Add a listener.
Parameters:
| Name | Type | Description |
|---|---|---|
type |
String | |
handler |
function |
- Source:
(async) close() → {Promise.<void>}
Close the client.
- Source:
Returns:
- Type
- Promise.<void>
(async) estimateFee(blocksnullable) → {Promise.<Number>}
Esimate smart fee.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
blocks |
Number |
<nullable> |
- Source:
Returns:
- Type
- Promise.<Number>
(async) getBlockHeader(block) → {Promise.<ChainEntry>}
Get block header.
Parameters:
| Name | Type | Description |
|---|---|---|
block |
Hash | Number |
- Source:
Returns:
- Type
- Promise.<ChainEntry>
(async) getCoin(hash, index) → {Object}
Get UTXO.
Parameters:
| Name | Type | Description |
|---|---|---|
hash |
Hash | |
index |
Number |
- Source:
Returns:
- Type
- Object
(async) getEntries(start, end) → {Promise.<Array.<ChainEntry>>}
Get entries range.
Parameters:
| Name | Type | Description |
|---|---|---|
start |
Number | |
end |
Number |
- Source:
Returns:
- Type
- Promise.<Array.<ChainEntry>>
(async) getEntry(hash) → {Promise.<?ChainEntry>}
Get chain entry.
Parameters:
| Name | Type | Description |
|---|---|---|
hash |
Hash |
- Source:
Returns:
- Type
- Promise.<?ChainEntry>
(async) getHashes(start, end) → {Promise.<Array.<Hash>>}
Get hash range.
Parameters:
| Name | Type | Description |
|---|---|---|
start |
Number | |
end |
Number |
- Source:
Returns:
- Type
- Promise.<Array.<Hash>>
(async) getNameStatus(nameHash) → {Promise.<NameState>}
Get name state.
Parameters:
| Name | Type | Description |
|---|---|---|
nameHash |
Buffer |
- Source:
Returns:
- Type
- Promise.<NameState>
(async) getTip() → {Promise.<ChainEntry>}
Get chain tip.
- Source:
Returns:
- Type
- Promise.<ChainEntry>
handleCall(event, …args) → {Promise}
Call a hook.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
event |
String | ||
args |
Object |
<repeatable> |
- Source:
Returns:
- Type
- Promise
hook(event, handler)
Add a hook.
Parameters:
| Name | Type | Description |
|---|---|---|
event |
String | |
handler |
function |
- Source:
init()
Initialize the client.
- Source:
(async) open() → {Promise.<void>}
Open the client.
- Source:
Returns:
- Type
- Promise.<void>
(async) rescan(start) → {Promise.<void>}
Rescan for any missed transactions.
Parameters:
| Name | Type | Description |
|---|---|---|
start |
Number | Hash | Start block. |
- Source:
Returns:
- Type
- Promise.<void>
(async) rescanInteractive(start, fullLockopt) → {Promise.<void>}
Rescan interactive for any missed transactions.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
start |
Number | Hash | Start block. |
||
fullLock |
Boolean |
<optional> |
false |
- Source:
Returns:
- Type
- Promise.<void>
(async) resetFilter() → {Promise.<void>}
Reset filter.
- Source:
Returns:
- Type
- Promise.<void>
(async) send(tx) → {Promise.<void>}
Send a transaction. Do not wait for promise.
Parameters:
| Name | Type | Description |
|---|---|---|
tx |
TX |
- Source:
Returns:
- Type
- Promise.<void>
(async) sendClaim(claim) → {Promise.<void>}
Send a claim. Do not wait for promise.
Parameters:
| Name | Type | Description |
|---|---|---|
claim |
Claim |
- Source:
Returns:
- Type
- Promise.<void>
(async) setFilter(filter) → {Promise.<void>}
Set bloom filter.
Parameters:
| Name | Type | Description |
|---|---|---|
filter |
BloomFilter |
- Source:
Returns:
- Type
- Promise.<void>
unhook(event)
Remove a hook.
Parameters:
| Name | Type | Description |
|---|---|---|
event |
String |
- Source: