From 35861c26fec5c2d1dc86144060b449950bf066bc Mon Sep 17 00:00:00 2001 From: Copilot <198982749+Copilot@users.noreply.github.com> Date: Tue, 12 Aug 2025 09:44:05 +0000 Subject: [PATCH 01/47] Initial plan From 53468186fd80638038d031283316ac8f64a55e5f Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Tue, 12 Aug 2025 09:48:34 +0000 Subject: [PATCH 02/47] Add lychee workflow for link checking on PRs Co-authored-by: emhane <58548332+emhane@users.noreply.github.com> --- .github/workflows/lychee.yaml | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 .github/workflows/lychee.yaml diff --git a/.github/workflows/lychee.yaml b/.github/workflows/lychee.yaml new file mode 100644 index 0000000000..23fe937f1d --- /dev/null +++ b/.github/workflows/lychee.yaml @@ -0,0 +1,30 @@ +name: Link Checker + +on: + push: + branches: [main] + merge_group: + pull_request: + +jobs: + lychee: + runs-on: ubuntu-latest + timeout-minutes: 30 + steps: + - name: Checkout sources + uses: actions/checkout@v5 + with: + submodules: true + + - name: Link Checker + uses: lycheeverse/lychee-action@v2 + with: + # Check all markdown and HTML files + args: --verbose --no-progress --accept 200,201,202,203,204,300,301,302,303,304,307,308,429 '**/*.md' '**/*.html' + # Fail on broken links + fail: true + # Format for GitHub Actions + format: markdown + env: + # Use GITHUB_TOKEN to avoid rate limiting + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file From ddc5979b04fc1bd56b2f2d7e84e787989049377e Mon Sep 17 00:00:00 2001 From: Emilia Hane Date: Tue, 12 Aug 2025 13:50:49 +0200 Subject: [PATCH 03/47] Ignore certificate errors and files in superchain-registry --- .github/workflows/lychee.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/lychee.yaml b/.github/workflows/lychee.yaml index 23fe937f1d..bbe50b4b27 100644 --- a/.github/workflows/lychee.yaml +++ b/.github/workflows/lychee.yaml @@ -20,7 +20,7 @@ jobs: uses: lycheeverse/lychee-action@v2 with: # Check all markdown and HTML files - args: --verbose --no-progress --accept 200,201,202,203,204,300,301,302,303,304,307,308,429 '**/*.md' '**/*.html' + args: --verbose --no-progress --insecure --exclude './target/**' --exclude 'crates/protocol/registry/superchain-registry/**' --accept 200,201,202,203,204,300,301,302,303,304,307,308,429 '**/*.md' '**/*.html' # Fail on broken links fail: true # Format for GitHub Actions From 741b3bf4bf20249615b60983618b5aac935ed9e1 Mon Sep 17 00:00:00 2001 From: Emilia Hane Date: Tue, 12 Aug 2025 13:58:01 +0200 Subject: [PATCH 04/47] Fix broken links README --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0c8beea0ab..a9e3ac6a63 100644 --- a/README.md +++ b/README.md @@ -74,7 +74,9 @@ getting started with building your own programs, and a reference for the librari - [`service`](./crates/node/service): The OP Stack rollup node service. - [`engine`](./crates/node/engine): An extensible implementation of the [OP Stack][op-stack] rollup node engine client - [`rpc`](./crates/node/rpc): OP Stack RPC types and extensions. -- [`p2p`](./crates/node/p2p): OP Stack P2P Networking including Gossip and Discovery. +- [`gossip`](./crates/node/gossip): OP Stack P2P Networking - Gossip. +- [`disc`](./crates/node/disc): OP Stack P2P Networking - Discovery. +- [`peers`](./crates/node/peers): Networking Utilities ported from reth. - [`sources`](./crates/node/sources): Data source types and utilities for the kona-node. **Providers** From f8642f9edf12cb2ec1c64d43413c86811d13f85b Mon Sep 17 00:00:00 2001 From: Emilia Hane Date: Tue, 12 Aug 2025 14:00:00 +0200 Subject: [PATCH 05/47] Move lychee job to rust_ci workflow --- .github/workflows/lychee.yaml | 30 ------------------------------ .github/workflows/rust_ci.yaml | 22 ++++++++++++++++++++++ 2 files changed, 22 insertions(+), 30 deletions(-) delete mode 100644 .github/workflows/lychee.yaml diff --git a/.github/workflows/lychee.yaml b/.github/workflows/lychee.yaml deleted file mode 100644 index bbe50b4b27..0000000000 --- a/.github/workflows/lychee.yaml +++ /dev/null @@ -1,30 +0,0 @@ -name: Link Checker - -on: - push: - branches: [main] - merge_group: - pull_request: - -jobs: - lychee: - runs-on: ubuntu-latest - timeout-minutes: 30 - steps: - - name: Checkout sources - uses: actions/checkout@v5 - with: - submodules: true - - - name: Link Checker - uses: lycheeverse/lychee-action@v2 - with: - # Check all markdown and HTML files - args: --verbose --no-progress --insecure --exclude './target/**' --exclude 'crates/protocol/registry/superchain-registry/**' --accept 200,201,202,203,204,300,301,302,303,304,307,308,429 '**/*.md' '**/*.html' - # Fail on broken links - fail: true - # Format for GitHub Actions - format: markdown - env: - # Use GITHUB_TOKEN to avoid rate limiting - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file diff --git a/.github/workflows/rust_ci.yaml b/.github/workflows/rust_ci.yaml index 2bd61b01e3..d3cb131dc0 100644 --- a/.github/workflows/rust_ci.yaml +++ b/.github/workflows/rust_ci.yaml @@ -258,3 +258,25 @@ jobs: - name: Lint features run: | zepter + + lychee: + runs-on: ubuntu-latest + timeout-minutes: 30 + steps: + - name: Checkout sources + uses: actions/checkout@v5 + with: + submodules: true + + - name: Link Checker + uses: lycheeverse/lychee-action@v2 + with: + # Check all markdown and HTML files + args: --verbose --no-progress --insecure --exclude './target/**' --exclude 'crates/protocol/registry/superchain-registry/**' --accept 200,201,202,203,204,300,301,302,303,304,307,308,429 '**/*.md' '**/*.html' + # Fail on broken links + fail: true + # Format for GitHub Actions + format: markdown + env: + # Use GITHUB_TOKEN to avoid rate limiting + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} From 429717f9e473827ed401e56686d9255c29f88bdc Mon Sep 17 00:00:00 2001 From: Emilia Hane Date: Tue, 12 Aug 2025 14:06:51 +0200 Subject: [PATCH 06/47] fixup! Ignore certificate errors and files in superchain-registry --- .github/workflows/rust_ci.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/rust_ci.yaml b/.github/workflows/rust_ci.yaml index d3cb131dc0..ea5f00e402 100644 --- a/.github/workflows/rust_ci.yaml +++ b/.github/workflows/rust_ci.yaml @@ -272,7 +272,7 @@ jobs: uses: lycheeverse/lychee-action@v2 with: # Check all markdown and HTML files - args: --verbose --no-progress --insecure --exclude './target/**' --exclude 'crates/protocol/registry/superchain-registry/**' --accept 200,201,202,203,204,300,301,302,303,304,307,308,429 '**/*.md' '**/*.html' + args: --verbose --no-progress --insecure --exclude './target/**' --exclude './crates/protocol/registry/superchain-registry/**' --accept 200,201,202,203,204,300,301,302,303,304,307,308,429 '**/*.md' '**/*.html' # Fail on broken links fail: true # Format for GitHub Actions From 040b52eb5761daecd99e32a4ba4f1735bcbe980c Mon Sep 17 00:00:00 2001 From: Emilia Hane Date: Tue, 12 Aug 2025 15:30:09 +0200 Subject: [PATCH 07/47] Ignore localhost links --- .github/workflows/rust_ci.yaml | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/.github/workflows/rust_ci.yaml b/.github/workflows/rust_ci.yaml index ea5f00e402..2e47690970 100644 --- a/.github/workflows/rust_ci.yaml +++ b/.github/workflows/rust_ci.yaml @@ -272,7 +272,12 @@ jobs: uses: lycheeverse/lychee-action@v2 with: # Check all markdown and HTML files - args: --verbose --no-progress --insecure --exclude './target/**' --exclude './crates/protocol/registry/superchain-registry/**' --accept 200,201,202,203,204,300,301,302,303,304,307,308,429 '**/*.md' '**/*.html' + args: --verbose --no-progress --insecure \ + --exclude './target/**' \ + --exclude './crates/protocol/registry/superchain-registry/**' \ + --exclude 'localhost' \ + --accept 200,201,202,203,204,300,301,302,303,304,307,308,429 \ + '**/*.md' '**/*.html' # Fail on broken links fail: true # Format for GitHub Actions From e8120c8747fadd8a881527bd8def6319a6624a2f Mon Sep 17 00:00:00 2001 From: Emilia Hane Date: Tue, 12 Aug 2025 15:50:03 +0200 Subject: [PATCH 08/47] Fix args list --- .github/workflows/rust_ci.yaml | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/.github/workflows/rust_ci.yaml b/.github/workflows/rust_ci.yaml index 2e47690970..61a3478d9a 100644 --- a/.github/workflows/rust_ci.yaml +++ b/.github/workflows/rust_ci.yaml @@ -272,12 +272,7 @@ jobs: uses: lycheeverse/lychee-action@v2 with: # Check all markdown and HTML files - args: --verbose --no-progress --insecure \ - --exclude './target/**' \ - --exclude './crates/protocol/registry/superchain-registry/**' \ - --exclude 'localhost' \ - --accept 200,201,202,203,204,300,301,302,303,304,307,308,429 \ - '**/*.md' '**/*.html' + args: --verbose --no-progress --insecure --exclude './target/**' --exclude './crates/protocol/registry/superchain-registry/**' --exclude 'localhost' --accept 200,201,202,203,204,300,301,302,303,304,307,308,429 '**/*.md' '**/*.html' # Fail on broken links fail: true # Format for GitHub Actions From a72b793dd2a1f53ee6f4832305e4e4cf1c3b1b64 Mon Sep 17 00:00:00 2001 From: Emilia Hane Date: Tue, 12 Aug 2025 17:45:44 +0200 Subject: [PATCH 09/47] Remove dead link --- crates/protocol/protocol/README.md | 7 ------- 1 file changed, 7 deletions(-) diff --git a/crates/protocol/protocol/README.md b/crates/protocol/protocol/README.md index 648724922e..799f7e0829 100644 --- a/crates/protocol/protocol/README.md +++ b/crates/protocol/protocol/README.md @@ -9,10 +9,3 @@ Core protocol types for Optimism. These include types, constants, and methods for derivation as well as batch-submission. - -### Provenance - -This code was initially ported from [kona-primitives] to [op-alloy] as part of maili migrations. - -[kona-primitives]: https://github.com/ethereum-optimism/kona/tree/main/crates/kona-primitives -[op-alloy]: https://github.com/alloy-rs/op-alloy From ec692c5a149d7b2223abca935bfbf8ff59de2f21 Mon Sep 17 00:00:00 2001 From: Emilia Hane Date: Wed, 13 Aug 2025 16:04:21 +0200 Subject: [PATCH 10/47] Fix exclude superchain-registry in hyperlink check Co-authored-by: theo <80177219+theochap@users.noreply.github.com> --- .github/workflows/rust_ci.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/rust_ci.yaml b/.github/workflows/rust_ci.yaml index 61a3478d9a..0fb6603818 100644 --- a/.github/workflows/rust_ci.yaml +++ b/.github/workflows/rust_ci.yaml @@ -272,7 +272,7 @@ jobs: uses: lycheeverse/lychee-action@v2 with: # Check all markdown and HTML files - args: --verbose --no-progress --insecure --exclude './target/**' --exclude './crates/protocol/registry/superchain-registry/**' --exclude 'localhost' --accept 200,201,202,203,204,300,301,302,303,304,307,308,429 '**/*.md' '**/*.html' + args: --verbose --no-progress --insecure --exclude './target/**' --exclude './crates/protocol/registry/superchain-registry/**' --exclude './crates/protocol/registry/etc/**' --exclude 'localhost' --accept 200,201,202,203,204,300,301,302,303,304,307,308,429 '**/*.md' '**/*.html' # Fail on broken links fail: true # Format for GitHub Actions From cf8288490f1d4666f62842bf6346fdb78539c6c3 Mon Sep 17 00:00:00 2001 From: Emilia Hane Date: Wed, 13 Aug 2025 16:08:08 +0200 Subject: [PATCH 11/47] Exclude kona-registry from hyperlink check --- .github/workflows/rust_ci.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/rust_ci.yaml b/.github/workflows/rust_ci.yaml index 61a3478d9a..844a745d3c 100644 --- a/.github/workflows/rust_ci.yaml +++ b/.github/workflows/rust_ci.yaml @@ -272,7 +272,7 @@ jobs: uses: lycheeverse/lychee-action@v2 with: # Check all markdown and HTML files - args: --verbose --no-progress --insecure --exclude './target/**' --exclude './crates/protocol/registry/superchain-registry/**' --exclude 'localhost' --accept 200,201,202,203,204,300,301,302,303,304,307,308,429 '**/*.md' '**/*.html' + args: --verbose --no-progress --insecure --exclude './target/**' --exclude './crates/protocol/registry/**' --exclude 'localhost' --accept 200,201,202,203,204,300,301,302,303,304,307,308,429 '**/*.md' '**/*.html' # Fail on broken links fail: true # Format for GitHub Actions From 895b3fc967ced464d9a8f56471915856064cdd7c Mon Sep 17 00:00:00 2001 From: Emilia Hane Date: Wed, 13 Aug 2025 16:13:54 +0200 Subject: [PATCH 12/47] Exclude .gitmodules --- .github/workflows/rust_ci.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/rust_ci.yaml b/.github/workflows/rust_ci.yaml index 844a745d3c..03f2563326 100644 --- a/.github/workflows/rust_ci.yaml +++ b/.github/workflows/rust_ci.yaml @@ -272,7 +272,7 @@ jobs: uses: lycheeverse/lychee-action@v2 with: # Check all markdown and HTML files - args: --verbose --no-progress --insecure --exclude './target/**' --exclude './crates/protocol/registry/**' --exclude 'localhost' --accept 200,201,202,203,204,300,301,302,303,304,307,308,429 '**/*.md' '**/*.html' + args: --verbose --no-progress --insecure --exclude './target/**' --exclude '.gitmodules' --exclude './crates/protocol/registry/superchain-registry/**' --exclude 'localhost' --accept 200,201,202,203,204,300,301,302,303,304,307,308,429 '**/*.md' '**/*.html' # Fail on broken links fail: true # Format for GitHub Actions From fff325b829c7f77a30d8c468b0e9a827683f0bf2 Mon Sep 17 00:00:00 2001 From: Emilia Hane Date: Wed, 13 Aug 2025 16:16:35 +0200 Subject: [PATCH 13/47] Exclude foo.bar --- .github/workflows/rust_ci.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/rust_ci.yaml b/.github/workflows/rust_ci.yaml index 03f2563326..72d6c42f2d 100644 --- a/.github/workflows/rust_ci.yaml +++ b/.github/workflows/rust_ci.yaml @@ -272,7 +272,7 @@ jobs: uses: lycheeverse/lychee-action@v2 with: # Check all markdown and HTML files - args: --verbose --no-progress --insecure --exclude './target/**' --exclude '.gitmodules' --exclude './crates/protocol/registry/superchain-registry/**' --exclude 'localhost' --accept 200,201,202,203,204,300,301,302,303,304,307,308,429 '**/*.md' '**/*.html' + args: --verbose --no-progress --insecure --exclude './target/**' --exclude '.gitmodules' --exclude './crates/protocol/registry/superchain-registry/**' --exclude 'localhost' --exclude 'foo.bar' --accept 200,201,202,203,204,300,301,302,303,304,307,308,429 '**/*.md' '**/*.html' # Fail on broken links fail: true # Format for GitHub Actions From 3c56d0c74d4f9c7fe7eb36fbdc91d76d31367c3e Mon Sep 17 00:00:00 2001 From: Emilia Hane Date: Mon, 18 Aug 2025 12:50:46 +0200 Subject: [PATCH 14/47] Move lychee args to config --- .github/workflows/rust_ci.yaml | 11 ----------- lychee.toml | 22 ++++++++++++++++++++++ 2 files changed, 22 insertions(+), 11 deletions(-) create mode 100644 lychee.toml diff --git a/.github/workflows/rust_ci.yaml b/.github/workflows/rust_ci.yaml index 72d6c42f2d..349009d997 100644 --- a/.github/workflows/rust_ci.yaml +++ b/.github/workflows/rust_ci.yaml @@ -267,16 +267,5 @@ jobs: uses: actions/checkout@v5 with: submodules: true - - name: Link Checker uses: lycheeverse/lychee-action@v2 - with: - # Check all markdown and HTML files - args: --verbose --no-progress --insecure --exclude './target/**' --exclude '.gitmodules' --exclude './crates/protocol/registry/superchain-registry/**' --exclude 'localhost' --exclude 'foo.bar' --accept 200,201,202,203,204,300,301,302,303,304,307,308,429 '**/*.md' '**/*.html' - # Fail on broken links - fail: true - # Format for GitHub Actions - format: markdown - env: - # Use GITHUB_TOKEN to avoid rate limiting - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/lychee.toml b/lychee.toml new file mode 100644 index 0000000000..d35f538223 --- /dev/null +++ b/lychee.toml @@ -0,0 +1,22 @@ +verbose = true + +progress = true + +# required to check liveness of RPC endpoints +insecure = true + +# Files or directories to exclude +exclude = [ + "./target/**", + "localhost", + "foo.bar" +] + +# Accepted HTTP status codes +accept = [200, 201, 202, 203, 204, 300, 301, 302, 303, 304, 307, 308, 429] + +# Files to scan +files = [ + "**/*.md", + "**/*.html" +] \ No newline at end of file From fef8929124d852df749db94249ac2283b7493d75 Mon Sep 17 00:00:00 2001 From: Emilia Hane Date: Mon, 18 Aug 2025 12:51:19 +0200 Subject: [PATCH 15/47] Avoid init submodules --- .github/workflows/rust_ci.yaml | 2 -- 1 file changed, 2 deletions(-) diff --git a/.github/workflows/rust_ci.yaml b/.github/workflows/rust_ci.yaml index 349009d997..51df02793c 100644 --- a/.github/workflows/rust_ci.yaml +++ b/.github/workflows/rust_ci.yaml @@ -265,7 +265,5 @@ jobs: steps: - name: Checkout sources uses: actions/checkout@v5 - with: - submodules: true - name: Link Checker uses: lycheeverse/lychee-action@v2 From e5ede664a47a8ee3d0b1c01b57253b926305c676 Mon Sep 17 00:00:00 2001 From: Emilia Hane Date: Mon, 18 Aug 2025 12:53:19 +0200 Subject: [PATCH 16/47] Remove verbosity key from lychee config --- lychee.toml | 2 -- 1 file changed, 2 deletions(-) diff --git a/lychee.toml b/lychee.toml index d35f538223..9ebf48d28a 100644 --- a/lychee.toml +++ b/lychee.toml @@ -1,5 +1,3 @@ -verbose = true - progress = true # required to check liveness of RPC endpoints From 730fc9f3933fa8bc10724865e323cc6ecd0746e4 Mon Sep 17 00:00:00 2001 From: Emilia Hane Date: Mon, 18 Aug 2025 12:55:41 +0200 Subject: [PATCH 17/47] Remove insecure key from lychee config --- lychee.toml | 3 --- 1 file changed, 3 deletions(-) diff --git a/lychee.toml b/lychee.toml index 9ebf48d28a..e6c70ed76c 100644 --- a/lychee.toml +++ b/lychee.toml @@ -1,8 +1,5 @@ progress = true -# required to check liveness of RPC endpoints -insecure = true - # Files or directories to exclude exclude = [ "./target/**", From 3067a4269b193674c35afd22d9357c990ead9f18 Mon Sep 17 00:00:00 2001 From: Emilia Hane Date: Mon, 18 Aug 2025 13:03:39 +0200 Subject: [PATCH 18/47] Remove redundant key from lychee config --- lychee.toml | 2 -- 1 file changed, 2 deletions(-) diff --git a/lychee.toml b/lychee.toml index e6c70ed76c..eb25022f40 100644 --- a/lychee.toml +++ b/lychee.toml @@ -1,5 +1,3 @@ -progress = true - # Files or directories to exclude exclude = [ "./target/**", From 362169a348919767ee459a37d8796fff9d1ea299 Mon Sep 17 00:00:00 2001 From: Emilia Hane Date: Mon, 18 Aug 2025 13:04:29 +0200 Subject: [PATCH 19/47] Include rust files --- lychee.toml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/lychee.toml b/lychee.toml index eb25022f40..51117161b8 100644 --- a/lychee.toml +++ b/lychee.toml @@ -11,5 +11,6 @@ accept = [200, 201, 202, 203, 204, 300, 301, 302, 303, 304, 307, 308, 429] # Files to scan files = [ "**/*.md", - "**/*.html" + "**/*.html", + "**/*.rs" ] \ No newline at end of file From cbc8f3f40fcad67321c6fdbb4b0e17f32988e1de Mon Sep 17 00:00:00 2001 From: Emilia Hane Date: Mon, 18 Aug 2025 13:16:17 +0200 Subject: [PATCH 20/47] Add .mdx files to lychee config --- lychee.toml | 1 + 1 file changed, 1 insertion(+) diff --git a/lychee.toml b/lychee.toml index 51117161b8..6b302c6728 100644 --- a/lychee.toml +++ b/lychee.toml @@ -11,6 +11,7 @@ accept = [200, 201, 202, 203, 204, 300, 301, 302, 303, 304, 307, 308, 429] # Files to scan files = [ "**/*.md", + "**/*.mdx", "**/*.html", "**/*.rs" ] \ No newline at end of file From 6502d90ac392dc2009d98c358e0d5b1e4a5b2afa Mon Sep 17 00:00:00 2001 From: Emilia Hane Date: Mon, 18 Aug 2025 13:24:00 +0200 Subject: [PATCH 21/47] fixup! Remove redundant key from lychee config --- lychee.toml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/lychee.toml b/lychee.toml index 6b302c6728..257a359722 100644 --- a/lychee.toml +++ b/lychee.toml @@ -1,3 +1,5 @@ +progress = true + # Files or directories to exclude exclude = [ "./target/**", From 09dd410266023a03c5f6f57990eb275a39c1bf75 Mon Sep 17 00:00:00 2001 From: Emilia Hane Date: Mon, 18 Aug 2025 13:33:54 +0200 Subject: [PATCH 22/47] Observe scanned files --- lychee.toml | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/lychee.toml b/lychee.toml index 257a359722..636167c6e1 100644 --- a/lychee.toml +++ b/lychee.toml @@ -1,10 +1,13 @@ +verbose = "debug" + progress = true # Files or directories to exclude exclude = [ "./target/**", "localhost", - "foo.bar" + "foo.bar", + "CHANGELOG.md" ] # Accepted HTTP status codes From 36d5120d6b31d9dfd083377b607e47d6d448bac4 Mon Sep 17 00:00:00 2001 From: Emilia Hane Date: Mon, 18 Aug 2025 13:37:51 +0200 Subject: [PATCH 23/47] fixup! Include rust files --- lychee.toml | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/lychee.toml b/lychee.toml index 636167c6e1..16b121a16c 100644 --- a/lychee.toml +++ b/lychee.toml @@ -10,13 +10,16 @@ exclude = [ "CHANGELOG.md" ] +include = [ + "**/*.mdx", + "**/*.rs" +] + # Accepted HTTP status codes accept = [200, 201, 202, 203, 204, 300, 301, 302, 303, 304, 307, 308, 429] # Files to scan files = [ "**/*.md", - "**/*.mdx", - "**/*.html", - "**/*.rs" + "**/*.html" ] \ No newline at end of file From 947e9fc73d3e1250bf13da1316cbc2c33f1acb4a Mon Sep 17 00:00:00 2001 From: Emilia Hane Date: Mon, 18 Aug 2025 13:56:16 +0200 Subject: [PATCH 24/47] fixup! fixup! Include rust files --- lychee.toml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lychee.toml b/lychee.toml index 16b121a16c..a0ec17135b 100644 --- a/lychee.toml +++ b/lychee.toml @@ -11,8 +11,8 @@ exclude = [ ] include = [ - "**/*.mdx", - "**/*.rs" + "*.mdx", + "*.rs" ] # Accepted HTTP status codes From b5779e237eec6119e67574d3c5b7720446ed4bb0 Mon Sep 17 00:00:00 2001 From: Emilia Hane Date: Mon, 18 Aug 2025 14:26:09 +0200 Subject: [PATCH 25/47] Fix file types to scan --- .github/workflows/rust_ci.yaml | 6 ++---- lychee.toml | 13 +++++-------- 2 files changed, 7 insertions(+), 12 deletions(-) diff --git a/.github/workflows/rust_ci.yaml b/.github/workflows/rust_ci.yaml index 51df02793c..67586d4f29 100644 --- a/.github/workflows/rust_ci.yaml +++ b/.github/workflows/rust_ci.yaml @@ -263,7 +263,5 @@ jobs: runs-on: ubuntu-latest timeout-minutes: 30 steps: - - name: Checkout sources - uses: actions/checkout@v5 - - name: Link Checker - uses: lycheeverse/lychee-action@v2 + - uses: actions/checkout@v5 + - uses: lycheeverse/lychee-action@v2 diff --git a/lychee.toml b/lychee.toml index a0ec17135b..35e17f6599 100644 --- a/lychee.toml +++ b/lychee.toml @@ -10,16 +10,13 @@ exclude = [ "CHANGELOG.md" ] -include = [ - "*.mdx", - "*.rs" -] - # Accepted HTTP status codes accept = [200, 201, 202, 203, 204, 300, 301, 302, 303, 304, 307, 308, 429] # Files to scan -files = [ - "**/*.md", - "**/*.html" +extensions = [ + "md", + "mdx", + "html", + "rs" ] \ No newline at end of file From 4e381a2af9626cc1242390ef9e6afb029cd0c519 Mon Sep 17 00:00:00 2001 From: Emilia Hane Date: Mon, 18 Aug 2025 14:29:26 +0200 Subject: [PATCH 26/47] Use github token against rate limiting --- .github/workflows/rust_ci.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/workflows/rust_ci.yaml b/.github/workflows/rust_ci.yaml index 67586d4f29..adb8f1625b 100644 --- a/.github/workflows/rust_ci.yaml +++ b/.github/workflows/rust_ci.yaml @@ -261,6 +261,9 @@ jobs: lychee: runs-on: ubuntu-latest + env: + # Use GITHUB_TOKEN to avoid rate limiting + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} timeout-minutes: 30 steps: - uses: actions/checkout@v5 From 64b345b986677a28185ecb62b3bae543ac4c2265 Mon Sep 17 00:00:00 2001 From: Emilia Hane Date: Mon, 18 Aug 2025 14:52:12 +0200 Subject: [PATCH 27/47] Explicitly use lychee config --- .github/workflows/rust_ci.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/workflows/rust_ci.yaml b/.github/workflows/rust_ci.yaml index adb8f1625b..ce060b28bb 100644 --- a/.github/workflows/rust_ci.yaml +++ b/.github/workflows/rust_ci.yaml @@ -268,3 +268,6 @@ jobs: steps: - uses: actions/checkout@v5 - uses: lycheeverse/lychee-action@v2 + with: + args: --config ./lychee.toml + debug: true From 69bda9ee6500bea64513d5702392ea29aead21ca Mon Sep 17 00:00:00 2001 From: Emilia Hane Date: Mon, 18 Aug 2025 14:59:34 +0200 Subject: [PATCH 28/47] Exclude changelog --- .github/workflows/rust_ci.yaml | 1 - lychee.toml | 2 +- 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/workflows/rust_ci.yaml b/.github/workflows/rust_ci.yaml index ce060b28bb..0859762d89 100644 --- a/.github/workflows/rust_ci.yaml +++ b/.github/workflows/rust_ci.yaml @@ -269,5 +269,4 @@ jobs: - uses: actions/checkout@v5 - uses: lycheeverse/lychee-action@v2 with: - args: --config ./lychee.toml debug: true diff --git a/lychee.toml b/lychee.toml index 35e17f6599..564a6038c3 100644 --- a/lychee.toml +++ b/lychee.toml @@ -7,7 +7,7 @@ exclude = [ "./target/**", "localhost", "foo.bar", - "CHANGELOG.md" + "./CHANGELOG.md" ] # Accepted HTTP status codes From c5301a5b2852f7f070b50fcc25cfafc1f530efe2 Mon Sep 17 00:00:00 2001 From: Emilia Hane Date: Mon, 18 Aug 2025 15:21:20 +0200 Subject: [PATCH 29/47] Add back files key --- lychee.toml | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/lychee.toml b/lychee.toml index 564a6038c3..ef2a940059 100644 --- a/lychee.toml +++ b/lychee.toml @@ -14,9 +14,8 @@ exclude = [ accept = [200, 201, 202, 203, 204, 300, 301, 302, 303, 304, 307, 308, 429] # Files to scan -extensions = [ - "md", - "mdx", - "html", - "rs" +files = [ + "**/*.md", + "**/*.mdx", + "**/*.html" ] \ No newline at end of file From 357d3b005cc41c4dcefa4b450bd43a8f2d72c103 Mon Sep 17 00:00:00 2001 From: Emilia Hane Date: Mon, 18 Aug 2025 15:28:34 +0200 Subject: [PATCH 30/47] Fix lychee config --- .github/workflows/rust_ci.yaml | 2 -- lychee.toml | 14 ++++++-------- 2 files changed, 6 insertions(+), 10 deletions(-) diff --git a/.github/workflows/rust_ci.yaml b/.github/workflows/rust_ci.yaml index 0859762d89..adb8f1625b 100644 --- a/.github/workflows/rust_ci.yaml +++ b/.github/workflows/rust_ci.yaml @@ -268,5 +268,3 @@ jobs: steps: - uses: actions/checkout@v5 - uses: lycheeverse/lychee-action@v2 - with: - debug: true diff --git a/lychee.toml b/lychee.toml index ef2a940059..4e9ba0137f 100644 --- a/lychee.toml +++ b/lychee.toml @@ -1,18 +1,16 @@ +# Config example at: https://lychee.cli.rs/usage/config/ + verbose = "debug" -progress = true +no_progress = false + +exclude_all_private = false # Files or directories to exclude -exclude = [ - "./target/**", - "localhost", - "foo.bar", +exclude_path = [ "./CHANGELOG.md" ] -# Accepted HTTP status codes -accept = [200, 201, 202, 203, 204, 300, 301, 302, 303, 304, 307, 308, 429] - # Files to scan files = [ "**/*.md", From 9a820b863b0b8030dedcd93a507f7ddb6159d6d7 Mon Sep 17 00:00:00 2001 From: Emilia Hane Date: Mon, 18 Aug 2025 15:35:33 +0200 Subject: [PATCH 31/47] Fix parse config --- .github/workflows/rust_ci.yaml | 2 ++ lychee.toml | 13 +++++-------- 2 files changed, 7 insertions(+), 8 deletions(-) diff --git a/.github/workflows/rust_ci.yaml b/.github/workflows/rust_ci.yaml index adb8f1625b..d256c55eee 100644 --- a/.github/workflows/rust_ci.yaml +++ b/.github/workflows/rust_ci.yaml @@ -268,3 +268,5 @@ jobs: steps: - uses: actions/checkout@v5 - uses: lycheeverse/lychee-action@v2 + with: + args: --config ./lychee.toml '**/*.md' '**/*.mdx' '**/*.html' diff --git a/lychee.toml b/lychee.toml index 4e9ba0137f..85b3c8571c 100644 --- a/lychee.toml +++ b/lychee.toml @@ -6,14 +6,11 @@ no_progress = false exclude_all_private = false -# Files or directories to exclude -exclude_path = [ - "./CHANGELOG.md" +exclude = [ + 'foo.bar' ] -# Files to scan -files = [ - "**/*.md", - "**/*.mdx", - "**/*.html" +# Files or directories to exclude +exclude_path = [ + './CHANGELOG.md' ] \ No newline at end of file From 53a1c7f35316fcae86e77efbb58936b411ca939d Mon Sep 17 00:00:00 2001 From: Emilia Hane Date: Mon, 18 Aug 2025 16:52:18 +0200 Subject: [PATCH 32/47] Add back localhost to exclude list --- lychee.toml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/lychee.toml b/lychee.toml index 85b3c8571c..ceb2e22184 100644 --- a/lychee.toml +++ b/lychee.toml @@ -7,7 +7,8 @@ no_progress = false exclude_all_private = false exclude = [ - 'foo.bar' + 'foo.bar', + 'localhost' ] # Files or directories to exclude From 60b87d996872b8906817c945f890173cffa62aaf Mon Sep 17 00:00:00 2001 From: Emilia Hane Date: Mon, 18 Aug 2025 17:08:38 +0200 Subject: [PATCH 33/47] Fix broken links in custom-backend doc --- docs/docs/pages/sdk/proof/custom-backend.mdx | 10 +++++----- docs/docs/pages/sdk/proof/fpvm-backend.mdx | 2 +- docs/docs/pages/sdk/protocol/derive/providers.mdx | 4 ++-- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/docs/pages/sdk/proof/custom-backend.mdx b/docs/docs/pages/sdk/proof/custom-backend.mdx index 3a2c493a81..4edf5b6b4c 100644 --- a/docs/docs/pages/sdk/proof/custom-backend.mdx +++ b/docs/docs/pages/sdk/proof/custom-backend.mdx @@ -48,9 +48,9 @@ Before getting started, we need to create custom implementations of the followin | Trait | Description | | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | -| [`ChainProvider`](https://docs.rs/kona-derive/latest/kona_derive/traits/trait.ChainProvider.html) | The `ChainProvider` trait describes the minimal interface for fetching data from L1 during L2 chain derivation. | -| [`L2ChainProvider`](https://docs.rs/kona-derive/latest/kona_derive/traits/trait.L2ChainProvider.html) | The `ChainProvider` trait describes the minimal interface for fetching data from the safe L2 chain during L2 chain derivation. | -| [`BlobProvider`](https://docs.rs/kona-derive/latest/kona_derive/traits/trait.BlobProvider.html) | The `BlobProvider` trait describes an interface for fetching EIP-4844 blobs from the L1 consensus layer during L2 chain derivation. | +| [`ChainProvider`](https://docs.rs/kona-derive/latest/kona_derive/trait.ChainProvider.html) | The `ChainProvider` trait describes the minimal interface for fetching data from L1 during L2 chain derivation. | +| [`L2ChainProvider`](https://docs.rs/kona-derive/latest/kona_derive/trait.L2ChainProvider.html) | The `ChainProvider` trait describes the minimal interface for fetching data from the safe L2 chain during L2 chain derivation. | +| [`BlobProvider`](https://docs.rs/kona-derive/latest/kona_derive/trait.BlobProvider.html) | The `BlobProvider` trait describes an interface for fetching EIP-4844 blobs from the L1 consensus layer during L2 chain derivation. | Once these are implemented, constructing the pipeline is as simple as passing in the data sources to the `PipelineBuilder`. Keep in mind the requirements for validation of incoming data, depending on your platform. For example, programs targeting zkVMs must constrain that the incoming data is indeed valid, whereas fault proof programs can offload this validation to the on-chain implementation of the host. @@ -93,8 +93,8 @@ Before getting started, we need to create custom implementations of the followin | Trait | Description | | ------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`TrieDBFetcher`](https://docs.rs/kona-mpt/latest/kona_mpt/trait.TrieDBFetcher.html) | The `TrieDBFetcher` trait describes the interface for fetching trie node preimages and chain information while executing a payload on the L2 chain. | -| [`TrieDBHinter`](https://docs.rs/kona-mpt/latest/kona_mpt/trait.TrieDBHinter.html) | The `TrieDBHinter` trait describes the interface for requesting the host program to prepare trie proof preimages for the client's consumption. For targets with upfront witness generation, i.e. zkVMs, a no-op hinter is exported as [`NoopTrieDBHinter`](https://docs.rs/kona-mpt/latest/kona_mpt/struct.NoopTrieDBHinter.html). | +| [`TrieProvider`](https://docs.rs/kona-mpt/latest/kona_mpt/trait.TrieProvider.html) | The `TrieProvider` trait describes the interface for fetching trie node preimages and chain information while executing a payload on the L2 chain. | +| [`TrieDBHinter`](https://docs.rs/kona-mpt/latest/kona_mpt/trait.TrieDBHinter.html) | The `TrieDBHinter` trait describes the interface for requesting the host program to prepare trie proof preimages for the client's consumption. For targets with upfront witness generation, i.e. zkVMs, a no-op hinter is exported as [`NoopTrieHinter`](https://docs.rs/kona-mpt/latest/kona_mpt/struct.NoopTrieHinter.html). | Once we have those, the `StatelessL2BlockExecutor` can be constructed like so: diff --git a/docs/docs/pages/sdk/proof/fpvm-backend.mdx b/docs/docs/pages/sdk/proof/fpvm-backend.mdx index 993648793b..dab1ecfc4a 100644 --- a/docs/docs/pages/sdk/proof/fpvm-backend.mdx +++ b/docs/docs/pages/sdk/proof/fpvm-backend.mdx @@ -101,7 +101,7 @@ to pull in untyped data from the host by `PreimageKey`. These data source traits the [Custom Backend](/sdk/proof/custom-backend) section, but we'll quickly gloss over them here to build intuition. Let's take, for example, [`OracleL1ChainProvider`](https://github.com/op-rs/kona/blob/40a8d7ec3def4a1eeb26492a1e4338d8b032e428/bin/client/src/l1/chain_provider.rs#L16-L23). -The [`ChainProvider`](https://docs.rs/kona-derive/latest/kona_derive/traits/trait.ChainProvider.html) trait in `kona-derive` +The [`ChainProvider`](https://docs.rs/kona-derive/latest/kona_derive/trait.ChainProvider.html) trait in `kona-derive` defines a simple interface for fetching information about the L1 chain. In the `OracleL1ChainProvider`, this information is pulled in over the [PreimageOracle ABI][preimage-specs]. There are many other examples of these data source traits, namely the `L2ChainProvider`, `BlobProvider`, `TrieProvider`, and `TrieHinter`, which enable the creation of different diff --git a/docs/docs/pages/sdk/protocol/derive/providers.mdx b/docs/docs/pages/sdk/protocol/derive/providers.mdx index 42840ed475..7019c00f39 100644 --- a/docs/docs/pages/sdk/protocol/derive/providers.mdx +++ b/docs/docs/pages/sdk/protocol/derive/providers.mdx @@ -96,6 +96,6 @@ impl DataAvailabilityProvider for ExampleAvail { [builder]: https://docs.rs/kona-derive/latest/kona_derive/pipeline/struct.PipelineBuilder.html [alloy]: https://github.com/alloy-rs/alloy [kda]: https://crates.io/crates/kona-derive-alloy -[chain-provider]: https://docs.rs/kona-derive/latest/kona_derive/traits/trait.ChainProvider.html -[l2-chain-provider]: https://docs.rs/kona-derive/latest/kona_derive/traits/trait.L2ChainProvider.html +[chain-provider]: https://docs.rs/kona-derive/latest/kona_derive/trait.ChainProvider.html +[l2-chain-provider]: https://docs.rs/kona-derive/latest/kona_derive/trait.L2ChainProvider.html [dap]: https://docs.rs/kona-derive/latest/kona_derive/traits/trait.DataAvailabilityProvider.html From 8137ee8ae20b5575f6e9f4d8d90552b57d313f84 Mon Sep 17 00:00:00 2001 From: Emilia Hane Date: Mon, 18 Aug 2025 17:24:58 +0200 Subject: [PATCH 34/47] Fix exclude path --- lychee.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lychee.toml b/lychee.toml index ceb2e22184..22de01f5cc 100644 --- a/lychee.toml +++ b/lychee.toml @@ -13,5 +13,5 @@ exclude = [ # Files or directories to exclude exclude_path = [ - './CHANGELOG.md' + 'CHANGELOG.md' ] \ No newline at end of file From e1ffff7a8c08512588edf10a6259836724e4be46 Mon Sep 17 00:00:00 2001 From: Emilia Hane Date: Mon, 18 Aug 2025 17:35:22 +0200 Subject: [PATCH 35/47] Fix links in kona-derive intro doc --- docs/docs/pages/sdk/protocol/derive/intro.mdx | 24 +++++++++---------- .../pages/sdk/protocol/derive/providers.mdx | 2 +- .../pages/sdk/protocol/derive/signaling.mdx | 4 ++-- .../docs/pages/sdk/protocol/derive/stages.mdx | 8 +++---- 4 files changed, 19 insertions(+), 19 deletions(-) diff --git a/docs/docs/pages/sdk/protocol/derive/intro.mdx b/docs/docs/pages/sdk/protocol/derive/intro.mdx index 5f1e309e1d..7e19c86adf 100644 --- a/docs/docs/pages/sdk/protocol/derive/intro.mdx +++ b/docs/docs/pages/sdk/protocol/derive/intro.mdx @@ -285,9 +285,9 @@ program on top of the RISCV or MIPS ISAs. So, [@clabby][clabby] and [@refcell][refcell] stood up [kona][kona] in a few months. -[driver]: https://github.com/op-rs/kona/blob/main/bin/client/src/l1/driver.rs#L74 +[driver]: https://docs.rs/kona-driver/latest/kona_driver/struct.Driver.html [next]: https://doc.rust-lang.org/nightly/core/iter/trait.Iterator.html#tymethod.next -[builder]: https://docs.rs/kona-derive/latest/kona_derive/pipeline/struct.PipelineBuilder.html +[builder]: https://docs.rs/kona-derive/latest/kona_derive/struct.PipelineBuilder.html [alloy]: https://github.com/alloy-rs/alloy [ethers-rs]: https://github.com/gakonst/ethers-rs [kona]: https://github.com/op-rs/kona @@ -297,16 +297,16 @@ So, [@clabby][clabby] and [@refcell][refcell] stood up [kona][kona] in a few mon [magi]: https://github.com/a16z/magi [kd]: https://crates.io/crates/kona-derive [iterator]: https://doc.rust-lang.org/nightly/core/iter/trait.Iterator.html -[p]: https://docs.rs/kona-derive/latest/kona_derive/traits/trait.Pipeline.html +[p]: https://docs.rs/kona-derive/latest/kona_derive/trait.Pipeline.html [op-dp]: https://github.com/ethereum-optimism/optimism/tree/develop/op-node/rollup/derive -[dp]: https://docs.rs/kona-derive/latest/kona_derive/pipeline/struct.DerivationPipeline.html -[attributes]: https://docs.rs/op-alloy-rpc-types-engine/latest/op_alloy_rpc_types_engine/struct.OpAttributesWithParent.html +[dp]: https://docs.rs/kona-derive/latest/kona_derive/struct.DerivationPipeline.html +[attributes]: https://docs.rs/kona-protocol/latest/kona_protocol/struct.OpAttributesWithParent.html -[attributes-queue]: https://docs.rs/kona-derive/latest/kona_derive/stages/struct.AttributesQueue.html -[batch-provider]: https://docs.rs/kona-derive/latest/kona_derive/stages/struct.BatchProvider.html -[batch-stream]: https://docs.rs/kona-derive/latest/kona_derive/stages/struct.BatchStream.html -[channel-reader]: https://docs.rs/kona-derive/latest/kona_derive/stages/struct.ChannelReader.html +[attributes-queue]: https://docs.rs/kona-derive/latest/kona_derive/struct.AttributesQueue.html +[batch-provider]: https://docs.rs/kona-derive/latest/kona_derive/struct.BatchProvider.html +[batch-stream]: https://docs.rs/kona-derive/latest/kona_derive/struct.BatchStream.html +[channel-reader]: https://docs.rs/kona-derive/latest/kona_derive/struct.ChannelReader.html [channel-provider]: https://docs.rs/kona-derive/latest/kona_derive/struct.ChannelProvider.html -[frame-queue]: https://docs.rs/kona-derive/latest/kona_derive/stages/struct.FrameQueue.html -[retrieval]: https://docs.rs/kona-derive/latest/kona_derive/stages/struct.L1Retrieval.html -[traversal]: https://docs.rs/kona-derive/latest/kona_derive/stages/struct.IndexedTraversal.html +[frame-queue]: https://docs.rs/kona-derive/latest/kona_derive/struct.FrameQueue.html +[retrieval]: https://docs.rs/kona-derive/latest/kona_derive/struct.L1Retrieval.html +[traversal]: https://docs.rs/kona-derive/latest/kona_derive/struct.IndexedTraversal.html diff --git a/docs/docs/pages/sdk/protocol/derive/providers.mdx b/docs/docs/pages/sdk/protocol/derive/providers.mdx index 7019c00f39..049ee41d87 100644 --- a/docs/docs/pages/sdk/protocol/derive/providers.mdx +++ b/docs/docs/pages/sdk/protocol/derive/providers.mdx @@ -93,7 +93,7 @@ impl DataAvailabilityProvider for ExampleAvail { [dap]: https://docs.rs/kona-derive/latest/kona_derive/traits/trait.DataAvailabilityProvider.html [next]: https://docs.rs/kona-derive/latest/kona_derive/traits/trait.DataAvailabilityProvider.html#tymethod.next -[builder]: https://docs.rs/kona-derive/latest/kona_derive/pipeline/struct.PipelineBuilder.html +[builder]: https://docs.rs/kona-derive/latest/kona_derive/struct.PipelineBuilder.html [alloy]: https://github.com/alloy-rs/alloy [kda]: https://crates.io/crates/kona-derive-alloy [chain-provider]: https://docs.rs/kona-derive/latest/kona_derive/trait.ChainProvider.html diff --git a/docs/docs/pages/sdk/protocol/derive/signaling.mdx b/docs/docs/pages/sdk/protocol/derive/signaling.mdx index 329da7162e..4ff8c71741 100644 --- a/docs/docs/pages/sdk/protocol/derive/signaling.mdx +++ b/docs/docs/pages/sdk/protocol/derive/signaling.mdx @@ -146,8 +146,8 @@ impl SignalReceiver for IndexedTraversal { -[traversal]: https://docs.rs/kona-derive/latest/kona_derive/stages/struct.IndexedTraversal.html -[dp]: https://docs.rs/kona-derive/latest/kona_derive/pipeline/struct.DerivationPipeline.html +[traversal]: https://docs.rs/kona-derive/latest/kona_derive/struct.IndexedTraversal.html +[dp]: https://docs.rs/kona-derive/latest/kona_derive/struct.DerivationPipeline.html [stages]: https://docs.rs/kona-derive/latest/kona_derive/stages/index.html [receiver]: https://docs.rs/kona-derive/latest/kona_derive/traits/trait.SignalReceiver.html [signal]: https://docs.rs/kona-derive/latest/kona_derive/traits/enum.Signal.html diff --git a/docs/docs/pages/sdk/protocol/derive/stages.mdx b/docs/docs/pages/sdk/protocol/derive/stages.mdx index 913a770275..c4b868c53d 100644 --- a/docs/docs/pages/sdk/protocol/derive/stages.mdx +++ b/docs/docs/pages/sdk/protocol/derive/stages.mdx @@ -103,10 +103,10 @@ DapRetrieval> [intro]: ./intro.md -[dp]: https://docs.rs/kona-derive/latest/kona_derive/pipeline/struct.DerivationPipeline.html +[dp]: https://docs.rs/kona-derive/latest/kona_derive/struct.DerivationPipeline.html [retrieval-provider]: https://docs.rs/kona-derive/latest/kona_derive/stages/trait.L1RetrievalProvider.html [frame-queue-provider]: https://docs.rs/kona-derive/latest/kona_derive/stages/trait.FrameQueueProvider.html -[frame-queue]: https://docs.rs/kona-derive/latest/kona_derive/stages/struct.FrameQueue.html -[retrieval]: https://docs.rs/kona-derive/latest/kona_derive/stages/struct.L1Retrieval.html -[traversal]: https://docs.rs/kona-derive/latest/kona_derive/stages/struct.IndexedTraversal.html +[frame-queue]: https://docs.rs/kona-derive/latest/kona_derive/struct.FrameQueue.html +[retrieval]: https://docs.rs/kona-derive/latest/kona_derive/struct.L1Retrieval.html +[traversal]: https://docs.rs/kona-derive/latest/kona_derive/struct.IndexedTraversal.html From d15887d1db05e545581c4faba4823c4aa9f6abb6 Mon Sep 17 00:00:00 2001 From: Emilia Hane Date: Mon, 18 Aug 2025 17:48:35 +0200 Subject: [PATCH 36/47] Fix more broken links --- docs/docs/pages/node/design/p2p.mdx | 2 +- docs/docs/pages/sdk/examples/batch-to-frames.mdx | 2 +- docs/docs/pages/sdk/protocol/derive/providers.mdx | 6 +++--- docs/docs/pages/sdk/protocol/derive/signaling.mdx | 10 +++++----- docs/docs/pages/sdk/protocol/derive/stages.mdx | 4 ++-- 5 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/docs/pages/node/design/p2p.mdx b/docs/docs/pages/node/design/p2p.mdx index da8a7c19fe..52d3ed1938 100644 --- a/docs/docs/pages/node/design/p2p.mdx +++ b/docs/docs/pages/node/design/p2p.mdx @@ -169,7 +169,7 @@ TODO [discv5-service]: https://docs.rs/discv5/latest/discv5/struct.Discv5.html -[driver]: https://github.com/op-rs/kona/blob/main/crates/node/p2p/src/discv5/mod.rs +[driver]: https://docs.rs/kona-p2p/latest/kona_p2p/struct.Discv5Driver.html [discv5]: https://github.com/ethereum/devp2p/blob/master/discv5/discv5.md [libp2p]: https://libp2p.io/ diff --git a/docs/docs/pages/sdk/examples/batch-to-frames.mdx b/docs/docs/pages/sdk/examples/batch-to-frames.mdx index 50634582f8..67b614bea0 100644 --- a/docs/docs/pages/sdk/examples/batch-to-frames.mdx +++ b/docs/docs/pages/sdk/examples/batch-to-frames.mdx @@ -181,7 +181,7 @@ fn main() { [channel-id]: https://docs.rs/kona-protocol/latest/kona_protocol/type.ChannelId.html [encode-batch]: https://docs.rs/kona-protocol/latest/kona_protocol/enum.Batch.html#method.encode -[compress-brotli]: https://docs.rs/kona-comp/latest/kona_comp/fn.compress_brotli.html +[compress-brotli]: https://docs.rs/op-alloy-protocol/latest/op_alloy_protocol/struct.BrotliCompressor.html [channel-out]: https://docs.rs/kona-comp/latest/kona_comp/struct.ChannelOut.html [ready-bytes]: https://docs.rs/kona-comp/latest/kona_comp/struct.ChannelOut.html#method.ready_bytes [output-frame]: https://docs.rs/kona-comp/latest/kona_comp/struct.ChannelOut.html#method.output_frame diff --git a/docs/docs/pages/sdk/protocol/derive/providers.mdx b/docs/docs/pages/sdk/protocol/derive/providers.mdx index 049ee41d87..05999248f3 100644 --- a/docs/docs/pages/sdk/protocol/derive/providers.mdx +++ b/docs/docs/pages/sdk/protocol/derive/providers.mdx @@ -91,11 +91,11 @@ impl DataAvailabilityProvider for ExampleAvail { -[dap]: https://docs.rs/kona-derive/latest/kona_derive/traits/trait.DataAvailabilityProvider.html -[next]: https://docs.rs/kona-derive/latest/kona_derive/traits/trait.DataAvailabilityProvider.html#tymethod.next +[dap]: https://docs.rs/kona-derive/latest/kona_derive/trait.DataAvailabilityProvider.html +[next]: https://docs.rs/kona-derive/latest/kona_derive/trait.DataAvailabilityProvider.html#tymethod.next [builder]: https://docs.rs/kona-derive/latest/kona_derive/struct.PipelineBuilder.html [alloy]: https://github.com/alloy-rs/alloy [kda]: https://crates.io/crates/kona-derive-alloy [chain-provider]: https://docs.rs/kona-derive/latest/kona_derive/trait.ChainProvider.html [l2-chain-provider]: https://docs.rs/kona-derive/latest/kona_derive/trait.L2ChainProvider.html -[dap]: https://docs.rs/kona-derive/latest/kona_derive/traits/trait.DataAvailabilityProvider.html +[dap]: https://docs.rs/kona-derive/latest/kona_derive/trait.DataAvailabilityProvider.html diff --git a/docs/docs/pages/sdk/protocol/derive/signaling.mdx b/docs/docs/pages/sdk/protocol/derive/signaling.mdx index 4ff8c71741..9376d775e9 100644 --- a/docs/docs/pages/sdk/protocol/derive/signaling.mdx +++ b/docs/docs/pages/sdk/protocol/derive/signaling.mdx @@ -148,8 +148,8 @@ impl SignalReceiver for IndexedTraversal { [traversal]: https://docs.rs/kona-derive/latest/kona_derive/struct.IndexedTraversal.html [dp]: https://docs.rs/kona-derive/latest/kona_derive/struct.DerivationPipeline.html -[stages]: https://docs.rs/kona-derive/latest/kona_derive/stages/index.html -[receiver]: https://docs.rs/kona-derive/latest/kona_derive/traits/trait.SignalReceiver.html -[signal]: https://docs.rs/kona-derive/latest/kona_derive/traits/enum.Signal.html -[error-kind]: https://docs.rs/kona-derive/latest/kona_derive/errors/enum.PipelineErrorKind.html -[step-result]: https://docs.rs/kona-derive/latest/kona_derive/traits/enum.StepResult.html +[stages]: https://docs.rs/kona-derive/latest/kona_derive/index.html +[receiver]: https://docs.rs/kona-derive/latest/kona_derive/trait.SignalReceiver.html +[signal]: https://docs.rs/kona-derive/latest/kona_derive/enum.Signal.html +[error-kind]: https://docs.rs/kona-derive/latest/kona_derive/enum.PipelineErrorKind.html +[step-result]: https://docs.rs/kona-derive/latest/kona_derive/enum.StepResult.html diff --git a/docs/docs/pages/sdk/protocol/derive/stages.mdx b/docs/docs/pages/sdk/protocol/derive/stages.mdx index c4b868c53d..6a0ef304ef 100644 --- a/docs/docs/pages/sdk/protocol/derive/stages.mdx +++ b/docs/docs/pages/sdk/protocol/derive/stages.mdx @@ -104,8 +104,8 @@ DapRetrieval> [intro]: ./intro.md [dp]: https://docs.rs/kona-derive/latest/kona_derive/struct.DerivationPipeline.html -[retrieval-provider]: https://docs.rs/kona-derive/latest/kona_derive/stages/trait.L1RetrievalProvider.html -[frame-queue-provider]: https://docs.rs/kona-derive/latest/kona_derive/stages/trait.FrameQueueProvider.html +[retrieval-provider]: https://docs.rs/kona-derive/latest/kona_derive/trait.L1RetrievalProvider.html +[frame-queue-provider]: https://docs.rs/kona-derive/latest/kona_derive/trait.FrameQueueProvider.html [frame-queue]: https://docs.rs/kona-derive/latest/kona_derive/struct.FrameQueue.html [retrieval]: https://docs.rs/kona-derive/latest/kona_derive/struct.L1Retrieval.html From 50ee10d8bddb58c6fb39b507e4a8a96faeb34b10 Mon Sep 17 00:00:00 2001 From: Emilia Hane Date: Mon, 18 Aug 2025 17:52:24 +0200 Subject: [PATCH 37/47] Exclude all change logs --- .github/workflows/rust_ci.yaml | 2 +- lychee.toml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/rust_ci.yaml b/.github/workflows/rust_ci.yaml index d256c55eee..8beeb310cf 100644 --- a/.github/workflows/rust_ci.yaml +++ b/.github/workflows/rust_ci.yaml @@ -269,4 +269,4 @@ jobs: - uses: actions/checkout@v5 - uses: lycheeverse/lychee-action@v2 with: - args: --config ./lychee.toml '**/*.md' '**/*.mdx' '**/*.html' + args: --config ./lychee.toml --cache-exclude-status 429 --suggest '**/*.md' '**/*.mdx' '**/*.html' diff --git a/lychee.toml b/lychee.toml index 22de01f5cc..e27616312f 100644 --- a/lychee.toml +++ b/lychee.toml @@ -13,5 +13,5 @@ exclude = [ # Files or directories to exclude exclude_path = [ - 'CHANGELOG.md' + '**/CHANGELOG.md' ] \ No newline at end of file From eda86aeda51b26b073c2c79b03046cd02c14b7c5 Mon Sep 17 00:00:00 2001 From: Emilia Hane Date: Mon, 18 Aug 2025 18:12:38 +0200 Subject: [PATCH 38/47] fixup! Exclude all change logs --- lychee.toml | 1 + 1 file changed, 1 insertion(+) diff --git a/lychee.toml b/lychee.toml index e27616312f..d4619e2f8f 100644 --- a/lychee.toml +++ b/lychee.toml @@ -13,5 +13,6 @@ exclude = [ # Files or directories to exclude exclude_path = [ + 'CHANGELOG.md', '**/CHANGELOG.md' ] \ No newline at end of file From 0225ce901271d6a5d161d8f1e236de2017213475 Mon Sep 17 00:00:00 2001 From: Emilia Hane Date: Mon, 18 Aug 2025 18:19:17 +0200 Subject: [PATCH 39/47] Fix link --- docs/docs/pages/sdk/proof/custom-backend.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/pages/sdk/proof/custom-backend.mdx b/docs/docs/pages/sdk/proof/custom-backend.mdx index 4edf5b6b4c..bd93731fcf 100644 --- a/docs/docs/pages/sdk/proof/custom-backend.mdx +++ b/docs/docs/pages/sdk/proof/custom-backend.mdx @@ -94,7 +94,7 @@ Before getting started, we need to create custom implementations of the followin | Trait | Description | | ------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [`TrieProvider`](https://docs.rs/kona-mpt/latest/kona_mpt/trait.TrieProvider.html) | The `TrieProvider` trait describes the interface for fetching trie node preimages and chain information while executing a payload on the L2 chain. | -| [`TrieDBHinter`](https://docs.rs/kona-mpt/latest/kona_mpt/trait.TrieDBHinter.html) | The `TrieDBHinter` trait describes the interface for requesting the host program to prepare trie proof preimages for the client's consumption. For targets with upfront witness generation, i.e. zkVMs, a no-op hinter is exported as [`NoopTrieHinter`](https://docs.rs/kona-mpt/latest/kona_mpt/struct.NoopTrieHinter.html). | +| [`TrieDBHinter`](https://docs.rs/kona-mpt/latest/kona_mpt/trait.TrieHinter.html) | The `TrieDBHinter` trait describes the interface for requesting the host program to prepare trie proof preimages for the client's consumption. For targets with upfront witness generation, i.e. zkVMs, a no-op hinter is exported as [`NoopTrieHinter`](https://docs.rs/kona-mpt/latest/kona_mpt/struct.NoopTrieHinter.html). | Once we have those, the `StatelessL2BlockExecutor` can be constructed like so: From 530cf7dde11e7dca3652c112da973832d0f00204 Mon Sep 17 00:00:00 2001 From: Emilia Hane Date: Mon, 18 Aug 2025 19:05:22 +0200 Subject: [PATCH 40/47] fixup! fixup! Exclude all change logs --- lychee.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lychee.toml b/lychee.toml index d4619e2f8f..c0afeb6197 100644 --- a/lychee.toml +++ b/lychee.toml @@ -13,6 +13,6 @@ exclude = [ # Files or directories to exclude exclude_path = [ - 'CHANGELOG.md', + './CHANGELOG.md', '**/CHANGELOG.md' ] \ No newline at end of file From bf73f1df4c8783f1f7da7a34e0650c2bd8f247ba Mon Sep 17 00:00:00 2001 From: Emilia Hane Date: Tue, 19 Aug 2025 17:40:45 +0200 Subject: [PATCH 41/47] Try exclude change log via args --- .github/workflows/rust_ci.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/rust_ci.yaml b/.github/workflows/rust_ci.yaml index 8beeb310cf..c030f59513 100644 --- a/.github/workflows/rust_ci.yaml +++ b/.github/workflows/rust_ci.yaml @@ -269,4 +269,4 @@ jobs: - uses: actions/checkout@v5 - uses: lycheeverse/lychee-action@v2 with: - args: --config ./lychee.toml --cache-exclude-status 429 --suggest '**/*.md' '**/*.mdx' '**/*.html' + args: --config ./lychee.toml --cache-exclude-status 429 --exclude-path '**/CHANGELOG.md' '**/*.md' '**/*.mdx' '**/*.html' From 0edb220cf6da90b9be1296d0b6e74af99ffd53b3 Mon Sep 17 00:00:00 2001 From: Emilia Hane Date: Wed, 20 Aug 2025 12:54:32 +0200 Subject: [PATCH 42/47] fixup! Try exclude change log via args --- .github/workflows/rust_ci.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/rust_ci.yaml b/.github/workflows/rust_ci.yaml index c030f59513..d10fccd62e 100644 --- a/.github/workflows/rust_ci.yaml +++ b/.github/workflows/rust_ci.yaml @@ -269,4 +269,4 @@ jobs: - uses: actions/checkout@v5 - uses: lycheeverse/lychee-action@v2 with: - args: --config ./lychee.toml --cache-exclude-status 429 --exclude-path '**/CHANGELOG.md' '**/*.md' '**/*.mdx' '**/*.html' + args: --cache-exclude-status 429 --config ./lychee.toml \ No newline at end of file From 643e39e6374534d85c363f3ad3c683505ecb7316 Mon Sep 17 00:00:00 2001 From: Emilia Hane Date: Wed, 20 Aug 2025 13:01:35 +0200 Subject: [PATCH 43/47] fixup! Try exclude change log via args --- .github/workflows/rust_ci.yaml | 2 +- lychee.toml | 9 ++------- 2 files changed, 3 insertions(+), 8 deletions(-) diff --git a/.github/workflows/rust_ci.yaml b/.github/workflows/rust_ci.yaml index d10fccd62e..def1f26046 100644 --- a/.github/workflows/rust_ci.yaml +++ b/.github/workflows/rust_ci.yaml @@ -269,4 +269,4 @@ jobs: - uses: actions/checkout@v5 - uses: lycheeverse/lychee-action@v2 with: - args: --cache-exclude-status 429 --config ./lychee.toml \ No newline at end of file + args: --cache-exclude-status 429 --config ./lychee.toml '**/README.md' './docs/**/*.md' diff --git a/lychee.toml b/lychee.toml index c0afeb6197..77017abd10 100644 --- a/lychee.toml +++ b/lychee.toml @@ -8,11 +8,6 @@ exclude_all_private = false exclude = [ 'foo.bar', - 'localhost' -] - -# Files or directories to exclude -exclude_path = [ - './CHANGELOG.md', - '**/CHANGELOG.md' + 'localhost', + '^https://github\.com/op-rs/kona/pull/' ] \ No newline at end of file From 969ac6b22d76a32fdd0173ac3428de927790f4ed Mon Sep 17 00:00:00 2001 From: Emilia Hane Date: Wed, 20 Aug 2025 13:07:32 +0200 Subject: [PATCH 44/47] Try fix check mdx files again --- .github/workflows/rust_ci.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/rust_ci.yaml b/.github/workflows/rust_ci.yaml index def1f26046..18d096b436 100644 --- a/.github/workflows/rust_ci.yaml +++ b/.github/workflows/rust_ci.yaml @@ -269,4 +269,4 @@ jobs: - uses: actions/checkout@v5 - uses: lycheeverse/lychee-action@v2 with: - args: --cache-exclude-status 429 --config ./lychee.toml '**/README.md' './docs/**/*.md' + args: --cache-exclude-status 429 --config ./lychee.toml '**/README.md' './docs/**/*' From ff4ee5653df878bde93627bb912763413b5ab612 Mon Sep 17 00:00:00 2001 From: Emilia Hane Date: Wed, 20 Aug 2025 13:56:59 +0200 Subject: [PATCH 45/47] Read only markup and html files --- .github/workflows/rust_ci.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/rust_ci.yaml b/.github/workflows/rust_ci.yaml index 18d096b436..adb106c7e6 100644 --- a/.github/workflows/rust_ci.yaml +++ b/.github/workflows/rust_ci.yaml @@ -269,4 +269,4 @@ jobs: - uses: actions/checkout@v5 - uses: lycheeverse/lychee-action@v2 with: - args: --cache-exclude-status 429 --config ./lychee.toml '**/README.md' './docs/**/*' + args: --config ./lychee.toml --cache-exclude-status 429 '**/README.md' './docs/**/*.md' './docs/**/*.html' From 0f52d735303abdfe27b5ef7a3a2e51a80c149e04 Mon Sep 17 00:00:00 2001 From: Emilia Hane Date: Wed, 20 Aug 2025 14:00:39 +0200 Subject: [PATCH 46/47] Read mdx files --- .github/workflows/rust_ci.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/rust_ci.yaml b/.github/workflows/rust_ci.yaml index adb106c7e6..7906e3ae45 100644 --- a/.github/workflows/rust_ci.yaml +++ b/.github/workflows/rust_ci.yaml @@ -269,4 +269,4 @@ jobs: - uses: actions/checkout@v5 - uses: lycheeverse/lychee-action@v2 with: - args: --config ./lychee.toml --cache-exclude-status 429 '**/README.md' './docs/**/*.md' './docs/**/*.html' + args: --config ./lychee.toml --cache-exclude-status 429 '**/README.md' './docs/**/*.md' './docs/**/*.mdx' './docs/**/*.html' './docs/**/*.com' From f4cac17f4eaf5b8ad9183cef8a1ee7fabb5c3f1f Mon Sep 17 00:00:00 2001 From: Emilia Hane Date: Wed, 20 Aug 2025 14:08:08 +0200 Subject: [PATCH 47/47] Add code comment --- lychee.toml | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/lychee.toml b/lychee.toml index 77017abd10..903446ae72 100644 --- a/lychee.toml +++ b/lychee.toml @@ -10,4 +10,7 @@ exclude = [ 'foo.bar', 'localhost', '^https://github\.com/op-rs/kona/pull/' -] \ No newline at end of file +] + +# exclude_path values are ignored if cli is glob pattern that matches +# this list, at least in lycheeverse/lychee-action@v2 \ No newline at end of file