Skip to content

Commit

Permalink
Merge branch 'master' into fix-module-root-file
Browse files Browse the repository at this point in the history
  • Loading branch information
pete-vielhaber authored Jan 10, 2025
2 parents 13b5b76 + 7720ac2 commit 047205b
Show file tree
Hide file tree
Showing 301 changed files with 12,252 additions and 5,465 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'
});
}
44 changes: 44 additions & 0 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
@@ -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
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
.vscode
arbitrum-docs/sdk
arbitrum-docs/stylus-by-example
.vercel
.DS_Store
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,6 @@
url = https://github.com/OffchainLabs/arbitrum-sdk
branch = main

[submodule "stylus-by-example"]
path = stylus-by-example
url = https://github.com/offchainlabs/stylus-by-example.git
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ For most of the docs content, you can contribute by simply reviewing our [docs c

The following are the only exceptions:

- Contributing to the three troubleshooting pages — [nodes](arbitrum-docs/partials/_troubleshooting-nodes-partial.md), [builders](arbitrum-docs/partials/_troubleshooting-building-partial.md), and [users](arbitrum-docs/partials/_troubleshooting-users-partial.md), as well as the [glossary](arbitrum-docs/partials/_glossary-partial.md) page — requires internal Offchain Labs access. If you'd like to make a suggestion about content on any of those pages, open an [issue ticket](https://github.com/OffchainLabs/arbitrum-docs/issues).
- Contributing to the three troubleshooting pages — [nodes](arbitrum-docs/partials/_troubleshooting-nodes-partial.mdx), [builders](arbitrum-docs/partials/_troubleshooting-building-partial.mdx), and [users](arbitrum-docs/partials/_troubleshooting-users-partial.mdx), as well as the [glossary](arbitrum-docs/partials/_glossary-partial.md) page — requires internal Offchain Labs access. If you'd like to make a suggestion about content on any of those pages, open an [issue ticket](https://github.com/OffchainLabs/arbitrum-docs/issues).

- To request to have your project added to the [3rd party node providers page](arbitrum-docs/build-decentralized-apps/reference/01-node-providers.md), use [this form](https://docs.google.com/forms/d/e/1FAIpQLSc_v8j7sc4ffE6U-lJJyLMdBoIubf7OIhGtCqvK3cGPGoLr7w/viewform).

Expand Down
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 Expand Up @@ -108,4 +108,4 @@ Once the countdown is done, switch to the destination network on your wallet and

## What's next?

The team working on Arbitrum is always interested and looking forward to engage with its users. Why not follow us on [Twitter](https://twitter.com/arbitrum) or join our community on [Discord](https://discord.gg/arbitrum)?
The team working on Arbitrum is always interested and looking forward to engage with its users. Why not follow us on [X (Twitter)](https://x.com/arbitrum) or join our community on [Discord](https://discord.gg/arbitrum)?
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.
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content_type: troubleshooting
---

import FAQStructuredDataJsonLd from '@site/src/components/FAQStructuredData';
import FAQQuestions from '../partials/_troubleshooting-bridging-partial.md';
import FAQQuestions from '../partials/_troubleshooting-bridging-partial.mdx';

<FAQStructuredDataJsonLd faqsId="bridging" />
<FAQQuestions />
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.
Loading

0 comments on commit 047205b

Please sign in to comment.