Struct governance_os_pallet_conviction_voting::ProposalState

pub struct ProposalState<AccountId, Balance, BlockNumber, CurrencyId> {
    pub parameters: VotingParameters<BlockNumber, CurrencyId>,
    pub created_on: BlockNumber,
    pub convictions: Vec<(AccountId, BlockNumber, Conviction<Balance>)>,
    pub conviction_for: Balance,
    pub conviction_against: Balance,
    pub snapshot: ConvictionSnapshot<Balance>,
}

Fields

parameters: VotingParameters<BlockNumber, CurrencyId>

Parameters that this proposal was created with.

created_on: BlockNumber

Record when the proposal was created. Used to know when it is expired (when the ttl is over).

convictions: Vec<(AccountId, BlockNumber, Conviction<Balance>)>

Conviction votes on this proposal.

conviction_for: Balance

How much tokens are staked in favor of the proposal.

conviction_against: Balance

How much tokens are staked against the proposal.

snapshot: ConvictionSnapshot<Balance>

Snapshot of our different conviction records. Used to compute the current conviction progressively.

Implementations

impl<AccountId: Clone, Balance: Copy + BaseArithmetic, BlockNumber: Copy + BaseArithmetic, CurrencyId> ProposalState<AccountId, Balance, BlockNumber, CurrencyId>

pub fn mutate_conviction_snapshot(
    &mut self,
    now: BlockNumber,
    decay: Balance
) -> DispatchResult

Compute the current amount of conviction for or against the proposal and save its latest value in the proposal state. now should be the current block number. decay is the decay variable of the half life exponential formula.

Refer to this work from EthParis. Also view this 1Hive thread.

Trait Implementations

impl<AccountId: Clone, Balance: Clone, BlockNumber: Clone, CurrencyId: Clone> Clone for ProposalState<AccountId, Balance, BlockNumber, CurrencyId>

fn clone(&self) -> ProposalState<AccountId, Balance, BlockNumber, CurrencyId>

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<AccountId, Balance, BlockNumber, CurrencyId> Debug for ProposalState<AccountId, Balance, BlockNumber, CurrencyId> where
    AccountId: Debug,
    Balance: Debug,
    BlockNumber: Debug,
    CurrencyId: Debug, 

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<AccountId, Balance, BlockNumber, CurrencyId> Decode for ProposalState<AccountId, Balance, BlockNumber, CurrencyId> where
    VotingParameters<BlockNumber, CurrencyId>: Decode,
    VotingParameters<BlockNumber, CurrencyId>: Decode,
    BlockNumber: Decode,
    BlockNumber: Decode,
    Vec<(AccountId, BlockNumber, Conviction<Balance>)>: Decode,
    Vec<(AccountId, BlockNumber, Conviction<Balance>)>: Decode,
    Balance: Decode,
    Balance: Decode,
    Balance: Decode,
    Balance: Decode,
    ConvictionSnapshot<Balance>: Decode,
    ConvictionSnapshot<Balance>: Decode, 

fn decode<__CodecInputEdqy: Input>(
    __codec_input_edqy: &mut __CodecInputEdqy
) -> Result<Self, Error>

Attempt to deserialise the value from input.

pub fn skip<I>(input: &mut I) -> Result<(), Error> where
    I: Input, 

Attempt to skip the encoded value from input.

pub fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl<AccountId: Default, Balance: Default, BlockNumber: Default, CurrencyId: Default> Default for ProposalState<AccountId, Balance, BlockNumber, CurrencyId>

fn default() -> ProposalState<AccountId, Balance, BlockNumber, CurrencyId>

Returns the “default value” for a type.

impl<'de, AccountId, Balance, BlockNumber, CurrencyId> Deserialize<'de> for ProposalState<AccountId, Balance, BlockNumber, CurrencyId> where
    AccountId: Deserialize<'de>,
    Balance: Deserialize<'de>,
    BlockNumber: Deserialize<'de>,
    CurrencyId: Deserialize<'de>, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<AccountId, Balance, BlockNumber, CurrencyId> Encode for ProposalState<AccountId, Balance, BlockNumber, CurrencyId> where
    VotingParameters<BlockNumber, CurrencyId>: Encode,
    VotingParameters<BlockNumber, CurrencyId>: Encode,
    BlockNumber: Encode,
    BlockNumber: Encode,
    Vec<(AccountId, BlockNumber, Conviction<Balance>)>: Encode,
    Vec<(AccountId, BlockNumber, Conviction<Balance>)>: Encode,
    Balance: Encode,
    Balance: Encode,
    Balance: Encode,
    Balance: Encode,
    ConvictionSnapshot<Balance>: Encode,
    ConvictionSnapshot<Balance>: Encode, 

fn encode_to<__CodecOutputEdqy: Output + ?Sized>(
    &self,
    __codec_dest_edqy: &mut __CodecOutputEdqy
)

Convert self to a slice and append it to the destination.

pub fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

pub fn encode(&self) -> Vec<u8, Global>

Convert self to an owned vector.

pub fn using_encoded<R, F>(&self, f: F) -> R where
    F: FnOnce(&[u8]) -> R, 

Convert self to a slice and then invoke the given closure with it.

pub fn encoded_size(&self) -> usize

Calculates the encoded size.

impl<AccountId: PartialEq, Balance: PartialEq, BlockNumber: PartialEq, CurrencyId: PartialEq> PartialEq<ProposalState<AccountId, Balance, BlockNumber, CurrencyId>> for ProposalState<AccountId, Balance, BlockNumber, CurrencyId>

fn eq(
    &self,
    other: &ProposalState<AccountId, Balance, BlockNumber, CurrencyId>
) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(
    &self,
    other: &ProposalState<AccountId, Balance, BlockNumber, CurrencyId>
) -> bool

This method tests for !=.

impl<AccountId, Balance, BlockNumber, CurrencyId> Serialize for ProposalState<AccountId, Balance, BlockNumber, CurrencyId> where
    AccountId: Serialize,
    Balance: Serialize,
    BlockNumber: Serialize,
    CurrencyId: Serialize, 

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<T: Config> StorageMap<<T as Config>::Hash, ProposalState<<T as Config>::AccountId, <<T as Config>::Currencies as Currencies<<T as Config>::AccountId>>::Balance, <T as Config>::BlockNumber, <<T as Config>::Currencies as Currencies<<T as Config>::AccountId>>::CurrencyId>> for Proposals<T>

type Query = ProposalState<<T as Config>::AccountId, <<T as Config>::Currencies as Currencies<<T as Config>::AccountId>>::Balance, <T as Config>::BlockNumber, <<T as Config>::Currencies as Currencies<<T as Config>::AccountId>>::CurrencyId>

The type that get/take returns.

type Hasher = Blake2_128Concat

Hasher. Used for generating final key.

fn module_prefix() -> &'static [u8]

Module prefix. Used for generating final key.

fn storage_prefix() -> &'static [u8]

Storage prefix. Used for generating final key.

fn from_optional_value_to_query(
    v: Option<ProposalState<<T as Config>::AccountId, <<T as Config>::Currencies as Currencies<<T as Config>::AccountId>>::Balance, <T as Config>::BlockNumber, <<T as Config>::Currencies as Currencies<<T as Config>::AccountId>>::CurrencyId>>
) -> Self::Query

Convert an optional value retrieved from storage to the type queried.

fn from_query_to_optional_value(
    v: Self::Query
) -> Option<ProposalState<<T as Config>::AccountId, <<T as Config>::Currencies as Currencies<<T as Config>::AccountId>>::Balance, <T as Config>::BlockNumber, <<T as Config>::Currencies as Currencies<<T as Config>::AccountId>>::CurrencyId>>

Convert a query to an optional value into storage.

pub fn prefix_hash() -> Vec<u8, Global>

The full prefix; just the hash of module_prefix concatenated to the hash of storage_prefix.

pub fn storage_map_final_key<KeyArg>(key: KeyArg) -> Vec<u8, Global> where
    KeyArg: EncodeLike<K>, 

Generate the full key used in top storage.

impl<T: Config> StoragePrefixedMap<ProposalState<<T as Config>::AccountId, <<T as Config>::Currencies as Currencies<<T as Config>::AccountId>>::Balance, <T as Config>::BlockNumber, <<T as Config>::Currencies as Currencies<<T as Config>::AccountId>>::CurrencyId>> for Proposals<T>

fn module_prefix() -> &'static [u8]

Module prefix. Used for generating final key.

fn storage_prefix() -> &'static [u8]

Storage prefix. Used for generating final key.

pub fn final_prefix() -> [u8; 32]

Final full prefix that prefixes all keys.

pub fn remove_all()

Remove all value of the storage.

pub fn iter_values() -> PrefixIterator<Value>

Iter over all value of the storage.

pub fn translate_values<OldValue, F>(f: F) where
    F: FnMut(OldValue) -> Option<Value>,
    OldValue: Decode, 

Translate the values of all elements by a function f, in the map in no particular order. By returning None from f for an element, you’ll remove it from the map.

impl<AccountId, Balance, BlockNumber, CurrencyId> EncodeLike<ProposalState<AccountId, Balance, BlockNumber, CurrencyId>> for ProposalState<AccountId, Balance, BlockNumber, CurrencyId> where
    VotingParameters<BlockNumber, CurrencyId>: Encode,
    VotingParameters<BlockNumber, CurrencyId>: Encode,
    BlockNumber: Encode,
    BlockNumber: Encode,
    Vec<(AccountId, BlockNumber, Conviction<Balance>)>: Encode,
    Vec<(AccountId, BlockNumber, Conviction<Balance>)>: Encode,
    Balance: Encode,
    Balance: Encode,
    Balance: Encode,
    Balance: Encode,
    ConvictionSnapshot<Balance>: Encode,
    ConvictionSnapshot<Balance>: Encode, 

impl<AccountId: Eq, Balance: Eq, BlockNumber: Eq, CurrencyId: Eq> Eq for ProposalState<AccountId, Balance, BlockNumber, CurrencyId>

impl<AccountId, Balance, BlockNumber, CurrencyId> StructuralEq for ProposalState<AccountId, Balance, BlockNumber, CurrencyId>

impl<AccountId, Balance, BlockNumber, CurrencyId> StructuralPartialEq for ProposalState<AccountId, Balance, BlockNumber, CurrencyId>