Merge branch 'main' into interop-ideas

Author: bradleycamacho

.circleci/config.yml

@@ -1,6 +1,6 @@
 version: 2.1
 orbs:
-  utils: ethereum-optimism/circleci-utils@0.0.7
+  utils: ethereum-optimism/circleci-utils@1.0.13
 
 executors:
   node20:
@@ -64,6 +64,7 @@ jobs:
       - run:
           name: Run breadcrumb check
           command: pnpm check-breadcrumbs
+          
   lint:
     description: Lint Markdown files
     executor: ubuntu
@@ -75,39 +76,14 @@ jobs:
           command: pnpm lint
 
   links:
-    executor: rust
+    description: Check broken links in documentation
+    executor: ubuntu
     steps:
-      - checkout:
-          path: docs
-      - run:
-          name: Checkout lycheeverse/lychee
-          command: |
-            git clone https://github.com/lycheeverse/lychee.git lychee
-
-      - restore_cache:
-          keys:
-            - v1-rust-cache-{{ checksum "lychee/Cargo.lock" }}
-            - v1-rust-cache-
-
-      - run:
-          name: Build Lychee
-          command: |
-            cd lychee
-            cargo build --release
-
-      - save_cache:
-          key: v1-rust-cache-{{ checksum "lychee/Cargo.lock" }}
-          paths:
-            - ~/.cargo/registry
-            - ~/.cargo/git
-            - lychee/target
-
+      - checkout
+      - setup-node
       - run:
-          name: Run Lychee link checker
-          command: |
-            export PATH=$PATH:$HOME/project/lychee/target/release
-            cd docs
-            lychee --config ./lychee.toml --quiet "./pages"
+          name: Run link checker
+          command: pnpm link-checker
 
   developer-metrics:
     description: Monthly Metrics Report
@@ -117,10 +93,6 @@ jobs:
         type: string
         default: $CIRCLE_PROJECT_USERNAME/$CIRCLE_PROJECT_REPONAME
     steps:
-      - utils/get-github-access-token:
-          private-key-str: GITHUB_APP_KEY
-          app-id: GITHUB_APP_ID
-          repo: << parameters.repo >>
       - run:
           name: Get Dates for Last Month
           command: |
@@ -133,21 +105,13 @@ jobs:
 
             # Export the last_month variable for subsequent steps
             echo "export LAST_MONTH=${first_day}..${last_day}" >> $BASH_ENV
-      - utils/generate-issue-metrics-file:
+      - utils/create-github-issue-from-search:
           SEARCH_QUERY: 'repo:ethereum-optimism/docs is:issue closed:${LAST_MONTH} -reason:\"not planned\" -label:monthly-report'
-          file-path: "./closed_issue_metrics.md"
-      - utils/create-github-issue-from-file:
-          repo: << parameters.repo >>
-          file-path: "./closed_issue_metrics.md"
           issue-title: "${LAST_MONTH} metrics report for closed issues"
           issue-labels: "monthly-report"
           assignees: "sbvegan"
-      - utils/generate-issue-metrics-file:
-          SEARCH_QUERY: "repo:ethereum-optimism/docs is:pr created:${LAST_MONTH}"
-          file-path: "./pr_issue_metrics.md"
-      - utils/create-github-issue-from-file:
-          repo: << parameters.repo >>
-          file-path: "./pr_issue_metrics.md"
+      - utils/create-github-issue-from-search:
+          SEARCH_QUERY: 'repo:ethereum-optimism/docs is:pr created:${LAST_MONTH}'
           issue-title: "${LAST_MONTH} metrics report for opened prs"
           issue-labels: "monthly-report"
           assignees: "sbvegan"
@@ -171,4 +135,4 @@ workflows:
       equal: [build_monthly, <<pipeline.schedule.name>>]
     jobs:
       - developer-metrics:
-          context: circleci-repo-docs
+          context: circleci-repo-docs

next.config.mjs

@@ -17,6 +17,32 @@ export default {
   eslint: {
     ignoreDuringBuilds: true,
   },
+  
+  async headers() {
+    return [
+      {
+        source: '/:path*',
+        headers: [
+          {
+            key: 'X-DNS-Prefetch-Control',
+            value: 'on'
+          },
+          {
+            key: 'Strict-Transport-Security',
+            value: 'max-age=31536000; includeSubDomains; preload'
+          },
+          {
+            key: 'X-Content-Type-Options',
+            value: 'nosniff'
+          },
+          {
+            key: 'X-Frame-Options',
+            value: 'DENY'
+          }
+        ],
+      },
+    ]
+  },
 
   // Don't put redirects here
   // they go in public/_redirects

package.json

@@ -3,13 +3,13 @@
   "version": "0.0.1",
   "description": "Optimism Docs",
   "scripts": {
-    "lint": "eslint . --ext mdx --max-warnings 0 && pnpm spellcheck:lint && pnpm check-breadcrumbs && pnpm check-redirects",
+    "lint": "eslint . --ext mdx --max-warnings 0 && pnpm spellcheck:lint && pnpm check-redirects && pnpm link-checker",
     "fix": "eslint . --ext mdx --fix && pnpm spellcheck:fix && pnpm breadcrumbs && pnpm fix-redirects",
     "spellcheck:lint": "cspell lint \"**/*.mdx\"",
     "spellcheck:fix": "cspell --words-only --unique \"**/*.mdx\" | sort --ignore-case | uniq > words.txt",
-    "linkcheck": "lychee --config ./lychee.toml --quiet \"./pages\"",
     "breadcrumbs": "npx ts-node --skip-project utils/create-breadcrumbs.ts",
     "check-redirects": "npx ts-node --skip-project utils/redirects.ts",
+    "link-checker": "npx ts-node --skip-project utils/link-checker.ts",
     "fix-redirects": "npx ts-node --skip-project utils/fix-redirects.ts",
     "check-breadcrumbs": "npx ts-node --skip-project utils/breadcrumbs.ts",
     "index:docs": "npx ts-node --skip-project utils/algolia-indexer.ts",

pages/app-developers/tools/connect/rpc-providers.mdx

@@ -103,7 +103,7 @@ GetBlock offers Pay-as-You-Go flexible pricing based on actual usage, suitable f
 
 [Infura](https://infura.io) is a Web3 infrastructure provider that offers free access to hosted [OP Mainnet and testnet nodes](https://docs.infura.io/infura/networks/optimism), with the option to upgrade to [paid plans](https://www.infura.io/pricing) for more features. With Infura's highly performant Optimism node infrastructure, developers can eliminate the need for syncing or complex setups and get reliable and consistent access to the Optimism blockchain.
 
-[Sign up for a free Infura account here](https://app.infura.io/register)
+[Sign up for a free Infura account here](https://developer.metamask.io/register)
 
 ### Supported networks
 

pages/app-developers/tools/supersim.mdx

@@ -56,6 +56,9 @@ This diagram illustrates how developers interact with Supersim through the CLI,
 
 ## Next steps
 
+*   Build a [revolutionary app](/app-developers/get-started) that uses multiple blockchains within the Superchain
+*   Deploy a [SuperchainERC20](/stack/interop/tutorials/deploy-superchain-erc20) to the Superchain
+*   View more [interop tutorials](/stack/interop/tutorials)
 *   Check out the collection of [Supersim docs](/app-developers/tutorials/supersim) for tutorials and specific use cases.
 *   Questions about Interop? Check out our collection of [interop guides](/stack/interop) or check out this [Superchain interop design video walk-thru](https://www.youtube.com/watch?v=FKc5RgjtGes).
 *   For more info about how Superchain interoperability works under the hood, [check out the specs](https://specs.optimism.io/interop/overview.html).

pages/app-developers/tutorials/supersim/chain-env/included-contracts.mdx

@@ -8,7 +8,7 @@ import { Callout, Steps } from 'nextra/components'
 
 # Included contracts
 
-The `supersim` chain environment includes contracts already deployed to help replicate the Superchain environment. See [OP Chain A](op-chain-a) for contract address examples for a L2 system.
+The `supersim` chain environment includes contracts already deployed to help replicate the Superchain environment. See [OP Chain A](./chain-a) for contract address examples for a L2 system.
 
 ## OP Stack system contracts (L1)
 

pages/connect/contribute/style-guide.mdx

@@ -292,7 +292,7 @@ Developers trust that we will lead them to sites or pages related to their readi
 
 *   Use anchor links, whenever possible, to guide users to a specific page and location in the technical documentation. This reduces cognitive load and improves overall usability.
 
-*   To link to an anchor, such as an H3 tag within a page, you need to append it to the page name preceded by `#`, like this **example**: `[any descriptive text](/chain/getting-started/overview#test-your-application)`.
+*   To link to an anchor, such as an H3 tag within a page, you need to append it to the page name preceded by `#`, like this **example**: `[any descriptive text](/stack/interop/tutorials/deploy-superchain-erc20)`.
 
 ### Linking across pages
 

pages/notices/holocene-changes.mdx

@@ -18,8 +18,6 @@ If you experience difficulty at any stage of this process, please reach out to [
 
   The Holocene upgrade for the Soneium Minato (Sepolia) will be activated at **Fri Dec 20 at 09:00:00 UTC** (`1734685200`).
 
-  The Holocene upgrade for the Soneium Minato (Sepolia) will be activated at **Fri Dec 20 at 09:00:00 UTC** (`1734685200`).
-
   The Holocene upgrade for the Mainnet Superchain is scheduled for **Thu 9 Jan 2025 18:00:01 UTC**, [governance approval](https://vote.optimism.io/proposals/20127877429053636874064552098716749508236019236440427814457915785398876262515).
 
   The Holocene upgrade for the Soneium Mainnet will be activated at **Mon Feb 03 at 09:00:00 UTC** (`1738573200`).

pages/notices/pectra-changes.mdx

@@ -50,7 +50,7 @@ Node operators will need to upgrade to the respective releases before the activa
   Full node operators, meaning those who are running op-geth with `gc-mode=full`, will need to reference the [`op-geth v1.101411.8`release notes](https://github.com/ethereum-optimism/op-geth/releases/tag/v1.101411.8) to handle an intermediate upgrade step before upgrading to the latest release. Archive node operators, `gc-mode=archive`, can skip this step and upgrade directly to the latest release.
 </Callout>
 
-*   `op-node` at [`v1.11.0`](https://github.com/ethereum-optimism/optimism/releases/tag/op-node%2Fv1.11.0)
+*   `op-node` at [`v1.11.1`](https://github.com/ethereum-optimism/optimism/releases/tag/op-node%2Fv1.11.1)
 *   `op-geth` at [`v1.101500.0`](https://github.com/ethereum-optimism/op-geth/releases/tag/v1.101500.0)
 *   `op-reth` at [`v1.1.5`](https://github.com/paradigmxyz/reth/releases/tag/v1.1.5) also includes L1 Pectra support.
 
@@ -74,7 +74,7 @@ The following sections are how chain operators can prepare the first part of the
 ## For fault proof enabled chains
 
 <Callout type="info">
-  The following instructions assume your chain is on the latest contract release `op-contracts/v1.8.0` and have Holocene activated.
+  The following instructions assume your chain is on the latest contract release `op-contracts/v1.8.0` and has Holocene activated.
 </Callout>
 
 The following steps are to update your absolute prestate with new dispute game contracts. **This is absolutely necessary for chains running permissionless fault proofs.** For chains running the Fault Proof System with permissioned games you can skip this section because games will not be played out and the absolute prestate is not used. 
@@ -91,8 +91,8 @@ The Pectra upgrade changes the derivation rules, permissionless fault proof chai
 
   The absolute prestate is generated with the [op-program/v1.5.0-rc.2](https://github.com/ethereum-optimism/optimism/tree/op-program/v1.5.0-rc.2). You can use this new absolute prestate (`0x035ac388b5cb22acf52a2063cfde108d09b1888655d21f02f595f9c3ea6cbdcd`) for the following chains:
 
-  *   Sepolia: Base, OP, Metal, Mode, Zora, Ethernity, Unichain, Ink
-  *   Mainnet: Base, OP, Orderly, Lyra, Metal, Mode, Zora, Lisk, Ethernity, Binary, Ink, Unichain
+  *   Sepolia: Base, OP, Metal, Mode, Zora, Ethernity, Unichain, Ink, Minato (Soneium)
+  *   Mainnet: Base, OP, Orderly, Lyra, Metal, Mode, Zora, Lisk, Ethernity, Binary, Ink, Unichain, Soneium
 
   You can verify this absolute prestate by running the following [command](https://github.com/ethereum-optimism/optimism/blob/3f18df1c8a502136bbe33f10ed1e29a26cd4678a/Makefile#L129-L131) in the root of the monorepo on the `op-program/v1.5.0-rc.2` tag:
 

pages/operators/chain-operators/configuration/batcher.mdx

@@ -90,7 +90,7 @@ You can use [this calculator](https://docs.google.com/spreadsheets/d/12VIiXHaVEC
 
 ### Set your `--batch-type=1` to use span batches
 
-Span batches reduce the overhead of OP Stack chains, introduced in Delta network upgrade. This is beneficial for sparse and low-throughput OP Stack chains.
+Span batches reduce the overhead of OP Stack chains, introduced in the Delta network upgrade. This is beneficial for sparse and low-throughput OP Stack chains.
 
 The overhead is reduced by representing a span of consecutive L2 blocks in a more efficient manner, while preserving the same consistency checks as regular batch data.
 

pages/operators/chain-operators/deploy/genesis.mdx

@@ -57,7 +57,7 @@ This command:
 
 ### Step 2: Generate your L2 genesis file and rollup file
 
-After your L1 contracts have been deployed, generate the L2 genesis and rollup configuration files by inspecting the deployer's `state.json.`
+After your L1 contracts have been deployed, generate the L2 genesis and rollup configuration files by inspecting the deployer's `state.json`
 
 ```bash
 ./bin/op-deployer inspect genesis --workdir .deployer <L2_CHAIN_ID> > .deployer/genesis.json

pages/operators/chain-operators/features/alt-da-mode.mdx

@@ -43,7 +43,7 @@ You should use at least the following compatible op\* versions when running your
 
   *   Celestia's docs on how to run the [Celestia DA server](https://github.com/celestiaorg/op-plasma-celestia/blob/main/README.md)
   *   EigenDA's docs on how to run the [EigenDA DA server](https://github.com/Layr-Labs/op-plasma-eigenda/blob/main/README.md)
-  *   Avail's docs on how to run the [AvailDA DA Server](https://docs.availproject.org/docs/build-with-avail/Optimium/op-stack/op-stack#setup-avail-da-server)
+  *   Avail's docs on how to run the [AvailDA DA Server](https://docs.availproject.org/docs/build-with-avail/deploy-rollup-on-avail/Optimium)
   *   0gDA's docs on how to run the [0gDA DA Server](https://github.com/0glabs/0g-da-op-plasma)
   *   Near DA's docs on how to run the [Near DA Server](https://github.com/Nuffle-Labs/data-availability/blob/84b484de98f58a91bf12c8abe8df27f5e753f63a/docs/OP-Alt-DA.md)
 
@@ -123,7 +123,7 @@ Alt DA teams who want to be featured on this page must meet the following criter
 This feature has been renamed from Plasma Mode to Alt-DA Mode in the monorepo at: [0bb2ff5](https://github.com/ethereum-optimism/optimism/commit/0bb2ff57c8133f1e3983820c0bf238001eca119b). There are several breaking changes you should be aware of. These include changes to configuration file parameters, environment variables, and CLI commands.
 Before proceeding with the migration, ensure you are using [OP Stack v1.9.1](https://github.com/ethereum-optimism/optimism/releases/tag/v1.9.1) or later.
 
-### Modify `rollup.json` config:
+### Modify `rollup.json` config
 
 Update your `rollup.json` configuration file by replacing the old Plasma config with the new Alt-DA config.
 There are two possible formats for the old Plasma config:

pages/operators/chain-operators/management/blobs.mdx

@@ -86,7 +86,7 @@ This guide walks you through how to switch to using blobs for your chain after E
 
   *   Configure `OP_BATCHER_DATA_AVAILABILITY_TYPE=blobs`. The batcher will have to be restarted for it to take effect.
   *   Ensure your `OP_BATCHER_MAX_CHANNEL_DURATION` is properly set to maximize your fee savings. See [OP Batcher Max Channel Configuration](/operators/chain-operators/configuration/batcher#set-your--op_batcher_max_channel_duration) for more details.
-  *   Optionally, you can configure your batcher to support multi-blobs. See [Multi-Blob Batcher Configuration](/operators/chain-operators/configuration/batcher#configure-your-multi-blob-batcher) for more details. 
+  *   Optionally, you can configure your batcher to support multi-blobs. See [Multi-Blob Batcher Configuration](/operators/chain-operators/configuration/batcher#configure-your-batcher-to-use-multiple-blobs) for more details. 
 </Steps>
 
 ## Switch back to using calldata

pages/operators/chain-operators/management/troubleshooting.mdx

@@ -44,7 +44,7 @@ WARN [02-16|21:22:02.868] Derivation process temporary error       attempts=14 e
 This error can occur when the data directory for `op-geth` becomes corrupted (for example, as a result of a computer crash).
 You will need to reinitialize the data directory.
 
-If you are following the tutorial for [Creating Your Own L2 Rollup](../tutorials/create-l2-rollup), make sure to rerun the commands within the [Initialize `op-geth`](../tutorials/create-l2-rollup#initialize-op-geth) section.
+If you are following the tutorial for [Creating Your Own L2 Rollup](/operators/chain-operators/tutorials/create-l2-rollup), make sure to rerun the commands within the [Initialize `op-geth`](/operators/chain-operators/tutorials/create-l2-rollup#initialize-op-geth) section.
 
 If you are not following the tutorial, make sure to take the following steps:
 

pages/operators/chain-operators/tools/op-txproxy.mdx

@@ -37,7 +37,7 @@ Even though the op-geth implementation of this endpoint includes rate limits, it
 
 *   Conditional cost is below the max
 *   Conditional values are valid (i.e min \< max)
-*   Transaction target are only 4337 Entrypoint contracts
+*   Transaction targets are only 4337 Entrypoint contracts
 
 <Callout type="info">
   The motivating factor for this endpoint is to enable permissionless 4337 mempools, hence the restricted usage of this methods to just [Entrypoint](https://github.com/eth-infinitism/account-abstraction/blob/develop/contracts/core/EntryPoint.sol) transactions.

pages/operators/chain-operators/tutorials/create-l2-rollup.mdx

@@ -765,4 +765,4 @@ Send some transactions, deploy some contracts, and see what happens!
 ## Next steps
 
 *   Check out the [protocol specs](https://specs.optimism.io/) for more detail about the rollup protocol.
-*   If you run into any problems, please visit the [Chain Operators Troubleshooting Guide](../management/troubleshooting) for help.
+*   If you run into any problems, please visit the [Chain Operators Troubleshooting Guide](/operators/chain-operators/management/troubleshooting) for help.

pages/operators/node-operators/json-rpc.mdx

@@ -995,5 +995,5 @@ todo: add Sample success output
 
 `op-geth` implements the Execution-Layer, with minimal changes for a secure Ethereum-equivalent application environment.
 
-The execution engine's RPC interface is identical to [the upstream Geth RPC interface](https://geth.ethereum.org/docs/rpc/server). The responses are nearly identical too, except we also include the L1 gas usage and price information.
+The execution engine's RPC interface is identical to [the upstream Geth RPC interface](https://geth.ethereum.org/docs/interacting-with-geth/rpc). The responses are nearly identical too, except we also include the L1 gas usage and price information.
 

pages/operators/node-operators/management/blobs.mdx

@@ -69,7 +69,7 @@ These will need to be set on `op-node` and `op-geth` for the sequencer and all o
 
 </Steps>
 
-## Configure a blob archiver (archive nodes)
+## Configure a blob archiver
 
 There is a configurable `beacon-archiver` that will allow nodes to sync blob data that is older than 18 days - after blobs are 18 days old, normal beacon nodes will  "prune" or remove them. If your node is already in sync with the head of the chain, you won't need to use a `beacon-archiver`.