lumina-node-wasm 0.2.0

package/README.md

@@ -0,0 +1,16 @@
+# Lumina node wasm
+
+A compatibility layer for the [`Lumina`](https://github.com/eigerco/lumina) node to
+work within a browser environment and be operable with javascript.
+
+```javascript
+import init, { Node, NodeConfig, Network } from "/wasm/lumina_node_wasm.js";
+
+await init();
+
+const config = NodeConfig.default(Network.Mainnet);
+const node = await new Node(config);
+
+await node.wait_connected();
+await node.request_head_header();
+```

package/lumina_node_wasm.d.ts

@@ -0,0 +1,251 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+* Set up a logging layer that direct logs to the browser's console.
+*/
+export function setup_logging(): void;
+/**
+* Supported Celestia networks.
+*/
+export enum Network {
+/**
+* Celestia mainnet.
+*/
+  Mainnet = 0,
+/**
+* Arabica testnet.
+*/
+  Arabica = 1,
+/**
+* Mocha testnet.
+*/
+  Mocha = 2,
+/**
+* Private local network.
+*/
+  Private = 3,
+}
+/**
+*/
+export class ConnectionCountersSnapshot {
+  free(): void;
+/**
+*/
+  num_connections: number;
+/**
+*/
+  num_established: number;
+/**
+*/
+  num_established_incoming: number;
+/**
+*/
+  num_established_outgoing: number;
+/**
+*/
+  num_pending: number;
+/**
+*/
+  num_pending_incoming: number;
+/**
+*/
+  num_pending_outgoing: number;
+}
+/**
+*/
+export class NetworkInfoSnapshot {
+  free(): void;
+/**
+*/
+  num_peers: number;
+}
+/**
+* `NodeDriver` is responsible for steering [`NodeWorker`] by sending it commands and receiving
+* responses over the provided port.
+*
+* [`NodeWorker`]: crate::worker::NodeWorker
+*/
+export class NodeClient {
+  free(): void;
+/**
+* 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.
+* @param {any} port
+*/
+  constructor(port: any);
+/**
+* Check whether Lumina is currently running
+* @returns {Promise<boolean>}
+*/
+  is_running(): Promise<boolean>;
+/**
+* Start a node with the provided config, if it's not running
+* @param {NodeConfig} config
+* @returns {Promise<void>}
+*/
+  start(config: NodeConfig): Promise<void>;
+/**
+* Get node's local peer ID.
+* @returns {Promise<string>}
+*/
+  local_peer_id(): Promise<string>;
+/**
+* Get current [`PeerTracker`] info.
+* @returns {Promise<any>}
+*/
+  peer_tracker_info(): Promise<any>;
+/**
+* Wait until the node is connected to at least 1 peer.
+* @returns {Promise<void>}
+*/
+  wait_connected(): Promise<void>;
+/**
+* Wait until the node is connected to at least 1 trusted peer.
+* @returns {Promise<void>}
+*/
+  wait_connected_trusted(): Promise<void>;
+/**
+* Get current network info.
+* @returns {Promise<NetworkInfoSnapshot>}
+*/
+  network_info(): Promise<NetworkInfoSnapshot>;
+/**
+* Get all the multiaddresses on which the node listens.
+* @returns {Promise<Array<any>>}
+*/
+  listeners(): Promise<Array<any>>;
+/**
+* Get all the peers that node is connected to.
+* @returns {Promise<Array<any>>}
+*/
+  connected_peers(): 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>;
+/**
+* Request the head header from the network.
+* @returns {Promise<any>}
+*/
+  request_head_header(): Promise<any>;
+/**
+* Request a header for the block with a given hash from the network.
+* @param {string} hash
+* @returns {Promise<any>}
+*/
+  request_header_by_hash(hash: string): Promise<any>;
+/**
+* Request a header for the block with a given height from the network.
+* @param {bigint} height
+* @returns {Promise<any>}
+*/
+  request_header_by_height(height: bigint): Promise<any>;
+/**
+* Request headers in range (from, from + amount] from the network.
+*
+* The headers will be verified with the `from` header.
+* @param {any} from_header
+* @param {bigint} amount
+* @returns {Promise<Array<any>>}
+*/
+  request_verified_headers(from_header: any, amount: bigint): Promise<Array<any>>;
+/**
+* Get current header syncing info.
+* @returns {Promise<any>}
+*/
+  syncer_info(): Promise<any>;
+/**
+* Get the latest header announced in the network.
+* @returns {Promise<any>}
+*/
+  get_network_head_header(): Promise<any>;
+/**
+* Get the latest locally synced header.
+* @returns {Promise<any>}
+*/
+  get_local_head_header(): Promise<any>;
+/**
+* Get a synced header for the block with a given hash.
+* @param {string} hash
+* @returns {Promise<any>}
+*/
+  get_header_by_hash(hash: string): Promise<any>;
+/**
+* Get a synced header for the block with a given height.
+* @param {bigint} height
+* @returns {Promise<any>}
+*/
+  get_header_by_height(height: bigint): Promise<any>;
+/**
+* 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.
+* @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>>;
+/**
+* Get data sampling metadata of an already sampled height.
+* @param {bigint} height
+* @returns {Promise<any>}
+*/
+  get_sampling_metadata(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>}
+*/
+  events_channel(): Promise<BroadcastChannel>;
+}
+/**
+* Config for the lumina wasm node.
+*/
+export class NodeConfig {
+  free(): void;
+/**
+* Get the configuration with default bootnodes for provided network
+* @param {Network} network
+* @returns {NodeConfig}
+*/
+  static default(network: Network): NodeConfig;
+/**
+* A list of bootstrap peers to connect to.
+*/
+  bootnodes: (string)[];
+/**
+* A network to connect to.
+*/
+  network: Network;
+}
+/**
+*/
+export class NodeWorker {
+  free(): void;
+/**
+*/
+  constructor();
+/**
+* @param {any} port
+* @returns {Promise<void>}
+*/
+  connect(port: any): Promise<void>;
+/**
+* @returns {Promise<void>}
+*/
+  poll(): Promise<void>;
+}

package/lumina_node_wasm.js

@@ -0,0 +1,7 @@
+
+import * as wasm from "./lumina_node_wasm_bg.wasm";
+import { __wbg_set_wasm } from "./lumina_node_wasm_bg.js";
+__wbg_set_wasm(wasm);
+export * from "./lumina_node_wasm_bg.js";
+
+wasm.__wbindgen_start();