Skip to content

Commit

Permalink
update lumina-node npm package
Browse files Browse the repository at this point in the history
  • Loading branch information
zvolin authored Dec 16, 2024
1 parent a28543d commit 93912e4
Show file tree
Hide file tree
Showing 2 changed files with 66 additions and 34 deletions.
96 changes: 64 additions & 32 deletions node-wasm/js/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

<a name="readmemd"></a>

**lumina-node-wasm**[**Docs**](#globalsmd)
**lumina-node-wasm**

***

Expand Down Expand Up @@ -57,7 +57,7 @@ For comprehensive and fully typed interface documentation, see [lumina-node](htt

<a name="classesblockrangemd"></a>

[**lumina-node-wasm**](#readmemd)**Docs**
[**lumina-node-wasm**](#readmemd)

***

Expand Down Expand Up @@ -150,7 +150,7 @@ lumina\_node\_wasm.d.ts:39

<a name="classesconnectioncounterssnapshotmd"></a>

[**lumina-node-wasm**](#readmemd)**Docs**
[**lumina-node-wasm**](#readmemd)

***

Expand Down Expand Up @@ -301,7 +301,7 @@ lumina\_node\_wasm.d.ts:60

<a name="classesnetworkinfosnapshotmd"></a>

[**lumina-node-wasm**](#readmemd)**Docs**
[**lumina-node-wasm**](#readmemd)

***

Expand Down Expand Up @@ -394,7 +394,7 @@ lumina\_node\_wasm.d.ts:102

<a name="classesnodeclientmd"></a>

[**lumina-node-wasm**](#readmemd)**Docs**
[**lumina-node-wasm**](#readmemd)

***

Expand All @@ -418,7 +418,9 @@ expected to have `MessagePort`-like interface for sending and receiving messages

##### Parameters

**port**: `any`
###### port

`any`

##### Returns

Expand All @@ -438,7 +440,9 @@ Establish a new connection to the existing worker over provided port

##### Parameters

**port**: `any`
###### port

`any`

##### Returns

Expand Down Expand Up @@ -507,7 +511,9 @@ https://docs.rs/celestia-types/latest/celestia_types/struct.ExtendedHeader.html

##### Parameters

**hash**: `string`
###### hash

`string`

##### Returns

Expand All @@ -530,7 +536,9 @@ https://docs.rs/celestia-types/latest/celestia_types/struct.ExtendedHeader.html

##### Parameters

**height**: `bigint`
###### height

`bigint`

##### Returns

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -624,7 +636,9 @@ https://docs.rs/lumina-node/latest/lumina_node/store/struct.SamplingMetadata.htm

##### Parameters

**height**: `bigint`
###### height

`bigint`

##### Returns

Expand Down Expand Up @@ -727,7 +741,9 @@ https://docs.rs/celestia-types/latest/celestia_types/struct.ExtendedHeader.html

##### Parameters

**hash**: `string`
###### hash

`string`

##### Returns

Expand All @@ -750,7 +766,9 @@ https://docs.rs/celestia-types/latest/celestia_types/struct.ExtendedHeader.html

##### Parameters

**height**: `bigint`
###### height

`bigint`

##### Returns

Expand Down Expand Up @@ -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

Expand All @@ -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

Expand All @@ -838,7 +864,9 @@ Start a node with the provided config, if it's not running

##### Parameters

**config**: [`NodeConfig`](#classesnodeconfigmd)
###### config

[`NodeConfig`](#classesnodeconfigmd)

##### Returns

Expand Down Expand Up @@ -913,7 +941,7 @@ lumina\_node\_wasm.d.ts:167

<a name="classesnodeconfigmd"></a>

[**lumina-node-wasm**](#readmemd)**Docs**
[**lumina-node-wasm**](#readmemd)

***

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -1026,7 +1054,9 @@ Get the configuration with default bootnodes for provided network

##### Parameters

**network**: [`Network`](#enumerationsnetworkmd)
###### network

[`Network`](#enumerationsnetworkmd)

##### Returns

Expand All @@ -1039,7 +1069,7 @@ lumina\_node\_wasm.d.ts:318

<a name="classesnodeworkermd"></a>

[**lumina-node-wasm**](#readmemd)**Docs**
[**lumina-node-wasm**](#readmemd)

***

Expand All @@ -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

Expand Down Expand Up @@ -1101,7 +1133,7 @@ lumina\_node\_wasm.d.ts:348

<a name="classespeertrackerinfosnapshotmd"></a>

[**lumina-node-wasm**](#readmemd)**Docs**
[**lumina-node-wasm**](#readmemd)

***

Expand Down Expand Up @@ -1194,7 +1226,7 @@ lumina\_node\_wasm.d.ts:361

<a name="classessyncinginfosnapshotmd"></a>

[**lumina-node-wasm**](#readmemd)**Docs**
[**lumina-node-wasm**](#readmemd)

***

Expand Down Expand Up @@ -1289,7 +1321,7 @@ lumina\_node\_wasm.d.ts:383

<a name="enumerationsnetworkmd"></a>

[**lumina-node-wasm**](#readmemd)**Docs**
[**lumina-node-wasm**](#readmemd)

***

Expand Down Expand Up @@ -1352,7 +1384,7 @@ lumina\_node\_wasm.d.ts:26

<a name="functionssetup_loggingmd"></a>

[**lumina-node-wasm**](#readmemd)**Docs**
[**lumina-node-wasm**](#readmemd)

***

Expand All @@ -1375,7 +1407,7 @@ lumina\_node\_wasm.d.ts:6

<a name="globalsmd"></a>

[**lumina-node-wasm**](#readmemd)**Docs**
[**lumina-node-wasm**](#readmemd)

***

Expand Down
4 changes: 2 additions & 2 deletions node-wasm/js/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"Eiger <[email protected]>"
],
"description": "Lumina node for Celestia, running in browser",
"version": "0.7.0",
"version": "0.8.0",
"license": "Apache-2.0",
"repository": {
"type": "git",
Expand All @@ -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",
Expand Down

0 comments on commit 93912e4

Please sign in to comment.