Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 29 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,30 @@
![Arbitrum Orbit](arbitrum-chain-primary.png)

# Arbitrum Orbit SDK

TypeScript SDK for building [Arbitrum Orbit](https://arbitrum.io/orbit) chains.
The Arbitrum (Orbit) chain SDK is software written in TypeScript for building [Arbitrum (Orbit) chains](https://arbitrum.io/orbit). These chains can settle directly to Ethereum or other Ethereum L2 chains. Key features include the ability to configure various components such as throughput, privacy, and governance, giving users control over their chains.

Arbitrum chains address challenges like Ethereum's high demand for block space by offloading workloads to decentralized networks, with options for Rollup or AnyTrust chains:

- Arbitrum One uses the Rollup protocol, storing data on Ethereum
- Arbitrum Nova adopts the AnyTrust protocol, enhancing performance through a data availability committee.

Benefits of Arbitrum chains for decentralized app development include dedicated throughput, low costs, fast finality, EVM+ compatibility for deploying smart contracts in various programming languages, and the ability to create independent roadmaps for app development, allowing for innovation ahead of Ethereum's public roadmap. Overall, Arbitrum chains provide tailored solutions that significantly scale Ethereum while offering greater control and flexibility for developers.


## What can I build?
The Arbitrum chain SDK allows complete configuration of your chain using scripts and contracts, such as:
- Throughput
- Privacy
- Governance
- Data availability
- Custom gas tokens
- Custom token bridge
- Precompiles
- Layer 2 settling to Ethereum or a Layer 3 settling to Arbitrum One

The possibilities are endless, allowing you to pick and choose the options for your exact use-case and business needs.


## Installation

Expand All @@ -27,3 +51,7 @@ yarn test:integration
## Examples

See [examples](./examples).

## Documentation

See [documentation](https://docs.arbitrum.io/launch-arbitrum-chain/a-gentle-introduction).
Binary file added arbitrum-chain-primary.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading