@typeberry/jam 0.0.1-ffdd6b4 → 0.0.4-9a78ba2

package/3d2227eb3bf29d80c75a.js

@@ -0,0 +1,3 @@
+export { default as quiche } from './quiche.js';
+export * from './types.js';
+//# sourceMappingURL=index.js.map

package/6b655f8772c01b768329.js

@@ -0,0 +1 @@
+module.exports = eval("require")("bandersnatch_bg.wasm");

package/LICENSE

@@ -0,0 +1,5 @@
+Copyright (c) 2024 Fluffy Labs
+
+This Source Code Form is subject to the terms of the Mozilla Public
+License, v. 2.0. If a copy of the MPL was not distributed with this
+file, You can obtain one at http://mozilla.org/MPL/2.0/.

package/README.md

@@ -0,0 +1,202 @@
+# typeberry 🫐
+
+[![JAM Conformance 0.7.0](https://github.com/FluffyLabs/typeberry/actions/workflows/vectors-jam-conformance-070.yml/badge.svg?branch=main)](https://github.com/FluffyLabs/typeberry/actions/workflows/vectors-jam-conformance-070.yml) [![W3F vectors](https://github.com/FluffyLabs/typeberry/actions/workflows/vectors-w3f.yml/badge.svg?branch=main)](https://github.com/FluffyLabs/typeberry/actions/workflows/vectors-w3f.yml) [![Publish commits](https://github.com/FluffyLabs/typeberry/actions/workflows/blockchain-git-log.yml/badge.svg?branch=main)](https://github.com/FluffyLabs/typeberry/actions/workflows/blockchain-git-log.yml) [![License: MPL 2.0](https://img.shields.io/badge/License-MPL%202.0-brightgreen.svg)](https://opensource.org/licenses/MPL-2.0)
+
+Typeberry is a TypeScript implementation of [JAM protocol](https://graypaper.com/) by Fluffy Labs.
+
+**NOTE: Since we are taking part in the JAM Prize, we do not accept any external
+PRs unless the contributor waives any claims to the prize and copy rights for
+the submitted code. By creating the PR you accept this requirement.**
+
+## Implementation status
+
+Gray Paper compliance can be controlled via `GP_VERSION` environment variable.
+
+- [x] 0.6.7
+- [x] 0.7.0
+- [ ] 0.7.1 (partial)
+
+JAM Prize requirements
+
+- [x] Milestone 1
+    - [x] Block import
+    - [x] W3F test vectors
+    - [x] JAM Conformance Fuzzer
+    - [ ] Performance optimisations
+- [ ] Milestone 2
+    - [x] Networking (partial)
+    - [ ] Fast PVM
+- [ ] Milestone 3
+    - [ ] PVM Recompiler
+- [ ] Milestone 4
+- [ ] Milestone 5
+
+## Requirements
+
+```bash
+$ node --version
+v 22.9.0
+```
+
+We recommend [NVM](https://github.com/nvm-sh/nvm) to install and manage different
+`node` versions.
+
+### Installing dependencies
+
+```bash
+$ npm ci
+```
+
+### Running typeberry
+
+```bash
+$ npm start
+```
+
+### Running fuzz-target
+
+```bash
+$ npm start -- fuzz-target
+```
+
+### Running with Docker
+
+Build and run typeberry using Docker:
+
+```bash
+# Build the Docker image
+$ docker build -t typeberry .
+
+# Run with default settings
+$ docker run typeberry
+
+# Run with custom arguments
+$ docker run typeberry --config /app/configs/typeberry-dev.json --node-name my-node
+
+# Run with environment variables (e.g., for logging)
+$ docker run -e JAM_LOG=trace GP_VERSION=0.7.0 typeberry
+
+# Run with volume mounts for persistent data
+$ docker run -v $(pwd)/database:/app/database typeberry
+```
+
+The Docker container uses a minimal Alpine Linux image and forwards all arguments to `npm start`.
+
+### Running the JSON RPC
+
+JSON-RPC does not require `typeberry` to be running, so we just need to point the binary to the correct database.
+
+Note the DB needs to be already initialized.
+
+```bash
+$ npm start -w @typeberry/rpc 
+```
+
+### Additional tooling
+
+- [@typeberry/convert](bin/convert/README.md) - convert common JAM formats
+- [JAM search](https://github.com/fluffylabs/jam-search) - search across all public JAM-related channels
+- [State Viewer](https://github.com/fluffylabs/state-viewer) - load & inspect state of test vectors
+- [PVM Debugger](https://github.com/fluffylabs/pvm-debugger) - load & inspect a PVM program
+- [Gray Paper Reader](https://github.com/fluffylabs/graypaper-reader) - view the Gray Paper
+- [Ananas](https://github.com/tomusdrw/anan-as) - AssemblyScript PVM interpreter
+
+### Formatting & linting
+
+```bash
+$ npm run qa
+```
+
+Formatting & linting is done by [biomejs](https://biomejs.dev/)). You can run
+separate tools using commands below.
+Note that all safe fixes will be applied automatically.
+
+```bash
+$ npm run format # format the code
+$ npm run lint   # lint the code & organise imports
+```
+
+A shorthand to run all the checks and apply safe fixes all at once is:
+```bash
+$ npm run qa-fix
+```
+
+### Running unit tests
+
+```bash
+$ npm run test
+```
+
+Running tests from a single package:
+```bash
+$ npm run test -w @typeberry/trie
+```
+
+### Running benchmarks
+This command will run all benchmarks from `./benchmarks/` folder
+
+```bash
+$ npm start -w @typeberry/benchmark
+```
+
+Since each benchmark file is also runnable, it's easy to run just one benchmark, e.g:
+```bash
+$ npm exec tsx ./benchmarks/math/mul_overflow.ts
+```
+
+### Running JSON test vectors
+
+To run JSON test cases coming from the official
+[JAM test vectors repository](https://github.com/w3f/jamtestvectors/) you need
+to first check out the repository with test cases and then use `test-runner`
+to execute them.
+
+```bash
+$ git clone https://github.com/w3f/jamtestvectors.git
+$ npm run w3f -w @typeberry/test-runner  --  jamtestvectors/**/*.json ../jamtestvectors/erasure_coding/vectors/*
+```
+
+Since there are multiple sources of test vectors (and their versions may differ),
+all relevant ones can be easily checked out from [our test vectors repository](https://github.com/FluffyLabs/test-vectors).
+
+Obviously it's also possible to run just single test case or part of the test
+cases by altering the glob pattern in the path.
+
+### Running JSON RPC E2E tests
+
+To run JSON RPC E2E test-vectors [test-vectors](https://github.com/fluffylabs/test-vectors) 
+repository needs to be checked out with ref matching our tests. Then to run tests:
+
+```bash
+$ npm run test:e2e -w @typeberry/rpc
+```
+
+### Adding a new component / package
+
+```bash
+$ npm init -w ./packages/core/mycomponent
+$ npm init -w ./packages/jam/mycomponent
+```
+
+This command will automatically update the `workspaces` field in top-level `package.json`.
+
+## Codestyle
+
+A brief, but evolving description of our codestyle and guideliness is availabe
+in [CODESTYLE](./CODESTYLE.md).
+
+## Add Typeberry's remote notes to Gray Paper Reader
+
+1. Open **Gray Paper Reader** and go to **Notes** > **Settings** (⚙️).<br/>
+![gpr-source-notes-1](https://github.com/user-attachments/assets/945152f4-a8f1-4167-af86-9c1e41102615)
+2. Click **"+ New Source"**.
+![gpr-source-notes-2](https://github.com/user-attachments/assets/7356dbe3-fa05-4fcb-99c3-28cb4b9553df)
+3. Set **Source Name** to **Typeberry**.
+4. Paste the following in **Source URL:**
+```
+https://fluffylabs.dev/typeberry/links.json
+```
+5. Select **All Versions**.
+![gpr-source-notes-3](https://github.com/user-attachments/assets/877a6494-75fd-4c0c-b531-55af6f676c89)
+6. Click **OK**.
+7. Ensure the ✅ next to **Typeberry** is enabled.

package/bandersnatch/6b655f8772c01b768329.js

@@ -0,0 +1 @@
+module.exports = eval("require")("bandersnatch_bg.wasm");

package/bandersnatch/ccf8ada94096a8f232f5.js

@@ -0,0 +1 @@
+module.exports = eval("require")("reed_solomon_wasm_bg.wasm");

package/bandersnatch/e2fdc1b646378dd96eda.js

@@ -0,0 +1 @@
+module.exports = eval("require")("ed25519_wasm_bg.wasm");