Adjust ProposalProcedure following end-to-end testing.

KtorZ · KtorZ · commit b6a3dfd39286 · 2024-08-11T00:51:12.000+02:00
diff --git a/lib/aiken/collection.ak b/lib/aiken/collection.ak
@@ -0,0 +1,4 @@
+/// An positive integer, that materializes the position of an element in a
+/// collection.
+pub type Index =
+  Int
diff --git a/lib/cardano/certificate.ak b/lib/cardano/certificate.ak
@@ -1,8 +1,6 @@
 use cardano/assets.{Lovelace}
-use cardano/credential.{
-  ColdCommitteeCredential, DRepCredential, HotCommitteeCredential, PoolId,
-  StakeCredential, VerificationKeyHash,
-}
+use cardano/credential.{Credential,
+  PoolId, StakeCredential, VerificationKeyHash}
 use cardano/governance.{Delegatee}
 
 /// An on-chain certificate attesting of some operation. Publishing
@@ -29,11 +27,11 @@ pub type Certificate {
     deposit_amount: Lovelace,
   }
   // Register a DRep with a deposit value. The optional anchor is omitted.
-  RegisterDRep { representative: DRepCredential, deposit_amount: Lovelace }
+  RegisterDRep { representative: Credential, deposit_amount: Lovelace }
   // Update a DRep. The optional anchor is omitted.
-  UpdateDRep { representative: DRepCredential }
+  UpdateDRep { representative: Credential }
   // UnRegister a DRep with mandatory refund value
-  UnregisterDRep { representative: DRepCredential, refund_amount: Lovelace }
+  UnregisterDRep { representative: Credential, refund_amount: Lovelace }
   // A digest of the PoolParams
   PoolRegister {
     // poolId
@@ -44,9 +42,6 @@ pub type Certificate {
   // The retirement certificate and the Epoch in which the retirement will take place
   PoolRetire { pool_id: PoolId, epoch: Int }
   // Authorize a Hot credential for a specific Committee member's cold credential
-  AuthorizeHotCommittee {
-    cold_memeber: ColdCommitteeCredential,
-    hot_member: HotCommitteeCredential,
-  }
-  ResignColdCommittee { cold_member: ColdCommitteeCredential }
+  AuthorizeHotCommittee { cold_memeber: Credential, hot_member: Credential }
+  ResignColdCommittee { cold_member: Credential }
 }
diff --git a/lib/cardano/credential.ak b/lib/cardano/credential.ak
@@ -6,8 +6,8 @@ use aiken/hash.{Blake2b_224, Blake2b_256, Hash}
 /// Credentials are always one of two kinds: a direct public/private key
 /// pair, or a script (native or Plutus).
 pub type Credential {
-  VerificationKeyCredential(Hash<Blake2b_224, VerificationKey>)
-  ScriptCredential(Hash<Blake2b_224, Script>)
+  VerificationKey(VerificationKeyHash)
+  Script(ScriptHash)
 }
 
 /// A Cardano `Address` typically holding one or two credential references.
@@ -23,18 +23,12 @@ pub type Address {
 
 /// Smart-constructor for an [Address](#Address) from a [verification key](#VerificationKey) hash. The resulting address has no delegation rights whatsoever.
 pub fn from_verification_key(vk: Hash<Blake2b_224, VerificationKey>) -> Address {
-  Address {
-    payment_credential: VerificationKeyCredential(vk),
-    stake_credential: None,
-  }
+  Address { payment_credential: VerificationKey(vk), stake_credential: None }
 }
 
 /// Smart-constructor for an [Address](#Address) from a [script](#Script) hash. The address has no delegation rights whatsoever.
 pub fn from_script(script: Hash<Blake2b_224, Script>) -> Address {
-  Address {
-    payment_credential: ScriptCredential(script),
-    stake_credential: None,
-  }
+  Address { payment_credential: Script(script), stake_credential: None }
 }
 
 /// Set (or reset) the delegation part of an [Address](#Address) using a [verification key](#VerificationKey) hash. This is useful when combined with [`from_verification_key`](#from_verification_key) and/or [`from_script`](#from_script).
@@ -44,7 +38,7 @@ pub fn with_delegation_key(
 ) -> Address {
   Address {
     payment_credential: self.payment_credential,
-    stake_credential: Some(Inline(VerificationKeyCredential(vk))),
+    stake_credential: Some(Inline(VerificationKey(vk))),
   }
 }
 
@@ -55,7 +49,7 @@ pub fn with_delegation_script(
 ) -> Address {
   Address {
     payment_credential: self.payment_credential,
-    stake_credential: Some(Inline(ScriptCredential(script))),
+    stake_credential: Some(Inline(Script(script))),
   }
 }
 
@@ -119,15 +113,3 @@ pub type ScriptHash =
 // DatumHash is taken as a Datum type so this may just need to change.
 pub type DatumHashDigest =
   Hash<Blake2b_256, Data>
-
-pub type DRepCredential {
-  member: Credential,
-}
-
-pub type ColdCommitteeCredential {
-  member: Credential,
-}
-
-pub type HotCommitteeCredential {
-  member: Credential,
-}
diff --git a/lib/cardano/governance.ak b/lib/cardano/governance.ak
@@ -1,13 +1,10 @@
-use aiken/collection/dict.{Dict}
+use aiken/collection.{Index}
 use aiken/math/rational.{Rational}
 use cardano/assets.{Lovelace}
-use cardano/credential.{
-  ColdCommitteeCredential, Credential, DRepCredential, HotCommitteeCredential,
-  ScriptHash, VerificationKeyHash,
-}
+use cardano/credential.{Credential, ScriptHash, VerificationKeyHash}
 
 pub type DRep {
-  FromCredential(DRepCredential)
+  FromCredential(Credential)
   AlwaysAbstain
   AlwaysNoConfidence
 }
@@ -26,64 +23,97 @@ pub type Vote {
 
 pub type GovernanceActionId {
   transaction_id: ByteArray,
-  index: Int,
+  proposal_procedure: Index,
 }
 
-pub type ChangedProtocolParameters {
-  new_parameters: Data,
-}
+pub type ProtocolParametersUpdate =
+  Data
 
 pub type ProtocolVersion {
   major: Int,
   minor: Int,
 }
 
 pub type Constitution {
-  guardrails_script: Option<ScriptHash>,
+  guardrails: Option<ScriptHash>,
 }
 
 pub type GovernanceAction {
-  //
-  ProtocolParametersChange(
-    Option<GovernanceActionId>,
-    ChangedProtocolParameters,
-    // Hash of the constitution script
-    Option<ScriptHash>,
-  )
-  // proposal to update protocol version
-  HardForkInitiation(Option<GovernanceActionId>, ProtocolVersion)
-  //
-  TreasuryWithdrawals(
-    Dict<Credential, Lovelace>,
-    // Hash of the constitution script
-    Option<ScriptHash>,
-  )
-  //
-  NoConfidence(Option<GovernanceActionId>)
-  //
-  UpdateCommittee(
-    Option<GovernanceActionId>,
-    // Committee members to be removed
-    List<ColdCommitteeCredential>,
-    // Committee members to be added
-    Dict<ColdCommitteeCredential, Int>,
-    // New quorum
-    Rational,
-  )
-  //
-  NewConstitution(Option<GovernanceActionId>, Constitution)
-  //
-  InfoAction
+  ProtocolParameters {
+    /// The last governance action of type 'ProtocolParameters'. They must all
+    /// form a chain.
+    ancestor: Option<GovernanceActionId>,
+    /// The new proposed protocol parameters. Only values set to `Some` are relevant.
+    new_parameters: ProtocolParametersUpdate,
+    /// The optional guardrails script defined in the constitution. The script
+    /// is executed by the ledger in addition to the hard-coded ledger rules.
+    ///
+    /// It must pass for the new protocol parameters to be deemed valid.
+    guardrails: Option<ScriptHash>,
+  }
+  Hardfork {
+    /// The last governance action of type `HardFork`. They must all
+    /// form a chain.
+    ancestor: Option<GovernanceActionId>,
+    /// The new proposed version. Few rules apply to proposing new versions:
+    ///
+    /// - The `major` component, if incremented, must be exactly one more than the current.
+    /// - The `minor` component, if incremented, must be exactly one more than the current.
+    /// - If the `major` component is incremented, `minor` must be set to `0`.
+    /// - Neither `minor` nor `major` can be decremented.
+    new_version: ProtocolVersion,
+  }
+  TreasuryWithdrawal {
+    /// A collection of beneficiaries, which can be plain verification key
+    /// hashes or script hashes (e.g. DAO).
+    beneficiaries: Pairs<Credential, Lovelace>,
+    /// The optional guardrails script defined in the constitution. The script
+    /// is executed by the ledger in addition to the hard-coded ledger rules.
+    ///
+    /// It must pass for the withdrawals to be authorized.
+    guardrails: Option<ScriptHash>,
+  }
+  NoConfidence {
+    /// The last governance action of type `NoConfidence` or
+    /// `ConstitutionalCommittee`. They must all / form a chain.
+    ancestor: Option<GovernanceActionId>,
+  }
+  ConstitutionalCommittee {
+    /// The last governance action of type `NoConfidence` or
+    /// `ConstitutionalCommittee`. They must all / form a chain.
+    ancestor: Option<GovernanceActionId>,
+    /// Constitutional members to be removed.
+    evicted_members: List<Credential>,
+    /// Constitutional members to be added.
+    added_members: Pairs<Credential, Mandate>,
+    /// The new quorum value, as a ratio of a numerator and a denominator. The
+    /// quorum specifies the threshold of 'Yes' votes necessary for the
+    /// constitutional committee to accept a proposal procedure.
+    quorum: Rational,
+  }
+  NewConstitution {
+    /// The last governance action of type `Constitution` or
+    /// `ConstitutionalCommittee`. They must all / form a chain.
+    ancestor: Option<GovernanceActionId>,
+    /// The new proposed constitution.
+    constitution: Constitution,
+  }
+  NicePoll
 }
 
+/// An epoch number after which constitutional committee member
+/// mandate expires.
+pub type Mandate =
+  Int
+
 pub type ProposalProcedure {
   deposit: Lovelace,
   return_address: Credential,
   governance_action: GovernanceAction,
 }
 
 pub type Voter {
-  CommitteeVoter(HotCommitteeCredential)
-  DRepVoter(DRepCredential)
+  CommitteeVoter(Credential)
+  DRepVoter(Credential)
   StakePoolVoter(VerificationKeyHash)
 }
diff --git a/lib/cardano/transaction.ak b/lib/cardano/transaction.ak
@@ -1,4 +1,5 @@
 use aiken/builtin
+use aiken/collection.{Index}
 use aiken/collection/dict.{Dict}
 use aiken/collection/list
 use aiken/hash.{Blake2b_256, Hash, blake2b_256}
@@ -7,16 +8,11 @@ use aiken/option
 use cardano/assets.{Lovelace, PolicyId, Value}
 use cardano/certificate.{Certificate}
 use cardano/credential.{
-  Address, DatumHashDigest, ScriptCredential, ScriptHash, StakeCredential,
-  VerificationKeyCredential, VerificationKeyHash,
+  Address, DatumHashDigest, Script, ScriptHash, StakeCredential, VerificationKey,
+  VerificationKeyHash,
 }
 use cardano/governance.{GovernanceActionId, ProposalProcedure, Vote, Voter}
 
-/// An positive integer, that materializes the position of an element in a
-/// collection.
-type Index =
-  Int
-
 /// A context given to a script by the Cardano ledger when being executed.
 ///
 /// The context contains information about the entire transaction that contains
@@ -103,20 +99,15 @@ pub type Transaction {
   reference_inputs: List<Input>,
   outputs: List<Output>,
   fee: Lovelace,
-  // ^ the fee is now lovelace
   mint: Value,
-  // ^ minted value is now back to a value
   certificates: List<Certificate>,
   withdrawals: Pairs<StakeCredential, Lovelace>,
   validity_range: ValidityRange,
   extra_signatories: List<VerificationKeyHash>,
   redeemers: Pairs<ScriptPurpose, Redeemer>,
-  // ^ Pairs and ScriptPurpose are used here
   datums: Dict<DatumHashDigest, Data>,
   id: Hash<Blake2b_256, Transaction>,
-  // new fields for v3
   votes: Dict<Voter, Dict<GovernanceActionId, Vote>>,
-  // ^ Does this need to be pairs?
   proposal_procedures: List<ProposalProcedure>,
   current_treasury_amount: Option<Lovelace>,
   treasury_donation: Option<Lovelace>,
@@ -268,9 +259,8 @@ pub fn find_script_outputs(
     |> list.filter(
         fn(output) {
           when output.address.payment_credential is {
-            ScriptCredential(addr_script_hash) ->
-              script_hash == addr_script_hash
-            VerificationKeyCredential(_) -> False
+            Script(addr_script_hash) -> script_hash == addr_script_hash
+            VerificationKey(_) -> False
           }
         },
       )
