@arbitrum/sdk

Arbitrum SDK

A TypeScript library for client-side interactions with Arbitrum. The Arbitrum SDK provides essential helper functionality and direct access to underlying smart contract interfaces, enabling developers to build powerful applications on the Arbitrum network.

[!IMPORTANT]

This is the code and documentation for @arbitrum/sdk v4.

If you're looking for v3, check out this branch.

If you're looking to migrate from v3 to v4, check out this guide.

Table of Contents

• Arbitrum SDK
  • Table of Contents
  • Overview
  • Installation
  • Key Features
    • Bridging Assets
    • Cross-Chain Messages
    • Network Configuration
  • Usage
  • Running Integration Tests
  • Documentation
  • License

Overview

Arbitrum SDK simplifies the process of interacting with Arbitrum chains, offering a robust set of tools for asset bridging and cross-chain messaging.

Installation

npm install @arbitrum/sdk

# or

yarn add @arbitrum/sdk

Key Features

Bridging Assets

Arbitrum SDK facilitates the bridging of assets between an Arbitrum chain and its parent chain. Currently supported asset bridgers:

• EthBridger: For bridging ETH to and from an Arbitrum chain (L2 or L3)
• Erc20Bridger: For bridging ERC-20 tokens to and from an Arbitrum chain (L2 or L3)
• EthL1L3Bridger: For bridging ETH to an L3 directly from L1
• Erc20L1L3Bridger: For bridging ERC-20 tokens to an L3 directly from L1

Cross-Chain Messages

Cross-chain communication is handled through ParentToChildMessage and ChildToParentMessage classes. These encapsulate the lifecycle of messages sent between chains, typically created from transaction receipts that initiate cross-chain messages.

Network Configuration

The SDK comes preconfigured for Arbitrum One, Arbitrum Nova and Arbitrum Sepolia. Custom Arbitrum networks can be registered using registerCustomArbitrumNetwork, which is required before utilizing other SDK features.

Usage

Here's a basic example of using the SDK to bridge ETH:

import { ethers } from 'ethers'
import { EthBridger, getArbitrumNetwork } from '@arbitrum/sdk'

async function bridgeEth(parentSigner: ethers.Signer, childChainId: number) {
  const childNetwork = await getArbitrumNetwork(childChainId)
  const ethBridger = new EthBridger(childNetwork)

  const deposit = await ethBridger.deposit({
    amount: ethers.utils.parseEther('0.1'),
    parentSigner,
  })

  const txReceipt = await deposit.wait()
  console.log(`Deposit initiated: ${txReceipt.transactionHash}`)
}

For more detailed usage examples and API references, please refer to the Arbitrum SDK documentation.

Running Integration Tests

1. Set up a Nitro test node by following the instructions here.

2. Copy .env.example to .env and update relevant environment variables.

3. Generate the network configuration against your active Nitro test node:

   yarn gen:network
   

4. Execute the integration tests:

   yarn test:integration
   

Documentation

For comprehensive guides and API documentation, visit the Arbitrum SDK Documentation.

License

Arbitrum SDK is released under the Apache 2.0 License.