mirror of
https://github.com/logos-blockchain/research.git
synced 2026-08-06 19:23:26 +00:00
Implement the countable uncle model from the Cryptarchia spec's counting-only reference rules, and make it the simulator default. Counting rules (uncles.py, measure.py): - Only the first block of a fork (parent on the producer's chain) is referenceable and countable, which makes every reference verifiable from chain data alone. - The reference window is derived from a window-absorption parameter, w_u = W_abs/f slots (W_abs in expected block-intervals, default 10, bounded W_abs <= 0.6*k), replacing the free-standing uncle_window. - Selection skips slots already occupied on the producer's chain and takes at most one uncle per slot. - The measurement pass re-checks every rule per reference and tallies rejections as deep_ref_share. The pre-redesign model is preserved behind --old on tsi-sweep and tsi-verify. Its RNG key is byte-identical to the pre-uncle_model key, so --old bit-reproduces the historical runs. Supporting changes: uncle_model and window_absorption config surface with validation (config.py, constants.py); accuracy closed form over the effective q_u (theory.py); plumbing through tsi.py, epoch.py, sweep.py, blocktree.py, metrics.py, verify.py, figures_pernode.py. Studies and figures: - configs/countable-vs-old.yaml -- delay x U grid, run under both models on the same grid. - configs/absorption-window.yaml -- accuracy vs W_abs at U=1. - scripts/plot_countable_vs_old.py renders fig30-fig33 into reports/tsi/report-figures/. Tests: tests/test_countable_counting.py (7 cases) covering first-fork eligibility, derived-window bounds, occupied-slot exclusion, and per-reference re-checking; extensions to test_uncles.py, test_config.py, test_slot_counting.py. Full fast suite: 202 passed. Also adds CLAUDE.md (graphify project instructions) and ignores editor/local-agent state plus the vendored Equi-X benchmark clone. The reports/tsi/ prose describing this model is held back for a separate editorial pass. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
442 lines
26 KiB
Python
442 lines
26 KiB
Python
"""Configuration dataclasses for single runs and parameter sweeps."""
|
||
|
||
from __future__ import annotations
|
||
|
||
import itertools
|
||
from dataclasses import dataclass, field, replace
|
||
from typing import Any, Literal
|
||
|
||
from . import constants
|
||
|
||
StakeDist = Literal["uniform", "pareto"]
|
||
UncleStrategy = Literal["oldest", "random"]
|
||
# Uncle counting/selection model:
|
||
# "countable" (default) — the spec's counting-only model (cryptarchia-v1-protocol.md):
|
||
# only the FIRST block of a fork is referenceable/countable (its parent lies on the
|
||
# referencing chain), the window is derived as w_u = window_absorption / f slots,
|
||
# selection excludes slots already occupied on the producer's chain and picks at most
|
||
# one uncle per slot, and counting re-checks every rule per reference.
|
||
# "old" — the pre-redesign model (run with --old): window = uncle_window slots directly,
|
||
# any orphan in view is referenceable regardless of fork depth, no occupied-slot or
|
||
# per-slot exclusion, and every baked reference counts.
|
||
UncleModel = Literal["countable", "old"]
|
||
Topology = Literal["full_mesh", "regular", "blend"]
|
||
LinkLatencyDist = Literal["fixed", "uniform", "exp", "geo"]
|
||
JitterDist = Literal["exp", "poisson"]
|
||
ChurnMode = Literal["sine", "ramp", "step"]
|
||
InitDest = Literal["common", "heterogeneous"]
|
||
# How the adversary_frac coalition attacks the TSI density count:
|
||
# "suppress" — produces normally but references NO uncles (starves the recovered density; weak);
|
||
# "withhold" — never gossips its blocks (they are orphaned, its won slots become gaps in the
|
||
# canonical chain), so the counted density drops ~adversary_frac and TSI deflates D_est toward
|
||
# the reduced ACTIVE stake. Stronger, but the withheld blocks earn nothing (griefing/grinding).
|
||
AdversaryStrategy = Literal["suppress", "withhold"]
|
||
|
||
|
||
@dataclass(frozen=True)
|
||
class SimConfig:
|
||
"""A single fully-specified simulation run (one grid cell, one replicate)."""
|
||
|
||
# --- network / stake ---
|
||
n_nodes: int = 1000
|
||
stake_dist: StakeDist = "uniform"
|
||
pareto_shape: float = 1.16 # Pareto (Lomax) tail index; ~80/20 by default
|
||
uniform_random: bool = False # if True, draw i.i.d. uniform stakes; else equal
|
||
total_stake: float = 1.0e9 # FIXED across distributions for comparability
|
||
|
||
# --- network latency (slots) ---
|
||
latency: int = 0 # L: full-mesh uniform link latency (block seen at t+L)
|
||
latency_stochastic: bool = False # if True, L is the mean of a stochastic model
|
||
|
||
# --- network topology (per-node model) ---
|
||
# "full_mesh": every node one hop away, uniform latency = `latency` (reproduces the
|
||
# reduced model). "regular": random d-regular peering graph with per-link latency;
|
||
# a block reaches a node after the shortest WEIGHTED path from its producer.
|
||
# "blend": same d-regular graph, but a block is first relayed through `blend_hops` random
|
||
# nodes (a mix cascade, each adding a Uniform(0, blend_delay_max) mixing delay) before a
|
||
# final network-wide gossip makes it visible — models routing over the Blend mixnet.
|
||
topology: Topology = "full_mesh"
|
||
degree: int = 8 # peering degree (regular / blend graph)
|
||
# One entropy contributor to the per-trajectory RNG (via key()), NOT an independent topology
|
||
# knob: the graph is seeded from the config's full-key spawn hierarchy (engine.run_trajectory),
|
||
# so it is fixed per trajectory but is re-rolled by ANY key() field (stake_dist, f,
|
||
# adversary_frac, replicate, ...). Consequently two configs that differ only in a non-topology
|
||
# field draw different graphs; adversary-vs-honest comparisons are therefore unpaired in the
|
||
# graph sample (a variance source averaged out over replicates, not a bias — the main deflation
|
||
# effects are topology-independent, §6.4). Making it a paired/independent knob would require
|
||
# seeding the graph from topology-only entropy and re-running every sweep.
|
||
graph_seed: int = 0
|
||
# Blend mixnet cascade (topology == "blend"): the producer picks `blend_hops` distinct
|
||
# relay nodes uniformly at random; the block hops producer -> r1 -> ... -> r_hops over the
|
||
# graph, each relay waiting Uniform(0, blend_delay_max) slots before forwarding; the last
|
||
# relay's forward is the final network-wide gossip. Ignored by full_mesh / regular.
|
||
blend_hops: int = 3 # number of random relay hops in the mix cascade
|
||
adversary_strategy: AdversaryStrategy = "suppress" # how adversary_frac attacks (see above)
|
||
blend_delay_max: float = 3.0 # max per-relay mixing delay (slots); delay ~ U(0, this)
|
||
# Mean one-way per-link latency in SLOTS (1 slot = 1 s). Realistic direct-gossip links are
|
||
# sub-slot (~0.04-0.15 slot = 40-150 ms); whole-slot values (1, 2, ...) model routing over
|
||
# the Blend mixnet, where each hop costs seconds. Arrivals are kept sub-slot (float).
|
||
link_latency_mean: float = 1.0
|
||
# Per-link latency distribution (all have mean = link_latency_mean): "fixed" (all equal),
|
||
# "uniform" (0..2*mean), "exp" (long tail), "geo" (real-world geographic band mixture:
|
||
# short intra-region links, long inter-continental ones — see constants.GEO_LATENCY_*).
|
||
link_latency_dist: LinkLatencyDist = "fixed"
|
||
jitter_mean: float = 0.0 # extra per-(block,node) jitter (slots); 0 = none.
|
||
# Jitter model (active when jitter_mean > 0):
|
||
# "exp" — EVERY delivery gets +Exp(jitter_mean); the §6.1 robustness model.
|
||
# "poisson" — a random fraction `jitter_frac` of deliveries gets +Poisson(jitter_mean)
|
||
# whole slots; the rest arrive on time. A LONG-TAIL model: most deliveries are
|
||
# unaffected, a few straggle by multiple slots (case (b) of the N-scaling study).
|
||
jitter_dist: JitterDist = "exp"
|
||
jitter_frac: float = 1.0 # fraction of deliveries hit (poisson model; exp uses all)
|
||
|
||
# --- uncle references ---
|
||
uncle_model: UncleModel = "countable" # countable (spec, default) | old (--old)
|
||
# Countable model: window absorption parameter W; the uncle reference window is DERIVED
|
||
# as w_u = W / f slots (W expected block-intervals), bounded 1 <= W <= 0.6*k
|
||
# (constants.W_ABS_MAX_FACTOR). Ignored by the old model.
|
||
window_absorption: float = constants.W_ABS_DEFAULT
|
||
# Old model only (--old): the uncle reference window w_u in slots, set directly.
|
||
# Ignored by the countable model, which derives the window from window_absorption.
|
||
uncle_window: int = constants.W_DEFAULT
|
||
max_uncles: int = 0 # U (0 = baseline, no uncles)
|
||
uncle_strategy: UncleStrategy = "oldest"
|
||
# Coin-flip inclusion prob for the "random" strategy. Only 0.5 reproduces the spec's
|
||
# unbiased coin (cryptarchia-v1-protocol.md); other values are a deliberate, non-spec
|
||
# sensitivity knob, not protocol behaviour.
|
||
uncle_random_p: float = 0.5
|
||
# --- adversary (grinding via D_est deflation) ---
|
||
# Fraction of TOTAL STAKE controlled by an adversary that suppresses uncle references in its
|
||
# own blocks (references no uncles), starving the TSI density count so honest nodes under-count
|
||
# blocks and infer a LOW D_est -> everyone's win probability phi(f, w/D_est) rises, which is the
|
||
# grinding payoff. 0.0 = fully honest (the studied baseline). The coalition is a RANDOM node set
|
||
# whose stake sums to adversary_frac (see engine._adversary_mask); block production is
|
||
# stake-proportional, so the deflation depends only on that summed share, not on whether the
|
||
# coalition is one whale or many small nodes. Withholding is a separate, stronger lever.
|
||
adversary_frac: float = 0.0
|
||
# Dynamic (withhold-then-rejoin) schedule for the withholding lever (§6.5). The coalition is
|
||
# FIXED (identity from adversary_frac); this only gates whether it withholds in a given epoch.
|
||
# adversary_period == 0 -> STATIC: the coalition attacks (withholds) every epoch (the §6.4
|
||
# model; backward-compatible default).
|
||
# adversary_period > 0 -> PERIODIC: withhold for the first `adversary_withhold_epochs` of
|
||
# every `adversary_period`-epoch cycle, then behave honestly (produce + gossip) for the
|
||
# rest — an abstain-then-rejoin grinder. A single downward pulse (does D_est recover, or
|
||
# tip into the §6.2 collapsed branch?) is period == epochs, withhold_epochs == pulse length.
|
||
# Only affects adversary_strategy == "withhold"; suppression stays static.
|
||
adversary_period: int = 0
|
||
adversary_withhold_epochs: int = 0
|
||
|
||
# --- consensus / TSI ---
|
||
f: float = constants.F # slot activation coefficient (configurable; sweepable)
|
||
beta: float = constants.BETA_DEFAULT
|
||
k: int = 64 # scaled by default; full scale = 2160
|
||
genesis_d_factor: float = 0.5 # genesis D = factor * true total stake
|
||
epochs: int = 40
|
||
# If True, quantise the target rate the way an on-chain integer estimator does:
|
||
# f_p = int(f*tsi.PRECISION)/tsi.PRECISION. With tsi.PRECISION = 1_000_000 (the report's
|
||
# recommended 10^-6 f-precision, §8) this gives f_p = 0.033333 and a negligible residual
|
||
# f/f_p < 1e-5 — not the ~1% overestimate the old 10^-3 truncation produced.
|
||
# Default False keeps the analysis-faithful exact-f behaviour.
|
||
fixed_point: bool = False
|
||
# If True, count uncle references per BLOCK ID (the pre-fix behaviour, which double-counts
|
||
# same-slot co-winners and inflates the equilibrium by c(f)). The correct default counts
|
||
# per SLOT (one count per slot, matching the pre-uncle design invariant). Kept as a flag
|
||
# for reproducing historical runs only; no study uses it.
|
||
legacy_block_count: bool = False
|
||
# Early stop: when the per-epoch estimate has converged (trailing epochs statistically
|
||
# flat), run ES_MEASURE more epochs as the equilibrium sample and stop. Truncation-only:
|
||
# per-epoch RNG streams are pre-spawned, so the epochs that DO run are bit-identical to a
|
||
# full run's prefix (hence excluded from key()). Auto-disabled for periodic-adversary
|
||
# schedules (sawtooths must run their full budget).
|
||
early_stop: bool = False
|
||
# Organic (non-adversarial) participation churn: each epoch a `churn_amp` fraction of honest
|
||
# stake goes inactive following a schedule, so the ACTIVE stake oscillates/ramps and TSI must
|
||
# track it. churn_amp = peak inactive fraction; churn_period = epochs per cycle; churn_mode:
|
||
# "sine" — active fraction = 1 - churn_amp*(1-cos(2π·epoch/period))/2 (smooth weekly cycle)
|
||
# "ramp" — active fraction declines linearly to 1-churn_amp over churn_period, then holds
|
||
# "step" — one-time drop to (1-churn_amp) at churn_period (mass leave)
|
||
churn_amp: float = 0.0
|
||
churn_period: int = 4
|
||
churn_mode: ChurnMode = "sine"
|
||
# INERT: nothing reads this. The §6.1 clock-skew study is run stand-alone by
|
||
# scripts/clock_skew.py, which applies its own per-node offsets — not through this field.
|
||
# Retained only as a key() seed contributor for run-hash compatibility (like `per_node_dest`);
|
||
# leave at 0.
|
||
clock_skew_max: int = 0
|
||
# Each node updates its OWN D_est from its OWN view — the point of this simulator, and the ONLY
|
||
# mode implemented here (always True). The global-consensus-D_est baseline (per_node_dest=False)
|
||
# is not built in this package; it lives in the sibling reduced model (tsi-sim). Retained as a
|
||
# key() seed contributor for compatibility; do not set False (no code path reads it).
|
||
per_node_dest: bool = True
|
||
# "common": all nodes start at genesis_d_factor*D_true (studies convergence FROM
|
||
# agreement). "heterogeneous": per-node initial D_est drawn with relative spread
|
||
# `init_spread` around genesis (studies transient re-convergence from disagreement).
|
||
init_dest: InitDest = "common"
|
||
init_spread: float = 0.0 # relative spread of heterogeneous initial D_est
|
||
|
||
# --- performance ---
|
||
# INERT: nothing reads this — `simulate_epoch` never calls `lottery.sample_wins_chunked`,
|
||
# so it has no modelled effect. Retained as a key() seed contributor for run-hash
|
||
# compatibility (like `per_node_dest` above); leave at 1.
|
||
lottery_chunks: int = 1
|
||
# Windowed fork choice bounds the per-slot candidate scan to a horizon of the max path
|
||
# latency (plus the fully-propagated best tip), turning O(n_blocks^2) into O(n_blocks*H).
|
||
# EXACT when link latency is deterministic (jitter_mean == 0). With jitter_mean > 0 it is
|
||
# a (usually tiny) approximation and emits a warning — see blocktree.build_tree_pernode.
|
||
# Set False for a guaranteed-exact full scan.
|
||
windowed_fork_choice: bool = True
|
||
# Sliding-window pruning of the (N x n_blocks) arrival matrix: keep per-node arrival columns
|
||
# only for blocks still inside the keep-span max(horizon, uncle_window); blocks past that are
|
||
# finalized (arrived at every node under the deterministic horizon), so their columns are
|
||
# dropped. Turns O(N * n_blocks) memory into O(N * keep-span-blocks) — the fix for the
|
||
# collapsed-D_est block explosion. EXACT vs the full matrix when jitter_mean == 0 (needs the
|
||
# horizon, so it only applies when windowed_fork_choice is on); set False to store the whole
|
||
# matrix (the parity oracle, and required for a guaranteed-exact jitter>0 run).
|
||
prune_arrival: bool = True
|
||
|
||
# --- bookkeeping ---
|
||
replicate: int = 0
|
||
root_seed: int = 12345
|
||
|
||
def __post_init__(self) -> None:
|
||
# frozen dataclass: validation only (no attribute assignment)
|
||
if self.stake_dist not in ("uniform", "pareto"):
|
||
raise ValueError(f"stake_dist must be uniform|pareto, got {self.stake_dist!r}")
|
||
if self.uncle_strategy not in ("oldest", "random"):
|
||
raise ValueError(f"uncle_strategy must be oldest|random, got {self.uncle_strategy!r}")
|
||
if self.uncle_model not in ("countable", "old"):
|
||
raise ValueError(f"uncle_model must be countable|old, got {self.uncle_model!r}")
|
||
if self.uncle_model == "countable":
|
||
if self.window_absorption < 1.0:
|
||
raise ValueError(
|
||
f"window_absorption W={self.window_absorption} must be >= 1")
|
||
if self.window_absorption > constants.W_ABS_MAX_FACTOR * self.k:
|
||
# The spec bounds W <= 0.6*k (w_u <= 0.6*k/f, inside the finalization
|
||
# window). Scaled-down research geometries (small k) may violate it on
|
||
# purpose — warn loudly rather than refuse, but full-scale runs should
|
||
# never see this.
|
||
import warnings
|
||
|
||
warnings.warn(
|
||
f"window_absorption W={self.window_absorption} exceeds the spec bound "
|
||
f"{constants.W_ABS_MAX_FACTOR}*k = "
|
||
f"{constants.W_ABS_MAX_FACTOR * self.k:g} (k={self.k}); the derived "
|
||
f"window is outside the finalization window at this geometry",
|
||
RuntimeWarning, stacklevel=2)
|
||
if self.topology not in ("full_mesh", "regular", "blend"):
|
||
raise ValueError(f"topology must be full_mesh|regular|blend, got {self.topology!r}")
|
||
if self.link_latency_dist not in ("fixed", "uniform", "exp", "geo"):
|
||
raise ValueError(f"link_latency_dist must be fixed|uniform|exp|geo, got "
|
||
f"{self.link_latency_dist!r}")
|
||
if self.jitter_dist not in ("exp", "poisson"):
|
||
raise ValueError(f"jitter_dist must be exp|poisson, got {self.jitter_dist!r}")
|
||
if not 0.0 <= self.jitter_frac <= 1.0:
|
||
raise ValueError(f"jitter_frac must be in [0, 1], got {self.jitter_frac}")
|
||
if self.init_dest not in ("common", "heterogeneous"):
|
||
raise ValueError(f"init_dest must be common|heterogeneous, got {self.init_dest!r}")
|
||
if self.churn_mode not in ("sine", "ramp", "step"):
|
||
raise ValueError(f"churn_mode must be sine|ramp|step, got {self.churn_mode!r}")
|
||
if not 0.0 <= self.churn_amp < 1.0:
|
||
raise ValueError(f"churn_amp must be in [0, 1), got {self.churn_amp}")
|
||
if self.churn_period < 1:
|
||
raise ValueError(f"churn_period must be >= 1, got {self.churn_period}")
|
||
if self.clock_skew_max < 0:
|
||
raise ValueError(f"clock_skew_max must be >= 0, got {self.clock_skew_max}")
|
||
if self.adversary_strategy not in ("suppress", "withhold"):
|
||
raise ValueError(f"adversary_strategy must be suppress|withhold, got "
|
||
f"{self.adversary_strategy!r}")
|
||
checks = {
|
||
"n_nodes": self.n_nodes >= 1,
|
||
"k": self.k >= 1,
|
||
"epochs": self.epochs >= 1,
|
||
"latency": self.latency >= 0,
|
||
"max_uncles": self.max_uncles >= 0,
|
||
"uncle_window": self.uncle_window >= 1,
|
||
"lottery_chunks": self.lottery_chunks >= 1,
|
||
"uncle_random_p": 0.0 <= self.uncle_random_p <= 1.0,
|
||
"f": 0.0 < self.f < 1.0,
|
||
"beta": self.beta > 0.0,
|
||
"genesis_d_factor": self.genesis_d_factor > 0.0,
|
||
"pareto_shape": self.pareto_shape > 0.0,
|
||
"total_stake": self.total_stake > 0.0,
|
||
"degree": self.degree >= 1,
|
||
"link_latency_mean": self.link_latency_mean >= 0.0,
|
||
"jitter_mean": self.jitter_mean >= 0.0,
|
||
"init_spread": self.init_spread >= 0.0,
|
||
"blend_hops": self.blend_hops >= 1,
|
||
"blend_delay_max": self.blend_delay_max >= 0.0,
|
||
"adversary_frac": 0.0 <= self.adversary_frac < 1.0,
|
||
"adversary_period": self.adversary_period >= 0,
|
||
"adversary_withhold_epochs": self.adversary_withhold_epochs >= 0,
|
||
}
|
||
bad = [name for name, ok in checks.items() if not ok]
|
||
if bad:
|
||
raise ValueError(f"invalid SimConfig field(s): {bad}")
|
||
if self.adversary_period > 0 and self.adversary_withhold_epochs > self.adversary_period:
|
||
raise ValueError(
|
||
f"adversary_withhold_epochs ({self.adversary_withhold_epochs}) must be "
|
||
f"<= adversary_period ({self.adversary_period})")
|
||
if self.topology in ("regular", "blend"):
|
||
# a d-regular graph on n nodes needs degree < n and n*degree even
|
||
if self.degree >= self.n_nodes:
|
||
raise ValueError(f"degree ({self.degree}) must be < n_nodes ({self.n_nodes})")
|
||
if (self.n_nodes * self.degree) % 2 != 0:
|
||
raise ValueError("regular graph requires n_nodes*degree to be even")
|
||
if self.topology == "blend":
|
||
# need `blend_hops` DISTINCT relay nodes drawn from the non-producer pool
|
||
if self.blend_hops > self.n_nodes - 1:
|
||
raise ValueError(
|
||
f"blend_hops ({self.blend_hops}) must be <= n_nodes-1 ({self.n_nodes - 1})")
|
||
|
||
def adversary_withholds(self, epoch: int) -> bool:
|
||
"""Whether the (fixed) coalition withholds this epoch under its schedule.
|
||
|
||
Static (``adversary_period == 0``) attacks every epoch; periodic attacks the first
|
||
``adversary_withhold_epochs`` epochs of each ``adversary_period``-epoch cycle. Meaningful
|
||
only for ``adversary_strategy == "withhold"`` with ``adversary_frac > 0``.
|
||
"""
|
||
if self.adversary_period <= 0:
|
||
return True
|
||
return (epoch % self.adversary_period) < self.adversary_withhold_epochs
|
||
|
||
# derived geometry -------------------------------------------------------
|
||
@property
|
||
def effective_uncle_window(self) -> int:
|
||
"""The uncle reference window ``w_u`` in slots actually used by this run.
|
||
|
||
Countable model (default): derived, ``w_u = round(window_absorption / f)``.
|
||
Old model (``--old``): ``uncle_window`` taken directly.
|
||
"""
|
||
if self.uncle_model == "old":
|
||
return self.uncle_window
|
||
return constants.uncle_window_slots(self.window_absorption, self.f)
|
||
|
||
@property
|
||
def epoch_len(self) -> int:
|
||
return constants.epoch_len(self.k, self.f)
|
||
|
||
@property
|
||
def period_T(self) -> int:
|
||
return constants.period_T(self.k, self.f)
|
||
|
||
def key(self) -> tuple:
|
||
"""Hashable identity used to seed the RNG deterministically.
|
||
|
||
Must include EVERY field that affects the run (guarded by test_rng), otherwise two
|
||
distinct configs would share an RNG stream. ``uncle_model`` /
|
||
``window_absorption`` are appended ONLY for the countable model: an ``--old`` run's
|
||
key is then byte-identical to the pre-redesign key, so ``--old`` bit-reproduces
|
||
historical runs (the two models still get distinct streams from the marker).
|
||
"""
|
||
base = (
|
||
self.n_nodes, self.stake_dist, self.pareto_shape, self.uniform_random,
|
||
self.total_stake, self.latency, self.latency_stochastic, self.uncle_window,
|
||
self.max_uncles, self.uncle_strategy, self.uncle_random_p, self.f, self.beta,
|
||
self.k, self.genesis_d_factor, self.epochs, self.fixed_point,
|
||
self.legacy_block_count, self.churn_amp, self.churn_period, self.churn_mode,
|
||
self.clock_skew_max, self.per_node_dest,
|
||
self.lottery_chunks, self.topology, self.degree, self.graph_seed,
|
||
self.link_latency_mean, self.link_latency_dist, self.jitter_mean,
|
||
self.jitter_dist, self.jitter_frac,
|
||
self.blend_hops, self.blend_delay_max, self.adversary_frac, self.adversary_strategy,
|
||
self.adversary_period, self.adversary_withhold_epochs,
|
||
self.init_dest, self.init_spread, self.replicate,
|
||
)
|
||
# NOTE: windowed_fork_choice and prune_arrival are deliberately excluded — they are pure
|
||
# compute/memory optimisations that consume no RNG and (at jitter_mean == 0) change no
|
||
# result, so pruned and full-matrix runs must share a seed (see test_pernode parity).
|
||
if self.uncle_model == "old":
|
||
return base # historical (pre-uncle_model) key: --old bit-compat
|
||
return base + (self.uncle_model, self.window_absorption)
|
||
|
||
|
||
# Axes that can be swept; every SimConfig field is legal here.
|
||
_SWEEP_AXES = (
|
||
"n_nodes", "stake_dist", "latency", "max_uncles", "uncle_strategy", "uncle_window",
|
||
"window_absorption",
|
||
"topology", "degree", "link_latency_mean", "link_latency_dist",
|
||
"blend_hops", "blend_delay_max", "init_dest", "f",
|
||
)
|
||
|
||
|
||
@dataclass
|
||
class SweepConfig:
|
||
"""A cartesian grid of runs plus replicates, all sharing ``base`` settings."""
|
||
|
||
n_nodes: list[int] = field(default_factory=lambda: [1000])
|
||
stake_dist: list[StakeDist] = field(default_factory=lambda: ["uniform"])
|
||
latency: list[int] = field(default_factory=lambda: [0])
|
||
max_uncles: list[int] = field(default_factory=lambda: [0, 1, 2, 4])
|
||
uncle_strategy: list[UncleStrategy] = field(default_factory=lambda: ["oldest"])
|
||
uncle_window: list[int] = field(default_factory=lambda: [constants.W_DEFAULT])
|
||
window_absorption: list[float] = field(default_factory=lambda: [constants.W_ABS_DEFAULT])
|
||
topology: list[Topology] = field(default_factory=lambda: ["regular"])
|
||
degree: list[int] = field(default_factory=lambda: [8])
|
||
link_latency_mean: list[float] = field(default_factory=lambda: [1.0])
|
||
link_latency_dist: list[LinkLatencyDist] = field(default_factory=lambda: ["fixed"])
|
||
blend_hops: list[int] = field(default_factory=lambda: [3])
|
||
blend_delay_max: list[float] = field(default_factory=lambda: [3.0])
|
||
init_dest: list[InitDest] = field(default_factory=lambda: ["common"])
|
||
f: list[float] = field(default_factory=lambda: [constants.F])
|
||
replicates: int = 8
|
||
base: dict[str, Any] = field(default_factory=dict)
|
||
|
||
def expand(self) -> list[SimConfig]:
|
||
"""Materialise every ``SimConfig`` in the grid × replicates."""
|
||
base = SimConfig(**self.base)
|
||
cells: list[SimConfig] = []
|
||
axis_values = [getattr(self, ax) for ax in _SWEEP_AXES]
|
||
for combo in itertools.product(*axis_values):
|
||
overrides = dict(zip(_SWEEP_AXES, combo, strict=True))
|
||
# U=0 references no uncles, so it is independent of uncle_strategy AND the window
|
||
# knobs; keep only the first of each to avoid duplicate (identical) work.
|
||
if overrides["max_uncles"] == 0 and (
|
||
overrides["uncle_strategy"] != self.uncle_strategy[0]
|
||
or overrides["uncle_window"] != self.uncle_window[0]
|
||
or overrides["window_absorption"] != self.window_absorption[0]
|
||
):
|
||
continue
|
||
# each uncle model reads exactly one window knob — collapse the other axis so a
|
||
# sweep never emits duplicate cells that differ only in an ignored field.
|
||
if base.uncle_model == "countable" and (
|
||
overrides["uncle_window"] != self.uncle_window[0]
|
||
):
|
||
continue
|
||
if base.uncle_model == "old" and (
|
||
overrides["window_absorption"] != self.window_absorption[0]
|
||
):
|
||
continue
|
||
# full mesh ignores degree / link-latency model; keep only the first to avoid dupes.
|
||
if overrides["topology"] == "full_mesh" and (
|
||
overrides["degree"] != self.degree[0]
|
||
or overrides["link_latency_mean"] != self.link_latency_mean[0]
|
||
or overrides["link_latency_dist"] != self.link_latency_dist[0]
|
||
):
|
||
continue
|
||
# only blend uses the mix-cascade knobs; collapse them elsewhere to avoid dupes.
|
||
if overrides["topology"] != "blend" and (
|
||
overrides["blend_hops"] != self.blend_hops[0]
|
||
or overrides["blend_delay_max"] != self.blend_delay_max[0]
|
||
):
|
||
continue
|
||
# `latency` is the full_mesh uniform-L knob; regular/blend ignore it — collapse it
|
||
# for them so sweeping latency doesn't emit duplicate (seed-shifted) graph cells.
|
||
if overrides["topology"] != "full_mesh" and overrides["latency"] != self.latency[0]:
|
||
continue
|
||
for rep in range(self.replicates):
|
||
cells.append(replace(base, **overrides, replicate=rep))
|
||
return cells
|
||
|
||
@classmethod
|
||
def from_dict(cls, d: dict[str, Any]) -> SweepConfig:
|
||
d = dict(d)
|
||
base = d.pop("base", {})
|
||
known = {*_SWEEP_AXES, "replicates"}
|
||
unknown = set(d) - known
|
||
if unknown:
|
||
raise ValueError(
|
||
f"unknown sweep keys: {sorted(unknown)} (valid: {sorted(known)}; "
|
||
"per-run settings belong under 'base:')"
|
||
)
|
||
return cls(base=base, **d)
|