status-im
/
eth2.0-specs
mirror of https://github.com/status-im/eth2.0-specs.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add custom types

This commit is contained in:
Hsiao-Wei Wang 2019-01-19 15:58:24 +08:00
parent ba8c44dd9a
commit 41813462c3
No known key found for this signature in database
GPG Key ID: 95B070122902DEA4
1 changed files with 38 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

59
specs/core/0_beacon-chain.md
View File

@ -50,6 +50,7 @@
- [`ValidatorRegistryDeltaBlock`](#validatorregistrydeltablock) - [`ValidatorRegistryDeltaBlock`](#validatorregistrydeltablock)
- [`Eth1Data`](#eth1data) - [`Eth1Data`](#eth1data)
- [`Eth1DataVote`](#eth1datavote) - [`Eth1DataVote`](#eth1datavote)
- [Custom Types](#custom-types)
- [Ethereum 1.0 deposit contract](#ethereum-10-deposit-contract) - [Ethereum 1.0 deposit contract](#ethereum-10-deposit-contract)
- [Deposit arguments](#deposit-arguments) - [Deposit arguments](#deposit-arguments)
- [Withdrawal credentials](#withdrawal-credentials) - [Withdrawal credentials](#withdrawal-credentials)
@ -253,6 +254,8 @@ Unless otherwise indicated, code appearing in `this style` is to be interpreted
## Data structures ## Data structures
The following data structures are [SimpleSerialize (SSZ)](https://github.com/ethereum/eth2.0-specs/blob/master/specs/simple-serialize.md) objects.
### Beacon chain operations ### Beacon chain operations
#### Proposer slashings #### Proposer slashings
@ -618,6 +621,20 @@ Unless otherwise indicated, code appearing in `this style` is to be interpreted
} }
``` ```
## Custom Types
We define the following Python custom types for type hinting and readability:
| Name | Type | Description |
| - | - | - |
| `SlotNumber` | unsigned 64-bit integer | the number of a slot |
| `ShardNumber` | unsigned 64-bit integer | the number of a shard |
| `ValidatorIndex` | unsigned 24-bit integer | the index number of validator in the registry |
| `Gwei` | unsigned 64-bit integer | the amount in Gwei |
| `Bytes32` | 32-byte data | the binary data in 32-byte length |
| `BLSPubkey` | 48-byte data | the public key in BLS signature scheme |
| `BLSSignature` | 96-byte data | the signature in BLS signature scheme |
## Ethereum 1.0 deposit contract ## Ethereum 1.0 deposit contract
The initial deployment phases of Ethereum 2.0 are implemented without consensus changes to Ethereum 1.0. A deposit contract at address `DEPOSIT_CONTRACT_ADDRESS` is added to Ethereum 1.0 for deposits of ETH to the beacon chain. Validator balances will be withdrawable to the shards in phase 2, i.e. when the EVM2.0 is deployed and the shards have state. The initial deployment phases of Ethereum 2.0 are implemented without consensus changes to Ethereum 1.0. A deposit contract at address `DEPOSIT_CONTRACT_ADDRESS` is added to Ethereum 1.0 for deposits of ETH to the beacon chain. Validator balances will be withdrawable to the shards in phase 2, i.e. when the EVM2.0 is deployed and the shards have state.
@ -788,7 +805,7 @@ Note: We aim to migrate to a S[T/N]ARK-friendly hash function in a future Ethere
#### `is_active_validator` #### `is_active_validator`
```python ```python
def is_active_validator(validator: Validator, slot: int) -> bool: def is_active_validator(validator: Validator, slot: SlotNumber) -> bool:
""" """
Checks if ``validator`` is active. Checks if ``validator`` is active.
""" """
@ -798,7 +815,7 @@ def is_active_validator(validator: Validator, slot: int) -> bool:
#### `get_active_validator_indices` #### `get_active_validator_indices`
```python ```python
def get_active_validator_indices(validators: [Validator], slot: int) -> List[int]: def get_active_validator_indices(validators: [Validator], slot: SlotNumber) -> List[ValidatorIndex]:
""" """
Gets indices of active validators from ``validators``. Gets indices of active validators from ``validators``.
""" """
@ -890,7 +907,7 @@ def get_committee_count_per_slot(active_validator_count: int) -> int:
```python ```python
def get_shuffling(seed: Bytes32, def get_shuffling(seed: Bytes32,
validators: List[Validator], validators: List[Validator],
slot: int) -> List[List[int]] slot: SlotNumber) -> List[List[ValidatorIndex]]
""" """
Shuffles ``validators`` into crosslink committees seeded by ``seed`` and ``slot``. Shuffles ``validators`` into crosslink committees seeded by ``seed`` and ``slot``.
Returns a list of ``EPOCH_LENGTH * committees_per_slot`` committees where each Returns a list of ``EPOCH_LENGTH * committees_per_slot`` committees where each
@ -942,7 +959,7 @@ def get_current_epoch_committee_count_per_slot(state: BeaconState) -> int:
```python ```python
def get_crosslink_committees_at_slot(state: BeaconState, def get_crosslink_committees_at_slot(state: BeaconState,
slot: int) -> List[Tuple[List[int], int]]: slot: SlotNumber) -> List[Tuple[List[ValidatorIndex], ShardNumber]]:
""" """
Returns the list of ``(committee, shard)`` tuples for the ``slot``. Returns the list of ``(committee, shard)`` tuples for the ``slot``.
""" """
@ -983,7 +1000,7 @@ def get_crosslink_committees_at_slot(state: BeaconState,
```python ```python
def get_block_root(state: BeaconState, def get_block_root(state: BeaconState,
slot: int) -> Bytes32: slot: SlotNumber) -> Bytes32:
""" """
Returns the block root at a recent ``slot``. Returns the block root at a recent ``slot``.
""" """
@ -998,7 +1015,7 @@ def get_block_root(state: BeaconState,
```python ```python
def get_randao_mix(state: BeaconState, def get_randao_mix(state: BeaconState,
slot: int) -> Bytes32: slot: SlotNumber) -> Bytes32:
""" """
Returns the randao mix at a recent ``slot``. Returns the randao mix at a recent ``slot``.
""" """
@ -1011,7 +1028,7 @@ def get_randao_mix(state: BeaconState,
```python ```python
def get_beacon_proposer_index(state: BeaconState, def get_beacon_proposer_index(state: BeaconState,
slot: int) -> int: slot: SlotNumber) -> ValidatorIndex:
""" """
Returns the beacon proposer index for the ``slot``. Returns the beacon proposer index for the ``slot``.
""" """
@ -1037,7 +1054,7 @@ def merkle_root(values: List[Bytes32]) -> Bytes32:
```python ```python
def get_attestation_participants(state: BeaconState, def get_attestation_participants(state: BeaconState,
attestation_data: AttestationData, attestation_data: AttestationData,
aggregation_bitfield: bytes) -> List[int]: aggregation_bitfield: bytes) -> List[ValidatorIndex]:
""" """
Returns the participant indices at for the ``attestation_data`` and ``aggregation_bitfield``. Returns the participant indices at for the ``attestation_data`` and ``aggregation_bitfield``.
""" """
@ -1065,7 +1082,7 @@ def get_attestation_participants(state: BeaconState,
#### `get_effective_balance` #### `get_effective_balance`
```python ```python
def get_effective_balance(state: State, index: int) -> int: def get_effective_balance(state: State, index: ValidatorIndex) -> Gwei:
""" """
Returns the effective balance (also known as "balance at stake") for a ``validator`` with the given ``index``. Returns the effective balance (also known as "balance at stake") for a ``validator`` with the given ``index``.
""" """
@ -1076,7 +1093,7 @@ def get_effective_balance(state: State, index: int) -> int:
```python ```python
def get_fork_version(fork: Fork, def get_fork_version(fork: Fork,
slot: int) -> int: slot: SlotNumber) -> int:
if slot < fork.slot: if slot < fork.slot:
return fork.previous_version return fork.previous_version
else: else:
@ -1087,7 +1104,7 @@ def get_fork_version(fork: Fork,
```python ```python
def get_domain(fork: Fork, def get_domain(fork: Fork,
slot: int, slot: SlotNumber,
domain_type: int) -> int: domain_type: int) -> int:
return get_fork_version( return get_fork_version(
fork, fork,
@ -1294,8 +1311,8 @@ First, a helper function:
```python ```python
def validate_proof_of_possession(state: BeaconState, def validate_proof_of_possession(state: BeaconState,
pubkey: Bytes48, pubkey: BLSPubkey,
proof_of_possession: Bytes96, proof_of_possession: BLSSignature,
withdrawal_credentials: Bytes32, withdrawal_credentials: Bytes32,
randao_commitment: Bytes32, randao_commitment: Bytes32,
custody_commitment: Bytes32) -> bool: custody_commitment: Bytes32) -> bool:
@ -1323,9 +1340,9 @@ Now, to add a [validator](#dfn-validator) or top up an existing [validator](#dfn
```python ```python
def process_deposit(state: BeaconState, def process_deposit(state: BeaconState,
pubkey: Bytes48, pubkey: BLSPubkey,
amount: int, amount: Gwei,
proof_of_possession: Bytes96, proof_of_possession: BLSSignature,
withdrawal_credentials: Bytes32, withdrawal_credentials: Bytes32,
randao_commitment: Bytes32, randao_commitment: Bytes32,
custody_commitment: Bytes32) -> None: custody_commitment: Bytes32) -> None:
@ -1379,7 +1396,7 @@ def process_deposit(state: BeaconState,
Note: All functions in this section mutate `state`. Note: All functions in this section mutate `state`.
```python ```python
def activate_validator(state: BeaconState, index: int, genesis: bool) -> None: def activate_validator(state: BeaconState, index: ValidatorIndex, genesis: bool) -> None:
validator = state.validator_registry[index] validator = state.validator_registry[index]
validator.activation_slot = GENESIS_SLOT if genesis else (state.slot + ENTRY_EXIT_DELAY) validator.activation_slot = GENESIS_SLOT if genesis else (state.slot + ENTRY_EXIT_DELAY)
@ -1395,13 +1412,13 @@ def activate_validator(state: BeaconState, index: int, genesis: bool) -> None:
``` ```
```python ```python
def initiate_validator_exit(state: BeaconState, index: int) -> None: def initiate_validator_exit(state: BeaconState, index: ValidatorIndex) -> None:
validator = state.validator_registry[index] validator = state.validator_registry[index]
validator.status_flags |= INITIATED_EXIT validator.status_flags |= INITIATED_EXIT
``` ```
```python ```python
def exit_validator(state: BeaconState, index: int) -> None: def exit_validator(state: BeaconState, index: ValidatorIndex) -> None:
validator = state.validator_registry[index] validator = state.validator_registry[index]
# The following updates only occur if not previous exited # The following updates only occur if not previous exited
@ -1424,7 +1441,7 @@ def exit_validator(state: BeaconState, index: int) -> None:
``` ```
```python ```python
def penalize_validator(state: BeaconState, index: int) -> None: def penalize_validator(state: BeaconState, index: ValidatorIndex) -> None:
exit_validator(state, index) exit_validator(state, index)
validator = state.validator_registry[index] validator = state.validator_registry[index]
state.latest_penalized_balances[(state.slot // EPOCH_LENGTH) % LATEST_PENALIZED_EXIT_LENGTH] += get_effective_balance(state, index) state.latest_penalized_balances[(state.slot // EPOCH_LENGTH) % LATEST_PENALIZED_EXIT_LENGTH] += get_effective_balance(state, index)
@ -1437,7 +1454,7 @@ def penalize_validator(state: BeaconState, index: int) -> None:
``` ```
```python ```python
def prepare_validator_for_withdrawal(state: BeaconState, index: int) -> None: def prepare_validator_for_withdrawal(state: BeaconState, index: ValidatorIndex) -> None:
validator = state.validator_registry[index] validator = state.validator_registry[index]
validator.status_flags |= WITHDRAWABLE validator.status_flags |= WITHDRAWABLE
``` ```