Module mpl_token_auth_rules::state

All structures and related functions representing a Rule Set on-chain.

Key types include the main RuleSetV1 type which keeps the the map of operations to Rules, RuleSetV2 type which keep a list of RuleV2, as well as RuleSetHeader and RuleSetRevisionMapV1 types used to manage data within the RuleSet PDA.

Each time a RuleSet is updated, a new revision is added to the PDA, and previous revisions never deleted. The revision map is needed so that during RuleSet validation the desired revision can be selected by the user.

Because the RuleSets and the revision map are variable size, a fixed size header is stored at the beginning of the RuleSet PDA that allows new RuleSets and updated revision maps to be added to the PDA without moving the previous revision RuleSets and without losing the revision map’s location.

Also note there is a 1-byte version preceding each RuleSetV1 revision (for RuleSetV2 the first byte of the serialized rule set is the version) and the revision map.

Approximate RuleSet PDA data layout

| Header  | RuleSetV1 version | RuleSetV1 Revision 0 | RuleSetV1 version | RuleSetV1 Revision 1 | RuleSetV2 Revision 2 | ... | RuleSetRevisionMap version | RuleSetRevisionMap |
|---------|-------------------|----------------------|-------------------|----------------------|----------------------|-----|----------------------------|--------------------|
| 9 bytes | 1 byte            | variable bytes       | 1 byte            | variable bytes       | variable bytes       | ... | 1 byte                     | variable bytes     |

When `RuleSetV2` revisions are added, there migh be the need to add padding bytes to align the data
to 8 bytes.

Modules

• constraint
  Collection of rule constraints.

Structs

• AdditionalSigner
  Constraint representing the requirement that An additional signer must be present.
• All
  Constraint representing a group AND, where every rule contained must pass.
• Amount
  Constraint representing a comparison against the amount of tokens being transferred.
• Any
  Constraint representing a group OR, where at least one rule contained must pass.
• Frequency
  Constraint representing a comparison based on time between operations.
• FrequencyAccount
  An account containing frequency state.
• Header
  Header for the rule.
• IsWallet
  Constraint that represents a test on whether a pubkey can be signed from a client and therefore is a true wallet account or not.
• Namespace
  A constraint that tells the operation finder to use the default namespace rule.
• Not
  Constraint representing a negation, where the contained rule must fail.
• PDAMatch
  Constraint representing a test where a resulting PDA derivation of seeds must prove the account is a PDA.
• Pass
  Constraint representing an operation that always succeeds.
• ProgramOwned
  Constraint representing a test where a Pubkey must be owned by a given program.
• ProgramOwnedList
  Constraint representing a test where the Pubkey must be owned by a program in the list of Pubkeys.
• ProgramOwnedTree
  Constraint representing a test where the Pubkey must be owned by a member of the Merkle tree in the rule.
• PubkeyListMatch
  Constraint representing a test where a Pubkey must be in the list of Pubkeys.
• PubkeyMatch
  Constraint representing a direct comparison between Pubkeys.
• PubkeyTreeMatch
  Constraing representing a test where a Pubkey must be a member of the Merkle tree in the rule.
• RuleSetHeader
  Header used to keep track of where RuleSets are stored in the PDA. This header is meant to be stored at the beginning of the PDA and never be versioned so that it always has the same serialized size. See top-level module for description of PDA memory layout.
• RuleSetRevisionMapV1
  Revision map used to keep track of where individual RuleSet revisions are stored in the PDA. See top-level module for description of PDA memory layout.
• RuleSetV1
  The struct containing all Rule Set data, most importantly the map of operations to Rules. See top-level module for description of PDA memory layout.
• RuleSetV2
  The struct containing all Rule Set data, most importantly the map of operations to Rules. See top-level module for description of PDA memory layout.
• RuleV2
  Struct representing a ‘RuleV2’.
• Str32
  Struct representing a 32 byte string.

Enums

• CompareOp
  Operators that can be used to compare against an Amount rule.
• ConstraintType
  The struct containing every type of Rule and its associated data.
• Key
  The key at the beginning of the serialized account that identifies the account type. NOTE: This is not used for the RuleSet account, which uses msgpack instead of Borsh for SerDes.
• Operator
  Operators that can be used to compare against an Amount rule.
• Rule
  The struct containing every type of Rule and its associated data.
• RuleResult
  Enum representation of Rule failure conditions

Constants

• CHUNK_SIZE
  The maximum size that can be allocated at one time for a PDA.
• HEADER_SECTION
  Size (in bytes) of the header section.
• RULE_SET_REV_MAP_VERSION
  Version of the RuleSetRevisionMapV1 struct.
• RULE_SET_SERIALIZED_HEADER_LEN
  Size of RuleSetHeader when Borsh serialized.
• U64_BYTES
  Size (in bytes) of a u64 value.

Traits

• Constraint
  Struct representing a test performed by a rule.
• SolanaAccount
  A trait implementing generic functions required by all accounts on Solana.