Skip to content
This repository was archived by the owner on Dec 12, 2023. It is now read-only.

Commit 5176c96

Browse files
authored
Merge pull request #194 from ethereum-optimism/qbzzt/230712-sdk-many-chains
feat(*): Add notices that the SDK supports many chains
2 parents 5d0765d + f2ee746 commit 5176c96

File tree

8 files changed

+42
-4
lines changed

8 files changed

+42
-4
lines changed

cross-dom-bridge-erc20/README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,11 @@ This tutorial teaches you how to use the [Optimism SDK](https://sdk.optimism.io/
77
While you *could* use [the bridge contracts](https://community.optimism.io/docs/developers/bridge/standard-bridge/) directly, a [simple usage error](https://community.optimism.io/docs/developers/bridge/standard-bridge/#depositing-erc20s) can cause you to lock tokens in the bridge forever and lose their value.
88
The SDK provides transparent safety rails to prevent that mistake.
99

10-
10+
The SDK supports multiple OP Chains: OP, Base, etc.
11+
To see whether a specific OP Chain is supported directly, [see the documentation](https://sdk.optimism.io/enums/l2chainid).
12+
Chains that aren't officially supported just take a few extra steps.
13+
Get the L1 contract addresses, and [provide them to the SDK](https://stack.optimism.io/docs/build/sdk/#contract-addresses).
14+
Once you do that, you can use the SDK normally.
1115

1216
**Warning:** The standard bridge does *not* support certain ERC-20 configurations:
1317

cross-dom-bridge-eth/README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,11 @@
55

66
This tutorial teaches you how to use the [Optimism SDK](https://sdk.optimism.io/) to transfer ETH between Layer 1 (Ethereum or Goerli) and Layer 2 (OP Mainnet or OP Goerli).
77

8-
8+
The SDK supports multiple OP Chains: OP, Base, etc.
9+
To see whether a specific OP Chain is supported directly, [see the documentation](https://sdk.optimism.io/enums/l2chainid).
10+
Chains that aren't officially supported just take a few extra steps.
11+
Get the L1 contract addresses, and [provide them to the SDK](https://stack.optimism.io/docs/build/sdk/#contract-addresses).
12+
Once you do that, you can use the SDK normally.
913

1014
## Setup
1115

cross-dom-comm/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -165,6 +165,12 @@ The fault challenge window starts after you do this, so it's best to do it as ea
165165
166166
1. Get the SDK (it is already in `node_modules`).
167167
168+
The SDK supports multiple OP Chains: OP, Base, etc.
169+
To see whether a specific OP Chain is supported directly, [see the documentation](https://sdk.optimism.io/enums/l2chainid).
170+
Chains that aren't officially supported just take a few extra steps.
171+
Get the L1 contract addresses, and [provide them to the SDK](https://stack.optimism.io/docs/build/sdk/#contract-addresses).
172+
Once you do that, you can use the SDK normally.
173+
168174
```js
169175
sdk = require("@eth-optimism/sdk")
170176
```

sdk-estimate-gas/README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,11 @@ This tutorial teaches you how to use the Optimism SDK to estimate the gas costs
88
This calculation is complicated by the fact that the major cost is the cost of writing the transaction on L1, it doesn't work to just multiply the gas used by the transaction by the gas price, the same way you would on L1.
99
[You can read the details of the calculation here](https://help.optimism.io/hc/en-us/articles/4411895794715-Transaction-fees).
1010

11-
11+
The SDK supports multiple OP Chains: OP, Base, etc.
12+
To see whether a specific OP Chain is supported directly, [see the documentation](https://sdk.optimism.io/enums/l2chainid).
13+
Chains that aren't officially supported just take a few extra steps.
14+
Get the L1 contract addresses, and [provide them to the SDK](https://stack.optimism.io/docs/build/sdk/#contract-addresses).
15+
Once you do that, you can use the SDK normally.
1216

1317
## Prerequisites
1418

sdk-trace-tx/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@
66
This tutorial teaches you how to trace individual cross-domain transactions between L1 Ethereum and OP Mainnet using [the Optimism SDK](https://sdk.optimism.io/).
77
To see how to send these messages, see [the cross domain tutorial](../cross-dom-comm/) or the tutorials on how to transfer [ETH](../cross-dom-bridge-eth/) and [ERC-20](../cross-dom-bridge-erc20/).
88

9+
The SDK supports multiple OP Chains: OP, Base, etc.
10+
To see whether a specific OP Chain is supported directly, [see the documentation](https://sdk.optimism.io/enums/l2chainid).
11+
Chains that aren't officially supported just take a few extra steps.
12+
Get the L1 contract addresses, and [provide them to the SDK](https://stack.optimism.io/docs/build/sdk/#contract-addresses).
13+
Once you do that, you can use the SDK normally.
14+
915
## Getting started
1016

1117
### Prerequisites

sdk-view-tx/README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,11 @@
66

77
This tutorial teaches you how to use [the Optimism SDK](https://sdk.optimism.io/) to view the transactions passed between L1 (Ethereum) and L2 (OP Mainnet) by an address.
88

9-
9+
The SDK supports multiple OP Chains: OP, Base, etc.
10+
To see whether a specific OP Chain is supported directly, [see the documentation](https://sdk.optimism.io/enums/l2chainid).
11+
Chains that aren't officially supported just take a few extra steps.
12+
Get the L1 contract addresses, and [provide them to the SDK](https://stack.optimism.io/docs/build/sdk/#contract-addresses).
13+
Once you do that, you can use the SDK normally.
1014

1115

1216
## Prerequisites

standard-bridge-custom-token/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,11 @@ Then the only thing we need to do is call the internal `_setupDecimals(8)` metho
105105
### Transfer tokens
106106

107107
Create and use [`CrossDomainMessenger`](https://sdk.optimism.io/classes/crosschainmessenger) (the Optimism SDK object used to bridge assets).
108+
The SDK supports multiple OP Chains: OP, Base, etc.
109+
To see whether a specific OP Chain is supported directly, [see the documentation](https://sdk.optimism.io/enums/l2chainid).
110+
Chains that aren't officially supported just take a few extra steps.
111+
Get the L1 contract addresses, and [provide them to the SDK](https://stack.optimism.io/docs/build/sdk/#contract-addresses).
112+
Once you do that, you can use the SDK normally.
108113

109114
1. Import the Optimism SDK.
110115

standard-bridge-standard-token/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,11 @@ If you do not need any special processing on L2, just the ability to deposit, tr
124124
### Transfer tokens
125125

126126
Create and use [`CrossDomainMessenger`](https://sdk.optimism.io/classes/crosschainmessenger) (the Optimism SDK object used to bridge assets).
127+
The SDK supports multiple OP Chains: OP, Base, etc.
128+
To see whether a specific OP Chain is supported directly, [see the documentation](https://sdk.optimism.io/enums/l2chainid).
129+
Chains that aren't officially supported just take a few extra steps.
130+
Get the L1 contract addresses, and [provide them to the SDK](https://stack.optimism.io/docs/build/sdk/#contract-addresses).
131+
Once you do that, you can use the SDK normally.
127132

128133
1. Import the Optimism SDK.
129134

0 commit comments

Comments
 (0)