wormhole/ethereum

Wormhole bridge - ETH

These smart contracts allow to use Ethereum as foreign chain in the Wormhole protocol.

The Wormhole contract is the bridge contract and allows tokens to be transferred out of ETH and VAAs to be submitted to transfer tokens in or change configuration settings.

The WrappedAsset is a ERC-20 token contract that holds metadata about a wormhole asset on ETH. Wormhole assets are all wrapped non-ETH assets that are currently held on ETH.

Building

To build the contracts: make build

Deploying using Forge

Create the ENV file

Before you can deploy the contracts, you need to create a file in ethereum/env with a name like .env.blast for mainnet or .env.blast.testnet for testnet. Substitute the appropriate chain name (as it will be in the worm client) and use the mentioned one as an example.

Create a symbolic link

ethereum$ ln -s env/.env.blast.testnet .env

Deploy the Core contract

ethereum$ MNEMONIC=<redacted> ./sh/deployCoreBridge.sh

Deploy the TokenBridge contract

ethereum$ MNEMONIC=<redacted> WORMHOLE_ADDRESS=<from_the_previous_command> ./sh/deployTokenBridge.sh

Deploy the Core Shutdown contract

ethereum$ MNEMONIC=<redacted> ./sh/deployCoreShutdown.sh

Deploy the TokenBridge Shutdown contract

ethereum$ MNEMONIC=<redacted> ./sh/deployTokenBridgeShutdown.sh

Generate Flattened Source

To generated the flattened source files to verify the contracts using the explorer UI

ethereum$ ./sh/flatten.sh

This will put the flattened files in ethereum/flattened.

Upgrade the Core or TokenBridge Implementation

ethereum$ MNEMONIC= ./sh/upgrade.sh testnet Core blast
ethereum$ MNEMONIC= ./sh/upgrade.sh testnet TokenBridge blast

Registering Other Chains on a New TokenBridge

ethereum$ MNEMONIC= ./sh/registerAllChainsOnTokenBridge.sh.sh testnet blast

Deploying using Truffle (deprecated)

To deploy the bridge on Ethereum you first need to compile all smart contracts: npx truffle compile

To deploy you can either use the bytecode from the build/contracts folder or the oz cli oz deploy <Contract> (Documentation).

You first need to deploy one Wrapped Asset and initialize it using dummy data.

Then deploy the Wormhole using the initial guardian key (key_x,y_parity,0) and the address of the previously deployed WrappedAsset. The wrapped asset contract will be used as proxy library to all the creation of cheap proxy wrapped assets.

Testing

For each test run:

Run npx ganache-cli --chain.vmErrorsOnRPCResponse --chain.chainId 1 --wallet.defaultBalance 10000 --wallet.deterministic --chain.time="1970-01-01T00:00:00+00:00" --chain.asyncRequestProcessing=false to start a chain.

Run the all ethereum tests using DEV=True make test

Run a specific test file using npx truffle test test/wormhole.js

Run a specific test file while skipping compile npx truffle test test/wormhole.js --compile-none

User methods

submitVAA(bytes vaa) can be used to execute a VAA.

lockAssets(address asset, uint256 amount, bytes32 recipient, uint8 target_chain) can be used to transfer any ERC20 compliant asset out of ETH to any recipient on another chain that is connected to the Wormhole protocol. asset is the asset to be transferred, amount is the amount to transfer (this must be <= the allowance that you have previously given to the bridge smart contract if the token is not a wormhole token), recipient is the foreign chain address of the recipient, target_chain is the id of the chain to transfer to.

lockETH(bytes32 recipient, uint8 target_chain) is a convenience function to wrap the Ether sent with the function call and transfer it as described in lockAssets.

Forge

Some tests and scripts use Foundry. It can be installed via the official installer, or by running

wormhole/ethereum $ ../scripts/install-foundry

The installer script installs foundry and the appropriate solc version to build the contracts.