lumina-node-wasm 0.2.0 → 0.3.1

package/README.md

@@ -3,14 +3,40 @@
 A compatibility layer for the [`Lumina`](https://github.com/eigerco/lumina) node to
 work within a browser environment and be operable with javascript.
 
+# Example
+Starting lumina inside a dedicated worker
+
 ```javascript
-import init, { Node, NodeConfig, Network } from "/wasm/lumina_node_wasm.js";
+import { spawnNode, NodeConfig, Network } from "lumina-node";
 
-await init();
+const node = await spawnNode();
+const mainnetConfig = NodeConfig.default(Network.Mainnet);
+
+await node.start(mainnetConfig);
+
+await node.waitConnected();
+await node.requestHeadHeader();
+```
+
+## Manual setup
 
+Note that `spawnNode` implicitly calls wasm initialisation code. If you want to set things up manually, make sure to call the default export before using any of the wasm functionality.
+
+```javascript
+import init, { NodeConfig, Network } from "lumina-node";
+
+await init();
 const config = NodeConfig.default(Network.Mainnet);
-const node = await new Node(config);
 
-await node.wait_connected();
-await node.request_head_header();
+// 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();
 ```

package/lumina_node_wasm.d.ts

@@ -27,7 +27,34 @@ export enum Network {
 }
 /**
 */
+export class BlockRange {
+/**
+** Return copy of self without private attributes.
+*/
+  toJSON(): Object;
+/**
+* Return stringified version of self.
+*/
+  toString(): string;
+  free(): void;
+/**
+*/
+  end: bigint;
+/**
+*/
+  start: bigint;
+}
+/**
+*/
 export class ConnectionCountersSnapshot {
+/**
+** Return copy of self without private attributes.
+*/
+  toJSON(): Object;
+/**
+* Return stringified version of self.
+*/
+  toString(): string;
   free(): void;
 /**
 */
@@ -54,13 +81,24 @@ export class ConnectionCountersSnapshot {
 /**
 */
 export class NetworkInfoSnapshot {
+/**
+** Return copy of self without private attributes.
+*/
+  toJSON(): Object;
+/**
+* Return stringified version of self.
+*/
+  toString(): string;
   free(): void;
 /**
+*/
+  connection_counters: ConnectionCountersSnapshot;
+/**
 */
   num_peers: number;
 }
 /**
-* `NodeDriver` is responsible for steering [`NodeWorker`] by sending it commands and receiving
+* `NodeClient` is responsible for steering [`NodeWorker`] by sending it commands and receiving
 * responses over the provided port.
 *
 * [`NodeWorker`]: crate::worker::NodeWorker
@@ -74,10 +112,16 @@ export class NodeClient {
 */
   constructor(port: any);
 /**
+* Establish a new connection to the existing worker over provided port
+* @param {any} port
+* @returns {Promise<void>}
+*/
+  addConnectionToWorker(port: any): Promise<void>;
+/**
 * Check whether Lumina is currently running
 * @returns {Promise<boolean>}
 */
-  is_running(): Promise<boolean>;
+  isRunning(): Promise<boolean>;
 /**
 * Start a node with the provided config, if it's not running
 * @param {NodeConfig} config
@@ -88,27 +132,27 @@ export class NodeClient {
 * Get node's local peer ID.
 * @returns {Promise<string>}
 */
-  local_peer_id(): Promise<string>;
+  localPeerId(): Promise<string>;
 /**
 * Get current [`PeerTracker`] info.
-* @returns {Promise<any>}
+* @returns {Promise<PeerTrackerInfoSnapshot>}
 */
-  peer_tracker_info(): Promise<any>;
+  peerTrackerInfo(): Promise<PeerTrackerInfoSnapshot>;
 /**
 * Wait until the node is connected to at least 1 peer.
 * @returns {Promise<void>}
 */
-  wait_connected(): Promise<void>;
+  waitConnected(): Promise<void>;
 /**
 * Wait until the node is connected to at least 1 trusted peer.
 * @returns {Promise<void>}
 */
-  wait_connected_trusted(): Promise<void>;
+  waitConnectedTrusted(): Promise<void>;
 /**
 * Get current network info.
 * @returns {Promise<NetworkInfoSnapshot>}
 */
-  network_info(): Promise<NetworkInfoSnapshot>;
+  networkInfo(): Promise<NetworkInfoSnapshot>;
 /**
 * Get all the multiaddresses on which the node listens.
 * @returns {Promise<Array<any>>}
@@ -118,67 +162,91 @@ export class NodeClient {
 * Get all the peers that node is connected to.
 * @returns {Promise<Array<any>>}
 */
-  connected_peers(): Promise<Array<any>>;
+  connectedPeers(): Promise<Array<any>>;
 /**
 * Trust or untrust the peer with a given ID.
 * @param {string} peer_id
 * @param {boolean} is_trusted
 * @returns {Promise<void>}
 */
-  set_peer_trust(peer_id: string, is_trusted: boolean): Promise<void>;
+  setPeerTrust(peer_id: string, is_trusted: boolean): Promise<void>;
 /**
 * Request the head header from the network.
+*
+* Returns a javascript object with given structure:
+* https://docs.rs/celestia-types/latest/celestia_types/struct.ExtendedHeader.html
 * @returns {Promise<any>}
 */
-  request_head_header(): Promise<any>;
+  requestHeadHeader(): Promise<any>;
 /**
 * Request a header for the block with a given hash from the network.
+*
+* Returns a javascript object with given structure:
+* https://docs.rs/celestia-types/latest/celestia_types/struct.ExtendedHeader.html
 * @param {string} hash
 * @returns {Promise<any>}
 */
-  request_header_by_hash(hash: string): Promise<any>;
+  requestHeaderByHash(hash: string): Promise<any>;
 /**
 * Request a header for the block with a given height from the network.
+*
+* Returns a javascript object with given structure:
+* https://docs.rs/celestia-types/latest/celestia_types/struct.ExtendedHeader.html
 * @param {bigint} height
 * @returns {Promise<any>}
 */
-  request_header_by_height(height: bigint): Promise<any>;
+  requestHeaderByHeight(height: bigint): Promise<any>;
 /**
 * Request headers in range (from, from + amount] from the network.
 *
 * The headers will be verified with the `from` header.
+*
+* Returns an array of javascript objects with given structure:
+* https://docs.rs/celestia-types/latest/celestia_types/struct.ExtendedHeader.html
 * @param {any} from_header
 * @param {bigint} amount
 * @returns {Promise<Array<any>>}
 */
-  request_verified_headers(from_header: any, amount: bigint): Promise<Array<any>>;
+  requestVerifiedHeaders(from_header: any, amount: bigint): Promise<Array<any>>;
 /**
 * Get current header syncing info.
-* @returns {Promise<any>}
+* @returns {Promise<SyncingInfoSnapshot>}
 */
-  syncer_info(): Promise<any>;
+  syncerInfo(): Promise<SyncingInfoSnapshot>;
 /**
 * Get the latest header announced in the network.
+*
+* Returns a javascript object with given structure:
+* https://docs.rs/celestia-types/latest/celestia_types/struct.ExtendedHeader.html
 * @returns {Promise<any>}
 */
-  get_network_head_header(): Promise<any>;
+  getNetworkHeadHeader(): Promise<any>;
 /**
 * Get the latest locally synced header.
+*
+* Returns a javascript object with given structure:
+* https://docs.rs/celestia-types/latest/celestia_types/struct.ExtendedHeader.html
 * @returns {Promise<any>}
 */
-  get_local_head_header(): Promise<any>;
+  getLocalHeadHeader(): Promise<any>;
 /**
 * Get a synced header for the block with a given hash.
+*
+* Returns a javascript object with given structure:
+* https://docs.rs/celestia-types/latest/celestia_types/struct.ExtendedHeader.html
 * @param {string} hash
 * @returns {Promise<any>}
 */
-  get_header_by_hash(hash: string): Promise<any>;
+  getHeaderByHash(hash: string): Promise<any>;
 /**
 * Get a synced header for the block with a given height.
+*
+* Returns a javascript object with given structure:
+* https://docs.rs/celestia-types/latest/celestia_types/struct.ExtendedHeader.html
 * @param {bigint} height
 * @returns {Promise<any>}
 */
-  get_header_by_height(height: bigint): Promise<any>;
+  getHeaderByHeight(height: bigint): Promise<any>;
 /**
 * Get synced headers from the given heights range.
 *
@@ -189,17 +257,23 @@ export class NodeClient {
 * # Errors
 *
 * If range contains a height of a header that is not found in the store.
+*
+* Returns an array of javascript objects with given structure:
+* https://docs.rs/celestia-types/latest/celestia_types/struct.ExtendedHeader.html
 * @param {bigint | undefined} [start_height]
 * @param {bigint | undefined} [end_height]
 * @returns {Promise<Array<any>>}
 */
-  get_headers(start_height?: bigint, end_height?: bigint): Promise<Array<any>>;
+  getHeaders(start_height?: bigint, end_height?: bigint): Promise<Array<any>>;
 /**
 * Get data sampling metadata of an already sampled height.
+*
+* Returns a javascript object with given structure:
+* https://docs.rs/lumina-node/latest/lumina_node/store/struct.SamplingMetadata.html
 * @param {bigint} height
 * @returns {Promise<any>}
 */
-  get_sampling_metadata(height: bigint): Promise<any>;
+  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.
@@ -210,12 +284,20 @@ export class NodeClient {
 * Returns a [`BroadcastChannel`] for events generated by [`Node`].
 * @returns {Promise<BroadcastChannel>}
 */
-  events_channel(): Promise<BroadcastChannel>;
+  eventsChannel(): Promise<BroadcastChannel>;
 }
 /**
 * Config for the lumina wasm node.
 */
 export class NodeConfig {
+/**
+** Return copy of self without private attributes.
+*/
+  toJSON(): Object;
+/**
+* Return stringified version of self.
+*/
+  toString(): string;
   free(): void;
 /**
 * Get the configuration with default bootnodes for provided network
@@ -237,15 +319,164 @@ export class NodeConfig {
 export class NodeWorker {
   free(): void;
 /**
+* @param {any} port_like_object
 */
-  constructor();
+  constructor(port_like_object: any);
 /**
-* @param {any} port
 * @returns {Promise<void>}
 */
-  connect(port: any): Promise<void>;
+  run(): Promise<void>;
+}
 /**
-* @returns {Promise<void>}
 */
-  poll(): Promise<void>;
+export class PeerTrackerInfoSnapshot {
+/**
+** Return copy of self without private attributes.
+*/
+  toJSON(): Object;
+/**
+* Return stringified version of self.
+*/
+  toString(): string;
+  free(): void;
+/**
+*/
+  num_connected_peers: bigint;
+/**
+*/
+  num_connected_trusted_peers: bigint;
 }
+/**
+*/
+export class SyncingInfoSnapshot {
+/**
+** Return copy of self without private attributes.
+*/
+  toJSON(): Object;
+/**
+* Return stringified version of self.
+*/
+  toString(): string;
+  free(): void;
+/**
+*/
+  stored_headers: (BlockRange)[];
+/**
+*/
+  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>;