From 8fef631a95746ed061460cd514a29ebf443e51bf Mon Sep 17 00:00:00 2001
From: Amar Singh <asinghchrony@protonmail.com>
Date: Tue, 15 Nov 2022 04:37:12 -0500
Subject: [PATCH] Make public is_passing and ReferendumStatus (#12667)

* init

* clean

* remove manual getter for ReferendumStatus in favor of changing pub crate to pub for ReferendumStatus DecidingStatus Deposit types

* rm status getters because fields are pub now
---
 substrate/frame/referenda/src/lib.rs   | 25 +++++++++++++++++++++
 substrate/frame/referenda/src/types.rs | 30 +++++++++++++-------------
 2 files changed, 40 insertions(+), 15 deletions(-)

diff --git a/substrate/frame/referenda/src/lib.rs b/substrate/frame/referenda/src/lib.rs
index d060c3db3f..ba5f4aec95 100644
--- a/substrate/frame/referenda/src/lib.rs
+++ b/substrate/frame/referenda/src/lib.rs
@@ -701,6 +701,31 @@ impl<T: Config<I>, I: 'static> Pallet<T, I> {
 		}
 	}
 
+	/// Returns whether the referendum is passing.
+	/// Referendum must be ongoing and its track must exist.
+	pub fn is_referendum_passing(ref_index: ReferendumIndex) -> Result<bool, DispatchError> {
+		let info = ReferendumInfoFor::<T, I>::get(ref_index).ok_or(Error::<T, I>::BadReferendum)?;
+		match info {
+			ReferendumInfo::Ongoing(status) => {
+				let track = Self::track(status.track).ok_or(Error::<T, I>::NoTrack)?;
+				let elapsed = if let Some(deciding) = status.deciding {
+					frame_system::Pallet::<T>::block_number().saturating_sub(deciding.since)
+				} else {
+					Zero::zero()
+				};
+				Ok(Self::is_passing(
+					&status.tally,
+					elapsed,
+					track.decision_period,
+					&track.min_support,
+					&track.min_approval,
+					status.track,
+				))
+			},
+			_ => Err(Error::<T, I>::NotOngoing.into()),
+		}
+	}
+
 	// Enqueue a proposal from a referendum which has presumably passed.
 	fn schedule_enactment(
 		index: ReferendumIndex,
diff --git a/substrate/frame/referenda/src/types.rs b/substrate/frame/referenda/src/types.rs
index 48db0847ed..a97faca3bb 100644
--- a/substrate/frame/referenda/src/types.rs
+++ b/substrate/frame/referenda/src/types.rs
@@ -101,16 +101,16 @@ impl<T: Ord, S: Get<u32>> InsertSorted<T> for BoundedVec<T, S> {
 pub struct DecidingStatus<BlockNumber> {
 	/// When this referendum began being "decided". If confirming, then the
 	/// end will actually be delayed until the end of the confirmation period.
-	pub(crate) since: BlockNumber,
+	pub since: BlockNumber,
 	/// If `Some`, then the referendum has entered confirmation stage and will end at
 	/// the block number as long as it doesn't lose its approval in the meantime.
-	pub(crate) confirming: Option<BlockNumber>,
+	pub confirming: Option<BlockNumber>,
 }
 
 #[derive(Encode, Decode, Clone, PartialEq, Eq, RuntimeDebug, TypeInfo, MaxEncodedLen)]
 pub struct Deposit<AccountId, Balance> {
-	pub(crate) who: AccountId,
-	pub(crate) amount: Balance,
+	pub who: AccountId,
+	pub amount: Balance,
 }
 
 #[derive(Clone, Encode, TypeInfo)]
@@ -171,28 +171,28 @@ pub struct ReferendumStatus<
 	ScheduleAddress: Eq + PartialEq + Debug + Encode + Decode + TypeInfo + Clone,
 > {
 	/// The track of this referendum.
-	pub(crate) track: TrackId,
+	pub track: TrackId,
 	/// The origin for this referendum.
-	pub(crate) origin: RuntimeOrigin,
+	pub origin: RuntimeOrigin,
 	/// The hash of the proposal up for referendum.
-	pub(crate) proposal: Call,
+	pub proposal: Call,
 	/// The time the proposal should be scheduled for enactment.
-	pub(crate) enactment: DispatchTime<Moment>,
+	pub enactment: DispatchTime<Moment>,
 	/// The time of submission. Once `UndecidingTimeout` passes, it may be closed by anyone if
 	/// `deciding` is `None`.
-	pub(crate) submitted: Moment,
+	pub submitted: Moment,
 	/// The deposit reserved for the submission of this referendum.
-	pub(crate) submission_deposit: Deposit<AccountId, Balance>,
+	pub submission_deposit: Deposit<AccountId, Balance>,
 	/// The deposit reserved for this referendum to be decided.
-	pub(crate) decision_deposit: Option<Deposit<AccountId, Balance>>,
+	pub decision_deposit: Option<Deposit<AccountId, Balance>>,
 	/// The status of a decision being made. If `None`, it has not entered the deciding period.
-	pub(crate) deciding: Option<DecidingStatus<Moment>>,
+	pub deciding: Option<DecidingStatus<Moment>>,
 	/// The current tally of votes in this referendum.
-	pub(crate) tally: Tally,
+	pub tally: Tally,
 	/// Whether we have been placed in the queue for being decided or not.
-	pub(crate) in_queue: bool,
+	pub in_queue: bool,
 	/// The next scheduled wake-up, if `Some`.
-	pub(crate) alarm: Option<(Moment, ScheduleAddress)>,
+	pub alarm: Option<(Moment, ScheduleAddress)>,
 }
 
 /// Info regarding a referendum, present or past.