Skip to content

Commit fde7cdd

Browse files
committed
copy tweaks
1 parent 5467b49 commit fde7cdd

File tree

4 files changed

+82
-51
lines changed

4 files changed

+82
-51
lines changed

content/docs/bitcoin/index.mdx

+7-20
Original file line numberDiff line numberDiff line change
@@ -49,18 +49,18 @@ import heroImage from '@/public/bitcoin-hero.svg';
4949

5050
<div className='flex flex-col'>
5151

52-
<h4 id="explore-ordinals" className="text-[#595650] dark:text-[#8c877d] scroll-m-20">
53-
<a href="#explore-ordinals" className="not-prose group text-sm uppercase">Explore Ordinals</a>
52+
<h4 id="explore-bitcoin" className="text-[#595650] dark:text-[#8c877d] scroll-m-20">
53+
<a href="#explore-bitcoin" className="not-prose group text-sm uppercase">Explore Bitcoin</a>
5454
</h4>
5555

5656
---
5757

5858
<Cards>
5959
<SmallCard
6060
icon={<Ordinals />}
61-
href="/bitcoin/ordinals/api"
62-
title="Ordinals API"
63-
description="Fetch on-chain data for Ordinals and meta-protocols with our hosted API."
61+
href="/bitcoin/indexer"
62+
title="Bitcoin Indexer"
63+
description="Use the Bitcoin Indexer to index and query Bitcoin blockchain data."
6464
/>
6565
<SmallCard
6666
icon={<API />}
@@ -70,23 +70,10 @@ import heroImage from '@/public/bitcoin-hero.svg';
7070
/>
7171
<SmallCard
7272
icon={<Play />}
73-
href="/ordinals/explorer"
74-
title="Explorer"
73+
href="https://ordinals.hiro.so/"
74+
title="Ordinals Explorer"
7575
description="View on-chain data for Ordinals and meta-protocols with our explorer."
7676
/>
77-
</Cards>
78-
79-
</div>
80-
81-
<div className='flex flex-col'>
82-
83-
<h4 id="explore-runes" className="text-[#595650] dark:text-[#8c877d] scroll-m-20">
84-
<a href="#explore-runes" className="not-prose group text-sm uppercase">Explore Runes</a>
85-
</h4>
86-
87-
---
88-
89-
<Cards>
9077
<SmallCard
9178
icon={<API />}
9279
href="/bitcoin/runes/api"

content/docs/bitcoin/indexer/index.mdx

+25-15
Original file line numberDiff line numberDiff line change
@@ -8,28 +8,38 @@ import { Step, Steps } from 'fumadocs-ui/components/steps';
88

99
The Bitcoin Indexer is a reorg-aware indexer that automatically handles chain forks, so you don't need to waste time or resources reindexing your database yourself.
1010

11-
With a familiar event-driven framework, you can customize what ordinals data you index in order to create lightweight databases for faster query responses and a better user experience.
11+
You can customize what ordinals data you index in order to create lightweight databases for faster query responses and a better user experience.
1212

13-
## Create event streams
13+
## Installation
14+
15+
```terminal
16+
$ git clone https://github.com/hirosystems/bitcoin-indexer.git
17+
$ cd bitcoin-indexer
18+
$ cargo bitcoin-indexer-install
19+
```
20+
21+
Alternatively, you can use Docker images from [Docker Hub](https://hub.docker.com/r/hirosystems/bitcoin-indexer).
22+
23+
## Get started
1424

1525
<Cards>
1626
<SecondaryCard
17-
href="/bitcoin/indexer/guides/scan-ordinals-activity"
18-
title="Scan past Ordinals activity"
19-
description="Fetch historical ordinals activity, whether for a range of blocks or for a particular inscription."
20-
/>
21-
<SecondaryCard
22-
href="/bitcoin/indexer/guides/stream-ordinals-activity"
23-
title="Stream Ordinals activity"
24-
description="Create webhook-like triggers that target and post ordinal activity to a custom source."
25-
/>
26-
<SecondaryCard
27-
href="/bitcoin/indexer/guides/indexer-as-a-service"
28-
title="Run Indexer as a Service"
29-
description="Interact and manage incoming Ordinals activity with your own service."
27+
href="/bitcoin/indexer/quickstart"
28+
title="Quickstart"
29+
description="Learn how to scan for Bitcoin activity using the Bitcoin Indexer."
3030
/>
3131
</Cards>
3232

33+
## System Requirements
34+
35+
Before running the indexer, ensure your system meets these requirements:
36+
37+
- **CPU**: Multi-core support for parallel processing
38+
- **Memory**: Minimum 16GB RAM
39+
- **Storage**: SSD or NVMe recommended
40+
- **OS**: Support for 4096+ open file descriptors
41+
- **Postgres**: Version 17+ recommended
42+
3343
## Related tools
3444

3545
- **[Ordinals API](/bitcoin/ordinals/api)**: Skip the infrastructure setup and get the ordinals data you need from our Ordinals API, which is powered by the Bitcoin Indexer.

content/docs/bitcoin/indexer/installation.mdx

-12
This file was deleted.

content/docs/bitcoin/indexer/quickstart.mdx

+50-4
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,51 @@ description: Learn how to scan the Bitcoin blockchain for Ordinals activity.
55

66
import { Steps, Step } from 'fumadocs-ui/components/steps';
77

8-
In this quickstart guide, you will set up the Bitcoin Indexer to index Ordinals activity on the Bitcoin blockchain.
8+
In this quickstart guide, you will set up the Bitcoin Indexer to index Ordinals or Runes activity on the Bitcoin blockchain.
99

1010
<Steps>
11-
<Step>
12-
11+
<Step title="Install Bitcoin Indexer">
12+
Clone the repository and install the indexer:
13+
```terminal
14+
$ git clone https://github.com/hirosystems/bitcoin-indexer.git
15+
$ cd bitcoin-indexer
16+
$ cargo bitcoin-indexer-install
17+
```
18+
</Step>
19+
20+
<Step title="Configure the Indexer">
21+
Generate a new configuration file:
22+
```terminal
23+
$ bitcoin-indexer config new
24+
```
25+
26+
Configure your Postgres database in the generated TOML file:
27+
```toml
28+
[ordinals.db]
29+
database = "metaprotocols"
30+
host = "localhost"
31+
port = 5432
32+
username = "postgres"
33+
password = "postgres"
34+
```
35+
</Step>
36+
37+
<Step title="Start the Indexer">
38+
Run the following command to start indexing Ordinals activity:
39+
```terminal
40+
$ bitcoin-indexer ordinals service start --config-path <path>
41+
```
42+
43+
For Runes indexing, use:
44+
```terminal
45+
$ bitcoin-indexer runes service start --config-path <path>
46+
```
1347
</Step>
1448
</Steps>
1549

16-
---
50+
<Callout type="info">
51+
A fully synced Bitcoin node is required for indexing to start.
52+
</Callout>
1753

1854
## Next steps
1955

@@ -23,4 +59,14 @@ In this quickstart guide, you will set up the Bitcoin Indexer to index Ordinals
2359
title="Ordinals Explorer"
2460
description="Explore the Ordinals Explorer to view inscriptions and transfers."
2561
/>
62+
<Card
63+
href="/bitcoin/ordinals/api"
64+
title="Ordinals API"
65+
description="Learn how to interact with Ordinals data using our API."
66+
/>
67+
<Card
68+
href="/bitcoin/runes/api"
69+
title="Runes API"
70+
description="Explore our Runes blockchain API documentation."
71+
/>
2672
</Cards>

0 commit comments

Comments
 (0)