prysm-pulse/contracts/deposit-contract
Preston Van Loon d5ddd012bc
Enforce error handling and checking type assertions (#5403)
* Enforce error handling and checking type assertions
* Reference issue #5404 in the TODO message
* doc description
* Merge branch 'master' into errcheck
* fix tests and address @nisdas feedbacK
* gaz
* fix docker image
2020-04-13 04:11:09 +00:00
..
abi.json Update run time to v0.9 (#3935) 2019-11-11 17:03:43 -05:00
BUILD.bazel Update run time to v0.9 (#3935) 2019-11-11 17:03:43 -05:00
bytecode.bin Update run time to v0.9 (#3935) 2019-11-11 17:03:43 -05:00
deposit_tree_test.go Fix typos and inconsistencies (#4453) 2020-01-07 20:36:55 -06:00
depositContract_test.go Update run time to v0.9 (#3935) 2019-11-11 17:03:43 -05:00
depositContract.go Update run time to v0.9 (#3935) 2019-11-11 17:03:43 -05:00
depositContract.v.py Update run time to v0.9 (#3935) 2019-11-11 17:03:43 -05:00
ETH1logs.go Wrap errors (#3123) 2019-08-01 19:27:38 -07:00
README.md Update run time to v0.9 (#3935) 2019-11-11 17:03:43 -05:00
testutils.go Enforce error handling and checking type assertions (#5403) 2020-04-13 04:11:09 +00:00

Deposit Contract

A validator will deposit 32 ETH to the deposit contract. The contract will generate a log showing the validator as a qualified validator. The deposit is considered to be burned. As you burn the 32 ETH to participate, the beacon chain will see it and will credit the validator with the validator bond, At some point in the future, after a hard fork, the original deposit + interest can be withdrawn back on one of the shards.
To call the registration function, it takes arguments of pubkey, proof_of_possession, withdrawal_credentials. If the user wants to deposit more than DEPOSIT_SIZE ETH, they would need to make multiple deposit calls.
When the contract publishes the ChainStart log, beacon nodes will start off the beacon chain with slot 0 and last recorded block.timestamp as beacon chain genesis time. The registration contract generate logs with the various arguments for consumption by beacon nodes. It does not validate proof_of_possession and withdrawal_credentials, pushing the validation logic to the beacon chain.

How to generate bindings for vyper contract

This requires that you have vyper and abigen installed in your local machine. Vyper: https://github.com/ethereum/vyper Abigen: https://github.com/ethereum/go-ethereum/tree/master/cmd/abigen

To generate the abi using the vyper compiler, you can use


docker run -v $(pwd):/code ethereum/vyper:0.1.0b12  -f abi /code/depositContract.v.py > abi.json

Then the abi will be outputted and you can save it in abi.json in the folder.

To generate the bytecode you can then use


docker run -v $(pwd):/code ethereum/vyper:0.1.0b12 /code/depositContract.v.py > bytecode.bin

and save the bytecode in bytecode.bin in the folder. Now with both the abi and bytecode we can generate the go bindings.


bazel run @com_github_ethereum_go_ethereum//cmd/abigen -- -bin $(pwd)/bytecode.bin -abi $(pwd)/abi.json -out $(pwd)/depositContract.go --pkg depositcontract --type DepositContract

How to execute tests

bazel test //contracts/deposit-contract:go_default_test

Run with -v option for detailed log output

bazel test //contracts/deposit-contract:go_default_test --test_arg=-test.v --test_output=streamed 
=== RUN   TestSetupRegistrationContract_OK
--- PASS: TestSetupRegistrationContract_OK (0.07s)
=== RUN   TestRegister_Below1ETH
--- PASS: TestRegister_Below1ETH (0.02s)
=== RUN   TestRegister_Above32Eth
--- PASS: TestRegister_Above32Eth (0.02s)
=== RUN   TestValidatorRegister_OK
--- PASS: TestValidatorRegister_OK (0.08s)
=== RUN   TestDrain
--- PASS: TestDrain (0.04s)
PASS
ok      contracts/deposit-contract        0.633s