Skip to content

Commit

Permalink
Added documentation for RatifyState
Browse files Browse the repository at this point in the history
Co-authored-by: Alexey Kuleshevich <[email protected]>
  • Loading branch information
Soupstraw and lehins committed Nov 19, 2024
1 parent 8a090f2 commit 1e926d2
Showing 1 changed file with 9 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -266,11 +266,20 @@ instance EraPParams era => NoThunks (EnactState era)

-- ========================================

-- | `RatifyState` stores information about what will happen to the active
-- governance actions at the next epoch boundary.
data RatifyState era = RatifyState
{ rsEnactState :: !(EnactState era)
, rsEnacted :: !(Seq (GovActionState era))
-- ^ Governance actions that are going to be enacted at the next epoch
-- boundary.
, rsExpired :: !(Set (GovActionId (EraCrypto era)))
-- ^ Governance actions that are going to be removed at the next epoch
-- boundary, either due to expiring or because they would become invalid
-- after another governance action gets enacted or expired before it
, rsDelayed :: !Bool
-- ^ True if all the governance actions will get delayed by one epoch at the
-- next epoch boundary
}
deriving (Generic)

Expand Down

0 comments on commit 1e926d2

Please sign in to comment.