nimbus-eth1/nimbus/constants.nim


import
  math, strutils, utils/padding, eth_common

proc default(t: typedesc): t = discard

# constants

let
  UINT_256_MAX*: UInt256 =        high(UInt256)
  INT_256_MAX_AS_UINT256* =       cast[Uint256](high(Int256))
  NULLBYTE* =                     "\x00"
  EMPTYWORD* =                    repeat(NULLBYTE, 32)
  UINT160CEILING*: UInt256 =      2.u256.pow(160)
  ZERO_ADDRESS* =                 default(EthAddress)
  CREATE_CONTRACT_ADDRESS* =      ZERO_ADDRESS
  ZERO_HASH32* =                  Hash256()
  STACK_DEPTH_LIMIT* =            1024

  GAS_LIMIT_EMA_DENOMINATOR* =    1_024
  GAS_LIMIT_ADJUSTMENT_FACTOR* =  1_024
  GAS_LIMIT_USAGE_ADJUSTMENT_NUMERATOR* = 3
  GAS_LIMIT_USAGE_ADJUSTMENT_DENOMINATOR* = 2

  DIFFICULTY_ADJUSTMENT_DENOMINATOR* = 2_048.u256
  DIFFICULTY_MINIMUM* =           131_072.u256
  BYZANTIUM_DIFFICULTY_ADJUSTMENT_CUTOFF* = 9

  BOMB_EXPONENTIAL_PERIOD* =      100_000.u256
  BOMB_EXPONENTIAL_FREE_PERIODS* = 2.u256

  BLOCK_REWARD* =                 5.u256 * 2.u256 # denoms.ether

  UNCLE_DEPTH_PENALTY_FACTOR* =   8.u256

  MAX_UNCLE_DEPTH* =              6.u256
  MAX_UNCLES* =                   2.u256

  EMPTY_UNCLE_HASH* =             "1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347".toDigest

  GENESIS_BLOCK_NUMBER* =         0.u256
  GENESIS_DIFFICULTY* =           131_072.u256
  GENESIS_GAS_LIMIT* =            3_141_592
  GENESIS_PARENT_HASH* =          ZERO_HASH32
  GENESIS_COINBASE* =             ZERO_ADDRESS
  GENESIS_NONCE* =                "\x00\x00\x00\x00\x00\x00\x00B"
  GENESIS_MIX_HASH* =             ZERO_HASH32
  GENESIS_EXTRA_DATA* =           ""
  GAS_LIMIT_MINIMUM* =            5000

  BLANK_ROOT_HASH* =              "56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421".toDigest
  EMPTY_SHA3* =                   "883f7328a6c30727a655daff17eba3a86049871bc7839a5b71e2bc26a99c4d4c".toDigest

  GAS_MOD_EXP_QUADRATIC_DENOMINATOR* = 20.u256

  MAX_PREV_HEADER_DEPTH* =        256.toBlockNumber

  FORK_ICEAGE_BLKNUM* =           200_000.u256
  FORK_HOMESTED_BLKNUM* =         1_150_000.u256
  FORK_DAO_BLKNUM* =              1_920_000.u256
  FORK_TANGERINE_WHISTLE_BLKNUM* = 2_463_000.u256
  FORK_SPURIOUS_DRAGON_BLKNUM* =  2_675_000.u256
  FORK_BYZANTIUM_BLKNUM* =        4_370_000.u256

# TODO: Move the below to a new utils unit?

type
  Fork = enum fkUnknown, fkFrontier, fkIceAge, fkHomested, fkDao, fkTangerineWhistle, fkSpuriousDragon, fkByzantium
  UInt256Pair = tuple[a: Uint256, b: Uint256]

proc `..`*(a, b: Uint256): UInt256Pair = (a, b)

proc contains*(ab: UInt256Pair, v: UInt256): bool =
  return v >= ab[0] and v <= ab[1]

proc toFork*(blockNumber: UInt256): Fork =
  # TODO - Refactoring: superseded by newNimbusVM for the time being #https://github.com/status-im/nimbus/pull/37
  # TODO - Refactoring: redundant with `chain.nim` getVM
  result = fkUnknown
  let one = u256(1)
  if blockNumber in u256(0)..FORK_ICEAGE_BLKNUM - one: result = fkFrontier
  elif blockNumber in FORK_ICEAGE_BLKNUM..FORK_HOMESTED_BLKNUM - one: result = fkIceAge
  elif blockNumber in FORK_HOMESTED_BLKNUM..FORK_DAO_BLKNUM - one: result = fkHomested
  elif blockNumber in FORK_DAO_BLKNUM..FORK_TANGERINE_WHISTLE_BLKNUM - one: result = fkDao
  elif blockNumber in FORK_TANGERINE_WHISTLE_BLKNUM..FORK_SPURIOUS_DRAGON_BLKNUM - one: result = fkTangerineWhistle
  elif blockNumber in FORK_SPURIOUS_DRAGON_BLKNUM..FORK_BYZANTIUM_BLKNUM - one: result = fkSpuriousDragon
  else:
    if blockNumber >= FORK_BYZANTIUM_BLKNUM: result = fkByzantium # Update for constantinople when announced
First part of port Translate with py2nim Work on improving the input, use more nim-ish stuff 2018-01-15 18:42:40 +00:00
			`import`
Implemented most of the stubbed-out state handling instructions (#59) Merge note: currently cannot compile due to `quasiBoolean` (#63). This will be solved by https://github.com/status-im/nimbus/pull/65 ---- * Implemented most of the stubbed out state handling instructions The code compiles, but still fails at the moment due to incorrect initialization of the VM. Don't merge yet. More commits will be pushed in the coming days. * Fixed crash * trie put and del are void now * getBlockTransactionData and getReceipts * Working code for extcodesize0.json * fix origin.json * fix calldatasize1 * fix calldataloadSizeTooHighPartial * fix calldataloadSizeTooHigh * more efficient PushX implementation * fix and, or, xor 2018-07-05 12:41:01 +00:00			`math, strutils, utils/padding, eth_common`
First part of port Translate with py2nim Work on improving the input, use more nim-ish stuff 2018-01-15 18:42:40 +00:00
Hash256/EthAddrres refactoring 2018-05-30 16:11:15 +00:00			`proc default(t: typedesc): t = discard`

Pass more tests, use UInt256 more often 82 / 189 arithmetic 55 / 62 logic 77 / 78 stack Most errors are the same sstore gascost bug, also next work on flow and memory 2018-02-20 17:27:43 +00:00			`# constants`

Implement duplication and block, add more opcodes, improve math support 2018-01-22 22:23:07 +00:00			`let`
Migrate from ttmath to stint (#24) * Constants and accounts compile as standalone * Mass replace ttmath by Stint * Adapt utils_numeric proc * Adapt memory.nim * Deactivate "ValidationError" test that requires pow(2, 256) function * Fix state_db toByteArrayBE * Fix more getUint toInt conversion * Remove absolute value ambiguous call * Stub-ify proc and opcode that requires pow - https://github.com/status-im/nim-stint/issues/37 2018-05-07 12:41:54 +00:00			`UINT_256_MAX*: UInt256 = high(UInt256)`
Fix arithmetic implementation issues (#30) * Change modular arithmetic ops and signextend implementation * Don't use signed int, introduce EVM "pseudoSigned" conversion pass 4 sdiv/smod tests * Print computation error in tests 2018-05-17 08:08:28 +00:00			`INT_256_MAX_AS_UINT256* = cast[Uint256](high(Int256))`
CodeStream impl and tests, fix byte and string fields 2018-01-31 12:57:05 +00:00			`NULLBYTE* = "\x00"`
Implement duplication and block, add more opcodes, improve math support 2018-01-22 22:23:07 +00:00			`EMPTYWORD* = repeat(NULLBYTE, 32)`
Reorganize VM/interpreter + cleanup (#52) * Move and cleanup interpreter files - prepare for redesign of VM * fix call comment aobut recursive dependencies * memory: use a template again and avoid (?) a cstring-> string conversion * Fix stack test regression * Fix recursive dependency on logging_ops, test_vm_json compiles but regression :/ * Fix signextend regression * Fix 3 signed test and sha3 test 2018-06-15 09:11:25 +00:00			`UINT160CEILING*: UInt256 = 2.u256.pow(160)`
Hash256/EthAddrres refactoring 2018-05-30 16:11:15 +00:00			`ZERO_ADDRESS* = default(EthAddress)`
			`CREATE_CONTRACT_ADDRESS* = ZERO_ADDRESS`
			`ZERO_HASH32* = Hash256()`
WIP call (different call variants depending on fork) 2018-01-30 18:12:05 +00:00			`STACK_DEPTH_LIMIT* = 1024`
Use new memrange and nim rlp 2018-04-11 10:42:04 +00:00
Hash256/EthAddrres refactoring 2018-05-30 16:11:15 +00:00			`GAS_LIMIT_EMA_DENOMINATOR* = 1_024`
			`GAS_LIMIT_ADJUSTMENT_FACTOR* = 1_024`
			`GAS_LIMIT_USAGE_ADJUSTMENT_NUMERATOR* = 3`
			`GAS_LIMIT_USAGE_ADJUSTMENT_DENOMINATOR* = 2`
Adding fork info 2018-04-05 17:32:18 +00:00
Pass more tests, use UInt256 more often 82 / 189 arithmetic 55 / 62 logic 77 / 78 stack Most errors are the same sstore gascost bug, also next work on flow and memory 2018-02-20 17:27:43 +00:00			`DIFFICULTY_ADJUSTMENT_DENOMINATOR* = 2_048.u256`
			`DIFFICULTY_MINIMUM* = 131_072.u256`
Adding fork info 2018-04-05 17:32:18 +00:00			`BYZANTIUM_DIFFICULTY_ADJUSTMENT_CUTOFF* = 9`

Pass more tests, use UInt256 more often 82 / 189 arithmetic 55 / 62 logic 77 / 78 stack Most errors are the same sstore gascost bug, also next work on flow and memory 2018-02-20 17:27:43 +00:00			`BOMB_EXPONENTIAL_PERIOD* = 100_000.u256`
			`BOMB_EXPONENTIAL_FREE_PERIODS* = 2.u256`
Use new memrange and nim rlp 2018-04-11 10:42:04 +00:00
Pass more tests, use UInt256 more often 82 / 189 arithmetic 55 / 62 logic 77 / 78 stack Most errors are the same sstore gascost bug, also next work on flow and memory 2018-02-20 17:27:43 +00:00			`BLOCK_REWARD* = 5.u256 * 2.u256 # denoms.ether`
Use new memrange and nim rlp 2018-04-11 10:42:04 +00:00
Pass more tests, use UInt256 more often 82 / 189 arithmetic 55 / 62 logic 77 / 78 stack Most errors are the same sstore gascost bug, also next work on flow and memory 2018-02-20 17:27:43 +00:00			`UNCLE_DEPTH_PENALTY_FACTOR* = 8.u256`
Use new memrange and nim rlp 2018-04-11 10:42:04 +00:00
Pass more tests, use UInt256 more often 82 / 189 arithmetic 55 / 62 logic 77 / 78 stack Most errors are the same sstore gascost bug, also next work on flow and memory 2018-02-20 17:27:43 +00:00			`MAX_UNCLE_DEPTH* = 6.u256`
			`MAX_UNCLES* = 2.u256`
Use new memrange and nim rlp 2018-04-11 10:42:04 +00:00
Hash256/EthAddrres refactoring 2018-05-30 16:11:15 +00:00			`EMPTY_UNCLE_HASH* = "1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347".toDigest`
Use new memrange and nim rlp 2018-04-11 10:42:04 +00:00
Pass more tests, use UInt256 more often 82 / 189 arithmetic 55 / 62 logic 77 / 78 stack Most errors are the same sstore gascost bug, also next work on flow and memory 2018-02-20 17:27:43 +00:00			`GENESIS_BLOCK_NUMBER* = 0.u256`
			`GENESIS_DIFFICULTY* = 131_072.u256`
Hash256/EthAddrres refactoring 2018-05-30 16:11:15 +00:00			`GENESIS_GAS_LIMIT* = 3_141_592`
Implement duplication and block, add more opcodes, improve math support 2018-01-22 22:23:07 +00:00			`GENESIS_PARENT_HASH* = ZERO_HASH32`
			`GENESIS_COINBASE* = ZERO_ADDRESS`
CodeStream impl and tests, fix byte and string fields 2018-01-31 12:57:05 +00:00			`GENESIS_NONCE* = "\x00\x00\x00\x00\x00\x00\x00B"`
Implement duplication and block, add more opcodes, improve math support 2018-01-22 22:23:07 +00:00			`GENESIS_MIX_HASH* = ZERO_HASH32`
Work on text fitures and decompiling bytecode 2018-02-12 16:59:12 +00:00			`GENESIS_EXTRA_DATA* = ""`
Hash256/EthAddrres refactoring 2018-05-30 16:11:15 +00:00			`GAS_LIMIT_MINIMUM* = 5000`
Use new memrange and nim rlp 2018-04-11 10:42:04 +00:00
Implemented most of the stubbed-out state handling instructions (#59) Merge note: currently cannot compile due to `quasiBoolean` (#63). This will be solved by https://github.com/status-im/nimbus/pull/65 ---- * Implemented most of the stubbed out state handling instructions The code compiles, but still fails at the moment due to incorrect initialization of the VM. Don't merge yet. More commits will be pushed in the coming days. * Fixed crash * trie put and del are void now * getBlockTransactionData and getReceipts * Working code for extcodesize0.json * fix origin.json * fix calldatasize1 * fix calldataloadSizeTooHighPartial * fix calldataloadSizeTooHigh * more efficient PushX implementation * fix and, or, xor 2018-07-05 12:41:01 +00:00			`BLANK_ROOT_HASH* = "56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421".toDigest`
			`EMPTY_SHA3* = "883f7328a6c30727a655daff17eba3a86049871bc7839a5b71e2bc26a99c4d4c".toDigest`
Use new memrange and nim rlp 2018-04-11 10:42:04 +00:00
Pass more tests, use UInt256 more often 82 / 189 arithmetic 55 / 62 logic 77 / 78 stack Most errors are the same sstore gascost bug, also next work on flow and memory 2018-02-20 17:27:43 +00:00			`GAS_MOD_EXP_QUADRATIC_DENOMINATOR* = 20.u256`
Implement duplication and block, add more opcodes, improve math support 2018-01-22 22:23:07 +00:00
Few steps towards having 64-bit block numbers (#57) Some of the other clients don't bother to store block numbers as 256-bit integers (64 bits or even 32 bit are enough). The changes here are based on helpers introduced in eth_common that try to abstract away all conversion steps in the code between VM words and block numbers in variables in fields. Unfortunately, this turn out to be more work than anticipated and I've postponed finishing the refactoring for now (Block numbers are still 256 bit). 2018-06-26 14:09:50 +00:00			`MAX_PREV_HEADER_DEPTH* = 256.toBlockNumber`
Implement duplication and block, add more opcodes, improve math support 2018-01-22 22:23:07 +00:00
Adding fork info 2018-04-05 17:32:18 +00:00			`FORK_ICEAGE_BLKNUM* = 200_000.u256`
			`FORK_HOMESTED_BLKNUM* = 1_150_000.u256`
			`FORK_DAO_BLKNUM* = 1_920_000.u256`
			`FORK_TANGERINE_WHISTLE_BLKNUM* = 2_463_000.u256`
			`FORK_SPURIOUS_DRAGON_BLKNUM* = 2_675_000.u256`
			`FORK_BYZANTIUM_BLKNUM* = 4_370_000.u256`

			`# TODO: Move the below to a new utils unit?`

			`type`
			`Fork = enum fkUnknown, fkFrontier, fkIceAge, fkHomested, fkDao, fkTangerineWhistle, fkSpuriousDragon, fkByzantium`
			`UInt256Pair = tuple[a: Uint256, b: Uint256]`

			proc `..`*(a, b: Uint256): UInt256Pair = (a, b)

			`proc contains*(ab: UInt256Pair, v: UInt256): bool =`
			`return v >= ab[0] and v <= ab[1]`

			`proc toFork*(blockNumber: UInt256): Fork =`
1st gas refactoring - handle different gas costs in Ethereum forks (#37) * Start by renaming the fork by chronological order * initial commit - groundwork: support different gasCosts depending on VMs * Running VMTests with new gas config - only push32AndSuicide changed * Introduce newNimbusVM that (temporarily) abstract over Frontier and Tangerine VM creation * Fix Gas - push32AndSuicide repassing and expXY_success passing - fixes #34 * case sensitive imports (thank you auto-completion) fix Travis on Linux * Add pre and post EIP-150 tests * Nimify gas identifiers that supports multiple forks 2018-05-24 10:01:59 +00:00			`# TODO - Refactoring: superseded by newNimbusVM for the time being #https://github.com/status-im/nimbus/pull/37`
			# TODO - Refactoring: redundant with `chain.nim` getVM
Adding fork info 2018-04-05 17:32:18 +00:00			`result = fkUnknown`
			`let one = u256(1)`
			`if blockNumber in u256(0)..FORK_ICEAGE_BLKNUM - one: result = fkFrontier`
			`elif blockNumber in FORK_ICEAGE_BLKNUM..FORK_HOMESTED_BLKNUM - one: result = fkIceAge`
			`elif blockNumber in FORK_HOMESTED_BLKNUM..FORK_DAO_BLKNUM - one: result = fkHomested`
			`elif blockNumber in FORK_DAO_BLKNUM..FORK_TANGERINE_WHISTLE_BLKNUM - one: result = fkDao`
			`elif blockNumber in FORK_TANGERINE_WHISTLE_BLKNUM..FORK_SPURIOUS_DRAGON_BLKNUM - one: result = fkTangerineWhistle`
			`elif blockNumber in FORK_SPURIOUS_DRAGON_BLKNUM..FORK_BYZANTIUM_BLKNUM - one: result = fkSpuriousDragon`
			`else:`
			`if blockNumber >= FORK_BYZANTIUM_BLKNUM: result = fkByzantium # Update for constantinople when announced`