Skip to content

ordpool-space/ordpool

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

12,970 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Ordpool

Preview

A Bitcoin MEMEpool explorer.
Inscriptions, Runes (including Alkanes), BRC-20, SRC-20 (Stamps), and ๐Ÿ˜บ CAT-21 Ordinals?
We have you covered!

This is a fork of the The Mempool Open Source Project โ€“ with significant changes for the Bitcoin Ordinals community.

๐ŸŸง What ordpool does that other explorers don't

Other explorers stop at "this is a transaction". Ordpool opens it up: inscriptions decoded inline, runes named, alkanes contract calls labelled, CAT-21 cats rendered, OpenTimestamps verified, Counterparty messages decoded, STAMP / SRC-20 / SRC-721 / SRC-101 / Labitbu / Atomicals / Bitmap โ€” every metaprotocol on Bitcoin L1, all parsed from raw on-chain bytes.

See it in action: EXAMPLE-TRANSACTIONS.md โ€” a click-through catalog of real mainnet txs that exercise each protocol and viewer. The doc doubles as the canonical test-case index used by the parser specs and the frontend viewer components.

๐ŸŸง Quick Setup for Backend Development

Get your Bitcoin node and Electrs ready! You should have the following services already running:

  • Bitcoin
  • Electrs
  • MariaDB

Read the /backend/README.md first. Copy mempool-config.sample.json to `mempool-config.json and adjust all connection settings.

cd backend
npm install
npm start

๐ŸŸง Quick Setup for Frontend Development

Read the /frontend/README.md first. The key difference to the original setup is the following new command:

cd frontend
npm install
npm run config:defaults:ordpool
npm start

This generates the required file /resources/config.js with the correct settings for Ordpool.

๐ŸŸง ordpool-parser

We've extracted the parsing of digital artifacts to a separate repository! Now it's your turn! Fork it and add support for the next big metaprotocol. Can't wait to see what you come up with! ...so that we can show it on Ordpool! ๐Ÿงก

More at:

If you want to integrate the parser into your own project, feel free to do so. The code is 100% open-source and is under the MIT License. Do whatever you want with it!

npm link ordpool-parser

Use the following instructions to make the ordpool-parser available locally (for testing changes against Ordpool) via npm link.

  1. Clone the project

    git clone https://github.com/ordpool-space/ordpool-parser.git
    cd ordpool-parser
  2. Install the dependencies

    npm install
  3. Build the project:

    npm run build
  4. Create a local npm link:

    cd dist
    npm link

use the linked ordpool-parser

Once you have completed the previous steps to npm link the local copy of ordpool-parser, follow these steps to use it in your local frontend project or backend project. (the parser is used in both projects)

  1. Enter the project directory

    cd ordpool
    cd frontend
    # OR
    cd backend
  2. Add the local version of ordpool-parser (instead of the stable version from npm).

    npm link ordpool-parser
  3. Happy developing! Don't forget to execute the tests! โ˜•๏ธ

  4. You can remove the link later by running npm unlink ordpool-parser.

Read more about the link feature in the official NPM documentation.

About

Your favorite MEMEpool explorer. Inscriptions, Stamps, Runes, and ๐Ÿ˜บ CAT-21 Ordinals? We have you covered! | https://ordpool.space/

Resources

License

Unknown, AGPL-3.0 licenses found

Licenses found

Unknown
LICENSE
AGPL-3.0
COPYING.md

Contributing

Stars

Watchers

Forks

Contributors