Class HiroOrdinalsDetector

Hiro Ordinals API detector implementation

Integrates with the Hiro Ordinals API to detect:

Bitcoin inscriptions (ordinals)
Runes tokens

Features:

Fail-safe operation (never throws, returns false on errors)
Configurable timeout and retry logic
Exponential backoff for rate limiting

Implements

Index

Constructors

Methods

getAssetData getInscriptionData isProtectedUtxo

Constructors

constructor

new HiroOrdinalsDetector(
options?: HiroOrdinalsDetectorOptions,
): HiroOrdinalsDetector
Parameters
- options: HiroOrdinalsDetectorOptions = {}
Returns HiroOrdinalsDetector
- Defined in detectors/hiro-ordinals-detector.ts:72

Methods

getAssetData

getAssetData(utxo: UTXO): Promise<null | ProtectedAssetData>
Get asset data for a UTXO - only returns ordinal/inscription types
Parameters
- utxo: UTXO
Returns Promise<null | ProtectedAssetData>
Implementation of OrdinalsDetector.getAssetData
- Defined in detectors/hiro-ordinals-detector.ts:181

getInscriptionData

getInscriptionData(utxo: UTXO): Promise<null | InscriptionData>
Get inscription data for a UTXO if it contains an inscription
Parameters
- utxo: UTXO
Returns Promise<null | InscriptionData>
Implementation of OrdinalsDetector.getInscriptionData
- Defined in detectors/hiro-ordinals-detector.ts:123

isProtectedUtxo

isProtectedUtxo(utxo: UTXO): Promise<boolean>
Check if a UTXO contains protected inscriptions/ordinals
Parameters
- utxo: UTXO
Returns Promise<boolean>
Implementation of OrdinalsDetector.isProtectedUtxo
- Defined in detectors/hiro-ordinals-detector.ts:81