Skip to content

Commit

Permalink
Merge branch 'master' into pr/1795
Browse files Browse the repository at this point in the history
  • Loading branch information
pete-vielhaber committed Jan 13, 2025
2 parents e426b28 + 25aaff0 commit 8361f12
Show file tree
Hide file tree
Showing 240 changed files with 8,107 additions and 4,159 deletions.
11 changes: 11 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# To get started with Dependabot version updates, you'll need to specify which
# package ecosystems to update and where the package manifests are located.
# Please see the documentation for all configuration options:
# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file

version: 2
updates:
- package-ecosystem: "gitsubmodule" # See documentation for possible values
directory: "/" # Location of package manifests
schedule:
interval: "daily"
57 changes: 57 additions & 0 deletions .github/workflows/check-undocumented-issues.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
name: Check Undocumented Issues

on:
issues:
types: [opened]

jobs:
check-issue-content:
runs-on: ubuntu-latest
permissions:
issues: write

steps:
- name: Check issue content
uses: actions/github-script@v7
with:
script: |
const issue = context.payload.issue;
// Get the issue body and title
const body = issue.body || '';
const title = issue.title || '';
// Check if this is a docs update request
const isDocsRequest = title.startsWith('Docs update request:');
if (!isDocsRequest) {
return;
}
// Split body into lines and remove empty ones
const bodyLines = body.split('\n').filter(line => line.trim());
// Check if only contains the template content
const hasOnlyTemplate =
bodyLines.length <= 3 && // Updated to match 3 lines
bodyLines[0]?.startsWith('Source:') &&
bodyLines[1]?.startsWith('Request: (how can we help?)') &&
bodyLines[2]?.includes('Psst, this issue will be closed'); // Added check for the warning message
if (hasOnlyTemplate) {
// Close the issue with a comment
await github.rest.issues.createComment({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: issue.number,
body: 'This issue is being closed automatically as it appears to be an empty documentation update request. Please provide specific details about what needs to be updated or improved in the documentation. You can create a new issue with more details if needed.\n\nSome helpful details to include:\n- What specific part of the documentation needs updating?\n- What is unclear or missing?\n- What would make the documentation more helpful?\n\nThank you for helping us improve our documentation!'
});
await github.rest.issues.update({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: issue.number,
state: 'closed',
state_reason: 'not_planned'
});
}
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.vscode
arbitrum-docs/sdk
arbitrum-docs/stylus-by-example
arbitrum-docs/stylus-by-example
.vercel
.DS_Store
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This quickstart is for users who want to "deposit" ETH or any ERC-20 tokens from

We will go through the whole process step by step with as much detail as possible. If you feel stuck in any of the steps, don't hesitate to contact us through our [Discord](https://discord.gg/arbitrum) and we will be happy to help you complete the process.

The only prerequisite for this quickstart is to have a web3 wallet installed, e.g. Metamask. If you don't have one, visit Arbitrum's [portal page](https://portal.arbitrum.io/?categories=wallet) to download one.
The only prerequisite for this quickstart is to have a web3 wallet installed, e.g., Metamask/OKX Wallet. If you don't have one, visit Arbitrum's [portal page](https://portal.arbitrum.io/?categories=wallet) to download one.

## Deposit ETH or ERC-20 tokens (from parent chain to child chain)

Expand All @@ -26,11 +26,11 @@ There are several ways to obtain the native currency:

### Step 2: Add the preferred network to your wallet

You'll also need to add the desired chain's RPC endpoint to your wallet. Here we provide an example for doing this using MetaMask, although the process should be similar for other wallets. You need to first click on the MetaMask extension on your browser, click the network selector dropdown on the top-left corner, and then click the `Add Network` button at the bottom. Click "Add a network manually" and then provide the information corresponding to the chain you want to send your assets to.
You'll also need to add the desired chain's RPC endpoint to your wallet. Here we provide an example for doing this using MetaMask/OKX Wallet, although the process should be similar for other wallets. You need to first click on the MetaMask/OKX Wallet extension on your browser, click the network selector dropdown on the top-left corner, and then click the `Add Network` button at the bottom. Click "Add a network manually" and then provide the information corresponding to the chain you want to send your assets to.

![Add the desired destination network to your MetaMask wallet](images/getting_started_users_1.png)
![Add the desired destination network to your MetaMask/OKX 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) |
| ------------------ | ---------------------------- | ---------------------------- | -------------------------------------- |
Expand Down Expand Up @@ -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](https://docs.arbitrum.io/arbitrum-bridge/troubleshooting#how-long-does-it-take-before-i-receive-my-funds-when-i-initiate-a-withdrawal-from-arbitrum-chains-one-and-nova).

:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,20 @@ sidebar_position: 4

Arbitrum One supports two different types of USDC:

1. **Arbitrum-native USDC (USDC)**: USDC tokens native to the Arbitrum One chain.
1. **USDC (USDC)**: USDC tokens native to the Arbitrum One chain.
2. **Bridged USDC (USDC.e)**: Ethereum-native USDC tokens that have been bridged to Arbitrum One.

### Differences between USDC and USDC.e

<table className="small-table">
<tr>
<th></th>
<th>Arbitrum-native USDC</th>
<th>USDC</th>
<th>Bridged USDC</th>
</tr>
<tr>
<td>Token Name</td>
<td>USD Coin</td>
<td>USDC</td>
<td>Bridged USDC</td>
</tr>
<tr>
Expand Down Expand Up @@ -54,4 +54,6 @@ The Arbitrum Bridge will continue to facilitate transfers of all USDC tokens. Wh

### Historical context

Arbitrum One has supported Bridged USDC since conception, which previously had over a billion Bridged USDC in circulation. On June 8th 2023, Circle added support for the Cross-Chain Transfer Protocol and launched Arbitrum-native USDC, which enabled direct minting and burning of Arbitrum-Native USDC on Arbitrum One. Due to this, the Bridged USDC token symbol was renamed from USDC to USDC.e to accommodate Arbitrum-native USDC. The expectation is that over time the conversion of Bridged USDC to Arbitrum-native USDC will continue.
The Arbitrum Bridge will continue to facilitate transfers of all USDC tokens. When depositing USDC from Ethereum, the option exists to receive USDC using Circle’s Cross-Chain Transfer Protocol or receive Bridged USDC using Arbitrum’s lock-and-mint bridge.
Historical context
In 2023, Circle launched USDC natively on Arbitrum One and added support for Cross-Chain Transfer Protocol, which enabled direct minting and burning of USDC between Ethereum and Arbitrum One. Due to this, the token symbol for Bridged USDC was renamed to USDC.e to accommodate an ecosystem-wide liquidity migration to native USDC. The expectation is that over time the liquidity migration of USDC.e to USDC will continue.
Binary file added arbitrum-docs/assets/batching.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added arbitrum-docs/assets/bypassing-the-sequencer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added arbitrum-docs/assets/compression.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added arbitrum-docs/assets/sequencer-feed.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added arbitrum-docs/assets/sequencer-operations.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added arbitrum-docs/assets/submit-tx-to-sequencer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
44 changes: 25 additions & 19 deletions arbitrum-docs/audit-reports.mdx
Original file line number Diff line number Diff line change
@@ -1,21 +1,27 @@
# 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 (MM/DD/YYY) | Audited code | View report |
| ----------------------- | ---------------------- | ----------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| **Trail of Bits** | 12/26/2024 | BoLD Proposal Payload & Upgrade Actions + Misc Changes for Nitro Contracts v3.0.0 | [view](hosted-audit-reports/2024_12_26_trail_of_bits_boldfixes_securityreview.pdf) |
| **Trail of Bits** | 10/30/2024 | Changes to BoLD Solidity contracts 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** | 10/23/2024 | ArbOS 32 Bianca: Emergency Stylus Fixes | [view](hosted-audit-reports/2024_10_23_trail_of_bits_security_audit_arbos32_emergency_fixes.pdf) |
| **Trail of Bits** | 10/07/2024 | Optimizations to BoLD history commitments | [view](hosted-audit-reports/2024_10_07_trail_of_bits_security_audit_bold_optimized_history_commitments.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 | Initial Stylus Rust SDK audit | [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/05/2024 | BoLD contract fixes from the May 2024 audit & DAC reward updates | [view](hosted-audit-reports/2024_08_05_trail_of_bits_security_audit_bold_and_dac_rewards_updates.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 | BoLD contract fixes from the Aug 2023 audit & Delay Buffer changes to the sequencer inbox | [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** | 08/02/2023 | Arbitrum BoLD - initial audit (then called challenge protocol v2) | [view](hosted-audit-reports/2023_08_02_trail_of_bits_security_audit_challenge_protocol_v2.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) |
Loading

0 comments on commit 8361f12

Please sign in to comment.