2024-01-24 22:04:35 +00:00
|
|
|
from typing import TypeAlias, List, Optional
|
|
|
|
from hashlib import sha256
|
2024-01-24 11:52:30 +00:00
|
|
|
|
|
|
|
# Please note this is still a work in progress
|
|
|
|
from dataclasses import dataclass
|
|
|
|
|
|
|
|
Id: TypeAlias = bytes
|
|
|
|
|
2024-01-24 22:04:35 +00:00
|
|
|
|
2024-01-24 11:52:30 +00:00
|
|
|
@dataclass
|
|
|
|
class Epoch:
|
|
|
|
# identifier of the epoch, counting incrementally from 0
|
|
|
|
epoch: int
|
|
|
|
|
2024-01-24 22:04:35 +00:00
|
|
|
|
|
|
|
@dataclass
|
|
|
|
class TimeConfig:
|
|
|
|
# How many slots in a epoch, all epochs will have the same number of slots
|
|
|
|
slots_per_epoch: int
|
|
|
|
# How long a slot lasts in seconds
|
|
|
|
slot_duration: int
|
|
|
|
# Start of the first epoch, in unix timestamp second precision
|
|
|
|
chain_start_time: int
|
|
|
|
|
|
|
|
|
2024-01-24 11:52:30 +00:00
|
|
|
# An absolute unique indentifier of a slot, counting incrementally from 0
|
|
|
|
@dataclass
|
|
|
|
class Slot:
|
|
|
|
absolute_slot: int
|
|
|
|
|
2024-01-24 22:04:35 +00:00
|
|
|
def from_unix_timestamp_s(config: TimeConfig, timestamp_s: int) -> "Slot":
|
2024-01-24 11:52:30 +00:00
|
|
|
absolute_slot = timestamp_s // config.slot_duration
|
|
|
|
return Slot(absolute_slot)
|
|
|
|
|
|
|
|
def epoch(self, config: TimeConfig) -> Epoch:
|
|
|
|
return self.absolute_slot // config.slots_per_epoch
|
|
|
|
|
|
|
|
|
|
|
|
@dataclass
|
|
|
|
class Config:
|
|
|
|
k: int
|
|
|
|
time: TimeConfig
|
|
|
|
|
2024-01-24 22:04:35 +00:00
|
|
|
|
2024-01-24 11:52:30 +00:00
|
|
|
@dataclass
|
|
|
|
class BlockHeader:
|
|
|
|
slot: Slot
|
|
|
|
parent: Id
|
|
|
|
|
|
|
|
def parent(self) -> Id:
|
|
|
|
return self.parent
|
|
|
|
|
|
|
|
def id(self) -> Id:
|
2024-01-24 22:04:35 +00:00
|
|
|
# TODO: spec out the block id
|
|
|
|
raise NotImplemented()
|
2024-01-24 11:52:30 +00:00
|
|
|
|
|
|
|
|
2024-01-24 22:04:35 +00:00
|
|
|
@dataclass
|
2024-01-24 11:52:30 +00:00
|
|
|
class Chain:
|
|
|
|
blocks: List[BlockHeader]
|
|
|
|
|
|
|
|
def tip(self) -> BlockHeader:
|
|
|
|
return self.blocks[-1]
|
|
|
|
|
|
|
|
def length(self) -> int:
|
|
|
|
return len(self.blocks)
|
|
|
|
|
|
|
|
def contains_block(self, block: BlockHeader) -> bool:
|
|
|
|
return block in self.blocks
|
2024-01-24 22:04:35 +00:00
|
|
|
|
2024-01-24 11:52:30 +00:00
|
|
|
def block_position(self, block: BlockHeader) -> int:
|
|
|
|
assert self.contains_block(block)
|
2024-01-24 22:04:35 +00:00
|
|
|
for i, b in enumerate(self.blocks):
|
2024-01-24 11:52:30 +00:00
|
|
|
if b == block:
|
|
|
|
return i
|
|
|
|
|
2024-01-24 22:04:35 +00:00
|
|
|
|
2024-01-24 11:52:30 +00:00
|
|
|
class Follower:
|
|
|
|
def __init__(self, genesis: BlockHeader, config: Config):
|
|
|
|
self.config = config
|
|
|
|
self.forks = []
|
|
|
|
self.local_chain = Chain([genesis])
|
|
|
|
|
|
|
|
# We don't do any validation in the current version
|
|
|
|
def validate_header(block: BlockHeader) -> bool:
|
2024-01-24 22:04:35 +00:00
|
|
|
return True
|
2024-01-24 11:52:30 +00:00
|
|
|
|
|
|
|
# Try appending this block to an existing chain and return whether
|
|
|
|
# the operation was successful
|
|
|
|
def try_extend_chains(self, block: BlockHeader) -> bool:
|
|
|
|
if self.local_chain.tip().id() == block.parent():
|
|
|
|
self.local_chain.blocks.append(block)
|
|
|
|
return True
|
2024-01-24 22:04:35 +00:00
|
|
|
|
2024-01-24 11:52:30 +00:00
|
|
|
for chain in self.forks:
|
|
|
|
if chain.tip().id() == block.parent():
|
|
|
|
chain.blocks.append(block)
|
|
|
|
return True
|
|
|
|
|
|
|
|
return False
|
|
|
|
|
2024-01-24 22:04:35 +00:00
|
|
|
def try_create_fork(self, block: BlockHeader) -> Optional[Chain]:
|
2024-01-24 11:52:30 +00:00
|
|
|
chains = self.forks + [self.local_chain]
|
|
|
|
for chain in chains:
|
|
|
|
if self.chain.contains_block(block):
|
|
|
|
block_position = chain.block_position(block)
|
2024-01-24 22:04:35 +00:00
|
|
|
return Chain(blocks=chain.blocks[:block_position] + [block])
|
|
|
|
|
2024-01-24 11:52:30 +00:00
|
|
|
return None
|
|
|
|
|
|
|
|
def on_block(self, block: BlockHeader):
|
|
|
|
if not self.validate_header(block):
|
|
|
|
return
|
|
|
|
|
|
|
|
# check if the new block extends an existing chain
|
|
|
|
if self.try_extend_chains(block):
|
|
|
|
return
|
|
|
|
|
|
|
|
# if we get here, we might need to create a fork
|
|
|
|
new_chain = self.try_create_fork(block)
|
|
|
|
if new_chain is not None:
|
|
|
|
self.forks.append(new_chain)
|
|
|
|
# otherwise, we're missing the parent block
|
|
|
|
# in that case, just ignore the block
|
|
|
|
|
|
|
|
# Evaluate the fork choice rule and return the block header of the block that should be the head of the chain
|
|
|
|
def fork_choice(local_chain: Chain, forks: List[Chain]) -> BlockHeader:
|
|
|
|
pass
|
|
|
|
|
|
|
|
def tip(self) -> BlockHeader:
|
|
|
|
return self.fork_choice()
|
|
|
|
|
|
|
|
|
|
|
|
@dataclass
|
|
|
|
class Coin:
|
2024-01-24 22:04:35 +00:00
|
|
|
pk: int
|
2024-01-24 11:52:30 +00:00
|
|
|
value: int
|
|
|
|
|
2024-01-24 22:04:35 +00:00
|
|
|
|
|
|
|
@dataclass
|
|
|
|
class LedgerState:
|
|
|
|
"""
|
|
|
|
A snapshot of the ledger state up to some height
|
|
|
|
"""
|
|
|
|
|
|
|
|
height: int = None
|
|
|
|
nonce: bytes = None
|
|
|
|
total_stake: int = None
|
|
|
|
|
|
|
|
|
|
|
|
@dataclass
|
|
|
|
class EpochState:
|
|
|
|
# for details of snapshot schedule please see:
|
|
|
|
# https://github.com/IntersectMBO/ouroboros-consensus/blob/fe245ac1d8dbfb563ede2fdb6585055e12ce9738/docs/website/contents/for-developers/Glossary.md#epoch-structure
|
|
|
|
|
|
|
|
# The stake distribution snapshot is taken at the beginning of the previous epoch
|
|
|
|
stake_distribution_snapshot: LedgerState
|
|
|
|
|
|
|
|
# The nonce snapshot is taken 7k/f slots into the previous epoch
|
|
|
|
nonce_snapshot: LedgerState
|
|
|
|
|
|
|
|
def stake_distribution(self) -> int:
|
|
|
|
"""Returns the total stake that will be used to reletivize leadership proofs during this epoch"""
|
|
|
|
return self.stake_distribution_snapshot.total_stake
|
|
|
|
|
|
|
|
def nonce(self) -> bytes:
|
|
|
|
return self.nonce_snapshot.nonce
|
|
|
|
|
|
|
|
|
|
|
|
@dataclass
|
|
|
|
class LeaderConfig:
|
|
|
|
active_slot_coeff: float = 0.05 # 'f', the rate of occupied slots
|
|
|
|
|
|
|
|
|
|
|
|
def phi(f: float, alpha: float) -> float:
|
|
|
|
"""
|
|
|
|
params:
|
|
|
|
f: 'active slot coefficient' - the rate of occupied slots
|
|
|
|
alpha: relative stake held by the validator
|
|
|
|
|
|
|
|
returns: the probability that this validator should win the slot lottery
|
|
|
|
"""
|
|
|
|
return 1 - (1 - f) ** alpha
|
|
|
|
|
|
|
|
|
|
|
|
class MOCK_LEADER_VRF:
|
|
|
|
"""NOT SECURE: A mock VRF function where the sk and pk are assummed to be the same"""
|
|
|
|
|
|
|
|
ORDER = 2**256
|
|
|
|
|
|
|
|
@classmethod
|
|
|
|
def vrf(cls, sk: int, nonce: bytes, slot: int) -> int:
|
|
|
|
h = sha256()
|
|
|
|
h.update(int.to_bytes(sk, length=32))
|
|
|
|
h.update(nonce)
|
|
|
|
h.update(int.to_bytes(slot, length=16)) # 64bit slots
|
|
|
|
return int.from_bytes(h.digest())
|
|
|
|
|
|
|
|
@classmethod
|
|
|
|
def verify(cls, r, pk, nonce, slot):
|
|
|
|
raise NotImplemented()
|
|
|
|
|
|
|
|
|
|
|
|
@dataclass
|
2024-01-24 11:52:30 +00:00
|
|
|
class Leader:
|
2024-01-24 22:04:35 +00:00
|
|
|
config: LeaderConfig
|
|
|
|
coin: Coin
|
|
|
|
|
|
|
|
def is_slot_leader(self, epoch: EpochState, slot: Slot) -> bool:
|
|
|
|
f = self.config.active_slot_coeff
|
|
|
|
total_stake = epoch.stake_distribution()
|
|
|
|
relative_stake = self.coin.value / total_stake
|
|
|
|
|
|
|
|
r = MOCK_LEADER_VRF.vrf(self.coin.pk, epoch.nonce(), slot)
|
|
|
|
|
|
|
|
return r < MOCK_LEADER_VRF.ORDER * phi(f, relative_stake)
|
2024-01-24 11:52:30 +00:00
|
|
|
|
|
|
|
def propose_block(self, slot: Slot, parent: BlockHeader) -> BlockHeader:
|
|
|
|
assert self.is_leader_at(slot)
|
|
|
|
return BlockHeader(parent=parent.id(), slot=slot, _id=Id(b"TODO"))
|
|
|
|
|
|
|
|
|
|
|
|
if __name__ == "__main__":
|
2024-01-24 22:04:35 +00:00
|
|
|
pass
|