Trac Core Reader for TAP Protocol

Trac Core Reader for TAP Protocol is a NodeJS-based application that provides decentralized access to indexed TAP Protocol data.

The reader basically represents a decentralized API to build upon Bitcoin Ordinal's TAP Protocol.

It sits on top of Holepunch (https://github.com/holepunchto), a set of libraries that enables decentralized data-storage and distribution.

You may run this reader within various restricted networks. Through holepunching, it will try to connect with its peers on the network through any means necessary, helping to maintain steady availability.

As a project/developer, you may use this reader in 3 different ways:

Utilizing the TracManager's native methods (see below)
Enabling REST Endpoints
Using websocket-based streaming
... or all of the above combined.

If you do not intend to develop with this package but want to support the project, you may just run it in the background to help strengthen the network.

Trac Core Reader for TAP Protocol is open-source (MIT license) and in beta state, use it on your own risk as stated in the license.

How it works

The reader connects to the Trac network by subscribing to a channel to request indexing data. Currently the indexers behind this channel are not part of the entire Trac Core release yet but will be released at a later point (the actual writers).

Once a channel has been picked (in the config or upon start), the reader will try to look for peers and starts to share data, similar to how it works with for example with Bittorrent.

This data can then be used through the different APIs that this package provides for further processing within your apps.

Channel Hopping

Should indexer upgrades require a new channel to hop on, the new channel will be broadcasted through different means by the Trac project.

Ultimately, Trac will carefully roll out an entire system that allows for automated channel hopping as well as decentralized upgrade broadcasts.

The most recent channel is always pre-defined in the reader's config of this repo.

Requirements

Linux, Windows, MacOS
NodeJS 20+
2-4 CPU Cores, 8GB RAM
150GB SSD drive (make sure it's a good one)

Should work perfectly on Pi 4-5 and low Watts.

Installation

Either download this package using git clone or install it through npmjs (if you use npmjs, you'll need to specify your entry point yourself):

git clone https://github.com/Trac-Systems/tap-reader.git
cd tap-reader
npm i
npm start

Running in background

There are several different ways to run readers in the background. We recommend to use PM2 to run and organize your readers, especially if you are running multiple instances:

https://pm2.keymetrics.io/

API Usage

Either use the reader diretly like so from within your application (please note that your app process will have exclusive access to the reader's db):

import TracManager from "./TracManager.mjs";

// Create an instance of TracManager
let tracCore = new TracManager();

// Initialize the reader for the TAP Protocol
await tracCore.initReader();

// Example: Retrieve transfer amount by inscription
let amount = await tracCore.tapProtocol.getTransferAmountByInscription('1b8e21761557bbf66c06ae3d8109764d0d8ec5d431b8291160b59ef28ffaab7ai0');

If rest is enabled, you can instead use the exposed endpoints. You may test these endpoints like this if REST is enabled in the config:

http://localhost:5099/docs

In case websockets are enabled, you can access their endpoints according to this documentation:

https://github.com/BennyTheDev/trac-tap-public-endpoint

Just swap out the given domain in that endpoint example above with your websocket url and port.

Configuration File

Defaults to ./config/default.json file, enabling websocket server if needed.

{
    "enableRest": true,
    "enableRestApiDocs": true,
    "restPort": 5099,
    "restCacheControl": {
        "maxAge": 3600,
        "public": false
    },
    "restHeaders": [
        { "name": "X-Powered-By", "value": "TracCore" },
        { "name": "Access-Control-Allow-Origin", "value": "*" }
    ],
    "enableWebsockets": false,
    "websocketPort": 5095,
    "websocketCORS": "*",
    "channel": "53b2c0e70485790d7f086edbbbb8e624a165667bc74b12034d9774c2f3ce503c",
    "enableBlockDownloader": false
}

Distributed MAINNET Data Channel "53b2c0e70485790d7f086edbbbb8e624a165667bc74b12034d9774c2f3ce503c" is the currently active LIVE channel for TAP Protocol.

Distributed TESTNET Data Channel "f505c35965a89d62cb4144f9523fc4ede43186c7c37a66b77388eaede210e051" is the currently active TEST channel for TAP Protocol.

Distributed SIGNET Data Channel "3665c09b9e6c173ba0302bee91ad036981d66a6dd9b51d83bc443c8ec2a6efd8" is the currently active TEST channel for TAP Protocol.

Trac Core Manager API

initReader([server], [client], [rangeStart], [rangeEnd]) ⇒ Promise.<void>: Initializes the reader for the TAP Protocol, setting up corestore and hyperswarm. Also configures the Hyperbee database and, optionally, a websocket and REST server.
initHyperswarm(server, client) ⇒ Promise.<void>: Initializes a Hyperswarm network connection for data synchronization.

initReader([server], [client], [rangeStart], [rangeEnd]) ⇒ `Promise.<void>`

Initializes the reader for the TAP Protocol, setting up corestore and hyperswarm. Also configures the Hyperbee database and, optionally, a websocket server.

Kind: global function
Returns: Promise.<void> - A promise that resolves when initialization is complete.

Param	Type	Default	Description
[server]	`boolean`	`true`	Whether to start as a server in the Hyperswarm network.
[client]	`boolean`	`true`	Whether to start as a client in the Hyperswarm network.
[rangeStart]	`number`	`-1`	The starting index for range-based data download.
[rangeEnd]	`number`	`-1`	The ending index for range-based data download.

initHyperswarm(server, client) ⇒ `Promise.<void>`

Initializes a Hyperswarm network connection for data synchronization.

Kind: global function
Returns: Promise.<void> - A promise that resolves when the network is initialized.

Param	Type	Description
server	`boolean`	Indicates if this instance should act as a server.
client	`boolean`	Indicates if this instance should act as a client.

Tap Protocol API

getSyncStatus() ⇒ Promise.<(Number|null)>: Retrieves the current synchronization status, indicating the percentage of blocks that have been successfully synced.

Name		Name	Last commit message	Last commit date
Latest commit History 1 Commit
config		config
patches		patches
src		src
test		test
.eslintrc.js		.eslintrc.js
.gitattributes		.gitattributes
.gitignore		.gitignore
LICENSE		LICENSE
README.md		README.md
jsdoc.conf		jsdoc.conf
package-lock.json		package-lock.json
package.json		package.json

Param	Type	Description
address	`string`	The address to query.
offset	`int`	The starting index for pagination. Optional, default `0`.
max	`int`	The maximum number of records to retrieve. Optional, default `500`.

Param	Type	Description
inscription_id	`string`	The ID of the DMT Mint to query.
offset	`int`	The starting index for pagination. Optional, default `0`.
max	`int`	The maximum number of records to retrieve. Optional, default `500`.

Param	Type	Description
address	`string`	The address for which to retrieve the balance.
ticker	`string`	The ticker of the token.

Param	Type	Description
address	`string`	The address for which to retrieve the transferable amount.
ticker	`string`	The ticker of the token.

Param	Type	Default	Description
[offset]	`number`	`0`	The starting index for retrieving deployments.
[max]	`number`	`500`	The maximum number of deployments to retrieve.

Param	Type	Default	Description
ticker	`string`		The ticker for which to retrieve holders.
[offset]	`number`	`0`	The starting index for retrieving holders.
[max]	`number`	`500`	The maximum number of holders to retrieve.

Param	Type	Default	Description
address	`string`		The address for which to retrieve tokens.
[offset]	`number`	`0`	The starting index for retrieving tokens.
[max]	`number`	`500`	The maximum number of tokens to retrieve.

Param	Type	Default	Description
[offset]	`number`	`0`	The starting index for retrieving DMT elements.
[max]	`number`	`500`	The maximum number of DMT elements to retrieve.

Param	Type	Description
address	`string`	The address for which to retrieve the mint count.
ticker	`string`	The ticker of the token.

Param	Type	Default	Description
address	`string`		The address for which to retrieve mint records.
ticker	`string`		The ticker of the token.
[offset]	`number`	`0`	The starting index for retrieving mint records.
[max]	`number`	`500`	The maximum number of mint records to retrieve.

Param	Type	Default	Description
address	`string`		The address for which to retrieve trades.
ticker	`string`		The ticker of the token.
[offset]	`number`	`0`	The starting index for retrieving trades.
[max]	`number`	`500`	The maximum number of trades to retrieve.

Param	Type	Default	Description
[offset]	`number`	`0`	The starting index for retrieving redeem records.
[max]	`number`	`500`	The maximum number of redeem records to retrieve.

Param	Type	Default	Description
address	`string`		The address for which to retrieve redeem records.
[offset]	`number`	`0`	The starting index for retrieving redeem records.
[max]	`number`	`500`	The maximum number of redeem records to retrieve.

Param	Type	Default	Description
address	`string`		The address for which to retrieve auth records.
[offset]	`number`	`0`	The starting index for retrieving auth records.
[max]	`number`	`500`	The maximum number of auth records to retrieve.

Param	Type	Default	Description
ticker	`string`		The ticker for which to retrieve trades.
[offset]	`number`	`0`	The starting index for retrieving trades.
[max]	`number`	`500`	The maximum number of trades to retrieve.

Param	Type	Default	Description
[offset]	`number`	`0`	The starting index for retrieving trade records.
[max]	`number`	`500`	The maximum number of trade records to retrieve.

Param	Type	Default	Description
address	`string`		The address for which to retrieve transfer records.
ticker	`string`		The ticker of the token.
[offset]	`number`	`0`	The starting index for retrieving transfer records.
[max]	`number`	`500`	The maximum number of transfer records to retrieve.

Param	Type	Default	Description
ticker	`string`		The ticker for which to retrieve transfer records.
[offset]	`number`	`0`	The starting index for retrieving transfer records.
[max]	`number`	`500`	The maximum number of transfer records to retrieve.

Param	Type	Description
address	`string`	The address for which to retrieve the sent count.
ticker	`string`	The ticker of the token.

Param	Type	Default	Description
address	`string`		The address for which to retrieve sent transaction records.
ticker	`string`		The ticker of the token.
[offset]	`number`	`0`	The starting index for retrieving sent transaction records.
[max]	`number`	`500`	The maximum number of sent transaction records to retrieve.

Param	Type	Description
address	`string`	The address for which to retrieve the count.
ticker	`string`	The ticker of the token.

Param	Type	Default	Description
address	`string`		The address for which to retrieve records.
ticker	`string`		The ticker of the token.
[offset]	`number`	`0`	The starting index for retrieving records.
[max]	`number`	`500`	The maximum number of records to retrieve.

Param	Type	Default	Description
address	`string`		The address for which to retrieve filled trades.
ticker	`string`		The ticker of the token.
[offset]	`number`	`0`	The starting index for retrieving filled trades.
[max]	`number`	`500`	The maximum number of filled trades to retrieve.

Param	Type	Default	Description
ticker	`string`		The ticker for which to retrieve filled trades.
[offset]	`number`	`0`	The starting index for retrieving filled trade records.
[max]	`number`	`500`	The maximum number of filled trade records to retrieve.

License

milojeBtc/tap-explorer-mainnet

Folders and files

Latest commit

History

Repository files navigation

Trac Core Reader for TAP Protocol

How it works

Channel Hopping

Requirements

Installation

Running in background

API Usage

Configuration File

Trac Core Manager API

initReader([server], [client], [rangeStart], [rangeEnd]) ⇒ Promise.<void>

initHyperswarm(server, client) ⇒ Promise.<void>

Tap Protocol API

getSyncStatus() ⇒ Promise<Object>

getReorgs() ⇒ Promise<Array|null>

getDmtMintWalletHistoricListLength(address) ⇒ Promise<number>

getDmtMintWalletHistoricList(address, offset, max) ⇒ Promise<Object[]|string>

getDmtMintHoldersHistoryListLength(inscription_id) ⇒ Promise<number>

getDmtMintHoldersHistoryList(inscription_id, offset, max) ⇒ Promise<Object[]|string>

getDmtMintHolderByBlock(block) ⇒ Promise<Object|null>

getDmtMintHolder(inscription_id) ⇒ Promise<Object|null>

getTransferAmountByInscription(inscription_id) ⇒ Promise.<(number|null)>

getDeploymentsLength() ⇒ Promise.<number>

getDeployments([offset], [max]) ⇒ Promise.<Array>

getDeployment(ticker) ⇒ Promise.<(Object|null)>

getMintTokensLeft(ticker) ⇒ Promise.<(number|null)>

getBalance(address, ticker) ⇒ Promise.<(number|null)>

getTransferable(address, ticker) ⇒ Promise.<(number|null)>

getHoldersLength(ticker) ⇒ Promise.<number>

getHolders(ticker, [offset], [max]) ⇒ Promise.<Array>

getAccountTokensLength(address) ⇒ Promise.<number>

getAccountTokens(address, [offset], [max]) ⇒ Promise.<Array>

getDmtElementsListLength() ⇒ Promise.<number>

getDmtElementsList([offset], [max]) ⇒ Promise.<Array>

getAccountMintListLength(address, ticker) ⇒ Promise.<number>

getAccountMintList(address, ticker) ⇒ Promise.<number>

getTickerMintListLength(address, ticker) ⇒ Promise.<number>

getTickerMintList(address, ticker, [offset], [max]) ⇒ Promise.<Array>

getMintListLength(ticker) ⇒ Promise.<number>

getMintList([offset], [max]) ⇒ Promise.<Array>

getTrade(inscription_id) ⇒ Promise.<(Object|null)>

getAccountTradesListLength(address, ticker) ⇒ Promise.<number>

getAccountTradesList(address, ticker, [offset], [max]) ⇒ Promise.<Array>

getAuthCancelled(inscription_id) ⇒ Promise.<boolean>

getAuthHashExists(hash) ⇒ Promise.<boolean>

getRedeemListLength() ⇒ Promise.<number>

getRedeemList([offset], [max]) ⇒ Promise.<Array>

getAccountRedeemListLength(address) ⇒ Promise.<number>

getAccountRedeemList(address, [offset], [max]) ⇒ Promise.<Array>

getAccountAuthListLength(address) ⇒ Promise.<number>

getAccountAuthList(address, [offset], [max]) ⇒ Promise.<Array>

getAuthListLength() ⇒ Promise.<number>

getAuthList([offset], [max]) ⇒ Promise.<Array>

getAccountPrivilegeAuthListLength(address) ⇒ Promise.<number>

getAccountPrivilegeAuthList(address, [offset], [max]) ⇒ Promise.<Array>

getPrivilegeAuthListLength() ⇒ Promise.<number>

getPrivilegeAuthList([offset], [max]) ⇒ Promise.<Array>

getTickerTradesListLength(ticker) ⇒ Promise.<number>

getTickerTradesList(ticker, [offset], [max]) ⇒ Promise.<Array>

getTradesListLength() ⇒ Promise.<number>

getTradesList([offset], [max]) ⇒ Promise.<Array>

getAccountTransferListLength(address, ticker) ⇒ Promise.<number>

getAccountTransferList(address, ticker, [offset], [max]) ⇒ Promise.<Array>

getTickerTransferListLength(ticker) ⇒ Promise.<number>

getTickerTransferList(ticker, [offset], [max]) ⇒ Promise.<Array>

getTransferListLength() ⇒ Promise.<number>

getTransferList([offset], [max]) ⇒ Promise.<Array>

getAccountSentListLength(address, ticker) ⇒ Promise.<number>

getAccountSentList(address, ticker, [offset], [max]) ⇒ Promise.<Array>

getAccountReceiveTradesFilledListLength(address, ticker) ⇒ Promise.<number>

getAccountReceiveTradesFilledList(address, ticker, [offset], [max]) ⇒ Promise.<Array>

getAccountTradesFilledListLength(address, ticker) ⇒ Promise.<number>

getAccountTradesFilledList(address, ticker, [offset], [max]) ⇒ Promise.<Array>

getTickerTradesFilledListLength(ticker) ⇒ Promise.<number>

getTickerTradesFilledList(ticker, [offset], [max]) ⇒ Promise.<Array>

initReader([server], [client], [rangeStart], [rangeEnd]) ⇒ `Promise.<void>`

initHyperswarm(server, client) ⇒ `Promise.<void>`

getSyncStatus() ⇒ `Promise<Object>`

getReorgs() ⇒ `Promise<Array|null>`

getDmtMintWalletHistoricListLength(address) ⇒ `Promise<number>`

getDmtMintWalletHistoricList(address, offset, max) ⇒ `Promise<Object[]|string>`

getDmtMintHoldersHistoryListLength(inscription_id) ⇒ `Promise<number>`

getDmtMintHoldersHistoryList(inscription_id, offset, max) ⇒ `Promise<Object[]|string>`

getDmtMintHolderByBlock(block) ⇒ `Promise<Object|null>`

getDmtMintHolder(inscription_id) ⇒ `Promise<Object|null>`

getTransferAmountByInscription(inscription_id) ⇒ `Promise.<(number|null)>`

getDeploymentsLength() ⇒ `Promise.<number>`

getDeployments([offset], [max]) ⇒ `Promise.<Array>`

getDeployment(ticker) ⇒ `Promise.<(Object|null)>`

getMintTokensLeft(ticker) ⇒ `Promise.<(number|null)>`

getBalance(address, ticker) ⇒ `Promise.<(number|null)>`

getTransferable(address, ticker) ⇒ `Promise.<(number|null)>`

getHoldersLength(ticker) ⇒ `Promise.<number>`

getHolders(ticker, [offset], [max]) ⇒ `Promise.<Array>`

getAccountTokensLength(address) ⇒ `Promise.<number>`

getAccountTokens(address, [offset], [max]) ⇒ `Promise.<Array>`

getDmtElementsListLength() ⇒ `Promise.<number>`

getDmtElementsList([offset], [max]) ⇒ `Promise.<Array>`

getAccountMintListLength(address, ticker) ⇒ `Promise.<number>`

getAccountMintList(address, ticker) ⇒ `Promise.<number>`

getTickerMintListLength(address, ticker) ⇒ `Promise.<number>`

getTickerMintList(address, ticker, [offset], [max]) ⇒ `Promise.<Array>`

getMintListLength(ticker) ⇒ `Promise.<number>`

getMintList([offset], [max]) ⇒ `Promise.<Array>`

getTrade(inscription_id) ⇒ `Promise.<(Object|null)>`

getAccountTradesListLength(address, ticker) ⇒ `Promise.<number>`

getAccountTradesList(address, ticker, [offset], [max]) ⇒ `Promise.<Array>`

getAuthCancelled(inscription_id) ⇒ `Promise.<boolean>`

getAuthHashExists(hash) ⇒ `Promise.<boolean>`

getRedeemListLength() ⇒ `Promise.<number>`

getRedeemList([offset], [max]) ⇒ `Promise.<Array>`

getAccountRedeemListLength(address) ⇒ `Promise.<number>`

getAccountRedeemList(address, [offset], [max]) ⇒ `Promise.<Array>`

getAccountAuthListLength(address) ⇒ `Promise.<number>`

getAccountAuthList(address, [offset], [max]) ⇒ `Promise.<Array>`

getAuthListLength() ⇒ `Promise.<number>`

getAuthList([offset], [max]) ⇒ `Promise.<Array>`

getAccountPrivilegeAuthListLength(address) ⇒ `Promise.<number>`

getAccountPrivilegeAuthList(address, [offset], [max]) ⇒ `Promise.<Array>`

getPrivilegeAuthListLength() ⇒ `Promise.<number>`

getPrivilegeAuthList([offset], [max]) ⇒ `Promise.<Array>`

getTickerTradesListLength(ticker) ⇒ `Promise.<number>`

getTickerTradesList(ticker, [offset], [max]) ⇒ `Promise.<Array>`

getTradesListLength() ⇒ `Promise.<number>`

getTradesList([offset], [max]) ⇒ `Promise.<Array>`

getAccountTransferListLength(address, ticker) ⇒ `Promise.<number>`

getAccountTransferList(address, ticker, [offset], [max]) ⇒ `Promise.<Array>`

getTickerTransferListLength(ticker) ⇒ `Promise.<number>`

getTickerTransferList(ticker, [offset], [max]) ⇒ `Promise.<Array>`

getTransferListLength() ⇒ `Promise.<number>`

getTransferList([offset], [max]) ⇒ `Promise.<Array>`

getAccountSentListLength(address, ticker) ⇒ `Promise.<number>`

getAccountSentList(address, ticker, [offset], [max]) ⇒ `Promise.<Array>`

getAccountReceiveTradesFilledListLength(address, ticker) ⇒ `Promise.<number>`

getAccountReceiveTradesFilledList(address, ticker, [offset], [max]) ⇒ `Promise.<Array>`

getAccountTradesFilledListLength(address, ticker) ⇒ `Promise.<number>`

getAccountTradesFilledList(address, ticker, [offset], [max]) ⇒ `Promise.<Array>`

getTickerTradesFilledListLength(ticker) ⇒ `Promise.<number>`

getTickerTradesFilledList(ticker, [offset], [max]) ⇒ `Promise.<Array>`

getTradesFilledListLength() ⇒ `Promise.<number>`

getTradesFilledList([offset], [max]) ⇒ `Promise.<(Array|Object)>`

getAccountReceiveListLength(address, ticker) ⇒ `Promise.<number>`

getAccountReceiveList(address, ticker, [offset], [max]) ⇒ `Promise.<(Array|Object)>`

getTickerSentListLength(ticker) ⇒ `Promise.<number>`

getTickerSentList(ticker, [offset], [max]) ⇒ `Promise.<(Array|Object)>`

getSentListLength() ⇒ `Promise.<number>`

getSentList([offset], [max]) ⇒ `Promise.<(Array|Object)>`

getAccumulator(inscription) ⇒ `Promise.<(Object|null)>`

getAccountAccumulatorListLength(address) ⇒ `Promise.<number>`

getAccountAccumulatorList(address, [offset], [max]) ⇒ `Promise.<(Array|Object)>`

getAccumulatorListLength() ⇒ `Promise.<number>`

getAccumulatorList([offset], [max]) ⇒ `Promise.<(Array|Object)>`

getListRecords(length_key, iterator_key, offset, max, return_json) ⇒ `Promise.<(Array|Object|string)>`

getLength(length_key) ⇒ `Promise.<number>`

Packages

Param	Type	Description
address	`string`	The Bitcoin address to query.
ticker	`string`	The ticker symbol for the token.

Param	Type	Default	Description
[offset]	`number`	`0`	The starting index for retrieving accumulator records.
[max]	`number`	`500`	The maximum number of accumulators to retrieve.

Param	Type	Description
length_key	`string`	The key to determine the length of the list.
iterator_key	`string`	The key used for iterating over the list.
offset	`number`	The starting index for retrieving records.
max	`number`	The maximum number of records to retrieve.
return_json	`boolean`	Whether to return the records as JSON objects.