@typeberry/convert 0.4.0 → 0.4.1-3923458

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.
Files changed (4) hide show
  1. package/README.md +27 -0
  2. package/index.js +2862 -2293
  3. package/index.js.map +1 -1
  4. package/package.json +1 -1
package/README.md CHANGED
@@ -8,6 +8,11 @@ Typeberry is a TypeScript implementation of [JAM protocol](https://graypaper.com
8
8
  PRs unless the contributor waives any claims to the prize and copy rights for
9
9
  the submitted code. By creating the PR you accept this requirement.**
10
10
 
11
+ ## Links
12
+
13
+ - [Documentation](https://fluffylabs.dev/typeberry)
14
+ - [Performance Charts](https://typeberry.fluffylabs.dev)
15
+
11
16
  ## Implementation status
12
17
 
13
18
  Gray Paper compliance can be controlled via `GP_VERSION` environment variable.
@@ -96,6 +101,9 @@ $ npm start -w @typeberry/rpc
96
101
  ### Additional tooling
97
102
 
98
103
  - [@typeberry/convert](bin/convert/README.md) - convert common JAM formats
104
+ - [@typeberry/jam](bin/jam/README.md) - main typeberry/jam node binary
105
+ - [@typeberry/lib](bin/lib/README.md) - typeberry-as-library. All utilities exposed as ESM, browser-compatible
106
+ library.
99
107
  - [JAM search](https://github.com/fluffylabs/jam-search) - search across all public JAM-related channels
100
108
  - [State Viewer](https://github.com/fluffylabs/state-viewer) - load & inspect state of test vectors
101
109
  - [PVM Debugger](https://github.com/fluffylabs/pvm-debugger) - load & inspect a PVM program
@@ -163,6 +171,25 @@ all relevant ones can be easily checked out from [our test vectors repository](h
163
171
  Obviously it's also possible to run just single test case or part of the test
164
172
  cases by altering the glob pattern in the path.
165
173
 
174
+ #### Selecting PVM Backend
175
+
176
+ By default, test vectors are run with both PVM backends (built-in and Ananas).
177
+ You can select a specific PVM backend using the `--pvm` option:
178
+
179
+ ```bash
180
+ # Run tests with built-in PVM only
181
+ $ npm run w3f-davxy:0.7.1 -w @typeberry/test-runner -- --pvm builtin
182
+
183
+ # Run tests with Ananas PVM only
184
+ $ npm run w3f-davxy:0.7.1 -w @typeberry/test-runner -- --pvm ananas
185
+
186
+ # Run tests with both PVMs (default)
187
+ $ npm run w3f-davxy:0.7.1 -w @typeberry/test-runner
188
+ ```
189
+
190
+ This option is useful for debugging PVM-specific issues or running faster tests
191
+ by testing only one implementation at a time.
192
+
166
193
  ### Running JSON RPC E2E tests
167
194
 
168
195
  To run JSON RPC E2E test-vectors [test-vectors](https://github.com/fluffylabs/test-vectors)