Categorygithub.com/prysmaticlabs/go-ethereumcontractsdeposit-contract
package
0.3.10
Repository: https://github.com/prysmaticlabs/go-ethereum.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
15
Dependents
0
Files
381 SLOC

# README

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

# Functions

Amount32Eth returns 32Eth(in wei) in terms of the big.Int type.
DeployDepositContract deploys a new Ethereum contract, binding an instance of DepositContract to it.
LessThan1Eth returns less than 1 Eth(in wei) in terms of the big.Int type.
NewDepositContract creates a new instance of DepositContract, bound to a specific deployed contract.
NewDepositContractCaller creates a new read-only instance of DepositContract, bound to a specific deployed contract.
NewDepositContractFilterer creates a new log filterer instance of DepositContract, bound to a specific deployed contract.
NewDepositContractTransactor creates a new write-only instance of DepositContract, bound to a specific deployed contract.
Setup creates the simulated backend with the deposit contract deployed.
UnpackDepositLogData unpacks the data from a deposit log using the ABI decoder.

# Constants

DepositContractABI is the input ABI used to generate the binding from.

# Variables

DepositContractBin is the compiled bytecode used for deploying new contracts.

# Structs

DepositContract is an auto generated Go binding around an Ethereum contract.
DepositContractCaller is an auto generated read-only Go binding around an Ethereum contract.
DepositContractCallerRaw is an auto generated low-level read-only Go binding around an Ethereum contract.
DepositContractCallerSession is an auto generated read-only Go binding around an Ethereum contract, with pre-set call options.
DepositContractDepositEvent represents a DepositEvent event raised by the DepositContract contract.
DepositContractDepositEventIterator is returned from FilterDepositEvent and is used to iterate over the raw logs and unpacked data for DepositEvent events raised by the DepositContract contract.
DepositContractFilterer is an auto generated log filtering Go binding around an Ethereum contract events.
DepositContractRaw is an auto generated low-level Go binding around an Ethereum contract.
DepositContractSession is an auto generated Go binding around an Ethereum contract, with pre-set call and transact options.
DepositContractTransactor is an auto generated write-only Go binding around an Ethereum contract.
DepositContractTransactorRaw is an auto generated low-level write-only Go binding around an Ethereum contract.
DepositContractTransactorSession is an auto generated write-only Go binding around an Ethereum contract, with pre-set transact options.
TestAccount represents a test account in the simulated backend, through which we can perform actions on the eth1.0 chain.