@lodestar/light-client 1.21.0-dev.d6175da2fa → 1.21.0-dev.e1dec02b10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -10
- package/package.json +8 -7
package/README.md
CHANGED
|
@@ -18,13 +18,12 @@ The evolution of light clients is emblematic of the broader trajectory of Ethere
|
|
|
18
18
|
|
|
19
19
|
## Requirements for Running a Light-Client
|
|
20
20
|
|
|
21
|
-
Access to an beacon node that supports the light client specification is necessary. The client must support the following routes from the [consensus API spec](https://github.com/ethereum/
|
|
21
|
+
Access to an beacon node that supports the light client specification is necessary. The client must support the following routes from the [consensus API spec](https://github.com/ethereum/beacon-APIs/tree/v2.5.0/apis/beacon/light_client):
|
|
22
22
|
|
|
23
|
-
-
|
|
24
|
-
-
|
|
25
|
-
-
|
|
26
|
-
-
|
|
27
|
-
- `/eth/v0/beacon/light_client/committee_root`
|
|
23
|
+
- [`GET /eth/v1/beacon/light_client/updates`](https://ethereum.github.io/beacon-APIs/?urls.primaryName=v2.5.0#/Beacon/getLightClientUpdatesByRange)
|
|
24
|
+
- [`GET /eth/v1/beacon/light_client/optimistic_update`](https://ethereum.github.io/beacon-APIs/?urls.primaryName=v2.5.0#/Beacon/getLightClientOptimisticUpdate)
|
|
25
|
+
- [`GET /eth/v1/beacon/light_client/finality_update`](https://ethereum.github.io/beacon-APIs/?urls.primaryName=v2.5.0#/Beacon/getLightClientFinalityUpdate)
|
|
26
|
+
- [`GET /eth/v1/beacon/light_client/bootstrap/{block_root}`](https://ethereum.github.io/beacon-APIs/?urls.primaryName=v2.5.0#/Beacon/getLightClientBootstrap)
|
|
28
27
|
|
|
29
28
|
System requirements are quite low so its possible to run a light client in the browser as part of a website. There are a few examples of this on github that you can use as reference, our [prover](https://chainsafe.github.io/lodestar/libraries/lightclient-prover/prover) being one of them.
|
|
30
29
|
|
|
@@ -42,8 +41,8 @@ It is possible to start up the light-client as a standalone process.
|
|
|
42
41
|
```bash
|
|
43
42
|
lodestar lightclient \
|
|
44
43
|
--network sepolia \
|
|
45
|
-
--
|
|
46
|
-
--
|
|
44
|
+
--beaconApiUrl https://lodestar-sepolia.chainsafe.io \
|
|
45
|
+
--checkpointRoot "0xccaff4b99986a7b05e06738f1828a32e40799b277fd9f9ff069be55341fe0229"
|
|
47
46
|
```
|
|
48
47
|
|
|
49
48
|
## Light-Client Programmatic Example
|
|
@@ -93,12 +92,12 @@ lightclient.emitter.on(LightclientEvent.lightClientOptimisticHeader, async (opti
|
|
|
93
92
|
|
|
94
93
|
## Browser Integration
|
|
95
94
|
|
|
96
|
-
If you want to use Lightclient in browser and facing some issues in building it with bundlers like webpack, vite. We suggest to use our distribution build. The support for single distribution build is started from `1.
|
|
95
|
+
If you want to use Lightclient in browser and facing some issues in building it with bundlers like webpack, vite. We suggest to use our distribution build. The support for single distribution build is started from `1.20.0` version.
|
|
97
96
|
|
|
98
97
|
Directly link the dist build with the `<script />` tag with tools like unpkg or other. e.g.
|
|
99
98
|
|
|
100
99
|
```html
|
|
101
|
-
<script src="https://www.unpkg.com/@lodestar/light-client@1.
|
|
100
|
+
<script src="https://www.unpkg.com/@lodestar/light-client@1.20.0/dist/lightclient.min.mjs" type="module">
|
|
102
101
|
```
|
|
103
102
|
|
|
104
103
|
Then the lightclient package will be exposed to `globalThis`, in case of browser environment that will be `window`. You can access the package as `window.lodestar.lightclient`. All named exports will also be available from this interface. e.g. `window.lodestar.lightclient.transport`.
|
package/package.json
CHANGED
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
"bugs": {
|
|
12
12
|
"url": "https://github.com/ChainSafe/lodestar/issues"
|
|
13
13
|
},
|
|
14
|
-
"version": "1.21.0-dev.
|
|
14
|
+
"version": "1.21.0-dev.e1dec02b10",
|
|
15
15
|
"type": "module",
|
|
16
16
|
"exports": {
|
|
17
17
|
".": {
|
|
@@ -74,13 +74,14 @@
|
|
|
74
74
|
},
|
|
75
75
|
"dependencies": {
|
|
76
76
|
"@chainsafe/bls": "7.1.3",
|
|
77
|
+
"@chainsafe/blst": "^0.2.0",
|
|
77
78
|
"@chainsafe/persistent-merkle-tree": "^0.7.1",
|
|
78
79
|
"@chainsafe/ssz": "^0.15.1",
|
|
79
|
-
"@lodestar/api": "1.21.0-dev.
|
|
80
|
-
"@lodestar/config": "1.21.0-dev.
|
|
81
|
-
"@lodestar/params": "1.21.0-dev.
|
|
82
|
-
"@lodestar/types": "1.21.0-dev.
|
|
83
|
-
"@lodestar/utils": "1.21.0-dev.
|
|
80
|
+
"@lodestar/api": "1.21.0-dev.e1dec02b10",
|
|
81
|
+
"@lodestar/config": "1.21.0-dev.e1dec02b10",
|
|
82
|
+
"@lodestar/params": "1.21.0-dev.e1dec02b10",
|
|
83
|
+
"@lodestar/types": "1.21.0-dev.e1dec02b10",
|
|
84
|
+
"@lodestar/utils": "1.21.0-dev.e1dec02b10",
|
|
84
85
|
"mitt": "^3.0.0"
|
|
85
86
|
},
|
|
86
87
|
"devDependencies": {
|
|
@@ -97,5 +98,5 @@
|
|
|
97
98
|
"light-client",
|
|
98
99
|
"blockchain"
|
|
99
100
|
],
|
|
100
|
-
"gitHead": "
|
|
101
|
+
"gitHead": "6f37877f25b0bb82d9eb9041ff69e5a82cc80794"
|
|
101
102
|
}
|