Enum spl_governance::instruction::GovernanceInstruction

#[repr(C)]
pub enum GovernanceInstruction {
    CreateRealm {
        name: String,
    },
    DepositGoverningTokens {},
    WithdrawGoverningTokens {},
    SetGovernanceDelegate {
        new_governance_delegate: Option<Pubkey>,
    },
    CreateAccountGovernance {
        config: GovernanceConfig,
    },
    CreateProgramGovernance {
        config: GovernanceConfig,
        transfer_upgrade_authority: bool,
    },
    CreateProposal {
        name: String,
        description_link: String,
        governing_token_mint: Pubkey,
    },
    AddSignatory {
        signatory: Pubkey,
    },
    RemoveSignatory {
        signatory: Pubkey,
    },
    InsertInstruction {
        index: u16,
        hold_up_time: u32,
        instruction: InstructionData,
    },
    RemoveInstruction,
    CancelProposal,
    SignOffProposal,
    CastVote {
        vote: Vote,
    },
    FinalizeVote {},
    RelinquishVote,
    ExecuteInstruction,
    CreateMintGovernance {
        config: GovernanceConfig,
        transfer_mint_authority: bool,
    },
    CreateTokenGovernance {
        config: GovernanceConfig,
        transfer_token_owner: bool,
    },
    SetGovernanceConfig {
        config: GovernanceConfig,
    },
}

Instructions supported by the Governance program

Variants

CreateRealm

Creates Governance Realm account which aggregates governances for given Community Mint and optional Council Mint

0. [writable] Governance Realm account. PDA seeds:[‘governance’,name]
1. [] Community Token Mint
2. [writable] Community Token Holding account. PDA seeds: [‘governance’,realm,community_mint] The account will be created with the Realm PDA as its owner
3. [signer] Payer
4. [] System
5. [] SPL Token
6. [] Sysvar Rent
7. [] Council Token Mint - optional
8. [writable] Council Token Holding account - optional. . PDA seeds: [‘governance’,realm,council_mint] The account will be created with the Realm PDA as its owner

Fields of CreateRealm

name: String

UTF-8 encoded Governance Realm name

DepositGoverningTokens

Deposits governing tokens (Community or Council) to Governance Realm and establishes your voter weight to be used for voting within the Realm Note: If subsequent (top up) deposit is made and there are active votes for the Voter then the vote weights won’t be updated automatically It can be done by relinquishing votes on active Proposals and voting again with the new weight

0. [] Governance Realm account
1. [writable] Governing Token Holding account. PDA seeds: [‘governance’,realm, governing_token_mint]
2. [writable] Governing Token Source account. All tokens from the account will be transferred to the Holding account
3. [signer] Governing Token Owner account
4. [signer] Governing Token Transfer authority
5. [writable] Token Owner Record account. PDA seeds: [‘governance’,realm, governing_token_mint, governing_token_owner]
6. [signer] Payer
7. [] System
8. [] SPL Token
9. [] Sysvar Rent

Fields of DepositGoverningTokens

WithdrawGoverningTokens

Withdraws governing tokens (Community or Council) from Governance Realm and downgrades your voter weight within the Realm Note: It’s only possible to withdraw tokens if the Voter doesn’t have any outstanding active votes If there are any outstanding votes then they must be relinquished before tokens could be withdrawn

0. [] Governance Realm account
1. [writable] Governing Token Holding account. PDA seeds: [‘governance’,realm, governing_token_mint]
2. [writable] Governing Token Destination account. All tokens will be transferred to this account
3. [signer] Governing Token Owner account
4. [writable] Token Owner Record account. PDA seeds: [‘governance’,realm, governing_token_mint, governing_token_owner]
5. [] SPL Token

Fields of WithdrawGoverningTokens

SetGovernanceDelegate

Sets Governance Delegate for the given Realm and Governing Token Mint (Community or Council) The Delegate would have voting rights and could vote on behalf of the Governing Token Owner The Delegate would also be able to create Proposals on behalf of the Governing Token Owner Note: This doesn’t take voting rights from the Token Owner who still can vote and change governance_delegate

0. [signer] Current Governance Delegate or Governing Token owner
1. [writable] Token Owner Record

Fields of SetGovernanceDelegate

new_governance_delegate: Option<Pubkey>

New Governance Delegate

CreateAccountGovernance

Creates Account Governance account which can be used to govern an arbitrary account

0. [] Realm account the created Governance belongs to
1. [writable] Account Governance account. PDA seeds: [‘account-governance’, realm, governed_account]
2. [signer] Payer
3. [] System program
4. [] Sysvar Rent

Fields of CreateAccountGovernance

config: GovernanceConfig

Governance config

CreateProgramGovernance

Creates Program Governance account which governs an upgradable program

0. [] Realm account the created Governance belongs to
1. [writable] Program Governance account. PDA seeds: [‘program-governance’, realm, governed_program]
2. [writable] Program Data account of the Program governed by this Governance account
3. [signer] Current Upgrade Authority account of the Program governed by this Governance account
4. [signer] Payer
5. [] bpf_upgradeable_loader program
6. [] System program
7. [] Sysvar Rent

Fields of CreateProgramGovernance

config: GovernanceConfig

Governance config

transfer_upgrade_authority: bool

Indicates whether Program’s upgrade_authority should be transferred to the Governance PDA If it’s set to false then it can be done at a later time However the instruction would validate the current upgrade_authority signed the transaction nonetheless

CreateProposal

Creates Proposal account for Instructions that will be executed at some point in the future

0. [writable] Proposal account. PDA seeds [‘governance’,governance, governing_token_mint, proposal_index]
1. [writable] Governance account
2. [] TokenOwnerRecord account for Proposal owner
3. [signer] Governance Authority (Token Owner or Governance Delegate)
4. [signer] Payer
5. [] System program
6. [] Rent sysvar
7. [] Clock sysvar

Fields of CreateProposal

name: String

UTF-8 encoded name of the proposal

description_link: String

Link to gist explaining proposal

governing_token_mint: Pubkey

Governing Token Mint the Proposal is created for

AddSignatory

Adds a signatory to the Proposal which means this Proposal can’t leave Draft state until yet another Signatory signs

0. [writable] Proposal account
1. [] TokenOwnerRecord account for Proposal owner
2. [signer] Governance Authority (Token Owner or Governance Delegate)
3. [writable] Signatory Record Account
4. [signer] Payer
5. [] System program
6. [] Rent sysvar

Fields of AddSignatory

signatory: Pubkey

Signatory to add to the Proposal

RemoveSignatory

Removes a Signatory from the Proposal

0. [writable] Proposal account
1. [] TokenOwnerRecord account for Proposal owner
2. [signer] Governance Authority (Token Owner or Governance Delegate)
3. [writable] Signatory Record Account
4. [writable] Beneficiary Account which would receive lamports from the disposed Signatory Record Account

Fields of RemoveSignatory

signatory: Pubkey

Signatory to remove from the Proposal

InsertInstruction

Inserts an instruction for the Proposal at the given index position New Instructions must be inserted at the end of the range indicated by Proposal instructions_next_index If an Instruction replaces an existing Instruction at a given index then the old one must be removed using RemoveInstruction first 0. [] Governance account

1. [writable] Proposal account
2. [] TokenOwnerRecord account for Proposal owner
3. [signer] Governance Authority (Token Owner or Governance Delegate)
4. [writable] ProposalInstruction account. PDA seeds: [‘governance’,proposal,index]
5. [signer] Payer
6. [] System program
7. [] Clock sysvar

Fields of InsertInstruction

index: u16

Instruction index to be inserted at.

hold_up_time: u32

Waiting time (in seconds) between vote period ending and this being eligible for execution

instruction: InstructionData

Instruction Data

RemoveInstruction

Removes instruction from the Proposal

0. [writable] Proposal account
1. [] TokenOwnerRecord account for Proposal owner
2. [signer] Governance Authority (Token Owner or Governance Delegate)
3. [writable] ProposalInstruction account
4. [writable] Beneficiary Account which would receive lamports from the disposed ProposalInstruction account

CancelProposal

Cancels Proposal by changing its state to Canceled

0. [writable] Proposal account
1. [] TokenOwnerRecord account for Proposal owner 2 [signer] Governance Authority (Token Owner or Governance Delegate)
2. [] Clock sysvar

SignOffProposal

Signs off Proposal indicating the Signatory approves the Proposal When the last Signatory signs the Proposal state moves to Voting state

0. [writable] Proposal account
1. [writable] Signatory Record account
2. [signer] Signatory account
3. [] Clock sysvar

CastVote

Uses your voter weight (deposited Community or Council tokens) to cast a vote on a Proposal By doing so you indicate you approve or disapprove of running the Proposal set of instructions If you tip the consensus then the instructions can begin to be run after their hold up time

0. [] Governance account
1. [writable] Proposal account
2. [writable] Token Owner Record account. PDA seeds: [‘governance’,realm, governing_token_mint, governing_token_owner]
3. [signer] Governance Authority (Token Owner or Governance Delegate)
4. [writable] Proposal VoteRecord account. PDA seeds: [‘governance’,proposal,governing_token_owner_record]
5. [] Governing Token Mint
6. [signer] Payer
7. [] System program
8. [] Rent sysvar
9. [] Clock sysvar

Fields of CastVote

vote: Vote

Yes/No vote

FinalizeVote

Finalizes vote in case the Vote was not automatically tipped within max_voting_time period

0. [] Governance account
1. [writable] Proposal account
2. [] Governing Token Mint
3. [] Clock sysvar

Fields of FinalizeVote

RelinquishVote

Relinquish Vote removes voter weight from a Proposal and removes it from voter’s active votes If the Proposal is still being voted on then the voter’s weight won’t count towards the vote outcome If the Proposal is already in decided state then the instruction has no impact on the Proposal and only allows voters to prune their outstanding votes in case they wanted to withdraw Governing tokens from the Realm

0. [] Governance account
1. [writable] Proposal account
2. [writable] TokenOwnerRecord account. PDA seeds: [‘governance’,realm, governing_token_mint, governing_token_owner]
3. [writable] Proposal VoteRecord account. PDA seeds: [‘governance’,proposal,governing_token_owner_record]
4. [] Governing Token Mint
5. [signer] Optional Governance Authority (Token Owner or Governance Delegate) It’s required only when Proposal is still being voted on
6. [writable] Optional Beneficiary account which would receive lamports when VoteRecord Account is disposed It’s required only when Proposal is still being voted on

ExecuteInstruction

Executes an instruction in the Proposal Anybody can execute transaction once Proposal has been voted Yes and transaction_hold_up time has passed The actual instruction being executed will be signed by Governance PDA the Proposal belongs to For example to execute Program upgrade the ProgramGovernance PDA would be used as the singer

0. [writable] Proposal account
1. [writable] ProposalInstruction account you wish to execute
2. [] Clock sysvar 3+ Any extra accounts that are part of the instruction, in order

CreateMintGovernance

Creates Mint Governance account which governs a mint

0. [] Realm account the created Governance belongs to
1. [writable] Mint Governance account. PDA seeds: [‘mint-governance’, realm, governed_mint]
2. [writable] Mint governed by this Governance account
3. [signer] Current Mint Authority
4. [signer] Payer
5. [] SPL Token program
6. [] System program
7. [] Sysvar Rent

Fields of CreateMintGovernance

config: GovernanceConfig

Governance config

transfer_mint_authority: bool

Indicates whether Mint’s authority should be transferred to the Governance PDA If it’s set to false then it can be done at a later time However the instruction would validate the current mint authority signed the transaction nonetheless

CreateTokenGovernance

Creates Token Governance account which governs a token account

0. [] Realm account the created Governance belongs to
1. [writable] Token Governance account. PDA seeds: [‘token-governance’, realm, governed_token]
2. [writable] Token account governed by this Governance account
3. [signer] Current Token account owner
4. [signer] Payer
5. [] SPL Token program
6. [] System program
7. [] Sysvar Rent

Fields of CreateTokenGovernance

config: GovernanceConfig

Governance config

transfer_token_owner: bool

Indicates whether token owner should be transferred to the Governance PDA If it’s set to false then it can be done at a later time However the instruction would validate the current token owner signed the transaction nonetheless

SetGovernanceConfig

Sets GovernanceConfig for a Governance

0. [] Realm account the Governance account belongs to
1. [writable, signer] The Governance account the config is for

Fields of SetGovernanceConfig

config: GovernanceConfig

New governance config

Trait Implementations

impl BorshDeserialize for GovernanceInstruction where
    String: BorshDeserialize,
    Option<Pubkey>: BorshDeserialize,
    GovernanceConfig: BorshDeserialize,
    GovernanceConfig: BorshDeserialize,
    bool: BorshDeserialize,
    String: BorshDeserialize,
    String: BorshDeserialize,
    Pubkey: BorshDeserialize,
    Pubkey: BorshDeserialize,
    Pubkey: BorshDeserialize,
    u16: BorshDeserialize,
    u32: BorshDeserialize,
    InstructionData: BorshDeserialize,
    Vote: BorshDeserialize,
    GovernanceConfig: BorshDeserialize,
    bool: BorshDeserialize,
    GovernanceConfig: BorshDeserialize,
    bool: BorshDeserialize,
    GovernanceConfig: 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.

unsafe fn is_u8() -> bool

Whether Self is u8. NOTE: Vec<u8> is the most common use-case for serialization and deserialization, it’s worth handling it as a special case to improve performance. It’s a workaround for specific Vec<u8> implementation versus generic Vec<T> implementation. See https://github.com/rust-lang/rfcs/pull/1210 for details.

impl BorshSchema for GovernanceInstruction

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 GovernanceInstruction where
    String: BorshSerialize,
    Option<Pubkey>: BorshSerialize,
    GovernanceConfig: BorshSerialize,
    GovernanceConfig: BorshSerialize,
    bool: BorshSerialize,
    String: BorshSerialize,
    String: BorshSerialize,
    Pubkey: BorshSerialize,
    Pubkey: BorshSerialize,
    Pubkey: BorshSerialize,
    u16: BorshSerialize,
    u32: BorshSerialize,
    InstructionData: BorshSerialize,
    Vote: BorshSerialize,
    GovernanceConfig: BorshSerialize,
    bool: BorshSerialize,
    GovernanceConfig: BorshSerialize,
    bool: BorshSerialize,
    GovernanceConfig: 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.

unsafe fn is_u8() -> bool

Whether Self is u8. NOTE: Vec<u8> is the most common use-case for serialization and deserialization, it’s worth handling it as a special case to improve performance. It’s a workaround for specific Vec<u8> implementation versus generic Vec<T> implementation. See https://github.com/rust-lang/rfcs/pull/1210 for details.

impl Clone for GovernanceInstruction

fn clone(&self) -> GovernanceInstruction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GovernanceInstruction

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

Formats the value using the given formatter.

impl PartialEq<GovernanceInstruction> for GovernanceInstruction

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

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

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

This method tests for !=.

impl StructuralPartialEq for GovernanceInstruction