chunky_dkg_config_seqnum - [devnet]

ChunkyDKG stall recovery utils.

When ChunkyDKG or SecretShareManager is stuck due to a bug, the chain may be stuck. Below is the recovery procedure.

1. Ensure more than 2/3 stakes are stuck at the same version.
2. Every validator restarts with chunky_dkg_override_seq_num set to X+1 in the node config file, where X is the current ChunkyDKGConfigSeqNum on chain.
3. The chain should then be unblocked.
4. Once the bug is fixed and the binary + framework have been patched, a governance proposal is needed to set ChunkyDKGConfigSeqNum to be X+2.

use 0x1::config_buffer;
use 0x1::system_addresses;

Constants

The new sequence number must be strictly greater than the current one.

const E_SEQ_NUM_MUST_INCREASE: u64 = 1;

Resources

ChunkyDKGConfigSeqNum

If this seqnum is smaller than a validator local override, the on-chain ChunkyDKGConfig will be ignored. Useful in a chain recovery from ChunkyDKG stall.

struct ChunkyDKGConfigSeqNum has drop, store, key

Fields

seq_num: u64

Functions

set_for_next_epoch

Update ChunkyDKGConfigSeqNum. Used when re-enabling ChunkyDKG after an emergency disable via local override. The new seq_num must be strictly greater than the current on-chain value.

public fun set_for_next_epoch(framework: &signer, seq_num: u64)

Implementation

public fun set_for_next_epoch(framework: &signer, seq_num: u64) acquires ChunkyDKGConfigSeqNum {
    system_addresses::assert_aptos_framework(framework);
    if (exists<ChunkyDKGConfigSeqNum>(@aptos_framework)) {
        let current = borrow_global<ChunkyDKGConfigSeqNum>(@aptos_framework).seq_num;
        assert!(seq_num > current, E_SEQ_NUM_MUST_INCREASE);
    };
    config_buffer::upsert(ChunkyDKGConfigSeqNum { seq_num });
}

initialize

Initialize the configuration. Used in genesis or governance.

public fun initialize(framework: &signer)

Implementation

public fun initialize(framework: &signer) {
    system_addresses::assert_aptos_framework(framework);
    if (!exists<ChunkyDKGConfigSeqNum>(@aptos_framework)) {
        move_to(framework, ChunkyDKGConfigSeqNum { seq_num: 0 })
    }
}

on_new_epoch

Only used in reconfigurations to apply the pending ChunkyDKGConfigSeqNum, if there is any.

public(friend) fun on_new_epoch(framework: &signer)

Implementation

public(friend) fun on_new_epoch(framework: &signer) acquires ChunkyDKGConfigSeqNum {
    system_addresses::assert_aptos_framework(framework);
    if (config_buffer::does_exist<ChunkyDKGConfigSeqNum>()) {
        let new_config = config_buffer::extract_v2<ChunkyDKGConfigSeqNum>();
        if (exists<ChunkyDKGConfigSeqNum>(@aptos_framework)) {
            *borrow_global_mut<ChunkyDKGConfigSeqNum>(@aptos_framework) = new_config;
        } else {
            move_to(framework, new_config);
        }
    }
}

Specification

on_new_epoch

public(friend) fun on_new_epoch(framework: &signer)

requires @aptos_framework == std::signer::address_of(framework);
include config_buffer::OnNewEpochRequirement<ChunkyDKGConfigSeqNum>;
aborts_if false;