Struct CatInfo

pub struct CatInfo {
    pub asset_id: Bytes32,
    pub hidden_puzzle_hash: Option<Bytes32>,
    pub p2_puzzle_hash: Bytes32,
}

Information needed to construct the outer puzzle of a CAT. This includes the CatLayer and RevocationLayer if present. However, it does not include the inner puzzle, which must be stored separately.

This type can be used on its own for parsing, or as part of the Cat primitive.

Fields

asset_id: Bytes32

The hash of the TAIL (Token and Asset Issuance Limitations) program. This is what controls the supply, and thus the main way to identify a CAT. You can spend multiple CAT coins at once, as long as they have the same asset_id.

hidden_puzzle_hash: Option<Bytes32>

The hash of the hidden puzzle, if this is a revocable CAT. A revocable CAT is one in which the inner puzzle is wrapped in the RevocationLayer.

p2_puzzle_hash: Bytes32

The hash of the inner puzzle to this CAT. For revocable CATs, it’s the inner puzzle of the RevocationLayer. If you encode this puzzle hash as bech32m, it’s the same as the current owner’s address.

Implementations

impl CatInfo

pub fn new( asset_id: Bytes32, hidden_puzzle_hash: Option<Bytes32>, p2_puzzle_hash: Bytes32, ) -> Self

pub fn parse( allocator: &Allocator, puzzle: Puzzle, ) -> Result<Option<(Self, Option<Puzzle>)>, DriverError>

Parses a CatInfo from a Puzzle by extracting the CatLayer and RevocationLayer if present.

This will return a tuple of the CatInfo and its p2 puzzle. If the CAT is revocable, the p2 puzzle will be None, since it’s not revealed until the CAT is spent.

If the puzzle is not a CAT, this will return None instead of an error. However, if the puzzle should have been a CAT but had a parsing error, this will return an error.

pub fn inner_puzzle_hash(&self) -> TreeHash

Calculates the inner puzzle hash of the CAT.

This is only different than the p2_puzzle_hash for revocable CATs.

pub fn puzzle_hash(&self) -> TreeHash

Calculates the full puzzle hash of the CAT, which is the hash of the outer CatLayer.

pub fn construct_puzzle( &self, ctx: &mut SpendContext, p2_puzzle: NodePtr, ) -> Result<NodePtr, DriverError>

Calculates the full puzzle of the CAT. If the CAT is revocable, the Self::p2_puzzle_hash if used instead of the passed in p2 puzzle reveal. This is because the revocation layer reveals the inner puzzle in the solution instead of the puzzle.

Trait Implementations

impl Clone for CatInfo

fn clone(&self) -> CatInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CatInfo

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

Formats the value using the given formatter.

impl PartialEq for CatInfo

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for CatInfo

impl Eq for CatInfo

impl StructuralPartialEq for CatInfo