Skip to content

feat: issue #8 project scaffolding #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
arunabha003 wants to merge 1 commit into from
Closed

feat: issue #8 project scaffolding #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions .github/workflows/ci.yml
View file
Open in desktop
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"

- name: Install dependencies
run: |
python -m pip install --upgrade pip
python -m pip install -e .[dev]
Comment on lines +15 to +23
Copy link
Contributor

@coderabbitai coderabbitai bot Feb 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick | 🔵 Trivial

Consider adding pip caching to speed up CI.

Adding a cache: 'pip' option to the setup-python action avoids re-downloading packages on every run.

♻️ Suggested change 
       - name: Setup Python
         uses: actions/setup-python@v5
         with:
           python-version: "3.11"
+          cache: "pip"
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: "3.11"
- name: Install dependencies
run: |
python -m pip install --upgrade pip
python -m pip install -e .[dev]
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: "3.11"
cache: "pip"
- name: Install dependencies
run: |
python -m pip install --upgrade pip
python -m pip install -e .[dev]
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In @.github/workflows/ci.yml around lines 15 - 23, The CI step using the
setup-python action (uses: actions/setup-python@v5) should enable pip caching to
avoid re-downloading packages each run; update the "Setup Python" step to
include the cache: "pip" input on that action so the runner caches installed pip
packages for subsequent jobs and speeds up the "Install dependencies" step where
pip installs project dev dependencies.

- name: Lint
run: make lint

- name: Run tests
run: make test
14 changes: 14 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -258,6 +258,17 @@ pythontex-files-*/
# easy-todo
*.lod

# MiniChain local planning docs (do not commit)
issues.md
architectureProposal.md

# Python caches and virtualenvs
__pycache__/
*.py[cod]
.pytest_cache/
.ruff_cache/
.venv/

Comment on lines +265 to +271
Copy link
Contributor

@coderabbitai coderabbitai bot Feb 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Check for LaTeX source files in the repository
fd -e tex -e bib --max-depth 3

Repository: StabilityNexus/MiniChain

Length of output: 50

🏁 Script executed:

# Check the .gitignore file size and structure
wc -l .gitignore

# Show lines around 265-271 to verify the Python patterns
sed -n '260,280p' .gitignore | cat -n

# Show the beginning of the file to check what patterns are there
head -50 .gitignore | cat -n

Repository: StabilityNexus/MiniChain

Length of output: 1493

🏁 Script executed:

# Show lines 265-271 specifically
sed -n '265,271p' .gitignore | cat -n

Repository: StabilityNexus/MiniChain

Length of output: 207

🏁 Script executed:

# Check project structure
ls -la | head -20

# Check for documentation about LaTeX/documentation building
find . -maxdepth 2 -type f \( -name "README*" -o -name "Makefile" -o -name "setup.py" -o -name "pyproject.toml" \) | head -10

Repository: StabilityNexus/MiniChain

Length of output: 1144

🏁 Script executed:

# Check if Python patterns appear multiple times in the file
grep -n "# Python caches and virtualenvs" .gitignore

# Show the entire .gitignore structure to understand the organization
cat -n .gitignore

Repository: StabilityNexus/MiniChain

Length of output: 6028

Remove unnecessary LaTeX patterns from .gitignore.

The Python patterns at lines 265-271 are correct and appropriate. However, the .gitignore file contains 260+ lines of LaTeX-specific patterns (lines 1-260, 272-337), yet no .tex or .bib files exist anywhere in this Python project. This .gitignore appears to be an unmodified LaTeX template.

Remove the entire LaTeX section to reduce file bloat and maintain clarity. Keep only:

  • Lines 1-5: MiniChain local planning docs
  • Lines 265-271: Python caches and virtualenvs
  • Line 340: docs/

This will reduce .gitignore from 340 lines to ~13 lines while removing dead code that serves no purpose for this project.

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In @.gitignore around lines 265 - 271, Remove the unrelated LaTeX block from
.gitignore: delete all LaTeX-specific patterns (e.g., entries matching *.tex,
*.bib, *.aux, *.log, *.toc and other TeX/LaTeX temporary files) that were pulled
in from a template, and keep only the project-relevant entries such as the
MiniChain local planning docs header, the Python cache/virtualenv lines
(__pycache__/, *.py[cod], .pytest_cache/, .ruff_cache/, .venv/) and the docs/
entry; update the file so it no longer contains the large LaTeX section and only
retains those minimal, project-specific ignore lines.

# xcolor
*.xcp

Expand Down Expand Up @@ -324,3 +335,6 @@ TSWLatexianTemp*
# option is specified. Footnotes are the stored in a file with suffix Notes.bib.
# Uncomment the next line to have this generated file ignored.
#*Notes.bib


docs/
21 changes: 21 additions & 0 deletions Makefile
View file
Open in desktop
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
Comment on lines +1 to +21
Copy link
Contributor

@coderabbitai coderabbitai bot Feb 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick | 🔵 Trivial

Add a clean target to remove build artifacts.

As the project grows, __pycache__, .egg-info, .pytest_cache, and other artifacts will accumulate. A clean target is a standard convenience for development workflows.

♻️ Suggested addition 
-.PHONY: install dev-install test lint format start-node
+.PHONY: install dev-install test lint format start-node clean

+clean:
+	find . -type d -name __pycache__ -exec rm -rf {} +
+	rm -rf .pytest_cache *.egg-info src/*.egg-info dist build
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
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
PYTHON ?= python3
.PHONY: install dev-install test lint format start-node clean
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
clean:
find . -type d -name __pycache__ -exec rm -rf {} +
rm -rf .pytest_cache *.egg-info src/*.egg-info dist build
🧰 Tools
🪛 checkmake (0.2.2)

[warning] 3-3: Missing required phony target "all"

(minphony)

[warning] 3-3: Missing required phony target "clean"

(minphony)

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@Makefile` around lines 1 - 21, Add a new Makefile target named clean that
deletes common Python/Cython build artifacts (e.g., __pycache__, *.py[cod],
build/, dist/, *.egg-info, .pytest_cache, .mypy_cache) using rm -rf patterns,
and add clean to the .PHONY list so it's treated as a phony target; update the
Makefile by adding the clean target (and its patterns) beneath the existing
targets and appending clean to the .PHONY declaration that currently lists
install dev-install test lint format start-node.

265 changes: 50 additions & 215 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,236 +1,71 @@
<!-- Don't delete it -->
<div name="readme-top"></div>
# MiniChain

<!-- Organization Logo -->
<div align="center" style="display: flex; align-items: center; justify-content: center; gap: 16px;">
<img alt="Stability Nexus" src="public/stability.svg" width="175">
<img src="public/todo-project-logo.svg" width="175" />
</div>
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.

&nbsp;
## Current Status

<!-- Organization Name -->
<div align="center">
Issue #1 (project scaffolding) is implemented with:
Copy link
Contributor

@coderabbitai coderabbitai bot Feb 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Incorrect issue reference.

This says "Issue #1" but the PR is for Issue #8 (project scaffolding).

-Issue `#1` (project scaffolding) is implemented with:
+Issue `#8` (project scaffolding) is implemented with:
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
Issue #1 (project scaffolding) is implemented with:
Issue `#8` (project scaffolding) is implemented with:
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@README.md` at line 7, Update the README line that currently reads "Issue `#1`
(project scaffolding) is implemented with:" to reference the correct issue
number for this PR by replacing "Issue `#1`" with "Issue `#8`" so the documentation
matches the actual ticket; locate the exact text in README.md and modify the
string literal "Issue `#1`" to "Issue `#8`".


[![Static Badge](https://img.shields.io/badge/Stability_Nexus-/TODO-228B22?style=for-the-badge&labelColor=FFC517)](https://TODO.stability.nexus/)
- Python package layout under `src/minichain`
- Placeholder component modules for:
- `crypto`, `transaction`, `block`, `state`, `mempool`, `consensus`, `network`, `storage`, `node`
- `pyproject.toml` project configuration
- `Makefile` for common developer tasks
- Basic CI workflow (`.github/workflows/ci.yml`)
- Baseline tests under `tests/`

<!-- Correct deployed url to be added -->
## Requirements

</div>
- Python 3.11+

<!-- Organization/Project Social Handles -->
<p align="center">
<!-- Telegram -->
<a href="https://t.me/StabilityNexus">
<img src="https://img.shields.io/badge/Telegram-black?style=flat&logo=telegram&logoColor=white&logoSize=auto&color=24A1DE" alt="Telegram Badge"/></a>
&nbsp;&nbsp;
<!-- X (formerly Twitter) -->
<a href="https://x.com/StabilityNexus">
<img src="https://img.shields.io/twitter/follow/StabilityNexus" alt="X (formerly Twitter) Badge"/></a>
&nbsp;&nbsp;
<!-- Discord -->
<a href="https://discord.gg/YzDKeEfWtS">
<img src="https://img.shields.io/discord/995968619034984528?style=flat&logo=discord&logoColor=white&logoSize=auto&label=Discord&labelColor=5865F2&color=57F287" alt="Discord Badge"/></a>
&nbsp;&nbsp;
<!-- Medium -->
<a href="https://news.stability.nexus/">
<img src="https://img.shields.io/badge/Medium-black?style=flat&logo=medium&logoColor=black&logoSize=auto&color=white" alt="Medium Badge"></a>
&nbsp;&nbsp;
<!-- LinkedIn -->
<a href="https://linkedin.com/company/stability-nexus">
<img src="https://img.shields.io/badge/LinkedIn-black?style=flat&logo=LinkedIn&logoColor=white&logoSize=auto&color=0A66C2" alt="LinkedIn Badge"></a>
&nbsp;&nbsp;
<!-- Youtube -->
<a href="https://www.youtube.com/@StabilityNexus">
<img src="https://img.shields.io/youtube/channel/subscribers/UCZOG4YhFQdlGaLugr_e5BKw?style=flat&logo=youtube&logoColor=white&logoSize=auto&labelColor=FF0000&color=FF0000" alt="Youtube Badge"></a>
</p>

---

<div align="center">
<h1>MiniChain</h1>
</div>

MiniChain is a minimal fully functional blockchain implemented in Python.

### Background and Motivation

* Most well-known blockchains are now several years old and have accumulated a lot of technical debt.
Simply forking their codebases is not an optimal option for starting a new chain.

* MiniChain will be focused on research. Its primary purpose is not to be yet another blockchain
trying to be the one blockchain to kill them all, but rather to serve as a clean codebase that can be a benchmark for research of
variations of the technology. (We hope that MiniChain will be as valuable for blockchain research as, for instance,
MiniSat was valuable for satisfiability and automated reasoning research. MiniSat had less than 600 lines of C++ code.)

* MiniChain will be focused on education. By having a clean and small codebase, devs will be able to understand
blockchains by looking at the codebase.

* The blockchain space is again going through a phase where many new blockchains are being launched.
Back in 2017 and 2018, such an expansion period led to many general frameworks for blockchains,
such as Scorex and various Hyperledger frameworks. But most of these frameworks suffered from speculative generality and
were bloated. They focused on extensibility and configurability. MiniChain has a different philosophy:
focus on minimality and, therefore, ease of modification.

* Recent advances in networking and crypto libraries for Python make it possible to develop MiniChain in Python.
Given that Python is one of the easiest languages to learn and results in usually boilerplate-minimized and easy to read code,
implementing MiniChain in Python aligns with MiniChain's educational goal.


### Overview of Tasks

* Develop a fully functional minimal blockchain in Python, with all the expected components:
peer-to-peer networking, consensus, mempool, ledger, ...

* Bonus task: add smart contracts to the blockchain.

Candidates are expected to refine these tasks in their GSoC proposals.
It is encouraged that you develop an initial prototype during the application phase.

### Requirements

* Use [PyNaCl](https://pynacl.readthedocs.io/en/latest/) library for hashing, signing transactions and verifying signatures.
* Use [Py-libp2p](https://github.com/libp2p/py-libp2p/tree/main) for p2p networking.
* Implement Proof-of-Work as the consensus protocol.
* Use accounts (instead of UTxO) as the accounting model for the ledger.
* Use as few lines of code as possible without compromising readability and understandability.
* For the bonus task, make Python itself be the language used for smart contracts, but watch out for security concerns related to executing arbitrary code from untrusted sources.

### Resources

* Read this book: https://www.marabu.dev/blockchain-foundations.pdf


---

## Project Maturity

TODO: In the checklist below, mark the items that have been completed and delete items that are not applicable to the current project:

* [ ] The project has a logo.
* [ ] The project has a favicon.
* [ ] The protocol:
- [ ] has been described and formally specified in a paper.
- [ ] has had its main properties mathematically proven.
- [ ] has been formally verified.
* [ ] The smart contracts:
- [ ] were thoroughly reviewed by at least two knights of The Stable Order.
- [ ] were deployed to:
- [ ] Ergo
- [ ] Cardano
- [ ] EVM Chains:
- [ ] Ethereum Classic
- [ ] Ethereum
- [ ] Polygon
- [ ] BSC
- [ ] Base
* [ ] The mobile app:
- [ ] has an _About_ page containing the Stability Nexus's logo and pointing to the social media accounts of the Stability Nexus.
- [ ] is available for download as a release in this repo.
- [ ] is available in the relevant app stores.
* [ ] The web frontend:
- [ ] has proper title and metadata.
- [ ] has proper open graph metadata, to ensure that it is shown well when shared in social media (Discord, Telegram, Twitter, LinkedIn).
- [ ] has a footer, containing the Stability Nexus's logo and pointing to the social media accounts of the Stability Nexus.
- [ ] is fully static and client-side.
- [ ] is deployed to Github Pages via a Github Workflow.
- [ ] is accessible through the https://TODO:PROJECT-NAME.stability.nexus domain.
* [ ] the project is listed in [https://stability.nexus/protocols](https://stability.nexus/protocols).

---

## Tech Stack

TODO:

### Frontend

TODO:

- Next.js 14+ (React)
- TypeScript
- TailwindCSS
- shadcn/ui

### Blockchain

TODO:

- Wagmi
- Solidity Smart Contracts
- Ethers.js

---

## Getting Started

### Prerequisites

TODO

- Node.js 18+
- npm/yarn/pnpm
- MetaMask or any other web3 wallet browser extension

### Installation

TODO

#### 1. Clone the Repository
## Setup

```bash
git clone https://github.com/StabilityNexus/TODO.git
cd TODO
python3 -m venv .venv
source .venv/bin/activate
python -m pip install --upgrade pip
make dev-install
```

#### 2. Install Dependencies

Using your preferred package manager:
If you also want networking dependencies:

```bash
npm install
# or
yarn install
# or
pnpm install
python -m pip install -e .[network]
```

#### 3. Run the Development Server

Start the app locally:
## Common Commands

```bash
npm run dev
# or
yarn dev
# or
pnpm dev
make test # run unit tests
make lint # run ruff checks
make format # format with ruff
make start-node # run scaffold node entrypoint
```

#### 4. Open your Browser

Navigate to [http://localhost:3000](http://localhost:3000) to see the application.

---

## Contributing

We welcome contributions of all kinds! To contribute:

1. Fork the repository and create your feature branch (`git checkout -b feature/AmazingFeature`).
2. Commit your changes (`git commit -m 'Add some AmazingFeature'`).
3. Run the development workflow commands to ensure code quality:
- `npm run format:write`
- `npm run lint:fix`
- `npm run typecheck`
4. Push your branch (`git push origin feature/AmazingFeature`).
5. Open a Pull Request for review.
## Run the Node Entrypoint

If you encounter bugs, need help, or have feature requests:

- Please open an issue in this repository providing detailed information.
- Describe the problem clearly and include any relevant logs or screenshots.

We appreciate your feedback and contributions!
```bash
PYTHONPATH=src python -m minichain --host 127.0.0.1 --port 7000
```

© 2025 The Stable Order.
## 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
```
Loading