Merge branch 'master' into timeboost-gentle-intro

OffchainLabs · Nov 21, 2024 · e21721c · e21721c
2 parents 1efb90d + 025f9de
commit e21721c
Show file tree

Hide file tree

Showing 192 changed files with 1,526 additions and 1,361 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -0,0 +1,44 @@
+name: Check format
+run-name: Checking format
+
+on:
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  install:
+    name: "Install"
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout files
+        uses: actions/checkout@v3
+
+      - name: Install node_modules
+        # This action does not work very well with subdirectories out of the box,
+        # but we can use this workaround to make it work.
+        # Note that this is highly dependent on the version of the action used
+        uses: OffchainLabs/actions/node-modules/install@35a1f8c3f3ad803e1fd9b81b94d063a4fc90a030
+        with:
+          install-command: cd website && yarn install --frozen-lockfile
+          cache-key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
+
+  check-formatting:
+    name: "Check Formatting"
+    runs-on: ubuntu-latest
+    needs: install
+    steps:
+      - name: Checkout files
+        uses: actions/checkout@v3
+
+      - name: Restore node_modules
+        # This action does not work very well with subdirectories out of the box,
+        # but we can use this workaround to make it work.
+        # Note that this is highly dependent on the version of the action used
+        uses: OffchainLabs/actions/node-modules/restore@35a1f8c3f3ad803e1fd9b81b94d063a4fc90a030
+        with:
+          cache-key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
+
+      - name: Check formatting with Prettier
+        working-directory: ./website
+        run: yarn format:check
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
 .vscode
 arbitrum-docs/sdk
-arbitrum-docs/stylus-by-example
+arbitrum-docs/stylus-by-example
+.vercel
diff --git a/...rum-docs/arbitrum-bridge/01-quickstart.md → ...um-docs/arbitrum-bridge/01-quickstart.mdx b/...rum-docs/arbitrum-bridge/01-quickstart.md → ...um-docs/arbitrum-bridge/01-quickstart.mdx
@@ -30,7 +30,7 @@ You'll also need to add the desired chain's RPC endpoint to your wallet. Here we
 
 ![Add the desired destination network to your MetaMask wallet](images/getting_started_users_1.png)
 
-Here we display the information of the most common Arbitrum chains, but you can find a more exhaustive list in our [RPC endpoints and providers](/build-decentralized-apps/reference/01-node-providers.md) page.
+Here we display the information of the most common Arbitrum chains, but you can find a more exhaustive list in our [RPC endpoints and providers](/build-decentralized-apps/reference/01-node-providers.mdx) page.
 
 | Parameter          | Arbitrum One                 | Arbitrum Nova                | Arbitrum Sepolia (testnet)             |
 | ------------------ | ---------------------------- | ---------------------------- | -------------------------------------- |
@@ -74,7 +74,7 @@ Also make sure your wallet is set to the destination chain so you can see your f
 
 :::info There's at least a 7 day withdrawal period for Arbitrum One and Nova networks
 Once you withdraw your funds from Arbitrum One or Nova through the Arbitrum bridge, you will have to wait for at least 7 days to receive them on Ethereum mainnet.
-For more details, see [Arbitrum Bridge: Troubleshooting](/arbitrum-bridge/03-troubleshooting.md#how-long-does-it-take-before-i-receive-my-funds-when-i-initiate-withdrawal-from-arbitrum-chains-one-and-nova).
+For more details, see [Arbitrum Bridge: Troubleshooting](/arbitrum-bridge/03-troubleshooting.mdx#how-long-does-it-take-before-i-receive-my-funds-when-i-initiate-withdrawal-from-arbitrum-chains-one-and-nova).
 
 :::
 

diff --git a/...s/arbitrum-bridge/02-usdc-arbitrum-one.md → .../arbitrum-bridge/02-usdc-arbitrum-one.mdx b/...s/arbitrum-bridge/02-usdc-arbitrum-one.md → .../arbitrum-bridge/02-usdc-arbitrum-one.mdx
diff --git a/...ocs/arbitrum-bridge/03-troubleshooting.md → ...cs/arbitrum-bridge/03-troubleshooting.mdx b/...ocs/arbitrum-bridge/03-troubleshooting.md → ...cs/arbitrum-bridge/03-troubleshooting.mdx
diff --git a/arbitrum-docs/audit-reports.mdx b/arbitrum-docs/audit-reports.mdx
@@ -1,21 +1,22 @@
 # Security Audit Reports
 
-| Auditor                 | Audit date | Audited code                                                  | View report                                                                                                                        |
-| ----------------------- | ---------- | ------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
-| **ConsenSys Diligence** | 11/05/2021 | Core Contracts, Token Bridge                                  | [view](hosted-audit-reports/2021_11_05_consensys_diligence_security_audit_core_contracts_token_bridge.pdf)                         |
-| **ConsenSys Diligence** | 06/24/2022 | Nitro Node & Core Contracts                                   | [view](hosted-audit-reports/2024_06_24_consensys_diligence_security_audit_nitro_contracts.pdf)                                     |
-| **Trail of Bits**       | 03/14/2022 | Nitro Node & Core Contracts, 1 of 2                           | [view](hosted-audit-reports/2022_03_14_trail_of_bits_security_audit_nitro_1_of_2.pdf)                                              |
-| **Trail of Bits**       | 10/10/2022 | Nitro Node & Core Contracts, 2 of 2                           | [view](hosted-audit-reports/2022_10_22_trail_of_bits_security_audit_nitro_2_of_2.pdf)                                              |
-| **Trail of Bits**       | 01/06/2023 | Governance & Token Bridge                                     | [view](hosted-audit-reports/2023_06_23_trail_of_bits_security_audit_governance_report_governance_token_bridge.pdf)                 |
-| **Chainsecurity**       | 03/20/2024 | Nova Fee Router Updates (ArbOS 31)                            | [view](hosted-audit-reports/2024_08_20_chainsecurity_security_audit_nova_fee_router_update_arbos_31.pdf)                           |
-| **Trail of Bits**       | 05/02/2024 | Arbitrum BoLD & Delay Buffer                                  | [view](hosted-audit-reports/2024_05_02_trail_of_bits_security_audit_bold_delay_buffer.pdf)                                         |
-| **Code4rena**           | 06/17/2024 | Arbitrum BoLD: Public Audit Competition Report                | [view](hosted-audit-reports/2024_06_17_code4arena_security_audit_arbos30_nitro_upgrade.pdf)                                        |
-| **Trail of Bits**       | 06/10/2024 | Arbitrum Stylus                                               | [view](hosted-audit-reports/2024_06_10_trail_of_bits_security_audit_stylus.pdf)                                                    |
-| **Trail of Bits**       | 07/26/2024 | ArbOS 30 Atlas: Nitro Upgrade                                 | [view](hosted-audit-reports/2024_07_26_trail_of_bits_security_audit_arbos30_nitro_upgrade.pdf)                                     |
-| **Trail of Bits**       | 07/26/2024 | ArbOS 31 Bianca: Nitro Upgrade                                | [view](hosted-audit-reports/2024_07_26_trail_of_bits_security_audit_arbos_31.pdf)                                                  |
-| **Trail of Bits**       | 03/18/2024 | l1-l3-teleporter                                              | [view](hosted-audit-reports/2024_03_18_trail_of_bits_security_audit_l1_l3_teleporter.pdf)                                          |
-| **Trail of Bits**       | 08/01/2024 | Custom fee token                                              | [view](hosted-audit-reports/2024_08_01_trail_of_bits_security_audit_custom_fee_token.pdf)                                          |
-| **Trail of Bits**       | 08/29/2024 | USDC Custom Gateway & ArbOS Timestamp Upgrade Action contract | [view](hosted-audit-reports/2024_08_29_trail_of_bits_security_audit_usdc_custom_gateway_and_arbos_upgrade_at_timestamp_action.pdf) |
-| **Trail of Bits**       | 08/29/2024 | Orbit & Governance Upgrade Actions Contracts v2.1             | [view](hosted-audit-reports/2024_08_29_trail_of_bits_security_audit_orbit_and_governance_upgrade_actions_v2.1.pdf)                 |
-| **Open Zeppelin**       | 09/05/2024 | Stylus Rust SDK                                               | [view](hosted-audit-reports/2024_09_05_open_zeppelin_security_audit_stylus_rust_sdk.pdf)                                           |
-| **Trail of Bits**       | 09/25/2024 | Timeboost Auction Contracts                                   | [view](hosted-audit-reports/2024_09_25_trail_of_bits_security_audit_timeboost_auction_contracts.pdf)                               |
+| Auditor                 | Audit date | Audited code                                                                 | View report                                                                                                                        |
+| ----------------------- | ---------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
+| **Trail of Bits**       | 10/30/2024 | BoLD contracts in Nitro due to changes to support EIP7702 & Fast Withdrawals | [view](hosted-audit-reports/2024_10_30_trail_of_bits_security_audit_Nitro_Contracts_with_BoLD.pdf)                                 |
+| **Trail of Bits**       | 09/25/2024 | Timeboost Auction Contracts                                                  | [view](hosted-audit-reports/2024_09_25_trail_of_bits_security_audit_timeboost_auction_contracts.pdf)                               |
+| **Open Zeppelin**       | 09/05/2024 | Stylus Rust SDK                                                              | [view](hosted-audit-reports/2024_09_05_open_zeppelin_security_audit_stylus_rust_sdk.pdf)                                           |
+| **Trail of Bits**       | 08/29/2024 | Orbit & Governance Upgrade Actions Contracts v2.1                            | [view](hosted-audit-reports/2024_08_29_trail_of_bits_security_audit_orbit_and_governance_upgrade_actions_v2.1.pdf)                 |
+| **Trail of Bits**       | 08/29/2024 | USDC Custom Gateway & ArbOS Timestamp Upgrade Action contract                | [view](hosted-audit-reports/2024_08_29_trail_of_bits_security_audit_usdc_custom_gateway_and_arbos_upgrade_at_timestamp_action.pdf) |
+| **Trail of Bits**       | 08/01/2024 | Custom fee token                                                             | [view](hosted-audit-reports/2024_08_01_trail_of_bits_security_audit_custom_fee_token.pdf)                                          |
+| **Trail of Bits**       | 07/26/2024 | ArbOS 31 Bianca: Nitro Upgrade                                               | [view](hosted-audit-reports/2024_07_26_trail_of_bits_security_audit_arbos_31.pdf)                                                  |
+| **Trail of Bits**       | 07/26/2024 | ArbOS 30 Atlas: Nitro Upgrade                                                | [view](hosted-audit-reports/2024_07_26_trail_of_bits_security_audit_arbos30_nitro_upgrade.pdf)                                     |
+| **Code4rena**           | 06/17/2024 | Arbitrum BoLD: Public Audit Competition Report                               | [view](hosted-audit-reports/2024_06_17_code4arena_security_audit_arbos30_nitro_upgrade.pdf)                                        |
+| **Trail of Bits**       | 06/10/2024 | Arbitrum Stylus                                                              | [view](hosted-audit-reports/2024_06_10_trail_of_bits_security_audit_stylus.pdf)                                                    |
+| **Trail of Bits**       | 05/02/2024 | Arbitrum BoLD & Delay Buffer                                                 | [view](hosted-audit-reports/2024_05_02_trail_of_bits_security_audit_bold_delay_buffer.pdf)                                         |
+| **Chainsecurity**       | 03/20/2024 | Nova Fee Router Updates (ArbOS 31)                                           | [view](hosted-audit-reports/2024_08_20_chainsecurity_security_audit_nova_fee_router_update_arbos_31.pdf)                           |
+| **Trail of Bits**       | 03/18/2024 | l1-l3-teleporter                                                             | [view](hosted-audit-reports/2024_03_18_trail_of_bits_security_audit_l1_l3_teleporter.pdf)                                          |
+| **Trail of Bits**       | 01/06/2023 | Governance & Token Bridge                                                    | [view](hosted-audit-reports/2023_06_23_trail_of_bits_security_audit_governance_report_governance_token_bridge.pdf)                 |
+| **Trail of Bits**       | 10/10/2022 | Nitro Node & Core Contracts, 2 of 2                                          | [view](hosted-audit-reports/2022_10_22_trail_of_bits_security_audit_nitro_2_of_2.pdf)                                              |
+| **ConsenSys Diligence** | 06/24/2022 | Nitro Node & Core Contracts                                                  | [view](hosted-audit-reports/2024_06_24_consensys_diligence_security_audit_nitro_contracts.pdf)                                     |
+| **Trail of Bits**       | 03/14/2022 | Nitro Node & Core Contracts, 1 of 2                                          | [view](hosted-audit-reports/2022_03_14_trail_of_bits_security_audit_nitro_1_of_2.pdf)                                              |
+| **ConsenSys Diligence** | 11/05/2021 | Core Contracts, Token Bridge                                                 | [view](hosted-audit-reports/2021_11_05_consensys_diligence_security_audit_core_contracts_token_bridge.pdf)                         |