commonware-glue 2026.9.0

Default constructions that span multiple primitives.
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
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
//! DKG/reshare crash-recovery storage.
//!
//! This store exists only to recover state a restarted actor cannot otherwise
//! re-obtain. After a crash the actor does not re-receive P2P messages and
//! marshal does not re-deliver finalized blocks, so this store keeps a plaintext
//! journal of the public messages a restarted node would otherwise lose:
//!
//! - public dealer messages and player acknowledgements, so a player can rebuild
//!   the acks it already emitted (its private dealings are recovered from
//!   [`SecretStore`]);
//! - finalized dealer logs observed during inclusion.
//!
//! The current epoch's public state is not persisted here: ordinary recovery
//! re-derives it from the finalized boundary block, while state-sync recovery
//! uses the shared [`state_sync::Plan`](crate::dkg::state_sync::Plan). Everything
//! secret stays out of this plaintext store and is held only through
//! [`SecretStore`]: shares, private dealings, and the dealer RNG seed (which
//! seeds the dealer polynomial and so reveals every share that dealer
//! distributes).

use crate::dkg::{SecretStore, network::Directory, types::EpochInfo};
use bytes::{Buf, BufMut};
use commonware_codec::{EncodeSize, Error as CodecError, Read, ReadExt, Write};
use commonware_consensus::types::Epoch;
use commonware_cryptography::{
    BatchVerifier, PublicKey, Signer,
    bls12381::{
        dkg::feldman_desmedt::{
            Dealer as CryptoDealer, DealerLog, DealerMessageError as DkgDealerMessageError,
            DealerPrivMsg, DealerPubMsg, Error as DkgError, FinalizeError as DkgFinalizeError,
            Info, Logs, Output, Player as CryptoPlayer, PlayerAck, PlayerAckError as DkgAckError,
            SignedDealerLog,
        },
        primitives::{group, variant::Variant},
    },
    transcript::{Summary, Transcript, Version},
};
use commonware_math::algebra::Random;
use commonware_parallel::Strategy;
use commonware_runtime::{
    BufferPooler, Clock, Metrics, ReadOptions, Storage as RuntimeStorage, buffer::paged::CacheRef,
};
use commonware_storage::journal::{
    self,
    segmented::variable::{Config as JournalConfig, Journal},
};
use commonware_utils::{Faults, N3f1, NZU16, NZUsize, futures::rebind, sequence::Unit};
use rand_core::CryptoRng;
use std::{
    collections::BTreeMap,
    num::{NonZeroU16, NonZeroU32, NonZeroUsize},
};
use tracing::{debug, warn};

const PAGE_SIZE: NonZeroU16 = NZU16!(1 << 12); // 4 KiB
const PAGE_CACHE_CAPACITY: NonZeroUsize = NZUsize!(1 << 13); // 8 KiB
const WRITE_BUFFER: NonZeroUsize = NZUsize!(1 << 12); // 4 KiB
const READ_BUFFER: NonZeroUsize = NZUsize!(1 << 20); // 1 MiB

enum Event<V: Variant, P: PublicKey> {
    Dealing(P, DealerPubMsg<V>),
    Ack(P, PlayerAck<P>),
    Log(P, DealerLog<V, P>),
}

impl<V: Variant, P: PublicKey> EncodeSize for Event<V, P> {
    fn encode_size(&self) -> usize {
        1 + match self {
            Self::Dealing(dealer, public) => dealer.encode_size() + public.encode_size(),
            Self::Ack(player, ack) => player.encode_size() + ack.encode_size(),
            Self::Log(dealer, log) => dealer.encode_size() + log.encode_size(),
        }
    }
}

impl<V: Variant, P: PublicKey> Write for Event<V, P> {
    fn write(&self, writer: &mut impl BufMut) {
        match self {
            Self::Dealing(dealer, public) => {
                0u8.write(writer);
                dealer.write(writer);
                public.write(writer);
            }
            Self::Ack(player, ack) => {
                1u8.write(writer);
                player.write(writer);
                ack.write(writer);
            }
            Self::Log(dealer, log) => {
                2u8.write(writer);
                dealer.write(writer);
                log.write(writer);
            }
        }
    }
}

impl<V: Variant, P: PublicKey> Read for Event<V, P> {
    type Cfg = NonZeroU32;

    fn read_cfg(reader: &mut impl Buf, cfg: &Self::Cfg) -> Result<Self, CodecError> {
        match u8::read(reader)? {
            0 => Ok(Self::Dealing(
                ReadExt::read(reader)?,
                Read::read_cfg(reader, cfg)?,
            )),
            1 => Ok(Self::Ack(ReadExt::read(reader)?, ReadExt::read(reader)?)),
            2 => Ok(Self::Log(
                ReadExt::read(reader)?,
                Read::read_cfg(reader, cfg)?,
            )),
            tag => Err(CodecError::InvalidEnum(tag)),
        }
    }
}

#[cfg(feature = "arbitrary")]
impl<V: Variant, P: PublicKey> arbitrary::Arbitrary<'_> for Event<V, P>
where
    P: for<'a> arbitrary::Arbitrary<'a>,
    DealerPubMsg<V>: for<'a> arbitrary::Arbitrary<'a>,
    DealerLog<V, P>: for<'a> arbitrary::Arbitrary<'a>,
    PlayerAck<P>: for<'a> arbitrary::Arbitrary<'a>,
{
    fn arbitrary(u: &mut arbitrary::Unstructured<'_>) -> arbitrary::Result<Self> {
        Ok(match u.int_in_range(0..=2)? {
            0 => Self::Dealing(u.arbitrary()?, u.arbitrary()?),
            1 => Self::Ack(u.arbitrary()?, u.arbitrary()?),
            _ => Self::Log(u.arbitrary()?, u.arbitrary()?),
        })
    }
}

struct EpochCache<V: Variant, P: PublicKey> {
    dealings: BTreeMap<P, (DealerPubMsg<V>, DealerPrivMsg)>,
    acks: BTreeMap<P, PlayerAck<P>>,
    logs: BTreeMap<P, DealerLog<V, P>>,
}

impl<V: Variant, P: PublicKey> Default for EpochCache<V, P> {
    fn default() -> Self {
        Self {
            dealings: BTreeMap::new(),
            acks: BTreeMap::new(),
            logs: BTreeMap::new(),
        }
    }
}

/// DKG/reshare crash-recovery store.
///
/// The plaintext side holds only the dealer-message, acknowledgement, and
/// finalized-log journal. The current epoch's public state comes from finalized
/// boundary blocks or the separate state-sync store, not this journal. All
/// secret material (shares, private dealings, and the dealer RNG seed) is held only through
/// [`SecretStore`], never in plaintext.
pub struct Store<E, SS, V, P, D = Unit>
where
    E: BufferPooler + Clock + RuntimeStorage + Metrics,
    SS: SecretStore,
    V: Variant,
    P: PublicKey,
    D: Directory<P>,
{
    secret_store: SS,
    events: Option<Journal<E, Event<V, P>>>,
    current: Option<EpochInfo<V, P, D>>,
    epochs: BTreeMap<Epoch, EpochCache<V, P>>,
}

impl<E, SS, V, P, D> Store<E, SS, V, P, D>
where
    E: BufferPooler + Clock + RuntimeStorage + Metrics,
    SS: SecretStore,
    V: Variant,
    P: PublicKey,
    D: Directory<P>,
{
    /// Initializes the store and replays durable crash-recovery state.
    pub async fn init(
        context: E,
        partition_prefix: &str,
        max_participants: NonZeroU32,
        mut secret_store: SS,
    ) -> Self {
        let page_cache = CacheRef::from_pooler(&context, PAGE_SIZE, PAGE_CACHE_CAPACITY);
        let events = Journal::init(
            context.child("events"),
            JournalConfig {
                partition: format!("{partition_prefix}_events"),
                compression: None,
                codec_config: max_participants,
                page_cache,
                write_buffer: WRITE_BUFFER,
            },
        )
        .await
        .expect("failed to initialize reshare event journal");

        // The current epoch is not persisted: it is re-derived from finalized
        // boundary blocks by the setup state, so a restarted store starts with no
        // current epoch.
        let current = None;

        let mut epochs = BTreeMap::<Epoch, EpochCache<V, P>>::new();
        let events = {
            // Replay rebuilds the epoch caches in memory, so journal pages need
            // not remain in the OS page cache.
            let mut replay = events
                .replay(0, 0, READ_BUFFER, ReadOptions::DONT_CACHE)
                .await
                .expect("failed to replay reshare events");

            while let Some(result) = replay.next().await {
                let (section, _, _, event) = result.expect("failed to read reshare event");
                let epoch = Epoch::new(section);
                let cache = epochs.entry(epoch).or_default();
                match event {
                    Event::Dealing(dealer, public) => {
                        let private = secret_store.get_dealing(epoch, &dealer).await;
                        if let Some(private) = private {
                            cache.dealings.insert(dealer, (public, private));
                        }
                    }
                    Event::Ack(player, ack) => {
                        cache.acks.insert(player, ack);
                    }
                    Event::Log(dealer, log) => {
                        cache.logs.insert(dealer, log);
                    }
                }
            }
            replay.finish().expect("failed to replay reshare events")
        };

        Self {
            secret_store,
            events: Some(events),
            current,
            epochs,
        }
    }

    /// Returns the current epoch state, if one has been entered.
    pub fn current(&self) -> Option<EpochInfo<V, P, D>> {
        self.current.clone()
    }

    /// Returns the share for `epoch`, if any.
    pub async fn share(&mut self, epoch: Epoch) -> Option<group::Share> {
        self.secret_store.get_share(epoch).await
    }

    /// Returns the persisted dealer RNG seed for `epoch`, if any.
    ///
    /// A seed exists only for an epoch this node previously entered. Reusing it
    /// keeps dealer randomness identical across a restart.
    pub async fn seed(&mut self, epoch: Epoch) -> Option<Summary> {
        self.secret_store.get_seed(epoch).await
    }

    /// Returns the persisted dealer RNG seed for `epoch`, generating a fresh
    /// random seed from `rng` if none exists.
    pub(crate) async fn seed_or_random(&mut self, epoch: Epoch, rng: impl CryptoRng) -> Summary {
        self.seed(epoch)
            .await
            .unwrap_or_else(|| Summary::random(rng))
    }

    /// Persists the dealer RNG seed for `epoch`.
    pub(crate) async fn put_seed(&mut self, epoch: Epoch, rng_seed: Summary) {
        self.secret_store.put_seed(epoch, rng_seed).await;
    }

    /// Advances to `info`, persisting its secrets before the current epoch moves.
    ///
    /// The public artifact in `info` is read from the finalized boundary block,
    /// not from local state, and is held only in memory. The share is persisted
    /// only when it matches that finalized truth; otherwise the node continues as
    /// an observer.
    pub async fn commit_epoch(
        &mut self,
        info: EpochInfo<V, P, D>,
        rng_seed: Summary,
        share: Option<group::Share>,
    ) {
        let epoch = info.epoch;
        if let Some(share) = share {
            self.secret_store.put_share(epoch, share).await;
        }
        self.secret_store.put_seed(epoch, rng_seed).await;
        self.current = Some(info);
    }

    /// Prunes public recovery data and secret material older than `min`.
    pub async fn prune(&mut self, min: Epoch) {
        self.epochs.retain(|epoch, _| *epoch >= min);
        // Prune the recovery journal and the secret store concurrently; they are
        // independent backends.
        let secret = &mut self.secret_store;
        futures::join!(
            async {
                rebind(&mut self.events, |events| events.prune(min.get()))
                    .await
                    .expect("failed to prune reshare events");
            },
            secret.prune(min),
        );
    }

    fn cache(&mut self, epoch: Epoch) -> &mut EpochCache<V, P> {
        self.epochs.entry(epoch).or_default()
    }

    /// Returns finalized dealer logs for `epoch`.
    pub fn logs(&self, epoch: Epoch) -> BTreeMap<P, DealerLog<V, P>> {
        self.epochs
            .get(&epoch)
            .map(|cache| cache.logs.clone())
            .unwrap_or_default()
    }

    /// Returns true if `dealer` already has a finalized log recorded.
    pub fn has_log(&self, epoch: Epoch, dealer: &P) -> bool {
        self.epochs
            .get(&epoch)
            .is_some_and(|cache| cache.logs.contains_key(dealer))
    }

    fn dealings(&self, epoch: Epoch) -> Vec<(P, DealerPubMsg<V>, DealerPrivMsg)> {
        self.epochs
            .get(&epoch)
            .map(|cache| {
                cache
                    .dealings
                    .iter()
                    .map(|(dealer, (public, private))| {
                        (dealer.clone(), public.clone(), private.clone())
                    })
                    .collect()
            })
            .unwrap_or_default()
    }

    fn acks(&self, epoch: Epoch) -> Vec<(P, PlayerAck<P>)> {
        self.epochs
            .get(&epoch)
            .map(|cache| {
                cache
                    .acks
                    .iter()
                    .map(|(player, ack)| (player.clone(), ack.clone()))
                    .collect()
            })
            .unwrap_or_default()
    }

    /// Persists a public/private dealing already accepted by the cryptographic player.
    async fn append_dealing(
        &mut self,
        epoch: Epoch,
        dealer: P,
        public: DealerPubMsg<V>,
        private: DealerPrivMsg,
    ) -> bool {
        if self
            .epochs
            .get(&epoch)
            .is_some_and(|cache| cache.dealings.contains_key(&dealer))
        {
            return false;
        }
        // Persist the private dealing (secret store) and the public dealer message
        // (recovery journal) concurrently. Both are durable before this returns, so
        // the ack the caller emits next is always backed by recoverable state. A
        // crash mid-write is safe: replay loads a dealing only when both its public
        // and private parts survived.
        let event = Event::Dealing(dealer.clone(), public.clone());
        let secret = &mut self.secret_store;
        futures::join!(
            secret.put_dealing(epoch, dealer.clone(), private.clone()),
            async {
                rebind(&mut self.events, |events| {
                    append_synced(events, epoch, &event)
                })
                .await
                .expect("failed to record reshare dealing");
            },
        );
        self.cache(epoch).dealings.insert(dealer, (public, private));
        true
    }

    async fn append_ack(&mut self, epoch: Epoch, player: P, ack: PlayerAck<P>) -> bool {
        if self
            .epochs
            .get(&epoch)
            .is_some_and(|cache| cache.acks.contains_key(&player))
        {
            return false;
        }
        let event = Event::Ack(player.clone(), ack.clone());
        rebind(&mut self.events, |events| {
            append_synced(events, epoch, &event)
        })
        .await
        .expect("failed to record reshare ack");
        self.cache(epoch).acks.insert(player, ack);
        true
    }

    /// Records a finalized dealer log.
    pub async fn append_log(&mut self, epoch: Epoch, dealer: P, log: DealerLog<V, P>) -> bool {
        if self.has_log(epoch, &dealer) {
            return false;
        }
        let event = Event::Log(dealer.clone(), log.clone());
        rebind(&mut self.events, |events| {
            append_synced(events, epoch, &event)
        })
        .await
        .expect("failed to record reshare log");
        self.cache(epoch).logs.insert(dealer, log);
        true
    }

    /// Replays dealer state for `epoch`.
    pub fn create_dealer<C, M>(
        &self,
        epoch: Epoch,
        signer: C,
        info: Info<V, P>,
        share: Option<group::Share>,
        rng_seed: Summary,
    ) -> Option<Dealer<V, C>>
    where
        C: Signer<PublicKey = P>,
        M: Faults,
    {
        if self.has_log(epoch, &signer.public_key()) {
            return None;
        }
        let (mut dealer, public, private) = CryptoDealer::start::<M>(
            Transcript::resume(rng_seed, Version::V1).noise(b"dealer-rng"),
            info,
            signer,
            share,
        )
        .expect("failed to create reshare dealer");
        let mut unsent: BTreeMap<P, DealerPrivMsg> = private.into_iter().collect();
        for (player, ack) in self.acks(epoch) {
            if unsent.contains_key(&player)
                && dealer.receive_player_ack(player.clone(), ack).is_ok()
            {
                unsent.remove(&player);
                debug!(?epoch, ?player, "replayed reshare ack");
            }
        }
        Some(Dealer {
            dealer: Some(dealer),
            public,
            unsent,
            finalized: None,
        })
    }

    /// Replays player state for `epoch`.
    ///
    /// Returns `None` when this node observes an on-chain dealer log carrying its
    /// own acknowledgement but has lost the matching private dealing; see
    /// [`resume_player`](Self::resume_player).
    pub fn create_player<C, M>(
        &self,
        epoch: Epoch,
        signer: C,
        info: Info<V, P>,
    ) -> Option<Player<V, C>>
    where
        C: Signer<PublicKey = P>,
        M: Faults,
    {
        self.resume_player::<C, M>(epoch, signer, info, &self.logs(epoch))
    }

    /// Replays player state using a supplied, non-durable log view.
    ///
    /// Returns `None` under the same missing-dealing condition as
    /// [`create_player`](Self::create_player).
    pub fn create_player_with_logs<C, M>(
        &self,
        epoch: Epoch,
        signer: C,
        info: Info<V, P>,
        logs: &BTreeMap<P, DealerLog<V, P>>,
    ) -> Option<Player<V, C>>
    where
        C: Signer<PublicKey = P>,
        M: Faults,
    {
        self.resume_player::<C, M>(epoch, signer, info, logs)
    }

    /// Resumes player state for `epoch` from `logs`.
    ///
    /// Degrades to observer mode (returns `None`) when [`CryptoPlayer::resume`]
    /// reports [`MissingPlayerDealing`](DkgError::MissingPlayerDealing): a
    /// finalized dealer log carries this node's valid acknowledgement, but the
    /// matching private dealing is absent from the secret store (for example, a
    /// secret store restored from a backup taken before the ack was emitted).
    /// The ceremony has otherwise succeeded, so the node commits the epoch as a
    /// share-less verifier rather than crash-looping. Any other error signals
    /// genuine corruption and stays fatal.
    fn resume_player<C, M>(
        &self,
        epoch: Epoch,
        signer: C,
        info: Info<V, P>,
        logs: &BTreeMap<P, DealerLog<V, P>>,
    ) -> Option<Player<V, C>>
    where
        C: Signer<PublicKey = P>,
        M: Faults,
    {
        match CryptoPlayer::resume::<M>(info, signer, logs, self.dealings(epoch)) {
            Ok((player, acks)) => Some(Player { player, acks }),
            Err(DkgError::MissingPlayerDealing) => {
                warn!(
                    ?epoch,
                    "missing private dealing on resume; entering epoch as observer"
                );
                None
            }
            Err(error) => panic!("failed to resume reshare player: {error:?}"),
        }
    }
}

/// Appends `event` to the recovery journal for `epoch` and flushes it durably.
async fn append_synced<E, V, P>(
    events: Journal<E, Event<V, P>>,
    epoch: Epoch,
    event: &Event<V, P>,
) -> Result<Journal<E, Event<V, P>>, journal::Error>
where
    E: BufferPooler + Clock + RuntimeStorage + Metrics,
    V: Variant,
    P: PublicKey,
{
    let section = epoch.get();
    let (events, _, _) = events.append(section, event).await?;
    events.sync(section).await
}

/// Dealer state for one epoch.
pub struct Dealer<V: Variant, C: Signer> {
    dealer: Option<CryptoDealer<V, C>>,
    public: DealerPubMsg<V>,
    unsent: BTreeMap<C::PublicKey, DealerPrivMsg>,
    finalized: Option<SignedDealerLog<V, C>>,
}

/// Successful outcome of processing a player acknowledgement.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub(crate) enum AckOutcome {
    /// The acknowledgement was newly persisted.
    Recorded,
    /// The acknowledgement was already recorded.
    Duplicate,
}

impl<V: Variant, C: Signer> Dealer<V, C> {
    /// Returns whether the recorded acknowledgements form a quorum.
    pub fn has_acknowledgement_quorum<M: Faults>(&self, players: usize) -> bool {
        self.unsent.len() <= M::max_faults(players) as usize
    }

    /// Records a player ack.
    ///
    /// Returns [`AckOutcome::Recorded`] for a new acknowledgement and
    /// [`AckOutcome::Duplicate`] for one already recorded.
    /// [`DkgAckError::UnexpectedPlayer`] identifies a sender outside the round's
    /// player set, while [`DkgAckError::InvalidAck`] identifies a signature that
    /// does not match this dealer's transcript.
    ///
    /// # Panics
    ///
    /// Panics if called after the dealer has finalized.
    pub async fn handle<E, SS, D>(
        &mut self,
        store: &mut Store<E, SS, V, C::PublicKey, D>,
        epoch: Epoch,
        player: C::PublicKey,
        ack: PlayerAck<C::PublicKey>,
    ) -> Result<AckOutcome, DkgAckError>
    where
        E: BufferPooler + Clock + RuntimeStorage + Metrics,
        SS: SecretStore,
        D: Directory<C::PublicKey>,
    {
        let dealer = self
            .dealer
            .as_mut()
            .expect("acknowledgements are handled only before dealer finalization");
        dealer.receive_player_ack(player.clone(), ack.clone())?;
        if self.unsent.remove(&player).is_none() {
            return Ok(AckOutcome::Duplicate);
        }
        assert!(
            store.append_ack(epoch, player, ack).await,
            "pending acknowledgement must not already be persisted"
        );
        Ok(AckOutcome::Recorded)
    }

    /// Finalizes once and returns true if a new log became available.
    pub fn finalize<M: Faults>(&mut self) -> bool {
        if self.finalized.is_some() {
            return false;
        }
        let Some(dealer) = self.dealer.take() else {
            return false;
        };
        self.finalized = Some(dealer.finalize::<M>());
        true
    }

    /// Returns a cloned finalized log.
    pub fn finalized(&self) -> Option<SignedDealerLog<V, C>> {
        self.finalized.clone()
    }

    /// Clears a finalized log after it is observed in a finalized block.
    pub fn clear_finalized(&mut self) {
        self.finalized = None;
    }

    /// Returns private dealings that still need to be sent.
    pub fn shares_to_distribute(
        &self,
    ) -> impl Iterator<Item = (C::PublicKey, DealerPubMsg<V>, DealerPrivMsg)> + '_ {
        self.unsent
            .iter()
            .map(|(player, private)| (player.clone(), self.public.clone(), private.clone()))
    }
}

/// Player state for one epoch.
pub struct Player<V: Variant, C: Signer> {
    player: CryptoPlayer<V, C>,
    acks: BTreeMap<C::PublicKey, PlayerAck<C::PublicKey>>,
}

impl<V: Variant, C: Signer> Player<V, C> {
    /// Handles a dealer message, persisting it before returning the ack.
    ///
    /// A previously processed dealer returns its cached acknowledgement. A first
    /// message returns the exact [`DkgDealerMessageError`] for an unexpected
    /// dealer, invalid commitment degree, mismatched reshare commitment, or
    /// invalid private share. Rejected messages are not persisted.
    pub async fn handle<E, SS, D>(
        &mut self,
        store: &mut Store<E, SS, V, C::PublicKey, D>,
        epoch: Epoch,
        dealer: C::PublicKey,
        public: DealerPubMsg<V>,
        private: DealerPrivMsg,
    ) -> Result<PlayerAck<C::PublicKey>, DkgDealerMessageError>
    where
        E: BufferPooler + Clock + RuntimeStorage + Metrics,
        SS: SecretStore,
        D: Directory<C::PublicKey>,
    {
        if let Some(ack) = self.acks.get(&dealer) {
            return Ok(ack.clone());
        }
        let ack = self
            .player
            .dealer_message::<N3f1>(dealer.clone(), public.clone(), private.clone())?
            .expect("processed dealer must have a cached acknowledgement");
        store
            .append_dealing(epoch, dealer.clone(), public, private)
            .await;
        self.acks.insert(dealer, ack.clone());
        Ok(ack)
    }

    /// Finalizes and returns the public output plus local share.
    #[allow(clippy::type_complexity)]
    pub fn finalize<M, B>(
        self,
        rng: &mut impl CryptoRng,
        logs: Logs<V, C::PublicKey, M>,
        strategy: &impl Strategy,
    ) -> Result<(Output<V, C::PublicKey>, group::Share), DkgFinalizeError<C::PublicKey>>
    where
        M: Faults,
        B: BatchVerifier<PublicKey = C::PublicKey>,
    {
        self.player.finalize::<M, B>(rng, logs, strategy)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::dkg::{
        tests::mocks::MemorySecretStore,
        types::{EpochInfo, EpochOutcome},
    };
    use commonware_codec::FixedSize;
    use commonware_consensus::types::Epoch;
    use commonware_cryptography::{
        Signer,
        bls12381::{
            dkg::feldman_desmedt::{Info, Output, Reveal, deal},
            primitives::{sharing::Mode, variant::MinPk},
        },
        ed25519::{PrivateKey, PublicKey},
    };
    use commonware_runtime::{Runner, Supervisor as _, deterministic};
    use commonware_utils::{N3f1, NZU32, TestRng, ordered::Set};

    type TestStore<E> = Store<E, MemorySecretStore, MinPk, PublicKey>;

    fn summary(seed: u8) -> Summary {
        let bytes = [seed; Summary::SIZE];
        Summary::read(&mut bytes.as_ref()).expect("valid summary")
    }

    fn output(seed: u64) -> Output<MinPk, PublicKey> {
        let (output, _) = deal::<MinPk, _, N3f1>(
            TestRng::new(seed),
            Mode::NonZeroCounter,
            players(&signers()),
        )
        .expect("trusted deal");
        output
    }

    fn epoch_info(epoch: Epoch, output: Output<MinPk, PublicKey>) -> EpochInfo<MinPk, PublicKey> {
        EpochInfo {
            outcome: EpochOutcome::Success,
            epoch,
            output,
            players: Set::default(),
            next_players: Set::default(),
            directory: Unit,
        }
    }

    fn signers() -> Vec<PrivateKey> {
        (0..4).map(PrivateKey::from_seed).collect()
    }

    fn players(signers: &[PrivateKey]) -> Set<PublicKey> {
        Set::from_iter_dedup(signers.iter().map(Signer::public_key))
    }

    async fn init_store<E>(
        context: E,
        partition: &str,
        secret_store: MemorySecretStore,
    ) -> TestStore<E>
    where
        E: BufferPooler + Clock + RuntimeStorage + Metrics,
    {
        Store::init(context, partition, NZU32!(16), secret_store).await
    }

    #[test]
    fn commit_epoch_seeds_configured_epoch() {
        let executor = deterministic::Runner::default();
        executor.start(|context| async move {
            let secret_store = MemorySecretStore::default();
            let mut store =
                init_store(context.child("store"), "configured-start", secret_store).await;
            store
                .commit_epoch(epoch_info(Epoch::new(7), output(1)), summary(1), None)
                .await;

            let info = store.current().expect("current epoch");
            assert_eq!(info.epoch, Epoch::new(7));
        });
    }

    #[test]
    fn replay_restores_dealings_acks_and_logs() {
        let executor = deterministic::Runner::default();
        executor.start(|context| async move {
            let secret_store = MemorySecretStore::default();
            let mut store =
                init_store(context.child("store"), "replay", secret_store.clone()).await;
            let signers = signers();
            let players = players(&signers);
            let info = Info::new::<N3f1>(
                b"_COMMONWARE_GLUE_DKG_RESHARE_STORE_TEST",
                0,
                None,
                Mode::NonZeroCounter,
                Reveal::V1,
                players.clone(),
                players.clone(),
            )
            .expect("valid info");
            store
                .commit_epoch(epoch_info(Epoch::zero(), output(1)), summary(1), None)
                .await;

            let dealer_pk = signers[0].public_key();
            let player_pk = signers[1].public_key();
            let mut dealer = store
                .create_dealer::<PrivateKey, N3f1>(
                    Epoch::zero(),
                    signers[0].clone(),
                    info.clone(),
                    None,
                    summary(2),
                )
                .expect("dealer");
            let mut player = store
                .create_player::<PrivateKey, N3f1>(Epoch::zero(), signers[1].clone(), info.clone())
                .expect("player");
            let (_, public, private) = dealer
                .shares_to_distribute()
                .find(|(recipient, _, _)| *recipient == player_pk)
                .expect("dealing for player");
            let duplicate_public = public.clone();
            let duplicate_private = private.clone();
            let ack = player
                .handle(
                    &mut store,
                    Epoch::zero(),
                    dealer_pk.clone(),
                    public,
                    private,
                )
                .await
                .expect("valid dealing");
            let duplicate_ack = player
                .handle(
                    &mut store,
                    Epoch::zero(),
                    dealer_pk.clone(),
                    duplicate_public.clone(),
                    duplicate_private.clone(),
                )
                .await
                .expect("cached dealing");
            assert_eq!(duplicate_ack, ack);

            // Sender membership and signature failures remain visible to the
            // authenticated transport policy without consuming pending state.
            let stranger = PrivateKey::from_seed(u64::MAX).public_key();
            assert!(matches!(
                dealer
                    .handle(&mut store, Epoch::zero(), stranger, ack.clone())
                    .await,
                Err(DkgAckError::UnexpectedPlayer)
            ));
            assert!(matches!(
                dealer
                    .handle(
                        &mut store,
                        Epoch::zero(),
                        signers[2].public_key(),
                        ack.clone(),
                    )
                    .await,
                Err(DkgAckError::InvalidAck)
            ));

            // Acknowledgements distinguish new and duplicate outcomes.
            assert!(matches!(
                dealer
                    .handle(&mut store, Epoch::zero(), player_pk.clone(), ack.clone())
                    .await,
                Ok(AckOutcome::Recorded)
            ));
            assert!(matches!(
                dealer
                    .handle(&mut store, Epoch::zero(), player_pk.clone(), ack.clone())
                    .await,
                Ok(AckOutcome::Duplicate)
            ));
            assert!(dealer.finalize::<N3f1>());
            let signed = dealer.finalized().expect("signed log");
            let (dealer, log) = signed.check(&info).expect("valid log");
            store.append_log(Epoch::zero(), dealer, log).await;
            drop(store);

            let mut store = init_store(context.child("restart"), "replay", secret_store).await;

            // The current epoch is not persisted; the setup state re-derives it from
            // finalized blocks, so a restarted store has no current epoch on its own.
            assert!(store.current().is_none());

            // The public recovery journal is replayed.
            assert_eq!(store.dealings(Epoch::zero()).len(), 1);
            assert_eq!(store.acks(Epoch::zero()).len(), 1);
            assert_eq!(store.logs(Epoch::zero()).len(), 1);
            let mut replayed_player = store
                .create_player::<PrivateKey, N3f1>(Epoch::zero(), signers[1].clone(), info)
                .expect("player");
            assert_eq!(replayed_player.acks.len(), 1);
            let replayed_ack = replayed_player
                .handle(
                    &mut store,
                    Epoch::zero(),
                    dealer_pk,
                    duplicate_public,
                    duplicate_private,
                )
                .await
                .expect("replayed dealing");
            assert_eq!(replayed_ack, ack);
        });
    }

    #[test]
    fn resume_with_missing_dealing_degrades_to_observer() {
        let executor = deterministic::Runner::default();
        executor.start(|context| async move {
            let secret_store = MemorySecretStore::default();
            let mut store = init_store(
                context.child("store"),
                "missing-dealing",
                secret_store.clone(),
            )
            .await;
            let signers = signers();
            let players = players(&signers);
            let info = Info::new::<N3f1>(
                b"_COMMONWARE_GLUE_DKG_RESHARE_STORE_TEST",
                0,
                None,
                Mode::NonZeroCounter,
                Reveal::V1,
                players.clone(),
                players.clone(),
            )
            .expect("valid info");
            store
                .commit_epoch(epoch_info(Epoch::zero(), output(1)), summary(1), None)
                .await;

            let dealer_pk = signers[0].public_key();
            let mut dealer = store
                .create_dealer::<PrivateKey, N3f1>(
                    Epoch::zero(),
                    signers[0].clone(),
                    info.clone(),
                    None,
                    summary(2),
                )
                .expect("dealer");

            // Collect enough acknowledgements (quorum) that the dealer log records
            // an Ack for each acking player rather than degrading to reveals. With
            // n=4, f=1 the log tolerates at most one reveal, so three players ack.
            for idx in [1usize, 2, 3] {
                let player_pk = signers[idx].public_key();
                let mut player = Player {
                    player: CryptoPlayer::new(info.clone(), signers[idx].clone()).expect("player"),
                    acks: BTreeMap::new(),
                };
                let (_, public, private) = dealer
                    .shares_to_distribute()
                    .find(|(recipient, _, _)| *recipient == player_pk)
                    .expect("dealing for player");
                let ack = player
                    .handle(
                        &mut store,
                        Epoch::zero(),
                        dealer_pk.clone(),
                        public,
                        private,
                    )
                    .await
                    .expect("valid dealing");
                assert!(matches!(
                    dealer
                        .handle(&mut store, Epoch::zero(), player_pk, ack)
                        .await,
                    Ok(AckOutcome::Recorded)
                ));
            }
            assert!(dealer.finalize::<N3f1>());
            let signed = dealer.finalized().expect("signed log");
            let (dealer, log) = signed.check(&info).expect("valid log");
            store.append_log(Epoch::zero(), dealer, log).await;
            drop(store);

            // Restart with an empty secret store: the finalized dealer log (which
            // records this player's acknowledgement) replays from public storage,
            // but the matching private dealing is gone. Resuming as that player
            // must degrade to an observer rather than panic.
            let empty_secret_store = MemorySecretStore::default();
            let restarted = init_store(
                context.child("restart"),
                "missing-dealing",
                empty_secret_store,
            )
            .await;
            assert!(restarted.dealings(Epoch::zero()).is_empty());
            assert_eq!(restarted.logs(Epoch::zero()).len(), 1);
            let player = restarted.create_player::<PrivateKey, N3f1>(
                Epoch::zero(),
                signers[1].clone(),
                info,
            );
            assert!(
                player.is_none(),
                "a missing private dealing must degrade to observer, not panic"
            );
        });
    }

    #[test]
    fn protocol_storage_does_not_restore_private_dealings() {
        let executor = deterministic::Runner::default();
        executor.start(|context| async move {
            let secret_store = MemorySecretStore::default();
            let mut store = init_store(
                context.child("store"),
                "private-dealing-boundary",
                secret_store,
            )
            .await;
            let signers = signers();
            let players = players(&signers);
            let info = Info::new::<N3f1>(
                b"_COMMONWARE_GLUE_DKG_RESHARE_STORE_TEST",
                0,
                None,
                Mode::NonZeroCounter,
                Reveal::V1,
                players.clone(),
                players,
            )
            .expect("valid info");
            store
                .commit_epoch(epoch_info(Epoch::zero(), output(1)), summary(1), None)
                .await;

            let dealer_pk = signers[0].public_key();
            let player_pk = signers[1].public_key();
            let dealer = store
                .create_dealer::<PrivateKey, N3f1>(
                    Epoch::zero(),
                    signers[0].clone(),
                    info.clone(),
                    None,
                    summary(2),
                )
                .expect("dealer");
            let mut player = store
                .create_player::<PrivateKey, N3f1>(Epoch::zero(), signers[1].clone(), info.clone())
                .expect("player");
            let (_, public, private) = dealer
                .shares_to_distribute()
                .find(|(recipient, _, _)| *recipient == player_pk)
                .expect("dealing for player");
            player
                .handle(&mut store, Epoch::zero(), dealer_pk, public, private)
                .await
                .expect("valid dealing");
            assert_eq!(store.dealings(Epoch::zero()).len(), 1);
            drop(store);

            let empty_secret_store = MemorySecretStore::default();
            let restarted = init_store(
                context.child("restart"),
                "private-dealing-boundary",
                empty_secret_store,
            )
            .await;
            assert!(restarted.dealings(Epoch::zero()).is_empty());
            let replayed_player = restarted
                .create_player::<PrivateKey, N3f1>(Epoch::zero(), signers[1].clone(), info)
                .expect("player");
            assert!(replayed_player.acks.is_empty());
        });
    }

    #[test]
    fn protocol_storage_does_not_restore_secret_shares() {
        let executor = deterministic::Runner::default();
        executor.start(|context| async move {
            let signers = signers();
            let (_, shares) =
                deal::<MinPk, _, N3f1>(TestRng::new(9), Mode::NonZeroCounter, players(&signers))
                    .expect("trusted deal");
            let share = shares
                .get_value(&signers[0].public_key())
                .expect("share")
                .clone();

            let secret_store = MemorySecretStore::default();
            let mut store =
                init_store(context.child("store"), "secret-boundary", secret_store).await;
            store
                .commit_epoch(
                    epoch_info(Epoch::zero(), output(1)),
                    summary(1),
                    Some(share),
                )
                .await;
            assert!(store.share(Epoch::zero()).await.is_some());
            drop(store);

            let empty_secret_store = MemorySecretStore::default();
            let mut restarted = init_store(
                context.child("restart"),
                "secret-boundary",
                empty_secret_store,
            )
            .await;
            // The current epoch is never persisted; setup re-derives it from
            // finalized boundary blocks. The share lived only in the secret store,
            // which is now empty, so neither a current epoch nor the share survives.
            assert!(restarted.current().is_none());
            assert!(restarted.share(Epoch::zero()).await.is_none());
        });
    }

    #[test]
    fn prune_removes_old_protocol_state_and_secret_shares() {
        let executor = deterministic::Runner::default();
        executor.start(|context| async move {
            let secret_store = MemorySecretStore::default();
            let mut store = init_store(context.child("store"), "prune", secret_store.clone()).await;
            let signers = signers();
            let (next_output, shares) =
                deal::<MinPk, _, N3f1>(TestRng::new(10), Mode::NonZeroCounter, players(&signers))
                    .expect("trusted deal");
            let share = shares
                .get_value(&signers[0].public_key())
                .expect("share")
                .clone();

            store
                .commit_epoch(epoch_info(Epoch::zero(), output(1)), summary(1), None)
                .await;
            store
                .commit_epoch(
                    epoch_info(Epoch::new(1), next_output),
                    summary(2),
                    Some(share),
                )
                .await;

            store.prune(Epoch::new(1)).await;
            drop(store);

            let store = init_store(context.child("restart"), "prune", secret_store.clone()).await;
            // The current epoch is not persisted (the setup state re-derives it), and
            // the pruned epoch's public journal and secret material stay pruned across
            // the restart.
            assert!(store.current().is_none());
            assert!(!store.epochs.contains_key(&Epoch::zero()));
            assert_eq!(secret_store.prunes(), vec![Epoch::new(1)]);
            assert!(!secret_store.has_share(Epoch::zero()));
        });
    }
}

#[cfg(all(test, feature = "arbitrary"))]
mod conformance {
    use super::*;
    use commonware_codec::conformance::CodecConformance;
    use commonware_cryptography::{bls12381::primitives::variant::MinSig, ed25519};

    commonware_conformance::conformance_tests! {
        CodecConformance<Event<MinSig, ed25519::PublicKey>>,
    }
}