xpi-ts 0.2.0

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

@@ -0,0 +1,127 @@
+import OpCode from './opcode.js';
+export type ScriptChunkLokadUTF8 = 'RANK' | 'RNKC';
+export type ScriptChunkPlatformUTF8 = 'lotusia' | 'twitter';
+export type ScriptChunkSentimentUTF8 = 'positive' | 'negative' | 'neutral';
+export type ScriptChunkLokadMap = Map<number, ScriptChunkLokadUTF8>;
+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 = {
+    offset: number | null;
+    len: number | null;
+    map?: ScriptChunkLokadMap | ScriptChunkPlatformMap | ScriptChunkSentimentMap;
+};
+export type ScriptChunksRNKC = {
+    [name in Exclude<ScriptChunkField, 'sentiment' | 'postHash' | 'instanceId'>]: ScriptChunk;
+};
+export type ScriptChunksRANK = {
+    [name in Exclude<ScriptChunkField, 'comment' | 'postId' | 'postHash' | 'instanceId'>]: ScriptChunk;
+};
+export type ScriptChunksOptionalRANK = {
+    [name in Extract<ScriptChunkField, 'postId' | 'postHash' | 'instanceId'>]: ScriptChunk;
+};
+export type TransactionOutputRANK = {
+    sentiment: ScriptChunkSentimentUTF8;
+    platform: ScriptChunkPlatformUTF8;
+    profileId: string;
+    postId?: string;
+};
+export type TransactionOutputRNKC = {
+    data: Uint8Array;
+    feeRate: number;
+    inReplyToPlatform: ScriptChunkPlatformUTF8;
+    inReplyToProfileId?: string;
+    inReplyToPostId?: string;
+};
+export type Transaction = {
+    txid: string;
+    outIdx: number;
+    sats: bigint;
+    firstSeen: bigint;
+    scriptPayload: string;
+    instanceId?: string;
+    height?: number;
+    timestamp?: bigint;
+};
+export type TransactionRANK = TransactionOutputRANK & Transaction;
+export type TransactionRNKC = TransactionOutputRNKC & Transaction;
+export type TargetEntity = {
+    id: string;
+    platform: string;
+    ranking: bigint;
+    ranks: Omit<TransactionRANK, 'profileId' | 'platform'>[];
+    comments: Omit<TransactionRNKC, 'inReplyToProfileId' | 'inReplyToPlatform'>[];
+    satsPositive: bigint;
+    satsNegative: bigint;
+    votesPositive: number;
+    votesNegative: number;
+};
+export type ProfileMap = Map<string, Profile>;
+export type PostMap = Map<string, Post>;
+export type Profile = TargetEntity & {
+    posts?: PostMap;
+};
+export type Post = TargetEntity & {
+    profileId: string;
+    data?: Uint8Array;
+};
+export type PlatformParameters = {
+    profileId: {
+        len: number;
+        regex: RegExp;
+    };
+    postId: {
+        len: number;
+        regex: RegExp;
+        type: 'BigInt' | 'Number' | 'String';
+    };
+};
+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;
+export declare const SCRIPT_CHUNK_SENTIMENT: ScriptChunkSentimentMap;
+export declare const RANK_SENTIMENT_OP_CODES: Map<ScriptChunkSentimentUTF8, string>;
+export declare const SCRIPT_CHUNK_PLATFORM: ScriptChunkPlatformMap;
+export declare const ScriptChunksRNKCMap: Map<keyof ScriptChunksRNKC, ScriptChunk>;
+export declare const RANK_SCRIPT_REQUIRED_LENGTH = 10;
+export declare const ScriptChunksRANKMap: Map<keyof ScriptChunksRANK, ScriptChunk>;
+export declare const ScriptChunksOptionalRANKMap: Map<keyof ScriptChunksOptionalRANK, ScriptChunk>;
+export declare const PlatformConfiguration: Map<ScriptChunkPlatformUTF8, PlatformParameters>;
+export declare function toProfileIdBuf(platform: ScriptChunkPlatformUTF8, profileId: string): Buffer | null;
+export declare function toProfileIdUTF8(profileIdBuf: Buffer): string;
+export declare function toPostIdBuf(platform: ScriptChunkPlatformUTF8, postId: string): Buffer | undefined;
+export declare function toPlatformBuf(platform: ScriptChunkPlatformUTF8): Buffer | undefined;
+export declare function toPlatformUTF8(platformBuf: Buffer): ScriptChunkPlatformUTF8 | undefined;
+export declare function toSentimentOpCode(sentiment: ScriptChunkSentimentUTF8): string | undefined;
+export declare function toSentimentUTF8(sentimentBuf: Buffer): ScriptChunkSentimentUTF8 | undefined;
+export declare function toCommentUTF8(commentBuf: Buffer | Uint8Array): string | undefined;
+export declare function toScriptRANK(sentiment: ScriptChunkSentimentUTF8, platform: ScriptChunkPlatformUTF8, profileId: string, postId?: string): Buffer;
+export declare function toScriptRNKC({ platform, profileId, postId, comment, }: {
+    platform: ScriptChunkPlatformUTF8;
+    profileId: string;
+    postId?: string;
+    comment: string;
+}): Buffer[];
+export declare class ScriptProcessor {
+    private chunks;
+    private script;
+    private supplementalScripts;
+    constructor(script: Buffer);
+    addScript(script: string | Buffer): boolean;
+    get lokadType(): ScriptChunkLokadUTF8 | undefined;
+    private processLokad;
+    private processSentiment;
+    private processPlatform;
+    private processProfileId;
+    private processPostId;
+    private processComment;
+    processScriptRANK(): TransactionOutputRANK | null;
+    processScriptRNKC(burnedSats: number | bigint, options?: {
+        minDataLength: number;
+        minFeeRate: number;
+    }): TransactionOutputRNKC | null;
+}
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../lib/rank/index.ts"],"names":[],"mappings":"AAWA,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,CA+Bf;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,CA4CR;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,CAiEX;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;IAsCxB,OAAO,CAAC,aAAa;IA0CrB,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"}

package/dist/lib/rank/index.js

@@ -0,0 +1,421 @@
+import { MAX_OP_RETURN_DATA, RNKC_MIN_DATA_LENGTH, RNKC_MIN_FEE_RATE, } from '../../utils/constants.js';
+import { toHex } from '../../utils/string.js';
+import OpCode from './opcode.js';
+import { isOpReturn } from './script.js';
+export const LOKAD_PREFIX_RANK = 0x52414e4b;
+export const LOKAD_PREFIX_RNKC = 0x524e4b43;
+export const SCRIPT_CHUNK_LOKAD = new Map();
+SCRIPT_CHUNK_LOKAD.set(LOKAD_PREFIX_RANK, 'RANK');
+SCRIPT_CHUNK_LOKAD.set(LOKAD_PREFIX_RNKC, 'RNKC');
+export const RANK_SENTIMENT_NEUTRAL = OpCode.OP_16;
+export const RANK_SENTIMENT_POSITIVE = OpCode.OP_1;
+export const RANK_SENTIMENT_NEGATIVE = OpCode.OP_0;
+export const SCRIPT_CHUNK_SENTIMENT = new Map();
+SCRIPT_CHUNK_SENTIMENT.set(RANK_SENTIMENT_NEUTRAL, 'neutral');
+SCRIPT_CHUNK_SENTIMENT.set(RANK_SENTIMENT_POSITIVE, 'positive');
+SCRIPT_CHUNK_SENTIMENT.set(RANK_SENTIMENT_NEGATIVE, 'negative');
+export const RANK_SENTIMENT_OP_CODES = new Map();
+RANK_SENTIMENT_OP_CODES.set('neutral', 'OP_16');
+RANK_SENTIMENT_OP_CODES.set('positive', 'OP_1');
+RANK_SENTIMENT_OP_CODES.set('negative', 'OP_0');
+export const SCRIPT_CHUNK_PLATFORM = new Map();
+SCRIPT_CHUNK_PLATFORM.set(0x00, 'lotusia');
+SCRIPT_CHUNK_PLATFORM.set(0x01, 'twitter');
+export const ScriptChunksRNKCMap = new Map();
+ScriptChunksRNKCMap.set('platform', {
+    offset: 7,
+    len: 1,
+    map: SCRIPT_CHUNK_PLATFORM,
+});
+ScriptChunksRNKCMap.set('profileId', {
+    offset: 9,
+    len: null,
+});
+ScriptChunksRNKCMap.set('postId', {
+    offset: null,
+    len: null,
+});
+ScriptChunksRNKCMap.set('comment', {
+    offset: null,
+    len: null,
+});
+export const RANK_SCRIPT_REQUIRED_LENGTH = 10;
+export const ScriptChunksRANKMap = new Map();
+ScriptChunksRANKMap.set('sentiment', {
+    offset: 6,
+    len: 1,
+    map: SCRIPT_CHUNK_SENTIMENT,
+});
+ScriptChunksRANKMap.set('platform', {
+    offset: 8,
+    len: 1,
+    map: SCRIPT_CHUNK_PLATFORM,
+});
+ScriptChunksRANKMap.set('profileId', {
+    offset: 10,
+    len: null,
+});
+export const ScriptChunksOptionalRANKMap = new Map();
+ScriptChunksOptionalRANKMap.set('postId', {
+    offset: null,
+    len: null,
+});
+ScriptChunksOptionalRANKMap.set('postHash', {
+    offset: null,
+    len: null,
+});
+ScriptChunksOptionalRANKMap.set('instanceId', {
+    offset: null,
+    len: null,
+});
+export const PlatformConfiguration = new Map();
+PlatformConfiguration.set('lotusia', {
+    profileId: {
+        len: 20,
+        regex: /^[0-9a-fA-F]{40}$/,
+    },
+    postId: {
+        len: 32,
+        regex: /^[0-9a-f]{64}$/,
+        type: 'String',
+    },
+});
+PlatformConfiguration.set('twitter', {
+    profileId: {
+        len: 16,
+        regex: /^[a-z0-9_]{1,16}$/,
+    },
+    postId: {
+        len: 8,
+        regex: /^[0-9]+$/,
+        type: 'BigInt',
+    },
+});
+export function toProfileIdBuf(platform, profileId) {
+    const platformSpec = PlatformConfiguration.get(platform);
+    if (!platformSpec) {
+        return null;
+    }
+    const profileIdSpec = platformSpec.profileId;
+    if (!profileIdSpec) {
+        return null;
+    }
+    if (profileIdSpec.regex && !profileIdSpec.regex.test(profileId)) {
+        return null;
+    }
+    const profileBuf = Buffer.alloc(profileIdSpec.len);
+    switch (platform) {
+        case 'lotusia': {
+            const profileIdHex = Buffer.from(profileId, 'hex');
+            profileBuf.write(profileId, profileIdSpec.len - profileIdHex.length, 'hex');
+            break;
+        }
+        case 'twitter':
+            profileBuf.write(profileId, profileIdSpec.len - profileId.length, 'utf8');
+            break;
+        default:
+            return null;
+    }
+    return profileBuf;
+}
+export function toProfileIdUTF8(profileIdBuf) {
+    return new TextDecoder('utf-8').decode(profileIdBuf.filter(byte => byte != 0x00));
+}
+export function toPostIdBuf(platform, postId) {
+    switch (platform) {
+        case 'lotusia':
+            return Buffer.from(postId, 'hex');
+        case 'twitter':
+            return Buffer.from(BigInt(postId).toString(16), 'hex');
+        default:
+            return undefined;
+    }
+}
+export function toPlatformBuf(platform) {
+    for (const [byte, platformName] of SCRIPT_CHUNK_PLATFORM) {
+        if (platformName == platform) {
+            return Buffer.from([byte]);
+        }
+    }
+}
+export function toPlatformUTF8(platformBuf) {
+    return SCRIPT_CHUNK_PLATFORM.get(platformBuf.readUint8());
+}
+export function toSentimentOpCode(sentiment) {
+    return RANK_SENTIMENT_OP_CODES.get(sentiment);
+}
+export function toSentimentUTF8(sentimentBuf) {
+    return SCRIPT_CHUNK_SENTIMENT.get(sentimentBuf.readUInt8());
+}
+export function toCommentUTF8(commentBuf) {
+    return new TextDecoder('utf-8').decode(commentBuf);
+}
+export function toScriptRANK(sentiment, platform, profileId, postId) {
+    if (!sentiment || !platform || !profileId) {
+        throw new Error('Must specify sentiment, platform, and profileId');
+    }
+    const platformSpec = PlatformConfiguration.get(platform);
+    if (!platformSpec || !platformSpec.profileId) {
+        throw new Error('No platform profileId specification defined');
+    }
+    const OP_RETURN = toHex(OpCode.OP_RETURN);
+    const LOKAD_PREFIX = toHex(LOKAD_PREFIX_RANK);
+    let script = OP_RETURN + toHex(4) + LOKAD_PREFIX;
+    switch (sentiment) {
+        case 'neutral':
+            script += toHex(RANK_SENTIMENT_NEUTRAL);
+            break;
+        case 'positive':
+            script += toHex(RANK_SENTIMENT_POSITIVE);
+            break;
+        case 'negative':
+            script += toHex(RANK_SENTIMENT_NEGATIVE);
+            break;
+    }
+    script += toHex(1) + toHex(toPlatformBuf(platform));
+    script += toHex(platformSpec.profileId.len);
+    script += toHex(toProfileIdBuf(platform, profileId));
+    if (postId) {
+        if (!platformSpec.postId) {
+            throw new Error('Post ID provided, but no platform post specification defined');
+        }
+        script += toHex(platformSpec.postId.len);
+        script += toHex(toPostIdBuf(platform, postId));
+    }
+    return Buffer.from(script, 'hex');
+}
+export function toScriptRNKC({ platform, profileId, postId, comment, }) {
+    if (!platform || !profileId) {
+        throw new Error('Must specify platform and profileId');
+    }
+    const platformSpec = PlatformConfiguration.get(platform);
+    if (!platformSpec || !platformSpec.profileId) {
+        throw new Error('No platform profileId specification defined');
+    }
+    if (!platformSpec.profileId.regex.test(profileId)) {
+        throw new Error(`Invalid profileId: ${profileId}`);
+    }
+    if (postId && !platformSpec.postId.regex.test(postId)) {
+        throw new Error(`Invalid postId: ${postId}`);
+    }
+    const commentBuf = Buffer.from(comment, 'utf8');
+    if (commentBuf.length < 1 || commentBuf.length > MAX_OP_RETURN_DATA * 2) {
+        throw new Error(`Comment must be between 1 and ${MAX_OP_RETURN_DATA * 2} bytes`);
+    }
+    const scriptBufs = [];
+    const OP_RETURN = toHex(OpCode.OP_RETURN);
+    const OP_PUSHDATA1 = toHex(OpCode.OP_PUSHDATA1);
+    const LOKAD_PREFIX = toHex(LOKAD_PREFIX_RNKC);
+    let scriptRNKC = OP_RETURN + toHex(4) + LOKAD_PREFIX;
+    scriptRNKC += toHex(1) + toHex(toPlatformBuf(platform));
+    scriptRNKC += toHex(platformSpec.profileId.len);
+    scriptRNKC += toHex(toProfileIdBuf(platform, profileId));
+    if (postId) {
+        scriptRNKC += toHex(platformSpec.postId.len);
+        scriptRNKC += toHex(toPostIdBuf(platform, postId));
+    }
+    scriptBufs.push(Buffer.from(scriptRNKC, 'hex'));
+    const commentBuf1 = commentBuf.subarray(0, MAX_OP_RETURN_DATA);
+    let scriptComment = OP_RETURN + OP_PUSHDATA1;
+    scriptComment += toHex(commentBuf1.length);
+    scriptComment += toHex(commentBuf1);
+    scriptBufs.push(Buffer.from(scriptComment, 'hex'));
+    if (commentBuf.length > MAX_OP_RETURN_DATA) {
+        const commentBuf2 = commentBuf.subarray(MAX_OP_RETURN_DATA);
+        let scriptComment2 = OP_RETURN + OP_PUSHDATA1;
+        scriptComment2 += toHex(commentBuf2.length);
+        scriptComment2 += toHex(commentBuf2);
+        scriptBufs.push(Buffer.from(scriptComment2, 'hex'));
+    }
+    return scriptBufs;
+}
+export class ScriptProcessor {
+    chunks = null;
+    script;
+    supplementalScripts = [];
+    constructor(script) {
+        this.script = script;
+        switch (this.lokadType) {
+            case 'RANK':
+                this.chunks = ScriptChunksRANKMap;
+                break;
+            case 'RNKC':
+                this.chunks = ScriptChunksRNKCMap;
+                break;
+        }
+    }
+    addScript(script) {
+        if (!(script instanceof Buffer)) {
+            script = Buffer.from(script, 'hex');
+        }
+        if (!isOpReturn(script)) {
+            return false;
+        }
+        this.supplementalScripts.push(script);
+        return true;
+    }
+    get lokadType() {
+        return this.processLokad();
+    }
+    processLokad() {
+        const lokadBuf = this.script.subarray(2, 6);
+        const lokad = SCRIPT_CHUNK_LOKAD.get(lokadBuf.readUInt32BE(0));
+        if (!lokad) {
+            return undefined;
+        }
+        return lokad;
+    }
+    processSentiment() {
+        const chunk = this.chunks?.get('sentiment');
+        if (!chunk || chunk.offset === null) {
+            return undefined;
+        }
+        const sentimentBuf = this.script.subarray(chunk.offset, chunk.offset + chunk.len);
+        return SCRIPT_CHUNK_SENTIMENT.get(sentimentBuf.readUInt8());
+    }
+    processPlatform() {
+        const chunk = this.chunks?.get('platform');
+        if (!chunk || chunk.offset === null) {
+            return undefined;
+        }
+        const platformBuf = this.script.subarray(chunk.offset, chunk.offset + chunk.len);
+        const platform = SCRIPT_CHUNK_PLATFORM.get(platformBuf.readUInt8());
+        if (!platform) {
+            return undefined;
+        }
+        return platform;
+    }
+    processProfileId(platform) {
+        const chunk = this.chunks?.get('profileId');
+        if (!chunk || chunk.offset === null) {
+            return undefined;
+        }
+        const platformSpec = PlatformConfiguration.get(platform);
+        if (!platformSpec || !platformSpec.profileId) {
+            return undefined;
+        }
+        const profileIdSpec = platformSpec.profileId;
+        const profileIdBuf = this.script.subarray(chunk.offset, chunk.offset + profileIdSpec.len);
+        if (profileIdBuf.length < profileIdSpec.len) {
+            return undefined;
+        }
+        switch (platform) {
+            case 'lotusia':
+                return toHex(profileIdBuf);
+            case 'twitter':
+                return toProfileIdUTF8(profileIdBuf);
+            default:
+                return undefined;
+        }
+    }
+    processPostId(platform) {
+        if (!platform) {
+            return undefined;
+        }
+        const platformSpec = PlatformConfiguration.get(platform);
+        if (!platformSpec || !platformSpec.postId || !platformSpec.profileId) {
+            return undefined;
+        }
+        const profileIdChunk = this.chunks?.get('profileId');
+        if (!profileIdChunk?.offset) {
+            return undefined;
+        }
+        const postIdSpec = platformSpec.postId;
+        const postIdOffset = profileIdChunk.offset + platformSpec.profileId.len + 1;
+        const postIdBuf = this.script.subarray(postIdOffset, postIdOffset + postIdSpec.len);
+        try {
+            switch (platform) {
+                case 'lotusia':
+                    return postIdBuf.toString('hex');
+                case 'twitter':
+                    return postIdBuf.readBigUInt64BE(0).toString();
+                default:
+                    return undefined;
+            }
+        }
+        catch (e) {
+            return undefined;
+        }
+    }
+    processComment(scripts) {
+        let commentBuf = Buffer.alloc(0);
+        for (let i = 0; i < scripts.length; i++) {
+            const script = scripts[i];
+            if (script.readUInt8(1) !== OpCode.OP_PUSHDATA1) {
+                break;
+            }
+            const dataSize = script.readUInt8(2);
+            if (isNaN(dataSize) || dataSize > MAX_OP_RETURN_DATA) {
+                break;
+            }
+            commentBuf = Buffer.concat([commentBuf, script.subarray(3, 3 + dataSize)]);
+        }
+        if (!commentBuf) {
+            return null;
+        }
+        return new Uint8Array(commentBuf);
+    }
+    processScriptRANK() {
+        const sentiment = this.processSentiment();
+        if (!sentiment) {
+            return null;
+        }
+        const platform = this.processPlatform();
+        if (!platform) {
+            return null;
+        }
+        const profileId = this.processProfileId(platform);
+        if (!profileId) {
+            return null;
+        }
+        const output = {
+            sentiment,
+            platform,
+            profileId,
+        };
+        const postId = this.processPostId(platform);
+        if (postId) {
+            output.postId = postId;
+        }
+        return output;
+    }
+    processScriptRNKC(burnedSats, options) {
+        if (typeof burnedSats === 'bigint') {
+            burnedSats = Number(burnedSats);
+        }
+        if (this.supplementalScripts.length === 0 ||
+            this.supplementalScripts.length > 2) {
+            return null;
+        }
+        const inReplyToPlatform = this.processPlatform();
+        if (!inReplyToPlatform) {
+            return null;
+        }
+        const data = this.processComment(this.supplementalScripts);
+        if (!data) {
+            return null;
+        }
+        if (data.length < (options?.minDataLength ?? RNKC_MIN_DATA_LENGTH)) {
+            return null;
+        }
+        if (burnedSats < (options?.minFeeRate ?? RNKC_MIN_FEE_RATE) * data.length) {
+            return null;
+        }
+        const output = {
+            data,
+            feeRate: Math.floor(burnedSats / data.length),
+            inReplyToPlatform,
+            inReplyToProfileId: undefined,
+            inReplyToPostId: undefined,
+        };
+        const profileId = this.processProfileId(inReplyToPlatform);
+        if (profileId) {
+            output.inReplyToProfileId = profileId;
+            const postId = this.processPostId(inReplyToPlatform);
+            if (postId) {
+                output.inReplyToPostId = postId;
+            }
+        }
+        return output;
+    }
+}

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

@@ -0,0 +1,23 @@
+declare enum OpCode {
+    OP_RETURN = 106,
+    OP_PUSHDATA1 = 76,
+    OP_0 = 0,
+    OP_1 = 81,
+    OP_2 = 82,
+    OP_3 = 83,
+    OP_4 = 84,
+    OP_5 = 85,
+    OP_6 = 86,
+    OP_7 = 87,
+    OP_8 = 88,
+    OP_9 = 89,
+    OP_10 = 90,
+    OP_11 = 91,
+    OP_12 = 92,
+    OP_13 = 93,
+    OP_14 = 94,
+    OP_15 = 95,
+    OP_16 = 96
+}
+export default OpCode;
+//# sourceMappingURL=opcode.d.ts.map

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

@@ -0,0 +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"}

package/dist/lib/rank/opcode.js

@@ -0,0 +1,23 @@
+var OpCode;
+(function (OpCode) {
+    OpCode[OpCode["OP_RETURN"] = 106] = "OP_RETURN";
+    OpCode[OpCode["OP_PUSHDATA1"] = 76] = "OP_PUSHDATA1";
+    OpCode[OpCode["OP_0"] = 0] = "OP_0";
+    OpCode[OpCode["OP_1"] = 81] = "OP_1";
+    OpCode[OpCode["OP_2"] = 82] = "OP_2";
+    OpCode[OpCode["OP_3"] = 83] = "OP_3";
+    OpCode[OpCode["OP_4"] = 84] = "OP_4";
+    OpCode[OpCode["OP_5"] = 85] = "OP_5";
+    OpCode[OpCode["OP_6"] = 86] = "OP_6";
+    OpCode[OpCode["OP_7"] = 87] = "OP_7";
+    OpCode[OpCode["OP_8"] = 88] = "OP_8";
+    OpCode[OpCode["OP_9"] = 89] = "OP_9";
+    OpCode[OpCode["OP_10"] = 90] = "OP_10";
+    OpCode[OpCode["OP_11"] = 91] = "OP_11";
+    OpCode[OpCode["OP_12"] = 92] = "OP_12";
+    OpCode[OpCode["OP_13"] = 93] = "OP_13";
+    OpCode[OpCode["OP_14"] = 94] = "OP_14";
+    OpCode[OpCode["OP_15"] = 95] = "OP_15";
+    OpCode[OpCode["OP_16"] = 96] = "OP_16";
+})(OpCode || (OpCode = {}));
+export default OpCode;

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

@@ -0,0 +1,2 @@
+export declare function isOpReturn(script: Buffer | string): boolean;
+//# sourceMappingURL=script.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"script.d.ts","sourceRoot":"","sources":["../../../lib/rank/script.ts"],"names":[],"mappings":"AAaA,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAK3D"}

package/dist/lib/rank/script.js

@@ -0,0 +1,7 @@
+import OpCode from './opcode.js';
+export function isOpReturn(script) {
+    if (typeof script === 'string') {
+        script = Buffer.from(script, 'hex');
+    }
+    return script.readUInt8(0) === OpCode.OP_RETURN;
+}

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

@@ -0,0 +1,3 @@
+import { Transaction } from '../bitcore/transaction/index.js';
+export declare function processTransaction(tx: Transaction | Buffer | string): void;
+//# sourceMappingURL=transaction.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"transaction.d.ts","sourceRoot":"","sources":["../../../lib/rank/transaction.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAA;AAG7D,wBAAgB,kBAAkB,CAAC,EAAE,EAAE,WAAW,GAAG,MAAM,GAAG,MAAM,QAUnE"}

package/dist/lib/rank/transaction.js

@@ -0,0 +1,12 @@
+import { Transaction } from '../bitcore/transaction/index.js';
+export function processTransaction(tx) {
+    if (typeof tx === 'string') {
+        if (!/^[a-fA-F0-9]+$/.test(tx)) {
+            throw new Error('Invalid transaction string format');
+        }
+        tx = Transaction.fromString(tx);
+    }
+    else if (tx instanceof Buffer) {
+        tx = Transaction.fromBuffer(tx);
+    }
+}