From 93912e48c8f1044af7b7e74315f0de8b3ea899d8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maciej=20Zwoli=C5=84ski?= Date: Mon, 16 Dec 2024 16:32:02 +0100 Subject: [PATCH] update lumina-node npm package --- node-wasm/js/README.md | 96 ++++++++++++++++++++++++++------------- node-wasm/js/package.json | 4 +- 2 files changed, 66 insertions(+), 34 deletions(-) diff --git a/node-wasm/js/README.md b/node-wasm/js/README.md index 87274c34..373b286b 100644 --- a/node-wasm/js/README.md +++ b/node-wasm/js/README.md @@ -1,7 +1,7 @@ -**lumina-node-wasm** • [**Docs**](#globalsmd) +**lumina-node-wasm** *** @@ -57,7 +57,7 @@ For comprehensive and fully typed interface documentation, see [lumina-node](htt -[**lumina-node-wasm**](#readmemd) • **Docs** +[**lumina-node-wasm**](#readmemd) *** @@ -150,7 +150,7 @@ lumina\_node\_wasm.d.ts:39 -[**lumina-node-wasm**](#readmemd) • **Docs** +[**lumina-node-wasm**](#readmemd) *** @@ -301,7 +301,7 @@ lumina\_node\_wasm.d.ts:60 -[**lumina-node-wasm**](#readmemd) • **Docs** +[**lumina-node-wasm**](#readmemd) *** @@ -394,7 +394,7 @@ lumina\_node\_wasm.d.ts:102 -[**lumina-node-wasm**](#readmemd) • **Docs** +[**lumina-node-wasm**](#readmemd) *** @@ -418,7 +418,9 @@ expected to have `MessagePort`-like interface for sending and receiving messages ##### Parameters -• **port**: `any` +###### port + +`any` ##### Returns @@ -438,7 +440,9 @@ Establish a new connection to the existing worker over provided port ##### Parameters -• **port**: `any` +###### port + +`any` ##### Returns @@ -507,7 +511,9 @@ https://docs.rs/celestia-types/latest/celestia_types/struct.ExtendedHeader.html ##### Parameters -• **hash**: `string` +###### hash + +`string` ##### Returns @@ -530,7 +536,9 @@ https://docs.rs/celestia-types/latest/celestia_types/struct.ExtendedHeader.html ##### Parameters -• **height**: `bigint` +###### height + +`bigint` ##### Returns @@ -561,9 +569,13 @@ https://docs.rs/celestia-types/latest/celestia_types/struct.ExtendedHeader.html ##### Parameters -• **start\_height?**: `bigint` +###### start\_height? -• **end\_height?**: `bigint` +`bigint` + +###### end\_height? + +`bigint` ##### Returns @@ -624,7 +636,9 @@ https://docs.rs/lumina-node/latest/lumina_node/store/struct.SamplingMetadata.htm ##### Parameters -• **height**: `bigint` +###### height + +`bigint` ##### Returns @@ -727,7 +741,9 @@ https://docs.rs/celestia-types/latest/celestia_types/struct.ExtendedHeader.html ##### Parameters -• **hash**: `string` +###### hash + +`string` ##### Returns @@ -750,7 +766,9 @@ https://docs.rs/celestia-types/latest/celestia_types/struct.ExtendedHeader.html ##### Parameters -• **height**: `bigint` +###### height + +`bigint` ##### Returns @@ -794,9 +812,13 @@ https://docs.rs/celestia-types/latest/celestia_types/struct.ExtendedHeader.html ##### Parameters -• **from\_header**: `any` +###### from\_header + +`any` + +###### amount -• **amount**: `bigint` +`bigint` ##### Returns @@ -816,9 +838,13 @@ Trust or untrust the peer with a given ID. ##### Parameters -• **peer\_id**: `string` +###### peer\_id + +`string` + +###### is\_trusted -• **is\_trusted**: `boolean` +`boolean` ##### Returns @@ -838,7 +864,9 @@ Start a node with the provided config, if it's not running ##### Parameters -• **config**: [`NodeConfig`](#classesnodeconfigmd) +###### config + +[`NodeConfig`](#classesnodeconfigmd) ##### Returns @@ -913,7 +941,7 @@ lumina\_node\_wasm.d.ts:167 -[**lumina-node-wasm**](#readmemd) • **Docs** +[**lumina-node-wasm**](#readmemd) *** @@ -947,12 +975,12 @@ lumina\_node\_wasm.d.ts:322 *** -#### custom\_syncing\_window\_secs? +#### custom\_sampling\_window\_secs? -> `optional` **custom\_syncing\_window\_secs**: `number` +> `optional` **custom\_sampling\_window\_secs**: `number` -Syncing window size, defines maximum age of headers considered for syncing and sampling. -Headers older than syncing window by more than an hour are eligible for pruning. +Sampling window size, defines maximum age of headers considered for syncing and sampling. +Headers older than sampling window by more than an hour are eligible for pruning. ##### Defined in @@ -1026,7 +1054,9 @@ Get the configuration with default bootnodes for provided network ##### Parameters -• **network**: [`Network`](#enumerationsnetworkmd) +###### network + +[`Network`](#enumerationsnetworkmd) ##### Returns @@ -1039,7 +1069,7 @@ lumina\_node\_wasm.d.ts:318 -[**lumina-node-wasm**](#readmemd) • **Docs** +[**lumina-node-wasm**](#readmemd) *** @@ -1060,7 +1090,9 @@ them and sending a response back, as well as accepting new `NodeClient` connecti ##### Parameters -• **port\_like\_object**: `any` +###### port\_like\_object + +`any` ##### Returns @@ -1101,7 +1133,7 @@ lumina\_node\_wasm.d.ts:348 -[**lumina-node-wasm**](#readmemd) • **Docs** +[**lumina-node-wasm**](#readmemd) *** @@ -1194,7 +1226,7 @@ lumina\_node\_wasm.d.ts:361 -[**lumina-node-wasm**](#readmemd) • **Docs** +[**lumina-node-wasm**](#readmemd) *** @@ -1289,7 +1321,7 @@ lumina\_node\_wasm.d.ts:383 -[**lumina-node-wasm**](#readmemd) • **Docs** +[**lumina-node-wasm**](#readmemd) *** @@ -1352,7 +1384,7 @@ lumina\_node\_wasm.d.ts:26 -[**lumina-node-wasm**](#readmemd) • **Docs** +[**lumina-node-wasm**](#readmemd) *** @@ -1375,7 +1407,7 @@ lumina\_node\_wasm.d.ts:6 -[**lumina-node-wasm**](#readmemd) • **Docs** +[**lumina-node-wasm**](#readmemd) *** diff --git a/node-wasm/js/package.json b/node-wasm/js/package.json index 06b00155..123aff11 100644 --- a/node-wasm/js/package.json +++ b/node-wasm/js/package.json @@ -5,7 +5,7 @@ "Eiger " ], "description": "Lumina node for Celestia, running in browser", - "version": "0.7.0", + "version": "0.8.0", "license": "Apache-2.0", "repository": { "type": "git", @@ -19,7 +19,7 @@ "main": "index.js", "homepage": "https://www.eiger.co", "dependencies": { - "lumina-node-wasm": "0.7.0" + "lumina-node-wasm": "0.8.0" }, "keywords": [ "blockchain",