diff --git a/README.md b/README.md index 671490f..aac4661 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,38 @@ -# L2 Base Bridging +# L2 Optimism ERC-20 Bridging -This is for depositing L1 tokens to L2. Written for Base blockchain -originally +This is for depositing L1 ERC-20 tokens to L2. Written for Base blockchain +originally. This is a separate project from the token build/deploy project because there is a dependency conflict between Hardhat and the Optimism SDK. ## Build - npm install #download dependencies - npx tsc # compile +``` +npm install #download dependencies +npx tsc # compile +``` ## configure -create a file `.env.dev` +create a file `.env.dev`: - MNEMONIC="special person entering our world egg yolks" - L1_TOKEN_ADDRESS=0xwhatever01 - L2_TOKEN_ADDRESS=0xwhatever02 - L1_RPC_URL="https://goerli.infura.io/v3/yourapikeyhere" - L2_RPC_URL=https://goerli.base.org +``` +MNEMONIC="special person entering our world egg yolks" +L1_TOKEN_ADDRESS=0xwhatever01 +L2_TOKEN_ADDRESS=0xwhatever02 +L1_RPC_URL="https://goerli.infura.io/v3/yourapikeyhere" +L2_RPC_URL=https://goerli.base.org +``` Tailor to your environment. You can create multiple with different suffixes, they are loaded by the NODE_ENV environment variable below. ## Run - NODE_ENV=dev node dist/index.js weiamounthere +``` +NODE_ENV=dev node dist/index.js weiamounthere +``` ## License