feat: merkle tree implementation for block transaction commitments #18
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,29 @@ | ||||||||||||||||||||||||||||
| name: CI | ||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||
| on: | ||||||||||||||||||||||||||||
| push: | ||||||||||||||||||||||||||||
| branches: [main] | ||||||||||||||||||||||||||||
| pull_request: | ||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||
| jobs: | ||||||||||||||||||||||||||||
| test: | ||||||||||||||||||||||||||||
| runs-on: ubuntu-latest | ||||||||||||||||||||||||||||
| steps: | ||||||||||||||||||||||||||||
| - name: Checkout | ||||||||||||||||||||||||||||
| uses: actions/checkout@v4 | ||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||
| - name: Setup Python | ||||||||||||||||||||||||||||
| uses: actions/setup-python@v5 | ||||||||||||||||||||||||||||
| with: | ||||||||||||||||||||||||||||
| python-version: "3.11" | ||||||||||||||||||||||||||||
|
Contributor
There was a problem hiding this comment. 🧹 Nitpick | 🔵 Trivial Consider a Currently only Python 3.11 is tested. As the project matures, adding 3.12 (and potentially 3.10) to a version matrix will catch compatibility regressions early. 🔧 Example matrix expansion (future consideration) test:
runs-on: ubuntu-latest
+ strategy:
+ matrix:
+ python-version: ["3.10", "3.11", "3.12"]
steps:
...
- name: Setup Python
uses: actions/setup-python@v5
with:
- python-version: "3.11"
+ python-version: ${{ matrix.python-version }}
+ cache: "pip"📝 Committable suggestion
Suggested change
🤖 Prompt for AI Agents |
||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||
| - name: Install dependencies | ||||||||||||||||||||||||||||
| run: | | ||||||||||||||||||||||||||||
| python -m pip install --upgrade pip | ||||||||||||||||||||||||||||
| python -m pip install -e .[dev] | ||||||||||||||||||||||||||||
| - name: Lint | ||||||||||||||||||||||||||||
| run: make lint | ||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||
| - name: Run tests | ||||||||||||||||||||||||||||
| run: make test | ||||||||||||||||||||||||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| PYTHON ?= python3 | ||
|
|
||
| .PHONY: install dev-install test lint format start-node | ||
|
|
||
| install: | ||
| $(PYTHON) -m pip install . | ||
|
|
||
| dev-install: | ||
| $(PYTHON) -m pip install -e .[dev] | ||
|
|
||
| test: | ||
| $(PYTHON) -m pytest | ||
|
|
||
| lint: | ||
| $(PYTHON) -m ruff check src tests | ||
|
|
||
| format: | ||
| $(PYTHON) -m ruff format src tests | ||
|
|
||
| start-node: | ||
| PYTHONPATH=src $(PYTHON) -m minichain --host 127.0.0.1 --port 7000 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,236 +1,71 @@ | ||
| # MiniChain | ||
|
|
||
| MiniChain is a minimal, research-oriented blockchain implementation in Python. This repository currently contains the project scaffolding and development environment for the v0 core chain roadmap. | ||
|
|
||
| ## Current Status | ||
|
|
||
| Issue #1 (project scaffolding) is implemented with: | ||
|
|
||
| - Python package layout under `src/minichain` | ||
| - Placeholder component modules for: | ||
| - `crypto`, `transaction`, `block`, `state`, `mempool`, `consensus`, `network`, `storage`, `node` | ||
|
Comment on lines
+9
to
+11
Contributor
There was a problem hiding this comment. Update the module listing to include Line 11 lists placeholder component modules but omits 🤖 Prompt for AI Agents |
||
| - `pyproject.toml` project configuration | ||
| - `Makefile` for common developer tasks | ||
| - Basic CI workflow (`.github/workflows/ci.yml`) | ||
| - Baseline tests under `tests/` | ||
|
|
||
| ## Requirements | ||
|
|
||
| - Python 3.11+ | ||
|
|
||
| ## Setup | ||
|
|
||
| ```bash | ||
| python3 -m venv .venv | ||
| source .venv/bin/activate | ||
| python -m pip install --upgrade pip | ||
| make dev-install | ||
| ``` | ||
|
|
||
| If you also want networking dependencies: | ||
|
|
||
| ```bash | ||
| python -m pip install -e .[network] | ||
| ``` | ||
|
|
||
| ## Common Commands | ||
|
|
||
| ```bash | ||
| make test # run unit tests | ||
| make lint # run ruff checks | ||
| make format # format with ruff | ||
| make start-node # run scaffold node entrypoint | ||
| ``` | ||
|
|
||
| ## Run the Node Entrypoint | ||
|
|
||
| ```bash | ||
| PYTHONPATH=src python -m minichain --host 127.0.0.1 --port 7000 | ||
| ``` | ||
|
|
||
| ## Repository Layout | ||
|
|
||
| ```text | ||
| .github/workflows/ci.yml | ||
| src/minichain/ | ||
| __init__.py | ||
| __main__.py | ||
| crypto.py | ||
| transaction.py | ||
| block.py | ||
| state.py | ||
| mempool.py | ||
| consensus.py | ||
| network.py | ||
| storage.py | ||
| node.py | ||
| tests/ | ||
| test_scaffold.py | ||
| issues.md | ||
| architectureProposal.md | ||
| ``` | ||
|
Comment on lines
+51
to
+71
Contributor
There was a problem hiding this comment. Repository layout is stale — missing modules and test files added in this PR. The layout section omits several files introduced in this PR:
📝 Suggested updated layout ```text
.github/workflows/ci.yml
+Makefile
+pyproject.toml
src/minichain/
__init__.py
__main__.py
crypto.py
transaction.py
block.py
state.py
mempool.py
consensus.py
network.py
storage.py
node.py
+ serialization.py
+ merkle.py
tests/
test_scaffold.py
+ test_crypto.py
+ test_merkle.py
+ test_serialization.py
+ test_transaction.py
issues.md
architectureProposal.md
```🤖 Prompt for AI Agents |
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧹 Nitpick | 🔵 Trivial
Add pip dependency caching to speed up CI runs.
actions/setup-python@v5natively supports pip caching via thecachekey. Without it, every CI run re-downloads all dependencies from scratch.⚡ Proposed improvement
- name: Setup Python uses: actions/setup-python@v5 with: python-version: "3.11" + cache: "pip"📝 Committable suggestion
🤖 Prompt for AI Agents