Enum FeatureProposalInstruction

Source
pub enum FeatureProposalInstruction {
    Propose {
        tokens_to_mint: u64,
        acceptance_criteria: AcceptanceCriteria,
    },
    Tally,
}
Expand description

Instructions supported by the Feature Proposal program

Variants§

§

Propose

Propose a new feature.

This instruction will create a variety of accounts to support the feature proposal, all funded by account 0:

  • A new token mint with a supply of tokens_to_mint, owned by the program and never modified again
  • A new “distributor” token account that holds the total supply, owned by account 0.
  • A new “acceptance” token account that holds 0 tokens, owned by the program. Tokens transfers to this address are irrevocable and permanent.
  • A new feature id account that has been funded and allocated (as described in solana_program::feature)

On successful execution of the instruction, the feature proposer is expected to distribute the tokens in the distributor token account out to all participating parties.

Based on the provided acceptance criteria, if AcceptanceCriteria::tokens_required tokens are transferred into the acceptance token account before AcceptanceCriteria::deadline then the proposal is eligible to be accepted.

The FeatureProposalInstruction::Tally instruction must be executed, by any party, to complete the feature acceptance process.

Accounts expected by this instruction:

  1. [writeable,signer] Funding account (must be a system account)
  2. [writeable,signer] Unallocated feature proposal account to create
  3. [writeable] Token mint address from get_mint_address
  4. [writeable] Distributor token account address from get_distributor_token_address
  5. [writeable] Acceptance token account address from get_acceptance_token_address
  6. [writeable] Feature id account address from get_feature_id_address
  7. [] System program
  8. [] SPL Token program
  9. [] Rent sysvar

Fields

§tokens_to_mint: u64

Total number of tokens to mint for this proposal

§acceptance_criteria: AcceptanceCriteria

Criteria for how this proposal may be activated

§

Tally

Tally is a permission-less instruction to check the acceptance criteria for the feature proposal, which may result in:

  • No action
  • Feature proposal acceptance
  • Feature proposal expiration

Accounts expected by this instruction:

  1. [writeable] Feature proposal account
  2. [] Acceptance token account address from get_acceptance_token_address
  3. [writeable] Derived feature id account address from get_feature_id_address
  4. [] System program
  5. [] Clock sysvar

Trait Implementations§

Source§

impl BorshDeserialize for FeatureProposalInstruction

Source§

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.
Source§

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

Deserialize this instance from a slice of bytes.
Source§

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.
Source§

impl BorshSchema for FeatureProposalInstruction

Source§

fn declaration() -> Declaration

Get the name of the type without brackets.
Source§

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.
Source§

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

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

fn schema_container() -> BorshSchemaContainer

Source§

impl BorshSerialize for FeatureProposalInstruction

Source§

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

Source§

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

Serialize this instance into a vector of bytes.
Source§

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.
Source§

impl Clone for FeatureProposalInstruction

Source§

fn clone(&self) -> FeatureProposalInstruction

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for FeatureProposalInstruction

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Pack for FeatureProposalInstruction

Source§

const LEN: usize = 25usize

The length, in bytes, of the packed representation
Source§

fn get_packed_len() -> usize

Get the packed length
Source§

fn unpack_unchecked(input: &[u8]) -> Result<Self, ProgramError>

Unpack from slice without checking if initialized
Source§

fn pack(src: Self, dst: &mut [u8]) -> Result<(), ProgramError>

Pack into slice
Source§

impl PartialEq for FeatureProposalInstruction

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Sealed for FeatureProposalInstruction

Source§

impl StructuralPartialEq for FeatureProposalInstruction

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> AbiExample for T

Source§

default fn example() -> T

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

OSZAR »