https://github.com/ordpool-space/ordpool-parser
The parsing engine that detects Inscriptions, Runes, BRC-20, SRC-20 Stamps, CAT-21, Atomicals, and Labitbus in Bitcoin transactions.
https://github.com/ordpool-space/ordpool-parser
atomicals bitcoin brc-20 cat-21 inscription inscriptions labitbu npm ordinals rune runes src-20 typescript
Last synced: 2 months ago
JSON representation
The parsing engine that detects Inscriptions, Runes, BRC-20, SRC-20 Stamps, CAT-21, Atomicals, and Labitbus in Bitcoin transactions.
- Host: GitHub
- URL: https://github.com/ordpool-space/ordpool-parser
- Owner: ordpool-space
- License: other
- Created: 2023-12-11T16:04:10.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2026-05-21T10:59:33.000Z (2 months ago)
- Last Synced: 2026-05-21T18:58:40.190Z (2 months ago)
- Topics: atomicals, bitcoin, brc-20, cat-21, inscription, inscriptions, labitbu, npm, ordinals, rune, runes, src-20, typescript
- Language: TypeScript
- Homepage: https://ordpool.space
- Size: 12.4 MB
- Stars: 7
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ordpool-parser
Yes, Bitcoin is money. Everything else is an attack on Bitcoin. We get it. [BIP 110](https://github.com/bitcoin/bips/blob/master/bip-0110.mediawiki) will fix this.
But you still want to know what's inside your blocks, don't you? Know your enemy! ;-)
**ordpool-parser** is a zero-dependency TypeScript parser that detects and extracts digital artifacts from raw Bitcoin transactions: **Inscriptions**, **Runes** (including **Alkanes**), **BRC-20**, **SRC-20 Stamps**, **CAT-21**, **Atomicals**, and **Labitbu**.
Works in **Node.js** and **browsers** out of the box. Used by [ordpool.space](https://ordpool.space).
```
npm install ordpool-parser
```
## What does it parse?
| Protocol | What it detects | Key data extracted |
|----------|----------------|-------------------|
| **Inscriptions** | `OP_FALSE OP_IF "ord"` envelope in witness | Content, content type, metadata, parents, delegates, **galleries** (tag 17 properties with items + traits) |
| **Runes** | `OP_RETURN` runestone | Etching, mint, transfers, cenotaphs; also surfaces **Alkanes** (sub-protocol via Runestone tag 16383 Protostones) |
| **BRC-20** | JSON inscriptions with `"p": "brc-20"` | Deploy, mint, transfer operations |
| **SRC-20** | RC4-encrypted stamp data in multisig outputs | Deploy, mint, transfer operations |
| **CAT-21** | Transactions with `nLockTime == 21` | Deterministic cat image (SVG) + traits |
| **Atomicals** | `OP_FALSE OP_IF "atom"` envelope in witness | Operation type, CBOR payload, args, file attachments |
| **Labitbu** | WebP image in Taproot control block (NUMS key) | 4096-byte WebP image |
## Quick start
The parser expects transactions in Esplora API JSON format (served by `api.ordpool.space`, `mempool.space`, `blockstream.info`, or your own Esplora-compatible backend).
### Parse everything at once
```ts
import { DigitalArtifactsParserService } from 'ordpool-parser';
const response = await fetch(`https://api.ordpool.space/api/tx/${txId}`);
const tx = await response.json();
// Returns all digital artifacts found in the transaction
const artifacts = DigitalArtifactsParserService.parse(tx);
```
### Parse specific types
```ts
import {
InscriptionParserService,
Cat21ParserService,
RuneParserService,
AtomicalParserService,
LabitbuParserService,
Src20ParserService,
} from 'ordpool-parser';
// Inscriptions (can return multiple — batch inscriptions)
const inscriptions = InscriptionParserService.parse(tx);
if (inscriptions.length) {
console.log(inscriptions[0].contentType);
console.log(await inscriptions[0].getContent());
// Galleries (tag 17 properties)
const properties = await inscriptions[0].getProperties();
if (properties) {
console.log(properties.gallery); // Array of { inscriptionId, title?, traits? }
}
}
// CAT-21
const cat = Cat21ParserService.parse(tx);
if (cat) {
console.log(cat.getImage()); // SVG string
console.log(cat.getTraits()); // { genesis, gender, designIndex, ... }
}
// Runes
const rune = RuneParserService.parse(tx);
if (rune?.runestone?.etching) {
console.log(rune.runestone.etching.runeName);
}
// Atomicals
const atomical = AtomicalParserService.parse(tx);
if (atomical) {
console.log(atomical.operation); // 'nft', 'dft', 'ft', 'mod', ...
console.log(atomical.getArgs()); // { request_ticker, mint_amount, ... }
console.log(atomical.getFiles()); // [{ name, contentType, data }]
}
// Labitbu
const labitbu = LabitbuParserService.parse(tx);
if (labitbu) {
console.log(labitbu.getDataRaw()); // 4096-byte WebP image
}
```
### Analyze a full block
```ts
import { DigitalArtifactAnalyserService } from 'ordpool-parser';
// Analyze all transactions in a block — returns per-type counts, fees, mint activity
const stats = await DigitalArtifactAnalyserService.analyseTransactions(blockTxns);
```
## License
MIT