Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/offchainlabs/arbitrum-sdk
https://github.com/offchainlabs/arbitrum-sdk
Last synced: 7 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/offchainlabs/arbitrum-sdk
- Owner: OffchainLabs
- License: apache-2.0
- Created: 2022-03-14T09:39:51.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-05T23:12:06.000Z (12 days ago)
- Last Synced: 2024-11-05T23:19:32.493Z (12 days ago)
- Language: TypeScript
- Homepage: https://arbitrum-sdk.vercel.app
- Size: 164 MB
- Stars: 231
- Watchers: 27
- Forks: 177
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Audit: audit-ci.jsonc
Awesome Lists containing this project
README
# Arbitrum SDK
[](https://badge.fury.io/js/@arbitrum%2Fsdk.svg)
[](https://opensource.org/licenses/Apache-2.0)
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](https://github.com/OffchainLabs/arbitrum-sdk/tree/v3).
>
> If you're looking to migrate from v3 to v4, check out [this guide](./docs/2-migrate.mdx).
## Table of Contents
- [Arbitrum SDK](#arbitrum-sdk)
- [Table of Contents](#table-of-contents)
- [Overview](#overview)
- [Installation](#installation)
- [Key Features](#key-features)
- [Bridging Assets](#bridging-assets)
- [Cross-Chain Messages](#cross-chain-messages)
- [Network Configuration](#network-configuration)
- [Usage](#usage)
- [Running Integration Tests](#running-integration-tests)
- [Documentation](#documentation)
- [License](#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
```bash
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:
```ts
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](https://docs.arbitrum.io/sdk).
## Running Integration Tests
1. Set up a Nitro test node by following the instructions [here](https://docs.arbitrum.io/node-running/how-tos/local-dev-node).
2. Copy `.env.example` to `.env` and update relevant environment variables.
3. Generate the network configuration against your active Nitro test node:
```sh
yarn gen:network
```
4. Execute the integration tests:
```sh
yarn test:integration
```
## Documentation
For comprehensive guides and API documentation, visit the [Arbitrum SDK Documentation](https://docs.arbitrum.io/sdk).
## License
Arbitrum SDK is released under the [Apache 2.0 License](LICENSE).