rustdoc

Signed-off-by: Nikolaos Dymitriadis <[email protected]>
input-output-hk · Jan 9, 2025 · 58f9a14 · 58f9a14
1 parent a676482
commit 58f9a14
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/toolkit/offchain/src/update_governance/mod.rs b/toolkit/offchain/src/update_governance/mod.rs
@@ -1,3 +1,10 @@
+//! Building and submitting of the transaction that changes the current governance authority
+//!
+//! The transaction:
+//! 1. Burns the previous governance UTXO from the version oracle validator address
+//! 2. Mints exactly 1 multi-sig policy token as authentication
+//! 3. Produces a new governance UTXO at the version oracle validator address with a version oracle
+//!    Plutus datum attached that contains the script ID (32) and policy hash.
 use crate::{
 	await_tx::AwaitTx,
 	csl::{