Interface OrdinalsDetector

Ordinals-specific detector interface

This interface is specifically for detecting Bitcoin ordinals and inscriptions. It provides methods optimized for ordinals detection workflows.

interface OrdinalsDetector {
    getAssetData(utxo: UTXO): Promise<null | ProtectedAssetData>;
    getInscriptionData(utxo: UTXO): Promise<null | InscriptionData>;
    isProtectedUtxo(utxo: UTXO): Promise<boolean>;
}

Implemented by

Index

Methods

getAssetData getInscriptionData isProtectedUtxo

Methods

getAssetData

getAssetData(utxo: UTXO): Promise<null | ProtectedAssetData>
Get asset data for a UTXO - only returns ordinal/inscription types
Parameters
- utxo: UTXO
  The UTXO to analyze
Returns Promise<null | ProtectedAssetData>
Promise<ProtectedAssetData | null> Asset data if found, null otherwise
- Defined in interfaces/ordinals.interface.ts:69

getInscriptionData

getInscriptionData(utxo: UTXO): Promise<null | InscriptionData>
Get inscription data for a UTXO if it contains an inscription
Parameters
- utxo: UTXO
  The UTXO to analyze
Returns Promise<null | InscriptionData>
Promise<InscriptionData | null> Inscription data if found, null otherwise
- Defined in interfaces/ordinals.interface.ts:62

isProtectedUtxo

isProtectedUtxo(utxo: UTXO): Promise<boolean>
Check if a UTXO contains protected ordinals/inscriptions
Parameters
- utxo: UTXO
  The UTXO to check
Returns Promise<boolean>
Promise True if the UTXO contains ordinals/inscriptions
- Defined in interfaces/ordinals.interface.ts:55