mpl-token-auth-rules 1.5.1

MPL Token Authorization Rules that can be used to restrict common token operations
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

use std::collections::HashMap;

use solana_program::{
    account_info::AccountInfo, entrypoint::ProgramResult, program_error::ProgramError,
    pubkey::Pubkey,
};

use crate::{error::RuleSetError, payload::Payload};

/// Max name length for any of the names used in this crate.
pub const MAX_NAME_LENGTH: usize = 32;

/// Versioning for `RuleSet` structs.
pub enum LibVersion {
    V1 = 1,
    V2,
}

impl TryFrom<u8> for LibVersion {
    type Error = RuleSetError;

    fn try_from(value: u8) -> Result<Self, Self::Error> {
        match value {
            1 => Ok(LibVersion::V1),
            2 => Ok(LibVersion::V2),
            _ => Err(RuleSetError::UnsupportedRuleSetVersion),
        }
    }
}

pub trait Assertable<'a> {
    fn validate(
        &self,
        accounts: &HashMap<Pubkey, &AccountInfo>,
        payload: &Payload,
        update_rule_state: bool,
        rule_set_state_pda: &Option<&AccountInfo>,
        rule_authority: &Option<&AccountInfo>,
    ) -> ProgramResult;
}

pub trait RuleSet<'a> {
    /// Returns the name of the `RuleSet`.
    fn name(&self) -> String;

    /// Returns the ownwer of the `RuleSet`.
    fn owner(&self) -> &Pubkey;

    /// Returns the version of the `RuleSet`.
    fn lib_version(&self) -> u8;

    /// Returns the rule associated with an operation.
    fn get_rule(&self, operation: String) -> Result<&dyn Assertable<'a>, ProgramError>;
}