Skip to content

OffchainLabs/arbitrum-orbit-sdk

Repository files navigation

Arbitrum Orbit SDK

Warning

Disclaimer: This project is an Alpha release and should not be used in a production environment. We are working on getting it ready for mainnet deployments, meanwhile please use it at your own discretion.

TypeScript SDK for building Arbitrum Orbit chains.

Installation

Make sure you are using Node v18 or greater.

yarn add @arbitrum/orbit-sdk viem@^1.20.0

Run integration tests

Clone the branch main of nitro-testnode, and run the testnode using the following arguments:

./test-node.bash --init --tokenbridge --l3node --l3-fee-token --l3-token-bridge

Then, run the integration tests:

yarn test:integration

Examples

See examples.