xpi-ts 0.2.22 → 0.2.24

package/dist/types/lib/rank/api.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../../../lib/rank/api.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,YAAY,GAAG;IACzB,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AACD,MAAM,MAAM,iBAAiB,GAAG;IAC9B,UAAU,EAAE,MAAM,CAAA;IAClB,aAAa,EAAE,MAAM,CAAA;IACrB,SAAS,EAAE,MAAM,CAAA;IACjB,WAAW,EAAE,MAAM,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,gBAAgB,EAAE,OAAO,CAAA;IACzB,kBAAkB,EAAE,OAAO,CAAA;IAC3B,YAAY,EAAE,MAAM,EAAE,CAAA;IACtB,cAAc,EAAE,MAAM,EAAE,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,MAAM,CAAA;IACjB,aAAa,EAAE,MAAM,CAAA;IACrB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB,CAAA;AACD,MAAM,MAAM,kBAAkB,GAAG,cAAc,GAAG;IAChD,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG,cAAc,GAAG;IAChD,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,MAAM,CAAA;IAChB,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,cAAc,CAAC,EAAE,UAAU,CAAA;IAC3B,WAAW,CAAC,EAAE,OAAO,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,UAAU,GAAG,aAAa,GAAG;IACvC,OAAO,EAAE,MAAM,CAAA;IACf,YAAY,EAAE,MAAM,CAAA;IACpB,YAAY,EAAE,MAAM,CAAA;IACpB,aAAa,EAAE,MAAM,CAAA;IACrB,aAAa,EAAE,MAAM,CAAA;IAErB,KAAK,CAAC,EAAE,kBAAkB,EAAE,CAAA;IAE5B,QAAQ,CAAC,EAAE,kBAAkB,EAAE,CAAA;IAE/B,KAAK,CAAC,EAAE,OAAO,EAAE,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,OAAO,GAAG,aAAa,GAAG;IACpC,OAAO,EAAE,MAAM,CAAA;IACf,YAAY,EAAE,MAAM,CAAA;IACpB,YAAY,EAAE,MAAM,CAAA;IACpB,aAAa,EAAE,MAAM,CAAA;IACrB,aAAa,EAAE,MAAM,CAAA;IACrB,OAAO,EAAE,UAAU,CAAA;IACnB,MAAM,EAAE,MAAM,CAAA;IAEd,KAAK,CAAC,EAAE,kBAAkB,EAAE,CAAA;IAE5B,QAAQ,CAAC,EAAE,kBAAkB,EAAE,CAAA;IAE/B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,QAAQ,CAAA;CACpB,CAAA;AAGD,eAAO,MAAM,kBAAkB;;;CAG9B,CAAA"}
+{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../../../lib/rank/api.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,YAAY,GAAG;IACzB,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AACD,MAAM,MAAM,iBAAiB,GAAG;IAC9B,UAAU,EAAE,MAAM,CAAA;IAClB,aAAa,EAAE,MAAM,CAAA;IACrB,SAAS,EAAE,MAAM,CAAA;IACjB,WAAW,EAAE,MAAM,CAAA;CACpB,CAAA;AACD,MAAM;AACN,MAAM,MAAM,QAAQ,GAAG;IACrB,gBAAgB,EAAE,OAAO,CAAA;IACzB,kBAAkB,EAAE,OAAO,CAAA;IAC3B,YAAY,EAAE,MAAM,EAAE,CAAA;IACtB,cAAc,EAAE,MAAM,EAAE,CAAA;CACzB,CAAA;AACD,sDAAsD;AACtD,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,MAAM,CAAA;IACjB,aAAa,EAAE,MAAM,CAAA;IACrB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB,CAAA;AACD,MAAM,MAAM,kBAAkB,GAAG,cAAc,GAAG;IAChD,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA;AACD,kDAAkD;AAClD,MAAM,MAAM,kBAAkB,GAAG,cAAc,GAAG;IAChD,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,MAAM,CAAA;IAChB,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,cAAc,CAAC,EAAE,UAAU,CAAA;IAC3B,WAAW,CAAC,EAAE,OAAO,CAAA;CACtB,CAAA;AACD,MAAM;AACN,MAAM,MAAM,aAAa,GAAG;IAC1B,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AACD,qDAAqD;AACrD,MAAM,MAAM,UAAU,GAAG,aAAa,GAAG;IACvC,OAAO,EAAE,MAAM,CAAA;IACf,YAAY,EAAE,MAAM,CAAA;IACpB,YAAY,EAAE,MAAM,CAAA;IACpB,aAAa,EAAE,MAAM,CAAA;IACrB,aAAa,EAAE,MAAM,CAAA;IACrB,oDAAoD;IACpD,KAAK,CAAC,EAAE,kBAAkB,EAAE,CAAA;IAC5B,2CAA2C;IAC3C,QAAQ,CAAC,EAAE,kBAAkB,EAAE,CAAA;IAC/B,wCAAwC;IACxC,KAAK,CAAC,EAAE,OAAO,EAAE,CAAA;CAClB,CAAA;AACD,kDAAkD;AAClD,MAAM,MAAM,OAAO,GAAG,aAAa,GAAG;IACpC,OAAO,EAAE,MAAM,CAAA;IACf,YAAY,EAAE,MAAM,CAAA;IACpB,YAAY,EAAE,MAAM,CAAA;IACpB,aAAa,EAAE,MAAM,CAAA;IACrB,aAAa,EAAE,MAAM,CAAA;IACrB,OAAO,EAAE,UAAU,CAAA;IACnB,MAAM,EAAE,MAAM,CAAA;IACd,iDAAiD;IACjD,KAAK,CAAC,EAAE,kBAAkB,EAAE,CAAA;IAC5B,wCAAwC;IACxC,QAAQ,CAAC,EAAE,kBAAkB,EAAE,CAAA;IAC/B,mDAAmD;IACnD,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,QAAQ,CAAA;CACpB,CAAA;AAED,mFAAmF;AACnF,eAAO,MAAM,kBAAkB;;;CAG9B,CAAA"}

package/dist/types/lib/rank/index.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Copyright 2025 The Lotusia Stewardship
+ * Github: https://github.com/LotusiaStewardship
+ * License: MIT
+ */
 import { Buffer } from 'buffer/';
 import OpCode from './opcode.js';
 export type ScriptChunkLokadUTF8 = 'RANK' | 'RNKC';
@@ -8,32 +13,50 @@ export type ScriptChunkPlatformMap = Map<number, ScriptChunkPlatformUTF8>;
 export type ScriptChunkSentimentMap = Map<number, ScriptChunkSentimentUTF8>;
 export type ScriptChunkField = 'sentiment' | 'platform' | 'profileId' | 'postId' | 'comment' | 'postHash' | 'instanceId';
 export type ScriptChunk = {
+    /** Byte offset of the chunk in the output script */
     offset: number | null;
+    /** Byte length of the chunk in the output script */
     len: number | null;
+    /** Map of supported RANK script chunks */
     map?: ScriptChunkLokadMap | ScriptChunkPlatformMap | ScriptChunkSentimentMap;
 };
+/** Required RNKC script chunks */
 export type ScriptChunksRNKC = {
     [name in Exclude<ScriptChunkField, 'sentiment' | 'postHash' | 'instanceId'>]: ScriptChunk;
 };
+/** Required RANK script chunks */
 export type ScriptChunksRANK = {
     [name in Exclude<ScriptChunkField, 'comment' | 'postId' | 'postHash' | 'instanceId'>]: ScriptChunk;
 };
+/** Optional RANK script chunks */
 export type ScriptChunksOptionalRANK = {
     [name in Extract<ScriptChunkField, 'postId' | 'postHash' | 'instanceId'>]: ScriptChunk;
 };
+/** OP_RETURN \<RANK\> \<sentiment\> \<profileId\> [\<postId\> \<postHash\> [\<instanceId\>]] */
 export type TransactionOutputRANK = {
+    /** positive or negative sentiment (can support more) */
     sentiment: ScriptChunkSentimentUTF8;
+    /** e.g. Twitter/X.com, etc. */
     platform: ScriptChunkPlatformUTF8;
+    /** who the ranking is for */
     profileId: string;
+    /** optional post ID if ranking specific content */
     postId?: string;
 };
+/** OP_RETURN \<RNKC\> \<platform\> \<profileId\> \<postId\> */
 export type TransactionOutputRNKC = {
+    /** outIdx 1 and 2 concatenated as comment data in UTF-8 encoding */
     data: Uint8Array;
+    /** Minimum fee rate for accepting RNKC transaction, in satoshis per byte */
     feeRate: number;
+    /** e.g. Twitter/X.com, etc. */
     inReplyToPlatform: ScriptChunkPlatformUTF8;
+    /** who the comment is replying to */
     inReplyToProfileId?: string;
+    /** ID of the post being replied to */
     inReplyToPostId?: string;
 };
+/** Transaction data for the backend indexer */
 export type Transaction = {
     txid: string;
     outIdx: number;
@@ -44,8 +67,11 @@ export type Transaction = {
     height?: number;
     timestamp?: bigint;
 };
+/** RANK transaction data for the backend indexer */
 export type TransactionRANK = TransactionOutputRANK & Transaction;
+/** RNKC transaction data for the backend indexer */
 export type TransactionRNKC = TransactionOutputRNKC & Transaction;
+/** Target entity being ranked by a RANK transaction, commented on by an RNKC transaction, etc. (e.g. Profile, Post, etc.) */
 export type TargetEntity = {
     id: string;
     platform: string;
@@ -57,15 +83,24 @@ export type TargetEntity = {
     votesPositive: number;
     votesNegative: number;
 };
+/**
+ * `IndexedTransactionRANK` objects are converted to a `ProfileMap` for database ops
+ *
+ * `string` is `profileId`
+ */
 export type ProfileMap = Map<string, Profile>;
 export type PostMap = Map<string, Post>;
+/**  */
 export type Profile = TargetEntity & {
     posts?: PostMap;
 };
+/**  */
 export type Post = TargetEntity & {
     profileId: string;
+    /** If this post is a RNKC transaction, this is set for establishing relation to `RankComment` */
     data?: Uint8Array;
 };
+/** Platform parameters */
 export type PlatformParameters = {
     profileId: {
         len: number;
@@ -77,49 +112,167 @@ export type PlatformParameters = {
         type: 'BigInt' | 'Number' | 'String';
     };
 };
+/** LOKAD chunk map */
 export declare const LOKAD_PREFIX_RANK = 1380011595;
 export declare const LOKAD_PREFIX_RNKC = 1380862787;
 export declare const SCRIPT_CHUNK_LOKAD: ScriptChunkLokadMap;
 export declare const RANK_SENTIMENT_NEUTRAL = OpCode.OP_16;
 export declare const RANK_SENTIMENT_POSITIVE = OpCode.OP_1;
 export declare const RANK_SENTIMENT_NEGATIVE = OpCode.OP_0;
+/** Sentiment chunk map */
 export declare const SCRIPT_CHUNK_SENTIMENT: ScriptChunkSentimentMap;
+/** Sentiment OP code map */
 export declare const RANK_SENTIMENT_OP_CODES: Map<ScriptChunkSentimentUTF8, string>;
+/** Platform chunk map */
 export declare const SCRIPT_CHUNK_PLATFORM: ScriptChunkPlatformMap;
+/** Required RANK Comment script chunks */
 export declare const ScriptChunksRNKCMap: Map<keyof ScriptChunksRNKC, ScriptChunk>;
+/** Length of the required RANK script chunks in bytes */
 export declare const RANK_SCRIPT_REQUIRED_LENGTH = 10;
+/** Required RANK script chunks */
 export declare const ScriptChunksRANKMap: Map<keyof ScriptChunksRANK, ScriptChunk>;
 export declare const ScriptChunksOptionalRANKMap: Map<keyof ScriptChunksOptionalRANK, ScriptChunk>;
+/** Platform configuration */
 export declare const PlatformConfiguration: Map<ScriptChunkPlatformUTF8, PlatformParameters>;
+/**
+ * RANK script utilities
+ */
+/**
+ * Convert the profile ID to a buffer
+ * @param platform - The platform to convert the profile ID for
+ * @param profileId - The profile ID to convert
+ * @returns The profile ID buffer
+ */
 export declare function toProfileIdBuf(platform: ScriptChunkPlatformUTF8, profileId: string): Buffer | null;
+/**
+ * Convert the `OP_RETURN` profile name back to UTF-8 with null bytes removed
+ * @param profileIdBuf - The profile ID buffer to convert, padded with null bytes
+ * @returns The UTF-8 profile ID
+ */
 export declare function toProfileIdUTF8(profileIdBuf: Buffer): string;
+/**
+ * Convert the post ID to a buffer
+ * @param platform - The platform to convert the post ID for
+ * @param postId - The post ID to convert
+ * @returns The post ID buffer
+ */
 export declare function toPostIdBuf(platform: ScriptChunkPlatformUTF8, postId: string): Buffer | undefined;
+/**
+ * Convert the UTF-8 platform name to the defined 1-byte platform hex code
+ * @param platform
+ * @returns
+ */
 export declare function toPlatformBuf(platform: ScriptChunkPlatformUTF8): Buffer | undefined;
+/**
+ * Convert the defined 1-byte platform hex code to the UTF-8 platform name
+ * @param platformBuf
+ */
 export declare function toPlatformUTF8(platformBuf: Buffer): ScriptChunkPlatformUTF8 | undefined;
+/**
+ * Convert the UTF-8 sentiment name to the defined 1-byte OP code
+ * @param sentiment
+ * @returns
+ */
 export declare function toSentimentOpCode(sentiment: ScriptChunkSentimentUTF8): string | undefined;
+/**
+ * Convert the defined 1-byte sentiment OP code to the UTF-8 sentiment name
+ * @param sentimentBuf
+ */
 export declare function toSentimentUTF8(sentimentBuf: Buffer): ScriptChunkSentimentUTF8 | undefined;
+/**
+ * Convert the comment buffer to a UTF-8 string
+ * @param commentBuf - The comment buffer to convert
+ * @returns The UTF-8 string
+ */
 export declare function toCommentUTF8(commentBuf: Buffer | Uint8Array): string | undefined;
+/**
+ * Create a hex-encoded RANK script from the given parameters
+ * @param sentiment - The sentiment to use
+ * @param platform - The platform to use
+ * @param profileId - The profile ID to use
+ * @param postId - The post ID to use
+ * @returns The hex-encoded RANK script, as `Buffer`
+ */
 export declare function toScriptRANK(sentiment: ScriptChunkSentimentUTF8, platform: ScriptChunkPlatformUTF8, profileId: string, postId?: string): Buffer;
+/**
+ * Create a hex-encoded RANK Comment script from the given parameters
+ *
+ * RNKC requires 2 output scripts at minimum, so we return output scripts in an
+ * array of `Buffer` objects according to outIdx.
+ * @param platform - The platform to use
+ * @param profileId - The profile ID to use
+ * @param postId - The post ID to use
+ * @param comment - The comment to use
+ * @returns The hex-encoded RANK Comment script
+ */
 export declare function toScriptRNKC({ platform, profileId, postId, comment, }: {
     platform: ScriptChunkPlatformUTF8;
     profileId: string;
     postId?: string;
     comment: string;
 }): Buffer[];
+/**
+ * Processor for defined LOKAD protocols (RANK, RNKC, etc.)
+ * @param script - The script to process, as a `Buffer`
+ */
 export declare class ScriptProcessor {
     private chunks;
+    /** The script to process, as a `Buffer` */
     private script;
+    /** Supplemental scripts, e.g. outIdx 1 and/or 2 for RNKC */
     private supplementalScripts;
     constructor(script: Buffer);
+    /**
+     * Add a supplemental OP_RETURN script to the processor
+     * @param script - The script to add, as a `Buffer`
+     * @returns true if the script was added, false otherwise
+     */
     addScript(script: string | Buffer): boolean;
+    /**
+     * Get the LOKAD type from the script
+     * @returns The LOKAD type or undefined if invalid
+     */
     get lokadType(): ScriptChunkLokadUTF8 | undefined;
+    /**
+     * Process the LOKAD chunk
+     * @returns The LOKAD value or undefined if invalid
+     */
     private processLokad;
+    /**
+     * Process the sentiment chunk (RANK)
+     * @returns The sentiment value or undefined if invalid
+     */
     private processSentiment;
+    /**
+     * Process the platform chunk
+     * @returns The platform value or undefined if invalid
+     */
     private processPlatform;
+    /**
+     * Process the profileId chunk
+     * @returns The profileId value or undefined if invalid
+     */
     private processProfileId;
+    /**
+     * Process the postId chunk
+     * @returns The postId value or undefined if invalid
+     */
     private processPostId;
+    /**
+     * Process the RNKC comment chunks (outIdx 1 and 2)
+     * @param scripts - outIdx 1 and 2 scripts, if outIdx 0 is RNKC
+     * @returns The comment value or null if invalid
+     */
     private processComment;
+    /**
+     * Validate the required RANK chunks and store the processed output
+     * @returns true if all required chunks are valid, false otherwise
+     */
     processScriptRANK(): TransactionOutputRANK | null;
+    /**
+     * Validate the required RNKC chunks and store the processed output
+     * @returns true if all required chunks are valid, false otherwise
+     */
     processScriptRNKC(burnedSats: number | bigint, options?: {
         minDataLength: number;
         minFeeRate: number;

package/dist/types/lib/rank/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../lib/rank/index.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAOhC,OAAO,MAAM,MAAM,aAAa,CAAA;AAGhC,MAAM,MAAM,oBAAoB,GAAG,MAAM,GAAG,MAAM,CAAA;AAClD,MAAM,MAAM,uBAAuB,GAAG,SAAS,GAAG,SAAS,CAAA;AAC3D,MAAM,MAAM,wBAAwB,GAAG,UAAU,GAAG,UAAU,GAAG,SAAS,CAAA;AAC1E,MAAM,MAAM,mBAAmB,GAAG,GAAG,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAA;AACnE,MAAM,MAAM,sBAAsB,GAAG,GAAG,CAAC,MAAM,EAAE,uBAAuB,CAAC,CAAA;AACzE,MAAM,MAAM,uBAAuB,GAAG,GAAG,CAAC,MAAM,EAAE,wBAAwB,CAAC,CAAA;AAC3E,MAAM,MAAM,gBAAgB,GACxB,WAAW,GACX,UAAU,GACV,WAAW,GACX,QAAQ,GACR,SAAS,GACT,UAAU,GACV,YAAY,CAAA;AAChB,MAAM,MAAM,WAAW,GAAG;IAExB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IAErB,GAAG,EAAE,MAAM,GAAG,IAAI,CAAA;IAElB,GAAG,CAAC,EAAE,mBAAmB,GAAG,sBAAsB,GAAG,uBAAuB,CAAA;CAC7E,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;KAC5B,IAAI,IAAI,OAAO,CACd,gBAAgB,EAChB,WAAW,GAAG,UAAU,GAAG,YAAY,CACxC,GAAG,WAAW;CAChB,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;KAC5B,IAAI,IAAI,OAAO,CACd,gBAAgB,EAChB,SAAS,GAAG,QAAQ,GAAG,UAAU,GAAG,YAAY,CACjD,GAAG,WAAW;CAChB,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG;KACpC,IAAI,IAAI,OAAO,CACd,gBAAgB,EAChB,QAAQ,GAAG,UAAU,GAAG,YAAY,CACrC,GAAG,WAAW;CAChB,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG;IAElC,SAAS,EAAE,wBAAwB,CAAA;IAEnC,QAAQ,EAAE,uBAAuB,CAAA;IAEjC,SAAS,EAAE,MAAM,CAAA;IAEjB,MAAM,CAAC,EAAE,MAAM,CAAA;CAKhB,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG;IAElC,IAAI,EAAE,UAAU,CAAA;IAEhB,OAAO,EAAE,MAAM,CAAA;IAEf,iBAAiB,EAAE,uBAAuB,CAAA;IAE1C,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAE3B,eAAe,CAAC,EAAE,MAAM,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,MAAM,CAAA;IACjB,aAAa,EAAE,MAAM,CAAA;IACrB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,eAAe,GAAG,qBAAqB,GAAG,WAAW,CAAA;AAEjE,MAAM,MAAM,eAAe,GAAG,qBAAqB,GAAG,WAAW,CAAA;AAEjE,MAAM,MAAM,YAAY,GAAG;IACzB,EAAE,EAAE,MAAM,CAAA;IACV,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,MAAM,CAAA;IACf,KAAK,EAAE,IAAI,CAAC,eAAe,EAAE,WAAW,GAAG,UAAU,CAAC,EAAE,CAAA;IACxD,QAAQ,EAAE,IAAI,CAAC,eAAe,EAAE,oBAAoB,GAAG,mBAAmB,CAAC,EAAE,CAAA;IAC7E,YAAY,EAAE,MAAM,CAAA;IACpB,YAAY,EAAE,MAAM,CAAA;IACpB,aAAa,EAAE,MAAM,CAAA;IACrB,aAAa,EAAE,MAAM,CAAA;CACtB,CAAA;AAMD,MAAM,MAAM,UAAU,GAAG,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAC7C,MAAM,MAAM,OAAO,GAAG,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;AAEvC,MAAM,MAAM,OAAO,GAAG,YAAY,GAAG;IACnC,KAAK,CAAC,EAAE,OAAO,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,IAAI,GAAG,YAAY,GAAG;IAChC,SAAS,EAAE,MAAM,CAAA;IAEjB,IAAI,CAAC,EAAE,UAAU,CAAA;CAClB,CAAA;AAGD,MAAM,MAAM,kBAAkB,GAAG;IAC/B,SAAS,EAAE;QACT,GAAG,EAAE,MAAM,CAAA;QACX,KAAK,EAAE,MAAM,CAAA;KACd,CAAA;IACD,MAAM,EAAE;QACN,GAAG,EAAE,MAAM,CAAA;QACX,KAAK,EAAE,MAAM,CAAA;QACb,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAA;KACrC,CAAA;CACF,CAAA;AAGD,eAAO,MAAM,iBAAiB,aAAa,CAAA;AAC3C,eAAO,MAAM,iBAAiB,aAAa,CAAA;AAC3C,eAAO,MAAM,kBAAkB,EAAE,mBAA+B,CAAA;AAIhE,eAAO,MAAM,sBAAsB,eAAe,CAAA;AAClD,eAAO,MAAM,uBAAuB,cAAc,CAAA;AAClD,eAAO,MAAM,uBAAuB,cAAc,CAAA;AAElD,eAAO,MAAM,sBAAsB,EAAE,uBAAmC,CAAA;AAKxE,eAAO,MAAM,uBAAuB,EAAE,GAAG,CAAC,wBAAwB,EAAE,MAAM,CAC/D,CAAA;AAKX,eAAO,MAAM,qBAAqB,EAAE,sBAAkC,CAAA;AAKtE,eAAO,MAAM,mBAAmB,EAAE,GAAG,CAAC,MAAM,gBAAgB,EAAE,WAAW,CAC9D,CAAA;AAmBX,eAAO,MAAM,2BAA2B,KAAK,CAAA;AAE7C,eAAO,MAAM,mBAAmB,EAAE,GAAG,CAAC,MAAM,gBAAgB,EAAE,WAAW,CAC9D,CAAA;AAeX,eAAO,MAAM,2BAA2B,EAAE,GAAG,CAC3C,MAAM,wBAAwB,EAC9B,WAAW,CACA,CAAA;AAcb,eAAO,MAAM,qBAAqB,EAAE,GAAG,CACrC,uBAAuB,EACvB,kBAAkB,CACP,CAAA;AAkCb,wBAAgB,cAAc,CAC5B,QAAQ,EAAE,uBAAuB,EACjC,SAAS,EAAE,MAAM,GAChB,MAAM,GAAG,IAAI,CAyCf;AAMD,wBAAgB,eAAe,CAAC,YAAY,EAAE,MAAM,UAInD;AAOD,wBAAgB,WAAW,CACzB,QAAQ,EAAE,uBAAuB,EACjC,MAAM,EAAE,MAAM,GACb,MAAM,GAAG,SAAS,CASpB;AAMD,wBAAgB,aAAa,CAC3B,QAAQ,EAAE,uBAAuB,GAChC,MAAM,GAAG,SAAS,CAMpB;AAKD,wBAAgB,cAAc,CAC5B,WAAW,EAAE,MAAM,GAClB,uBAAuB,GAAG,SAAS,CAErC;AAMD,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,wBAAwB,sBAEpE;AAKD,wBAAgB,eAAe,CAC7B,YAAY,EAAE,MAAM,GACnB,wBAAwB,GAAG,SAAS,CAEtC;AAMD,wBAAgB,aAAa,CAC3B,UAAU,EAAE,MAAM,GAAG,UAAU,GAC9B,MAAM,GAAG,SAAS,CAEpB;AAUD,wBAAgB,YAAY,CAC1B,SAAS,EAAE,wBAAwB,EACnC,QAAQ,EAAE,uBAAuB,EACjC,SAAS,EAAE,MAAM,EACjB,MAAM,CAAC,EAAE,MAAM,GACd,MAAM,CA6CR;AAaD,wBAAgB,YAAY,CAAC,EAC3B,QAAQ,EACR,SAAS,EACT,MAAM,EACN,OAAO,GACR,EAAE;IACD,QAAQ,EAAE,uBAAuB,CAAA;IACjC,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,MAAM,CAAA;CAChB,GAAG,MAAM,EAAE,CAkEX;AAMD,qBAAa,eAAe;IAC1B,OAAO,CAAC,MAAM,CAAkD;IAEhE,OAAO,CAAC,MAAM,CAAQ;IAEtB,OAAO,CAAC,mBAAmB,CAAe;gBAE9B,MAAM,EAAE,MAAM;IAmB1B,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO;IAe3C,IAAI,SAAS,IAAI,oBAAoB,GAAG,SAAS,CAEhD;IAKD,OAAO,CAAC,YAAY;IAcpB,OAAO,CAAC,gBAAgB;IAgBxB,OAAO,CAAC,eAAe;IAoBvB,OAAO,CAAC,gBAAgB;IAiDxB,OAAO,CAAC,aAAa;IAqErB,OAAO,CAAC,cAAc;IA2BtB,iBAAiB,IAAI,qBAAqB,GAAG,IAAI;IAsCjD,iBAAiB,CACf,UAAU,EAAE,MAAM,GAAG,MAAM,EAC3B,OAAO,CAAC,EAAE;QAAE,aAAa,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAE,GACtD,qBAAqB,GAAG,IAAI;CA4DhC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../lib/rank/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAOhC,OAAO,MAAM,MAAM,aAAa,CAAA;AAGhC,MAAM,MAAM,oBAAoB,GAAG,MAAM,GAAG,MAAM,CAAA;AAClD,MAAM,MAAM,uBAAuB,GAAG,SAAS,GAAG,SAAS,CAAA;AAC3D,MAAM,MAAM,wBAAwB,GAAG,UAAU,GAAG,UAAU,GAAG,SAAS,CAAA;AAC1E,MAAM,MAAM,mBAAmB,GAAG,GAAG,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAA;AACnE,MAAM,MAAM,sBAAsB,GAAG,GAAG,CAAC,MAAM,EAAE,uBAAuB,CAAC,CAAA;AACzE,MAAM,MAAM,uBAAuB,GAAG,GAAG,CAAC,MAAM,EAAE,wBAAwB,CAAC,CAAA;AAC3E,MAAM,MAAM,gBAAgB,GACxB,WAAW,GACX,UAAU,GACV,WAAW,GACX,QAAQ,GACR,SAAS,GACT,UAAU,GACV,YAAY,CAAA;AAChB,MAAM,MAAM,WAAW,GAAG;IACxB,oDAAoD;IACpD,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,oDAAoD;IACpD,GAAG,EAAE,MAAM,GAAG,IAAI,CAAA;IAClB,0CAA0C;IAC1C,GAAG,CAAC,EAAE,mBAAmB,GAAG,sBAAsB,GAAG,uBAAuB,CAAA;CAC7E,CAAA;AACD,kCAAkC;AAClC,MAAM,MAAM,gBAAgB,GAAG;KAC5B,IAAI,IAAI,OAAO,CACd,gBAAgB,EAChB,WAAW,GAAG,UAAU,GAAG,YAAY,CACxC,GAAG,WAAW;CAChB,CAAA;AACD,kCAAkC;AAClC,MAAM,MAAM,gBAAgB,GAAG;KAC5B,IAAI,IAAI,OAAO,CACd,gBAAgB,EAChB,SAAS,GAAG,QAAQ,GAAG,UAAU,GAAG,YAAY,CACjD,GAAG,WAAW;CAChB,CAAA;AACD,kCAAkC;AAClC,MAAM,MAAM,wBAAwB,GAAG;KACpC,IAAI,IAAI,OAAO,CACd,gBAAgB,EAChB,QAAQ,GAAG,UAAU,GAAG,YAAY,CACrC,GAAG,WAAW;CAChB,CAAA;AACD,gGAAgG;AAChG,MAAM,MAAM,qBAAqB,GAAG;IAClC,wDAAwD;IACxD,SAAS,EAAE,wBAAwB,CAAA;IACnC,+BAA+B;IAC/B,QAAQ,EAAE,uBAAuB,CAAA;IACjC,6BAA6B;IAC7B,SAAS,EAAE,MAAM,CAAA;IACjB,mDAAmD;IACnD,MAAM,CAAC,EAAE,MAAM,CAAA;CAKhB,CAAA;AACD,+DAA+D;AAC/D,MAAM,MAAM,qBAAqB,GAAG;IAClC,oEAAoE;IACpE,IAAI,EAAE,UAAU,CAAA;IAChB,4EAA4E;IAC5E,OAAO,EAAE,MAAM,CAAA;IACf,+BAA+B;IAC/B,iBAAiB,EAAE,uBAAuB,CAAA;IAC1C,qCAAqC;IACrC,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,sCAAsC;IACtC,eAAe,CAAC,EAAE,MAAM,CAAA;CACzB,CAAA;AACD,+CAA+C;AAC/C,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,MAAM,CAAA;IACjB,aAAa,EAAE,MAAM,CAAA;IACrB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB,CAAA;AACD,oDAAoD;AACpD,MAAM,MAAM,eAAe,GAAG,qBAAqB,GAAG,WAAW,CAAA;AACjE,oDAAoD;AACpD,MAAM,MAAM,eAAe,GAAG,qBAAqB,GAAG,WAAW,CAAA;AACjE,6HAA6H;AAC7H,MAAM,MAAM,YAAY,GAAG;IACzB,EAAE,EAAE,MAAM,CAAA;IACV,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,MAAM,CAAA;IACf,KAAK,EAAE,IAAI,CAAC,eAAe,EAAE,WAAW,GAAG,UAAU,CAAC,EAAE,CAAA;IACxD,QAAQ,EAAE,IAAI,CAAC,eAAe,EAAE,oBAAoB,GAAG,mBAAmB,CAAC,EAAE,CAAA;IAC7E,YAAY,EAAE,MAAM,CAAA;IACpB,YAAY,EAAE,MAAM,CAAA;IACpB,aAAa,EAAE,MAAM,CAAA;IACrB,aAAa,EAAE,MAAM,CAAA;CACtB,CAAA;AACD;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAAG,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAC7C,MAAM,MAAM,OAAO,GAAG,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;AACvC,OAAO;AACP,MAAM,MAAM,OAAO,GAAG,YAAY,GAAG;IACnC,KAAK,CAAC,EAAE,OAAO,CAAA;CAChB,CAAA;AACD,OAAO;AACP,MAAM,MAAM,IAAI,GAAG,YAAY,GAAG;IAChC,SAAS,EAAE,MAAM,CAAA;IACjB,iGAAiG;IACjG,IAAI,CAAC,EAAE,UAAU,CAAA;CAClB,CAAA;AAED,0BAA0B;AAC1B,MAAM,MAAM,kBAAkB,GAAG;IAC/B,SAAS,EAAE;QACT,GAAG,EAAE,MAAM,CAAA;QACX,KAAK,EAAE,MAAM,CAAA;KACd,CAAA;IACD,MAAM,EAAE;QACN,GAAG,EAAE,MAAM,CAAA;QACX,KAAK,EAAE,MAAM,CAAA;QACb,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAA;KACrC,CAAA;CACF,CAAA;AAED,sBAAsB;AACtB,eAAO,MAAM,iBAAiB,aAAa,CAAA;AAC3C,eAAO,MAAM,iBAAiB,aAAa,CAAA;AAC3C,eAAO,MAAM,kBAAkB,EAAE,mBAA+B,CAAA;AAIhE,eAAO,MAAM,sBAAsB,eAAe,CAAA;AAClD,eAAO,MAAM,uBAAuB,cAAc,CAAA;AAClD,eAAO,MAAM,uBAAuB,cAAc,CAAA;AAClD,0BAA0B;AAC1B,eAAO,MAAM,sBAAsB,EAAE,uBAAmC,CAAA;AAIxE,4BAA4B;AAC5B,eAAO,MAAM,uBAAuB,EAAE,GAAG,CAAC,wBAAwB,EAAE,MAAM,CAC/D,CAAA;AAIX,yBAAyB;AACzB,eAAO,MAAM,qBAAqB,EAAE,sBAAkC,CAAA;AAItE,0CAA0C;AAC1C,eAAO,MAAM,mBAAmB,EAAE,GAAG,CAAC,MAAM,gBAAgB,EAAE,WAAW,CAC9D,CAAA;AAkBX,yDAAyD;AACzD,eAAO,MAAM,2BAA2B,KAAK,CAAA;AAC7C,kCAAkC;AAClC,eAAO,MAAM,mBAAmB,EAAE,GAAG,CAAC,MAAM,gBAAgB,EAAE,WAAW,CAC9D,CAAA;AAeX,eAAO,MAAM,2BAA2B,EAAE,GAAG,CAC3C,MAAM,wBAAwB,EAC9B,WAAW,CACA,CAAA;AAab,6BAA6B;AAC7B,eAAO,MAAM,qBAAqB,EAAE,GAAG,CACrC,uBAAuB,EACvB,kBAAkB,CACP,CAAA;AAwBb;;GAEG;AAEH;;;;;GAKG;AACH,wBAAgB,cAAc,CAC5B,QAAQ,EAAE,uBAAuB,EACjC,SAAS,EAAE,MAAM,GAChB,MAAM,GAAG,IAAI,CAyCf;AACD;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,YAAY,EAAE,MAAM,UAInD;AACD;;;;;GAKG;AACH,wBAAgB,WAAW,CACzB,QAAQ,EAAE,uBAAuB,EACjC,MAAM,EAAE,MAAM,GACb,MAAM,GAAG,SAAS,CASpB;AACD;;;;GAIG;AACH,wBAAgB,aAAa,CAC3B,QAAQ,EAAE,uBAAuB,GAChC,MAAM,GAAG,SAAS,CAMpB;AACD;;;GAGG;AACH,wBAAgB,cAAc,CAC5B,WAAW,EAAE,MAAM,GAClB,uBAAuB,GAAG,SAAS,CAErC;AACD;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,wBAAwB,sBAEpE;AACD;;;GAGG;AACH,wBAAgB,eAAe,CAC7B,YAAY,EAAE,MAAM,GACnB,wBAAwB,GAAG,SAAS,CAEtC;AACD;;;;GAIG;AACH,wBAAgB,aAAa,CAC3B,UAAU,EAAE,MAAM,GAAG,UAAU,GAC9B,MAAM,GAAG,SAAS,CAEpB;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAC1B,SAAS,EAAE,wBAAwB,EACnC,QAAQ,EAAE,uBAAuB,EACjC,SAAS,EAAE,MAAM,EACjB,MAAM,CAAC,EAAE,MAAM,GACd,MAAM,CA6CR;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,YAAY,CAAC,EAC3B,QAAQ,EACR,SAAS,EACT,MAAM,EACN,OAAO,GACR,EAAE;IACD,QAAQ,EAAE,uBAAuB,CAAA;IACjC,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,MAAM,CAAA;CAChB,GAAG,MAAM,EAAE,CAkEX;AAED;;;GAGG;AACH,qBAAa,eAAe;IAC1B,OAAO,CAAC,MAAM,CAAkD;IAChE,2CAA2C;IAC3C,OAAO,CAAC,MAAM,CAAQ;IACtB,4DAA4D;IAC5D,OAAO,CAAC,mBAAmB,CAAe;gBAE9B,MAAM,EAAE,MAAM;IAc1B;;;;OAIG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO;IAW3C;;;OAGG;IACH,IAAI,SAAS,IAAI,oBAAoB,GAAG,SAAS,CAEhD;IACD;;;OAGG;IACH,OAAO,CAAC,YAAY;IAUpB;;;OAGG;IACH,OAAO,CAAC,gBAAgB;IAYxB;;;OAGG;IACH,OAAO,CAAC,eAAe;IAgBvB;;;OAGG;IACH,OAAO,CAAC,gBAAgB;IA6CxB;;;OAGG;IACH,OAAO,CAAC,aAAa;IAgErB;;;;OAIG;IACH,OAAO,CAAC,cAAc;IAuBtB;;;OAGG;IACH,iBAAiB,IAAI,qBAAqB,GAAG,IAAI;IAkCjD;;;OAGG;IACH,iBAAiB,CACf,UAAU,EAAE,MAAM,GAAG,MAAM,EAC3B,OAAO,CAAC,EAAE;QAAE,aAAa,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAE,GACtD,qBAAqB,GAAG,IAAI;CA4DhC"}

package/dist/types/lib/rank/opcode.d.ts

@@ -1,8 +1,12 @@
+/**
+ * Opcode definitions
+ * @see https://en.bitcoin.it/wiki/Script
+ */
 declare enum OpCode {
     OP_RETURN = 106,
     OP_PUSHDATA1 = 76,
-    OP_0 = 0,
-    OP_1 = 81,
+    OP_0 = 0,// negative
+    OP_1 = 81,// positive
     OP_2 = 82,
     OP_3 = 83,
     OP_4 = 84,

package/dist/types/lib/rank/opcode.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"opcode.d.ts","sourceRoot":"","sources":["../../../../lib/rank/opcode.ts"],"names":[],"mappings":"AAIA,aAAK,MAAM;IACT,SAAS,MAAO;IAChB,YAAY,KAAO;IAEnB,IAAI,IAAO;IACX,IAAI,KAAO;IACX,IAAI,KAAO;IACX,IAAI,KAAO;IACX,IAAI,KAAO;IACX,IAAI,KAAO;IACX,IAAI,KAAO;IACX,IAAI,KAAO;IACX,IAAI,KAAO;IACX,IAAI,KAAO;IACX,KAAK,KAAO;IACZ,KAAK,KAAO;IACZ,KAAK,KAAO;IACZ,KAAK,KAAO;IACZ,KAAK,KAAO;IACZ,KAAK,KAAO;IACZ,KAAK,KAAO;CACb;AAED,eAAe,MAAM,CAAA"}
+{"version":3,"file":"opcode.d.ts","sourceRoot":"","sources":["../../../../lib/rank/opcode.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,aAAK,MAAM;IACT,SAAS,MAAO;IAChB,YAAY,KAAO;IAEnB,IAAI,IAAO,CAAE,WAAW;IACxB,IAAI,KAAO,CAAE,WAAW;IACxB,IAAI,KAAO;IACX,IAAI,KAAO;IACX,IAAI,KAAO;IACX,IAAI,KAAO;IACX,IAAI,KAAO;IACX,IAAI,KAAO;IACX,IAAI,KAAO;IACX,IAAI,KAAO;IACX,KAAK,KAAO;IACZ,KAAK,KAAO;IACZ,KAAK,KAAO;IACZ,KAAK,KAAO;IACZ,KAAK,KAAO;IACZ,KAAK,KAAO;IACZ,KAAK,KAAO;CACb;AAED,eAAe,MAAM,CAAA"}

package/dist/types/lib/rank/script.d.ts

@@ -1,3 +1,13 @@
+/**
+ * Copyright 2025 The Lotusia Stewardship
+ * Github: https://github.com/LotusiaStewardship
+ * License: MIT
+ */
 import { Buffer } from 'buffer/';
+/**
+ * Check provided script for OP_RETURN op code
+ * @param script - The script to check, as a `Buffer` or hex `string`
+ * @returns true if the output is an OP_RETURN, false otherwise
+ */
 export declare function isOpReturn(script: Buffer | string): boolean;
 //# sourceMappingURL=script.d.ts.map

package/dist/types/lib/rank/script.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"script.d.ts","sourceRoot":"","sources":["../../../../lib/rank/script.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAShC,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAK3D"}
+{"version":3,"file":"script.d.ts","sourceRoot":"","sources":["../../../../lib/rank/script.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAIhC;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAK3D"}

package/dist/types/lib/rank/transaction.d.ts

@@ -1,4 +1,15 @@
+/**
+ * Copyright 2025 The Lotusia Stewardship
+ * Github: https://github.com/LotusiaStewardship
+ * License: MIT
+ */
 import { Buffer } from 'buffer/';
 import { Transaction } from '../bitcore/transaction/index.js';
 export declare function processTransaction(tx: Transaction | Buffer | string): void;
+/**
+ * Convert a bitcore transaction to an RNKC transaction
+ * @param tx - The bitcore transaction to convert
+ * @param scriptProcessor - Optional instantiated `ScriptProcessor` for the transaction
+ * @returns The RNKC transaction, ready to be indexed
+ */
 //# sourceMappingURL=transaction.d.ts.map

package/dist/types/lib/rank/transaction.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"transaction.d.ts","sourceRoot":"","sources":["../../../../lib/rank/transaction.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAEhC,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAA;AAG7D,wBAAgB,kBAAkB,CAAC,EAAE,EAAE,WAAW,GAAG,MAAM,GAAG,MAAM,QAUnE"}
+{"version":3,"file":"transaction.d.ts","sourceRoot":"","sources":["../../../../lib/rank/transaction.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAEhC,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAA;AAG7D,wBAAgB,kBAAkB,CAAC,EAAE,EAAE,WAAW,GAAG,MAAM,GAAG,MAAM,QAUnE;AACD;;;;;GAKG"}

package/dist/types/lib/rpc.d.ts

@@ -1,136 +1,312 @@
+/**
+ * RPC daemon configuration
+ */
 export interface RPCConfig {
+    /** Username for RPC authentication */
     user: string;
+    /** Password for RPC authentication */
     password: string;
+    /** RPC daemon address (hostname or IP) */
     address: string;
+    /** RPC daemon port number */
     port: number;
 }
+/**
+ * Network information returned by the RPC daemon
+ */
 export interface NetworkInfo {
+    /** Subversion string */
     subversion: string;
+    /** Whether local relay is enabled */
     localrelay: boolean;
+    /** Number of connections */
     connections: number;
+    /** Number of inbound connections */
     connections_in: number;
+    /** Network warnings if any */
     warnings: string;
 }
+/**
+ * Mining information returned by the RPC daemon
+ */
 export interface MiningInfo {
+    /** Current block height */
     blocks: number;
+    /** Current network difficulty */
     difficulty: number;
+    /** Network hash rate in hashes per second */
     networkhashps: number;
+    /** Number of transactions in the mempool */
     pooledtx: number;
+    /** Blockchain name (e.g., "main", "test", "regtest") */
     chain: string;
+    /** Network warnings if any */
     warnings: string;
 }
+/**
+ * Mempool information returned by the RPC daemon
+ */
 export interface MempoolInfo {
+    /** Whether the mempool is loaded */
     loaded: boolean;
+    /** Number of transactions in mempool */
     size: number;
+    /** Total size of mempool in bytes */
     bytes: number;
+    /** Memory usage in bytes */
     usage: number;
+    /** Maximum mempool size in bytes */
     maxmempool: number;
+    /** Minimum fee rate for mempool transactions */
     mempoolminfee: number;
+    /** Minimum relay fee rate */
     minrelaytxfee: number;
+    /** Number of unbroadcast transactions */
     unbroadcastcount: number;
 }
+/**
+ * Peer connection information returned by the RPC daemon
+ */
 export interface PeerInfo {
+    /** Peer address and port */
     addr: string;
+    /** Peer services as hex string */
     services: string;
+    /** Array of service names */
     servicesnames: Array<string>;
+    /** Whether peer relays transactions */
     relaytxes: boolean;
+    /** Timestamp of last sent message */
     lastsend: number;
+    /** Timestamp of last received message */
     lastrecv: number;
+    /** Timestamp of last transaction */
     last_transaction: number;
+    /** Timestamp of last proof */
     last_proof: number;
+    /** Timestamp of last block */
     last_block: number;
+    /** Total bytes sent to peer */
     bytessent: number;
+    /** Total bytes received from peer */
     bytesrecv: number;
+    /** Connection time timestamp */
     conntime: number;
+    /** Time offset in seconds */
     timeoffset: number;
+    /** Current ping time in seconds */
     pingtime: number;
+    /** Minimum ping time in seconds */
     minping: number;
+    /** Protocol version */
     version: number;
+    /** User agent string */
     subver: string;
+    /** Whether connection is inbound */
     inbound: boolean;
+    /** Starting block height */
     startingheight: number;
+    /** Number of synced headers */
     synced_headers: number;
+    /** Number of synced blocks */
     synced_blocks: number;
+    /** GeoIP data */
     geoip?: {
         country: string;
         city: string;
     };
 }
+/**
+ * Block statistics returned by the RPC daemon
+ */
 export interface BlockStats {
+    /** Average fee in the block */
     avgfee: number;
+    /** Average fee rate in the block */
     avgfeerate: number;
+    /** Average transaction size in the block */
     avgtxsize: number;
+    /** Block hash */
     blockhash: string;
+    /** Fee rate percentiles */
     feerate_percentiles: Array<number>;
+    /** Block height */
     height: number;
+    /** Number of inputs */
     ins: number;
+    /** Maximum fee in the block */
     maxfee: number;
+    /** Maximum fee rate in the block */
     maxfeerate: number;
+    /** Maximum transaction size in the block */
     maxtxsize: number;
+    /** Median fee in the block */
     medianfee: number;
+    /** Median fee rate in the block */
     medianfeerate: number;
+    /** Median transaction size in the block */
     mediantxsize: number;
+    /** Minimum fee rate in the block */
     minfeerate: number;
+    /** Minimum transaction size in the block */
     mintxsize: number;
+    /** Number of outputs */
     notx: number;
+    /** Number of outputs */
     outs: number;
+    /** Block subsidy */
     subsidy: number;
+    /** Block timestamp */
     time: number;
+    /** Total output value */
     total_out: number;
+    /** Total block size */
     total_size: number;
+    /** Total fees in the block */
     totalfee: number;
+    /** Number of transactions */
     txs: number;
+    /** UTXO increase count */
     utxo_increase: number;
+    /** UTXO size increase */
     utxo_size_inc: number;
 }
+/**
+ * Block information returned by the RPC daemon
+ */
 export interface BlockInfo {
+    /** Block hash */
     hash: string;
+    /** Number of confirmations */
     confirmations: number;
+    /** Block size in bytes */
     size: number;
+    /** Block height */
     height: number;
+    /** Array of transaction IDs */
     tx: Array<string>;
+    /** Block timestamp */
     time: number;
+    /** Block difficulty */
     difficulty: number;
+    /** Number of transactions */
     nTx: number;
+    /** Previous block hash */
     previousblockhash: string;
+    /** Next block hash */
     nextblockhash: string;
 }
+/**
+ * Transaction input information
+ */
 export interface TransactionInput {
+    /** Transaction ID */
     txid: string;
+    /** Output index */
     vout: number;
+    /** Coinbase transaction data (for coinbase inputs) */
     coinbase?: string;
 }
+/**
+ * Transaction output information
+ */
 export interface TransactionOutput {
+    /** Output value in coins */
     value: number;
+    /** Script public key information */
     scriptPubKey: {
+        /** Array of addresses */
         addresses: Array<string>;
+        /** Script type */
         type: string;
+        /** Assembly representation */
         asm: string;
     };
 }
+/**
+ * Raw transaction information returned by the RPC daemon
+ */
 export interface RawTransaction {
+    /** Transaction ID */
     txid: string;
+    /** Transaction size in bytes */
     size: number;
+    /** Array of transaction inputs */
     vin: TransactionInput[];
+    /** Array of transaction outputs */
     vout: TransactionOutput[];
+    /** Transaction timestamp */
     time?: number;
+    /** Block timestamp */
     blocktime?: number;
+    /** Block hash containing this transaction */
     blockhash?: string;
+    /** Number of confirmations */
     confirmations?: number;
 }
 export declare class RPCClient {
     config: RPCConfig;
     constructor(config: RPCConfig);
+    /**
+     * Sends an RPC request to the Lotus daemon
+     * @param method - The RPC method to call
+     * @param params - Array of parameters to pass to the RPC method
+     * @returns Promise that resolves to the JSON response from the RPC daemon
+     */
     private sendRPCRequest;
+    /**
+     * RPC command - `getmininginfo`
+     * @returns {Promise<MiningInfo>} Raw mining information
+     */
     getMiningInfo(): Promise<MiningInfo>;
+    /**
+     * RPC command - `getnetworkinfo`
+     * @returns {Promise<NetworkInfo>} Network information
+     */
     getNetworkInfo(): Promise<NetworkInfo>;
+    /**
+     * RPC command - `getpeerinfo`
+     * @returns {Promise<PeerInfo[]>} Array of peer connection information
+     */
     getPeerInfo(): Promise<PeerInfo[]>;
+    /**
+     * RPC command - `getblockcount`
+     * @returns {Promise<number>} Current block count
+     */
     getBlockCount(): Promise<number>;
+    /**
+     * RPC command - `getblockhash`
+     * @param {number} height - Block height
+     * @returns {Promise<string>} Block hash for the given height
+     */
     getBlockHash(height: number): Promise<string>;
+    /**
+     * RPC command - `getblockstats`
+     * @param {string} hash - Block hash
+     * @returns {Promise<BlockStats>} Block statistics
+     */
     getBlockStats(hash: string): Promise<BlockStats>;
+    /**
+     * RPC command - `getblock`
+     * @param {string} hash - Block hash
+     * @returns {Promise<BlockInfo>} Block information
+     */
     getBlock(hash: string): Promise<BlockInfo>;
+    /**
+     * RPC command - `getrawtransaction`
+     * @param {string} txid - Transaction ID
+     * @returns {Promise<RawTransaction>} Raw transaction information
+     */
     getRawTransaction(txid: string): Promise<RawTransaction>;
+    /**
+     * RPC command - `getrawmempool`
+     * @returns {Promise<string[]>} Array of transaction IDs in mempool
+     */
     getRawMemPool(): Promise<string[]>;
+    /**
+     * RPC command - `getmempoolinfo`
+     * @returns {Promise<MempoolInfo>} Mempool information
+     */
     getMempoolInfo(): Promise<MempoolInfo>;
 }
 //# sourceMappingURL=rpc.d.ts.map