Skip to main content

chronik-client

Classes​

Interfaces​

Type Aliases​

AlpTokenType_Type​

Ƭ AlpTokenType_Type: "ALP_TOKEN_TYPE_STANDARD" | "ALP_TOKEN_TYPE_UNKNOWN"

Possible ALP token types returned by chronik

Defined in​

src/ChronikClientNode.ts:1166

BlockMsgType​

Ƭ BlockMsgType: "BLK_CONNECTED" | "BLK_DISCONNECTED" | "BLK_FINALIZED" | "UNRECOGNIZED"

Block message types that can come from chronik

Defined in​

src/ChronikClientNode.ts:1358

Network​

Ƭ Network: "BCH" | "XEC" | "XPI" | "XRG"

Different networks of txs/blocks/UTXOs. Supported are BCH, eCash, Lotus and Ergon.

Defined in​

src/ChronikClient.ts:1116

ScriptType​

Ƭ ScriptType: "other" | "p2pk" | "p2pkh" | "p2sh" | "p2tr-commitment" | "p2tr-state"

Script type queried in the script method.

  • other: Script type not covered by the standard script types; payload is the raw hex.
  • p2pk: Pay-to-Public-Key (<pk> OP_CHECKSIG), payload is the hex of the pubkey (compressed (33 bytes) or uncompressed (65 bytes)).
  • p2pkh: Pay-to-Public-Key-Hash (OP_DUP OP_HASH160 <pkh> OP_EQUALVERIFY OP_CHECKSIG). Payload is the 20 byte public key hash.
  • p2sh: Pay-to-Script-Hash (OP_HASH160 <sh> OP_EQUAL). Payload is the 20 byte script hash.
  • p2tr-commitment: Pay-to-Taproot (OP_SCRIPTTYPE OP_1 <commitment> <state>?), only on Lotus. Queries by the commitment. Payload is the 33 byte commitment.
  • p2tr-state: Pay-to-Taproot (OP_SCRIPTTYPE OP_1 <commitment> <state>), only on Lotus. Queries by the state. Payload is the 32 byte state.

Defined in​

src/ChronikClient.ts:1163

ScriptType_InNode​

Ƭ ScriptType_InNode: "other" | "p2pk" | "p2pkh" | "p2sh"

Script type queried in the script method.

  • other: Script type not covered by the standard script types; payload is the raw hex.
  • p2pk: Pay-to-Public-Key (<pk> OP_CHECKSIG), payload is the hex of the pubkey (compressed (33 bytes) or uncompressed (65 bytes)).
  • p2pkh: Pay-to-Public-Key-Hash (OP_DUP OP_HASH160 <pkh> OP_EQUALVERIFY OP_CHECKSIG). Payload is the 20 byte public key hash.
  • p2sh: Pay-to-Script-Hash (OP_HASH160 <sh> OP_EQUAL). Payload is the 20 byte script hash.

Defined in​

src/ChronikClientNode.ts:1341

SlpTokenType​

Ƭ SlpTokenType: "FUNGIBLE" | "NFT1_GROUP" | "NFT1_CHILD" | "UNKNOWN_TOKEN_TYPE"

Which SLP token type (normal fungible, NFT, unknown).

Defined in​

src/ChronikClient.ts:1127

SlpTokenType_InNode_Type​

Ƭ SlpTokenType_InNode_Type: "SLP_TOKEN_TYPE_FUNGIBLE" | "SLP_TOKEN_TYPE_MINT_VAULT" | "SLP_TOKEN_TYPE_NFT1_GROUP" | "SLP_TOKEN_TYPE_NFT1_CHILD" | "SLP_TOKEN_TYPE_UNKNOWN"

Possible SLP token types returned by chronik

Defined in​

src/ChronikClientNode.ts:1176

SlpTxType​

Ƭ SlpTxType: "GENESIS" | "SEND" | "MINT" | "BURN" | "UNKNOWN_TX_TYPE"

Which SLP tx type.

Defined in​

src/ChronikClient.ts:1119

SubscribeMsg​

Ƭ SubscribeMsg: Error | MsgAddedToMempool | MsgRemovedFromMempool | MsgConfirmed | MsgReorg | MsgBlockConnected | MsgBlockDisconnected

Message returned from the WebSocket.

Defined in​

src/ChronikClient.ts:1040

TokenStatus​

Ƭ TokenStatus: "TOKEN_STATUS_NON_TOKEN" | "TOKEN_STATUS_NORMAL" | "TOKEN_STATUS_NOT_NORMAL" | "TOKEN_STATUS_UNKNOWN"

TokenStatus TOKEN_STATUS_NON_TOKEN - Tx involves no tokens whatsover, i.e. neither any burns nor any failed parsing/coloring or any tokens being created / moved. TOKEN_STATUS_NORMAL - Tx involves tokens but no unintentional burns or failed parsings/colorings TOKEN_STATUS_NOT_NORMAL - Tx involves tokens but contains unintentional burns or failed parsings/colorings TOKEN_STATUS_UNKNOWN - Token tx of unknown status

Defined in​

src/ChronikClientNode.ts:1199

TokenTxType​

Ƭ TokenTxType: "NONE" | "UNKNOWN" | "GENESIS" | "SEND" | "MINT" | "BURN"

SLP/ALP tx type

Defined in​

src/ChronikClientNode.ts:1213

TokenType​

Ƭ TokenType: SlpTokenType_InNode | AlpTokenType

SLP/ALP token type

Defined in​

src/ChronikClientNode.ts:1151

TxMsgType​

Ƭ TxMsgType: "TX_ADDED_TO_MEMPOOL" | "TX_REMOVED_FROM_MEMPOOL" | "TX_CONFIRMED" | "TX_FINALIZED" | "UNRECOGNIZED"

Tx message types that can come from chronik

Defined in​

src/ChronikClientNode.ts:1381

UtxoStateVariant​

Ƭ UtxoStateVariant: "UNSPENT" | "SPENT" | "NO_SUCH_TX" | "NO_SUCH_OUTPUT"

State of a transaction output.

  • UNSPENT: The UTXO is unspent.
  • SPENT: The output is spent and no longer part of the UTXO set.
  • NO_SUCH_TX: The tx queried does not exist.
  • NO_SUCH_OUTPUT: The output queried does not exist, but the tx does exist.

Defined in​

src/ChronikClient.ts:1140

WsMsgClient​

Ƭ WsMsgClient: Error_InNode | MsgBlockClient | MsgTxClient

Message returned from the WebSocket, translated to be more human-readable for client

Defined in​

src/ChronikClientNode.ts:1344

Variables​

ALP_TOKEN_TYPES​

• Const ALP_TOKEN_TYPES: AlpTokenType_Type[]

Defined in​

src/ChronikClientNode.ts:1170