Skip to content

OffchainLabs/arbitrum-tutorials

Folders and files

NameName
Last commit message
Last commit date
Jan 23, 2025
Mar 16, 2023
Feb 5, 2025
Dec 24, 2024
Jun 7, 2022
Oct 25, 2024
May 19, 2022
Jan 23, 2025
Mar 9, 2023
May 19, 2022
Jan 23, 2025
Jan 17, 2025
Dec 17, 2024
Jan 23, 2025
Jan 23, 2025

Repository files navigation

Arbitrum Tutorials

This monorepo will help you get started with building on Arbitrum chains. It provides various simple demos showing and explaining how to interact with Arbitrum chains (including Orbit chains) — deploying and using contracts directly on Arbitrum, moving Ether and tokens betweens the parent and child chains, and more.

We show how you can use broadly supported Ethereum ecosystem tooling (Hardhat, Ethers-js, etc.) as well as our special Arbitrum SDK for convenience.

Installation

From root directory:

yarn install

Testing

  1. Start the nitro-testnode (you can find instructions here) with the following parameters:
./test-node.bash --init --tokenbridge --l3node --l3-token-bridge
  1. Execute all tests with the following command
yarn run testAll

What's included?

✅ Basics

✅ Moving stuff around

✅ General interop

✅ Advanced features

How to run the tutorials against a custom network

As mentioned above, these tutorials use the Arbitrum SDK, which loads the regular Arbitrum chains by default (Arbitrum One, Arbitrum Nova and Arbitrum Sepolia). You can use these tutorials against any other Arbitrum chain (including Orbit chains), by loading it to the Arbitrum SDK.

To do that, fill the information of your chain in the customNetwork.json file, which is automatically loaded in all tutorials.

To obtain the information of a specific chain, you can use the method prepareArbitrumNetwork of the Orbit SDK.

You can also register multiple chains if you need to (for example, for the l1-l3-teleport tutorial). In that case, create an array of chain information objects in the customNetwork.json file.