Skip to content

Audit of SuperERC20 deployment tutorial. #1584

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
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
29 changes: 16 additions & 13 deletions pages/interop/tutorials/deploy-superchain-erc20.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -45,34 +45,36 @@ This requirement abstracts away the complexity of cross-chain validation.
Achieving this requires deterministic deployment methods. There are multiple ways to do this.
Here we will use the [SuperchainERC20 Starter Kit](/app-developers/starter-kit).

### What you'll do
<details>

* Use the [SuperchainERC20 Starter Kit](/app-developers/starter-kit) to deploy an `SuperchainERC20` token on the devnet.
<summary>About this tutorial</summary>

### What you'll learn
**What you'll learn**

* How to deploy `SuperchainERC20` tokens on different chains at the same address.

## Prerequisites

Before starting this tutorial, ensure your development environment meets the following requirements:

### Technical knowledge
**Technical knowledge**

* Understanding of smart contract development
* Familiarity with blockchain concepts

### Development environment
**Development environment**

* Unix-like operating system (Linux, macOS, or WSL for Windows)
* Git for version control

### Required tools
**Required tools**

The tutorial uses these primary tools:

* Foundry: For sending transactions to blockchains.

</details>

### What you'll do

* Use the [SuperchainERC20 Starter Kit](/app-developers/starter-kit) to deploy an `SuperchainERC20` token on the devnet.

## Step by step explanation

<Steps>
Expand All @@ -83,7 +85,7 @@ The tutorial uses these primary tools:
### Prepare for deployment

The Starter Kit already deploys a `SuperchainERC20` token to [Supersim](/interop/tools/supersim).
Here we will deploy it to the [Interop devnet](/interop/tools/devnet).
Here are the required changes to deploy it to the [Interop devnet](/interop/tools/devnet).

1. Edit `packages/contracts/foundry.toml` to add the RPC endpoints for the devnet (add the bottom two rows).

Expand Down Expand Up @@ -157,9 +159,10 @@ The tutorial uses these primary tools:
<summary>Sanity check</summary>

1. Set `TOKEN_ADDRESS` to the address where the token is deployed.
Your address will be different.

```sh
TOKEN_ADDRESS=0x322f4aF25D370BE2A2C74eEFf0DD0d2AF2e7eD75
TOKEN_ADDRESS=<your address>
```

2. Set `PRIVATE_KEY` to the private key for the owner address.
Expand All @@ -169,7 +172,7 @@ The tutorial uses these primary tools:
```

3. Mint tokens for an address you control on both chains.
The owner address is the easiest to use.
It is the easiest to use the owner address.

```sh
OWNER_ADDRESS=`cast wallet address --private-key $PRIVATE_KEY`
Expand Down
2 changes: 0 additions & 2 deletions words.txt
Original file line number Diff line number Diff line change
Expand Up @@ -97,8 +97,6 @@ Devnet
devnet
Devnets
devnets
Devs

direnv
DISABLETXPOOLGOSSIP
disabletxpoolgossip
Expand Down