defmodule Elixium.Block do alias Elixium.Block alias Elixium.Utilities alias Elixium.Transaction alias Elixium.Store.Ledger alias Decimal, as: D require Logger @moduledoc """ Provides functions for creating blocks and mining new ones """ defstruct index: <<0, 0, 0, 0>>, hash: nil, version: <<0, 0>>, previous_hash: nil, difficulty: 3_000_000.0, nonce: <<0, 0, 0, 0, 0, 0, 0, 0>>, timestamp: nil, merkle_root: nil, transactions: [] @doc """ When the first node on the Elixium network spins up, there won't be any blocks in the chain. In order to create a base from which all nodes can agree, we create a block called a genesis block. This block has the data structure that a block would have, but has hard-coded values. This block never needs to be verified by nodes, as it doesn't contain any actual data. The block mined after the genesis block must reference the hash of the genesis block as its previous_hash to be valid """ @spec initialize :: Block def initialize do %Block{ timestamp: time_unix(), previous_hash: String.duplicate("0", 64) # 32 bytes of 0 } end @doc """ Takes the previous block as an argument (This is the way we create every block except the genesis block) """ @spec initialize(Block) :: Block def initialize(%{index: index, hash: previous_hash}) do index = index |> :binary.decode_unsigned() |> Kernel.+(1) |> :binary.encode_unsigned() |> Utilities.zero_pad(4) block = %Block{ index: index, previous_hash: previous_hash, timestamp: time_unix() } difficulty = calculate_difficulty(block) Map.put(block, :difficulty, difficulty) end @spec calculate_block_hash(Block) :: String.t() def calculate_block_hash(block) do %{ index: index, version: version, previous_hash: previous_hash, timestamp: timestamp, nonce: nonce, merkle_root: merkle_root } = block Utilities.sha3_base16([ index, version, previous_hash, timestamp, nonce, merkle_root ]) end @doc """ The process of mining consists of hashing the index of the block, the hash of the previous block (thus linking the current and previous block), the timestamp at which the block was generated, the merkle root of the transactions within the block, and a random nonce. We then check to see whether the number represented by the hash is lower than the mining difficulty. If the value of the hash is lower, it is a valid block, and we can broadcast the block to other nodes on the network. """ @spec mine(Block, Range.t(), number, number) :: Block | :not_in_range def mine(block, nonce_range \\ 0..18446744073709551615, cpu_num \\ 0, hashes \\ 0, last_hashrate_check \\ time_unix()) do block = Map.put(block, :hash, calculate_block_hash(block)) cond do hash_beat_target?(block) -> exit(block) :binary.decode_unsigned(block.nonce) not in nonce_range -> exit(:not_in_range) true -> # Output hashrate after every 10 seconds {hashes, last_hashrate_check} = if time_unix() > last_hashrate_check + 30 && rem(time_unix() - last_hashrate_check, 31) == 0 do time = time_unix() Logger.info("CPU ##{cpu_num} Hashrate: #{Float.round((hashes / 30) / 1000, 2)} kH/s") {0, time - 1} else {hashes + 1, last_hashrate_check} end # Wrap nonce back to 0 if we're about to overflow 8 bytes. # We increase the timestamp and try again if block.nonce == <<255, 255, 255, 255, 255, 255, 255, 255>> do mine(%{block | nonce: <<0, 0, 0, 0, 0, 0, 0, 0>>, timestamp: time_unix()}, nonce_range, cpu_num, hashes, last_hashrate_check) else nonce = block.nonce |> :binary.decode_unsigned() |> Kernel.+(1) |> :binary.encode_unsigned() |> Utilities.zero_pad(8) # Add trailing zero bytes since they're removed when encoding / decoding mine(%{block | nonce: nonce}, nonce_range, cpu_num, hashes, last_hashrate_check) end end end @doc """ Retrieves a block header from a given block """ @spec header(Block) :: map def header(block) do %{ hash: block.hash, index: block.index, version: block.version, previous_hash: block.previous_hash, merkle_root: block.merkle_root, nonce: block.nonce, timestamp: block.timestamp } end @doc """ Because the hash is a Base16 string, and not an integer, we must first convert the hash to an integer, and afterwards compare it to the target """ @spec hash_beat_target?(Block) :: boolean def hash_beat_target?(%{hash: hash, difficulty: difficulty}) do {integer_value_of_hash, _} = Integer.parse(hash, 16) integer_value_of_hash < calculate_target(difficulty) end @doc """ The target is a number based off of the block difficulty. The higher the block difficulty, the lower the target. When a block is being mined, the goal is to find a hash that is lower in numerical value than the target. The maximum target (when the difficulty is 0) is 115792089237316195423570985008687907853269984665640564039457584007913129639935, which means any hash is valid. """ @spec calculate_target(float) :: number def calculate_target(difficulty), do: round((:math.pow(16, 64) / difficulty)) - 1 @doc """ Calculates the block reward for a given block index, following our weighted smooth emission algorithm. Where x is total token supply, t is block at full emission, i is block index, and s is the sigma of the total_token_supply, the Smooth emission algorithm is as follows: (x * max{0, t - i}) / s """ @spec calculate_block_reward(number) :: Decimal def calculate_block_reward(block_index) do sigma_full_emission = Application.get_env(:elixium_core, :sigma_full_emission) total_token_supply = Application.get_env(:elixium_core, :total_token_supply) block_at_full_emission = Application.get_env(:elixium_core, :block_at_full_emission) D.div( D.mult( D.from_float(total_token_supply), D.new(max(0, block_at_full_emission - block_index)) ), D.new(sigma_full_emission) ) end @spec total_block_fees(list) :: Decimal def total_block_fees(transactions) do Enum.reduce(transactions, D.new(0), fn tx, acc -> D.add(acc, Transaction.calculate_fee(tx)) end) end @doc """ Return a list of keys that differ between two given block headers. """ @spec diff_header(Block, Block) :: list def diff_header(block1, block2) do block1 |> header() |> Map.keys() |> Enum.filter(&(Map.get(block1, &1) != Map.get(block2, &1))) end @doc """ Calculates the difficulty for a block using the WWHM difficulty algorithm described at https://getmasari.org/research-papers/wwhm.pdf """ @spec calculate_difficulty(Block) :: number def calculate_difficulty(block) do index = :binary.decode_unsigned(block.index) if index < 11 do 3_000_000.0 else blocks_to_weight = :elixium_core |> Application.get_env(:retargeting_window) |> Ledger.last_n_blocks() |> Enum.map(&(%{&1 | index: :binary.decode_unsigned(&1.index)})) calculate_difficulty(%{block | index: index}, blocks_to_weight) end end def calculate_difficulty(block, blocks_to_weight) do retargeting_window = Application.get_env(:elixium_core, :retargeting_window) target_solvetime = Application.get_env(:elixium_core, :target_solvetime) # If we don't have enough blocks to fill our retargeting window, the # algorithm won't run properly (difficulty will be set too high). Let's scale # the algo down until then. retargeting_window = min(block.index, retargeting_window) {weighted_solvetimes, summed_difficulties} = weight_solvetimes_and_sum_difficulties(blocks_to_weight) min_timespan = (target_solvetime * retargeting_window) / 2 weighted_solvetimes = if weighted_solvetimes < min_timespan, do: min_timespan, else: weighted_solvetimes target = (retargeting_window + 1) / 2 * target_solvetime summed_difficulties * target / weighted_solvetimes end def weight_solvetimes_and_sum_difficulties(blocks) do target_solvetime = Application.get_env(:elixium_core, :target_solvetime) max_solvetime = target_solvetime * 10 {_, weighted_solvetimes, summed_difficulties, _} = blocks |> Enum.scan({nil, 0, 0, 0}, fn block, {last_block_timestamp, weighted_solvetimes, sum_difficulties, i} -> if i == 0 do {block.timestamp, 0, 0, 1} else solvetime = block.timestamp - last_block_timestamp solvetime = if solvetime > max_solvetime, do: max_solvetime, else: solvetime solvetime = if solvetime == 0, do: 1, else: solvetime {block.timestamp, weighted_solvetimes + (solvetime * i), sum_difficulties + block.difficulty, i + 1} end end) |> List.last() {weighted_solvetimes, summed_difficulties} end @doc """ Takes in a block received from a peer which may have malicious or extra attributes attached. Removes all extra parameters which are not defined explicitly by the block struct. """ @spec sanitize(Block) :: Block def sanitize(unsanitized_block) do sanitized_block = struct(Block, Map.delete(unsanitized_block, :__struct__)) sanitized_transactions = Enum.map(sanitized_block.transactions, &Transaction.sanitize/1) Map.put(sanitized_block, :transactions, sanitized_transactions) end defp time_unix do DateTime.utc_now() |> DateTime.to_unix() end end