Optimize ETH contract

ethereum/.openzeppelin/project.json

@@ -1,6 +1,8 @@
 {
   "manifestVersion": "2.2",
-  "contracts": {},
+  "contracts": {
+    "Wormhole": "Wormhole"
+  },
   "dependencies": {},
   "name": "wormhole",
   "version": "0.1.0",

ethereum/README.md

@@ -0,0 +1,36 @@
+# 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 oz compile`
+
+To deploy you can either use the bytecode from the `build/contracts` folder or the oz cli `oz deploy <Contract>` 
+([Documentation](https://docs.openzeppelin.com/learn/deploying-and-interacting)).
+
+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.
+
+### 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`.