79657d4392
* Node: Rename Hyperliquid to HyperEVM * Add registration VAA |
||
|---|---|---|
| .. | ||
| contracts | ||
| docs | ||
| env | ||
| forge-scripts | ||
| forge-test | ||
| lib | ||
| sh | ||
| .dockerignore | ||
| .env.test | ||
| .gitignore | ||
| Dockerfile | ||
| Makefile | ||
| PROOFS.md | ||
| README.md | ||
| VERIFY.md | ||
| anvil_fork | ||
| compare-method-identifiers.sh | ||
| foundry | ||
| foundry.toml | ||
| package-lock.json | ||
| package.json | ||
| run-kevm.sh | ||
| simulate_upgrade | ||
| simulate_upgrades | ||
| slither.config.json | ||
| upgrade_all_testnet | ||
| verify | ||
| verify_all | ||
| wormhole-lemmas.k | ||
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.
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 <network> <chainName> <tokenBridgeAddress>
Testing
Run all ethereum tests using make 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.
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.