Stanisław Drozd 7b9d5b1c22 ethereum/: use publishTime instead of attestationTime for queries (#196) 3 years ago
..
contracts 7b9d5b1c22 ethereum/: use publishTime instead of attestationTime for queries (#196) 3 years ago
migrations 352fa64653 Merge Dev.v2 into main (#181) 3 years ago
scripts 7e212fa739 terra/nft_bridge: Implement nft-bridge for terra (#698) 3 years ago
test 7b9d5b1c22 ethereum/: use publishTime instead of attestationTime for queries (#196) 3 years ago
.dockerignore 352fa64653 Merge Dev.v2 into main (#181) 3 years ago
.env.fantom.mainnet 60363dd3d1 Fantom deploy (#920) 3 years ago
.env.fantom.testnet 3484921b70 ethereum: Add fantom testnet & aurora testnet to truffle-config 3 years ago
.env.template 352fa64653 Merge Dev.v2 into main (#181) 3 years ago
.env.test 352fa64653 Merge Dev.v2 into main (#181) 3 years ago
1conf.patch 02848a6560 eth: add nft bridge to 1conf (#906) 3 years ago
Dockerfile 2ea41b8176 [WIP] Pr/drozdziak1/p2w batching/5e704f8b (#877) 3 years ago
README.md 1094c2cadb ethereum: partially fix npm run test 5 years ago
VERIFY.md 60d313b23c ethereum: Add contract verification instructions (#792) 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 ded0fb37bd evm unit tests in tilt (#186) 3 years ago
package.json ded0fb37bd evm unit tests in tilt (#186) 3 years ago
truffle-config.js 352fa64653 Merge Dev.v2 into main (#181) 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.