add ordhook docs

docs/ordhook/getting-started.md

@@ -0,0 +1,40 @@
+---
+title: Getting Started
+---
+
+Ordhook is a utility designed for interacting with the [Ordinal Theory](https://trustmachines.co/glossary/ordinal-theory) protocol, enabling you to assign distinct identifiers to newly minted satoshis for diverse applications. Follow the steps below to install Ordhook.
+
+## Installing Ordhook
+
+> **_NOTE_**
+> Before proceeding, make sure you have the Rust and Cargo (Rust's package manager) installed on your computer.
+
+### Clone the Repository
+
+Open your terminal and navigate to the directory where you want to clone the Ordhook repository. Then run the following command to clone the repository:
+
+```bash
+git clone https://github.com/hirosystems/ordhook.git
+```
+
+This will download the Ordhook source code to your local machine.
+
+### Navigate to the Ordhook Directory
+
+Move into the newly cloned Ordhook directory by running the following command:
+
+```bash
+cd ordhook
+```
+
+You are now inside the Ordhook directory.
+
+### Install Ordhook
+
+Use the Rust package manager, Cargo, to install Ordhook. Run the following command:
+
+```bash
+cargo ordhook-install
+```
+
+This command compiles the Ordhook code and installs it on your system.

docs/ordhook/how-to-guides/how-to-explore-ordinal-activities.md

@@ -0,0 +1,109 @@
+---
+title: Explore Ordinal activities in your terminal
+---
+
+Ordhook can be used to extract ordinal activities from the Bitcoin chain and stream these activities to the indexer. This guide helps you with the steps to explore ordinal activities and post these activities to the indexer.
+
+### Explore ordinal activity
+
+You can use the following command to scan a range of blocks on mainnet or testnet.
+
+`ordhook scan blocks 767430 767753 --mainnet`
+
+The above command generates a `hord.sqlite.gz` file in your directory and displays inscriptions and transfers activities occurring in the range of the specified blocks.
+
+The output of the above command looks like this:
+
+```
+Inscription 6fb976ab49dcec017f1e201e84395983204ae1a7c2abf7ced0a85d692e442799i0 revealed at block #767430 (ordinal_number 1252201400444387, inscription_number 0)
+Inscription 26482871f33f1051f450f2da9af275794c0b5f1c61ebf35e4467fb42c2813403i0 revealed at block #767753 (ordinal_number 727624168684699, inscription_number 1)
+```
+
+You can now generate an activity for a given inscription by using the following command:
+
+`ordhook scan inscription 6fb976ab49dcec017f1e201e84395983204ae1a7c2abf7ced0a85d692e442799i0 --mainnet`
+
+The above command generates the ordinal activity for that inscription and also the number of transfers in the transactions.
+
+```
+Inscription 6fb976ab49dcec017f1e201e84395983204ae1a7c2abf7ced0a85d692e442799i0 revealed at block #767430 (inscription_number 0, ordinal_number 1252201400444387)
+        → Transferred in transaction 0x2c8a11858825ae2056be90c3e49938d271671ac4245b452cd88b1475cbea8971 (block #785391)
+        → Transferred in transaction 0xbc4c30829a9564c0d58e6287195622b53ced54a25711d1b86be7cd3a70ef61ed (block #785396)
+Number of transfers: 2
+```
+
+### Configure ordhook
+
+This section walks you through streaming ordinal activities to an indexer. To post the ordinal activity, you'll need to configure bitcoind. Refer to [Setting up a bitcoin node](https://docs.hiro.so/chainhook/how-to-guides/how-to-run-chainhook-as-a-service-using-bitcoind#setting-up-a-bitcoin-node) to understand the steps to configure Bitcoind.
+
+> **_NOTE_**
+> Ordhook is applicable to the Bitcoin chain only.
+
+Once the Bitcoin node is configured, you can use the following command in your terminal to create a configuration for Ordhook.
+
+`ordhook config new --mainnet`
+
+You will see a success message "Created file Ordhook.toml" in your terminal.
+
+The generated `ordhook.toml` file looks like this:
+
+```toml
+[storage]
+working_dir = "ordhook"
+
+# The Http Api allows you to register / deregister
+# dynamically predicates.
+# Disable by default.
+#
+# [http_api]
+# http_port = 20456
+# database_uri = "redis://localhost:6379/"
+
+[network]
+mode = "mainnet"
+bitcoind_rpc_url = "http://0.0.0.0:8332"
+bitcoind_rpc_username = "devnet"
+bitcoind_rpc_password = "devnet"
+# Bitcoin block events can be received by Chainhook
+# either through a Bitcoin node's ZeroMQ interface,
+# or through the Stacks node. Zmq is being
+# used by default:
+bitcoind_zmq_url = "tcp://0.0.0.0:18543"
+# but stacks can also be used:
+# stacks_node_rpc_url = "http://0.0.0.0:20443"
+
+[limits]
+max_number_of_bitcoin_predicates = 100
+max_number_of_concurrent_bitcoin_scans = 100
+max_number_of_processing_threads = 16
+bitcoin_concurrent_http_requests_max = 16
+max_caching_memory_size_mb = 32000
+
+# Disable the following section if the state
+# must be built locally
+[bootstrap]
+download_url = "https://archive.hiro.so/mainnet/ordhook/mainnet-ordhook-sqlite-latest"
+
+[logs]
+ordinals_internals = true
+chainhook_internals = true
+```
+
+Observe that the bitcoind configured fields will appear in the `ordhook.toml` file. Now, ensure that these fields are configured with the right values and URLs, as shown below:
+
+```toml
+bitcoind_rpc_url = "http://0.0.0.0:8332"
+bitcoind_rpc_username = "devnet"
+bitcoind_rpc_password = "devnet"
+bitcoind_zmq_url = "tcp://0.0.0.0:18543"
+```
+
+### Post ordinal activity to the indexer
+
+After adjusting the `Ordhook.toml` settings to make them match the bitcoind configuration, the following command can be run to scan blocks and post events to a local server.
+
+`ordhook scan blocks 767430 767753 --post-to=http://localhost:3000/api/events --config-path=./Ordhook.toml`
+
+The above command uses chainhook to create a predicate ordinal theory where one of the inscriptions is created and posts the events to `http://localhost:3000/api/events`.
+
+You can update the above command to scan between block heights and post events to the local server.

docs/ordhook/how-to-guides/how-to-use-ordhook-as-a-service-using-bitcoind.md

@@ -0,0 +1,38 @@
+---
+title: Run Ordhook as a Service using Bitcoind
+---
+
+## Run ordhook as a service using Bitcoind
+
+In this section, you'll learn how to run Ordhook as a service using [Chainhook SDK](https://github.com/hirosystems/chainhook/tree/develop/components/chainhook-sdk) to create a predicate ordinal theory and post events to a server.
+
+## Prerequisites
+
+- [Bitcoind configuration](https://docs.hiro.so/chainhook/how-to-guides/how-to-run-chainhook-as-a-service-using-bitcoind#setting-up-a-bitcoin-node)
+- Configure ordhook by following [this](./how-to-explore-ordinal-activities.md#configure-ordhook) section
+
+## Run ordhook service for streaming blocks
+
+Use the following command to start the ordhook service for streaming and processing new blocks appended to the Bitcoin blockchain.
+
+`ordhook service start --post-to=http://localhost:3000/api/events --config-path=./Ordhook.toml`
+
+When the ordhook service starts, the chainhook service gets initiated in the background to augment the blocks that Bitcoind sends. The bitcoind sends zeromq notifications to Ordhook to retrieve the inscriptions.
+
+### Add `http-post` endpoints dynamically
+
+To enable dynamically posting endpoints to the server, you can spin up the redis server by enabling the following lines of code in the `ordhook.toml` file.
+
+```toml
+[http_api]
+http_port = 20456
+database_uri = "redis://localhost:6379/"
+```
+
+## Run ordhook service
+
+Based on the `Ordhook.toml` file configuration, the ordhook service spins up an HTTP API to manage event destinations. Use the following command to start the ordhook service.
+
+`ordhook service start --config-path=./Ordhook.toml`
+
+A comprehensive OpenAPI specification explaining how to interact with this HTTP REST API can be found [here](https://github.com/hirosystems/chainhook/blob/develop/docs/chainhook-openapi.json).

docs/ordhook/overview.md

@@ -0,0 +1,17 @@
+---
+title: Ordhook Overview
+---
+
+## Ordinal Theory
+
+The Ordinal Theory is a protocol with a specific goal: assigning unique identifiers to newly created satoshis (sats). The protocol achieves this by introducing a numbering scheme. This numbering allows for the inclusion of arbitrary content on these satoshis. This content is referred to as _inscriptions_. These inscriptions essentially turn satoshis into Bitcoin-native digital artifacts, often referred to as Non-Fungible Tokens (NFTs). This means that you can associate additional information or data with individual satoshis.
+
+Ordinal Theory accomplishes this without requiring the use of sidechains or creating separate tokens. This makes it an attractive option for those looking to integrate, expand, or utilize this functionality within the Bitcoin ecosystem.
+Satoshis with inscriptions can be transferred through standard Bitcoin transactions, sent to regular Bitcoin addresses, and held in Bitcoin Unspent Transaction Outputs (UTXOs). The uniqueness of these transactions is identified while sending individual satoshis with inscriptions, transactions must be crafted to control the order and value of inputs and outputs following the rules defined by Ordinal Theory.
+
+## Ordhook
+
+Ordhook is an indexer designed to assist developers in creating new applications that are resistant to re-organizations (re-orgs) and are built on top of the [Ordinal Theory](https://trustmachines.co/glossary/ordinal-theory) protocol. Its primary purpose is to simplify the process for both protocol developers and users to track and discover the ownership of Ordinal Theory's inscriptions. It also provides a wealth of information about each inscription.
+Ordhook utilizes the Chainhook Software Development Kit (SDK) from the Chainhook project. This SDK is a transaction indexing engine that is aware of re-orgs and is designed for use with both Stacks and Bitcoin. The Chainhook SDK operates on first-class event-driven principles. This means it efficiently extracts transaction data from blocks and maintains a consistent view of the state of the blockchain. This helps ensure that the data retrieved remains accurate and up-to-date.
+
+Ordhook offers a valuable tool for Bitcoin developers. They can rely on it to implement feature-rich protocols and business models that make use of near-real-time information related to Ordinal inscriptions and their transfers.

docusaurus.config.js

@@ -193,6 +193,28 @@ module.exports = {
         },
       },
     ],
+    [
+      'docusaurus-plugin-remote-content',
+      {
+        name: 'remote-docs-ordhook-docs',
+        sourceBaseUrl: 'https://raw.githubusercontent.com/hirosystems/ordhook/develop/docs/',
+        outDir: 'docs/ordhook',
+        documents: ['getting-started.md', 'overview.md'],
+      },
+    ],
+    [
+      'docusaurus-plugin-remote-content',
+      {
+        name: 'remote-docs-ordhook-how-to',
+        sourceBaseUrl:
+          'https://raw.githubusercontent.com/hirosystems/ordhook/develop/docs/how-to-guides/',
+        outDir: 'docs/ordhook/how-to-guides',
+        documents: [
+          'how-to-use-ordhook-as-a-service-using-bitcoind.md',
+          'how-to-explore-ordinal-activities.md',
+        ],
+      },
+    ],
     [
       'docusaurus-plugin-remote-content',
       {
@@ -426,6 +448,7 @@ module.exports = {
               'token-metadata-api':
                 'https://github.com/hirosystems/token-metadata-api/tree/develop/docs',
               chainhook: 'https://github.com/hirosystems/chainhook/tree/develop/docs',
+              ordhook: 'https://github.com/hirosystems/ordhook/tree/develop/docs',
             };
             const [repo, ...rem] = docPath.split('/');
             if (repo in repoUrls) {

sidebars.js

@@ -348,6 +348,38 @@ module.exports = {
         'platform/faq',
       ],
     },
+    {
+      type: 'category',
+      label: 'Ordhook',
+      items: [
+        'ordhook/overview',
+        'ordhook/getting-started',
+        {
+          type: 'category',
+          label: 'How-to Guides',
+          items: [
+            'ordhook/how-to-guides/how-to-use-ordhook-as-a-service-using-bitcoind',
+            'ordhook/how-to-guides/how-to-explore-ordinal-activities',
+          ],
+        },
+        {
+          type: 'category',
+          label: 'Developer Resources',
+          items: [
+            {
+              type: 'link',
+              label: 'Contribution Guidelines',
+              href: 'https://github.com/hirosystems/ordhook/tree/develop',
+            },
+            {
+              type: 'link',
+              label: 'Discord #General',
+              href: 'https://discord.com/channels/621759717756370964/621759718192447502',
+            },
+          ],
+        },
+      ],
+    },
     {
       type: 'category',
       label: 'Stacks.js',