Skip to content

Commit 6e583cb

Browse files
stdevMacstdevMac
committed
Merge remote-tracking branch 'origin/main'
2 parents b9c4f66 + 0a03bd9 commit 6e583cb

File tree

12 files changed

+287
-90
lines changed

12 files changed

+287
-90
lines changed

‎pages/app-developers/tutorials/bridging/standard-bridge-custom-token.mdx

+38-35
Original file line numberDiff line numberDiff line change
@@ -18,23 +18,22 @@ is_imported_content: 'false'
1818
import { Callout, Steps } from 'nextra/components'
1919
import { WipCallout } from '@/components/WipCallout'
2020

21-
<WipCallout />
2221
# Bridging your custom ERC-20 token using the Standard Bridge
2322

24-
In this tutorial you'll learn how to bridge a custom ERC-20 token from Ethereum to an OP Stack chain using the Standard Bridge system.
23+
In this tutorial, you'll learn how to bridge a custom ERC-20 token from Ethereum to an OP Stack chain using the Standard Bridge system.
2524
This tutorial is meant for developers who already have an existing ERC-20 token on Ethereum and want to create a bridged representation of that token on OP Mainnet.
2625

27-
This tutorial explains how you can create a custom token that conforms to the [`IOptimismMintableERC20`](https://github.com/ethereum-optimism/optimism/blob/v1.1.4/packages/contracts-bedrock/src/universal/IOptimismMintableERC20.sol) interface so that it can be used with the Standard Bridge system.
26+
This tutorial explains how you can create a custom token that conforms to the [`IOptimismMintableERC20`](https://github.com/ethereum-optimism/optimism/blob/v1.12.2/packages/contracts-bedrock/src/universal/IOptimismMintableERC20.sol) interface so that it can be used with the Standard Bridge system.
2827
A custom token allows you to do things like trigger extra logic whenever a token is deposited.
2928
If you don't need extra functionality like this, consider following the tutorial on [Bridging Your Standard ERC-20 Token Using the Standard Bridge](./standard-bridge-standard-token) instead.
3029

3130
<Callout type="error">
32-
The Standard Bridge **does not** support [**fee on transfer tokens**](https://github.com/d-xo/weird-erc20#fee-on-transfer) or [**rebasing tokens**](https://github.com/d-xo/weird-erc20#balance-modifications-outside-of-transfers-rebasingairdrops) because they can cause bridge accounting errors.
31+
The Standard Bridge **does not** support [**fee on transfer tokens**](https://github.com/d-xo/weird-erc20#fee-on-transfer) or [**rebasing tokens**](https://github.com/d-xo/weird-erc20#balance-modifications-outside-of-transfers-rebasingairdrops) because they can cause bridge accounting errors.
3332
</Callout>
3433

3534
## About OptimismMintableERC20s
3635

37-
The Standard Bridge system requires that L2 representations of L1 tokens implement the [`IOptimismMintableERC20`](https://github.com/ethereum-optimism/optimism/blob/v1.1.4/packages/contracts-bedrock/src/universal/IOptimismMintableERC20.sol) interface.
36+
The Standard Bridge system requires that L2 representations of L1 tokens implement the [`IOptimismMintableERC20`](https://github.com/ethereum-optimism/optimism/blob/v1.12.2/packages/contracts-bedrock/src/universal/IOptimismMintableERC20.sol) interface.
3837
This interface is a superset of the standard ERC-20 interface and includes functions that allow the bridge to properly verify deposits/withdrawals and mint/burn tokens as needed.
3938
Your L2 token contract must implement this interface in order to be bridged using the Standard Bridge system.
4039
This tutorial will show you how to create a custom token that implements this interface.
@@ -50,8 +49,8 @@ This tutorial explains how to create a bridged ERC-20 token on OP Sepolia.
5049
You will need to get some ETH on both of these testnets.
5150

5251
<Callout type="info">
53-
You can use [this faucet](https://sepoliafaucet.com/) to get ETH on Sepolia.
54-
You can use the [Superchain Faucet](https://console.optimism.io/faucet?utm_source=docs) to get ETH on OP Sepolia.
52+
You can use [this faucet](https://sepoliafaucet.com/) to get ETH on Sepolia.
53+
You can use the [Superchain Faucet](https://console.optimism.io/faucet?utm_source=docs) to get ETH on OP Sepolia.
5554
</Callout>
5655

5756
## Add OP Sepolia to your wallet
@@ -76,50 +75,54 @@ In this section, you'll be creating an ERC-20 token that can be deposited but ca
7675
This is just one example of the endless ways in which you could customize your L2 token.
7776

7877
<Steps>
78+
{<h3>Open Remix</h3>}
7979

80-
{<h3>Open Remix</h3>}
80+
Navigate to [Remix](https://remix.ethereum.org) in your browser.
8181

82-
Navigate to [Remix](https://remix.ethereum.org) in your browser.
82+
{<h3>Create a new file</h3>}
8383

84-
{<h3>Create a new file</h3>}
84+
Click the 📄 ("Create new file") button to create a new empty Solidity file.
85+
You can name this file whatever you'd like, for example `MyCustomL2Token.sol`.
8586

86-
Click the 📄 ("Create new file") button to create a new empty Solidity file.
87-
You can name this file whatever you'd like.
87+
{<h3>Copy the example contract</h3>}
8888

89-
{<h3>Copy the example contract</h3>}
89+
Copy the following example contract into your new file:
9090

91-
Copy the following example contract into your new file:
91+
```solidity file=<rootDir>/public/tutorials/standard-bridge-custom-token.sol#L1-L189 hash=087b70cdb85338a213497a64dd049322
92+
```
9293

93-
```solidity file=<rootDir>/public/tutorials/standard-bridge-custom-token.sol#L1-L97 hash=a0b97f33ab7bff9ceb8271b8fa4fd726
94-
```
94+
{<h3>Review the example contract</h3>}
9595

96-
{<h3>Review the example contract</h3>}
96+
Take a moment to review the example contract. It's closely based on the official [`OptimismMintableERC20`](https://github.com/ethereum-optimism/optimism/blob/v1.12.2/packages/contracts-bedrock/src/universal/OptimismMintableERC20.sol) contract with one key modification:
9797

98-
Take a moment to review the example contract.
99-
It's almost the same as the standard [`OptimismMintableERC20`](https://github.com/ethereum-optimism/optimism/blob/v1.1.4/packages/contracts-bedrock/src/universal/OptimismMintableERC20.sol) contract except that the `_burn` function has been made to always revert.
100-
Since the bridge needs to burn tokens when users want to withdraw them to L1, this means that users will not be able to withdraw tokens from this contract.
98+
The `burn` function has been modified to always revert, making it impossible to withdraw tokens back to L1.
10199

102-
```solidity file=<rootDir>/public/tutorials/standard-bridge-custom-token.sol#L85-L96 hash=7c8cdadf1bec4c76dafb5552d1a593fe
103-
```
100+
Since the bridge needs to burn tokens when users want to withdraw them to L1, this means that users will not be able to withdraw tokens from this contract. Here's the key part of the contract that prevents withdrawals:
104101

105-
{<h3>Compile the contract</h3>}
102+
```solidity file=<rootDir>/public/tutorials/standard-bridge-custom-token.sol#L136-L156 hash=632f4649d3ce66c28ec34f58046a8890
103+
```
106104

107-
Save the file to automatically compile the contract.
108-
If you've disabled auto-compile, you'll need to manually compile the contract by clicking the "Solidity Compiler" tab (this looks like the letter "S") and press the blue "Compile" button.
105+
{<h3>Compile the contract</h3>}
109106

110-
{<h3>Deploy the contract</h3>}
107+
Save the file to automatically compile the contract.
108+
If you've disabled auto-compile, you'll need to manually compile the contract by clicking the "Solidity Compiler" tab (this looks like the letter "S") and press the blue "Compile" button.
111109

112-
Open the deployment tab (this looks like an Ethereum logo with an arrow pointing left).
113-
Make sure that your environment is set to "Injected Provider", your wallet is connected to OP Sepolia, and Remix has access to your wallet.
114-
Then, select the `MyCustomL2Token` contract from the deployment dropdown and deploy it with the following parameters:
110+
Make sure you're using Solidity compiler version 0.8.15 (the same version used in the official Optimism contracts).
115111

116-
```text
117-
_BRIDGE: "0x4200000000000000000000000000000000000010"
118-
_REMOTETOKEN: "<L1 ERC-20 address>"
119-
_NAME: "My Custom L2 Token"
120-
_SYMBOL: "MCL2T"
121-
```
112+
{<h3>Deploy the contract</h3>}
122113

114+
Open the deployment tab (this looks like an Ethereum logo with an arrow pointing left).
115+
Make sure that your environment is set to "Injected Provider", your wallet is connected to OP Sepolia, and Remix has access to your wallet.
116+
Then, select the `MyCustomL2Token` contract from the deployment dropdown and deploy it with the following parameters:
117+
118+
```text
119+
_bridge: "0x4200000000000000000000000000000000000010" // L2 Standard Bridge address
120+
_remoteToken: "<L1 ERC-20 address>" // Your L1 token address
121+
_name: "My Custom L2 Token" // Your token name
122+
_symbol: "MCL2T" // Your token symbol
123+
```
124+
125+
Note: The L2 Standard Bridge address is a predefined address on all OP Stack chains, so it will be the same on OP Sepolia and OP Mainnet.
123126
</Steps>
124127

125128
## Bridge some tokens

‎pages/app-developers/tutorials/bridging/standard-bridge-standard-token.mdx

+1-3
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,7 @@ is_imported_content: 'false'
1616
---
1717

1818
import { Callout, Steps } from 'nextra/components'
19-
import { WipCallout } from '@/components/WipCallout'
2019

21-
<WipCallout />
2220
# Bridging Your Standard ERC-20 Token Using the Standard Bridge
2321

2422
In this tutorial you'll learn how to bridge a standard ERC-20 token from Ethereum to an OP Stack chain using the Standard Bridge system.
@@ -34,7 +32,7 @@ The Standard Bridge **does not** support [**fee on transfer tokens**](https://gi
3432

3533
## About OptimismMintableERC20s
3634

37-
The Standard Bridge system requires that L2 representations of L1 tokens implement the [`IOptimismMintableERC20`](https://github.com/ethereum-optimism/optimism/blob/v1.1.4/packages/contracts-bedrock/src/universal/IOptimismMintableERC20.sol) interface.
35+
The Standard Bridge system requires that L2 representations of L1 tokens implement the [`IOptimismMintableERC20`](https://github.com/ethereum-optimism/optimism/blob/v1.12.0/packages/contracts-bedrock/src/universal/OptimismMintableERC20.sol) interface.
3836
This interface is a superset of the standard ERC-20 interface and includes functions that allow the bridge to properly verify deposits/withdrawals and mint/burn tokens as needed.
3937
Your L2 token contract must implement this interface in order to be bridged using the Standard Bridge system.
4038
This tutorial will show you how to use the [`OptimismMintableERC20Factory`](https://github.com/ethereum-optimism/optimism/blob/develop/packages/contracts-bedrock/src/universal/OptimismMintableERC20Factory.sol) to create a basic standardized ERC-20 token on layer 2.

‎pages/notices/upgrade-13.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ import { Steps, Callout } from 'nextra/components'
2323
Upgrade execution timelines are being publicly tracked in this [release management project board](https://github.com/orgs/ethereum-optimism/projects/117/views/12).
2424

2525
* OP Sepolia, Ink Sepolia, and Minato Sepolia are executing their upgrades **March 21st**
26-
* OP Mainnet, Ink Mainnet, and Soneium Mainnet are expected to have Upgrade 13 executed on **April 1st**.
27-
* Unichain Sepolia is executing its upgrade on **April 1st**.
26+
* OP Mainnet, Ink Mainnet, and Soneium Mainnet are expected to have Upgrade 13 executed on **April 2nd**.
27+
* Unichain Sepolia is executing its upgrade on **April 1nd**.
2828
* Unichain Mainnet is executing its upgrade on **April 8th**.
2929
* Other Optimism governed chains' upgrades will be tracked in the release management project board.
3030
</Callout>

‎pages/notices/upgrade-14.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ import { Steps, Callout } from 'nextra/components'
2222
<Callout type="info">
2323
Upgrade execution timelines are being publicly tracked in this [release management project board](https://github.com/orgs/ethereum-optimism/projects/117/views/12) and are subject to change. Here are the following expected timelines:
2424

25-
* OP Sepolia, Ink Sepolia, and Minato Sepolia upgrades are targeting **April 2nd, 2025**.
25+
* OP Sepolia, Ink Sepolia, and Minato Sepolia upgrades are targeting **April 9th, 2025**.
2626
* OP Mainnet, Soneium Mainnet, Ink Mainnet are expected to execute Upgrade 14 on **April 25th, 2025**.
2727
* Other Optimism governed chains' upgrades will be tracked in the release management project board.
2828
</Callout>

‎pages/operators/node-operators/json-rpc.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -981,7 +981,7 @@ todo: add Sample success output
981981

982982
#### `admin_sequencerActive`
983983

984-
TODO: add description
984+
Returns the status of the sequencer. This endpoint provides real-time information about whether the sequencer is actively processing transactions.
985985

986986
<Tabs items={['curl', 'cast']}>
987987
<Tabs.Tab>

‎pages/stack/interop/tools.mdx

+2
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,6 @@ Documentation covering Interop devnet, Supersim in the Interop section of the OP
2626

2727
<Card title="Interop devnet" href="/stack/interop/tools/devnet" icon={<img src="/img/icons/shapes.svg" />} />
2828

29+
<Card title="Release Candidate Alpha devnet" href="/stack/interop/tools/rc-alpha" icon={<img src="/img/icons/shapes.svg" />} />
30+
2931
</Cards>

‎pages/stack/interop/tools/_meta.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
{
2+
"devnet": "Superchain interop devnet",
23
"supersim": "Supersim Multichain Development Environment",
3-
"devnet": "Interop devnet"
4+
"rc-alpha": "Release Candidate Alpha devnet"
45
}

0 commit comments

Comments
 (0)