Skip to content
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.

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

Refactor node from 4 to 1 binary and add feature flags #292

Closed
wants to merge 15 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
38 changes: 38 additions & 0 deletions .dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Include any files or directories that you don't want to be copied to your
# container here (e.g., local build artifacts, temporary files, etc.).
#
# For more help, visit the .dockerignore file reference guide at
# https://docs.docker.com/go/build-context-dockerignore/

**/.DS_Store
**/.classpath
**/.dockerignore
**/.env
**/.git
**/.gitignore
**/.project
**/.settings
**/.toolstarget
**/.vs
**/.vscode
**/*.*proj.user
**/*.dbmdl
**/*.jfm
**/charts
**/docker-compose*
**/compose*
**/Dockerfile*
**/node_modules
**/npm-debug.log
**/secrets.dev.yaml
**/values.dev.yaml
./bin
./target
/bin
/target
LICENSE
README.md
accounts
genesis.dat
miden-store.*
store.*
73 changes: 0 additions & 73 deletions .github/workflows/ci.yml

This file was deleted.

22 changes: 22 additions & 0 deletions .github/workflows/doc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Runs documentation related jobs.

name: doc

on:
push:
branches: [main, next]
pull_request:
types: [opened, reopened, synchronize]

jobs:
doc:
name: doc stable on ubuntu-latest
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Install Rust
uses: dtolnay/rust-toolchain@stable
- name: Install cargo make
run: cargo install cargo-make
- name: cargo make - doc
run: cargo make doc
51 changes: 51 additions & 0 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# Runs linting related jobs.

name: lint

on:
push:
branches: [main, next]
pull_request:
types: [opened, reopened, synchronize]

jobs:
version:
name: check rust version consistency
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
profile: minimal
override: true
- name: check rust versions
run: ./scripts/check-rust-version.sh

rustfmt:
name: rustfmt nightly on ubuntu-latest
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Install minimal Rust with rustfmt
uses: dtolnay/rust-toolchain@master
with:
toolchain: nightly
components: rustfmt
- name: Install cargo make
run: cargo install cargo-make
- name: cargo make - format-check
run: cargo make format-check

clippy:
name: clippy stable on ubuntu-latest
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Install minimal Rust with clippy
uses: dtolnay/rust-toolchain@master
with:
toolchain: stable
components: clippy
- name: Install cargo make
run: cargo install cargo-make
- name: cargo make - clippy
run: cargo make clippy
23 changes: 23 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Runs testing related jobs.

name: test

on:
push:
branches: [main, next]
pull_request:
types: [opened, reopened, synchronize]

jobs:
unit-and-integration:
name: test stable on ubuntu-latest
runs-on: ubuntu-latest
timeout-minutes: 30
steps:
- uses: actions/checkout@v4
- name: Install Rust
uses: dtolnay/rust-toolchain@stable
- name: Install cargo make
run: cargo install cargo-make
- name: cargo make - test
run: cargo make test
11 changes: 6 additions & 5 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,15 +1,12 @@
# Generated by Cargo

# will have compiled files and executables
debug/
target/

# Generated by protox `file_descriptor_set.bin`
*.bin

# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
# Cargo.lock

# These are backup files generated by rustfmt
**/*.rs.bk

Expand All @@ -20,10 +17,14 @@ target/
.vscode/

# Genesis files
/accounts
accounts/
genesis.dat

# Sqlite db files
*.sqlite3
*.sqlite3-shm
*.sqlite3-wal
database/

# Python venv files
venv/
11 changes: 9 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@

We want to make contributing to this project as easy and transparent as possible, whether it's:

- Reporting a [bug](https://github.com/0xPolygonMiden/miden-node/issues/new)
- Reporting a [bug](https://github.com/0xPolygonMiden/miden-node/issues/new?assignees=&labels=bug&projects=&template=1-bugreport.yml&title=%5BBug%5D%3A+)
- Taking part in [discussions](https://github.com/0xPolygonMiden/miden-node/discussions)
- Submitting a [fix](https://github.com/0xPolygonMiden/miden-node/pulls)
- Proposing new [features](https://github.com/0xPolygonMiden/miden-node/issues/new)
- Proposing new [features](https://github.com/0xPolygonMiden/miden-node/issues/new?assignees=&labels=enhancement&projects=&template=2-feature-request.yml&title=%5BFeature%5D%3A+)

 

Expand Down Expand Up @@ -80,6 +80,13 @@ For example, a new change to the `miden-node-store` crate might have the followi

You can find more information about the `cargo make` commands in the [Makefile](Makefile.toml)

### Testing
After writing code different types of tests (unit, integration, end-to-end) are required to make sure that the correct behavior has been achieved and that no bugs have been introduced. You can run tests using the following command:

```
cargo make test
```

### Versioning
We use [semver](https://semver.org/) naming convention.

Expand Down
Loading
Loading