Struct mpl_candy_guard::guards::Allocation

pub struct Allocation {
    pub id: u8,
    pub limit: u32,
}

Gaurd to specify the maximum number of mints in a guard set.

List of accounts required:

0. [writable] Allocation tracker PDA. The PDA is derived using the seed ["allocation", allocation id, candy guard pubkey, candy machine pubkey].

Fields

id: u8

Unique identifier of the allocation.

limit: u32

The limit of the allocation.

Trait Implementations

impl BorshDeserialize for Allocation

where u8: BorshDeserialize, u32: BorshDeserialize,

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 BorshSerialize for Allocation

where u8: BorshSerialize, u32: BorshSerialize,

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 Allocation

fn clone(&self) -> Allocation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Condition for Allocation

fn validate<'info>( &self, ctx: &mut EvaluationContext<'_, '_, '_>, _guard_set: &GuardSet, _mint_args: &[u8] ) -> Result<()>

Validate the condition of the guard. When the guard condition is not satisfied, it will return an error.

fn pre_actions<'info>( &self, ctx: &mut EvaluationContext<'_, '_, '_>, _guard_set: &GuardSet, _mint_args: &[u8] ) -> Result<()>

Perform the action associated with the guard before the CPI mint instruction.

fn post_actions( &self, _ctx: &mut EvaluationContext<'_, '_, '_>, _guard_set: &GuardSet, _mint_args: &[u8] ) -> Result<()>

Perform the action associated with the guard after the CPI mint instruction.

impl Debug for Allocation

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

Formats the value using the given formatter.

impl Guard for Allocation

fn instruction<'info>( ctx: &Context<'_, '_, '_, 'info, Route<'info>>, route_context: RouteContext<'info>, _data: Vec<u8> ) -> Result<()>

Instruction to initialize the allocation PDA.

List of accounts required:

0. [writable] Pda to track the number of mints (seeds ["allocation", allocation id, candy guard pubkey, candy machine pubkey]).
1. [signer] Candy Guard authority.
2. [] System program account.

fn size() -> usize

Returns the number of bytes used by the guard configuration.

fn mask() -> u64

Returns the feature mask for the guard.

fn is_enabled(features: u64) -> bool

Returns whether the guards is enabled or not on the specified features.

fn enable(features: u64) -> u64

Enables the guard on the specified features value.

fn disable(features: u64) -> u64

Disables the guard on the specified features value.

fn save(&self, data: &mut [u8], offset: usize) -> Result<()>

Serializes the guard into the specified data array.

fn load(data: &[u8], offset: usize) -> Result<Option<Self>>

Deserializes the guard from a slice of data. Only attempts the deserialization if the data slice is large enough.

fn verify(_data: &CandyGuardData) -> Result<()>

Verifies that the candy guard configuration is valid according to the rules of the guard.