Skip to content

Commit

Permalink
Merge branch 'master' into interactive-orbit-sdk
Browse files Browse the repository at this point in the history
  • Loading branch information
anegg0 committed Apr 17, 2024
2 parents 39242fc + 400dd81 commit ea9db61
Show file tree
Hide file tree
Showing 19 changed files with 73 additions and 45 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ There are several ways to obtain the native currency:

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.

![Add the desired destination network to your MetaMask wallet](assets/getting_started_users_1.png)
![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.

Expand All @@ -50,11 +50,11 @@ Note that testnets like Arbitrum Sepolia only appear if you are connected to the

:::

![Add the desired network to your web3 wallet](assets/getting_started_users_2.png)
![Add the desired network to your web3 wallet](images/getting_started_users_2.png)

Select the token you want to bridge in the token drop-down menu. You can also enable/disable the token lists by clicking `Manage token lists` button on the bottom right corner of the drop-down menu.

![Select the token to bridge](assets/getting_started_users_3.png)
![Select the token to bridge](images/getting_started_users_3.png)

Enter the amount of ETH or ERC-20 tokens you want to bridge over in the **From** box and then press `Move funds`. Follow the prompts on your web3 wallet.

Expand All @@ -64,7 +64,7 @@ Please make sure you leave enough ETH on your wallet to pay for the transaction,

:::

![Enter the amount of tokens to bridge](assets/getting_started_users_4.png)
![Enter the amount of tokens to bridge](images/getting_started_users_4.png)

After you submit the transaction through your web3 wallet you can expect your funds to arrive on the destination chain within roughly 15-30 minutes (depending on the chain congestion).

Expand All @@ -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 [here](https://docs.arbitrum.io/for-users/troubleshooting-users#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.md#how-long-does-it-take-before-i-receive-my-funds-when-i-initiate-withdrawal-from-arbitrum-chains-one-and-nova).

:::

Expand All @@ -86,7 +86,7 @@ Note that testnets like Ethereum Sepolia only appear if you are connected to the

:::

![Select the token to withdraw](assets/getting_started_users_5.png)
![Select the token to withdraw](images/getting_started_users_5.png)

Select the token you want to bridge in the token drop-down menu. You can also enable/disable the token lists by clicking `Manage token lists` button on the bottom right corner of the drop-down menu. Enter the amount of ETH or ERC-20 tokens you want to bridge over in the **from** box and then press `Move funds`. Follow the prompts on your web3 wallet.

Expand All @@ -96,13 +96,13 @@ Please make sure you leave enough ETH on your wallet to pay for the transaction,

:::

![Enter the amount of token to withdraw](assets/getting_started_users_6.png)
![Enter the amount of token to withdraw](images/getting_started_users_6.png)

A countdown will pop up stating that you’ll get your funds in 7-8 days.

You can check the status of your withdrawal by clicking on your profile on the top right and opening the `Transactions` tab, and claim it there when it’s ready.

![See the transaction history](assets/getting_started_users_7.png)
![See the transaction history](images/getting_started_users_7.png)

Once the countdown is done, switch to the destination network on your wallet and press the `Claim` button, that has now turned blue, to receive your funds!

Expand Down
4 changes: 3 additions & 1 deletion arbitrum-docs/arbos/l1-to-l2-messaging.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,18 +27,20 @@ Here we walk through the different stages of the lifecycle of a retryable ticket

1. Creating a retryable ticket is initiated with a call (direct or internal) to the `createRetryableTicket` function of the [`inbox` contract][inbox_link]. A ticket is guaranteed to be created if this call succeeds. Here, we describe parameters that need to be carefully set. Note that, this function forces the sender to provide a _reasonable_ amount of funds (at least enough to submitting, and _attempting_ to executing the ticket), but that doesn't guarantee a successful auto-redemption.


| Parameter | Description |
|:--------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `l1CallValue (also referred to as deposit)` | Not a real function parameter, it is rather the callValue that is sent along with the transaction |
| `address to` | The destination L2 address |
| `uint256 l2CallValue` | The callvalue for retryable L2 message that is supplied within the deposit (l1CallValue) |
| `uint256 maxSubmissionCost` | The maximum amount of ETH to be paid for submitting the ticket. This amount is (1) supplied within the deposit (l1CallValue) to be later deducted from sender's L2 balance and is (2) directly proportional to the size of the retryable’s data and L1 basefee |
| `address excessFeeRefundAddress` | The L2 address to which the excess fee is credited (l1CallValue - (autoredeem ? ticket execution cost : submission cost) - l2CallValue) |
| `address excessFeeRefundAddress` | The unused gas cost and submssion cost will deposit to this address, formula is: `(gasLimit x maxFeePerGas - execution cost) + (maxSubmission - (autoredeem ? 0 : submission cost))`. (Note: excess deposit will transfer to the alias address of the parent chain tx's `msg.sender` rather than this address) | |
| `address callValueRefundAddress` | The L2 address to which the l2CallValue is credited if the ticket times out or gets cancelled (this is also called the `beneficiary`, who's got a critical permission to cancel the ticket) |
| `uint256 gasLimit` | Maximum amount of gas used to cover L2 execution of the ticket |
| `uint256 maxFeePerGas` | The gas price bid for L2 execution of the ticket that is supplied within the deposit (l1CallValue) |
| `bytes calldata data` | The calldata to the destination L2 address |


2. Sender's deposit must be enough to make the L1 submission succeed and for the L2 execution to be _attempted_. If provided correctly, a new ticket with a unique `TicketID` is created and added to retryable buffer. Also, funds (`submissionCost` + `l2CallValue`) are deducted from the sender and placed into the escrow for later use in redeeming the ticket.

3. Ticket creation causes the [`ArbRetryableTx`](/build-decentralized-apps/precompiles/02-reference.md#arbretryabletx) precompile to emit a `TicketCreated` event containing the `TicketID` on L2.
Expand Down
16 changes: 0 additions & 16 deletions arbitrum-docs/bridge-tokens/gentle-introduction-bridge.md

This file was deleted.

31 changes: 31 additions & 0 deletions arbitrum-docs/for-devs/third-party-docs/SubQuery/subquery.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: 'Indexing Arbitrum data with SubQuery'
description: 'Fast, flexible, universal, open source and decentralised APIs for Arbitrum'
author: subquery-team
sidebar_label: 'SubQuery Indexer'
---

SubQuery is a leading blockchain data indexer that provides developers with fast, flexible, universal, open source and decentralised APIs for web3 projects. SubQuery SDK allows developers to get rich indexed data and build intuitive and immersive decentralised applications in a faster and more efficient way. SubQuery supports 100+ ecosystems including Arbitrum, Ethereum, Polkadot, Algorand, NEAR, and Avalanche.

Another one of SubQuery's competitive advantages is the ability to aggregate data not only within a chain but across multiple blockchains all within a single project. This allows the creation of feature-rich dashboard analytics and multi-chain block scanners.

Other advantages include superior performance with multiple RPC endpoint configurations, multi-worker capabilities and a configurable caching architecture. To find out more, visit our [documentation](https://academy.subquery/).

## Useful resources

- SubQuery docs: [SubQuery Academy (Documentation)](https://academy.subquery.network/)
- Intro quick start guide: [1. Create a New Project](https://academy.subquery.network/quickstart/quickstart.html)
- [Arbitrum Quick Start Guide](https://academy.subquery.network/quickstart/quickstart_chains/arbitrum.html)
- [Arbitrum's starter projects directory](https://github.com/subquery/ethereum-subql-starter/tree/main/Arbitrum)

For technical questions and support reach out to us `start@subquery.network`

## Running and hosting your Arbitrum SubQuery APIs

SubQuery is open-source, meaning you have the freedom to run it in the following three ways:

- Locally on your own computer (or a cloud provider of your choosing), [view the instructions on how to run SubQuery Locally](https://academy.subquery.network/run_publish/run.html).

- You can publish it to SubQuery's enterprise-level [Managed Service](https://managedservice.subquery.network/), where we'll host your SubQuery project in production ready services for mission critical data with zero-downtime blue/green deployments. There even is a generous free tier. [Find out how](https://academy.subquery.network/run_publish/publish.html).

- You can publish it to the decentralised [SubQuery Network](https://subquery.network/network), the most open, performant, reliable, and scalable data service for dApp developers. The SubQuery Network indexes and services data to the global community in an incentivised and verifiable way and supports Arbitrum from launch.
10 changes: 5 additions & 5 deletions arbitrum-docs/welcome/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,11 @@ The Arbitrum suite includes the protocols, chains, services, and SDKs that power

**Users** interact with Arbitrum either through the Arbitrum bridge or by using dApps that have been deployed to an Arbitrum chain.

| Resource | Description |
| ---------------------------------------------- | ---------------------------------------------------------------------------------------- |
| [Arbitrum bridge](https://bridge.arbitrum.io/) | Lets you move ETH and ERC-20 tokens between Ethereum, Arbitrum, and select Orbit chains. |
| [Arbitrum Portal](https://portal.arbitrum.io/) | A directory of dApps on Arbitrum. |
| [Quickstart (bridge)](/getting-started-users) | Provides step-by-step instructions for first-time bridge users. |
| Resource | Description |
| -------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| [Arbitrum bridge](https://bridge.arbitrum.io/) | Lets you move ETH and ERC-20 tokens between Ethereum, Arbitrum, and select Orbit chains. |
| [Arbitrum Portal](https://portal.arbitrum.io/) | A directory of dApps on Arbitrum. |
| [Quickstart (bridge)](/arbitrum-bridge/01-quickstart.md) | Provides step-by-step instructions for first-time bridge users. |

## Arbitrum for developers

Expand Down
15 changes: 15 additions & 0 deletions vercel.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,20 @@
{
"redirects": [
{
"source": "/(bridge-tokens/concepts/usdc-concept/?)",
"destination": "/arbitrum-bridge/usdc-arbitrum-one",
"permanent": false
},
{
"source": "/(for-users/troubleshooting-users/?)",
"destination": "/arbitrum-bridge/troubleshooting",
"permanent": false
},
{
"source": "/(getting-started-users/?)",
"destination": "/arbitrum-bridge/quickstart",
"permanent": false
},
{
"source": "/(mainnet-risks/?)",
"destination": "/build-decentralized-apps/reference/mainnet-risks",
Expand Down
4 changes: 2 additions & 2 deletions website/i18n/ja/docusaurus-plugin-content-docs/current.json
Original file line number Diff line number Diff line change
Expand Up @@ -165,11 +165,11 @@
},
"sidebar.bridgeTokensSidebar.doc.Quickstart": {
"message": "Quickstart",
"description": "The label for the doc item Quickstart in sidebar bridgeTokensSidebar, linking to the doc getting-started-users"
"description": "The label for the doc item Quickstart in sidebar bridgeTokensSidebar, linking to the doc arbitrum-bridge/quickstart"
},
"sidebar.bridgeTokensSidebar.doc.Troubleshooting": {
"message": "Troubleshooting",
"description": "The label for the doc item Troubleshooting in sidebar bridgeTokensSidebar, linking to the doc for-users/troubleshooting-users"
"description": "The label for the doc item Troubleshooting in sidebar bridgeTokensSidebar, linking to the doc arbitrum-bridge/troubleshooting"
},
"sidebar.runNodesSidebar.category.Get started": {
"message": "Get started",
Expand Down
8 changes: 2 additions & 6 deletions website/i18n/zh/docusaurus-plugin-content-docs/current.json
Original file line number Diff line number Diff line change
Expand Up @@ -159,17 +159,13 @@
"message": "More",
"description": "The label for category More in sidebar bridgeTokensSidebar"
},
"sidebar.bridgeTokensSidebar.doc.A gentle introduction": {
"message": "A gentle introduction",
"description": "The label for the doc item A gentle introduction in sidebar bridgeTokensSidebar, linking to the doc bridge-tokens/gentle-introduction-bridge"
},
"sidebar.bridgeTokensSidebar.doc.Quickstart": {
"message": "Quickstart",
"description": "The label for the doc item Quickstart in sidebar bridgeTokensSidebar, linking to the doc getting-started-users"
"description": "The label for the doc item Quickstart in sidebar bridgeTokensSidebar, linking to the doc arbitrum-bridge/quickstart"
},
"sidebar.bridgeTokensSidebar.doc.Troubleshooting": {
"message": "Troubleshooting",
"description": "The label for the doc item Troubleshooting in sidebar bridgeTokensSidebar, linking to the doc for-users/troubleshooting-users"
"description": "The label for the doc item Troubleshooting in sidebar bridgeTokensSidebar, linking to the doc arbitrum-bridge/troubleshooting"
},
"sidebar.runNodesSidebar.category.Get started": {
"message": "Get started",
Expand Down
12 changes: 6 additions & 6 deletions website/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -676,19 +676,19 @@ const sidebars = {
items: [
{
type: 'doc',
id: 'getting-started-users',
id: 'arbitrum-bridge/quickstart',
label: 'Quickstart',
},
{
type: 'doc',
id: 'for-users/troubleshooting-users',
label: 'Troubleshooting',
id: 'arbitrum-bridge/usdc-arbitrum-one',
label: 'USDC on Arbitrum One',
},
{
type: 'doc',
id: 'bridge-tokens/concepts/usdc-concept',
label: 'USDC on Arbitrum One',
},
id: 'arbitrum-bridge/troubleshooting',
label: 'Troubleshooting',
}
],
},
{
Expand Down
2 changes: 1 addition & 1 deletion website/src/components/HomepageFeatures/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ const FeatureList: FeatureItem[] = [
{
title: 'Quickstart: Bridge tokens',
Svg: require('@site/static/img/bridge_token.svg').default,
href: '/getting-started-users',
href: '/arbitrum-bridge/quickstart',
description:
"Learn how to transfer tokens between Ethereum's L1 chain and Arbitrum's L2 chains using Arbitrum Bridge.",
},
Expand Down

0 comments on commit ea9db61

Please sign in to comment.