eth2.0-specs/solidity_deposit_contract/README.md

# Deposit Contract

## History

This is a rewrite of the [Vyper Eth 2.0 deposit contract](https://github.com/ethereum/eth2.0-specs/blob/v0.12.2/deposit_contract/contracts/validator_registration.vy) to Solidity.

The original motivation was to run the SMTChecker and the new Yul IR generator option (`--ir`) in the compiler.

As of June 2020, version `r1` of the Solidity deposit contract has been verified and is considered for adoption.
See this [blog post](https://blog.ethereum.org/2020/06/23/eth2-quick-update-no-12/) for more information.

In August 2020, version `r2` was released with metadata modifications and relicensed to CC0-1.0. Afterward, this contract has been ported back to from [`axic/eth2-deposit-contract`](https://github.com/axic/eth2-deposit-contract) to this repository and replaced the Vyper deposit contract.

## Running web3 tests

1. In the `eth2.0-specs` directory run `make install_deposit_contract_web3_tester` to install the tools needed (make sure to have Python 3.7 and pip installed).
2. In the `eth2.0-specs` directory run `make test_deposit_contract_web3_tests` to execute the tests.

## Running randomized `dapp` tests:

Install the latest version of `dapp` by following the instructions at [dapp.tools](https://dapp.tools/). Then in the `eth2.0-specs` directory run:

```sh
make test_deposit_contract
```
## Verifying bytecode

The following parameters were used to generate the bytecode for the `DepositContract` available in this repository:

* Contract Name: `DepositContract`
* Compiler Version: Solidity `v0.6.11+commit.5ef660b1`
* Optimization Enabled: `Yes` with `5000000` runs
* EVM Version: `default` (Istanbul)
* Metadata Options: `--metadata-literal` (to verify metadata hash)
Update README 2020-08-20 12:56:55 +00:00			`# Deposit Contract`
Genesis 2020-04-14 20:44:39 +00:00
Update the docs and remove unused code 2020-08-17 16:51:03 +00:00			`## History`

			`This is a rewrite of the [Vyper Eth 2.0 deposit contract](https://github.com/ethereum/eth2.0-specs/blob/v0.12.2/deposit_contract/contracts/validator_registration.vy) to Solidity.`
Genesis 2020-04-14 20:44:39 +00:00
Update README to reflect the current status (#37) 2020-06-23 21:41:20 +00:00			The original motivation was to run the SMTChecker and the new Yul IR generator option (`--ir`) in the compiler.
Genesis 2020-04-14 20:44:39 +00:00
Update README 2020-08-20 12:56:55 +00:00			As of June 2020, version `r1` of the Solidity deposit contract has been verified and is considered for adoption.
Update README to reflect the current status (#37) 2020-06-23 21:41:20 +00:00			`See this [blog post](https://blog.ethereum.org/2020/06/23/eth2-quick-update-no-12/) for more information.`
Add Makefile and instructions for the tests in the README 2020-04-15 11:03:19 +00:00
Update README 2020-08-20 12:56:55 +00:00			In August 2020, version `r2` was released with metadata modifications and relicensed to CC0-1.0. Afterward, this contract has been ported back to from [`axic/eth2-deposit-contract`](https://github.com/axic/eth2-deposit-contract) to this repository and replaced the Vyper deposit contract.
Update the docs and remove unused code 2020-08-17 16:51:03 +00:00
Cleaning 2020-08-17 16:20:20 +00:00			`## Running web3 tests`
Add unit test and fuzzing against Vyper (#20) 2020-05-14 19:58:48 +00:00
Update the docs and remove unused code 2020-08-17 16:51:03 +00:00			1. In the `eth2.0-specs` directory run `make install_deposit_contract_web3_tester` to install the tools needed (make sure to have Python 3.7 and pip installed).
			2. In the `eth2.0-specs` directory run `make test_deposit_contract_web3_tests` to execute the tests.
Add unit test and fuzzing against Vyper (#20) 2020-05-14 19:58:48 +00:00
			## Running randomized `dapp` tests:

Update the docs and remove unused code 2020-08-17 16:51:03 +00:00			Install the latest version of `dapp` by following the instructions at [dapp.tools](https://dapp.tools/). Then in the `eth2.0-specs` directory run:

Add unit test and fuzzing against Vyper (#20) 2020-05-14 19:58:48 +00:00			```sh
Update the docs and remove unused code 2020-08-17 16:51:03 +00:00			`make test_deposit_contract`
Add unit test and fuzzing against Vyper (#20) 2020-05-14 19:58:48 +00:00			```
deposit contract: add verifying bytecode to readme closes #2052 2020-09-14 09:37:37 +00:00			`## Verifying bytecode`

			The following parameters were used to generate the bytecode for the `DepositContract` available in this repository:

			* Contract Name: `DepositContract`
			* Compiler Version: Solidity `v0.6.11+commit.5ef660b1`
			* Optimization Enabled: `Yes` with `5000000` runs
add metadata options 2020-09-14 09:51:19 +00:00			* EVM Version: `default` (Istanbul)
			* Metadata Options: `--metadata-literal` (to verify metadata hash)