feat: Kona Optimism Monorepo

.github/codecov.yml

@@ -22,10 +22,11 @@ ignore:
   - "**/test_utils*"
   - "**/test_util*"
   - "**/tests*"
-  - "crates/providers-alloy"
-  - "crates/mpt/src/noop.rs"
+  - "crates/providers/providers-alloy"
+  - "crates/providers/providers-local"
+  - "crates/proof/mpt/src/noop.rs"
   # Interop - not yet integrated
-  - "crates/proof-sdk/proof-interop"
+  - "crates/proof/proof-interop"
   - "bin/host/src/interop"
   - "bin/client/src/interop"
 

.github/workflows/deny.yaml

@@ -0,0 +1,17 @@
+name: Deny
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+  schedule: [cron: "00 00 * * *"]
+
+jobs:
+  cargo-deny:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
+      - uses: EmbarkStudios/cargo-deny-action@v2

.github/workflows/no_std.yml

@@ -0,0 +1,28 @@
+name: no_std checks
+
+on:
+  push:
+    branches: [main]
+  merge_group:
+  pull_request:
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  no-std:
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
+      - uses: dtolnay/rust-toolchain@stable
+        with:
+          target: riscv32imac-unknown-none-elf
+      - uses: taiki-e/install-action@cargo-hack
+      - uses: Swatinem/rust-cache@v2
+        with:
+          cache-on-failure: true
+      - name: check
+        run: ./scripts/check_no_std.sh

.github/workflows/sync.yaml

@@ -0,0 +1,43 @@
+name: Synchronize Git Submodules
+
+on:
+  push:
+    branches: [main]
+  schedule:
+    - cron:  '30 5 * * *'
+  workflow_dispatch:
+
+jobs:
+  submodule-sync:
+    name: Synchronize the git submodule
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
+          token: ${{ secrets.PAT_TOKEN }}
+      - uses: taiki-e/install-action@just
+      - uses: dtolnay/rust-toolchain@stable
+      - name: Update Submodule
+        run: just source && just bind
+      - name: Create Pull Request
+        id: cpr
+        uses: peter-evans/create-pull-request@v7
+        with:
+          token: ${{ secrets.PAT_TOKEN }}
+          commit-message: Update Submodules
+          signoff: false
+          branch: bot/update-submodules
+          base: main
+          delete-branch: true
+          title: '[BOT] Update Submodules'
+          body: |
+            ### Description
+
+            Automated PR to update git submodules.
+          labels: |
+            A-submodules
+            C-bot
+          assignees: refcell
+          draft: false

CONTRIBUTING.md

@@ -0,0 +1,37 @@
+# Contributing
+
+Thank you for wanting to contribute! Before contributing to this repository,
+please read through this document and discuss the change you wish to make via issue.
+
+## Dependencies
+
+Before working with this repository locally, you'll need to install the following dependencies.
+
+- [just][just] for our command-runner scripts.
+- The [Rust toolchain][rust]
+
+**Optional**
+
+- [mdbook](https://github.com/rust-lang/mdBook) to contribute to the [book][book]
+  - [mdbook-template](https://github.com/sgoudham/mdbook-template)
+  - [mdbook-mermaid](https://github.com/badboy/mdbook-mermaid)
+
+## Pull Request Process
+
+1. Before anything, [create an issue][create-an-issue] to discuss the change you're
+   wanting to make, if it is significant or changes functionality. Feel free to skip this step for trivial changes.
+1. Once your change is implemented, ensure that all checks are passing before creating a PR. The full CI pipeline can
+   be run locally via the `justfile`s in the repository.
+1. Make sure to update any documentation that has gone stale as a result of the change, in the `README` files, the [book][book],
+   and in rustdoc comments.
+1. Once you have sign-off from a maintainer, you may merge your pull request yourself if you have permissions to do so.
+   If not, the maintainer who approves your pull request will add it to the merge queue.
+
+<!-- Links -->
+
+[just]: https://github.com/casey/just
+[rust]: https://rustup.rs/
+
+[book]: https://op-rs.github.io/kona
+
+[create-an-issue]: https://github.com/op-rs/kona/issues/new