Struct spl_governance::state::realm::Realm

#[repr(C)]
pub struct Realm {
    pub account_type: GovernanceAccountType,
    pub community_mint: Pubkey,
    pub config: RealmConfig,
    pub reserved: [u8; 8],
    pub authority: Option<Pubkey>,
    pub name: String,
}

Governance Realm Account Account PDA seeds“ [‘governance’, name]

Fields

account_type: GovernanceAccountType

Governance account type

community_mint: Pubkey

Community mint

config: RealmConfig

Configuration of the Realm

reserved: [u8; 8]

Reserved space for future versions

authority: Option<Pubkey>

Realm authority. The authority must sign transactions which update the realm config The authority can be transferer to Realm Governance and hence make the Realm self governed through proposals

name: String

Governance Realm name

Implementations

impl Realm

pub fn assert_is_valid_governing_token_mint(
    &self,
    governing_token_mint: &Pubkey
) -> Result<(), ProgramError>

Asserts the given mint is either Community or Council mint of the Realm

pub fn assert_is_valid_governing_token_mint_and_holding(
    &self,
    program_id: &Pubkey,
    realm: &Pubkey,
    governing_token_mint: &Pubkey,
    governing_token_holding: &Pubkey
) -> Result<(), ProgramError>

Asserts the given governing token mint and holding accounts are valid for the realm

Trait Implementations

impl AccountMaxSize for Realm

fn get_max_size(&self) -> Option<usize>

Returns max account size or None if max size is not known and actual instance size should be used

impl BorshDeserialize for Realm where
    GovernanceAccountType: BorshDeserialize,
    Pubkey: BorshDeserialize,
    RealmConfig: BorshDeserialize,
    [u8; 8]: BorshDeserialize,
    Option<Pubkey>: BorshDeserialize,
    String: BorshDeserialize, 

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.

impl BorshSchema for Realm where
    GovernanceAccountType: BorshSchema,
    Pubkey: BorshSchema,
    RealmConfig: BorshSchema,
    [u8; 8]: BorshSchema,
    Option<Pubkey>: BorshSchema,
    String: BorshSchema, 

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, RandomState>
)

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

fn schema_container() -> BorshSchemaContainer

impl BorshSerialize for Realm where
    GovernanceAccountType: BorshSerialize,
    Pubkey: BorshSerialize,
    RealmConfig: BorshSerialize,
    [u8; 8]: BorshSerialize,
    Option<Pubkey>: BorshSerialize,
    String: BorshSerialize, 

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

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

Serialize this instance into a vector of bytes.

impl Clone for Realm

fn clone(&self) -> Realm

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Realm

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

Formats the value using the given formatter.

impl IsInitialized for Realm

fn is_initialized(&self) -> bool

Is initialized

impl PartialEq<Realm> for Realm

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

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

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

This method tests for !=.

impl StructuralPartialEq for Realm