https://github.com/offchainlabs/arbitrum-orbit-sdk

💙 SDK for building Arbitrum Orbit chains
https://github.com/offchainlabs/arbitrum-orbit-sdk

Last synced: 7 days ago
JSON representation

💙 SDK for building Arbitrum Orbit chains

• Host: GitHub
• URL: https://github.com/offchainlabs/arbitrum-orbit-sdk
• Owner: OffchainLabs
• License: apache-2.0
• Created: 2023-11-02T15:27:04.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-11-05T23:55:25.000Z (12 days ago)
• Last Synced: 2024-11-09T07:41:55.808Z (8 days ago)
• Language: TypeScript
• Homepage:
• Size: 1.32 MB
• Stars: 31
• Watchers: 11
• Forks: 43
• Open Issues: 24
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Audit: audit-ci.jsonc

Awesome Lists containing this project

README

        
# Arbitrum Orbit SDK

TypeScript SDK for building [Arbitrum Orbit](https://arbitrum.io/orbit) chains.

## Installation

Make sure you are using Node.js v18 or greater.

```bash

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

```

## Run integration tests

Clone the branch `main` of [nitro-testnode](https://github.com/OffchainLabs/nitro-testnode), and run the testnode using the following arguments:

```bash

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

```

Then, run the integration tests:

```bash

yarn test:integration

```

## Examples

See [examples](./examples).