Enum spl_governance::state::realm_config::GoverningTokenType

pub enum GoverningTokenType {
    Liquid,
    Membership,
    Dormant,
}

The type of the governing token defines:

1. Who retains the authority over deposited tokens
2. Which token instructions Deposit, Withdraw and Revoke (burn) are allowed

Variants

Liquid

Liquid token is a token which is fully liquid and the token owner retains full authority over it. Deposit - Yes Withdraw - Yes
Revoke - No, Realm authority cannot revoke liquid tokens

Membership

Membership token is a token controlled by Realm authority Deposit - Yes, membership tokens can be deposited to gain governance power. The membership tokens are conventionally minted into the holding account to keep them out of members possession. Withdraw - No, after membership tokens are deposited they are no longer transferable and can’t be withdrawn. Revoke - Yes, Realm authority can Revoke (burn) membership tokens.

Dormant

Dormant token is a token which is only a placeholder and its deposits are not accepted and not used for governance power within the Realm

The Dormant token type is used when only a single voting population is operational. For example a Multisig starter DAO uses Council only and sets Community as Dormant to indicate its not utilized for any governance power. Once the starter DAO decides to decentralise then it can change the Community token to Liquid

Note: When an external voter weight plugin which takes deposits of the token is used then the type should be set to Dormant to make the intention explicit

Deposit - No, dormant tokens can’t be deposited into the Realm Withdraw - Yes, tokens can still be withdrawn from Realm to support scenario where the config is changed while some tokens are still deposited. Revoke - No, Realm authority cannot revoke dormant tokens

Trait Implementations

impl BorshDeserialize for GoverningTokenType

fn deserialize_reader<R: Read>(reader: &mut R) -> Result<Self, Error>

fn deserialize(buf: &mut &[u8]) -> Result<Self, Error>

Deserializes this instance from a given slice of bytes. Updates the buffer to point at the remaining bytes.

fn try_from_slice(v: &[u8]) -> Result<Self, Error>

Deserialize this instance from a slice of bytes.

fn try_from_reader<R>(reader: &mut R) -> Result<Self, Error>

where R: Read,

impl BorshSchema for GoverningTokenType

fn declaration() -> Declaration

Get the name of the type without brackets.

fn add_definitions_recursively( definitions: &mut HashMap<Declaration, Definition> )

Recursively, using DFS, add type definitions required for this type. For primitive types this is an empty map. Type definition explains how to serialize/deserialize a type.

fn add_definition( declaration: String, definition: Definition, definitions: &mut HashMap<String, Definition> )

Helper method to add a single type definition to the map.

fn schema_container() -> BorshSchemaContainer

impl BorshSerialize for GoverningTokenType

fn serialize<W: Write>(&self, writer: &mut W) -> Result<(), Error>

fn try_to_vec(&self) -> Result<Vec<u8>, Error>

Serialize this instance into a vector of bytes.

impl Clone for GoverningTokenType

fn clone(&self) -> GoverningTokenType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GoverningTokenType

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

Formats the value using the given formatter.

impl Default for GoverningTokenType

fn default() -> Self

Returns the “default value” for a type.

impl EnumExt for GoverningTokenType

fn deserialize_variant<R: Read>( reader: &mut R, variant_idx: u8 ) -> Result<Self, Error>

Deserialises given variant of an enum from the reader.

impl PartialEq for GoverningTokenType

fn eq(&self, other: &GoverningTokenType) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for GoverningTokenType

impl StructuralEq for GoverningTokenType

impl StructuralPartialEq for GoverningTokenType