zakura-state 7.0.0

State contextual verification and storage code for the Zakura node. Internal crate, published to support cargo install zakura
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
use super::*;

fn commit_verified_change(
    writer: &HeaderChainWriter,
    live: &mut NonFinalizedState,
    staged: NonFinalizedState,
    accepted: Frontier,
) {
    let (evidence, event_path, request) = verified_request(writer, live, &staged, accepted)
        .expect("the generated full-state change has exact header evidence");
    PreparedFullStateTransition::new(
        evidence,
        writer
            .runtime
            .publisher()
            .snapshot()
            .frontiers
            .verified_best,
        event_path,
        staged,
        None,
        request,
    )
    .expect("the generated full-state and header paths agree")
    .commit(&writer.runtime, live, &writer.context())
    .expect("the generated full-state and header transition commits");
}

fn assert_selected_header_matches_full_state(
    writer: &HeaderChainWriter,
    full_state: &NonFinalizedState,
) {
    let best = full_state
        .best_chain()
        .expect("the generated fork graph has a full-state best chain");
    let (_, tip_hash) = best.non_finalized_tip();
    let expected_work = best
        .blocks
        .values()
        .map(|block| {
            block
                .block
                .header
                .difficulty_threshold
                .to_work()
                .expect("generated block targets have exact work")
                .as_u256()
        })
        .fold(zakura_chain::work::difficulty::U256::zero(), |sum, work| {
            sum.checked_add(work)
                .expect("the short generated graph cannot overflow cumulative work")
        });
    let snapshot = writer.runtime.publisher().snapshot();

    assert_eq!(snapshot.frontiers.header_best.hash, tip_hash);
    assert_eq!(snapshot.frontiers.verified_best.hash, tip_hash);
    assert_eq!(snapshot.header_best_score.tip_hash, tip_hash);
    assert_eq!(
        snapshot.header_best_score.suffix_work.as_u256(),
        expected_work
    );
}

#[test]
// DF-01: real headers at every observable activation boundary exercise the
// shared rules with production network parameters and historical encoding.
fn production_activation_headers_pass_shared_rules() {
    let _init_guard = zakura_test::init();

    for network in Network::iter() {
        let blocks = network.block_map();

        for upgrade in [
            NetworkUpgrade::Overwinter,
            NetworkUpgrade::Sapling,
            NetworkUpgrade::Blossom,
            NetworkUpgrade::Heartwood,
            NetworkUpgrade::Canopy,
            NetworkUpgrade::Nu5,
        ] {
            let height = upgrade
                .activation_height(&network)
                .expect("every production network configures this upgrade");
            let parent_height = height
                .previous()
                .expect("the tested upgrades activate after genesis");
            let vector_height = blocks
                .range(height.0..)
                .next()
                .map(|(height, _)| *height)
                .expect("an activation or post-activation vector exists");
            let candidate = blocks
                .get(&vector_height)
                .expect("the selected activation vector exists")
                .zcash_deserialize_into::<Arc<zakura_chain::block::Block>>()
                .expect("the activation vector deserializes");
            if vector_height == height.0 {
                let parent = blocks
                    .get(&parent_height.0)
                    .expect("the exact activation vector has its parent vector")
                    .zcash_deserialize_into::<Arc<zakura_chain::block::Block>>()
                    .expect("the parent activation vector deserializes");
                assert_eq!(candidate.header.previous_block_hash, parent.hash());
            }

            let spacing = NetworkUpgrade::target_spacing_for_height(&network, height);
            let context_times: Vec<_> = (1..=POW_ADJUSTMENT_BLOCK_SPAN)
                .map(|offset| {
                    let offset_i32 =
                        i32::try_from(offset).expect("the DAA context length fits in i32");
                    candidate.header.time - spacing * offset_i32
                })
                .collect();
            let candidate_bits =
                u32::from_le_bytes(candidate.header.difficulty_threshold.to_le_bytes());
            let context_threshold = (-16..=16)
                .filter_map(|delta| {
                    let bits = i64::from(candidate_bits).checked_add(i64::from(delta))?;
                    let bits = u32::try_from(bits).ok()?;
                    let threshold =
                        zakura_chain::work::difficulty::CompactDifficulty::from_le_bytes(
                            bits.to_le_bytes(),
                        );
                    let expected = AdjustedDifficulty::new_from_header_time(
                        candidate.header.time,
                        parent_height,
                        &network,
                        context_times.iter().copied().map(|time| (threshold, time)),
                    )
                    .expect("the fixture retains the complete difficulty context")
                    .expected_difficulty_threshold();
                    (expected == candidate.header.difficulty_threshold).then_some(threshold)
                })
                .next()
                .expect("a nearby compact context exactly reproduces the historical target");
            assert_eq!(
                AdjustedDifficulty::new_from_header_time(
                    candidate.header.time,
                    parent_height,
                    &network,
                    context_times
                        .iter()
                        .copied()
                        .map(|time| (context_threshold, time)),
                )
                .expect("the fixture retains the complete difficulty context")
                .expected_difficulty_threshold(),
                candidate.header.difficulty_threshold,
                "{network:?} {upgrade:?} activation target must match its complete DAA context",
            );
            assert!(
                candidate.header.difficulty_threshold.to_work().is_some(),
                "the historical target must encode exact work",
            );
        }
    }
}

#[test]
// DF-01: one coherent fork graph crosses NU5 through both validation paths;
// matching tips and work are the complete observable fork-choice result.
fn generated_nu5_graph_matches_full_state_before_finalization() {
    let _init_guard = zakura_test::init();
    fn network(checkpoint_blocks: Option<&[Arc<Block>]>) -> Network {
        let builder = ParametersBuilder::default()
            .with_activation_heights(ConfiguredActivationHeights {
                before_overwinter: Some(1),
                overwinter: Some(10),
                sapling: Some(15),
                blossom: Some(20),
                heartwood: Some(25),
                canopy: Some(30),
                nu5: Some(35),
                nu6: Some(100),
                nu6_1: Some(110),
                nu6_2: Some(120),
                nu6_3: Some(130),
                nu7: Some(140),
            })
            .expect("the compressed activation schedule is ordered")
            .with_disable_pow(true)
            .extend_funding_streams();
        let builder = if let Some(blocks) = checkpoint_blocks {
            let genesis_hash = blocks
                .first()
                .expect("the generated checkpoint chain contains genesis")
                .hash();
            builder
                .with_genesis_hash(genesis_hash)
                .expect("the generated genesis hash is canonical")
                .with_checkpoints(ConfiguredCheckpoints::HeightsAndHashes(
                    blocks
                        .iter()
                        .take(31)
                        .map(|block| {
                            (
                                block
                                    .coinbase_height()
                                    .expect("every generated checkpoint has a height"),
                                block.hash(),
                            )
                        })
                        .collect(),
                ))
                .expect("the generated checkpoints are ordered")
        } else {
            builder
        };
        builder
            .to_network()
            .expect("the compressed custom network is valid")
    }

    fn chain(network: &Network) -> Vec<Arc<Block>> {
        let sapling_root = zakura_chain::sapling::tree::NoteCommitmentTree::default().root();
        let orchard_root = zakura_chain::orchard::tree::NoteCommitmentTree::default().root();
        let ironwood_root = zakura_chain::ironwood::tree::NoteCommitmentTree::default().root();
        let mut history_tree = HistoryTree::default();
        let mut previous_hash = GENESIS_PREVIOUS_BLOCK_HASH;
        let mut blocks = Vec::new();

        for height in (0..=40).map(block::Height) {
            let upgrade = NetworkUpgrade::current(network, height);
            let input = transparent::Input::Coinbase {
                height,
                data: if height == block::Height(0) {
                    transparent::GENESIS_COINBASE_SCRIPT_SIG.to_vec()
                } else {
                    format!("DF-01 {height:?}").into_bytes()
                },
                sequence: 0,
            };
            let transaction = match upgrade {
                NetworkUpgrade::Genesis | NetworkUpgrade::BeforeOverwinter => Transaction::V1 {
                    inputs: vec![input],
                    outputs: Vec::new(),
                    lock_time: zakura_chain::transaction::LockTime::unlocked(),
                },
                NetworkUpgrade::Overwinter => Transaction::V3 {
                    inputs: vec![input],
                    outputs: Vec::new(),
                    lock_time: zakura_chain::transaction::LockTime::unlocked(),
                    expiry_height: height,
                    joinsplit_data: None,
                },
                NetworkUpgrade::Sapling
                | NetworkUpgrade::Blossom
                | NetworkUpgrade::Heartwood
                | NetworkUpgrade::Canopy => Transaction::V4 {
                    inputs: vec![input],
                    outputs: Vec::new(),
                    lock_time: zakura_chain::transaction::LockTime::unlocked(),
                    expiry_height: height,
                    joinsplit_data: None,
                    sapling_shielded_data: None,
                },
                NetworkUpgrade::Nu5 => Transaction::V5 {
                    network_upgrade: upgrade,
                    lock_time: zakura_chain::transaction::LockTime::unlocked(),
                    expiry_height: height,
                    inputs: vec![input],
                    outputs: Vec::new(),
                    sapling_shielded_data: None,
                    orchard_shielded_data: None,
                },
                _ => unreachable!("the deterministic graph stops during NU5"),
            };
            let transactions = vec![Arc::new(transaction)];
            let merkle_root = transactions.iter().cloned().collect();
            let time =
                chrono::DateTime::from_timestamp(1_700_000_000_i64 + i64::from(height.0) * 150, 0)
                    .expect("the deterministic timestamp is in range");
            let header = zakura_chain::block::Header {
                version: 4,
                previous_block_hash: previous_hash,
                merkle_root,
                commitment_bytes: HexDebug([0; 32]),
                time,
                difficulty_threshold: network.target_difficulty_limit().to_compact(),
                nonce: HexDebug([0; 32]),
                solution: equihash::Solution::for_proposal(),
            };
            let mut block = Arc::new(Block {
                header: Arc::new(header),
                transactions,
            });
            let commitment = match upgrade {
                NetworkUpgrade::Sapling | NetworkUpgrade::Blossom => <[u8; 32]>::from(sapling_root),
                NetworkUpgrade::Heartwood
                    if NetworkUpgrade::Heartwood.activation_height(network) == Some(height) =>
                {
                    [0; 32]
                }
                NetworkUpgrade::Heartwood | NetworkUpgrade::Canopy => history_tree
                    .hash()
                    .expect("the history tree exists after Heartwood activation")
                    .into(),
                NetworkUpgrade::Nu5 => {
                    let history_root = history_tree.hash().expect("the history tree exists at NU5");
                    ChainHistoryBlockTxAuthCommitmentHash::from_commitments(
                        &history_root,
                        &block.auth_data_root(),
                    )
                    .into()
                }
                _ => [0; 32],
            };
            Arc::make_mut(&mut Arc::make_mut(&mut block).header).commitment_bytes =
                commitment.into();
            previous_hash = block.hash();
            history_tree
                .push(
                    network,
                    block.clone(),
                    &sapling_root,
                    &orchard_root,
                    &ironwood_root,
                )
                .expect("the deterministic history tree advances");
            blocks.push(block);
        }
        blocks
    }

    let preliminary = network(None);
    let preliminary_chain = chain(&preliminary);
    let network = network(Some(&preliminary_chain));
    let chain = chain(&network);
    assert_eq!(network.genesis_hash(), chain[0].hash());
    assert_eq!(
        chain.iter().map(|block| block.hash()).collect::<Vec<_>>(),
        preliminary_chain
            .iter()
            .map(|block| block.hash())
            .collect::<Vec<_>>(),
        "installing generated checkpoints must not change the generated graph"
    );

    let mut finalized_state = FinalizedState::new(&Config::ephemeral(), &network)
        .expect("the differential finalized state opens");
    let mut live = NonFinalizedState::new(&network);
    for block in chain.iter().take(31) {
        finalized_state
            .commit_finalized_direct(
                CheckpointVerifiedBlock::from(block.clone()).into(),
                None,
                None,
                "DF-01 generated Canopy anchor",
            )
            .expect("the generated finalized prefix commits");
    }
    let canopy_anchor = Frontier::new(block::Height(30), chain[30].hash());
    let writer = HeaderChainWriter::attach_at_semantic_handoff(&finalized_state, &live)
        .expect("the header engine attaches at the exact full-state Canopy anchor");
    assert_eq!(
        writer.runtime.publisher().snapshot().frontiers.finalized,
        canopy_anchor
    );

    for (index, block) in chain.iter().cloned().enumerate().skip(31) {
        let height = block
            .coinbase_height()
            .expect("the generated block has a coinbase height");
        let parent_hash = block.header.previous_block_hash;
        let lease = writer
            .runtime
            .reader()
            .validation_context(parent_hash)
            .expect("the exact generated parent context read succeeds")
            .expect("the exact generated parent is retained");
        let rules = HeaderRules::for_validation_lease(&lease)
            .expect("the custom network authenticates its PoW waiver");
        let batch = zakura_header_chain::prepare_headers(
            HeaderBatchInput::new(std::slice::from_ref(&block.header)),
            lease.parent(),
            &rules,
            &SystemClock,
        )
        .unwrap_or_else(|error| {
            panic!("generated header {height:?} must pass the shared observable rules: {error}")
        });
        assert_eq!(batch.headers()[0].height, height);
        assert_eq!(batch.headers()[0].hash, block.hash());

        let mut staged = live.clone();
        if index == 31 {
            staged
                .commit_new_chain(block.clone().prepare(), &finalized_state.db)
                .expect("the first generated body enters full state");
        } else {
            staged
                .commit_block(block.clone().prepare(), &finalized_state.db)
                .expect("the next generated body enters full state");
        }
        let accepted = Frontier::new(height, block.hash());
        commit_verified_change(&writer, &mut live, staged, accepted);
        assert_selected_header_matches_full_state(&writer, &live);
    }

    assert_eq!(
        NetworkUpgrade::current(
            &network,
            live.best_chain()
                .expect("the generated full-state graph has a best chain")
                .non_finalized_tip()
                .0,
        ),
        NetworkUpgrade::Nu5
    );

    let incumbent = writer
        .runtime
        .publisher()
        .snapshot()
        .frontiers
        .verified_best;
    let mut side = chain[39].clone();
    let side_block = Arc::make_mut(&mut side);
    let Transaction::V5 { expiry_height, .. } = Arc::make_mut(&mut side_block.transactions[0])
    else {
        unreachable!("the side block is after the generated NU5 activation")
    };
    *expiry_height = block::Height(40);
    Arc::make_mut(&mut side_block.header).merkle_root =
        side_block.transactions.iter().cloned().collect();
    let parent_history_root = live
        .best_chain()
        .expect("the generated full-state graph has a best chain")
        .history_tree(crate::HashOrHeight::Height(block::Height(38)))
        .expect("the side parent has a retained history tree")
        .hash()
        .expect("the side parent history tree is nonempty");
    let commitment: [u8; 32] = ChainHistoryBlockTxAuthCommitmentHash::from_commitments(
        &parent_history_root,
        &side.auth_data_root(),
    )
    .into();
    Arc::make_mut(&mut Arc::make_mut(&mut side).header).commitment_bytes = commitment.into();
    let side_frontier = Frontier::new(
        side.coinbase_height().expect("the side block has a height"),
        side.hash(),
    );
    assert!(writer
        .runtime
        .reader()
        .validation_context(side_frontier.hash)
        .expect("the absent side context reads")
        .is_none());
    let mut staged = live.clone();
    staged
        .commit_block(side.prepare(), &finalized_state.db)
        .expect("the lower-work side block enters full state");
    commit_verified_change(&writer, &mut live, staged, side_frontier);
    assert_eq!(
        writer
            .runtime
            .publisher()
            .snapshot()
            .frontiers
            .verified_best,
        incumbent,
        "accepting a valid side block does not replace the full-state winner"
    );
    assert!(writer
        .runtime
        .reader()
        .validation_context(side_frontier.hash)
        .expect("the accepted side context reads")
        .is_some());

    let mut replacement = chain[39].clone().set_work(1_000);
    let replacement_block = Arc::make_mut(&mut replacement);
    let Transaction::V5 { expiry_height, .. } =
        Arc::make_mut(&mut replacement_block.transactions[0])
    else {
        unreachable!("the replacement is after the generated NU5 activation")
    };
    *expiry_height = block::Height(40);
    Arc::make_mut(&mut replacement_block.header).merkle_root =
        replacement_block.transactions.iter().cloned().collect();
    let parent_history_root = live
        .best_chain()
        .expect("the generated full-state graph has a best chain")
        .history_tree(crate::HashOrHeight::Height(block::Height(38)))
        .expect("the replacement parent has a retained history tree")
        .hash()
        .expect("the replacement parent history tree is nonempty");
    let commitment: [u8; 32] = ChainHistoryBlockTxAuthCommitmentHash::from_commitments(
        &parent_history_root,
        &replacement.auth_data_root(),
    )
    .into();
    Arc::make_mut(&mut Arc::make_mut(&mut replacement).header).commitment_bytes = commitment.into();
    let replacement_frontier = Frontier::new(
        replacement
            .coinbase_height()
            .expect("the replacement has a height"),
        replacement.hash(),
    );
    let mut staged = live.clone();
    staged
        .commit_block(replacement.prepare(), &finalized_state.db)
        .expect("the harder supported-format replacement enters full state");
    commit_verified_change(&writer, &mut live, staged, replacement_frontier);
    assert_eq!(
        writer
            .runtime
            .publisher()
            .snapshot()
            .frontiers
            .verified_best,
        replacement_frontier
    );

    let mut staged = live.clone();
    staged
        .invalidate_block(replacement_frontier.hash)
        .expect("the replacement invalidates in staged full state");
    commit_operator_change(&writer, &mut live, staged, replacement_frontier.hash, true)
        .expect("invalidation commits both frontiers before swapping full state");
    let invalidated = writer.runtime.publisher().snapshot();
    assert_eq!(invalidated.frontiers.verified_best, incumbent);
    assert_eq!(invalidated.frontiers.header_best, incumbent);

    let mut staged = live.clone();
    staged
        .reconsider_block(replacement_frontier.hash, &finalized_state.db)
        .expect("the replacement replays into staged full state");
    commit_operator_change(&writer, &mut live, staged, replacement_frontier.hash, false)
        .expect("reconsider commits both frontiers before swapping full state");
    let reconsidered = writer.runtime.publisher().snapshot();
    assert_eq!(reconsidered.frontiers.verified_best, replacement_frontier);
    assert_eq!(reconsidered.frontiers.header_best, replacement_frontier);

    let first_non_finalized = chain[31].hash();
    let mut staged = live.clone();
    staged
        .invalidate_block(first_non_finalized)
        .expect("invalidating the common root empties every full-state branch");
    commit_operator_change(&writer, &mut live, staged, first_non_finalized, true)
        .expect("empty full state commits its exact finalized fallback");
    assert!(live.is_chain_set_empty());
    let snapshot = writer.runtime.publisher().snapshot();
    assert_eq!(
        snapshot.frontiers.verified_best,
        snapshot.frontiers.finalized
    );
    assert_eq!(snapshot.frontiers.header_best, snapshot.frontiers.finalized);
}