Ali Behjati 44111714f9 Add new contract memory layout (#293) 3 years ago
..
.openzeppelin 44111714f9 Add new contract memory layout (#293) 3 years ago
contracts 2ad991f4ab Abehjati/add-eth-governance (#279) 3 years ago
migrations 2ad991f4ab Abehjati/add-eth-governance (#279) 3 years ago
networks 05c631b022 Add mainnet networks (#274) 3 years ago
scripts 09fcb158dd Add wormhole receiver + docs on how to use it (#216) 3 years ago
test 2ad991f4ab Abehjati/add-eth-governance (#279) 3 years ago
.dockerignore 4f4bec508e EVM deployment scripts and documentation (#141) 3 years ago
.env.prod.arbitrum 05c631b022 Add mainnet networks (#274) 3 years ago
.env.prod.aurora 65c273fa0a Add pythnet migration files (#246) 3 years ago
.env.prod.aurora_testnet 2ad991f4ab Abehjati/add-eth-governance (#279) 3 years ago
.env.prod.avalanche 65c273fa0a Add pythnet migration files (#246) 3 years ago
.env.prod.bnb 65c273fa0a Add pythnet migration files (#246) 3 years ago
.env.prod.bnb_testnet 2ad991f4ab Abehjati/add-eth-governance (#279) 3 years ago
.env.prod.celo 65c273fa0a Add pythnet migration files (#246) 3 years ago
.env.prod.celo_alfajores_testnet 2ad991f4ab Abehjati/add-eth-governance (#279) 3 years ago
.env.prod.development 2ad991f4ab Abehjati/add-eth-governance (#279) 3 years ago
.env.prod.fantom 65c273fa0a Add pythnet migration files (#246) 3 years ago
.env.prod.fantom_testnet 2ad991f4ab Abehjati/add-eth-governance (#279) 3 years ago
.env.prod.fuji 2ad991f4ab Abehjati/add-eth-governance (#279) 3 years ago
.env.prod.goerli 2ad991f4ab Abehjati/add-eth-governance (#279) 3 years ago
.env.prod.mainnet 65c273fa0a Add pythnet migration files (#246) 3 years ago
.env.prod.mumbai 2ad991f4ab Abehjati/add-eth-governance (#279) 3 years ago
.env.prod.optimism 05c631b022 Add mainnet networks (#274) 3 years ago
.env.prod.polygon 65c273fa0a Add pythnet migration files (#246) 3 years ago
.env.prod.ropsten 2ad991f4ab Abehjati/add-eth-governance (#279) 3 years ago
.env.template 2ad991f4ab Abehjati/add-eth-governance (#279) 3 years ago
.env.test 2ad991f4ab Abehjati/add-eth-governance (#279) 3 years ago
1conf.patch 02848a6560 eth: add nft bridge to 1conf (#906) 3 years ago
Deploying.md 05c631b022 Add mainnet networks (#274) 3 years ago
README.md 1094c2cadb ethereum: partially fix npm run test 5 years ago
VERIFY.md 05c631b022 Add mainnet networks (#274) 3 years ago
copy-from-container.sh c5d90f779c Use /usr/bin/env for shell scripts; web/.dockerignore: node_modules (#159) 4 years ago
devnet_mnemonic.txt 2ea41b8176 [WIP] Pr/drozdziak1/p2w batching/5e704f8b (#877) 3 years ago
mine.js da768a09c4 ethereum: mine ganache blocks in the background 5 years ago
package-lock.json 2ad991f4ab Abehjati/add-eth-governance (#279) 3 years ago
package.json 2ad991f4ab Abehjati/add-eth-governance (#279) 3 years ago
truffle-config.js 05c631b022 Add mainnet networks (#274) 3 years ago
truffle-verify-constants.patch 60d313b23c ethereum: Add contract verification instructions (#792) 3 years ago

README.md

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.

Deploying

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 --deterministic --time "1970-01-01T00:00:00+00:00" to start a chain.

Run the tests using npm run test

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.