Enum OrdParser

pub enum OrdParser {
    Ordinal(Nft),
    Brc20(Brc20),
}

Encapsulates inscription parsing logic for both Ordinals and BRC20s.

Variants

Ordinal(Nft)

Denotes a parsed Nft inscription.

Brc20(Brc20)

Denotes a parsed Brc20 inscription.

Implementations

impl OrdParser

pub fn parse_all(tx: &Transaction) -> OrdResult<Vec<(InscriptionId, Self)>>

Parses all inscriptions from a given transaction and categorizes them as either Self::Brc20 or Self::Ordinal.

This function extracts all inscription data from the transaction, attempts to parse each inscription, and returns a vector of categorized inscriptions with their corresponding IDs.

Errors

Will return an error if any inscription data cannot be parsed correctly, or if no valid inscriptions are found in the transaction.

pub fn parse_one( tx: &Transaction, index: usize, ) -> OrdResult<(InscriptionId, Self)>

Parses a single inscription from a transaction at a specified index, returning the parsed inscription along with its ID.

This method specifically targets one inscription identified by its index within the transaction’s inputs. It extracts the inscription data, attempts to parse it, and categorizes it as either Self::Brc20 or Self::Ordinal.

Errors

Returns an error if the inscription data at the specified index cannot be parsed, if there is no data at the specified index, or if the data at the index does not contain a valid payload.

Trait Implementations

impl Clone for OrdParser

fn clone(&self) -> OrdParser

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OrdParser

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OrdParser

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Brc20> for OrdParser

fn from(inscription: Brc20) -> Self

Converts to this type from the input type.

impl From<Nft> for OrdParser

fn from(inscription: Nft) -> Self

Converts to this type from the input type.

impl Inscription for OrdParser

fn content_type(&self) -> String

Returns the MIME content type of the inscription.

fn data(&self) -> OrdResult<PushBytesBuf>

Returns the body of the inscription as to be pushed to the redeem script.

fn generate_redeem_script( &self, builder: ScriptBuilder, pubkey: RedeemScriptPubkey, ) -> OrdResult<ScriptBuilder>

Generates the redeem script from a script pubkey and the inscription.

fn encode(&self) -> OrdResult<String>

where Self: Serialize,

Encodes the inscription object into a JSON string.

fn parse(data: &[u8]) -> OrdResult<Self>

where Self: Sized,

Parses inscription data from the serialized bytes found in the witness script.

impl PartialEq for OrdParser

fn eq(&self, other: &OrdParser) -> 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 Serialize for OrdParser

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&OrdParser> for Brc20

type Error = OrdError

The type returned in the event of a conversion error.

fn try_from(parser: &OrdParser) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&OrdParser> for Nft

type Error = OrdError

The type returned in the event of a conversion error.

fn try_from(parser: &OrdParser) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<OrdParser> for Brc20

type Error = OrdError

The type returned in the event of a conversion error.

fn try_from(parser: OrdParser) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<OrdParser> for Nft

type Error = OrdError

The type returned in the event of a conversion error.

fn try_from(parser: OrdParser) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for OrdParser

impl StructuralPartialEq for OrdParser