lumina-node-wasm 0.3.1 → 0.5.0

package/README.md

@@ -40,3 +40,8 @@ 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](https://docs.rs/lumina-node/latest/lumina_node/) and [celestia-types](https://docs.rs/celestia-types/latest/celestia_types/) documentation on docs.rs. You can see there the exact structure of more complex types, such as [`ExtendedHeader`](https://docs.rs/celestia-types/latest/celestia_types/struct.ExtendedHeader.html). JavaScript API's goal is to provide similar interface to Rust when possible, e.g. `NodeClient` mirrors [`Node`](https://docs.rs/lumina-node/latest/lumina_node/node/struct.Node.html).
+

package/lumina_node_wasm.d.ts

@@ -26,6 +26,7 @@ export enum Network {
   Private = 3,
 }
 /**
+* A range of blocks between `start` and `end` height, inclusive
 */
 export class BlockRange {
 /**
@@ -38,9 +39,11 @@ export class BlockRange {
   toString(): string;
   free(): void;
 /**
+* Last block height in range
 */
   end: bigint;
 /**
+* First block height in range
 */
   start: bigint;
 }
@@ -57,28 +60,36 @@ export class ConnectionCountersSnapshot {
   toString(): string;
   free(): void;
 /**
+* The total number of connections, both pending and established.
 */
   num_connections: number;
 /**
+* The number of outgoing connections being established.
 */
   num_established: number;
 /**
+* The number of established incoming connections.
 */
   num_established_incoming: number;
 /**
+* The number of established outgoing connections.
 */
   num_established_outgoing: number;
 /**
+* The total number of pending connections, both incoming and outgoing.
 */
   num_pending: number;
 /**
+* The total number of pending connections, both incoming and outgoing.
 */
   num_pending_incoming: number;
 /**
+* The number of outgoing connections being established.
 */
   num_pending_outgoing: number;
 }
 /**
+* Information about the connections
 */
 export class NetworkInfoSnapshot {
 /**
@@ -91,9 +102,11 @@ export class NetworkInfoSnapshot {
   toString(): string;
   free(): void;
 /**
+* Gets counters for ongoing network connections.
 */
   connection_counters: ConnectionCountersSnapshot;
 /**
+* The number of connected peers, i.e. peers with whom at least one established connection exists.
 */
   num_peers: number;
 }
@@ -129,6 +142,10 @@ export class NodeClient {
 */
   start(config: NodeConfig): Promise<void>;
 /**
+* @returns {Promise<void>}
+*/
+  stop(): Promise<void>;
+/**
 * Get node's local peer ID.
 * @returns {Promise<string>}
 */
@@ -275,12 +292,6 @@ export class NodeClient {
 */
   getSamplingMetadata(height: bigint): Promise<any>;
 /**
-* Requests SharedWorker running lumina to close. Any events received afterwards wont
-* be processed and new NodeClient needs to be created to restart a node.
-* @returns {Promise<void>}
-*/
-  close(): Promise<void>;
-/**
 * Returns a [`BroadcastChannel`] for events generated by [`Node`].
 * @returns {Promise<BroadcastChannel>}
 */
@@ -328,6 +339,7 @@ export class NodeWorker {
   run(): Promise<void>;
 }
 /**
+* Statistics of the connected peers
 */
 export class PeerTrackerInfoSnapshot {
 /**
@@ -340,13 +352,16 @@ export class PeerTrackerInfoSnapshot {
   toString(): string;
   free(): void;
 /**
+* Number of the connected peers.
 */
   num_connected_peers: bigint;
 /**
+* Number of the connected trusted peers.
 */
   num_connected_trusted_peers: bigint;
 }
 /**
+* Status of the synchronization.
 */
 export class SyncingInfoSnapshot {
 /**
@@ -359,124 +374,11 @@ export class SyncingInfoSnapshot {
   toString(): string;
   free(): void;
 /**
+* Ranges of headers that are already synchronised
 */
   stored_headers: (BlockRange)[];
 /**
+* Syncing target. The latest height seen in the network that was successfully verified.
 */
   subjective_head: bigint;
 }
-
-export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
-
-export interface InitOutput {
-  readonly memory: WebAssembly.Memory;
-  readonly setup_logging: () => void;
-  readonly __wbg_nodeconfig_free: (a: number, b: number) => void;
-  readonly __wbg_get_nodeconfig_network: (a: number) => number;
-  readonly __wbg_set_nodeconfig_network: (a: number, b: number) => void;
-  readonly __wbg_get_nodeconfig_bootnodes: (a: number, b: number) => void;
-  readonly __wbg_set_nodeconfig_bootnodes: (a: number, b: number, c: number) => void;
-  readonly __wbg_nodeclient_free: (a: number, b: number) => void;
-  readonly nodeclient_new: (a: number) => number;
-  readonly nodeclient_addConnectionToWorker: (a: number, b: number) => number;
-  readonly nodeclient_isRunning: (a: number) => number;
-  readonly nodeclient_start: (a: number, b: number) => number;
-  readonly nodeclient_localPeerId: (a: number) => number;
-  readonly nodeclient_peerTrackerInfo: (a: number) => number;
-  readonly nodeclient_waitConnected: (a: number) => number;
-  readonly nodeclient_waitConnectedTrusted: (a: number) => number;
-  readonly nodeclient_networkInfo: (a: number) => number;
-  readonly nodeclient_listeners: (a: number) => number;
-  readonly nodeclient_connectedPeers: (a: number) => number;
-  readonly nodeclient_setPeerTrust: (a: number, b: number, c: number, d: number) => number;
-  readonly nodeclient_requestHeadHeader: (a: number) => number;
-  readonly nodeclient_requestHeaderByHash: (a: number, b: number, c: number) => number;
-  readonly nodeclient_requestHeaderByHeight: (a: number, b: number) => number;
-  readonly nodeclient_requestVerifiedHeaders: (a: number, b: number, c: number) => number;
-  readonly nodeclient_syncerInfo: (a: number) => number;
-  readonly nodeclient_getNetworkHeadHeader: (a: number) => number;
-  readonly nodeclient_getLocalHeadHeader: (a: number) => number;
-  readonly nodeclient_getHeaderByHash: (a: number, b: number, c: number) => number;
-  readonly nodeclient_getHeaderByHeight: (a: number, b: number) => number;
-  readonly nodeclient_getHeaders: (a: number, b: number, c: number, d: number, e: number) => number;
-  readonly nodeclient_getSamplingMetadata: (a: number, b: number) => number;
-  readonly nodeclient_close: (a: number) => number;
-  readonly nodeclient_eventsChannel: (a: number) => number;
-  readonly nodeconfig_default: (a: number) => number;
-  readonly __wbg_nodeworker_free: (a: number, b: number) => void;
-  readonly nodeworker_new: (a: number) => number;
-  readonly nodeworker_run: (a: number) => number;
-  readonly __wbg_networkinfosnapshot_free: (a: number, b: number) => void;
-  readonly __wbg_get_networkinfosnapshot_connection_counters: (a: number) => number;
-  readonly __wbg_set_networkinfosnapshot_connection_counters: (a: number, b: number) => void;
-  readonly __wbg_connectioncounterssnapshot_free: (a: number, b: number) => void;
-  readonly __wbg_get_connectioncounterssnapshot_num_connections: (a: number) => number;
-  readonly __wbg_set_connectioncounterssnapshot_num_connections: (a: number, b: number) => void;
-  readonly __wbg_get_connectioncounterssnapshot_num_pending: (a: number) => number;
-  readonly __wbg_set_connectioncounterssnapshot_num_pending: (a: number, b: number) => void;
-  readonly __wbg_get_connectioncounterssnapshot_num_pending_incoming: (a: number) => number;
-  readonly __wbg_set_connectioncounterssnapshot_num_pending_incoming: (a: number, b: number) => void;
-  readonly __wbg_get_connectioncounterssnapshot_num_pending_outgoing: (a: number) => number;
-  readonly __wbg_set_connectioncounterssnapshot_num_pending_outgoing: (a: number, b: number) => void;
-  readonly __wbg_get_connectioncounterssnapshot_num_established: (a: number) => number;
-  readonly __wbg_set_connectioncounterssnapshot_num_established: (a: number, b: number) => void;
-  readonly __wbg_get_connectioncounterssnapshot_num_established_incoming: (a: number) => number;
-  readonly __wbg_set_connectioncounterssnapshot_num_established_incoming: (a: number, b: number) => void;
-  readonly __wbg_get_connectioncounterssnapshot_num_established_outgoing: (a: number) => number;
-  readonly __wbg_set_connectioncounterssnapshot_num_established_outgoing: (a: number, b: number) => void;
-  readonly __wbg_set_networkinfosnapshot_num_peers: (a: number, b: number) => void;
-  readonly __wbg_get_networkinfosnapshot_num_peers: (a: number) => number;
-  readonly __wbg_blockrange_free: (a: number, b: number) => void;
-  readonly __wbg_get_blockrange_start: (a: number) => number;
-  readonly __wbg_set_blockrange_start: (a: number, b: number) => void;
-  readonly __wbg_get_blockrange_end: (a: number) => number;
-  readonly __wbg_set_blockrange_end: (a: number, b: number) => void;
-  readonly __wbg_syncinginfosnapshot_free: (a: number, b: number) => void;
-  readonly __wbg_get_syncinginfosnapshot_stored_headers: (a: number, b: number) => void;
-  readonly __wbg_set_syncinginfosnapshot_stored_headers: (a: number, b: number, c: number) => void;
-  readonly __wbg_set_peertrackerinfosnapshot_num_connected_peers: (a: number, b: number) => void;
-  readonly __wbg_set_peertrackerinfosnapshot_num_connected_trusted_peers: (a: number, b: number) => void;
-  readonly __wbg_set_syncinginfosnapshot_subjective_head: (a: number, b: number) => void;
-  readonly __wbg_get_peertrackerinfosnapshot_num_connected_peers: (a: number) => number;
-  readonly __wbg_get_peertrackerinfosnapshot_num_connected_trusted_peers: (a: number) => number;
-  readonly __wbg_get_syncinginfosnapshot_subjective_head: (a: number) => number;
-  readonly __wbg_peertrackerinfosnapshot_free: (a: number, b: number) => void;
-  readonly __wbindgen_malloc: (a: number, b: number) => number;
-  readonly __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
-  readonly __wbindgen_export_2: WebAssembly.Table;
-  readonly _dyn_core__ops__function__FnMut__A____Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__h2f6a021db35c77b9: (a: number, b: number, c: number) => void;
-  readonly _dyn_core__ops__function__Fn__A____Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__hbb2cadc81740e52e: (a: number, b: number, c: number) => void;
-  readonly _dyn_core__ops__function__FnMut_____Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__h551e5119637c385e: (a: number, b: number) => void;
-  readonly _dyn_core__ops__function__FnMut__A____Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__h62ad66d3e9f77ac4: (a: number, b: number, c: number) => void;
-  readonly _dyn_core__ops__function__FnMut_____Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__h0a0047be2e37408e: (a: number, b: number) => void;
-  readonly _dyn_core__ops__function__FnMut__A____Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__h80386b419f109aff: (a: number, b: number, c: number) => void;
-  readonly _dyn_core__ops__function__FnMut__A____Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__h0ff40ee0b4df5b25: (a: number, b: number, c: number) => void;
-  readonly _dyn_core__ops__function__FnMut__A____Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__hbfb1f6eb8d7aa58f: (a: number, b: number, c: number) => void;
-  readonly _dyn_core__ops__function__FnMut_____Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__h9503509ad8c78ce2: (a: number, b: number) => void;
-  readonly __wbindgen_add_to_stack_pointer: (a: number) => number;
-  readonly __wbindgen_free: (a: number, b: number, c: number) => void;
-  readonly __wbindgen_exn_store: (a: number) => void;
-  readonly wasm_bindgen__convert__closures__invoke2_mut__h47e988f82b6e4529: (a: number, b: number, c: number, d: number) => void;
-  readonly __wbindgen_start: () => void;
-}
-
-export type SyncInitInput = BufferSource | WebAssembly.Module;
-/**
-* Instantiates the given `module`, which can either be bytes or
-* a precompiled `WebAssembly.Module`.
-*
-* @param {{ module: SyncInitInput }} module - Passing `SyncInitInput` directly is deprecated.
-*
-* @returns {InitOutput}
-*/
-export function initSync(module: { module: SyncInitInput } | SyncInitInput): InitOutput;
-
-/**
-* If `module_or_path` is {RequestInfo} or {URL}, makes a request and
-* for everything else, calls `WebAssembly.instantiate` directly.
-*
-* @param {{ module_or_path: InitInput | Promise<InitInput> }} module_or_path - Passing `InitInput` directly is deprecated.
-*
-* @returns {Promise<InitOutput>}
-*/
-export default function __wbg_init (module_or_path?: { module_or_path: InitInput | Promise<InitInput> } | InitInput | Promise<InitInput>): Promise<InitOutput>;