Shibes

ℹ️ This is a fork/based on apezord/ord-dogecoin

Key differences

‼️ DISCLAIMER: OUR CODE MAY STILL HAVE BUGS️

We included the real wonky block rewards from block 0 until block 144,999. We invite you to critically review our code in src/epoch.rs. We are convinced that doginals should use actual block rewards instead of a simplified version.

API documentation

You can find the API documentation here. Most convenient way to view the API documentation is to use the Swagger Editor. You can import the openapi.yaml file and view the API documentation via Import URL: https://raw.githubusercontent.com/verydogelabs/wonky-ord-dogecoin/main/openapi.yaml.

TL;DR How to run

Preqrequisites

You will have to launch your own Dogecoin node and have it fully synced. You can use the following guide to set up your own Dogecoin node:

1. Download latest version from Dogecoin and install it.
   1. We have tested and launched the indexer with Dogecoin Core v1.14.8.
2. Follow the installation instructions
   1. We started the Dogecoin Core with the following flags:

      dogecoind -txindex -rpcuser=foo -rpcpassword=bar -rpcport=22555 -rpcallowip=0.0.0.0/0 -rpcbind=127.0.0.1

   2. Make sure your Dogecoin node is fully synced before starting the indexer.
   3. ‼️ IMPORTANT Ensure to replace foo and bar with your own username and password. IMPORTANT ‼️
3. Start the indexer with rpc-url pointing to your Dogecoin node and the data-dir pointing to the directory where the indexer should store its data.

### Start the ord indexer / server
```shell
export RUST_LOG=info
// Set the path to the subsidies.json and starting_sats.json files
export SUBSIDIES_PATH=/home/dogeuser/wonky-ord-dogecoin/subsidies.json
export STARTING_SATS_PATH=/home/dogeuser/wonky-ord-dogecoin/starting_sats.json

# ensure the data directory exists
mkdir -p /mnt/ord-node/indexer-data-main

# replace YOUR_RPC_URL with the URL of your Dogecoin node like: http://foo:[email protected]:22555

// Start Indexing
ord --rpc-url=YOUR_RPC_URL --data-dir=/mnt/ord-node/indexer-data-main --nr-parallel-requests=16 --first-inscription-height=4609723 --first-dune-height=5084000 --index-dunes --index-transactions --index-drc20 index

// Start Indexing + Server
ord --rpc-url=YOUR_RPC_URL --data-dir=/mnt/ord-node/indexer-data-main --nr-parallel-requests=16 --first-inscription-height=4609723 --first-dune-height=5084000 --index-dunes --index-transactions --index-drc20 server

--index-transactions will store transaction data, this is currently needed for --index-drc20 and furthermore helps for a better performance for the API. --nr-parallel-requests will configure how many parallel requests while indexing are sent to your RPC Server - 16 is recommended for default node settings.

With all settings enabled, the database will currently need around 400gb when fully indexed.

Required env vars

On the root level of this repo you'll find a subsidies.json and starting_sats.json file. When starting ord you will need to set the location of these files to env variables.

Example: If your wonky-ord-dogecoin dir is /home/dogeuser/wonky-ord-dogecoin then set the vars: SUBSIDIES_PATH=/home/dogeuser/wonky-ord-dogecoin/subsidies.json and STARTING_SATS_PATH=/home/dogeuser/wonky-ord-dogecoin/starting_sats.json.

Start the ord indexer / server in Docker

You can use a docker image to run the ord indexer / server.

Prerequisites Docker

1. Use ubuntu linux or a similar distribution
2. Install dogecoind and have it fully synced 1See Dogecoin installation instructions
3. Install docker and docker-compose (Ubuntu)[https://docs.docker.com/engine/install/ubuntu/]
4. Clone this repository

Build the Docker image

docker build -t verydogelabs/wonky-ord-dogecoin .

Start the ord in a docker container

docker compose up -d

Stop the ord in a docker container

When stopping the ord in a container it is important to add a timeout. If no timeout is add, the process cannot close the database properly and the next start will take ages or fail.

docker compose stop -t 600
docker compose down

Original README

Please check the original README for more information on how to run ord and the required env vars.