Skip to content

Commit

Permalink
fix: typos (#316)
Browse files Browse the repository at this point in the history
Co-authored-by: Fionna Chan <[email protected]>
  • Loading branch information
omahs and fionnachan authored Oct 19, 2023
1 parent def0478 commit 1cc67ee
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Arbitrum SDK

Typescript library for client-side interactions with Arbitrum. Arbitrum SDK provides common helper functionaliy as well access to the underlying smart contract interfaces.
TypeScript library for client-side interactions with Arbitrum. Arbitrum SDK provides common helper functionality as well as access to the underlying smart contract interfaces.

Below is an overview of the Arbitrum SDK functionality. See the [tutorials](https://github.com/OffchainLabs/arbitrum-tutorials) for further examples of how to use these classes.

Expand Down Expand Up @@ -71,7 +71,7 @@ const dataIsOnL1 = await l2TxnReceipt.isDataAvailable(l2Provider, l1Provider)

### Bridging assets

Arbitrum SDK can be used to bridge assets to/from the rollup chain.The following asset bridgers are currently available:
Arbitrum SDK can be used to bridge assets to/from the rollup chain. The following asset bridgers are currently available:

- EthBridger
- Erc20Bridger
Expand All @@ -81,7 +81,7 @@ All asset bridgers have the following methods:
- **deposit** - moves assets from the L1 to the L2
- **depositEstimateGas** - estimates the gas required to do the deposit
- **withdraw** - moves assets from the L2 to the L1
- **withdrawEstimateGas** - estimate the gas required to do the withdrawal
- **withdrawEstimateGas** - estimates the gas required to do the withdrawal
Which accept different parameters depending on the asset bridger type

### Cross chain messages
Expand All @@ -94,7 +94,7 @@ Arbitrum SDK comes pre-configured for Mainnet and Goerli, and their Arbitrum cou

### Inbox tools

As part of normal operation the Arbitrum sequencer will messages into the rollup chain. However, if the sequencer is unavailable and not posting batches, the inbox tools can be used to force the inclusion of transactions into the rollup chain.
As part of normal operation the Arbitrum sequencer will send messages into the rollup chain. However, if the sequencer is unavailable and not posting batches, the inbox tools can be used to force the inclusion of transactions into the rollup chain.

### Utils

Expand All @@ -106,7 +106,7 @@ As part of normal operation the Arbitrum sequencer will messages into the rollup

1. First, make sure you have a Nitro node running. Check out the nitro repo, and run the following command `./test-node.bash --init --no-blockscout`

2. After the node has started up (that could take upto 20-30 mins), run `yarn gen:network`.
2. After the node has started up (that could take up to 20-30 mins), run `yarn gen:network`.

3. Once done, finally run `yarn test:integration` to run the integration tests.

Expand All @@ -117,15 +117,15 @@ Defaults to `Arbitrum Goerli`, for custom network use `--network` flag.

### Bridge A Standard Token

Bridging new a token to L2 (i.e., deploying a new token contract) through the standard gateway is done by simply depositing a token that hasn't yet been bridged. This repo includes a script to trigger this initial deposit/deployment:
Bridging a new token to L2 (i.e., deploying a new token contract) through the standard gateway is done by simply depositing a token that hasn't yet been bridged. This repo includes a script to trigger this initial deposit/deployment:

1. clone `arbitrum-sdk`
1. Clone `arbitrum-sdk`

2. `yarn install` (from root)

3. Set `PRIVKEY` environmental variable (you can use .env) to the key of the account from which you'll be deploying (account should have some balance of the token you're bridging).
3. Set `PRIVKEY` environment variable (you can use .env) to the key of the account from which you'll be deploying (account should have some balance of the token you're bridging).

4. Set MAINNET_RPC environmental variable to L1 RPC endpoint (i.e., https://mainnet.infura.io/v3/my-infura-key)
4. Set MAINNET_RPC environment variable to L1 RPC endpoint (i.e., https://mainnet.infura.io/v3/my-infura-key)

5. `yarn bridgeStandardToken`

Expand Down

0 comments on commit 1cc67ee

Please sign in to comment.