Enum spl_governance::instruction::GovernanceInstruction

#[repr(C)]
pub enum GovernanceInstruction {
    CreateRealm {
        name: String,
        config_args: RealmConfigArgs,
    },
    DepositGoverningTokens {
        amount: u64,
    },
    WithdrawGoverningTokens {},
    SetGovernanceDelegate {
        new_governance_delegate: Option<Pubkey>,
    },
    CreateGovernance {
        config: GovernanceConfig,
    },
    CreateProgramGovernance {
        config: GovernanceConfig,
        transfer_upgrade_authority: bool,
    },
    CreateProposal {
        name: String,
        description_link: String,
        vote_type: VoteType,
        options: Vec<String>,
        use_deny_option: bool,
    },
    AddSignatory {
        signatory: Pubkey,
    },
    RemoveSignatory {
        signatory: Pubkey,
    },
    InsertTransaction {
        option_index: u8,
        index: u16,
        hold_up_time: u32,
        instructions: Vec<InstructionData>,
    },
    RemoveTransaction,
    CancelProposal,
    SignOffProposal,
    CastVote {
        vote: Vote,
    },
    FinalizeVote {},
    RelinquishVote,
    ExecuteTransaction,
    CreateMintGovernance {
        config: GovernanceConfig,
        transfer_mint_authorities: bool,
    },
    CreateTokenGovernance {
        config: GovernanceConfig,
        transfer_account_authorities: bool,
    },
    SetGovernanceConfig {
        config: GovernanceConfig,
    },
    FlagTransactionError,
    SetRealmAuthority {
        action: SetRealmAuthorityAction,
    },
    SetRealmConfig {
        config_args: RealmConfigArgs,
    },
    CreateTokenOwnerRecord {},
    UpdateProgramMetadata {},
    CreateNativeTreasury,
}

Instructions supported by the Governance program

Variants

CreateRealm

Fields

name: String

UTF-8 encoded Governance Realm name

config_args: RealmConfigArgs

Realm config args

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. [] Realm authority
2. [] Community Token Mint
3. [writable] Community Token Holding account. PDA seeds: [‘governance’,realm,community_mint] The account will be created with the Realm PDA as its owner
4. [signer] Payer
5. [] System
6. [] SPL Token
7. [] Sysvar Rent
8. [] Council Token Mint - optional
9. [writable] Council Token Holding account - optional unless council is used. PDA seeds: [‘governance’,realm,council_mint] The account will be created with the Realm PDA as its owner
10. [] Optional Community Voter Weight Addin Program Id
11. [] Optional Max Community Voter Weight Addin Program Id
12. [writable] Optional RealmConfig account. PDA seeds: [‘realm-config’, realm]

DepositGoverningTokens

Fields

amount: u64

The amount to deposit into the realm

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

WithdrawGoverningTokens

Fields

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

SetGovernanceDelegate

Fields

new_governance_delegate: Option<Pubkey>

New Governance Delegate

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

CreateGovernance

Fields

config: GovernanceConfig

Governance config

Creates Governance account which can be used to govern any arbitrary Solana account or asset

0. [] Realm account the created Governance belongs to
1. [writable] Account Governance account. PDA seeds: [‘account-governance’, realm, governed_account]
2. [] Account governed by this Governance Note: The account doesn’t have to exist and can be only used as a unique identifier for the Governance account
3. [] Governing TokenOwnerRecord account (Used only if not signed by RealmAuthority)
4. [signer] Payer
5. [] System program
6. [] Sysvar Rent
7. [signer] Governance authority
8. [] Realm Config
9. [] Optional Voter Weight Record

CreateProgramGovernance

Fields

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

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. [] Program governed by this Governance account
3. [writable] Program Data account of the Program governed by this Governance account
4. [signer] Current Upgrade Authority account of the Program governed by this Governance account
5. [] Governing TokenOwnerRecord account (Used only if not signed by RealmAuthority)
6. [signer] Payer
7. [] bpf_upgradeable_loader program
8. [] System program
9. [] Sysvar Rent
10. [signer] Governance authority
11. [] Realm Config
12. [] Optional Voter Weight Record

CreateProposal

Fields

name: String

UTF-8 encoded name of the proposal

description_link: String

Link to a gist explaining the proposal

vote_type: VoteType

Proposal vote type

options: Vec<String>

Proposal options

use_deny_option: bool

Indicates whether the proposal has the deny option A proposal without the rejecting option is a non binding survey Only proposals with the rejecting option can have executable transactions

Creates Proposal account for Transactions which will be executed at some point in the future

0. [] Realm account the created Proposal belongs to
1. [writable] Proposal account. PDA seeds [‘governance’,governance, governing_token_mint, proposal_index]
2. [writable] Governance account
3. [writable] TokenOwnerRecord account of the Proposal owner
4. [] Governing Token Mint the Proposal is created for
5. [signer] Governance Authority (Token Owner or Governance Delegate)
6. [signer] Payer
7. [] System program
8. [] Realm Config
9. [] Optional Voter Weight Record

AddSignatory

Fields

signatory: Pubkey

Signatory to add to the Proposal

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 of the 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

RemoveSignatory

Fields

signatory: Pubkey

Signatory to remove from the Proposal

Removes a Signatory from the Proposal

0. [writable] Proposal account
1. [] TokenOwnerRecord account of the 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

InsertTransaction

Fields

option_index: u8

The index of the option the transaction is for

index: u16

Transaction index to be inserted at.

hold_up_time: u32

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

instructions: Vec<InstructionData>

Instructions Data

Inserts Transaction with a set of instructions for the Proposal at the given index position New Transaction must be inserted at the end of the range indicated by Proposal transactions_next_index If a Transaction replaces an existing Transaction at a given index then the old one must be removed using RemoveTransaction first 0. [] Governance account

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

RemoveTransaction

Removes Transaction from the Proposal

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

CancelProposal

Cancels Proposal by changing its state to Canceled

0. [writable] Realm account
1. [writable] Governance account
2. [writable] Proposal account
3. [writable] TokenOwnerRecord account of the Proposal owner
4. [signer] Governance Authority (Token Owner or Governance Delegate)

SignOffProposal

Signs off Proposal indicating the Signatory approves the Proposal When the last Signatory signs off the Proposal it enters Voting state Note: Adding signatories to a Proposal is a quality and not a security gate and it’s entirely at the discretion of the Proposal owner If Proposal owner doesn’t designate any signatories then can sign off the Proposal themself

0. [writable] Realm account
1. [writable] Governance account
2. [writable] Proposal account
3. [signer] Signatory account signing off the Proposal Or Proposal owner if the owner hasn’t appointed any signatories
4. [] TokenOwnerRecord for the Proposal owner, required when the owner signs off the Proposal Or [writable] SignatoryRecord account, required when non owner sings off the Proposal

CastVote

Fields

vote: Vote

User’s vote

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 transactions If you tip the consensus then the transactions can begin to be run after their hold up time

0. [writable] Realm account
1. [writable] Governance account
2. [writable] Proposal account
3. [writable] TokenOwnerRecord of the Proposal owner
4. [writable] TokenOwnerRecord of the voter. PDA seeds: [‘governance’,realm, governing_token_mint, governing_token_owner]
5. [signer] Governance Authority (Token Owner or Governance Delegate)
6. [writable] Proposal VoteRecord account. PDA seeds: [‘governance’,proposal,governing_token_owner_record]
7. [] Governing Token Mint
8. [signer] Payer
9. [] System program
10. [] Realm Config
11. [] Optional Voter Weight Record
12. [] Optional Max Voter Weight Record

FinalizeVote

Fields

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

0. [writable] Realm account
1. [writable] Governance account
2. [writable] Proposal account
3. [writable] TokenOwnerRecord of the Proposal owner
4. [] Governing Token Mint
5. [] Realm Config
6. [] Optional Max Voter Weight Record

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

ExecuteTransaction

Executes a Transaction in the Proposal Anybody can execute transaction once Proposal has been voted Yes and transaction_hold_up time has passed The actual transaction 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] ProposalTransaction account you wish to execute 2+ Any extra accounts that are part of the transaction, in order

CreateMintGovernance

Fields

config: GovernanceConfig

Governance config

transfer_mint_authorities: bool

Indicates whether Mint’s authorities (MintTokens, FreezeAccount) 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

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 (MintTokens and optionally FreezeAccount)
4. [] Governing TokenOwnerRecord account (Used only if not signed by RealmAuthority)
5. [signer] Payer
6. [] SPL Token program
7. [] System program
8. [] Sysvar Rent
9. [signer] Governance authority
10. [] Realm Config
11. [] Optional Voter Weight Record

CreateTokenGovernance

Fields

config: GovernanceConfig

Governance config

transfer_account_authorities: bool

Indicates whether the token account authorities (AccountOwner and optionally CloseAccount) 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

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 authority (AccountOwner and optionally CloseAccount)
4. [] Governing TokenOwnerRecord account (Used only if not signed by RealmAuthority)
5. [signer] Payer
6. [] SPL Token program
7. [] System program
8. [] Sysvar Rent
9. [signer] Governance authority
10. [] Realm Config
11. [] Optional Voter Weight Record

SetGovernanceConfig

Fields

config: GovernanceConfig

New governance config

Sets GovernanceConfig for a Governance

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

FlagTransactionError

Flags a transaction and its parent Proposal with error status It can be used by Proposal owner in case the transaction is permanently broken and can’t be executed Note: This instruction is a workaround because currently it’s not possible to catch errors from CPI calls and the Governance program has no way to know when instruction failed and flag it automatically

0. [writable] Proposal account
1. [] TokenOwnerRecord account of the Proposal owner
2. [signer] Governance Authority (Token Owner or Governance Delegate)
3. [writable] ProposalTransaction account to flag

SetRealmAuthority

Fields

action: SetRealmAuthorityAction

Set action ( SetUnchecked, SetChecked, Remove)

Sets new Realm authority

0. [writable] Realm account
1. [signer] Current Realm authority
2. [] New realm authority. Must be one of the realm governances when set

SetRealmConfig

Fields

config_args: RealmConfigArgs

Realm config args

Sets realm config 0. [writable] Realm account

1. [signer] Realm authority
2. [] Council Token Mint - optional Note: In the current version it’s only possible to remove council mint (set it to None) After setting council to None it won’t be possible to withdraw the tokens from the Realm any longer If that’s required then it must be done before executing this instruction
3. [writable] Council Token Holding account - optional unless council is used. PDA seeds: [‘governance’,realm,council_mint] The account will be created with the Realm PDA as its owner
4. [] System
5. [writable] RealmConfig account. PDA seeds: [‘realm-config’, realm]
6. [] Optional Community Voter Weight Addin Program Id
7. [] Optional Max Community Voter Weight Addin Program Id
8. [signer] Optional Payer

CreateTokenOwnerRecord

Fields

Creates TokenOwnerRecord with 0 deposit amount It’s used to register TokenOwner when voter weight addin is used and the Governance program doesn’t take deposits

0. [] Realm account
1. [] Governing Token Owner account
2. [writable] TokenOwnerRecord account. PDA seeds: [‘governance’,realm, governing_token_mint, governing_token_owner]
3. [] Governing Token Mint
4. [signer] Payer
5. [] System

UpdateProgramMetadata

Fields

Updates ProgramMetadata account The instruction dumps information implied by the program’s code into a persistent account

0. [writable] ProgramMetadata account. PDA seeds: [‘metadata’]
1. [signer] Payer
2. [] System

CreateNativeTreasury

Creates native SOL treasury account for a Governance account The account has no data and can be used as a payer for instructions signed by Governance PDAs or as a native SOL treasury

0. [] Governance account the treasury account is for
1. [writable] NativeTreasury account. PDA seeds: [‘treasury’, governance]
2. [signer] Payer
3. [] System

Trait Implementations

impl BorshDeserialize for GovernanceInstruction where
    String: BorshDeserialize,
    RealmConfigArgs: BorshDeserialize,
    u64: BorshDeserialize,
    Option<Pubkey>: BorshDeserialize,
    GovernanceConfig: BorshDeserialize,
    GovernanceConfig: BorshDeserialize,
    bool: BorshDeserialize,
    String: BorshDeserialize,
    String: BorshDeserialize,
    VoteType: BorshDeserialize,
    Vec<String>: BorshDeserialize,
    bool: BorshDeserialize,
    Pubkey: BorshDeserialize,
    Pubkey: BorshDeserialize,
    u8: BorshDeserialize,
    u16: BorshDeserialize,
    u32: BorshDeserialize,
    Vec<InstructionData>: BorshDeserialize,
    Vote: BorshDeserialize,
    GovernanceConfig: BorshDeserialize,
    bool: BorshDeserialize,
    GovernanceConfig: BorshDeserialize,
    bool: BorshDeserialize,
    GovernanceConfig: BorshDeserialize,
    SetRealmAuthorityAction: BorshDeserialize,
    RealmConfigArgs: 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 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,
    RealmConfigArgs: BorshSerialize,
    u64: BorshSerialize,
    Option<Pubkey>: BorshSerialize,
    GovernanceConfig: BorshSerialize,
    GovernanceConfig: BorshSerialize,
    bool: BorshSerialize,
    String: BorshSerialize,
    String: BorshSerialize,
    VoteType: BorshSerialize,
    Vec<String>: BorshSerialize,
    bool: BorshSerialize,
    Pubkey: BorshSerialize,
    Pubkey: BorshSerialize,
    u8: BorshSerialize,
    u16: BorshSerialize,
    u32: BorshSerialize,
    Vec<InstructionData>: BorshSerialize,
    Vote: BorshSerialize,
    GovernanceConfig: BorshSerialize,
    bool: BorshSerialize,
    GovernanceConfig: BorshSerialize,
    bool: BorshSerialize,
    GovernanceConfig: BorshSerialize,
    SetRealmAuthorityAction: BorshSerialize,
    RealmConfigArgs: 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 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