Lumina node wasm
lumina-node-wasm
Lumina node wasm
A compatibility layer for the Lumina node to
work within a browser environment and be operable with javascript.
Changelog
You can find about the latest changes here.
Example
Starting lumina inside a dedicated worker
import { spawnNode, Network, NodeConfig } from "lumina-node";
const node = await spawnNode();
const mainnetConfig = NodeConfig.default(Network.Mainnet);
await node.start(mainnetConfig);
await node.waitConnected();
await node.requestHeadHeader();
Manual setup
spawnNode sets up a DedicatedWorker instance and runs NodeWorker there. If you want to set things up manually
you need to connect client and worker using objects that have MessagePort interface.
import { Network, NodeClient, NodeConfig, NodeWorker } from "lumina-node";
const config = NodeConfig.default(Network.Mainnet);
// client and worker accept any object with MessagePort like interface e.g. Worker
const channel = new MessageChannel();
const worker = new NodeWorker(channel.port1);
// note that this runs lumina in the current context (and doesn't create a new web-worker). Promise created with `.run()` never completes.
const worker_promise = worker.run();
// client port can be used locally or transferred like any plain MessagePort
const client = await new NodeClient(channel.port2);
await client.waitConnected();
await client.requestHeadHeader();
Rust API
For comprehensive and fully typed interface documentation, see lumina-node
and celestia-types documentation on docs.rs.
You can see there the exact structure of more complex types, such as ExtendedHeader.
JavaScript API's goal is to provide similar interface to Rust when possible, e.g. NodeClient mirrors Node.
Classes
lumina-node-wasm / AbciMessageLog
Class: AbciMessageLog
ABCIMessageLog defines a structure containing an indexed tx ABCI message log.
Properties
events
events:
StringEvent[]
Events contains a slice of Event objects that were emitted during some execution.
Defined in
lumina_node_wasm.d.ts:157
log
log:
string
Defined in
lumina_node_wasm.d.ts:158
msg_index
msg_index:
number
Defined in
lumina_node_wasm.d.ts:159
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:152
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:151
lumina-node-wasm / AbciQueryResponse
Class: AbciQueryResponse
Response to a tx query
Properties
code
code:
ErrorCode
Response code.
Defined in
lumina_node_wasm.d.ts:179
codespace
codespace:
string
Namespace for the Code.
Defined in
lumina_node_wasm.d.ts:183
height
readonlyheight:bigint
The block height from which data was derived.
Note that this is the height of the block containing the application's Merkle root hash, which represents the state as it was after committing the block at height - 1.
Defined in
lumina_node_wasm.d.ts:175
index
index:
bigint
The index of the key in the tree.
Defined in
lumina_node_wasm.d.ts:187
info
info:
string
Additional information. May be non-deterministic.
Defined in
lumina_node_wasm.d.ts:191
key
key:
Uint8Array<ArrayBufferLike>
The key of the matching data.
Defined in
lumina_node_wasm.d.ts:195
log
log:
string
The output of the application's logger (raw string). May be non-deterministic.
Defined in
lumina_node_wasm.d.ts:200
value
value:
Uint8Array<ArrayBufferLike>
The value of the matching data.
Defined in
lumina_node_wasm.d.ts:218
Accessors
proof_ops
Get Signature
get proof_ops():
ProofOps
Serialized proof for the value data, if requested,
to be verified against the AppHash for the given [Height].
Returns
Set Signature
set proof_ops(
value):void
Serialized proof for the value data, if requested,
to be verified against the AppHash for the given [Height].
Parameters
####### value
Returns
void
Defined in
lumina_node_wasm.d.ts:207
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:168
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:167
lumina-node-wasm / AccAddress
Class: AccAddress
Address of an account.
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:235
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:234
toJSON()
toJSON():
Object
- Return copy of self without private attributes.
Returns
Object
Defined in
lumina_node_wasm.d.ts:229
toString()
toString():
string
Return stringified version of self.
Returns
string
Defined in
lumina_node_wasm.d.ts:233
lumina-node-wasm / Attribute
Class: Attribute
Attribute defines an attribute wrapper where the key and value are strings instead of raw bytes.
Properties
key
key:
string
Defined in
lumina_node_wasm.d.ts:260
value
value:
string
Defined in
lumina_node_wasm.d.ts:261
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:259
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:258
lumina-node-wasm / AuthInfo
Class: AuthInfo
[AuthInfo] describes the fee and signer modes that are used to sign a transaction.
Properties
fee
fee:
Fee
[Fee] and gas limit for the transaction.
The first signer is the primary signer and the one which pays the fee. The fee can be calculated based on the cost of evaluating the body and doing signature verification of the signers. This can be estimated via simulation.
Defined in
lumina_node_wasm.d.ts:278
signer_infos
signer_infos:
SignerInfo[]
Defines the signing modes for the required signers.
The number and order of elements must match the required signers from transaction
[TxBody]’s messages. The first element is the primary signer and the one
which pays the [Fee].
Defined in
lumina_node_wasm.d.ts:286
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:270
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:269
lumina-node-wasm / Blob
Class: Blob
Arbitrary data that can be stored in the network within certain [Namespace].
Constructors
new Blob()
new Blob(
namespace,data):Blob
Create a new blob with the given data within the [Namespace].
Parameters
namespace
data
Uint8Array<ArrayBufferLike>
Returns
Defined in
lumina_node_wasm.d.ts:310
Properties
commitment
commitment:
Commitment
A [Commitment] computed from the Blobs data.
Defined in
lumina_node_wasm.d.ts:314
data
data:
Uint8Array<ArrayBufferLike>
Data stored within the Blob.
Defined in
lumina_node_wasm.d.ts:318
namespace
namespace:
Namespace
A [Namespace] the Blob belongs to.
Defined in
lumina_node_wasm.d.ts:330
share_version
share_version:
number
Version indicating the format in which Shares should be created from this Blob.
Defined in
lumina_node_wasm.d.ts:334
Accessors
index
Get Signature
get index():
bigint
Index of the blob's first share in the EDS. Only set for blobs retrieved from chain.
Returns
bigint
Set Signature
set index(
value):void
Index of the blob's first share in the EDS. Only set for blobs retrieved from chain.
Parameters
####### value
bigint
Returns
void
Defined in
lumina_node_wasm.d.ts:322
signer
Get Signature
get signer():
AccAddress
A signer of the blob, i.e. address of the account which submitted the blob.
Must be present in share_version 1 and absent otherwise.
Returns
Set Signature
set signer(
value):void
A signer of the blob, i.e. address of the account which submitted the blob.
Must be present in share_version 1 and absent otherwise.
Parameters
####### value
Returns
void
Defined in
lumina_node_wasm.d.ts:340
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:302
clone()
clone():
Blob
Clone a blob creating a new deep copy of it.
Returns
Defined in
lumina_node_wasm.d.ts:306
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:301
toJSON()
toJSON():
Object
- Return copy of self without private attributes.
Returns
Object
Defined in
lumina_node_wasm.d.ts:296
toString()
toString():
string
Return stringified version of self.
Returns
string
Defined in
lumina_node_wasm.d.ts:300
lumina-node-wasm / BlobParams
Class: BlobParams
Params defines the parameters for the blob module.
Properties
gas_per_blob_byte
gas_per_blob_byte:
number
Gas cost per blob byte
Defined in
lumina_node_wasm.d.ts:367
gov_max_square_size
gov_max_square_size:
bigint
Max square size
Defined in
lumina_node_wasm.d.ts:371
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:363
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:362
toJSON()
toJSON():
Object
- Return copy of self without private attributes.
Returns
Object
Defined in
lumina_node_wasm.d.ts:357
toString()
toString():
string
Return stringified version of self.
Returns
string
Defined in
lumina_node_wasm.d.ts:361
lumina-node-wasm / BlobsAtHeight
Class: BlobsAtHeight
List of blobs together with height they were published at
Properties
blobs
blobs:
Blob[]
Published blobs
Defined in
lumina_node_wasm.d.ts:392
height
height:
bigint
Height the blobs were published at
Defined in
lumina_node_wasm.d.ts:396
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:388
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:387
toJSON()
toJSON():
Object
- Return copy of self without private attributes.
Returns
Object
Defined in
lumina_node_wasm.d.ts:382
toString()
toString():
string
Return stringified version of self.
Returns
string
Defined in
lumina_node_wasm.d.ts:386
lumina-node-wasm / Block
Class: Block
Blocks consist of a header, transactions, votes (the commit), and a list of evidence of malfeasance (i.e. signing conflicting votes).
This is a modified version of [tendermint::block::Block] which contains
modifications that Celestia introduced.
Properties
data
data:
Data
Transaction data
Defined in
lumina_node_wasm.d.ts:427
evidence
readonlyevidence:Evidence[]
Evidence of malfeasance
Defined in
lumina_node_wasm.d.ts:415
header
readonlyheader:Header
Block header
Defined in
lumina_node_wasm.d.ts:419
lastCommit
readonlylastCommit:Commit
Last commit, should be None for the initial block.
Defined in
lumina_node_wasm.d.ts:423
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:411
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:410
lumina-node-wasm / BlockId
Class: BlockId
Block identifiers which contain two distinct Merkle roots of the block, as well as the number of parts in the block.
Properties
hash
hash:
string
The block’s main hash is the Merkle root of all the fields in the block header.
Defined in
lumina_node_wasm.d.ts:440
part_set_header
part_set_header:
PartsHeader
Parts header (if available) is used for secure gossipping of the block during consensus. It is the Merkle root of the complete serialized block cut into parts.
PartSet is used to split a byteslice of data into parts (pieces) for transmission. By splitting data into smaller parts and computing a Merkle root hash on the list, you can verify that a part is legitimately part of the complete data, and the part can be forwarded to other peers before all the parts are known. In short, it’s a fast way to propagate a large file over a gossip network.
https://github.com/tendermint/tendermint/wiki/Block-Structure#partset
PartSetHeader in protobuf is defined as never nil using the gogoproto annotations. This does not translate to Rust, but we can indicate this in the domain type.
Defined in
lumina_node_wasm.d.ts:456
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:436
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:435
lumina-node-wasm / BlockRange
Class: BlockRange
A range of blocks between start and end height, inclusive
Properties
end
end:
bigint
Last block height in range
Defined in
lumina_node_wasm.d.ts:477
start
start:
bigint
First block height in range
Defined in
lumina_node_wasm.d.ts:481
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:473
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:472
toJSON()
toJSON():
Object
- Return copy of self without private attributes.
Returns
Object
Defined in
lumina_node_wasm.d.ts:467
toString()
toString():
string
Return stringified version of self.
Returns
string
Defined in
lumina_node_wasm.d.ts:471
lumina-node-wasm / BroadcastMode
Class: BroadcastMode
BroadcastMode specifies the broadcast mode for the TxService.Broadcast RPC method.
Properties
Async
readonlystaticAsync:BroadcastMode
BroadcastMode Async defines a tx broadcasting mode where the client returns
immediately.
Defined in
lumina_node_wasm.d.ts:495
Block
readonlystaticBlock:BroadcastMode
DEPRECATED: use BroadcastMode Sync instead,
BroadcastMode Block is not supported by the SDK from v0.47.x onwards.
Defined in
lumina_node_wasm.d.ts:500
Sync
readonlystaticSync:BroadcastMode
BroadcastMode Sync defines a tx broadcasting mode where the client waits for
a CheckTx execution response only.
Defined in
lumina_node_wasm.d.ts:505
Unspecified
readonlystaticUnspecified:BroadcastMode
zero-value for mode ordering
Defined in
lumina_node_wasm.d.ts:509
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:490
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:489
lumina-node-wasm / Coin
Class: Coin
Coin defines a token with a denomination and an amount.
Properties
amount
amount:
bigint
Defined in
lumina_node_wasm.d.ts:33
denom
denom:
string
Defined in
lumina_node_wasm.d.ts:32
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:518
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:517
lumina-node-wasm / Commit
Class: Commit
Commit contains the justification (ie. a set of signatures) that a block was committed by a set of validators.
Properties
block_id
block_id:
BlockId
Block ID
Defined in
lumina_node_wasm.d.ts:532
height
height:
bigint
Block height
Defined in
lumina_node_wasm.d.ts:536
round
round:
number
Round
Defined in
lumina_node_wasm.d.ts:540
signatures
signatures:
CommitSig[]
Signatures
Defined in
lumina_node_wasm.d.ts:544
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:528
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:527
lumina-node-wasm / CommitSig
Class: CommitSig
CommitSig represents a signature of a validator. It’s a part of the Commit and can be used to reconstruct the vote set given the validator set.
Properties
vote_type
vote_type:
CommitVoteType
vote type of a validator
Defined in
lumina_node_wasm.d.ts:558
Accessors
vote
Get Signature
get vote():
CommitVote
vote, if received
Returns
Set Signature
set vote(
value):void
vote, if received
Parameters
####### value
Returns
void
Defined in
lumina_node_wasm.d.ts:562
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:554
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:553
lumina-node-wasm / CommitVote
Class: CommitVote
Value of the validator vote
Properties
timestamp
timestamp:
string
Timestamp
Defined in
lumina_node_wasm.d.ts:587
validator_address
validator_address:
string
Address of the voting validator
Defined in
lumina_node_wasm.d.ts:591
Accessors
signature
Get Signature
get signature():
Signature
Signature
Returns
Set Signature
set signature(
value):void
Signature
Parameters
####### value
Returns
void
Defined in
lumina_node_wasm.d.ts:579
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:575
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:574
lumina-node-wasm / Commitment
Class: Commitment
A merkle hash used to identify the Blobs data.
In Celestia network, the transaction which pays for the blob's inclusion
is separated from the data itself. The reason for that is to allow verifying
the blockchain's state without the need to pull the actual data which got stored.
To achieve that, the MsgPayForBlobs transaction only includes the [Commitment]s
of the blobs it is paying for, not the data itself.
The algorithm of computing the [Commitment] of the Blob's Shares is
designed in a way to allow easy and cheap proving of the Shares inclusion in the
block. It is computed as a merkle hash of all the Nmt subtree roots created from
the blob shares included in the ExtendedDataSquare rows. Assuming the s1 and s2
are the only shares of some blob posted to the celestia, they'll result in a single subtree
root as shown below:
NMT: row root
/ \
o subtree root
/ \ / \
_________________
EDS row: | s | s | s1 | s2 |
Using subtree roots as a base for [Commitment] computation allows for much smaller
inclusion proofs than when the Shares would be used directly, but it imposes some
constraints on how the Blobs can be placed in the ExtendedDataSquare. You can
read more about that in the share commitment rules.
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:658
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:657
hash()
hash():
Uint8Array<ArrayBufferLike>
Hash of the commitment
Returns
Uint8Array<ArrayBufferLike>
Defined in
lumina_node_wasm.d.ts:662
toJSON()
toJSON():
Object
- Return copy of self without private attributes.
Returns
Object
Defined in
lumina_node_wasm.d.ts:652
toString()
toString():
string
Return stringified version of self.
Returns
string
Defined in
lumina_node_wasm.d.ts:656
lumina-node-wasm / ConfigResponse
Class: ConfigResponse
Response holding consensus node configuration.
Properties
halt_height
halt_height:
bigint
A height at which the node should stop advancing state.
Defined in
lumina_node_wasm.d.ts:675
pruning_interval
pruning_interval:
bigint
Amount of blocks used as an interval to trigger prunning.
Defined in
lumina_node_wasm.d.ts:687
pruning_keep_recent
pruning_keep_recent:
bigint
How many recent blocks are stored by the node.
Defined in
lumina_node_wasm.d.ts:691
Accessors
minimum_gas_price
Get Signature
get minimum_gas_price():
number
Minimum gas price for the node to accept tx. Value is in utia denom.
Returns
number
Set Signature
set minimum_gas_price(
value):void
Minimum gas price for the node to accept tx. Value is in utia denom.
Parameters
####### value
number
Returns
void
Defined in
lumina_node_wasm.d.ts:679
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:671
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:670
lumina-node-wasm / ConflictingBlock
Class: ConflictingBlock
Conflicting block detected in light client attack
Properties
signed_header
signed_header:
SignedHeader
Signed header
Defined in
lumina_node_wasm.d.ts:704
validator_set
validator_set:
ValidatorSet
Validator set
Defined in
lumina_node_wasm.d.ts:708
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:700
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:699
lumina-node-wasm / ConnectionCountersSnapshot
Class: ConnectionCountersSnapshot
Network connection information
Properties
num_connections
num_connections:
number
The total number of connections, both pending and established.
Defined in
lumina_node_wasm.d.ts:729
num_established
num_established:
number
The number of outgoing connections being established.
Defined in
lumina_node_wasm.d.ts:741
num_established_incoming
num_established_incoming:
number
The number of established incoming connections.
Defined in
lumina_node_wasm.d.ts:733
num_established_outgoing
num_established_outgoing:
number
The number of established outgoing connections.
Defined in
lumina_node_wasm.d.ts:737
num_pending
num_pending:
number
The total number of pending connections, both incoming and outgoing.
Defined in
lumina_node_wasm.d.ts:753
num_pending_incoming
num_pending_incoming:
number
The total number of pending connections, both incoming and outgoing.
Defined in
lumina_node_wasm.d.ts:745
num_pending_outgoing
num_pending_outgoing:
number
The number of outgoing connections being established.
Defined in
lumina_node_wasm.d.ts:749
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:725
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:724
toJSON()
toJSON():
Object
- Return copy of self without private attributes.
Returns
Object
Defined in
lumina_node_wasm.d.ts:719
toString()
toString():
string
Return stringified version of self.
Returns
string
Defined in
lumina_node_wasm.d.ts:723
lumina-node-wasm / ConsAddress
Class: ConsAddress
Address of a consensus node.
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:770
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:769
toJSON()
toJSON():
Object
- Return copy of self without private attributes.
Returns
Object
Defined in
lumina_node_wasm.d.ts:764
toString()
toString():
string
Return stringified version of self.
Returns
string
Defined in
lumina_node_wasm.d.ts:768
lumina-node-wasm / Data
Class: Data
Data contained in a Block.
Properties
hash
hash:
Uint8Array<ArrayBufferLike>
Hash is the root of a binary Merkle tree where the leaves of the tree are the row and column roots of an extended data square. Hash is often referred to as the "data root".
Defined in
lumina_node_wasm.d.ts:791
square_size
square_size:
bigint
Square width of original data square.
Defined in
lumina_node_wasm.d.ts:795
transactions
readonlytransactions:Uint8Array<ArrayBufferLike>[]
Transactions
Defined in
lumina_node_wasm.d.ts:785
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:781
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:780
lumina-node-wasm / DataAvailabilityHeader
Class: DataAvailabilityHeader
Header with commitments of the data availability.
It consists of the root hashes of the merkle trees created from each
row and column of the ExtendedDataSquare. Those are used to prove
the inclusion of the data in a block.
The hash of this header is a hash of all rows and columns and thus a data commitment of the block.
Example
## use celestia_types::{ExtendedHeader, Height, Share};
## use celestia_types::nmt::{Namespace, NamespaceProof};
## fn extended_header() -> ExtendedHeader {
## unimplemented!();
## }
## fn shares_with_proof(_: u64, _: &Namespace) -> (Vec<Share>, NamespaceProof) {
## unimplemented!();
## }
// fetch the block header and data for your namespace
let namespace = Namespace::new_v0(&[1, 2, 3, 4]).unwrap();
let eh = extended_header();
let (shares, proof) = shares_with_proof(eh.height(), &namespace);
// get the data commitment for a given row
let dah = eh.dah;
let root = dah.row_root(0).unwrap();
// verify a proof of the inclusion of the shares
assert!(proof.verify_complete_namespace(&root, &shares, *namespace).is_ok());
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:845
columnRoot()
columnRoot(
column):any
Get the a root of the column with the given index.
Parameters
column
number
Returns
any
Defined in
lumina_node_wasm.d.ts:849
columnRoots()
columnRoots():
any[]
Merkle roots of the ExtendedDataSquare columns.
Returns
any[]
Defined in
lumina_node_wasm.d.ts:853
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:844
hash()
hash():
any
Compute the combined hash of all rows and columns.
This is the data commitment for the block.
Returns
any
Defined in
lumina_node_wasm.d.ts:859
rowRoot()
rowRoot(
row):any
Get a root of the row with the given index.
Parameters
row
number
Returns
any
Defined in
lumina_node_wasm.d.ts:863
rowRoots()
rowRoots():
any[]
Merkle roots of the ExtendedDataSquare rows.
Returns
any[]
Defined in
lumina_node_wasm.d.ts:867
squareWidth()
squareWidth():
number
Get the size of the ExtendedDataSquare for which this header was built.
Returns
number
Defined in
lumina_node_wasm.d.ts:871
toJSON()
toJSON():
Object
- Return copy of self without private attributes.
Returns
Object
Defined in
lumina_node_wasm.d.ts:839
toString()
toString():
string
Return stringified version of self.
Returns
string
Defined in
lumina_node_wasm.d.ts:843
lumina-node-wasm / DuplicateVoteEvidence
Class: DuplicateVoteEvidence
Duplicate vote evidence
Properties
timestamp
timestamp:
string
Timestamp
Defined in
lumina_node_wasm.d.ts:884
total_voting_power
total_voting_power:
bigint
Total voting power
Defined in
lumina_node_wasm.d.ts:888
validator_power
validator_power:
bigint
Validator power
Defined in
lumina_node_wasm.d.ts:892
vote_a
vote_a:
Vote
Vote A
Defined in
lumina_node_wasm.d.ts:896
vote_b
vote_b:
Vote
Vote B
Defined in
lumina_node_wasm.d.ts:900
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:880
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:879
lumina-node-wasm / Endpoint
Class: Endpoint
A URL endpoint paired with its configuration.
Use this with withUrl/withUrls to configure endpoints with different settings.
Example
const primary = new Endpoint(
"http://primary:9090"
);
primary = primary.withMetadata("auth", "token1");
const fallback = new Endpoint(
"http://fallback:9090"
);
fallback = fallback.withTimeout(10000);
const client = await GrpcClient
.withUrls([primary, fallback])
.build();
Constructors
new Endpoint()
new Endpoint(
url):Endpoint
Create a new endpoint with a URL.
Parameters
url
string
Returns
Defined in
lumina_node_wasm.d.ts:931
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:927
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:926
withMetadata()
withMetadata(
key,value):Endpoint
Appends ASCII metadata (HTTP/2 header) to requests made to this endpoint.
Note that this method consumes the endpoint and returns an updated instance.
Parameters
key
string
value
string
Returns
Defined in
lumina_node_wasm.d.ts:937
withMetadataBin()
withMetadataBin(
key,value):Endpoint
Appends binary metadata to requests made to this endpoint.
Keys must have -bin suffix.
Note that this method consumes the endpoint and returns an updated instance.
Parameters
key
string
value
Uint8Array<ArrayBufferLike>
Returns
Defined in
lumina_node_wasm.d.ts:945
withTimeout()
withTimeout(
timeout_ms):Endpoint
Sets the request timeout in milliseconds for this endpoint.
Note that this method consumes the endpoint and returns an updated instance.
Parameters
timeout_ms
bigint
Returns
Defined in
lumina_node_wasm.d.ts:951
lumina-node-wasm / Evidence
Class: Evidence
Evidence of malfeasance by validators (i.e. signing conflicting votes or light client attack).
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:1252
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:1251
lumina-node-wasm / ExtendedHeader
Class: ExtendedHeader
Block header together with the relevant Data Availability metadata.
[ExtendedHeader]s are used to announce and describe the blocks
in the Celestia network.
Before being used, each header should be validated and verified with a header you trust.
Example
## use celestia_types::ExtendedHeader;
## fn trusted_genesis_header() -> ExtendedHeader {
## let s = include_str!("../test_data/chain1/extended_header_block_1.json");
## serde_json::from_str(s).unwrap()
## }
## fn some_untrusted_header() -> ExtendedHeader {
## let s = include_str!("../test_data/chain1/extended_header_block_27.json");
## serde_json::from_str(s).unwrap()
## }
let genesis_header = trusted_genesis_header();
// fetch new header
let fetched_header = some_untrusted_header();
fetched_header.validate().expect("Invalid block header");
genesis_header.verify(&fetched_header).expect("Malicious header received");
Properties
commit
readonlycommit:any
Commit metadata and signatures from validators committing the block.
Defined in
lumina_node_wasm.d.ts:1377
dah
Header of the block data availability.
Defined in
lumina_node_wasm.d.ts:1389
header
readonlyheader:any
Tendermint block header.
Defined in
lumina_node_wasm.d.ts:1381
validatorSet
readonlyvalidatorSet:any
Information about the set of validators commiting the block.
Defined in
lumina_node_wasm.d.ts:1385
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:1295
clone()
clone():
ExtendedHeader
Clone a header producing a deep copy of it.
Returns
Defined in
lumina_node_wasm.d.ts:1299
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:1294
hash()
hash():
string
Get the block hash.
Returns
string
Defined in
lumina_node_wasm.d.ts:1303
height()
height():
bigint
Get the block height.
Returns
bigint
Defined in
lumina_node_wasm.d.ts:1307
previousHeaderHash()
previousHeaderHash():
string
Get the hash of the previous header.
Returns
string
Defined in
lumina_node_wasm.d.ts:1311
time()
time():
number
Get the block time.
Returns
number
Defined in
lumina_node_wasm.d.ts:1315
toJSON()
toJSON():
Object
- Return copy of self without private attributes.
Returns
Object
Defined in
lumina_node_wasm.d.ts:1289
toString()
toString():
string
Return stringified version of self.
Returns
string
Defined in
lumina_node_wasm.d.ts:1293
validate()
validate():
void
Decode protobuf encoded header and then validate it.
Returns
void
Defined in
lumina_node_wasm.d.ts:1319
verify()
verify(
untrusted):void
Verify a chain of adjacent untrusted headers and make sure
they are adjacent to self.
Errors
If verification fails, this function will return an error with a reason of failure.
This function will also return an error if untrusted headers and self don't form contiguous range
Parameters
untrusted
Returns
void
Defined in
lumina_node_wasm.d.ts:1329
verifyAdjacentRange()
verifyAdjacentRange(
untrusted):void
Verify a chain of adjacent untrusted headers and make sure
they are adjacent to self.
Note
Provided headers will be consumed by this method, meaning
they will no longer be accessible. If this behavior is not desired,
consider using ExtendedHeader.clone().
const genesis = hdr0;
const headers = [hrd1, hdr2, hdr3];
genesis.verifyAdjacentRange(headers.map(h => h.clone()));
Errors
If verification fails, this function will return an error with a reason of failure.
This function will also return an error if untrusted headers and self don't form contiguous range
Parameters
untrusted
Returns
void
Defined in
lumina_node_wasm.d.ts:1351
verifyRange()
verifyRange(
untrusted):void
Verify a chain of adjacent untrusted headers.
Note
Provided headers will be consumed by this method, meaning
they will no longer be accessible. If this behavior is not desired,
consider using ExtendedHeader.clone().
const genesis = hdr0;
const headers = [hrd1, hdr2, hdr3];
genesis.verifyRange(headers.map(h => h.clone()));
Errors
If verification fails, this function will return an error with a reason of failure. This function will also return an error if untrusted headers are not adjacent to each other.
Parameters
untrusted
Returns
void
Defined in
lumina_node_wasm.d.ts:1373
lumina-node-wasm / Fee
Class: Fee
Fee includes the amount of coins paid in fees and the maximum gas to be used by the transaction. The ratio yields an effective "gasprice", which must be above some miminum to be accepted into the mempool.
Properties
amount
amount:
Coin[]
amount is the amount of coins to be paid as a fee
Defined in
lumina_node_wasm.d.ts:1416
gas_limit
gas_limit:
bigint
gas_limit is the maximum gas that can be used in transaction processing before an out of gas error occurs
Defined in
lumina_node_wasm.d.ts:1421
granter
readonlygranter:string
if set, the fee payer (either the first signer or the value of the payer field) requests that a fee grant be used to pay fees instead of the fee payer's own balance. If an appropriate fee grant does not exist or the chain does not support fee grants, this will fail
Defined in
lumina_node_wasm.d.ts:1406
payer
readonlypayer:string
if unset, the first signer is responsible for paying the fees. If set, the specified account must pay the fees. the payer must be a tx signer (and thus have signed this field in AuthInfo). setting this field does not change the ordering of required signers for the transaction.
Defined in
lumina_node_wasm.d.ts:1412
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:1400
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:1399
lumina-node-wasm / GasEstimate
Class: GasEstimate
Result of gas price and usage estimation
Properties
price
price:
number
Gas price estimated based on last 5 blocks
Defined in
lumina_node_wasm.d.ts:1434
usage
usage:
bigint
Simulated transaction gas usage
Defined in
lumina_node_wasm.d.ts:1438
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:1430
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:1429
lumina-node-wasm / GasInfo
Class: GasInfo
GasInfo defines tx execution gas context.
Properties
gas_used
gas_used:
bigint
GasUsed is the amount of gas actually consumed.
Defined in
lumina_node_wasm.d.ts:1451
gas_wanted
gas_wanted:
bigint
GasWanted is the maximum units of work we allow this tx to perform.
Defined in
lumina_node_wasm.d.ts:1455
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:1447
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:1446
lumina-node-wasm / GetTxResponse
Class: GetTxResponse
Response to GetTx
Properties
tx
tx:
Tx
Response Transaction
Defined in
lumina_node_wasm.d.ts:1472
tx_response
tx_response:
TxResponse
TxResponse to a Query
Defined in
lumina_node_wasm.d.ts:1468
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:1464
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:1463
lumina-node-wasm / GrpcClient
Class: GrpcClient
Celestia gRPC client, for builder see [GrpcClientBuilder]
Properties
chainId
readonlychainId:Promise<string>
Chain id of the client
Defined in
lumina_node_wasm.d.ts:1708
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:1481
abciQuery()
abciQuery(
data,path,height,prove):Promise<AbciQueryResponse>
Issue a direct ABCI query to the application
Parameters
data
Uint8Array<ArrayBufferLike>
path
string
height
bigint
prove
boolean
Returns
Promise<AbciQueryResponse>
Defined in
lumina_node_wasm.d.ts:1485
broadcastBlobs()
broadcastBlobs(
blobs,tx_config?):Promise<BroadcastedTx>
Broadcast blobs to the celestia network, and return without confirming.
Example
const ns = Namespace.newV0(new Uint8Array([97, 98, 99]));
const data = new Uint8Array([100, 97, 116, 97]);
const blob = new Blob(ns, data);
const broadcastedTx = await txClient.broadcastBlobs([blob]);
console.log("Tx hash:", broadcastedTx.hash);
const txInfo = await txClient.confirmTx(broadcastedTx);
Note
Provided blobs will be consumed by this method, meaning
they will no longer be accessible. If this behavior is not desired,
consider using Blob.clone().
const blobs = [blob1, blob2, blob3];
await txClient.broadcastBlobs(blobs.map(b => b.clone()));
Parameters
blobs
Blob[]
tx_config?
Returns
Promise<BroadcastedTx>
Defined in
lumina_node_wasm.d.ts:1511
broadcastMessage()
broadcastMessage(
message,tx_config?):Promise<BroadcastedTx>
Broadcast message to the celestia network, and return without confirming.
Example
import { Registry } from "@cosmjs/proto-signing";
const registry = new Registry();
const sendMsg = {
typeUrl: "/cosmos.bank.v1beta1.MsgSend",
value: {
fromAddress: "celestia169s50psyj2f4la9a2235329xz7rk6c53zhw9mm",
toAddress: "celestia1t52q7uqgnjfzdh3wx5m5phvma3umrq8k6tq2p9",
amount: [{ denom: "utia", amount: "10000" }],
},
};
const sendMsgAny = registry.encodeAsAny(sendMsg);
const broadcastedTx = await txClient.broadcastMessage(sendMsgAny);
console.log("Tx hash:", broadcastedTx.hash);
const txInfo = await txClient.confirmTx(broadcastedTx);
Parameters
message
tx_config?
Returns
Promise<BroadcastedTx>
Defined in
lumina_node_wasm.d.ts:1535
broadcastTx()
broadcastTx(
tx_bytes,mode):Promise<TxResponse>
Broadcast prepared and serialised transaction
Parameters
tx_bytes
Uint8Array<ArrayBufferLike>
mode
Returns
Promise<TxResponse>
Defined in
lumina_node_wasm.d.ts:1539
confirmTx()
confirmTx(
broadcasted_tx,tx_config?):Promise<TxInfo>
Confirm transaction broadcasted with [broadcast_blobs] or [broadcast_message].
Example
const ns = Namespace.newV0(new Uint8Array([97, 98, 99]));
const data = new Uint8Array([100, 97, 116, 97]);
const blob = new Blob(ns, data);
const broadcastedTx = await txClient.broadcastBlobs([blob]);
console.log("Tx hash:", broadcastedTx.hash);
const txInfo = await txClient.confirmTx(broadcastedTx);
console.log("Confirmed at height:", txInfo.height);
Parameters
broadcasted_tx
tx_config?
Returns
Promise<TxInfo>
Defined in
lumina_node_wasm.d.ts:1555
estimateGasPrice()
estimateGasPrice(
priority):Promise<number>
Estimate gas price for given transaction priority based on the gas prices of the transactions in the last five blocks.
If no transaction is found in the last five blocks, return the network min gas price.
Parameters
priority
Returns
Promise<number>
Defined in
lumina_node_wasm.d.ts:1563
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:1480
get_node_config()
get_node_config():
Promise<ConfigResponse>
Get node configuration
Returns
Promise<ConfigResponse>
Defined in
lumina_node_wasm.d.ts:1622
getAccount()
getAccount(
account):Promise<BaseAccount>
Get account
Parameters
account
string
Returns
Promise<BaseAccount>
Defined in
lumina_node_wasm.d.ts:1567
getAccounts()
getAccounts():
Promise<BaseAccount[]>
Get accounts
Returns
Promise<BaseAccount[]>
Defined in
lumina_node_wasm.d.ts:1571
getAllBalances()
getAllBalances(
address):Promise<Coin[]>
Get balance of all coins
Parameters
address
string
Returns
Promise<Coin[]>
Defined in
lumina_node_wasm.d.ts:1575
getAuthParams()
getAuthParams():
Promise<AuthParams>
Get auth params
Returns
Promise<AuthParams>
Defined in
lumina_node_wasm.d.ts:1579
getBalance()
getBalance(
address,denom):Promise<Coin>
Retrieves the Celestia coin balance for the given address.
Parameters
address
string
denom
string
Returns
Promise<Coin>
Defined in
lumina_node_wasm.d.ts:1583
getBlobParams()
getBlobParams():
Promise<BlobParams>
Get blob params
Returns
Promise<BlobParams>
Defined in
lumina_node_wasm.d.ts:1587
getBlockByHeight()
getBlockByHeight(
height):Promise<Block>
Get block by height
Parameters
height
bigint
Returns
Promise<Block>
Defined in
lumina_node_wasm.d.ts:1591
getLatestBlock()
getLatestBlock():
Promise<Block>
Get latest block
Returns
Promise<Block>
Defined in
lumina_node_wasm.d.ts:1595
getSpendableBalances()
getSpendableBalances(
address):Promise<Coin[]>
Get balance of all spendable coins
Parameters
address
string
Returns
Promise<Coin[]>
Defined in
lumina_node_wasm.d.ts:1599
getTotalSupply()
getTotalSupply():
Promise<Coin[]>
Get total supply
Returns
Promise<Coin[]>
Defined in
lumina_node_wasm.d.ts:1603
getTx()
getTx(
hash):Promise<GetTxResponse>
Get Tx
Parameters
hash
string
Returns
Promise<GetTxResponse>
Defined in
lumina_node_wasm.d.ts:1607
getVerifiedBalance()
getVerifiedBalance(
address,header):Promise<Coin>
Retrieves the verified Celestia coin balance for the address.
Notes
This returns the verified balance which is the one that was reported by
the previous network block. In other words, if you transfer some coins,
you need to wait 1 more block in order to see the new balance. If you want
something more immediate then use [GrpcClient::get_balance].
Parameters
address
string
header
Returns
Promise<Coin>
Defined in
lumina_node_wasm.d.ts:1618
simulate()
simulate(
tx_bytes):Promise<GasInfo>
Simulate prepared and serialised transaction, returning simulated gas usage
Parameters
tx_bytes
Uint8Array<ArrayBufferLike>
Returns
Promise<GasInfo>
Defined in
lumina_node_wasm.d.ts:1626
submitBlobs()
submitBlobs(
blobs,tx_config?):Promise<TxInfo>
Submit blobs to the celestia network.
Example
const ns = Namespace.newV0(new Uint8Array([97, 98, 99]));
const data = new Uint8Array([100, 97, 116, 97]);
const blob = new Blob(ns, data);
const txInfo = await txClient.submitBlobs([blob]);
await txClient.submitBlobs([blob], { gasLimit: 100000n, gasPrice: 0.02, memo: "foo" });
Note
Provided blobs will be consumed by this method, meaning
they will no longer be accessible. If this behavior is not desired,
consider using Blob.clone().
const blobs = [blob1, blob2, blob3];
await txClient.submitBlobs(blobs.map(b => b.clone()));
Parameters
blobs
Blob[]
tx_config?
Returns
Promise<TxInfo>
Defined in
lumina_node_wasm.d.ts:1651
submitMessage()
submitMessage(
message,tx_config?):Promise<TxInfo>
Submit message to the celestia network.
Example
import { Registry } from "@cosmjs/proto-signing";
const registry = new Registry();
const sendMsg = {
typeUrl: "/cosmos.bank.v1beta1.MsgSend",
value: {
fromAddress: "celestia169s50psyj2f4la9a2235329xz7rk6c53zhw9mm",
toAddress: "celestia1t52q7uqgnjfzdh3wx5m5phvma3umrq8k6tq2p9",
amount: [{ denom: "utia", amount: "10000" }],
},
};
const sendMsgAny = registry.encodeAsAny(sendMsg);
const txInfo = await txClient.submitMessage(sendMsgAny);
Parameters
message
tx_config?
Returns
Promise<TxInfo>
Defined in
lumina_node_wasm.d.ts:1673
txStatus()
txStatus(
hash):Promise<TxStatusResponse>
Get status of the transaction
Parameters
hash
string
Returns
Promise<TxStatusResponse>
Defined in
lumina_node_wasm.d.ts:1677
withUrl()
staticwithUrl(url):GrpcClientBuilder
Create a builder for [GrpcClient] connected to url.
Accepts a string, an Endpoint, or an array of strings/endpoints.
Example
const client = await GrpcClient.withUrl("http://localhost:18080").build();
Parameters
url
Returns
Defined in
lumina_node_wasm.d.ts:1689
withUrls()
staticwithUrls(urls):GrpcClientBuilder
Create a builder for [GrpcClient] with multiple URL endpoints for fallback support.
Accepts a string, an Endpoint, or an array of strings/endpoints.
When multiple endpoints are configured, the client will automatically fall back to the next endpoint if a network-related error occurs.
Example
const client = await GrpcClient.withUrls(["http://primary:9090", "http://fallback:9090"]).build();
Parameters
urls
Returns
Defined in
lumina_node_wasm.d.ts:1704
lumina-node-wasm / GrpcClientBuilder
Class: GrpcClientBuilder
Builder for [GrpcClient] and [TxClient].
Url must point to a grpc-web proxy.
Keyless client example
const client = await GrpcClient
.withUrl("http://127.0.0.1:18080")
.build()
// With config:
const endpoint = new Endpoint("http://127.0.0.1:18080").withTimeout(BigInt(5000));
const client = await GrpcClient
.withUrl(endpoint)
.build()
Transaction client examples
Example with noble/curves
import { secp256k1 } from "@noble/curves/secp256k1";
const privKey = "fdc8ac75dfa1c142dbcba77938a14dd03078052ce0b49a529dcf72a9885a3abb";
const pubKey = secp256k1.getPublicKey(privKey);
const signer = (signDoc) => {
const bytes = protoEncodeSignDoc(signDoc);
const sig = secp256k1.sign(bytes, privKey, { prehash: true });
return sig.toCompactRawBytes();
};
const client = await GrpcClient
.withUrl("http://127.0.0.1:18080")
.withPubkeyAndSigner(pubKey, signer)
.build();
Example with leap wallet
await window.leap.enable("mocha-4")
const keys = await window.leap.getKey("mocha-4")
const signer = (signDoc) => {
return window.leap.signDirect("mocha-4", keys.bech32Address, signDoc, { preferNoSetFee: true })
.then(sig => Uint8Array.from(atob(sig.signature.signature), c => c.charCodeAt(0)))
}
const client = await GrpcClient
.withUrl("http://127.0.0.1:18080")
.withPubkeyAndSigner(keys.pubKey, signer)
.build()
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:1770
build()
build():
GrpcClient
build gRPC client
Returns
Defined in
lumina_node_wasm.d.ts:1774
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:1769
withPubkeyAndSigner()
withPubkeyAndSigner(
account_pubkey,signer_fn):GrpcClientBuilder
Add public key and signer to the client being built
Note that this method consumes builder and returns updated instance of it. Make sure to re-assign it if you keep builder in a variable.
Parameters
account_pubkey
Uint8Array<ArrayBufferLike>
signer_fn
Returns
Defined in
lumina_node_wasm.d.ts:1781
withUrl()
withUrl(
url):GrpcClientBuilder
Set the url of the grpc-web server to connect to.
Accepts a string, an Endpoint, or an array of strings/endpoints.
Note that this method consumes builder and returns updated instance of it. Make sure to re-assign it if you keep builder in a variable.
Parameters
url
Returns
Defined in
lumina_node_wasm.d.ts:1790
withUrls()
withUrls(
urls):GrpcClientBuilder
Add multiple URL endpoints at once for fallback support.
Accepts a string, an Endpoint, or an array of strings/endpoints.
When multiple endpoints are configured, the client will automatically fall back to the next endpoint if a network-related error occurs.
Note that this method consumes builder and returns updated instance of it. Make sure to re-assign it if you keep builder in a variable.
Parameters
urls
Returns
Defined in
lumina_node_wasm.d.ts:1802
lumina-node-wasm / Header
Class: Header
Block Header values contain metadata about the block and about the consensus, as well as commitments to the data in the current block, the previous block, and the results returned by the application.
Properties
app_hash
app_hash:
string
State after txs from the previous block
Defined in
lumina_node_wasm.d.ts:1817
chain_id
chain_id:
string
Chain ID
Defined in
lumina_node_wasm.d.ts:1821
consensus_hash
consensus_hash:
string
Consensus params for the current block
Defined in
lumina_node_wasm.d.ts:1825
height
height:
bigint
Current block height
Defined in
lumina_node_wasm.d.ts:1845
next_validators_hash
next_validators_hash:
string
Validators for the next block
Defined in
lumina_node_wasm.d.ts:1873
proposer_address
proposer_address:
string
Original proposer of the block
Defined in
lumina_node_wasm.d.ts:1877
time
time:
string
Current timestamp encoded as rfc3339
Defined in
lumina_node_wasm.d.ts:1881
validators_hash
validators_hash:
string
Validators for the current block
Defined in
lumina_node_wasm.d.ts:1885
version
version:
ProtocolVersion
Header version
Defined in
lumina_node_wasm.d.ts:1889
Accessors
data_hash
Get Signature
get data_hash():
string
Merkle root of transaction hashes
Returns
string
Set Signature
set data_hash(
value):void
Merkle root of transaction hashes
Parameters
####### value
string
Returns
void
Defined in
lumina_node_wasm.d.ts:1829
evidence_hash
Get Signature
get evidence_hash():
string
Hash of evidence included in the block
Returns
string
Set Signature
set evidence_hash(
value):void
Hash of evidence included in the block
Parameters
####### value
string
Returns
void
Defined in
lumina_node_wasm.d.ts:1837
last_block_id
Get Signature
get last_block_id():
BlockId
Previous block info
Returns
Set Signature
set last_block_id(
value):void
Previous block info
Parameters
####### value
Returns
void
Defined in
lumina_node_wasm.d.ts:1849
last_commit_hash
Get Signature
get last_commit_hash():
string
Commit from validators from the last block
Returns
string
Set Signature
set last_commit_hash(
value):void
Commit from validators from the last block
Parameters
####### value
string
Returns
void
Defined in
lumina_node_wasm.d.ts:1857
last_results_hash
Get Signature
get last_results_hash():
string
Root hash of all results from the txs from the previous block
Returns
string
Set Signature
set last_results_hash(
value):void
Root hash of all results from the txs from the previous block
Parameters
####### value
string
Returns
void
Defined in
lumina_node_wasm.d.ts:1865
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:1813
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:1812
lumina-node-wasm / IntoUnderlyingByteSource
Class: IntoUnderlyingByteSource
Properties
autoAllocateChunkSize
readonlyautoAllocateChunkSize:number
Defined in
lumina_node_wasm.d.ts:1899
type
readonlytype:"bytes"
Defined in
lumina_node_wasm.d.ts:1900
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:1895
cancel()
cancel():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:1896
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:1894
pull()
pull(
controller):Promise<any>
Parameters
controller
ReadableByteStreamController
Returns
Promise<any>
Defined in
lumina_node_wasm.d.ts:1897
start()
start(
controller):void
Parameters
controller
ReadableByteStreamController
Returns
void
Defined in
lumina_node_wasm.d.ts:1898
lumina-node-wasm / IntoUnderlyingSink
Class: IntoUnderlyingSink
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:1906
abort()
abort(
reason):Promise<any>
Parameters
reason
any
Returns
Promise<any>
Defined in
lumina_node_wasm.d.ts:1907
close()
close():
Promise<any>
Returns
Promise<any>
Defined in
lumina_node_wasm.d.ts:1908
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:1905
write()
write(
chunk):Promise<any>
Parameters
chunk
any
Returns
Promise<any>
Defined in
lumina_node_wasm.d.ts:1909
lumina-node-wasm / IntoUnderlyingSource
Class: IntoUnderlyingSource
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:1915
cancel()
cancel():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:1916
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:1914
pull()
pull(
controller):Promise<any>
Parameters
controller
ReadableStreamDefaultController<any>
Returns
Promise<any>
Defined in
lumina_node_wasm.d.ts:1917
lumina-node-wasm / IteratorResultObject
Class: IteratorResultObject
Properties
done
done:
boolean
Has the value true if the iterator is past the end of the iterated sequence. In this case value optionally specifies the return value of the iterator.
Defined in
lumina_node_wasm.d.ts:1929
value
value:
any
Any JavaScript value returned by the iterator. Can be omitted when done is true.
Defined in
lumina_node_wasm.d.ts:1934
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:1923
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:1922
lumina-node-wasm / JsBitVector
Class: JsBitVector
Array of bits
Properties
0
0:
Uint8Array<ArrayBufferLike>
Defined in
lumina_node_wasm.d.ts:1944
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:1943
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:1942
lumina-node-wasm / JsEvent
Class: JsEvent
Event allows application developers to attach additional information to ResponseBeginBlock, ResponseEndBlock, ResponseCheckTx and ResponseDeliverTx. Later, transactions may be queried using these events.
Properties
attributes
attributes:
JsEventAttribute[]
Defined in
lumina_node_wasm.d.ts:1956
type
type:
string
Defined in
lumina_node_wasm.d.ts:1957
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:1955
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:1954
lumina-node-wasm / JsEventAttribute
Class: JsEventAttribute
Properties
index
index:
boolean
Defined in
lumina_node_wasm.d.ts:1964
key
key:
string
Defined in
lumina_node_wasm.d.ts:1965
value
value:
string
Defined in
lumina_node_wasm.d.ts:1966
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:1963
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:1962
lumina-node-wasm / JsValidatorInfo
Class: JsValidatorInfo
Validator information
Properties
address
address:
string
Validator account address
Defined in
lumina_node_wasm.d.ts:1979
power
power:
bigint
Validator voting power
Defined in
lumina_node_wasm.d.ts:1991
proposer_priority
proposer_priority:
bigint
Validator proposer priority
Defined in
lumina_node_wasm.d.ts:1995
pub_key
pub_key:
PublicKey
Validator public key
Defined in
lumina_node_wasm.d.ts:1999
Accessors
name
Get Signature
get name():
string
Validator name
Returns
string
Set Signature
set name(
value):void
Validator name
Parameters
####### value
string
Returns
void
Defined in
lumina_node_wasm.d.ts:1983
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:1975
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:1974
lumina-node-wasm / LightClientAttackEvidence
Class: LightClientAttackEvidence
LightClient attack evidence
Properties
byzantine_validators
byzantine_validators:
JsValidatorInfo[]
Byzantine validators
Defined in
lumina_node_wasm.d.ts:2012
common_height
common_height:
bigint
Common height
Defined in
lumina_node_wasm.d.ts:2016
conflicting_block
conflicting_block:
ConflictingBlock
Conflicting block
Defined in
lumina_node_wasm.d.ts:2020
timestamp
timestamp:
string
Timestamp
Defined in
lumina_node_wasm.d.ts:2024
total_voting_power
total_voting_power:
bigint
Total voting power
Defined in
lumina_node_wasm.d.ts:2028
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:2008
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:2007
lumina-node-wasm / ModeInfo
Class: ModeInfo
ModeInfo describes the signing mode of a single or nested multisig signer.
Properties
bitarray
readonlybitarray:JsBitVector
Multi is the mode info for a multisig public key bitarray specifies which keys within the multisig are signing
Defined in
lumina_node_wasm.d.ts:2046
mode
readonlymode:number
Single is the mode info for a single signer. It is structured as a message to allow for additional fields such as locale for SIGN_MODE_TEXTUAL in the future
Defined in
lumina_node_wasm.d.ts:2052
mode_infos
readonlymode_infos:ModeInfo[]
Multi is the mode info for a multisig public key mode_infos is the corresponding modes of the signers of the multisig which could include nested multisig public keys
Defined in
lumina_node_wasm.d.ts:2058
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:2037
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:2036
signature_mode()
signature_mode():
SignatureMode
Return signature mode for the stored signature(s)
Returns
Defined in
lumina_node_wasm.d.ts:2041
lumina-node-wasm / Namespace
Class: Namespace
Namespace of the data published to the celestia network.
The [Namespace] is a single byte defining the version
followed by 28 bytes specifying concrete ID of the namespace.
Currently there are two versions of namespaces:
- version
0- the one allowing for the custom namespace ids. It requires an id to start with 180x00bytes followed by a user specified suffix (except reserved ones, see below). - version
255- for secondary reserved namespaces. It requires an id to start with 270xffbytes followed by a single byte indicating the id.
Some namespaces are reserved for the block creation purposes and cannot be used when submitting the blobs to celestia. Those fall into one of the two categories:
- primary reserved namespaces - those use version
0and have id lower or equal to0xffso they are always placed in blocks before user-submitted data. - secondary reserved namespaces - those use version
0xffso they are always placed after user-submitted data.
Properties
id
readonlyid:Uint8Array<ArrayBufferLike>
Returns the trailing 28 bytes indicating the id of the [Namespace].
Defined in
lumina_node_wasm.d.ts:2165
version
readonlyversion:number
Returns the first byte indicating the version of the [Namespace].
Defined in
lumina_node_wasm.d.ts:2169
MAX_PRIMARY_RESERVED
readonlystaticMAX_PRIMARY_RESERVED:Namespace
Maximal primary reserved [Namespace].
Used to indicate the end of the primary reserved group.
Defined in
lumina_node_wasm.d.ts:2121
MIN_SECONDARY_RESERVED
readonlystaticMIN_SECONDARY_RESERVED:Namespace
Minimal secondary reserved [Namespace].
Used to indicate the beginning of the secondary reserved group.
Defined in
lumina_node_wasm.d.ts:2127
NS_SIZE
readonlystaticNS_SIZE:number
Namespace size in bytes.
Defined in
lumina_node_wasm.d.ts:2131
PARITY_SHARE
readonlystaticPARITY_SHARE:Namespace
The [Namespace] for parity shares.
It is the namespace with which all the parity shares from
ExtendedDataSquare are inserted to the Nmt when computing
merkle roots.
Defined in
lumina_node_wasm.d.ts:2139
PAY_FOR_BLOB
readonlystaticPAY_FOR_BLOB:Namespace
Primary reserved [Namespace] for the compact Shares with MsgPayForBlobs transactions.
Defined in
lumina_node_wasm.d.ts:2143
PRIMARY_RESERVED_PADDING
readonlystaticPRIMARY_RESERVED_PADDING:Namespace
Primary reserved [Namespace] for the Shares used for padding.
Shares with this namespace are inserted after other shares from primary reserved namespace
so that user-defined namespaces are correctly aligned in ExtendedDataSquare
Defined in
lumina_node_wasm.d.ts:2150
TAIL_PADDING
readonlystaticTAIL_PADDING:Namespace
Secondary reserved [Namespace] used for padding after the blobs.
It is used to fill up the original data square after all user-submitted
blobs before the parity data is generated for the ExtendedDataSquare.
Defined in
lumina_node_wasm.d.ts:2157
TRANSACTION
readonlystaticTRANSACTION:Namespace
Primary reserved [Namespace] for the compact Shares with cosmos SDK transactions.
Defined in
lumina_node_wasm.d.ts:2161
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:2093
asBytes()
asBytes():
Uint8Array<ArrayBufferLike>
Converts the [Namespace] to a byte slice.
Returns
Uint8Array<ArrayBufferLike>
Defined in
lumina_node_wasm.d.ts:2097
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:2092
toJSON()
toJSON():
Object
- Return copy of self without private attributes.
Returns
Object
Defined in
lumina_node_wasm.d.ts:2087
toString()
toString():
string
Return stringified version of self.
Returns
string
Defined in
lumina_node_wasm.d.ts:2091
fromRaw()
staticfromRaw(raw):Namespace
Create a new [Namespace] from the raw bytes.
Errors
This function will return an error if the slice length is different than
[NS_SIZE] or if the namespace is invalid. If you are constructing the
version 0 namespace, check [newV0].
Parameters
raw
Uint8Array<ArrayBufferLike>
Returns
Defined in
lumina_node_wasm.d.ts:2107
newV0()
staticnewV0(id):Namespace
Create a new [Namespace] version 0 with given id.
Check Namespace::new_v0 for more details.
Parameters
id
Uint8Array<ArrayBufferLike>
Returns
Defined in
lumina_node_wasm.d.ts:2115
lumina-node-wasm / NetworkInfoSnapshot
Class: NetworkInfoSnapshot
Information about the connections
Properties
connection_counters
connection_counters:
ConnectionCountersSnapshot
Gets counters for ongoing network connections.
Defined in
lumina_node_wasm.d.ts:2212
num_peers
num_peers:
number
The number of connected peers, i.e. peers with whom at least one established connection exists.
Defined in
lumina_node_wasm.d.ts:2216
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:2208
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:2207
toJSON()
toJSON():
Object
- Return copy of self without private attributes.
Returns
Object
Defined in
lumina_node_wasm.d.ts:2202
toString()
toString():
string
Return stringified version of self.
Returns
string
Defined in
lumina_node_wasm.d.ts:2206
lumina-node-wasm / NodeClient
Class: NodeClient
NodeClient is responsible for steering NodeWorker by sending it commands and receiving
responses over the provided port.
Constructors
new NodeClient()
new NodeClient(
port):NodeClient
Create a new connection to a Lumina node running in NodeWorker. Provided port is
expected to have MessagePort-like interface for sending and receiving messages.
Parameters
port
any
Returns
Defined in
lumina_node_wasm.d.ts:2313
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:2227
addConnectionToWorker()
addConnectionToWorker(
port):Promise<void>
Establish a new connection to the existing worker over provided port
Parameters
port
any
Returns
Promise<void>
Defined in
lumina_node_wasm.d.ts:2231
blobSubscribe()
blobSubscribe(
namespace):Promise<AsyncIterable<BlobsAtHeight|SubscriptionError,any,any>>
Subscribe to the shares from the namespace, as new headers are received by the node
Return an async iterator which will yield all the blobs from the namespace, as the new headers are being received by the node, starting from the first header received after the call.
Parameters
namespace
Returns
Promise<AsyncIterable<BlobsAtHeight | SubscriptionError, any, any>>
Defined in
lumina_node_wasm.d.ts:2238
connectedPeers()
connectedPeers():
Promise<any[]>
Get all the peers that node is connected to.
Returns
Promise<any[]>
Defined in
lumina_node_wasm.d.ts:2242
eventsChannel()
eventsChannel():
Promise<BroadcastChannel>
Returns a [BroadcastChannel] for events generated by [Node].
Returns
Promise<BroadcastChannel>
Defined in
lumina_node_wasm.d.ts:2246
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:2226
getHeaderByHash()
getHeaderByHash(
hash):Promise<ExtendedHeader>
Get a synced header for the block with a given hash.
Parameters
hash
string
Returns
Promise<ExtendedHeader>
Defined in
lumina_node_wasm.d.ts:2250
getHeaderByHeight()
getHeaderByHeight(
height):Promise<ExtendedHeader>
Get a synced header for the block with a given height.
Parameters
height
bigint
Returns
Promise<ExtendedHeader>
Defined in
lumina_node_wasm.d.ts:2254
getHeaders()
getHeaders(
start_height?,end_height?):Promise<ExtendedHeader[]>
Get synced headers from the given heights range.
If start of the range is undefined (None), the first returned header will be of height 1. If end of the range is undefined (None), the last returned header will be the last header in the store.
Errors
If range contains a height of a header that is not found in the store.
Parameters
start_height?
bigint
end_height?
bigint
Returns
Promise<ExtendedHeader[]>
Defined in
lumina_node_wasm.d.ts:2266
getLocalHeadHeader()
getLocalHeadHeader():
Promise<ExtendedHeader>
Get the latest locally synced header.
Returns
Promise<ExtendedHeader>
Defined in
lumina_node_wasm.d.ts:2270
getNetworkHeadHeader()
getNetworkHeadHeader():
Promise<ExtendedHeader>
Get the latest header announced in the network.
Returns
Promise<ExtendedHeader>
Defined in
lumina_node_wasm.d.ts:2274
getSamplingMetadata()
getSamplingMetadata(
height):Promise<SamplingMetadata>
Get data sampling metadata of an already sampled height.
Parameters
height
bigint
Returns
Promise<SamplingMetadata>
Defined in
lumina_node_wasm.d.ts:2278
headerSubscribe()
headerSubscribe():
Promise<AsyncIterable<ExtendedHeader|SubscriptionError,any,any>>
Subscribe to new headers received by the node from the network.
Return an async iterator which will yield all the headers, as they are being received by the node, starting from the first header received after the call.
Returns
Promise<AsyncIterable<ExtendedHeader | SubscriptionError, any, any>>
Defined in
lumina_node_wasm.d.ts:2285
isRunning()
isRunning():
Promise<boolean>
Check whether Lumina is currently running
Returns
Promise<boolean>
Defined in
lumina_node_wasm.d.ts:2289
listeners()
listeners():
Promise<any[]>
Get all the multiaddresses on which the node listens.
Returns
Promise<any[]>
Defined in
lumina_node_wasm.d.ts:2293
localPeerId()
localPeerId():
Promise<string>
Get node's local peer ID.
Returns
Promise<string>
Defined in
lumina_node_wasm.d.ts:2297
namespaceSubscribe()
namespaceSubscribe(
namespace):Promise<AsyncIterable<SubscriptionError|SharesAtHeight,any,any>>
Subscribe to the blobs from the namespace, as new headers are received by the node
Return an async iterator which will yield all the shares from the namespace, as the new headers are being received by the node, starting from the first header received after the call.
Parameters
namespace
Returns
Promise<AsyncIterable<SubscriptionError | SharesAtHeight, any, any>>
Defined in
lumina_node_wasm.d.ts:2304
networkInfo()
networkInfo():
Promise<NetworkInfoSnapshot>
Get current network info.
Returns
Promise<NetworkInfoSnapshot>
Defined in
lumina_node_wasm.d.ts:2308
peerTrackerInfo()
peerTrackerInfo():
Promise<PeerTrackerInfoSnapshot>
Get current [PeerTracker] info.
Returns
Promise<PeerTrackerInfoSnapshot>
Defined in
lumina_node_wasm.d.ts:2317
requestAllBlobs()
requestAllBlobs(
namespace,block_height,timeout_secs?):Promise<Blob[]>
Request all blobs with provided namespace in the block corresponding to this header using bitswap protocol.
Parameters
namespace
block_height
bigint
timeout_secs?
number
Returns
Promise<Blob[]>
Defined in
lumina_node_wasm.d.ts:2322
requestHeaderByHash()
requestHeaderByHash(
hash):Promise<ExtendedHeader>
Request a header for the block with a given hash from the network.
Parameters
hash
string
Returns
Promise<ExtendedHeader>
Defined in
lumina_node_wasm.d.ts:2330
requestHeaderByHeight()
requestHeaderByHeight(
height):Promise<ExtendedHeader>
Request a header for the block with a given height from the network.
Parameters
height
bigint
Returns
Promise<ExtendedHeader>
Defined in
lumina_node_wasm.d.ts:2334
requestHeadHeader()
requestHeadHeader():
Promise<ExtendedHeader>
Request the head header from the network.
Returns
Promise<ExtendedHeader>
Defined in
lumina_node_wasm.d.ts:2326
requestVerifiedHeaders()
requestVerifiedHeaders(
from,amount):Promise<ExtendedHeader[]>
Request headers in range (from, from + amount] from the network.
The headers will be verified with the from header.
Parameters
from
amount
bigint
Returns
Promise<ExtendedHeader[]>
Defined in
lumina_node_wasm.d.ts:2340
setPeerTrust()
setPeerTrust(
peer_id,is_trusted):Promise<void>
Trust or untrust the peer with a given ID.
Parameters
peer_id
string
is_trusted
boolean
Returns
Promise<void>
Defined in
lumina_node_wasm.d.ts:2344
start()
start(
config):Promise<void>
Start the node with the provided config, if it's not running
Parameters
config
Returns
Promise<void>
Defined in
lumina_node_wasm.d.ts:2348
stop()
stop():
Promise<void>
Stop the node.
Returns
Promise<void>
Defined in
lumina_node_wasm.d.ts:2352
syncerInfo()
syncerInfo():
Promise<SyncingInfoSnapshot>
Get current header syncing info.
Returns
Promise<SyncingInfoSnapshot>
Defined in
lumina_node_wasm.d.ts:2356
waitConnected()
waitConnected():
Promise<void>
Wait until the node is connected to at least 1 peer.
Returns
Promise<void>
Defined in
lumina_node_wasm.d.ts:2360
waitConnectedTrusted()
waitConnectedTrusted():
Promise<void>
Wait until the node is connected to at least 1 trusted peer.
Returns
Promise<void>
Defined in
lumina_node_wasm.d.ts:2364
lumina-node-wasm / NodeConfig
Class: NodeConfig
Config for the lumina wasm node.
Properties
bootnodes
bootnodes:
string[]
A list of bootstrap peers to connect to.
Defined in
lumina_node_wasm.d.ts:2389
network
network:
Network
A network to connect to.
Defined in
lumina_node_wasm.d.ts:2429
usePersistentMemory
usePersistentMemory:
boolean
Whether to store data in persistent memory or not.
Default value: true
Defined in
lumina_node_wasm.d.ts:2435
Accessors
customPruningWindowSecs
Get Signature
get customPruningWindowSecs():
number
Pruning window defines maximum age of a block for it to be retained in store.
If pruning window is smaller than sampling window, then blocks will be pruned right after they are sampled. This is useful when you want to keep low memory footprint but still validate the blockchain.
If this is not set, then default value will apply:
- If
use_persistent_memory == true, default value is 7 days plus 1 hour. - If
use_persistent_memory == false, default value is 0 seconds.
Returns
number
Set Signature
set customPruningWindowSecs(
value):void
Pruning window defines maximum age of a block for it to be retained in store.
If pruning window is smaller than sampling window, then blocks will be pruned right after they are sampled. This is useful when you want to keep low memory footprint but still validate the blockchain.
If this is not set, then default value will apply:
- If
use_persistent_memory == true, default value is 7 days plus 1 hour. - If
use_persistent_memory == false, default value is 0 seconds.
Parameters
####### value
number
Returns
void
Defined in
lumina_node_wasm.d.ts:2402
identity_key
Get Signature
get identity_key():
Uint8Array<ArrayBufferLike>
Optionally start with a provided private key used as libp2p identity. Expects 32 bytes containing ed25519 secret key.
Returns
Uint8Array<ArrayBufferLike>
Set Signature
set identity_key(
value):void
Optionally start with a provided private key used as libp2p identity. Expects 32 bytes containing ed25519 secret key.
Parameters
####### value
Uint8Array<ArrayBufferLike>
Returns
void
Defined in
lumina_node_wasm.d.ts:2420
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:2381
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:2380
toJSON()
toJSON():
Object
- Return copy of self without private attributes.
Returns
Object
Defined in
lumina_node_wasm.d.ts:2375
toString()
toString():
string
Return stringified version of self.
Returns
string
Defined in
lumina_node_wasm.d.ts:2379
default()
staticdefault(network):NodeConfig
Get the configuration with default bootnodes for provided network
Parameters
network
Returns
Defined in
lumina_node_wasm.d.ts:2385
lumina-node-wasm / NodeWorker
Class: NodeWorker
NodeWorker is responsible for receiving commands from connected NodeClients, executing
them and sending a response back, as well as accepting new NodeClient connections.
Constructors
new NodeWorker()
new NodeWorker(
port_like_object):NodeWorker
Create a new NodeWorker with a port-like JS object.
Parameters
port_like_object
any
Returns
Defined in
lumina_node_wasm.d.ts:2450
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:2446
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:2445
run()
run():
Promise<void>
Run NodeWorker main loop.
Returns
Promise<void>
Defined in
lumina_node_wasm.d.ts:2454
lumina-node-wasm / PartsHeader
Class: PartsHeader
Block parts header
Properties
hash
hash:
string
Hash of the parts set header
Defined in
lumina_node_wasm.d.ts:2467
total
total:
number
Number of parts in this block
Defined in
lumina_node_wasm.d.ts:2471
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:2463
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:2462
lumina-node-wasm / PeerTrackerInfoSnapshot
Class: PeerTrackerInfoSnapshot
Statistics of the connected peers
Properties
num_connected_peers
num_connected_peers:
bigint
Number of the connected peers.
Defined in
lumina_node_wasm.d.ts:2492
num_connected_trusted_peers
num_connected_trusted_peers:
bigint
Number of the connected trusted peers.
Defined in
lumina_node_wasm.d.ts:2496
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:2488
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:2487
toJSON()
toJSON():
Object
- Return copy of self without private attributes.
Returns
Object
Defined in
lumina_node_wasm.d.ts:2482
toString()
toString():
string
Return stringified version of self.
Returns
string
Defined in
lumina_node_wasm.d.ts:2486
lumina-node-wasm / ProofOp
Class: ProofOp
ProofOp defines an operation used for calculating Merkle root. The data could be arbitrary format, providing necessary data for example neighbouring node hash.
Note: This type is a duplicate of the ProofOp proto type defined in Tendermint.
Properties
data
data:
Uint8Array<ArrayBufferLike>
Defined in
lumina_node_wasm.d.ts:2510
key
key:
Uint8Array<ArrayBufferLike>
Defined in
lumina_node_wasm.d.ts:2511
type
type:
string
Defined in
lumina_node_wasm.d.ts:2512
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:2509
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:2508
lumina-node-wasm / ProofOps
Class: ProofOps
ProofOps is Merkle proof defined by the list of ProofOps.
Note: This type is a duplicate of the ProofOps proto type defined in Tendermint.
Properties
ops
ops:
ProofOp[]
Defined in
lumina_node_wasm.d.ts:2524
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:2523
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:2522
lumina-node-wasm / ProtocolVersion
Class: ProtocolVersion
Version contains the protocol version for the blockchain and the application.
Properties
app
app:
bigint
app version
Defined in
lumina_node_wasm.d.ts:2537
block
block:
bigint
blockchain version
Defined in
lumina_node_wasm.d.ts:2541
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:2533
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:2532
lumina-node-wasm / SamplingMetadata
Class: SamplingMetadata
Sampling metadata for a block.
This struct persists DAS-ing information in a header store for future reference.
Properties
cids
readonlycids:Uint8Array<ArrayBufferLike>[]
Return Array of cids
Defined in
lumina_node_wasm.d.ts:2556
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:2552
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:2551
lumina-node-wasm / Share
Class: Share
A single fixed-size chunk of data which is used to form an ExtendedDataSquare.
All data in Celestia is split into Shares before being put into a
block's data square. See Blob::to_shares.
All shares have the fixed size of 512 bytes and the following structure:
| Namespace | InfoByte | (optional) sequence length | data |
sequence length is the length of the original data in bytes and is present only in the first of the shares the data was split into.
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:2587
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:2586
toJSON()
toJSON():
Object
- Return copy of self without private attributes.
Returns
Object
Defined in
lumina_node_wasm.d.ts:2581
toString()
toString():
string
Return stringified version of self.
Returns
string
Defined in
lumina_node_wasm.d.ts:2585
lumina-node-wasm / SharesAtHeight
Class: SharesAtHeight
A list of shares that were published at particular height.
Properties
height
height:
bigint
height the shares were published at
Defined in
lumina_node_wasm.d.ts:2608
shares
shares:
Share[]
shares published
Defined in
lumina_node_wasm.d.ts:2612
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:2604
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:2603
toJSON()
toJSON():
Object
- Return copy of self without private attributes.
Returns
Object
Defined in
lumina_node_wasm.d.ts:2598
toString()
toString():
string
Return stringified version of self.
Returns
string
Defined in
lumina_node_wasm.d.ts:2602
lumina-node-wasm / Signature
Class: Signature
Signature
Properties
0
0:
Uint8Array<ArrayBufferLike>
Defined in
lumina_node_wasm.d.ts:2622
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:2621
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:2620
lumina-node-wasm / SignedHeader
Class: SignedHeader
Signed block headers
Properties
commit
commit:
Commit
Commit containing signatures for the header
Defined in
lumina_node_wasm.d.ts:2640
header
header:
Header
Signed block headers
Defined in
lumina_node_wasm.d.ts:2644
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:2636
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:2635
lumina-node-wasm / SignerInfo
Class: SignerInfo
SignerInfo describes the public key and signing mode of a single top-level signer.
Properties
mode_info
mode_info:
ModeInfo
mode_info describes the signing mode of the signer and is a nested structure to support nested multisig pubkey's
Defined in
lumina_node_wasm.d.ts:2665
sequence
sequence:
bigint
sequence is the sequence of the account, which describes the number of committed transactions signed by a given address. It is used to prevent replay attacks.
Defined in
lumina_node_wasm.d.ts:2671
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:2654
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:2653
public_key()
public_key():
ProtoAny
public_key is the public key of the signer. It is optional for accounts
that already exist in state. If unset, the verifier can use the required
signer address for this position and lookup the public key.
Returns
Defined in
lumina_node_wasm.d.ts:2660
lumina-node-wasm / StringEvent
Class: StringEvent
StringEvent defines en Event object wrapper where all the attributes contain key/value pairs that are strings instead of raw bytes.
Properties
attributes
attributes:
Attribute[]
Defined in
lumina_node_wasm.d.ts:2682
type
type:
string
Defined in
lumina_node_wasm.d.ts:2683
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:2681
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:2680
lumina-node-wasm / SubscriptionError
Class: SubscriptionError
Error thrown while processing subscription
Properties
error
error:
string
error message
Defined in
lumina_node_wasm.d.ts:2696
Accessors
height
Get Signature
get height():
bigint
Height at which the error occurred, if applicable
Returns
bigint
Set Signature
set height(
value):void
Height at which the error occurred, if applicable
Parameters
####### value
bigint
Returns
void
Defined in
lumina_node_wasm.d.ts:2700
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:2692
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:2691
lumina-node-wasm / SyncingInfoSnapshot
Class: SyncingInfoSnapshot
Status of the synchronization.
Properties
stored_headers
stored_headers:
BlockRange[]
Ranges of headers that are already synchronised
Defined in
lumina_node_wasm.d.ts:2725
subjective_head
subjective_head:
bigint
Syncing target. The latest height seen in the network that was successfully verified.
Defined in
lumina_node_wasm.d.ts:2729
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:2721
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:2720
toJSON()
toJSON():
Object
- Return copy of self without private attributes.
Returns
Object
Defined in
lumina_node_wasm.d.ts:2715
toString()
toString():
string
Return stringified version of self.
Returns
string
Defined in
lumina_node_wasm.d.ts:2719
lumina-node-wasm / Tx
Class: Tx
[Tx] is the standard type used for broadcasting transactions.
Properties
auth_info
auth_info:
AuthInfo
Authorization related content of the transaction, specifically signers, signer modes
and [Fee].
Defined in
lumina_node_wasm.d.ts:2743
body
body:
TxBody
Processable content of the transaction
Defined in
lumina_node_wasm.d.ts:2747
signatures
readonlysignatures:Signature[]
List of signatures that matches the length and order of [AuthInfo]’s signer_infos to
allow connecting signature meta information like public key and signing mode by position.
Defined in
lumina_node_wasm.d.ts:2752
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:2738
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:2737
lumina-node-wasm / TxBody
Class: TxBody
[TxBody] of a transaction that all signers sign over.
Properties
memo
memo:
string
memo is any arbitrary memo to be added to the transaction.
Defined in
lumina_node_wasm.d.ts:2788
timeout_height
readonlytimeout_height:bigint
timeout is the block height after which this transaction will not
be processed by the chain
Defined in
lumina_node_wasm.d.ts:2793
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:2761
extension_options()
extension_options():
ProtoAny[]
extension_options are arbitrary options that can be added by chains
when the default options are not sufficient. If any of these are present
and can't be handled, the transaction will be rejected
Returns
ProtoAny[]
Defined in
lumina_node_wasm.d.ts:2767
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:2760
messages()
messages():
ProtoAny[]
messages is a list of messages to be executed. The required signers of
those messages define the number and order of elements in AuthInfo's
signer_infos and Tx's signatures. Each required signer address is added to
the list only the first time it occurs.
By convention, the first required signer (usually from the first message) is referred to as the primary signer and pays the fee for the whole transaction.
Returns
ProtoAny[]
Defined in
lumina_node_wasm.d.ts:2778
non_critical_extension_options()
non_critical_extension_options():
ProtoAny[]
extension_options are arbitrary options that can be added by chains
when the default options are not sufficient. If any of these are present
and can't be handled, they will be ignored
Returns
ProtoAny[]
Defined in
lumina_node_wasm.d.ts:2784
lumina-node-wasm / TxResponse
Class: TxResponse
Response to a tx query
Properties
code
code:
ErrorCode
Response code.
Defined in
lumina_node_wasm.d.ts:2824
codespace
codespace:
string
Namespace for the Code
Defined in
lumina_node_wasm.d.ts:2828
data
data:
string
Result bytes, if any.
Defined in
lumina_node_wasm.d.ts:2832
events
readonlyevents:JsEvent[]
Events defines all the events emitted by processing a transaction. Note, these events include those emitted by processing all the messages and those emitted from the ante. Whereas Logs contains the events, with additional metadata, emitted only by processing the messages.
Defined in
lumina_node_wasm.d.ts:2866
gas_used
gas_used:
bigint
Amount of gas consumed by transaction.
Defined in
lumina_node_wasm.d.ts:2836
gas_wanted
gas_wanted:
bigint
Amount of gas requested for transaction.
Defined in
lumina_node_wasm.d.ts:2840
height
readonlyheight:bigint
The block height
Defined in
lumina_node_wasm.d.ts:2870
info
info:
string
Additional information. May be non-deterministic.
Defined in
lumina_node_wasm.d.ts:2844
logs
logs:
AbciMessageLog[]
The output of the application's logger (typed). May be non-deterministic.
Defined in
lumina_node_wasm.d.ts:2848
raw_log
raw_log:
string
The output of the application's logger (raw string). May be non-deterministic.
Defined in
lumina_node_wasm.d.ts:2853
timestamp
timestamp:
string
Time of the previous block. For heights > 1, it's the weighted median of the timestamps of the valid votes in the block.LastCommit. For height == 1, it's genesis time.
Defined in
lumina_node_wasm.d.ts:2859
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:2820
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:2819
lumina-node-wasm / TxStatusResponse
Class: TxStatusResponse
Response to a tx status query
Properties
error
error:
string
Error log, if transaction failed.
Defined in
lumina_node_wasm.d.ts:2909
execution_code
execution_code:
ErrorCode
Execution_code is returned when the transaction has been committed and returns whether it was successful or errored. A non zero execution code indicates an error.
Defined in
lumina_node_wasm.d.ts:2915
height
readonlyheight:bigint
Height of the block in which the transaction was committed.
Defined in
lumina_node_wasm.d.ts:2927
index
index:
number
Index of the transaction in block.
Defined in
lumina_node_wasm.d.ts:2919
status
status:
TxStatus
Status of the transaction.
Defined in
lumina_node_wasm.d.ts:2923
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:2905
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:2904
lumina-node-wasm / ValAddress
Class: ValAddress
Address of a validator.
Methods
[dispose]()
[dispose]():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:2944
free()
free():
void
Returns
void
Defined in
lumina_node_wasm.d.ts:2943
toJSON()
toJSON():
Object
- Return copy of self without private attributes.
Returns
Object
Defined in
lumina_node_wasm.d.ts:2938
toString()
toString():
string
Return stringified version of self.
Returns
string
Defined in
lumina_node_wasm.d.ts:2942
lumina-node-wasm / ValidatorSet
Class: ValidatorSet
Validator set contains a vector of validators
Properties
total_voting_power
total_voting_power:
bigint
Total voting power
Defined in
lumina_node_wasm.d.ts:2965
validators
validators:
JsValidatorInfo[]
Validators in the set
Defined in
lumina_node_wasm.d.ts:2969
