diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index c393b8b88..a2e119f21 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1,13 +1,2 @@ -* @ethereum-optimism/docs-reviewers - -# Giving Node Squad review privileges to the following sections -/pages/builders/chain-operators/ @ethereum-optimism/docs-reviewers @ethereum-optimism/node-squad -/pages/chain/ @ethereum-optimism/docs-reviewers @ethereum-optimism/node-squad -/pages/stack/ @ethereum-optimism/docs-reviewers @ethereum-optimism/node-squad - -# Giving Marine privileges to review RPC providers and block explorers -/pages/builders/tools/connect/rpc-providers.mdx @ethereum-optimism/docs-reviewers @0xmariniere -/pages/builders/tools/build/block-explorers.mdx @ethereum-optimism/docs-reviewers @0xmariniere - -# Giving Binji privileges to review NFT tools -/pages/builders/tools/build/nft-tools.mdx @ethereum-optimism/docs-reviewers @binjix23 +# Code reviewers +* @squdgy @paulgnz \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/general_docs_request.md b/.github/ISSUE_TEMPLATE/general_docs_request.md index 46b840393..2e979177f 100644 --- a/.github/ISSUE_TEMPLATE/general_docs_request.md +++ b/.github/ISSUE_TEMPLATE/general_docs_request.md @@ -1,6 +1,6 @@ --- name: General docs request -about: Template for general documentation requests from the Optimism Collective +about: Template for general documentation requests for the Metal L2 docs title: "[DOCS] Add PR title" labels: 'community-request,documentation' @@ -20,4 +20,4 @@ Provide links to any related content pages for this documentation request. This ## Additional Context Provide any additional context about this documentation request. What problems did you run into that caused you to make this request? -Which existing documentation pages did you already try as a solution to your problem? Why do you think the requested page(s) will be beneficial to developers in the Optimism Collective? +Which existing documentation pages did you already try as a solution to your problem? Why do you think the requested page(s) will be beneficial to developers working with Metal L2? diff --git a/.github/ISSUE_TEMPLATE/suggest_attestation.yaml b/.github/ISSUE_TEMPLATE/suggest_attestation.yaml index 502aafe7d..c150f4fe4 100644 --- a/.github/ISSUE_TEMPLATE/suggest_attestation.yaml +++ b/.github/ISSUE_TEMPLATE/suggest_attestation.yaml @@ -6,7 +6,7 @@ body: - type: markdown attributes: value: | - Before submitting this suggestion, be sure to read the [listing of current attestation apps](https://docs.optimism.io/identity/applications). + Before submitting this suggestion, be sure to read the [listing of current attestation apps](https://docs.metall2.com/identity/applications). - type: markdown id: project_info attributes: diff --git a/.github/ISSUE_TEMPLATE/suggest_faq_item.yaml b/.github/ISSUE_TEMPLATE/suggest_faq_item.yaml index cb07e9acd..ec92f5c05 100644 --- a/.github/ISSUE_TEMPLATE/suggest_faq_item.yaml +++ b/.github/ISSUE_TEMPLATE/suggest_faq_item.yaml @@ -6,7 +6,7 @@ body: - type: markdown attributes: value: | - Before submitting this suggestion, be sure to read our expectations for [FAQ content](https://docs.optimism.io/contribute/style-guide#faqs).
For an example FAQ guide with question+answer pairs, see [Security Model FAQ](https://docs.optimism.io/security/faq#security-model-faq). + Before submitting this suggestion, be sure to read our expectations for [FAQ content](https://docs.metall2.com/contribute/style-guide#faqs).
For an example FAQ guide with question+answer pairs, see [Security Model FAQ](https://docs.metall2.com/security/faq#security-model-faq). - type: markdown id: project_info attributes: @@ -26,7 +26,7 @@ body: id: faq_where_should_it_live attributes: label: What page will this FAQ item live? - description: list the page where the FAQ (question + answer) would be most relevant on docs.optimism.io + description: list the page where the FAQ (question + answer) would be most relevant on docs.metall2.com validations: required: true - type: textarea diff --git a/.github/ISSUE_TEMPLATE/suggest_glossary_term.yaml b/.github/ISSUE_TEMPLATE/suggest_glossary_term.yaml index 0302b4e1a..09ef52483 100644 --- a/.github/ISSUE_TEMPLATE/suggest_glossary_term.yaml +++ b/.github/ISSUE_TEMPLATE/suggest_glossary_term.yaml @@ -6,7 +6,7 @@ body: - type: markdown attributes: value: | - Before suggesting a new glossary term or glossary term update, make sure you've read [glossary page](https://docs.optimism.io/resources/glossary). + Before suggesting a new glossary term or glossary term update, make sure you've read [glossary page](https://docs.metall2.com/resources/glossary). - type: markdown attributes: value: | diff --git a/.github/ISSUE_TEMPLATE/suggest_troubleshooting_item.yaml b/.github/ISSUE_TEMPLATE/suggest_troubleshooting_item.yaml index 287ed464d..f17083de7 100644 --- a/.github/ISSUE_TEMPLATE/suggest_troubleshooting_item.yaml +++ b/.github/ISSUE_TEMPLATE/suggest_troubleshooting_item.yaml @@ -6,7 +6,7 @@ body: - type: markdown attributes: value: | - Before submitting this suggestion, be sure to read our expectations for [troubleshooting content](https://docs.optimism.io/contribute/style-guide#troubleshooting-guides).
For an example troubleshooting guide with problem+solution pairs, see [Troubleshooting: L2 Rollup](https://docs.optimism.io/builders/chain-operators/management/troubleshooting). + Before submitting this suggestion, be sure to read our expectations for [troubleshooting content](https://docs.metall2.com/contribute/style-guide#troubleshooting-guides).
For an example troubleshooting guide with problem+solution pairs, see [Troubleshooting: L2 Rollup](https://docs.metall2.com/builders/chain-operators/management/troubleshooting). - type: markdown id: project_info attributes: @@ -26,7 +26,7 @@ body: id: troubleshooting_where_should_it_live attributes: label: What page will this troubleshooting item live? - description: list the page where the troubleshooting (problem + solution) would be most relevant on docs.optimism.io + description: list the page where the troubleshooting (problem + solution) would be most relevant on docs.metall2.com validations: required: true - type: textarea diff --git a/.github/ISSUE_TEMPLATE/suggest_tutorial.yaml b/.github/ISSUE_TEMPLATE/suggest_tutorial.yaml index f8259e873..5a2dc282a 100644 --- a/.github/ISSUE_TEMPLATE/suggest_tutorial.yaml +++ b/.github/ISSUE_TEMPLATE/suggest_tutorial.yaml @@ -6,7 +6,7 @@ body: - type: markdown attributes: value: | - We'll consider [our defined content types](https://docs.optimism.io/contribute/style-guide#content-types/) when reviewing the tutorial, so please take a look there first. + We'll consider [our defined content types](https://docs.metall2.com/contribute/style-guide#content-types/) when reviewing the tutorial, so please take a look there first. - type: markdown id: tutorial_info attributes: @@ -46,7 +46,7 @@ body: id: tutorial_hosted attributes: label: Hosted on Optimism.io or hosted elsewhere? - description: Let us know if you want your tutorial to be hosted on the docs.optimism.io website or if it is published elsewhere and you want us to link out to the tutorial + description: Let us know if you want your tutorial to be hosted on the docs.metall2.com website or if it is published elsewhere and you want us to link out to the tutorial options: - "Hosted on optimism.io" - "Hosted elsewhere" diff --git a/.github/workflows/links.yml b/.github/workflows/links.yml index 4461adada..cc4824d03 100644 --- a/.github/workflows/links.yml +++ b/.github/workflows/links.yml @@ -11,10 +11,10 @@ jobs: runs-on: ubuntu-latest steps: - - name: Checkout ethereum-optimism/docs + - name: Checkout MetalPay/metal-l2-docs uses: actions/checkout@v2 with: - repository: 'ethereum-optimism/docs' + repository: 'MetalPay/metal-l2-docs' path: 'docs' - name: Checkout lycheeverse/lychee diff --git a/.github/workflows/tutorials.yml b/.github/workflows/tutorials.yml deleted file mode 100644 index 74e8870c7..000000000 --- a/.github/workflows/tutorials.yml +++ /dev/null @@ -1,124 +0,0 @@ -name: Check Tutorials - -on: - workflow_dispatch: - schedule: - - cron: '0 0 * * *' # Runs at 00:00 UTC every day - -concurrency: - group: shared-tutorial-key - cancel-in-progress: false - -jobs: - cross-dom-bridge-erc20: - runs-on: ubuntu-latest - - steps: - - name: Check out code - uses: actions/checkout@v2 - - - name: Set up Node.js - uses: actions/setup-node@v2 - with: - node-version: '20.x' - - - name: Install pnpm - run: npm install -g pnpm - - - name: Install dependencies - run: pnpm install - - - name: Run tutorial - env: - TUTORIAL_PRIVATE_KEY: ${{ secrets.TUTORIAL_PRIVATE_KEY }} - run: - node ./public/tutorials/cross-dom-bridge-erc20.js - - - name: Notify Slack on failure - uses: ravsamhq/notify-slack-action@v2 - if: always() - with: - status: ${{ job.status }} - notify_when: "failure" - notification_title: "{workflow} has {status_message} (<{run_url}|view errors>)" - message_format: "{emoji} *{workflow}* {status_message} in <{repo_url}|{repo}>" - footer: "<{run_url}|View Run>" - mention_users_when: "failure,warnings" - env: - SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }} - - cross-dom-bridge-eth: - needs: cross-dom-bridge-erc20 - runs-on: ubuntu-latest - - steps: - - name: Check out code - uses: actions/checkout@v2 - - - name: Set up Node.js - uses: actions/setup-node@v2 - with: - node-version: '20.x' - - - name: Install pnpm - run: npm install -g pnpm - - - name: Install dependencies - run: pnpm install - - - name: Run tutorial - env: - TUTORIAL_PRIVATE_KEY: ${{ secrets.TUTORIAL_PRIVATE_KEY }} - run: - node ./public/tutorials/cross-dom-bridge-eth.js - - - name: Notify Slack on failure - uses: ravsamhq/notify-slack-action@v2 - if: always() - with: - status: ${{ job.status }} - notify_when: "failure" - notification_title: "{workflow} has {status_message} (<{run_url}|view errors>)" - message_format: "{emoji} *{workflow}* {status_message} in <{repo_url}|{repo}>" - footer: "<{run_url}|View Run>" - mention_users_when: "failure,warnings" - env: - SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }} - - sdk-estimate-costs: - needs: cross-dom-bridge-eth - runs-on: ubuntu-latest - - steps: - - name: Check out code - uses: actions/checkout@v2 - - - name: Set up Node.js - uses: actions/setup-node@v2 - with: - node-version: '20.x' - - - name: Install pnpm - run: npm install -g pnpm - - - name: Install dependencies - run: pnpm install - - - name: Run tutorial - env: - TUTORIAL_PRIVATE_KEY: ${{ secrets.TUTORIAL_PRIVATE_KEY }} - run: - node ./public/tutorials/sdk-estimate-costs.js - - - name: Notify Slack on failure - uses: ravsamhq/notify-slack-action@v2 - if: always() - with: - status: ${{ job.status }} - notify_when: "failure" - notification_title: "{workflow} has {status_message} (<{run_url}|view errors>)" - message_format: "{emoji} *{workflow}* {status_message} in <{repo_url}|{repo}>" - footer: "<{run_url}|View Run>" - mention_users_when: "failure,warnings" - env: - SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }} diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 26bf56263..d97c98c33 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,29 +1,29 @@ -# Contributing to Optimism Docs +# Contributing to Metal L2 Docs Thanks for taking the time to contribute! ❤️ -Optimism's documentation is open-source, hosted on GitHub in the `ethereum-optimism/docs` repository which renders on the corresponding official website hosted at [docs.optimism.io](https://docs.optimism.io). This guide will give you an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR. Please note that contributions, pull requests, and issues should be written in English at this time. We will be running a dedicated project in the future to add language support to the technical docs, so please reach out via our [developer support channel](https://github.com/ethereum-optimism/developers/) if you are interested in helping with that project. +Metal L2's documentation is open-source, hosted on GitHub in the `MetalPay/metal-l2-docs` repository which renders on the corresponding official website hosted at [docs.metall2.com](https://docs.metall2.com). This guide will give you an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR. Please note that contributions, pull requests, and issues should be written in English at this time. -The Optimism Documentation team reviews pull requests and either merges, requests changes, or comments and closes the pull request. You can open a documentation pull request by: +The Metal L2 Documentation team reviews pull requests and either merges, requests changes, or comments and closes the pull request. You can open a documentation pull request by: -- forking the `docs` repository and working locally, +- forking the `metal-l2-docs` repository and working locally, - or, for smaller updates, clicking the `Edit this page` link on the right side of any documentation page to directly edit in GitHub. -Contributing to the Optimism documentation implies 2 steps: +Contributing to the Metal L2 documentation implies 2 steps: -1. Learn how to use [Nextra](#learn-how-to-use-nextra), the tool used to write and generate Optimism's documentation. +1. Learn how to use [Nextra](#learn-how-to-use-nextra), the tool used to write and generate Metal L2's documentation. 2. [Submit a pull request](#send-pull-request) for review. ## Learn How to Use Nextra -Optimism's documentation is built with the React and Markdown-based [Nextra](https://nextra.site/docs) framework. We are using the docs theme (as opposed to the blog theme), which has specialized features. +Metal L2's documentation is built with the React and Markdown-based [Nextra](https://nextra.site/docs) framework. We are using the docs theme (as opposed to the blog theme), which has specialized features. -To start contributing to Optimism's documentation using Nextra, you need to understand the [files and branches architecture](#understand-file-architecture-and-branch-names) and use the proper [syntax to format content](#use-proper-formatting-and-syntax). Additionally, if you want to work locally from a repository fork, you should [set up the Nextra project](#set-up-the-project-and-test-locally) on your machine. +To start contributing to Metal L2's documentation using Nextra, you need to understand the [files and branches architecture](#understand-file-architecture-and-branch-names) and use the proper [syntax to format content](#use-proper-formatting-and-syntax). Additionally, if you want to work locally from a repository fork, you should [set up the Nextra project](#set-up-the-project-and-test-locally) on your machine. ### Understand File Architecture and Branch Names -Optimism's documentation includes two major sections with each section living in a different folder. +Metal L2's documentation includes two major sections with each section living in a different folder. | Section name | Target content | Folder | | ------------------| ----------------------------------------------------------------- | ----------------------------- | @@ -32,15 +32,15 @@ Optimism's documentation includes two major sections with each section living in **Warning** The `public` folder also stores the `robots.txt` and `sitemap.xml` files used for SEO. Please do not modify these pages. -The Optimism Documentation team will modify these pages, when necessary, after your PR is merged. +The Metal L2 Documentation team will modify these pages, when necessary, after your PR is merged. ### Use Proper Formatting and Syntax Nextra is MDX-based, meaning the content you write is [Markdown](https://daringfireball.net/projects/markdown/syntax) that accepts [React](https://reactjs.org/) components. -The Optimism Documentation team has created a complete style guide for you to make the best out of the various options available: +The Metal L2 Documentation team has created a complete style guide for you to make the best out of the various options available: -[Optimism Documentation Style Guide](/pages/connect/contribute/style-guide.mdx) +[Metal L2 Documentation Style Guide](/pages/connect/contribute/style-guide.mdx) ### Set Up the Project and Test Locally @@ -66,32 +66,32 @@ To prevent building issues upstream, you should build the content locally before - Try another `pnpm dev` and repeat until no issues are reported ("client" and "server compiled successfully"). -Your pull request should usually target the `main` branch, though the Optimism Documentation team might sometimes ask you to target another branch. +Your pull request should usually target the `main` branch, though the Metal L2 Documentation team might sometimes ask you to target another branch. To submit your contribution for review: -1. Create a new [pull request on GitHub](https://github.com/ethereum-optimism/docs/issues/new/choose). +1. Create a new [pull request on GitHub](https://github.com/MetalPay/metal-l2-docs/issues/new/choose). 2. Select a PR type from the list or choose **Open a blank issue** at the bottom of the page. 3. Complete the form as requested. For blank PR issues, please provide a clear title and accurate description/context. 4. Click the "Create pull request"button to create the pull request effectively. ->If your pull request is not ready for review yet, choose the "[Create draft pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)"in the dropdown. The Optimism documentation team will review your pull request only when you mark it as "[Ready for review](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request)". +>If your pull request is not ready for review yet, choose the "[Create draft pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)"in the dropdown. The Metal L2 documentation team will review your pull request only when you mark it as "[Ready for review](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request)". 5. Add GitHub labels for the pull request. Add `documentation` to all pull requests in this repo **AND** additional labels based on the type of update or request. - `tutorial`, `faq`, or `troubleshooting` for specific content types, - `oracle`, `rpc-provider`, `faucet`, or `attestation` for ecosystem offerings, - `user feedback` for general feedback about one or more pages, or - `bug` if something isn't working as expected. ->If label for type of update is not set, the Optimism Documentation team will set or update this for you
+>If label for type of update is not set, the Metal L2 Documentation team will set or update this for you
**Warning** -Approved pull requests are usually merged immediately into the `main` branch, automatically triggering a deployment on docs.optimism.io. Please add the `flag:merge-pending-release` label if the pull request content should only be released publicly in sync with a product release. +Approved pull requests are usually merged immediately into the `main` branch, automatically triggering a deployment on docs.metall2.com. Please add the `flag:merge-pending-release` label if the pull request content should only be released publicly in sync with a product release. -That's it! 🥳 Once the pull request is [reviewed and approved](#review-and-management-of-pull-requests), the Optimism Documentation team will merge it, and the content will be live on [docs.optimism.io](http://docs.optimism.io) a few minutes later. 🚀 +That's it! 🥳 Once the pull request is [reviewed and approved](#review-and-management-of-pull-requests), the Metal L2 Documentation team will merge it, and the content will be live on [docs.metall2.com](http://docs.metall2.com) a few minutes later. 🚀 ## Review and Management of Pull Requests -The pull request review process and timeline are based on the availability of the Optimism Documentation team to handle community contributions. The workflow is as follows: +The pull request review process and timeline are based on the availability of the Metal L2 Documentation team to handle community contributions. The workflow is as follows: 1. The pull request is assigned to a member of the Documentation team. 2. At least 1 member of the Documentation team will review the pull request for: @@ -101,7 +101,7 @@ The pull request review process and timeline are based on the availability of th - alignment with the documentation scope. 3. Reviewers will either approve, ask for changes, or reject the pull request. -4. Accepted pull requests will be merged and automatically deployed on [docs.optimism.io](https://docs.optimism.io) a few minutes later. +4. Accepted pull requests will be merged and automatically deployed on [docs.metall2.com](https://docs.metall2.com) a few minutes later. ## Other Ways to Support the Project All types of contributions are encouraged and valued. diff --git a/README.md b/README.md index 62aeb0d12..ec734b4a4 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# Optimism Docs +# Metal L2 Docs -This repo houses the Optimism Docs located at [docs.optimism.io](https://docs.optimism.io/). All documentation-related updates and new content will be tracked and maintained in this repo. +This repo houses the Metal L2 Docs forked from Optimism located at [docs.metall2.com](https://docs.metall2.com/). All documentation-related updates and new content will be tracked and maintained in this repo. ## Local Development @@ -12,11 +12,11 @@ Then, run `pnpm dev` to start the development server and visit localhost:3000. ## Contributions -Please see the [CONTRIBUTING.md](CONTRIBUTING.md) page for specifics on how to write PRs, use the linter, run spellcheck, add dictionary terms, etc. You should also review the [Optimism Documentation Style Guide](/pages/connect/contribute/style-guide.mdx) for additional guidelines, especially if you are writing entirely brand new pages to the developer docs, as opposed to smaller edits and/or revisions. +Please see the [CONTRIBUTING.md](CONTRIBUTING.md) page for specifics on how to write PRs, use the linter, run spellcheck, add dictionary terms, etc. You should also review the [Documentation Style Guide](/pages/connect/contribute/style-guide.mdx) for additional guidelines, especially if you are writing entirely brand new pages to the developer docs, as opposed to smaller edits and/or revisions. ## Project Board -You can track documentation [issues](https://github.com/ethereum-optimism/docs/issues) or submit documentation [requests](https://github.com/ethereum-optimism/docs/issues/new/choose) directly from this repo. +You can track documentation [issues](https://github.com/MetalPay/metal-l2-docs/issues) or submit documentation [requests](https://github.com/MetalPay/metal-l2-docs/issues/new/choose) directly from this repo. ## License diff --git a/components/TokenListTable.tsx b/components/TokenListTable.tsx index 874592eb7..a9b764fb0 100644 --- a/components/TokenListTable.tsx +++ b/components/TokenListTable.tsx @@ -8,6 +8,8 @@ const explorers = { '420': 'https://goerli-optimism.etherscan.io', '11155111': 'https://sepolia.etherscan.io/', '11155420': 'https://sepolia-optimism.etherscan.io/', + '1750' : 'https://explorer.metall2.com/', + '1740' : 'https://testnet.explorer.metall2.com/', } export function TokenListTable({ diff --git a/next-sitemap.config.js b/next-sitemap.config.js index 6f7627d0c..125252816 100644 --- a/next-sitemap.config.js +++ b/next-sitemap.config.js @@ -1,6 +1,6 @@ /** @type {import('next-sitemap').IConfig} */ module.exports = { - siteUrl: process.env.SITE_URL || 'https://docs.optimism.io/', + siteUrl: process.env.SITE_URL || 'https://docs.metall2.com/', generateRobotsTxt: true, // (optional) generateIndexSitemap: true, // ...other options diff --git a/notes/README.md b/notes/README.md index 7747bd9da..430b586ff 100644 --- a/notes/README.md +++ b/notes/README.md @@ -1,7 +1,7 @@ -# Optimism Docs Docs +# Metal L2 DocsDocs -The Optimism Docs Docs are internal docs to help you understand how the Optimism Docs are built and maintained. +The Metal L2 DocsDocs are internal docs to help you understand how the Metal L2 Docsare built and maintained. -- [How the Optimism Docs Use Nextra](./nextra.md) -- [How the Optimism Docs Use Remark](./remark.md) +- [How the Metal L2 DocsUse Nextra](./nextra.md) +- [How the Metal L2 DocsUse Remark](./remark.md) - [GitHub Actions](./actions.md) diff --git a/notes/nextra.md b/notes/nextra.md index 0dc35797b..54827487d 100644 --- a/notes/nextra.md +++ b/notes/nextra.md @@ -1,6 +1,6 @@ -# How the Optimism Docs Use Nextra +# How the Metal L2 DocsUse Nextra -The Optimism Docs use the [Nextra](https://nextra.site/) documentation framework. +The Metal L2 Docsuse the [Nextra](https://nextra.site/) documentation framework. Nextra is essentially a combination of [Next.js](https://nextjs.org/) + [MDX](https://mdxjs.com/) and allows you to write React components that can be used within Markdown pages. Nextra documentation is decent and can explain the basics of how to do most of the things you might want to do. This page documents all of the things that we do that are currently not made obvious by Nextra's docs. diff --git a/notes/remark.md b/notes/remark.md index 8dc5a1193..b13ae6236 100644 --- a/notes/remark.md +++ b/notes/remark.md @@ -1,6 +1,6 @@ -# How the Optimism Docs Use Remark +# How the Metal L2 Docs Use Remark -The Optimism Docs use [Nextra](https://nextra.site) as a documentation framework which uses [Remark](https://github.com/remarkjs/remark) as a markdown processor under the hood. +The Metal L2 Docs use [Nextra](https://nextra.site) as a documentation framework which uses [Remark](https://github.com/remarkjs/remark) as a markdown processor under the hood. This repository also uses [ESLint](https://eslint.org) in combination with [`eslint-plugin-mdx`](https://www.npmjs.com/package/eslint-plugin-mdx) as this plugin also uses Remark under the hood. Remark is a flexible Markdown processor with a [vibrant plugin ecosystem](https://github.com/remarkjs/remark/blob/main/doc/plugins.md#list-of-plugins). diff --git a/package.json b/package.json index 884691467..4daf25e33 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { - "name": "op-docs", - "version": "0.0.1", - "description": "Optimism Docs", + "name": "metal-l2-docs", + "version": "0.0.2", + "description": "Metal L2 Docs", "scripts": { "lint": "eslint . --ext mdx --max-warnings 0 && pnpm spellcheck:lint", "fix": "eslint . --ext mdx --fix && pnpm spellcheck:fix", diff --git a/pages/_meta.json b/pages/_meta.json index 647eda8a5..76d49465e 100644 --- a/pages/_meta.json +++ b/pages/_meta.json @@ -43,16 +43,16 @@ "href": "https://app.optimism.io/faucet?utm_source=docs", "newWindow": true }, - "gas": { - "title": "Gas Tracker", + "bridge": { + "title": "Bridge", "type": "page", - "href": "https://optimistic.grafana.net/public-dashboards/c84a5a9924fe4e14b270a42a8651ceb8?orgId=1&refresh=5m", + "href": "https://bridge.metall2.com/", "newWindow": true }, - "status": { - "title": "Status", + "explorer": { + "title": "Explorer", "type": "page", - "href": "https://status.optimism.io/", + "href": "https://explorer.metall2.com/", "newWindow": true }, @@ -65,16 +65,16 @@ "display": "children" }, - "+++ OP MAINNET": { + "+++ METAL L2 MAINNET": { "title": "", "type": "separator" }, - "--- OP MAINNET": { - "title": "OP MAINNET", + "--- METAL L2 MAINNET": { + "title": "METAL L2 MAINNET", "type": "separator" }, "chain": { - "title": "OP Mainnet", + "title": "METAL L2 Mainnet", "display": "children" }, diff --git a/pages/builders/app-developers/overview.mdx b/pages/builders/app-developers/overview.mdx index b42ed8018..28445dcb8 100644 --- a/pages/builders/app-developers/overview.mdx +++ b/pages/builders/app-developers/overview.mdx @@ -1,45 +1,45 @@ --- title: App Developer Overview lang: en-US -description: Learn about deploying contracts, cross-chain messaging, and tutorials to help you build applications on OP Mainnet. +description: Learn about deploying contracts, cross-chain messaging, and tutorials to help you build applications on Metal L2. --- import { Cards, Card } from 'nextra/components' # App Developer Overview -If you're a developer looking to build on OP Mainnet, you've come to the right place. -In this area of the Optimism Docs you'll find everything you need to know about building OP Mainnet applications. +If you're a developer looking to build on Metal L2, you've come to the right place. +In this area of the Metal L2 Docs you'll find everything you need to know about building Metal L2 applications for deployment on the Superchains Banking Layer, Metal L2. ## Getting Started -If you're brand new to OP Mainnet, try starting with the guide on [deploying a basic contract](/chain/getting-started). +If you're brand new to Metal L2, try starting with the guide on [deploying a basic contract](/chain/getting-started). It'll get you familiar with the basic steps required to get a contract deployed to the network. -OP Mainnet is [EVM equivalent](https://web.archive.org/web/20231127160757/https://medium.com/ethereum-optimism/introducing-evm-equivalence-5c2021deb306) so you can feel confident that your existing Ethereum smart contract skills will carry over to OP Mainnet. -Just make sure to be aware of the few small [differences between Ethereum and OP Mainnet](/chain/differences). +Metal L2 is [EVM equivalent](https://web.archive.org/web/20231127160757/https://medium.com/ethereum-optimism/introducing-evm-equivalence-5c2021deb306) so you can feel confident that your existing Ethereum smart contract skills will carry over to Metal L2. +Just make sure to be aware of the few small [differences between Ethereum and Metal L2](/chain/differences). -You might also want to check out the [testing on OP Networks guide](/chain/testing/testing-apps) and the tutorial on [running a local development environment](/chain/testing/dev-node) to help you feel totally confident in your OP Mainnet deployment. +You might also want to check out the [testing on Metal L2 guide](/chain/testing/testing-apps) and the tutorial on [running a local development environment](/chain/testing/dev-node) to help you feel totally confident in your Metal L2 deployment. - } /> + } /> - } /> + } /> - } /> + } /> ## Bridging and Messaging -Looking to build an application that sends ETH, tokens, or data between OP Mainnet and Ethereum? +Looking to build an application that sends ETH, tokens, or data between Metal L2 and Ethereum? You'll find some useful guides and tutorials in this area of the docs. -For instance, if you want to learn how to bridge a token from Ethereum to OP Mainnet (or vice versa!), you should check out the [Standard Token Bridge](bridging/standard-bridge). +For instance, if you want to learn how to bridge a token from Ethereum to Metal L2 (or vice versa!), you should check out the [Standard Token Bridge](bridging/standard-bridge). If you're looking for something more advanced, take a look at the guide on [sending data between L1 and L2](bridging/messaging). Contracts on one chain can trigger contract functions on the other chain, it's pretty cool! -The Standard Token Bridge for OP Mainnet even uses this same message-passing infrastructure under the hood. +The Standard Token Bridge for Metal L2 even uses this same message-passing infrastructure under the hood. - } /> + } /> } /> @@ -48,21 +48,21 @@ The Standard Token Bridge for OP Mainnet even uses this same message-passing inf ## Tutorials -If you're a bit more familiar with OP Mainnet and Ethereum, you can try walking through one of the tutorials put together by the Optimism community. +If you're a bit more familiar with Metal L2 and Ethereum, you can try walking through one of the tutorials put together by the Optimism community. They'll help you get a head start when building your first Optimistic project. -| Tutorial Name | Description | Difficulty Level | -| --------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ---------------- | -| [Deploying Your First Contract on OP Mainnet](tutorials/first-contract) | Learn how to deploy your first contract to OP Mainnet with Remix and MetaMask. | 🟢 Easy | -| [Deploying Your Contracts for Free on the Superchain](tutorials/deploy-for-free) | Learn how to deploy your contracts for free on the Superchain using the Superchain Developer Console | 🟢 Easy | -| [Bridging ETH With the Optimism SDK](tutorials/cross-dom-bridge-eth) | Learn how to use the Optimism SDK to transfer ETH between Layer 1 (Ethereum or Sepolia) and Layer 2 (OP Mainnet or OP Sepolia). | 🟢 Easy | -| [Bridging ERC-20 Tokens With the Optimism SDK](tutorials/cross-dom-bridge-erc20) | Learn how to use the Optimism SDK to transfer ERC-20 tokens between Layer 1 (Ethereum or Sepolia) and Layer 2 (OP Mainnet or OP Sepolia). | 🟢 Easy | -| [Bridging your Standard ERC-20 token using the Standard Bridge](tutorials/standard-bridge-standard-token) | Learn how to bridge your standard ERC-20 token to layer 2 using the standard bridge. | 🟡 Medium | -| [Bridging your Custom ERC-20 token using the Standard Bridge](tutorials/standard-bridge-custom-token) | Learn how to bridge your custom ERC-20 token to layer 2 using the standard bridge. | 🟡 Medium | -| [Tracing Deposits and Withdrawals With the Optimism SDK](tutorials/sdk-trace-txns) | Learn how to use the Optimism SDK to trace deposits and withdrawals. | 🟢 Easy | -| [Viewing Deposits and Withdrawals by Address With the Optimism SDK](tutorials/sdk-view-txns) | Learn how to use the Optimism SDK to view deposits and withdrawals by address. | 🟢 Easy | -| [Estimating Transaction Costs With the Optimism SDK](tutorials/sdk-view-txns) | Learn how to use the Optimism SDK to estimate the cost of a transaction on OP Mainnet. | 🟢 Easy | -| [Sending OP Mainnet Transactions from Ethereum](tutorials/send-tx-from-eth) | Learn how to send transactions to OP Mainnet from Ethereum. | 🟢 Easy | +| Tutorial Name | Description | Difficulty Level | +| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ---------------- | +| [Deploying Your First Contract on Metal L2](tutorials/first-contract) | Learn how to deploy your first contract to Metal L2 with Remix and MetaMask. | 🟢 Easy | +| [Deploying Your Contracts for Free on the Superchain](tutorials/deploy-for-free) | Learn how to deploy your contracts for free on the Superchain using the Superchain Developer Console | 🟢 Easy | +| [Bridging ETH With the Optimism SDK](tutorials/cross-dom-bridge-eth) | Learn how to use the Optimism SDK to transfer ETH between Layer 1 (Ethereum or Sepolia) and Layer 2 (Metal L2 or Metal L2 Testnet). | 🟢 Easy | +| [Bridging ERC-20 Tokens With the Optimism SDK](tutorials/cross-dom-bridge-erc20) | Learn how to use the Optimism SDK to transfer ERC-20 tokens between Layer 1 (Ethereum or Sepolia) and Layer 2 (Metal L2 or Metal L2 Testnet). | 🟢 Easy | +| [Bridging your Standard ERC-20 token using the Standard Bridge](tutorials/standard-bridge-standard-token) | Learn how to bridge your standard ERC-20 token to layer 2 using the standard bridge. | 🟡 Medium | +| [Bridging your Custom ERC-20 token using the Standard Bridge](tutorials/standard-bridge-custom-token) | Learn how to bridge your custom ERC-20 token to layer 2 using the standard bridge. | 🟡 Medium | +| [Tracing Deposits and Withdrawals With the Optimism SDK](tutorials/sdk-trace-txns) | Learn how to use the Optimism SDK to trace deposits and withdrawals. | 🟢 Easy | +| [Viewing Deposits and Withdrawals by Address With the Optimism SDK](tutorials/sdk-view-txns) | Learn how to use the Optimism SDK to view deposits and withdrawals by address. | 🟢 Easy | +| [Estimating Transaction Costs With the Optimism SDK](tutorials/sdk-view-txns) | Learn how to use the Optimism SDK to estimate the cost of a transaction on Metal L2. | 🟢 Easy | +| [Sending Metal L2 Transactions from Ethereum](tutorials/send-tx-from-eth) | Learn how to send transactions to Metal L2 from Ethereum. | 🟢 Easy | You can also [suggest a new tutorial](https://github.com/ethereum-optimism/docs/issues/new?assignees=\&labels=tutorial%2Cdocumentation%2Ccommunity-request\&projects=\&template=suggest_tutorial.yaml\&title=%5BTUTORIAL%5D+Add+PR+title) if you have something specific in mind. We'd love to grow this list! diff --git a/pages/builders/cex-wallet-developers/cex-support.mdx b/pages/builders/cex-wallet-developers/cex-support.mdx index 044c5118e..35f8616f8 100644 --- a/pages/builders/cex-wallet-developers/cex-support.mdx +++ b/pages/builders/cex-wallet-developers/cex-support.mdx @@ -1,52 +1,52 @@ --- -title: Supporting OP Mainnet in Your Exchange +title: Supporting Metal L2 in Your Exchange lang: en-US -description: Learn how to support OP Mainnet in your exchange. +description: Learn how to support Metal L2 in your exchange. --- import { Callout } from 'nextra/components' -# Supporting OP Mainnet in Your Exchange +# Supporting Metal L2 in Your Exchange -Check out this guide to get an overview of everything you need to know to properly support OP Mainnet within your exchange. +Check out this guide to get an overview of everything you need to know to properly support Metal L2 within your exchange. -## Connecting to OP Mainnet +## Connecting to Metal L2 -OP Mainnet is designed to be [EVM equivalent](https://web.archive.org/web/20231127160757/https://medium.com/ethereum-optimism/introducing-evm-equivalence-5c2021deb306) and supports all of the same tooling as Ethereum. -You can use your favorite Ethereum libraries and tools to work with OP Mainnet. -Head over to the [Networks and RPC Endpoints](/chain/networks) page for network connection details and check out the [RPC Providers](/builders/tools/connect/rpc-providers) page for an updated list of RPC providers that support OP Mainnet. -If you need to run your own OP Mainnet node, head over to the [Node Operator](/builders/node-operators/rollup-node) guide. +Metal L2 is designed to be [EVM equivalent](https://web.archive.org/web/20231127160757/https://medium.com/ethereum-optimism/introducing-evm-equivalence-5c2021deb306) and supports all of the same tooling as Ethereum. +You can use your favorite Ethereum libraries and tools to work with Metal L2. +Head over to the [Networks and RPC Endpoints](/chain/networks) page for network connection details and check out the [RPC Providers](/builders/tools/connect/rpc-providers) page for an updated list of RPC providers that support Metal L2. +If you need to run your own Metal L2 node, head over to the [Node Operator](/builders/node-operators/rollup-node) guide. ## Native Gas Token (ETH) -OP Mainnet uses ETH as its native gas token. +Metal L2 uses ETH as its native gas token. Transactions are paid for in ETH and account balances are denominated in ETH. ## Transaction Fees -OP Mainnet charges the standard gas fee for transactions, but also charges an additional L1 data fee for the cost of publishing transaction data to Ethereum. -Check out the [Transaction Fees](/stack/transactions/fees) page for more information about how transaction fees work on OP Mainnet. +Metal L2 charges the standard gas fee for transactions, but also charges an additional L1 data fee for the cost of publishing transaction data to Ethereum. +Check out the [Transaction Fees](/stack/transactions/fees) page for more information about how transaction fees work on Metal L2. ## Smart Contracts -Smart contracts on OP Mainnet function the same way they do on Ethereum. +Smart contracts on Metal L2 function the same way they do on Ethereum. This includes ERC-20 token contracts. You can use your existing logic for managing withdrawals and deposits of ERC-20 tokens. ## Token Addresses -The ERC-20 contract address for a token on OP Mainnet may differ from the address for the same token on Ethereum. +The ERC-20 contract address for a token on Metal L2 may differ from the address for the same token on Ethereum. Make sure to reference the [Bridged Token Addresses](/chain/tokenlist) to confirm that you are using the correct token addresses in your application. ## Bridging ETH and ERC-20s -You may need to transfer ETH or ERC-20 tokens between OP Mainnet and Ethereum. -For instance, you may need to use this functionality to balance the supply of ETH on OP Mainnet and Ethereum depending on the demand for withdrawals and deposits on the two networks. -Refer to the [Basics of Bridging](/builders/app-developers/bridging/basics) and the [Standard Bridge](/builders/app-developers/bridging/standard-bridge) guides for more information about how to bridge ETH and ERC-20 tokens between OP Mainnet and Ethereum. +You may need to transfer ETH or ERC-20 tokens between Metal L2 and Ethereum. +For instance, you may need to use this functionality to balance the supply of ETH on Metal L2 and Ethereum depending on the demand for withdrawals and deposits on the two networks. +Refer to the [Basics of Bridging](/builders/app-developers/bridging/basics) and the [Standard Bridge](/builders/app-developers/bridging/standard-bridge) guides for more information about how to bridge ETH and ERC-20 tokens between Metal L2 and Ethereum. ## Transaction Statuses -OP Mainnet transactions have a number of different statuses during the transaction lifecycle. +Metal L2 transactions have a number of different statuses during the transaction lifecycle. Refer to the [Transaction Statuses](/builders/app-developers/transactions/statuses) page for more information about the different transaction statuses and how to handle them in your application. @@ -57,6 +57,6 @@ Make sure to understand the various transaction statuses to avoid security issue ## Audits and Security Reviews -The OP Stack codebase upon which OP Mainnet is built has undergone a number of security reviews. +The OP Stack codebase upon which Metal L2 is built has undergone a number of security reviews. Visit [GitHub](https://github.com/ethereum-optimism/optimism/tree/develop/docs/security-reviews) for a full list of the most recent reports. -Additionally, refer to the [Security Model & FAQ](/chain/security/faq) page for more information about the security model of OP Mainnet. +Additionally, refer to the [Security Model & FAQ](/chain/security/faq) page for more information about the security model of Metal L2. diff --git a/pages/builders/cex-wallet-developers/wallet-support.mdx b/pages/builders/cex-wallet-developers/wallet-support.mdx index 31c085699..148fea43e 100644 --- a/pages/builders/cex-wallet-developers/wallet-support.mdx +++ b/pages/builders/cex-wallet-developers/wallet-support.mdx @@ -1,56 +1,56 @@ --- -title: Supporting OP Mainnet in Your Wallet +title: Supporting Metal L2 in Your Wallet lang: en-US -description: Learn how to support OP Mainnet in your wallet. +description: Learn how to support Metal L2 in your wallet. --- import { Callout } from 'nextra/components' -# Supporting OP Mainnet in Your Wallet +# Supporting Metal L2 in Your Wallet -Check out this guide to get an overview of everything you need to know to properly support OP Mainnet within your wallet. +Check out this guide to get an overview of everything you need to know to properly support Metal L2 within your wallet. -## Connecting to OP Mainnet +## Connecting to Metal L2 -OP Mainnet is designed to be [EVM equivalent](https://web.archive.org/web/20231127160757/https://medium.com/ethereum-optimism/introducing-evm-equivalence-5c2021deb306) and supports all of the same tooling as Ethereum. -You can use your favorite Ethereum libraries and tools to work with OP Mainnet. -Head over to the [Networks and RPC Endpoints](/chain/networks) page for network connection details and check out the [RPC Providers](/builders/tools/connect/rpc-providers) page for an updated list of RPC providers that support OP Mainnet. -If you need to run your own OP Mainnet node, head over to the [Node Operator](/builders/node-operators/rollup-node) guide. +Metal L2 is designed to be [EVM equivalent](https://web.archive.org/web/20231127160757/https://medium.com/ethereum-optimism/introducing-evm-equivalence-5c2021deb306) and supports all of the same tooling as Ethereum. +You can use your favorite Ethereum libraries and tools to work with Metal L2. +Head over to the [Networks and RPC Endpoints](/chain/networks) page for network connection details and check out the [RPC Providers](/builders/tools/connect/rpc-providers) page for an updated list of RPC providers that support Metal L2. +If you need to run your own Metal L2 node, head over to the [Node Operator](/builders/node-operators/rollup-node) guide. ## Native Gas Token (ETH) -OP Mainnet uses ETH as its native gas token. +Metal L2 uses ETH as its native gas token. Transactions are paid for in ETH and account balances are denominated in ETH. ## Transaction Fees -OP Mainnet charges the standard gas fee for transactions, but also charges an additional L1 data fee for the cost of publishing transaction data to Ethereum. -Check out the [Transaction Fees](/stack/transactions/fees) page for more information about how transaction fees work on OP Mainnet. +Metal L2 charges the standard gas fee for transactions, but also charges an additional L1 data fee for the cost of publishing transaction data to Ethereum. +Check out the [Transaction Fees](/stack/transactions/fees) page for more information about how transaction fees work on Metal L2. -Transactions on OP Mainnet must pay for an additional "L1 data fee" that often heavily outweighs the standard gas fee. +Transactions on Metal L2 must pay for an additional "L1 data fee" that often heavily outweighs the standard gas fee. Make sure that your wallet is configured to display this fee to your users so that they are aware of the total cost of their transaction. ## Smart Contracts -Smart contracts on OP Mainnet function the same way they do on Ethereum. -You can use your favorite Ethereum libraries and tools to interact with smart contracts on OP Mainnet. +Smart contracts on Metal L2 function the same way they do on Ethereum. +You can use your favorite Ethereum libraries and tools to interact with smart contracts on Metal L2. ## Token Addresses -The ERC-20 contract address for a token on OP Mainnet may differ from the address for the same token on Ethereum. -Addresses for many common tokens will differ between OP Mainnet and Ethereum. +The ERC-20 contract address for a token on Metal L2 may differ from the address for the same token on Ethereum. +Addresses for many common tokens will differ between Metal L2 and Ethereum. Make sure to reference the [Bridged Token Addresses](/chain/tokenlist) to confirm that you are using the correct token addresses in your application. ## Bridging ETH and ERC-20s -You may need to transfer ETH or ERC-20 tokens between OP Mainnet and Ethereum. +You may need to transfer ETH or ERC-20 tokens between Metal L2 and Ethereum. This is a useful feature for users who want to move tokens between the two networks. -Refer to the [Basics of Bridging](/builders/app-developers/bridging/basics) and the [Standard Bridge](/builders/app-developers/bridging/standard-bridge) guides for more information about how to bridge ETH and ERC-20 tokens between OP Mainnet and Ethereum. +Refer to the [Basics of Bridging](/builders/app-developers/bridging/basics) and the [Standard Bridge](/builders/app-developers/bridging/standard-bridge) guides for more information about how to bridge ETH and ERC-20 tokens between Metal L2 and Ethereum. ## Transaction Statuses -OP Mainnet transactions have a number of different statuses during the transaction lifecycle. +Metal L2 transactions have a number of different statuses during the transaction lifecycle. The status of a transaction can be useful for users. Refer to the [Transaction Statuses](/builders/app-developers/transactions/statuses) page for more information about the different transaction statuses and how to handle them in your application. diff --git a/pages/builders/chain-operators/configuration/batcher.mdx b/pages/builders/chain-operators/configuration/batcher.mdx index ac07942aa..5c4c2890f 100644 --- a/pages/builders/chain-operators/configuration/batcher.mdx +++ b/pages/builders/chain-operators/configuration/batcher.mdx @@ -10,7 +10,7 @@ import { Callout, Tabs } from 'nextra/components' This page lists all configuration options for the op-batcher. The op-batcher posts L2 sequencer data to the L1, to make it available for verifiers. The following -options are from the `--help` in [v1.7.6](https://github.com/ethereum-optimism/optimism/releases/tag/v1.7.6). +options are from the `--help` in [v1.7.6](https://github.com/MetalLayer2/ethereum-optimism.github.io/releases/tag/v1.7.6). ## Global Options diff --git a/pages/builders/chain-operators/configuration/proposer.mdx b/pages/builders/chain-operators/configuration/proposer.mdx index da7b24846..783fd7b4d 100644 --- a/pages/builders/chain-operators/configuration/proposer.mdx +++ b/pages/builders/chain-operators/configuration/proposer.mdx @@ -10,7 +10,7 @@ import { Tabs } from 'nextra/components' This page list all configuration options for op-proposer. The op-proposer posts the output roots to the L1, to make it available for verifiers. The following -options are from the `--help` in [v1.7.6](https://github.com/ethereum-optimism/optimism/releases/tag/v1.7.6). +options are from the `--help` in [v1.7.6](https://github.com/MetalLayer2/ethereum-optimism.github.io/releases/tag/v1.7.6). ## Global Options diff --git a/pages/builders/chain-operators/deploy/genesis.mdx b/pages/builders/chain-operators/deploy/genesis.mdx index 87e1ca785..d635c5010 100644 --- a/pages/builders/chain-operators/deploy/genesis.mdx +++ b/pages/builders/chain-operators/deploy/genesis.mdx @@ -64,7 +64,7 @@ STATE_DUMP_PATH= \ The genesis file creation is handled by the `genesis l2` subcommand, provided by the `op-node`. The following is an example of its usage -from [v1.7.6](https://github.com/ethereum-optimism/optimism/releases/tag/v1.7.6) -- +from [v1.7.6](https://github.com/MetalLayer2/ethereum-optimism.github.io/releases/tag/v1.7.6) -- note that you need to pass the path to the l2 genesis state dump file output by the foundry script above: @@ -87,5 +87,5 @@ with `--l1-rpc`. * Learn how to [initialize](/builders/node-operators/configuration/base-config#initialization-via-genesis-file) `op-geth` with your `genesis.json` file. -* Learn how to [initialize](https://docs.optimism.io/builders/node-operators/configuration/base-config#configuring-op-node) `op-node` with your `rollup.json` file. +* Learn how to [initialize](https://docs.metall2.com/builders/node-operators/configuration/base-config#configuring-op-node) `op-node` with your `rollup.json` file. * Learn more about the off chain [architecture](/builders/chain-operators/architecture). diff --git a/pages/builders/chain-operators/deploy/smart-contracts.mdx b/pages/builders/chain-operators/deploy/smart-contracts.mdx index 2eb101cd4..72878f33d 100644 --- a/pages/builders/chain-operators/deploy/smart-contracts.mdx +++ b/pages/builders/chain-operators/deploy/smart-contracts.mdx @@ -79,7 +79,7 @@ single contract. Production users should deploy their L1 contracts from a contracts release. All contracts releases are on git tags with the following format: `op-contracts/vX.Y.Z`. If you're deploying a new standard chain, you should -deploy the [Multi-Chain Prep (MCP) L1 release](https://github.com/ethereum-optimism/optimism/releases/tag/op-contracts%2Fv1.3.0). +deploy the [Multi-Chain Prep (MCP) L1 release](https://github.com/MetalLayer2/ethereum-optimism.github.io/releases/tag/op-contracts%2Fv1.3.0). We're working on writing more documentation to prepare OP Stack chain operators to run a fault proof chain effectively. diff --git a/pages/builders/chain-operators/features/alt-da-mode.mdx b/pages/builders/chain-operators/features/alt-da-mode.mdx index e1e933699..14143aa1b 100644 --- a/pages/builders/chain-operators/features/alt-da-mode.mdx +++ b/pages/builders/chain-operators/features/alt-da-mode.mdx @@ -90,7 +90,7 @@ For deploying your contracts, use the latest release. * Chain operators are not posting everything to Ethereum, just commitments, so chain operators will need to determine fee scalars values to charge users. The fee scalar values are network throughput dependent, so values will need to be adjusted by chain operators as needed. * Cost structure for Alt-DA Mode: The transaction data is split up into 128kb chunks and then submitted to your DA Layer. Then, 32 byte commitments are submitted (goes to batch inbox address) to L1 for each 128kb chunk. Then, figure out how much that costs relative to the amount of transactions your chain is putting through. - * Set scalar values inside the deploy config. The example below shows some possible fee scalar values, calculated assuming negligible DA Layer costs, but will need to be adjusted up or down based on network throughput - as a reminder of how to set your scalar values, see [this section](https://docs.optimism.io/builders/chain-operators/management/blobs#update-your-scalar-values-for-blobs) of the docs. + * Set scalar values inside the deploy config. The example below shows some possible fee scalar values, calculated assuming negligible DA Layer costs, but will need to be adjusted up or down based on network throughput - as a reminder of how to set your scalar values, see [this section](https://docs.metall2.com/builders/chain-operators/management/blobs#update-your-scalar-values-for-blobs) of the docs. ``` // Set in Deploy Config diff --git a/pages/builders/chain-operators/management/best-practices.mdx b/pages/builders/chain-operators/management/best-practices.mdx index bb63e031a..81ae75a50 100644 --- a/pages/builders/chain-operators/management/best-practices.mdx +++ b/pages/builders/chain-operators/management/best-practices.mdx @@ -17,7 +17,7 @@ off-chain components. Chain and node operators should always run the latest production releases of the OP Stack's off chain components. Our latest releases, notes, and changelogs -can be found on GitHub. `op-node` releases can be found [here](https://github.com/ethereum-optimism/optimism/releases) +can be found on GitHub. `op-node` releases can be found [here](https://github.com/MetalLayer2/ethereum-optimism.github.io/releases) and `op-geth` releases can be found [here](https://github.com/ethereum-optimism/op-geth/releases). * Production releases are always tags, versioned as diff --git a/pages/builders/chain-operators/tools/op-challenger.mdx b/pages/builders/chain-operators/tools/op-challenger.mdx index 376fff38b..0a7b4c1ca 100644 --- a/pages/builders/chain-operators/tools/op-challenger.mdx +++ b/pages/builders/chain-operators/tools/op-challenger.mdx @@ -19,7 +19,7 @@ This guide provides a walkthrough of setting up the configuration and monitoring git clone https://github.com/ethereum-optimism/optimism.git ``` - * Check out the [latest release of `op-challenger`](https://github.com/ethereum-optimism/optimism/releases/tag/op-challenger%2Fv1.0.1) and use the commit to deploy. Alternatively, chain operators can use the prebuilt [challenger docker images](https://us-docker.pkg.dev/oplabs-tools-artifacts/images/op-challenger:v1.0.1). + * Check out the [latest release of `op-challenger`](https://github.com/MetalLayer2/ethereum-optimism.github.io/releases/tag/op-challenger%2Fv1.0.1) and use the commit to deploy. Alternatively, chain operators can use the prebuilt [challenger docker images](https://us-docker.pkg.dev/oplabs-tools-artifacts/images/op-challenger:v1.0.1). If a Docker image is used, it already comes with `op-program` server and an executable for Cannon embedded, so the Cannon bin doesn't need to be specified. ```bash diff --git a/pages/builders/node-operators/configuration/consensus-config.mdx b/pages/builders/node-operators/configuration/consensus-config.mdx index b3d62b76a..f3510e324 100644 --- a/pages/builders/node-operators/configuration/consensus-config.mdx +++ b/pages/builders/node-operators/configuration/consensus-config.mdx @@ -15,7 +15,7 @@ import { Tabs } from 'nextra/components' This page list all configuration options for `op-node`. `op-node` implements most rollup-specific functionality as Consensus-Layer, similar to a L1 beacon-node. -The following options are from the `--help` in [v1.7.5](https://github.com/ethereum-optimism/optimism/releases/tag/op-node/v1.7.5). +The following options are from the `--help` in [v1.7.5](https://github.com/MetalLayer2/ethereum-optimism.github.io/releases/tag/op-node/v1.7.5). ## Global Options diff --git a/pages/builders/node-operators/releases.mdx b/pages/builders/node-operators/releases.mdx index 1edc492c4..ba11406d8 100644 --- a/pages/builders/node-operators/releases.mdx +++ b/pages/builders/node-operators/releases.mdx @@ -11,7 +11,7 @@ import { Callout } from 'nextra/components' This page gives information on the off chain node software release information. - Our latest releases, notes, and changelogs can be found on GitHub. `op-node` releases can be found [here](https://github.com/ethereum-optimism/optimism/releases) + Our latest releases, notes, and changelogs can be found on GitHub. `op-node` releases can be found [here](https://github.com/MetalLayer2/ethereum-optimism.github.io/releases) and `op-geth` releases can be found [here](https://github.com/ethereum-optimism/op-geth/releases). @@ -34,7 +34,7 @@ characters for the geth minor version and two characters for the geth patch version. Since we cannot left-pad with zeroes, the geth major version is not padded. -| Network | op-node | op-geth | -| ---------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | -| OP Mainnet | [v1.7.7](https://github.com/ethereum-optimism/optimism/releases/tag/v1.7.7) | [v1.101315.2](https://github.com/ethereum-optimism/op-geth/releases/tag/v1.101315.2) | -| OP Sepolia | [v1.7.7](https://github.com/ethereum-optimism/optimism/releases/tag/v1.7.7) | [v1.101315.2](https://github.com/ethereum-optimism/op-geth/releases/tag/v1.101315.2) | +| Network | op-node | op-geth | +| ---------- | ---------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | +| OP Mainnet | [v1.7.7](https://github.com/MetalLayer2/ethereum-optimism.github.io/releases/tag/v1.7.7) | [v1.101315.2](https://github.com/ethereum-optimism/op-geth/releases/tag/v1.101315.2) | +| OP Sepolia | [v1.7.7](https://github.com/MetalLayer2/ethereum-optimism.github.io/releases/tag/v1.7.7) | [v1.101315.2](https://github.com/ethereum-optimism/op-geth/releases/tag/v1.101315.2) | diff --git a/pages/builders/node-operators/tutorials/node-from-source.mdx b/pages/builders/node-operators/tutorials/node-from-source.mdx index 326afa65c..5fc1b0ff2 100644 --- a/pages/builders/node-operators/tutorials/node-from-source.mdx +++ b/pages/builders/node-operators/tutorials/node-from-source.mdx @@ -69,7 +69,7 @@ cd optimism {

Check out the required release branch

} Release branches are created when new versions of the `op-node` are created. -Read through the [Releases page](https://github.com/ethereum-optimism/optimism/releases) to determine the correct branch to check out. +Read through the [Releases page](https://github.com/MetalLayer2/ethereum-optimism.github.io/releases) to determine the correct branch to check out. ```bash git checkout diff --git a/pages/builders/notices/fjord-changes.mdx b/pages/builders/notices/fjord-changes.mdx index 354ae0d1e..3661b5a35 100644 --- a/pages/builders/notices/fjord-changes.mdx +++ b/pages/builders/notices/fjord-changes.mdx @@ -106,7 +106,7 @@ The proposed Fjord upgrade impacts OP chains and requires chain operators to upg ## For Node Operators -Node operators will need to upgrade to Fjord before the activation date. For Sepolia, the op-node release [v1.7.7](https://github.com/ethereum-optimism/optimism/releases/tag/v1.7.7) and op-geth release [v1.101315.2](https://github.com/ethereum-optimism/op-geth/releases/tag/v1.101315.2) contain these changes. +Node operators will need to upgrade to Fjord before the activation date. For Sepolia, the op-node release [v1.7.7](https://github.com/MetalLayer2/ethereum-optimism.github.io/releases/tag/v1.7.7) and op-geth release [v1.101315.2](https://github.com/ethereum-optimism/op-geth/releases/tag/v1.101315.2) contain these changes. These following steps are necessary for EVERY node operator: @@ -114,7 +114,7 @@ These following steps are necessary for EVERY node operator: ### Update to the Latest Release * [`op-geth`](https://github.com/ethereum-optimism/op-geth/releases/tag/v1.101315.2) - * [`op-node`](https://github.com/ethereum-optimism/optimism/releases/tag/v1.7.7) + * [`op-node`](https://github.com/MetalLayer2/ethereum-optimism.github.io/releases/tag/v1.7.7) ### Configure the Fjord Activation Date diff --git a/pages/builders/notices/fp-changes.mdx b/pages/builders/notices/fp-changes.mdx index 4f7a34d81..b889db0e7 100644 --- a/pages/builders/notices/fp-changes.mdx +++ b/pages/builders/notices/fp-changes.mdx @@ -17,7 +17,7 @@ If you experience difficulty at any stage of this process, please reach out to [ **ALL** withdrawals that are not finalized before the Fault Proofs upgrade executes will need to be reproven after the upgrade is complete. - * Reproving simply requires that you execute the [withdrawal proving flow](https://docs.optimism.io/stack/protocol/rollup/withdrawal-flow) again. + * Reproving simply requires that you execute the [withdrawal proving flow](https://docs.metall2.com/stack/protocol/rollup/withdrawal-flow) again. * Withdrawals prior to the Fault Proofs upgrade must wait a 7-day challenge period before finalization. As a result, any withdrawal initiated less than 7 days before the upgrade cannot be finalized before the upgrade is executed. You may want to consider waiting until after the upgrade is complete to begin a withdrawal during this 7-day window. diff --git a/pages/builders/tools/build/faucets.mdx b/pages/builders/tools/build/faucets.mdx index 7384de1b3..d7d3beb77 100644 --- a/pages/builders/tools/build/faucets.mdx +++ b/pages/builders/tools/build/faucets.mdx @@ -19,7 +19,7 @@ Faucets can occasionally also run out of ETH, so if you're having trouble gettin Tokens on test networks like Sepolia or OP Sepolia have no value and are only meant for testing. - Optimists only take what they need so that others can use faucets too! + Metal L2 contributors only take what they need so that others can use faucets too! ## Superchain Faucet diff --git a/pages/builders/tools/connect/rpc-providers.mdx b/pages/builders/tools/connect/rpc-providers.mdx index 20010e015..52dfbaa39 100644 --- a/pages/builders/tools/connect/rpc-providers.mdx +++ b/pages/builders/tools/connect/rpc-providers.mdx @@ -1,101 +1,32 @@ --- title: RPC & Node Providers lang: en-US -description: Learn about different RPC and node providers to help you connect to an Optimism node. +description: Learn about different RPC and node providers to help you connect to an Optimism or Metal L2 node. --- import { Callout } from 'nextra/components' # RPC & Node Providers -This reference guide lists different RPC and node providers to help you connect to an Optimism node. +This reference guide lists different RPC and node providers to help you connect to an Optimism or Metal L2 node. This page includes providers that meet specific [inclusion criteria](#inclusion-criteria), as outlined below. Please visit the [community node providers page](https://github.com/ethereum-optimism/developers/blob/main/community/tools/node-providers.md) for an additional listing of third-party node providers. -## Ankr - -### Description and Pricing - -[Ankr](https://www.ankr.com/) provides a geo-distributed and decentralized (free) public and premium (Pay-as-you-go) [Optimism RPC](https://www.ankr.com/rpc/optimism/) comprised of many independent blockchain nodes running worldwide for low-latency and incredibly reliable connections. - -Moreover, Ankr offers access to developer tooling on OP Mainnet (and testnets) like SDKs and [Advanced APIs](https://www.ankr.com/advanced-api/) such as NFT, Token and Query API. - -### Supported Networks - -* OP Mainnet -* OP Sepolia - -## Alchemy - -### Description and Pricing - -[Alchemy](https://docs.alchemy.com/reference/optimism-api-quickstart/?a=818c11a8da) is a popular API provider and developer platform. Its robust, free tier offers access to enhanced features like SDKs and enhanced APIs and hosted OP Mainnet and testnet nodes. - -### Supported Networks - -* OP Mainnet -* OP Sepolia - -## Chainstack - -### Description and Pricing - -[Chainstack](https://chainstack.com/build-better-with-optimism/) provides global & regional load-balanced nodes that are full & archive with debug & trace APIs. For the free tier, the Developer plan is available and you can sign up with GitHub account or other social logins. Chainstack also has special discounts available. - -### Supported Networks - -* OP Mainnet -* OP Sepolia ## dRPC ### Description and Pricing -[dRPC](https://drpc.org) provides geo-distributed, auto-scalable OP Mainnet and OP Sepolia nodes. For more information, visit [dRPC's chainlist for Optimism](https://drpc.org/chainlist/optimism). dRPC supports Websocket and all methods, including debug and trace methods. +[dRPC](https://drpc.org) provides geo-distributed, auto-scalable Metal L2 Mainnet and Metal L2 Sepolia nodes. For more information, visit [dRPC's chainlist page for Metal L2](https://drpc.org/chainlist/metall2). dRPC supports Websocket and all methods, including debug and trace methods. For early-stage startups, dRPC and Optimism Collective provide OP Mainnet nodes from 3 geo clusters without method restrictions and are totally free! For commercial nodes, dRPC uses a pay-as-you-go model without hidden fees and rate limits. Feel free to try fast and reliable nodes. -Supported Networks -OP Mainnet -OP Sepolia - -## Infura - -### Description and Pricing - -[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) - -### Supported Networks - -* OP Mainnet -* OP Sepolia - -## Moralis - -### Description and Pricing - -[Moralis](https://moralis.io/?utm_source=op-docs&utm_medium=partner-docs) is a popular Node and API provider for both real-time and indexed blockchain data. Moralis is the only major infrastructure provider in blockchain with a SOC2 Type 2 certification. You can use Moralis for free, or upgrade to a [paid plan](https://moralis.io/pricing/?utm_source=op-docs&utm_medium=partner-docs) for more features and benefits. - -[Sign up for a free Moralis account here](https://admin.moralis.io/register/?utm_source=op-docs&utm_medium=partner-docs) - ### Supported Networks -* OP Mainnet - -## QuickNode - -### Description and Pricing - -[QuickNode](https://www.quicknode.com/) offers access to hosted OP Mainnet (and testnet) nodes for free. -With the option to upgrade to a premium plan for additional features, we allow you to focus solely on optimizing your application while we manage the complex infrastructure. - -### Supported Networks +Metal L2 Mainnet +Metal L2 Sepolia -* OP Mainnet -* OP Sepolia ## Inclusion Criteria diff --git a/pages/builders/tools/overview.mdx b/pages/builders/tools/overview.mdx index 596be82ad..a8658ec1c 100644 --- a/pages/builders/tools/overview.mdx +++ b/pages/builders/tools/overview.mdx @@ -1,16 +1,16 @@ --- title: Developer Tools lang: en-US -description: Learn about different developer tools you can use to help you build on Optimism. +description: Learn about different developer tools you can use to help you build on Metal L2. --- import { Cards, Card } from 'nextra/components' # Developer Tools -Welcome to the Optimism developer tools! +Welcome to the Metal L2 developer tools! -If you are already familiar with [building on OP Mainnet](/chain/getting-started) and just need the tools to get cracking, you are in the right place! +If you are already familiar with [building on Metal L2](/chain/getting-started) and just need the tools to get cracking, you are in the right place! ## Connecting @@ -43,10 +43,10 @@ If you are already familiar with [building on OP Mainnet](/chain/getting-started } /> -## OP Tools +## Metal L2 Tools - } /> + } /> } /> diff --git a/pages/chain/_meta.json b/pages/chain/_meta.json index 120d2dc16..252510382 100644 --- a/pages/chain/_meta.json +++ b/pages/chain/_meta.json @@ -1,7 +1,8 @@ { - "getting-started": "Getting Started: OP Mainnet", - "differences": "Differences Between Ethereum and OP Mainnet", + "getting-started": "Getting Started: Metal L2", + "differences": "Differences Between Ethereum and Metal L2", "networks": "Networks and RPC Endpoints", + "biconomy": "Biconomy", "addresses": "Contract Addresses", "tokenlist": "Bridged Token Addresses", "identity": "Identity", diff --git a/pages/chain/addresses.mdx b/pages/chain/addresses.mdx index e0142fce3..2144a6d19 100644 --- a/pages/chain/addresses.mdx +++ b/pages/chain/addresses.mdx @@ -21,26 +21,26 @@ This page is automatically generated from packages in the [superchain-registry]( ### Ethereum (L1) - + ### Ethereum Legacy Contracts (L1) - + -### OP Mainnet (L2) +### Metal L2 (L2) - + -### OP Mainnet Legacy Contracts (L2) +### Metal L2 Legacy Contracts (L2) - + ## Testnet (Sepolia) ### Sepolia (L1) - + -### OP Sepolia (L2) +### Metal L2 Testnet (L2) - + diff --git a/pages/chain/biconomy.mdx b/pages/chain/biconomy.mdx new file mode 100644 index 000000000..39d53b537 --- /dev/null +++ b/pages/chain/biconomy.mdx @@ -0,0 +1,107 @@ +--- +title: Biconomy +lang: en-US +description: Learn about sending a gasless txn on Metal L2 testnet using Biconomy +--- + +# Biconomy Integration with Metal L2 Testnet + +In this tutorial, we'll walk through the process of integrating Biconomy with Metal L2 Testnet chain to enable gasless transactions. + +The tutorial covers the entire process from setting up the Biconomy paymaster to actually sending a gasless transaction on the Metal L2 Testnet chain. + +## Prerequisites + +* A wallet with some testnet tokens for Metal L2 Testnet + +## Step 1: Create a Biconomy Paymaster + +1. Go to the [Biconomy Dashboard](https://dashboard.biconomy.io/). +2. Sign up or log in to your account. +3. Click on "Create New Paymaster." +4. Select "Metal L2 Testnet" as the network. +5. Choose a name for your paymaster and click "Create." +6. Once created, you'll see your Paymaster API Key. Save this for later use. + +## Step 2: Create a Smart Account + +1. Install the necessary dependencies: + +```bash +npm install @biconomy/account viem +``` + +2. Set up your account and biconomy configuration: + +```typescript +import { createWalletClient, http, parseEther } from "viem"; +import { privateKeyToAccount } from "viem/accounts"; +import { createSmartAccountClient, PaymasterMode, getCustomChain } from "@biconomy/account"; + +const config = { + privateKey: "your-private-key", + biconomyPaymasterApiKey: "your-paymaster-api-key", + bundlerUrl: "https://bundler.biconomy.io/api/v2/1802203764/nJPK7B3ru.dd7f7861-190d-41bd-af80-6877f74b8f44", + explorerUrl: "https://testnet.explorer.metall2.com" +}; +``` + +3. Create a Biconomy Smart Account: + +```typescript +const account = privateKeyToAccount(`0x${config.privateKey}`); +const customChain = getCustomChain( + "Metal L2 Testnet", + config.chainId, + config.providerUrl, + config.explorerUrl + ); +const client = createWalletClient({ + account, + chain: customChain, + transport: http(), +}); + +const smartWallet = await createSmartAccountClient({ + signer: client, + biconomyPaymasterApiKey: config.biconomyPaymasterApiKey, + bundlerUrl: config.bundlerUrl, +}); +const saAddress = await smartWallet.getAccountAddress(); +console.log("Smart Account Address", saAddress); +``` + +## Step 3: Send a Gasless Transaction + +1. Prepare the transaction data: + +```typescript +const tx = { + to: '0xf5715961C550FC497832063a98eA34673ad7C816', + value: parseEther('0.0001') +}; +console.log("Transaction sent:", tx); +``` + +2. Send the transaction and wait for the result: + +```typescript +const userOpResponse = await smartWallet.sendTransaction(tx, { + paymasterServiceData: { mode: PaymasterMode.SPONSORED }, +}); +const { transactionHash } = await userOpResponse.waitForTxHash(); +console.log("Transaction Hash", transactionHash); +const userOpReceipt = await userOpResponse.wait(); +if (userOpReceipt.success === "true") { + console.log("UserOp receipt", userOpReceipt); + console.log("Transaction receipt", userOpReceipt.receipt); +} +``` + +## Conclusion + +You have now successfully integrated Biconomy with Metal L2 Testnet chain and sent a gasless transaction. This setup allows your users to interact with your dApp without worrying about gas fees, improving the overall user experience. + +Remember to handle errors appropriately and consider implementing additional features like transaction status updates or retry mechanisms for failed transactions. + +For more advanced use cases and detailed documentation, refer to the [Biconomy documentation](https://docs.biconomy.io/). diff --git a/pages/chain/differences.mdx b/pages/chain/differences.mdx index 784911879..7dddb38c7 100644 --- a/pages/chain/differences.mdx +++ b/pages/chain/differences.mdx @@ -1,15 +1,15 @@ --- -title: Differences between Ethereum and OP Mainnet +title: Differences between Ethereum and Metal L2 lang: en-US -description: Learn the minor differences between the behavior of OP Mainnet and Ethereum. +description: Learn the minor differences between the behavior of Metal L2 and Ethereum. --- import { Callout } from 'nextra/components' -# Differences between Ethereum and OP Mainnet +# Differences between Ethereum and Metal L2 -OP Mainnet is designed to be [EVM equivalent](https://web.archive.org/web/20231127160757/https://medium.com/ethereum-optimism/introducing-evm-equivalence-5c2021deb306) and introduces as few changes as possible to the Ethereum protocol. -However, there are some minor differences between the behavior of Ethereum and OP Mainnet that developers should be aware of. +Metal L2 is designed to be [EVM equivalent](https://web.archive.org/web/20231127160757/https://medium.com/ethereum-optimism/introducing-evm-equivalence-5c2021deb306) and introduces as few changes as possible to the Ethereum protocol. +However, there are some minor differences between the behavior of Ethereum and Metal L2 that developers should be aware of. ## Opcodes @@ -52,26 +52,26 @@ In all other cases, the transaction sender address is set according to the same ### Transaction Fees -Transactions on OP Mainnet must pay for an [L1 data fee](/stack/transactions/fees#the-l1-data-fee) on top of the standard [execution gas fee](/stack/transactions/fees#execution-gas-fee) you would expect on Ethereum. -Refer to the guide on [OP Mainnet Transaction Fees](/stack/transactions/fees) for more information. +Transactions on Metal L2 must pay for an [L1 data fee](/stack/transactions/fees#the-l1-data-fee) on top of the standard [execution gas fee](/stack/transactions/fees#execution-gas-fee) you would expect on Ethereum. +Refer to the guide on [Metal L2 Transaction Fees](/stack/transactions/fees) for more information. ### EIP-1559 Parameters -The base fee on OP Mainnet is, like Ethereum, computed via the [EIP-1559](https://notes.ethereum.org/@vbuterin/eip-1559-faq) mechanism. -The EIP-1559 parameters used by OP Mainnet differ from those used by Ethereum as follows. +The base fee on Metal L2 is, like Ethereum, computed via the [EIP-1559](https://notes.ethereum.org/@vbuterin/eip-1559-faq) mechanism. +The EIP-1559 parameters used by Metal L2 differ from those used by Ethereum as follows. -| Parameter | OP Mainnet value | Ethereum value (for reference) | -| ------------------------------------- | ---------------: | -----------------------------: | -| Block gas limit | 30,000,000 gas | 30,000,000 gas | -| Block gas target | 5,000,000 gas | 15,000,000 gas | -| EIP-1559 elasticity multiplier | 6 | 2 | -| EIP-1559 denominator | 250 | 8 | -| Maximum base fee increase (per block) | 2% | 12.5% | -| Maximum base fee decrease (per block) | 0.4% | 12.5% | -| Block time in seconds | 2 | 12 | +| Parameter | Metal L2 value | Ethereum value (for reference) | +| ------------------------------------- | -------------: | -----------------------------: | +| Block gas limit | 30,000,000 gas | 30,000,000 gas | +| Block gas target | 5,000,000 gas | 15,000,000 gas | +| EIP-1559 elasticity multiplier | 6 | 2 | +| EIP-1559 denominator | 250 | 8 | +| Maximum base fee increase (per block) | 2% | 12.5% | +| Maximum base fee decrease (per block) | 0.4% | 12.5% | +| Block time in seconds | 2 | 12 | ### Mempool Rules -Unlike Ethereum, OP Mainnet does not have a large public mempool. -The OP Mainnet Sequencer mempool is currently only visible to the Sequencer. +Unlike Ethereum, Metal L2 does not have a large public mempool. +The Metal L2 Sequencer mempool is currently only visible to the Sequencer. The Sequencer executes transactions from the mempool in priority fee order (highest fee first). diff --git a/pages/chain/getting-started.mdx b/pages/chain/getting-started.mdx index 1c3958856..f1e07e18a 100644 --- a/pages/chain/getting-started.mdx +++ b/pages/chain/getting-started.mdx @@ -1,36 +1,36 @@ --- -title: Getting Started Developing for OP Mainnet +title: Getting Started Developing for Metal L2 lang: en-US -description: Learn the basics of OP Mainnet development. +description: Learn the basics of Metal L2 development. --- import { Steps } from 'nextra/components' -# Getting Started Developing for OP Mainnet +# Getting Started Developing for Metal L2 -This guide explains the basics of OP Mainnet development. -OP Mainnet is [EVM equivalent](https://web.archive.org/web/20231127160757/https://medium.com/ethereum-optimism/introducing-evm-equivalence-5c2021deb306), meaning we run a slightly modified version of the same `geth` you run on mainnet. -Therefore, the differences between OP Mainnet development and Ethereum development are minor. +This guide explains the basics of Metal L2 development. +Metal L2 is [EVM equivalent](https://web.archive.org/web/20231127160757/https://medium.com/ethereum-optimism/introducing-evm-equivalence-5c2021deb306), meaning we run a slightly modified version of the same `geth` you run on mainnet. +Therefore, the differences between Metal L2 development and Ethereum development are minor. But a few differences [do exist](/chain/differences). -## OP Mainnet and OP Sepolia Endpoint URLs +## Metal L2 and Metal L2 Testnet Endpoint URLs To access any Ethereum type network you need an endpoint. [These providers](/builders/tools/connect/rpc-providers) support our networks. ### Network Choice -For development purposes we recommend you use either a local development node or [OP Sepolia](https://sepolia-optimism.etherscan.io). +For development purposes we recommend you use either a local development node or [Metal L2 Testnet](https://testnet.explorer.metall2.com/). That way you don't need to spend real money. -If you need ETH on OP Sepolia for testing purposes, [you can use this faucet](https://app.optimism.io/faucet?utm_source=docs). +If you need ETH on Metal L2 Testnet for testing purposes, [you can use this faucet](https://app.optimism.io/faucet?utm_source=docs). -## Interacting with Contracts on OP Mainnet or OP Sepolia +## Interacting with Contracts on Metal L2 or Metal L2 Testnet -We have Hardhat's Greeter contract on OP Sepolia at address [0x9d334aFBa83865E67a9219830ADA57aaA9406681](https://sepolia-optimism.etherscan.io/address/0x9d334aFBa83865E67a9219830ADA57aaA9406681#code). +We have Hardhat's Greeter contract on Metal L2 Testnet at address [0xacc0cAB1F524F34012fb766f582e3AB2049f2bC5](https://testnet.explorer.metall2.com/address/0xacc0cAB1F524F34012fb766f582e3AB2049f2bC5#code). You can verify your development stack configuration by interacting with it. ## Development Stacks -As you can see in the different development stacks below, the way you deploy contracts and interact with them on OP Mainnet or OP Sepolia is almost identical to the way you do it with L1 Ethereum. +As you can see in the different development stacks below, the way you deploy contracts and interact with them on Metal L2 or Metal L2 Testnet is almost identical to the way you do it with L1 Ethereum. The most visible difference is that you have to specify a different endpoint (of course). The list of other differences is [here](differences). @@ -52,7 +52,7 @@ Not only is it faster, but such EVMs often have extra features, such as the [abi ### Debug Before Deploying After you are done with that development, debug your decentralized application using either a [development node](/chain/testing/dev-node) or the [Sepolia test network](/chain/networks). -This lets you debug parts that are OP Mainnet specific such as calls to bridges to transfer ETH or tokens between layers. +This lets you debug parts that are Metal L2 specific such as calls to bridges to transfer ETH or tokens between layers. Only when you have a version that works well on a test network should you deploy to the production network, where every transaction has a cost. @@ -62,4 +62,4 @@ You don't have to upload your source code to [block explorers](/builders/tools/b On the test network, it lets you issue queries and transactions from the explorer's user interface. On the production network, it lets users know exactly what your contract does, which is conducive to trust. -Just remember, if you use [the Etherscan API](https://explorer.optimism.io/apis), you need one API key for OP Mainnet and a separate one for OP Sepolia. +You can find the explorer API for testnet here: [https://testnet.explorer.metall2.com/api-docs](https://testnet.explorer.metall2.com/api-docs) diff --git a/pages/chain/networks.mdx b/pages/chain/networks.mdx index 3fc2c7369..4a337e868 100644 --- a/pages/chain/networks.mdx +++ b/pages/chain/networks.mdx @@ -1,48 +1,45 @@ --- -title: OP Networks and Public RPC Endpoints +title: Metal L2 Networks and Public RPC Endpoints lang: en-US -description: Learn about the different OP networks and public RPC endpoints. +description: Learn about the different Metal L2 Networks and public RPC endpoints. --- import { Callout } from 'nextra/components' -# OP Networks and Public RPC Endpoints +# Metal L2 Networks and Public RPC Endpoints -This reference guide provides a listing of the different OP networks and public RPC endpoints. +This reference guide provides a listing of the different Metal L2 Networks and public RPC endpoints. The public RPC URLs provided below are rate limited and do not support websocket connections. If you are experiencing rate limiting issues or need websocket functionality, consider [running your own node](/builders/node-operators/rollup-node) or signing up for a [third-party RPC provider](/builders/tools/connect/rpc-providers). -## OP Mainnet - -| Parameter | Value | -| --------------------------- | ---------------------------------------------------------------------------------------- | -| Network Name | `OP Mainnet` | -| Chain ID | `10` | -| Currency Symbol1 | ETH | -| Explorer | [https://optimistic.etherscan.io](https://optimistic.etherscan.io) | -| Public RPC URL | [https://mainnet.optimism.io](https://mainnet.optimism.io) | -| Sequencer URL2 | [https://mainnet-sequencer.optimism.io](https://mainnet-sequencer.optimism.io) | -| Contract Addresses | Refer to the [Contract Addresses page](/chain/addresses#mainnet) | -| Connect Wallet | [Click here to connect your wallet to OP Mainnet](https://chainid.link?network=optimism) | - -1. The "currency symbol" is required by some wallets like MetaMask. -2. The sequencer URL is write only. - -## OP Sepolia - -| Parameter | Value | -| --------------------------- | ------------------------------------------------------------------------------------------ | -| Network Name | `OP Sepolia` | -| Chain ID | `11155420` | -| Currency Symbol1 | ETH | -| Explorer | [https://sepolia-optimistic.etherscan.io](https://sepolia-optimistic.etherscan.io) | -| Public RPC URL | [https://sepolia.optimism.io](https://sepolia.optimism.io) | -| Sequencer URL2 | [https://sepolia-sequencer.optimism.io](https://sepolia-sequencer.optimism.io) | -| Contract Addresses | Refer to the [Contract Addresses page](/chain/addresses#testnet-sepolia) | -| Connect Wallet | [Click here to connect your wallet to OP Sepolia](https://chainid.link?network=op-sepolia) | +## Metal L2 Mainnet + +| Parameter | Value | +| --------------------------- | ------------------------------------------------------------------------------------ | +| Network Name | `Metal L2` | +| Chain ID | `1750` | +| Currency Symbol1 | ETH | +| Explorer | [https://explorer.metall2.com](https://explorer.metall2.com) | +| Public RPC URL | [https://rpc.metall2.com](https://rpc.metall2.com) | +| Sequencer URL2 | [https://mainnet-sequencer.metall2.com/](https://mainnet-sequencer.metall2.com/) | +| Contract Addresses | Refer to the [Contract Addresses page](/chain/addresses#mainnet) | +| Connect Wallet | [Click here to connect your wallet to Metal L2 Mainnet](https://metall2.com/connect) | + +## Metal L2 Testnet + +| Parameter | Value | +| --------------------------- | ------------------------------------------------------------------------------------ | +| Network Name | `Metal L2 Testnet` | +| Chain ID | `1740` | +| Currency Symbol1 | ETH | +| Explorer | [https://testnet.explorer.metall2.com/](https://testnet.explorer.metall2.com/) | +| Public RPC URL | [https://testnet.rpc.metall2.com/](https://testnet.rpc.metall2.com/) | +| Sequencer URL2 | [https://testnet-sequencer.metall2.com/](https://testnet-sequencer.metall2.com/) | +| Contract Addresses | Refer to the [Contract Addresses page](/chain/addresses#testnet) | +| Connect Wallet | [Click here to connect your wallet to Metal L2 Testnet](https://metall2.com/connect) | 1. The "currency symbol" is required by some wallets like MetaMask. 2. The sequencer URL is write only. diff --git a/pages/chain/tokenlist.mdx b/pages/chain/tokenlist.mdx index 4b590e43c..6813db7cd 100644 --- a/pages/chain/tokenlist.mdx +++ b/pages/chain/tokenlist.mdx @@ -18,6 +18,14 @@ This page is automatically generated from the Superchain Token List. **The presence of a token on this page does not imply any endorsement of the token or its minter.** +## Metal L2 + + + +## Metal L2 Testnet + + + ## OP Mainnet diff --git a/pages/connect/_meta.json b/pages/connect/_meta.json index 3efad2c2d..8e149c32a 100644 --- a/pages/connect/_meta.json +++ b/pages/connect/_meta.json @@ -1,14 +1,4 @@ { "contribute": "Contribute", - "resources": "Resources", - "live-support": { - "title": "Get Launch Support", - "href": "https://share.hsforms.com/1yENj8CV9TzGYBASD0JC8_gqoshb", - "newWindow": true -}, - "governance": { - "title": "Optimism Governance", - "href": "https://community.optimism.io/docs/governance/", - "newWindow": true - } + "resources": "Resources" } diff --git a/pages/connect/contribute/_meta.json b/pages/connect/contribute/_meta.json index 39ebe0e09..108b94efa 100644 --- a/pages/connect/contribute/_meta.json +++ b/pages/connect/contribute/_meta.json @@ -1,5 +1,4 @@ { - "docs-contribute": "Contribute to Optimism Docs", - "stack-contribute": "Contribute to OP Stack", + "docs-contribute": "Contribute to Metal L2 Docs", "style-guide": "Docs Style Guide" } \ No newline at end of file diff --git a/pages/connect/contribute/docs-contribute.mdx b/pages/connect/contribute/docs-contribute.mdx index bfe48b94d..9e7e529ec 100644 --- a/pages/connect/contribute/docs-contribute.mdx +++ b/pages/connect/contribute/docs-contribute.mdx @@ -1,30 +1,25 @@ --- -title: Ways to Contribute to Optimism Docs +title: Ways to Contribute to Metal L2 Docs lang: en-US -description: Learn about the different ways you can contribute to Optimism Docs. +description: Learn about the different ways you can contribute to Metal L2 Docs. --- import { Callout } from 'nextra/components' -# Contribute to Optimism Docs +# Contribute to Metal L2 Docs -Optimism Docs (docs.optimism.io) is an open-source project, and we welcome your contributions. Here's how you can help grow and support the Optimism Collective. - - - We recently migrated our technical docs from community.optimism.io --> docs.optimism.io. - So, if you contributed to either repo in 2023, don't forget to claim your [POAP token](#claim-your-gitpoap)! - +Metal L2 Docs(docs.metall2.com) is an open-source project, and we welcome your contributions. Here's how you can help grow and support Metal L2 and the Optimism SuperChain. ## Ways to contribute -* [Work on a good first issue](https://github.com/ethereum-optimism/docs/labels/good%20first%20issue): make the greatest and most immediate impact with a quick-start or tutorial. These special issues are clearly labeled for new contributors to Optimism. +* [Work on a good first issue](https://github.com/MetalPay/metal-l2-docs/labels/good%20first%20issue): make the greatest and most immediate impact with a quick-start or tutorial. These special issues are clearly labeled for new contributors to Metal L2. * [Edit existing content](#how-to-work-on-docsoptimismio): make tweaks to existing content using the ✏️ **Edit this page on GitHub** or ❤️ **Share general feedback** links on the right-side of any page. -* [Add or update an FAQ item](https://github.com/ethereum-optimism/docs/issues/new?assignees=\&labels=documentation%2Cfaq%2Ccommunity-request\&projects=\&template=suggest_faq_item.yaml\&title=Suggest+an+FAQ+item): +* [Add or update an FAQ item](https://github.com/MetalPay/metal-l2-docs/issues/new?assignees=\&labels=documentation%2Cfaq%2Ccommunity-request\&projects=\&template=suggest_faq_item.yaml\&title=Suggest+an+FAQ+item): add a new FAQ (question+answer set) to an [existing page](/chain/security/faq#security-model-faq), create a new FAQ page, or update an existing FAQ question/answer set. -* [Add or update a troubleshooting item](https://github.com/ethereum-optimism/docs/issues/new?assignees=\&labels=documentation%2Ctroubleshooting%2Ccommunity-request\&projects=\&template=suggest_troubleshooting_item.yaml\&title=Suggest+a+troubleshooting+item): +* [Add or update a troubleshooting item](https://github.com/MetalPay/metal-l2-docs/issues/new?assignees=\&labels=documentation%2Ctroubleshooting%2Ccommunity-request\&projects=\&template=suggest_troubleshooting_item.yaml\&title=Suggest+a+troubleshooting+item): add a new troubleshooting item (problem+solution set) to an [existing page](/builders/chain-operators/management/troubleshooting), create a new troubleshooting page, or update an existing troubleshooting problem/solution set. -* [Add a glossary term](https://github.com/ethereum-optimism/docs/issues/new?assignees=\&labels=glossary%2Cdocumentation%2Ccommunity-request\&projects=\&template=suggest_glossary_term.yaml\&title=Suggest+a+glossary+term): - help us continue to expand the Optimism [glossary](/connect/resources/glossary). +* [Add a glossary term](https://github.com/MetalPay/metal-l2-docs/issues/new?assignees=\&labels=glossary%2Cdocumentation%2Ccommunity-request\&projects=\&template=suggest_glossary_term.yaml\&title=Suggest+a+glossary+term): + help us continue to expand the Metal L2 [glossary](/connect/resources/glossary). * [Add a faucet to the developer community](https://github.com/ethereum-optimism/developers/tree/main/community): add a new faucet to the [Faucets page](https://github.com/ethereum-optimism/developers/blob/main/community/tools/faucets.md) or update an existing faucet. * [Add an oracle to the developer community](https://github.com/ethereum-optimism/developers/tree/main/community): @@ -35,60 +30,33 @@ Optimism Docs (docs.optimism.io) is an open-source project, and we welcome your add a new block explorer to the [Block Explorers page](https://github.com/ethereum-optimism/developers/blob/main/community/tools/block-explorers.md) or update an existing block explorer. * [Add a blockchain indexer to the developer community](https://github.com/ethereum-optimism/developers/tree/main/community): add a new blockchain indexer to the [Blockchain Indexers page](https://github.com/ethereum-optimism/developers/blob/main/community/tools/blockchain-indexers.md) or update an existing blockchain indexer. -* [Work on an open issue](https://github.com/ethereum-optimism/docs/issues): start with items we've already identified as needing attention, which range from general guides to tutorials and quickstarts. -* [Create new content](https://github.com/ethereum-optimism/docs/issues/new): create new content to add to the technical docs. - Review the [style guide](style-guide) and follow the PR process outlined in the [contributor guidelines](https://github.com/ethereum-optimism/docs/blob/main/CONTRIBUTING.md) to get started. +* [Work on an open issue](https://github.com/MetalPay/metal-l2-docs/issues): start with items we've already identified as needing attention, which range from general guides to tutorials and quickstarts. +* [Create new content](https://github.com/MetalPay/metal-l2-docs/issues/new): create new content to add to the technical docs. + Review the [style guide](style-guide) and follow the PR process outlined in the [contributor guidelines](https://github.com/MetalPay/metal-l2-docs/blob/main/CONTRIBUTING.md) to get started. * [Submit a bug report](https://immunefi.com/bounty/optimism/): create a report to help us improve our products and developer tooling. For more information, please read our [Security Policy](/chain/security/security-policy). -* [Contribute to the Optimism Collective](https://github.com/ethereum-optimism/ecosystem-contributions): select from several different categories where you can make an impact such as - [foundation missions](https://github.com/ethereum-optimism/ecosystem-contributions/issues?q=is%3Aissue+is%3Aopen+label%3A%22Foundation+Mission+%28RFP%29%22) or general [contributor opportunities](https://github.com/ethereum-optimism/ecosystem-contributions/issues?q=is%3Aissue+is%3Aopen+label%3A%22Contribution+Opportunity%22). -## How to work on docs.optimism.io +## How to work on docs.metall2.com Whether you're adding to the site, creating content, or working on open issues, you'll need a [GitHub](https://github.com) account. All updates are made via the GitHub PR process. This means you create a local copy of the website, make your changes and request to merge your changes. -Please see the [contributor guidelines](https://github.com/ethereum-optimism/docs/blob/main/CONTRIBUTING.md) for more details. +Please see the [contributor guidelines](https://github.com/MetalPay/metal-l2-docs/blob/main/CONTRIBUTING.md) for more details. You don't need permission to work on anything, but it's always best to let us know what you're planning to do, so we don't duplicate efforts. You can do this by: -* Commenting on an issue or PR in [GitHub](https://github.com/ethereum-optimism/docs/) -* Messaging us in the [developer support channel](https://github.com/ethereum-optimism/developers/) +* Commenting on an issue or PR in [GitHub](https://github.com/MetalPay/metal-l2-docs/) Before contributing, make sure you're familiar with: -* the [Optimism vision and values](https://www.optimism.io/about) -* our [contributor guidelines](https://github.com/ethereum-optimism/docs/blob/main/CONTRIBUTING.md) +* our [contributor guidelines](https://github.com/MetalPay/metal-l2-docs/blob/main/CONTRIBUTING.md) * our [style guide](style-guide) -* our [code of conduct](https://github.com/ethereum-optimism/.github/blob/master/CODE_OF_CONDUCT.md) ## How decisions about the site are made Decisions about individual PRs, tutorials, and major docs updates are made by the Developer Relations team. -We want to transition to a more community-informed and community-generated approach for the Optimism Docs, so please raise questions in issues, submit PRs, or contact the team: - -* Please contact the Foundation's service provider at [devrel@oplabs.co](mailto:devrel@oplabs.co). -* Raise questions or contact the [developer support channel](https://github.com/ethereum-optimism/developers/). +We want to transition to a more community-informed and community-generated approach for the Metal L2 Docs, so please raise questions in issues, submit PRs, or contact the team: ### A note on plagiarism -Only use your original work or content that you have permission to use when contributing any content or artifact to docs.optimism.io. -Many projects use open-source licensing that allows for the free sharing of information. However, if you cannot find this information, do not attempt to add it to docs.optimism.io. +Only use your original work or content that you have permission to use when contributing any content or artifact to docs.metall2.com. +Many projects use open-source licensing that allows for the free sharing of information. However, if you cannot find this information, do not attempt to add it to docs.metall2.com. Any pull requests deemed as plagiarism will get rejected. - -## Claim your GitPOAP - -We use GitPOAPs to recognize our contributors! GitPOAP automatically recognizes your merged contribution and lets you mint a unique contributors POAP directly on their platform. - -### How to claim - -1. Visit [Optimism's GitPOAP page](https://www.gitpoap.io/gh/ethereum-optimism). -2. Connect with your wallet or your email through sign in option. -3. Search for your GitHub username, ETH address, ENS names or any GitPOAP to check if you're eligible. -4. If your GitHub account is eligible, then you are able to mint a GitPOAP! - - - You should only use self-custody wallets to claim POAPs. Do not use exchange accounts or other accounts you do not hold the private keys to, as these will not allow you to access and manage your POAPs. - - -## Still Have Questions? - -You can reach us in our developer support [forum](https://github.com/ethereum-optimism/developers/discussions). We look forward to growing the Collective with you! diff --git a/pages/connect/contribute/stack-contribute.mdx b/pages/connect/contribute/stack-contribute.mdx deleted file mode 100644 index 159cdc5aa..000000000 --- a/pages/connect/contribute/stack-contribute.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: Contribute to the OP Stack -lang: en-US -description: Learn different ways you can contribute to the OP Stack. ---- - -import { Callout } from 'nextra/components' - -# Contribute to the OP Stack - -The OP Stack is a collaborative, decentralized development stack that only gets more powerful as more people contribute. Code for the OP Stack should follow the stack's [design principles](/stack/design-principles), which means it should be entirely open source and accessible for people to hack on, contribute to, and extend. -The Optimism Collective wins when it works together. ♥️✨ - -Whether you're a budding chain operator, app developer, node operator, bounty hunter, content creator, or anything in between, the OP Stack always has something for you to contribute to. -Every contribution makes a difference — no contribution is too small. If you're ready to contribute, check out one of the following contributor pathways below. - -## Component Contributions - -The OP Stack is a decentralized development stack and is constantly evolving as new layers and modules are developed. Anyone can contribute components that can be considered part of the OP Stack as long as those components fit the stack's [design principles and goals](/stack/design-principles). -To start contributing components to the stack, check out some of these [useful ideas](https://github.com/ethereum-optimism/ecosystem-contributions) and get to building! And don't forget that projects can also receive grants from the Collective via [RetroPGF](https://community.optimism.io/docs/citizen-house/how-retro-funding-works/). - -## Codebase Contributions - -The OP Stack codebase is not a product (in the traditional sense) but rather a collection of software components that power the Optimism ecosystem. -If you'd like to contribute to the current release of OP Stack codebase, rather than creating new components, your contribution would be greatly appreciated. -**A "Release"of the OP Stack codebase is a particular set of software components that are production-ready and which fit the stack's design principles and goals.** - -To make your first contribution to the codebase, check out the [open issues](https://github.com/ethereum-optimism/optimism/issues) on the Optimism Monorepo. - - - Only the software components included within the current release of the OP Stack codebase are considered in the scope of the OP Stack. - Any usage of the OP Stack outside of the official, intended capabilities of the current release are considered [OP Stack Hacks](/builders/chain-operators/hacks/overview) — unofficial modifications that are useful for experimentation but could have unforeseen results, such as security vulnerabilities, and are likely to cause your chain to no longer be interoperable with the [Optimism Superchain](https://app.optimism.io/superchain/). - Developer support for OP Stack Hacks is limited — when in doubt, stick to the capabilities of the current release! - - -## Bounty Hunting - -The OP Stack needs YOU (yes you!) to help review the codebase for bugs and vulnerabilities. If you're interested in bounty hunting, check out our [Security Policy, Vulnerability Reporting, and Bug Bounties page](/chain/security/security-policy). - -## Docs Contributions - -Want a new tutorial? See something that could be a little clearer? Check out the [Optimism Docs Contribution page](docs-contribute) for more information on how to help. No contribution is too small! - -## Community Contributions - -If you're looking for other ways to get involved, here are a few options: - -* Grab an idea from the [project ideas list](https://github.com/ethereum-optimism/ecosystem-contributions) to start building -* [Suggest a new idea](https://github.com/ethereum-optimism/ecosystem-contributions/issues/74) for the project ideas list -* Become an Optimism Ambassador, Support Nerd, and more in the [Optimism Discord](https://discord.gg/optimism) diff --git a/pages/connect/contribute/style-guide.mdx b/pages/connect/contribute/style-guide.mdx index c9c38067b..88184d758 100644 --- a/pages/connect/contribute/style-guide.mdx +++ b/pages/connect/contribute/style-guide.mdx @@ -1,17 +1,16 @@ --- -title: Optimism Docs Style Guide +title: Metal L2 DocsStyle Guide lang: en-US -description: This guide explains how to write technical content for Optimism Docs using a consistent voice, tone, and style. +description: This guide explains how to write technical content for Metal L2 Docs using a consistent voice, tone, and style. --- import { Callout } from 'nextra/components' # Docs Style Guide -This Style Guide aims to assist Optimists in writing technical content with a consistent voice, tone, and style. See the [glossary](/connect/resources/glossary) for an alphabetical listing of commonly used words, terms, and concepts used throughout the technical docs and across the OP Collective. +This Style Guide aims to assist Metal L2 contributors in writing technical content with a consistent voice, tone, and style. See the [glossary](/connect/resources/glossary) for an alphabetical listing of commonly used words, terms, and concepts used throughout the technical docs and across the OP Collective. * For docs-related questions or comments, create an issue in the [docs repo](https://github.com/ethereum-optimism/docs/issues). -* For support-related questions or comments, create an issue in the [developers repo](https://github.com/ethereum-optimism/developers/issues). **Table of Contents** @@ -27,7 +26,7 @@ This Style Guide aims to assist Optimists in writing technical content with a co ### Folder Structure -The folder structure for the [docs.optimism.io](https://github.com/ethereum-optimism/docs) repository is organized into several high-level categories under the main `pages` folder such as `builders`, `chain`, `connect`, and `stack`. +The folder structure for the [docs.metall2.com](https://github.com/ethereum-optimism/docs) repository is organized into several high-level categories under the main `pages` folder such as `builders`, `chain`, `connect`, and `stack`. The left sidebar (side navigation) is managed in the `_meta.json` file, which should be edited only for adding or deleting pages. Frequent edits may lead to merge conflicts due to ongoing content updates. Accept changes from others when committing a PR. @@ -51,7 +50,7 @@ File paths, when mentioned **within** a docs page, should be formatted as code s ### Voice and Tone -Write in a friendly, yet professional tone. We are upbeat, knowledgeable, and **optimistic** about the development of the Optimism Collective, which we try our best to convey in our technical documentation. +Write in a friendly, yet professional tone. We are upbeat, knowledgeable, and **optimistic** about the development of Metal Layer 2, which we try our best to convey in our technical documentation. ### Clear and Concise Language @@ -256,7 +255,7 @@ import Image from 'next/image' /> ``` -* Icons come from [Remix](https://remixicon.com/) to maintain consistency across the docs. Use Optimism Red `FF0420` to color icons before downloading and store icons in `public/img/icons` directory. +* Icons come from [Remix](https://remixicon.com/) to maintain consistency across the docs. Use Metal L2 Yellow `FF0420` to color icons before downloading and store icons in `public/img/icons` directory. ### Videos @@ -431,7 +430,7 @@ The heading level for FAQs will vary based on if it's an FAQ-only doc or if FAQs 4. Enter the information, and click **Save**. -Include a category heading when you need to group related FAQ content (e.g., See the Optimism Glossary for a detailed example). Category headings are optional, but helpful, for longer FAQs. +Include a category heading when you need to group related FAQ content (e.g., See the our glossary for a detailed example). Category headings are optional, but helpful, for longer FAQs. ### Troubleshooting Guides @@ -503,7 +502,7 @@ Please use `*` instead of `-` for items in a list. This maintains consistency ac * **Commas (,)** Use a serial comma in lists of three or more items and use the oxford comma preceding the "and" before the last element in a list. - **Example**: The developer built a node, social app, and DeFi app for the Optimism Collective. + **Example**: The developer built a node, social app, and DeFi app for Metal Layer 2. * **Em dash (—)** Use to indicate a break in thought or a parenthetical comment. Do not add spaces around the em dash. diff --git a/pages/connect/resources/_meta.json b/pages/connect/resources/_meta.json index 97804169a..06d00cdc2 100644 --- a/pages/connect/resources/_meta.json +++ b/pages/connect/resources/_meta.json @@ -1,7 +1,7 @@ { "changelog": { "title": "Changelog", - "href": "https://github.com/ethereum-optimism/optimism/releases", + "href": "https://github.com/MetalLayer2/ethereum-optimism.github.io/releases", "newWindow": true }, "glossary": "Glossary" diff --git a/pages/connect/resources/glossary.mdx b/pages/connect/resources/glossary.mdx index 51ed26994..e12b74f0e 100644 --- a/pages/connect/resources/glossary.mdx +++ b/pages/connect/resources/glossary.mdx @@ -1,14 +1,14 @@ --- title: Glossary lang: en-US -description: Learn the meaning of important terminology used throughout the Optimism Developer Documentation. +description: Learn the meaning of important terminology used throughout the Developer Documentation. --- import { Callout } from 'nextra/components' # Glossary -The glossary provides definitions of important terminology used throughout the Optimism Developer Documentation. To make revisions to this page, please [submit an issue](https://github.com/ethereum-optimism/docs/issues/new?assignees=\&labels=glossary%2Cdocumentation%2Ccommunity-request\&projects=\&template=suggest_glossary_term.yaml\&title=%5BGLOSSARY%5D+Add+PR+title). +The glossary provides definitions of important terminology used throughout the Developer Documentation. To make revisions to this page, please [submit an issue](https://github.com/ethereum-optimism/docs/issues/new?assignees=\&labels=glossary%2Cdocumentation%2Ccommunity-request\&projects=\&template=suggest_glossary_term.yaml\&title=%5BGLOSSARY%5D+Add+PR+title). ## Table of Contents @@ -48,24 +48,18 @@ come from L1 block synchronization or from a block freshly minted by the executi at the request of the L1 consensus layer. On L2, the executed blocks are freshly minted by the execution engine at the request of the [rollup node](#rollup-node), using transactions [derived from L1 blocks](#l2-chain-derivation). -#### Optimism Collective -The Optimism Collective is a band of people, projects, and companies working together to build a better economy for everyone, -united by a mutually beneficial pact to adhere to the axiom of impact=profit — the principle that positive impact to the collective should be rewarded with profit to the individual. -New model of digital democratic governance optimized to drive rapid and sustained growth of a decentralized ecosystem. +#### MTL Token - -#### OP Token - -A governance token, referred to as "OP." Content should not discuss the token price or speculate on the price, and content that refers to OP incorrectly will be removed from Optimism platforms and will not be eligible for promotion. +A governance token, referred to as "MTL." Content should not discuss the token price or speculate on the price. #### Layer 1 (L1) -Refers the Ethereum blockchain, used in contrast to [layer 2](#layer-2-l2), which refers to Optimism. +Refers to the Ethereum blockchain, used in contrast to [layer 2](#layer-2-l2), which refers to Metal L2. #### Layer 2 (L2) -Refers to the Optimism blockchain and is used in contrast to [layer 1](#layer-1-l1), which refers to the Ethereum blockchain. +Refers to the Metal L2 blockchain and is used in contrast to [layer 1](#layer-1-l1), which refers to the Ethereum blockchain. #### L2 Output Root @@ -351,7 +345,7 @@ of the channel are seen, or else these frames are ignored.) #### Data Availability Guarantee that some data will be "available" (i.e. *retrievable*) during a reasonably long time -window. In Optimism's case, the data in question are [sequencer batches](#sequencer-batch) that [validators](#validator) +window. In Metal L2's case, the data in question are [sequencer batches](#sequencer-batch) that [validators](#validator) needs in order to verify the sequencer's work and validate the L2 chain. The [finalization period](#finalization-period) should be taken as the lower bound on the availability window, since that is when data availability is the most crucial, as it is needed to perform a [fault proof](#fault-proof). "Availability" **does not** mean guaranteed long-term storage of the data. diff --git a/pages/index.mdx b/pages/index.mdx index 3d15e72b9..3334103e7 100644 --- a/pages/index.mdx +++ b/pages/index.mdx @@ -1,25 +1,24 @@ --- -title: Welcome to the Optimism Docs +title: Welcome to the Metal L2 Docs lang: en-US -description: Learn about the Optimism Collective, the Optimism Docs, and how to get started building with Optimism. +description: Learn about the Metal DAO, the Metal L2 Docs, and how to get started building with Metal L2. --- import { Cards, Card } from 'nextra/components' -# Welcome to the Optimism Docs +# Welcome to the Metal L2 Docs -Welcome to the Optimism Docs, the unified home of the [Optimism Collective's](/connect/resources/glossary#optimism-collective) technical documentation and information about the [OP Stack](/stack/getting-started). -Information about the Optimism Collective's governance, community, and mission can be found on the [Optimism Community Hub](https://community.optimism.io/docs/governance/). +Welcome to Metal L2 Docs, the unified home of [Metal L2's](/connect/resources/glossary#metal-l2) technical documentation and information about the [OP Stack](/stack/getting-started) that Metal L2 is built on. + +Information about Metal DAO's governance, community, and mission can be found on the [Metal L2 Website](https://metall2.com). ## Guides for Builders -Whether you're a developer building a app on OP Mainnet, a node operator running an OP Mainnet node, or a chain operator launching your own OP Stack chain, you'll find everything you need to get started right here. +Whether you're a developer building a app on Metal L2 or a node operator running a Metal L2 node you'll find everything you need to get started right here. } /> - } /> - } /> } /> @@ -29,7 +28,7 @@ Whether you're a developer building a app on OP Mainnet, a node operator running ## Featured Tools -Check out these amazing tools, so you can get building with Optimism. +Check out these amazing tools, so you can get building with Metal L2. } /> @@ -41,15 +40,18 @@ Check out these amazing tools, so you can get building with Optimism. } /> -## Learn About Optimism +## Learn About Metal L2 + +Metal L2 is an [EVM equivalent](https://web.archive.org/web/20231127160757/https://medium.com/ethereum-optimism/introducing-evm-equivalence-5c2021deb306) Layer 2 blockchain connected to Ethereum built on the Superchain using the OP Stack. + +The OP Stack is the standardized, shared, and open-source development stack for the Superchain that makes it easy for production-ready Layer 2 blockchains just like Metal L2 to benefit from shared security, scalability, interoperability, ecosystem support and economic efficiency. -OP Mainnet is an [EVM equivalent](https://web.archive.org/web/20231127160757/https://medium.com/ethereum-optimism/introducing-evm-equivalence-5c2021deb306) Layer 2 blockchain connected to Ethereum. -The OP Stack is the standardized, shared, and open-source development stack that makes it easy to spin up your own production-ready Layer 2 blockchain just like OP Mainnet. The Superchain is a network of OP Stack chains that share a bridging protocol, governance system, and more. -We've got you covered with these detailed guides to help you learn all about Optimism's tech stack. + +These documents should have you covered with detailed guides to help you learn all about Metal L2's tech stack. - } /> + } /> } /> diff --git a/pages/stack/_meta.json b/pages/stack/_meta.json index 98eefb94c..b4de87ce1 100644 --- a/pages/stack/_meta.json +++ b/pages/stack/_meta.json @@ -1,5 +1,5 @@ { - "getting-started": "Getting Started: OP Stack", + "getting-started": "About: OP Stack", "differences": "Differences Between Ethereum and OP Stack Chains", "components": "OP Stack Components", "explainer": "Superchain Explainer", diff --git a/pages/stack/protocol/fault-proofs/challenger.mdx b/pages/stack/protocol/fault-proofs/challenger.mdx index 3f23d83f3..540d7b579 100644 --- a/pages/stack/protocol/fault-proofs/challenger.mdx +++ b/pages/stack/protocol/fault-proofs/challenger.mdx @@ -31,7 +31,7 @@ graph TD; OPP -->|Resolves Claims| DG DG -->|Claims Paid| Bonds[Bonds for Challenger and Proposer] - classDef default fill:#00,stroke:#FF0420,stroke-width:2px; + classDef default fill:#00,stroke:#FC9237,stroke-width:2px; ``` diff --git a/pages/stack/protocol/rollup/smart-contracts.mdx b/pages/stack/protocol/rollup/smart-contracts.mdx index a3af040ae..706a39f5f 100644 --- a/pages/stack/protocol/rollup/smart-contracts.mdx +++ b/pages/stack/protocol/rollup/smart-contracts.mdx @@ -243,7 +243,7 @@ The Bedrock protocol upgrade was designed to minimize the amount of code in the OP Stack, pushed it as close as possible to Ethereum-Equivalence, and most importantly making the stack modular. -* [Bedrock release notes](https://github.com/ethereum-optimism/optimism/releases/tag/op-contracts%2Fv1.0.0) ... +* [Bedrock release notes](https://github.com/MetalLayer2/ethereum-optimism.github.io/releases/tag/op-contracts%2Fv1.0.0) ... * [Governance post](https://gov.optimism.io/t/final-upgrade-1-bedrock-protocol-upgrade-v2/5548) ### v1.1.0 - ProtocolVersions @@ -265,14 +265,14 @@ future hardforks, not the activation of said hardforks. of the OP-Stack. This is an optional feature. -* [ProtocolVersions release notes](https://github.com/ethereum-optimism/optimism/releases/tag/op-contracts%2Fv1.1.0) +* [ProtocolVersions release notes](https://github.com/MetalLayer2/ethereum-optimism.github.io/releases/tag/op-contracts%2Fv1.1.0) ### v1.2.0 - SuperchainConfig with Extended Pause Functionality The SuperchainConfig contract is used to manage global configuration values for multiple OP Chains within a single Superchain network. -* [SuperchainConfig and Extended Pause release notes](https://github.com/ethereum-optimism/optimism/releases/tag/op-contracts%2Fv1.2.0) +* [SuperchainConfig and Extended Pause release notes](https://github.com/MetalLayer2/ethereum-optimism.github.io/releases/tag/op-contracts%2Fv1.2.0) * [Governance post](https://gov.optimism.io/t/upgrade-proposal-4/7534) ### v1.3.0 - Multi-Chain Prep (MCP) @@ -283,5 +283,5 @@ chains in a single transaction. This upgrade also extends the `SystemConfig` to contain the addresses of the contracts in the network, allowing users to discover the system's contract addresses programmatically. -* [MCP release notes](https://github.com/ethereum-optimism/optimism/releases/tag/op-contracts%2Fv1.3.0-rc.1) +* [MCP release notes](https://github.com/MetalLayer2/ethereum-optimism.github.io/releases/tag/op-contracts%2Fv1.3.0-rc.1) * [Governance post](https://gov.optimism.io/t/upgrade-proposal-6-multi-chain-prep-mcp-l1/7677) diff --git a/public/img/icons/500-page.svg b/public/img/icons/500-page.svg index c4d5a70ae..db313120f 100644 --- a/public/img/icons/500-page.svg +++ b/public/img/icons/500-page.svg @@ -1,4 +1,4 @@ - + diff --git a/public/img/icons/arrow-left-right.svg b/public/img/icons/arrow-left-right.svg index 855c0cfde..93ae89f26 100644 --- a/public/img/icons/arrow-left-right.svg +++ b/public/img/icons/arrow-left-right.svg @@ -1,3 +1,10 @@ - - + + + + + + + + + diff --git a/public/img/icons/asterisk.svg b/public/img/icons/asterisk.svg index 23ddf52f3..1fd584502 100644 --- a/public/img/icons/asterisk.svg +++ b/public/img/icons/asterisk.svg @@ -1,3 +1,3 @@ - - + + diff --git a/public/img/icons/book.svg b/public/img/icons/book.svg index 0f528f646..f3adab939 100644 --- a/public/img/icons/book.svg +++ b/public/img/icons/book.svg @@ -1,3 +1,3 @@ - - + + diff --git a/public/img/icons/build.svg b/public/img/icons/build.svg index ecee209ec..e47d748e0 100644 --- a/public/img/icons/build.svg +++ b/public/img/icons/build.svg @@ -1,3 +1,10 @@ - + + + + + + + + diff --git a/public/img/icons/computer-line.svg b/public/img/icons/computer-line.svg index aa5e84778..bdb34cf23 100644 --- a/public/img/icons/computer-line.svg +++ b/public/img/icons/computer-line.svg @@ -1 +1,3 @@ - \ No newline at end of file + + + diff --git a/public/img/icons/favicon.ico b/public/img/icons/favicon.ico index 7abd812e5..cfce4d51d 100644 Binary files a/public/img/icons/favicon.ico and b/public/img/icons/favicon.ico differ diff --git a/public/img/icons/file-edit-line.svg b/public/img/icons/file-edit-line.svg index bc5a8705d..8458db442 100644 --- a/public/img/icons/file-edit-line.svg +++ b/public/img/icons/file-edit-line.svg @@ -1 +1,3 @@ - \ No newline at end of file + + + diff --git a/public/img/icons/gear.svg b/public/img/icons/gear.svg index 785011111..e8a586a93 100644 --- a/public/img/icons/gear.svg +++ b/public/img/icons/gear.svg @@ -1,3 +1,10 @@ - - + + + + + + + + + diff --git a/public/img/icons/government-line.svg b/public/img/icons/government-line.svg index 445ba0b23..7af06fcb1 100644 --- a/public/img/icons/government-line.svg +++ b/public/img/icons/government-line.svg @@ -1 +1,3 @@ - \ No newline at end of file + + + diff --git a/public/img/icons/instance-line.svg b/public/img/icons/instance-line.svg index 6e6fe254a..afd77ae80 100644 --- a/public/img/icons/instance-line.svg +++ b/public/img/icons/instance-line.svg @@ -1 +1,3 @@ - \ No newline at end of file + + + diff --git a/public/img/icons/link.svg b/public/img/icons/link.svg index aee73d0ae..8c4ac3e78 100644 --- a/public/img/icons/link.svg +++ b/public/img/icons/link.svg @@ -1,3 +1,10 @@ - + + + + + + + + diff --git a/public/img/icons/news-line.svg b/public/img/icons/news-line.svg index 25d50f800..7a0d35b6b 100644 --- a/public/img/icons/news-line.svg +++ b/public/img/icons/news-line.svg @@ -1 +1,3 @@ - \ No newline at end of file + + + diff --git a/public/img/icons/person.svg b/public/img/icons/person.svg index 43b61f3b2..4c3cf502d 100644 --- a/public/img/icons/person.svg +++ b/public/img/icons/person.svg @@ -1,3 +1,10 @@ - + + + + + + + + diff --git a/public/img/icons/question-answer-line.svg b/public/img/icons/question-answer-line.svg index 962011f72..8c4ad1007 100644 --- a/public/img/icons/question-answer-line.svg +++ b/public/img/icons/question-answer-line.svg @@ -1 +1,3 @@ - + + + diff --git a/public/img/icons/rocket-2-line.svg b/public/img/icons/rocket-2-line.svg index 98cd668e1..05374a543 100644 --- a/public/img/icons/rocket-2-line.svg +++ b/public/img/icons/rocket-2-line.svg @@ -1 +1,3 @@ - \ No newline at end of file + + + diff --git a/public/img/icons/shapes.svg b/public/img/icons/shapes.svg index 0c877815c..515edcf3b 100644 --- a/public/img/icons/shapes.svg +++ b/public/img/icons/shapes.svg @@ -1,3 +1,10 @@ - + + + + + + + + diff --git a/public/img/icons/stack-line.svg b/public/img/icons/stack-line.svg index 712f04f6a..cacd6e073 100644 --- a/public/img/icons/stack-line.svg +++ b/public/img/icons/stack-line.svg @@ -1 +1,3 @@ - \ No newline at end of file + + + diff --git a/public/img/icons/stack.svg b/public/img/icons/stack.svg index 7d8464feb..195121999 100644 --- a/public/img/icons/stack.svg +++ b/public/img/icons/stack.svg @@ -1,3 +1,10 @@ - + + + + + + + + diff --git a/public/img/icons/terminal-window-line.svg b/public/img/icons/terminal-window-line.svg index e56c05668..153be36db 100644 --- a/public/img/icons/terminal-window-line.svg +++ b/public/img/icons/terminal-window-line.svg @@ -1 +1,3 @@ - \ No newline at end of file + + + diff --git a/public/img/icons/tools.svg b/public/img/icons/tools.svg index 4bd4bcd87..3a5a7f1f1 100644 --- a/public/img/icons/tools.svg +++ b/public/img/icons/tools.svg @@ -1,3 +1,3 @@ - - + + diff --git a/public/img/icons/wallet.svg b/public/img/icons/wallet.svg index 4c5afab75..4888a93cd 100644 --- a/public/img/icons/wallet.svg +++ b/public/img/icons/wallet.svg @@ -1,3 +1,10 @@ - - \ No newline at end of file + + + + + + + + + diff --git a/public/img/op-stack/protocol/transaction-flow.svg b/public/img/op-stack/protocol/transaction-flow.svg index df18cac0a..8a2d4410b 100644 --- a/public/img/op-stack/protocol/transaction-flow.svg +++ b/public/img/op-stack/protocol/transaction-flow.svg @@ -1 +1 @@ - \ No newline at end of file + \ No newline at end of file diff --git a/public/img/op-stack/protocol/tx-overall-process.svg b/public/img/op-stack/protocol/tx-overall-process.svg index df18cac0a..8a2d4410b 100644 --- a/public/img/op-stack/protocol/tx-overall-process.svg +++ b/public/img/op-stack/protocol/tx-overall-process.svg @@ -1 +1 @@ - \ No newline at end of file + \ No newline at end of file diff --git a/public/logos/logo-docs-dark.svg b/public/logos/logo-docs-dark.svg index 6f96aae8e..521726786 100644 --- a/public/logos/logo-docs-dark.svg +++ b/public/logos/logo-docs-dark.svg @@ -1,4 +1,4 @@ - + diff --git a/public/logos/logo-docs-light.svg b/public/logos/logo-docs-light.svg index 63ab1156f..4d2432713 100644 --- a/public/logos/logo-docs-light.svg +++ b/public/logos/logo-docs-light.svg @@ -1,4 +1,4 @@ - + diff --git a/public/logos/metal-logo-docs-dark.svg b/public/logos/metal-logo-docs-dark.svg new file mode 100644 index 000000000..c3de09398 --- /dev/null +++ b/public/logos/metal-logo-docs-dark.svg @@ -0,0 +1,33 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/public/logos/metal-logo-docs-light.svg b/public/logos/metal-logo-docs-light.svg new file mode 100644 index 000000000..d8739e003 --- /dev/null +++ b/public/logos/metal-logo-docs-light.svg @@ -0,0 +1,33 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/styles/colors.css b/styles/colors.css index d3edc18d2..0f171c9f5 100644 --- a/styles/colors.css +++ b/styles/colors.css @@ -106,7 +106,7 @@ --op-red-200: #FFD1D5; --op-red-300: #FF99A1; --op-red-400: #FF5C6C; - --op-red-500: #FF0420; + --op-red-500: #FC9237; --op-red-600: #B80018; --op-red-700: #700013; --op-red-800: #330009; diff --git a/styles/global.css b/styles/global.css index 498779c39..00206fcc6 100644 --- a/styles/global.css +++ b/styles/global.css @@ -64,7 +64,7 @@ div.custom-callouts { border-radius: 4px; } a.callout-link { - color: #006be6; + color: #FC9237; text-decoration: underline; } diff --git a/styles/theme.css b/styles/theme.css index c82741b6f..7e8861d1c 100644 --- a/styles/theme.css +++ b/styles/theme.css @@ -127,6 +127,11 @@ nav a span { /* Links */ a.nx-underline { text-decoration: none; + color:#FC9237; +} + +a.nx-underline:hover { + text-decoration: underline; } @@ -243,7 +248,7 @@ pre { /* in-content external links */ .nextra-content a[target="_blank"]:after { - content: url('data:image/svg+xml,'); + content: url('data:image/svg+xml,'); padding-left: 5px; margin-right: 2px; } @@ -313,3 +318,4 @@ table tr { :is(html[class~=dark]) .nextra-toc .divider { border-top: 1px solid var(--op-neutral-700); } + diff --git a/theme.config.tsx b/theme.config.tsx index 4f6b263e7..8fb98156a 100644 --- a/theme.config.tsx +++ b/theme.config.tsx @@ -8,19 +8,51 @@ import "@feelback/react/styles/feelback.css" const config: DocsThemeConfig = { logo: ( <> - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ), darkMode: true, project: { - link: 'https://github.com/ethereum-optimism/docs', + link: 'https://github.com/MetalPay/metal-l2-docs', }, - docsRepositoryBase: 'https://github.com/ethereum-optimism/docs/blob/main/', + docsRepositoryBase: 'https://github.com/MetalPay/metal-l2-docs/docs/blob/main/', footer: { - text: 'OP Documentation', + text: 'Metal L2 Documentation', }, sidebar: { defaultMenuCollapseLevel: 1, @@ -46,19 +78,19 @@ const config: DocsThemeConfig = { editLink: { text: '✏️ Edit this page on GitHub' }, - banner: { + /*banner: { key: 'fp-mainnet-release', text: ( 📣📣📣 ATTENTION: Fault Proofs are planned for OP Mainnet. Withdrawal claims submitted after June 3 will need to be reproven after the upgrade, which will be at least 7 days later. Click here for more info. 📣📣📣 ) - }, + },*/ useNextSeoProps() { const { asPath } = useRouter() if (asPath !== '/') { return { - titleTemplate: '%s | Optimism Docs' + titleTemplate: '%s | Metal L2 Docs' } } }, @@ -66,16 +98,16 @@ const config: DocsThemeConfig = { const { asPath, defaultLocale, locale } = useRouter() const { frontMatter } = useConfig() const url = - 'https://docs.optimism.io' + + 'https://docs.metall2.com' + (defaultLocale === locale ? asPath : `/${locale}${asPath}`) return ( <> - + diff --git a/utils/constants.ts b/utils/constants.ts index 40165a5dc..4d1bfc86e 100644 --- a/utils/constants.ts +++ b/utils/constants.ts @@ -49,4 +49,10 @@ export const CHAIN_CONSTANTS = { 11155420: { explorer: 'https://sepolia-optimism.etherscan.io', }, + 1750: { + explorer: 'https://explorer.metall2.com', + }, + 1740: { + explorer: 'https://testnet.explorer.metall2.com', + }, } diff --git a/words.txt b/words.txt index 8a2afb7de..0ab169a7a 100644 --- a/words.txt +++ b/words.txt @@ -18,6 +18,7 @@ basefee BGEZ BGTZ Biconomy +biconomy birthdate BLEZ BLOBBASEFEE @@ -50,7 +51,6 @@ Celestia Celestia's Chainlink chainlist -Chainstack chaosnet Clabby codebases @@ -173,6 +173,7 @@ MEMPROFILERATE memprofilerate Merkle merkle +metall MFHI MFLO MINFREEDISK @@ -237,8 +238,6 @@ permissionlessly Perps personhood Pimlico -POAP -POAPs PPROF pprof preconfigured