certusone
/
wormhole
mirror of https://github.com/certusone/wormhole.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
wormhole/ethereum
History
bruce-riley 879670c0e5
Klaytn testnet support (#1038) 
* Klaytn support for testnet

Change-Id: Id0647fd6c603ab298f860c2cae20481555467315

* token_bridge client changes

Change-Id: If49ba994a67041044bdec054f19e69b4cfc2785b

* Get rid of special handling

* More cleanup

* Need to add Klaytn to structs tests

* Update SDK version

* Add SDK version

* fix klaytn bridge chain id

Co-authored-by: Evan Gray <battledingo@gmail.com>
 		2022-04-04 18:11:03 -04:00
..
contracts ethereum/nft-bridge: Transfer before burn 2022-03-18 13:14:32 +00:00
migrations Run ethereum tests on CI (#1028) 2022-03-31 00:32:27 -04:00
scripts Add NFT deploy script 2022-03-18 13:14:32 +00:00
test Run ethereum tests on CI (#1028) 2022-03-31 00:32:27 -04:00
.dockerignore Update devnet and Solana program 2020-08-16 13:21:39 +02:00
.env.acala.testnet Karura and Acala support (#862) 2022-03-03 16:40:32 -05:00
.env.aurora.testnet Testnet support for Aurora (#947) 2022-03-15 10:41:10 -04:00
.env.fantom.mainnet Fantom deploy (#920) 2022-02-28 16:32:22 -05:00
.env.fantom.testnet ethereum: Add fantom testnet & aurora testnet to truffle-config 2022-02-09 16:07:57 -05:00
.env.karura.testnet Karura and Acala support (#862) 2022-03-03 16:40:32 -05:00
.env.klaytn.testnet Klaytn testnet support (#1038) 2022-04-04 18:11:03 -04:00
.env.template remove pyth2wormhole 2022-03-07 10:23:34 -05:00
.env.test remove pyth2wormhole 2022-03-07 10:23:34 -05:00
.gitignore Run ethereum tests on CI (#1028) 2022-03-31 00:32:27 -04:00
1conf.patch eth: add nft bridge to 1conf (#906) 2022-02-24 14:57:06 -06:00
Dockerfile Run ethereum tests on CI (#1028) 2022-03-31 00:32:27 -04:00
Makefile Run ethereum tests on CI (#1028) 2022-03-31 00:32:27 -04:00
README.md ethereum: partially fix npm run test 2020-08-16 01:47:10 +02:00
VERIFY.md ethereum: Add contract verification instructions (#792) 2022-01-28 14:52:54 +01:00
copy-from-container.sh Use /usr/bin/env for shell scripts; web/.dockerignore: node_modules (#159) 2021-01-23 18:20:17 +01:00
devnet_mnemonic.txt [WIP] Pr/drozdziak1/p2w batching/5e704f8b (#877) 2022-02-23 19:12:16 +01:00
mine.js ethereum: mine ganache blocks in the background 2020-11-18 13:56:56 +01:00
package-lock.json ethereum: fix package-lock.json 2022-03-07 23:13:48 -05:00
package.json Klaytn testnet support (#1038) 2022-04-04 18:11:03 -04:00
truffle-config.js Klaytn testnet support (#1038) 2022-04-04 18:11:03 -04:00
truffle-verify-constants.patch ethereum: Add contract verification instructions (#792) 2022-01-28 14:52:54 +01:00

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.