Merge pull request #60 from OffchainLabs/verification-readme

Add instructions for verifying token bridge deployment

Author: gzeoneth

README.md

@@ -14,6 +14,9 @@ See security audit reports [here](./audits).
 
 This repository is offered under the Apache 2.0 license. See LICENSE for details.
 
+## Deployment
+Check [this doc](./docs/deployment.md) for instructions on deployment and verification of token bridge.
+
 ## Contact
 
 Discord - [Arbitrum](https://discord.com/invite/5KE54JwyTs)

docs/deployment.md

@@ -1,6 +1,6 @@
 # How to deploy RollupCreator and TokenBridgeCreator?
 
-## RollupCreator
+## Deploy RollupCreator
 RollupCreator is in nitro-contracts repo
 ```
 cd nitro-contracts
@@ -38,7 +38,7 @@ yarn run deploy-factory --network arb1
 Script output will contain all deployed addresses.
 
 
-## TokenBridgeCreator
+## Deploy TokenBridgeCreator
 Checkout target code, install dependencies and build
 ```
 cd token-bridge-contracts
@@ -71,4 +71,31 @@ Script outputs `L1TokenBridgeCreator` and `L1TokenBridgeRetryableSender` address
 These contracts will be owned by deployer:
 - RollupCreator (owner can set templates)
 - L1AtomicTokenBridgeCreator (owner can set templates)
-- ProxyAdmin of L1AtomicTokenBridgeCreator and L1TokenBridgeRetryableSender (owner can do upgrades)
+- ProxyAdmin of L1AtomicTokenBridgeCreator and L1TokenBridgeRetryableSender (owner can do upgrades)
+
+
+## Verify token bridge deployment
+There is a verification script which checks that token bridge contracts have been properly deployed and initialized. Here are steps for running it.
+
+Checkout target code, install dependencies and build
+```
+cd token-bridge-contracts
+yarn install
+yarn build
+```
+
+Populate .env
+```
+ROLLUP_ADDRESS
+L1_TOKEN_BRIDGE_CREATOR
+L1_RETRYABLE_SENDER
+BASECHAIN_DEPLOYER_KEY
+ORBIT_RPC
+```
+(`L1_RETRYABLE_SENDER` address can be obtained by calling `retryableSender()` on the L1 token bridge creator)
+
+
+Run the script
+```
+yarn run test:tokenbridge:deployment
+```

scripts/atomicTokenBridgeDeployer.ts

@@ -510,7 +510,8 @@ export const deployL1TokenBridgeCreator = async (
     )
     await l1Verifier.verifyWithAddress(
       'l1TokenBridgeCreatorLogic',
-      l1TokenBridgeCreatorLogic.address
+      l1TokenBridgeCreatorLogic.address,
+      abi.encode(['address'], [l2MulticallAddressOnL1.address])
     )
     await l1Verifier.verifyWithAddress(
       'l1TokenBridgeCreatorProxy',