Skip to content

Latest commit

 

History

History
137 lines (87 loc) · 4.55 KB

README.md

File metadata and controls

137 lines (87 loc) · 4.55 KB
Raw

LooLockJS Indexer

Introduction

The LooLockJS indexer is a NodeJS program that Bitcoin transactions containing a lockup script prefix, and adhere to the MAP protocol.

The indexer requires an instance of mysql running on the same machine the indexer runs on.

Installation

Clone this repository, then run the command:

npm install

Configuration

Create a .env file with the following parameters (THIS IS MANDATORY):

Name Description Example
DATABASE_NAME Name of mysql database schema locks
DATABASE_USER mysql user with access to database root
DATABASE_HOST host of mysql instance localhost
DATABASE_PASSWORD mysql password for DATABASE_USER p@ssw0rd
SERVER_PORT PORT that server.js runs on 9007
MAP_SUBSCRIPTION JungleBus Subscription ID to fetch MAP Bitcoin transactions
API_URL HTTP URL where server is running
BLOCK_HEIGHT Block height to populate the lockcrawl table with upon initial indexing 808839

Setup

Start the Express server that hosts the endpoints:

node server

This will initialize the database with 4 tables, locks, likes, replies and lockcrawl

lockcrawl manages the synced block height and hash. The indexer will start from this height if the lockcrawl table is empty.

locks, likes and replies contains locking BSocial records, with its content, context, satoshis locked, until which block height and more.

Create a Subscription on JungleBus, with Output types set to map.

Set this value in the MAP_SUBSCRIPTION field in the .env file before continuing.

Once complete run the JungleBus indexer:

npm run idx

Database Schema

locks

Name Description Data Type Example
txid Bitcoin transaction ID varchar(64)
satoshis Amount of satoshis locked bigint 2100000000
address Address of private key that signs to unlock the coins bigint 2100000000
lockHeight Block when satoshis unlock int 1000000
content BSocial content MEDIUMTEXT Keep fading, anon
app BSocial app name varchar(64) hodlocker.com
paymail Paymail of locker and poster varchar(100) cryptoacorns@relayx.io
txBlockHeight Block height of txid int 809000
likedTxid LooLiked txid varchar(64)
contextTx Replied txid, or other context varchar(64)
blockIndex Index of transaction in the block INT

lockcrawl

Name Description Data Type Example
hash Block height varchar(64)
height Block hash int 1000000

replies

likes

lockusers

Endpoints

To be documented -

Special steps

Once synced to the current block height, please execute the following steps IN ORDER -

  1. Stop the indexer

  2. BSocial implementation

Locks started adhering to the BSocial protocol from block height 808839.

The locktx_before_BSocial.csv contains all records before this point, and is compatible with the locks table schema.

Import it using a client such as mysql workbench, or leverage the code in the update.js file.

  1. Update paymail on pre-BSocial records

Run the following mysql script to update the missing addresses on the above records:

update locks inner join lockusers on lockusers.paymail = locks.paymail 
SET locks.address = lockusers.address
where locks.address is null

  1. Paymail mapping

The missing_paymail_tx.csv contains txids mapped to paymails from the LooLike bug in September 2023, as well as from RelayX accounts that have made on-chain transactions for where there was no on-chain paymail mapping.

Run the update.js file after the database is populated up to block height 812414:

node update

  1. Update paymails on like table

Run the following mysql script to update the missing paymails on like records:

update likes inner join lockusers on lockusers.address = likes.address
set likes.paymail = lockusers.paymail
where likes.paymail = ''

  1. Update paymails on the locks table:

Run the following mysql script to update the missing paymails on lock records:

update locks inner join lockusers on lockusers.address = locks.address
set locks.paymail = lockusers.paymail
where locks.paymail = ''

  1. Start the indexer again