binarytree: create binarytree package

.github/ISSUE_TEMPLATE/package--ethereumjs-binarytree.md

@@ -0,0 +1,7 @@
+---
+name: 'Package: @ethereumjs/binarytree'
+about: Create issue for @ethereumjs/binarytree package
+title: ''
+labels: 'package: binarytree'
+assignees: ''
+---

.github/workflows/binarytree-build.yml

@@ -0,0 +1,56 @@
+name: binarytree
+on:
+  workflow_call:
+    inputs:
+      dep-cache-key:
+        required: false
+        type: string
+  workflow_dispatch:
+    inputs:
+      dep-cache-key:
+        required: false
+        default: 'none'
+      submodule-cache-key:
+        required: false
+        default: 'none'
+
+env:
+  cwd: ${{github.workspace}}/packages/binarytree
+
+defaults:
+  run:
+    working-directory: packages/binarytree
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}-binarytree
+  cancel-in-progress: true
+
+jobs:
+  test-binarytree:
+    runs-on: ubuntu-latest
+
+    steps:
+      # We clone the repo and submodules if triggered from work-flow dispatch
+      - if: inputs.submodule-cache-key == 'none'
+        uses: actions/checkout@v4
+
+      # We restore the code/deps from cache if triggered from workflow_call (i.e. have valid cache key)
+      - if: inputs.dep-cache-key != 'none'
+        uses: actions/cache/restore@v4
+        id: dep-cache
+        with:
+          path: ${{github.workspace}}
+          key: ${{ inputs.dep-cache-key }}
+
+      - name: Use Node.js 20
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: 'npm'
+
+      - name: Install Dependencies (if not restored from cache)
+        if: steps.dep-cache.outputs.cache-hit != 'true'
+        run: npm ci
+        working-directory: ${{ github.workspace }}
+
+      - run: npm run test

README.md

@@ -22,6 +22,7 @@ Below you can find a list of the packages included in this repository.
 
 | package                                          | npm                                                             | issues                                                                        | tests                                                                      | coverage                                                                    |
 | ------------------------------------------------ | --------------------------------------------------------------- | ----------------------------------------------------------------------------- | -------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
+| [@ethereumjs/binarytree][binarytree-package]             | [![NPM Package][binarytree-npm-badge]][binarytree-npm-link]             | [![VM Issues][binarytree-issues-badge]][binarytree-issues-link]                       | [![Actions Status][binarytree-actions-badge]][binarytree-actions-link]             | [![Code Coverage][binarytree-coverage-badge]][binarytree-coverage-link]     
 | [@ethereumjs/block][block-package]               | [![NPM Package][block-npm-badge]][block-npm-link]               | [![Block Issues][block-issues-badge]][block-issues-link]                      | [![Actions Status][block-actions-badge]][block-actions-link]               | [![Code Coverage][block-coverage-badge]][block-coverage-link]               |
 | [@ethereumjs/blockchain][blockchain-package]     | [![NPM Package][blockchain-npm-badge]][blockchain-npm-link]     | [![Blockchain Issues][blockchain-issues-badge]][blockchain-issues-link]       | [![Actions Status][blockchain-actions-badge]][blockchain-actions-link]     | [![Code Coverage][blockchain-coverage-badge]][blockchain-coverage-link]     |
 | [@ethereumjs/client][client-package]             | [![NPM Package][client-npm-badge]][client-npm-link]             | [![Client Issues][client-issues-badge]][client-issues-link]                   | [![Actions Status][client-actions-badge]][client-actions-link]             | [![Code Coverage][client-coverage-badge]][client-coverage-link]             |

config/cspell-md.json

@@ -4,6 +4,7 @@
     "/0x[0-9A-Fa-f]+/"
   ],
   "words": [
+    "binarytree",
     "trienode",
     "t8ntool",
     "calldatasize",
@@ -330,4 +331,4 @@
     "ethportal",
     "bytevector"
   ]
-}
+}

config/cspell-ts.json

@@ -24,6 +24,8 @@
     }
   ],
   "words": [
+    "binarytree",
+    "merkelize",
     "kaust",
     "EEST",
     "paulmillr",

packages/binarytree/.c8rc.json

@@ -0,0 +1,4 @@
+{
+  "extends": "../../config/.c8rc.json",
+  "include": ["src/**/*.ts"]
+}

packages/binarytree/.eslintrc.cjs

@@ -0,0 +1,14 @@
+module.exports = {
+  extends: '../../config/eslint.cjs',
+  parserOptions: {
+    project: ['./tsconfig.lint.json'],
+  },
+  overrides: [
+    {
+      files: ['benchmarks/*.ts', 'examples/*.ts'],
+      rules: {
+        'no-console': 'off',
+      },
+    },
+  ],
+}

packages/binarytree/.gitignore

@@ -0,0 +1 @@
+

packages/binarytree/.npmignore

@@ -0,0 +1,2 @@
+test/
+src/

packages/binarytree/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+(modification: no type change headlines) and this project adheres to
+[Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## 0.0.1 - 2025-01-30
+
+- Initial development release

packages/binarytree/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 EthereumJS 
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

packages/binarytree/README.md

@@ -0,0 +1,40 @@
+# @ethereumjs/binarytree
+
+[![NPM Package][binarytree-npm-badge]][binarytree-npm-link]
+[![GitHub Issues][binarytree-issues-badge]][binarytree-issues-link]
+[![Actions Status][binarytree-actions-badge]][binarytree-actions-link]
+[![Code Coverage][binarytree-coverage-badge]][binarytree-coverage-link]
+[![Discord][discord-badge]][discord-link]
+
+| Implementation of Binary Trees as specified in [EIP-7864](https://eips.ethereum.org/EIPS/eip-7864) |
+| --------------------------------------------------------------------------------------------------------------------------------------------------- |
+
+> Binary Trees are a novel cryptographic data structure proposed for use in Ethereum to optimize state storage and proof verification. Unlike Merkle Patricia Tries, Binary Trees use a strict binary branching structure, allowing smaller proof sizes. By reducing storage overhead and improving proof efficiency, Binary Trees aim to enhance Ethereum’s scalability while maintaining robust security guarantees.
+
+This package is currently in early alpha and is a work in progress. It is not intended for use in production environments, but rather for research and development purposes. Any help in improving the package is very much welcome.
+
+## Installation
+
+To obtain the latest version, simply install the project using `npm`:
+
+```shell
+npm install @ethereumjs/binarytree
+```
+## EthereumJS
+
+See our organizational [documentation](https://ethereumjs.readthedocs.io) for an introduction to `EthereumJS` as well as information on current standards and best practices. If you want to join for work or carry out improvements on the libraries, please review our [contribution guidelines](https://ethereumjs.readthedocs.io/en/latest/contributing.html) first.
+
+## License
+
+[MIT](https://opensource.org/licenses/MIT)
+
+[discord-badge]: https://img.shields.io/static/v1?logo=discord&label=discord&message=Join&color=blue
+[discord-link]: https://discord.gg/TNwARpR
+[binarytree-npm-badge]: https://img.shields.io/npm/v/@ethereumjs/binarytree.svg
+[binarytree-npm-link]: https://www.npmjs.com/package/@ethereumjs/binarytree
+[binarytree-issues-badge]: https://img.shields.io/github/issues/ethereumjs/ethereumjs-monorepo/package:%20binarytree?label=issues
+[binarytree-issues-link]: https://github.com/ethereumjs/ethereumjs-monorepo/issues?q=is%3Aopen+is%3Aissue+label%3A"package%3A+binarytree"
+[binarytree-actions-badge]: https://github.com/ethereumjs/ethereumjs-monorepo/workflows/binarytree/badge.svg
+[binarytree-actions-link]: https://github.com/ethereumjs/ethereumjs-monorepo/actions?query=workflow%3A%22binarytree%22
+[binarytree-coverage-badge]: https://codecov.io/gh/ethereumjs/ethereumjs-monorepo/branch/master/graph/badge.svg?flag=binarytree
+[binarytree-coverage-link]: https://codecov.io/gh/ethereumjs/ethereumjs-monorepo/tree/master/packages/binarytree

packages/binarytree/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@ethereumjs/binarytree",
+  "version": "0.0.1",
+  "description": "Implementation of binary trees as used in Ethereum.",
+  "keywords": ["binary", "tree", "trie", "ethereum"],
+  "homepage": "https://github.com/ethereumjs/ethereumjs-monorepo/tree/master/packages/binarytree#readme",
+  "bugs": {
+    "url": "https://github.com/ethereumjs/ethereumjs-monorepo/issues?q=is%3Aissue+label%3A%22package%3A+binarytree%22"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ethereumjs/ethereumjs-monorepo.git"
+  },
+  "license": "MIT",
+  "author": "EthereumJS Team",
+  "contributors": [
+    {
+      "name": "Gabriel Rocheleau",
+      "url": "https://github.com/gabrocheleau"
+    }
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "exports": {
+    ".": {
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js"
+    }
+  },
+  "files": ["dist", "src"],
+  "scripts": {
+    "biome": "npx @biomejs/biome check",
+    "biome:fix": "npx @biomejs/biome check --write",
+    "build": "../../config/cli/ts-build.sh",
+    "clean": "../../config/cli/clean-package.sh",
+    "coverage": "DEBUG=ethjs npx vitest run -c ../../config/vitest.config.coverage.mts",
+    "docs:build": "typedoc --options typedoc.cjs",
+    "lint": "npm run biome && eslint --config .eslintrc.cjs . --ext .js,.ts",
+    "lint:fix": "npm run biome:fix && eslint --fix --config .eslintrc.cjs . --ext .js,.ts",
+    "prepublishOnly": "../../config/cli/prepublish.sh",
+    "test": "npm run test:node",
+    "test:node": "npx vitest run",
+    "test:browser": "npx vitest run --config=../../config/vitest.config.browser.mts",
+    "tsc": "../../config/cli/ts-compile.sh"
+  },
+  "dependencies": {
+    "@ethereumjs/rlp": "^6.0.0-alpha.1",
+    "@ethereumjs/util": "^10.0.0-alpha.1",
+    "@noble/hashes": "^1.7.1",
+    "debug": "^4.3.4",
+    "ethereum-cryptography": "^3.1.0",
+    "lru-cache": "10.1.0"
+  },
+  "engines": {
+    "node": ">=18"
+  }
+}