@1sat/actions 0.0.1

package/dist/locks/index.js

@@ -0,0 +1,296 @@
+/**
+ * Locks Module
+ *
+ * Actions for time-locking BSV.
+ */
+import { Hash, PublicKey, Script, Transaction, TransactionSignature, Utils, } from '@bsv/sdk';
+import { LOCK_BASKET, LOCK_PREFIX, LOCK_SUFFIX, MIN_UNLOCK_SATS, } from '../constants';
+// ============================================================================
+// Constants
+// ============================================================================
+const LOCK_PROTOCOL = [1, 'lock'];
+const LOCK_KEY_ID = 'lock';
+// ============================================================================
+// Internal helpers
+// ============================================================================
+function buildLockScript(address, until) {
+    const pkh = Utils.fromBase58Check(address).data;
+    return new Script()
+        .writeScript(Script.fromHex(LOCK_PREFIX))
+        .writeBin(pkh)
+        .writeNumber(until)
+        .writeScript(Script.fromHex(LOCK_SUFFIX));
+}
+/**
+ * Get lock data summary.
+ */
+export const getLockData = {
+    meta: {
+        name: 'getLockData',
+        description: 'Get summary of time-locked BSV (total, unlockable, next unlock height)',
+        category: 'locks',
+        inputSchema: {
+            type: 'object',
+            properties: {},
+        },
+    },
+    async execute(ctx) {
+        const lockData = { totalLocked: 0, unlockable: 0, nextUnlock: 0 };
+        if (!ctx.services)
+            return lockData;
+        const currentHeight = await ctx.services.chaintracks.currentHeight();
+        const result = await ctx.wallet.listOutputs({
+            basket: LOCK_BASKET,
+            includeTags: true,
+            limit: 10000,
+        });
+        const outputs = result.outputs;
+        for (const o of outputs) {
+            const untilTag = o.tags?.find((t) => t.startsWith('until:'));
+            if (!untilTag)
+                continue;
+            const until = Number.parseInt(untilTag.slice(6), 10);
+            lockData.totalLocked += o.satoshis;
+            if (until <= currentHeight) {
+                lockData.unlockable += o.satoshis;
+            }
+            else if (!lockData.nextUnlock || until < lockData.nextUnlock) {
+                lockData.nextUnlock = until;
+            }
+        }
+        if (lockData.unlockable < MIN_UNLOCK_SATS * outputs.length) {
+            lockData.unlockable = 0;
+        }
+        return lockData;
+    },
+};
+/**
+ * Lock BSV until a block height.
+ */
+export const lockBsv = {
+    meta: {
+        name: 'lockBsv',
+        description: 'Lock BSV until a specific block height',
+        category: 'locks',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                requests: {
+                    type: 'array',
+                    description: 'Array of lock requests',
+                    items: {
+                        type: 'object',
+                        properties: {
+                            satoshis: {
+                                type: 'integer',
+                                description: 'Amount in satoshis to lock',
+                            },
+                            until: {
+                                type: 'integer',
+                                description: 'Block height until which to lock',
+                            },
+                        },
+                        required: ['satoshis', 'until'],
+                    },
+                },
+            },
+            required: ['requests'],
+        },
+    },
+    async execute(ctx, input) {
+        try {
+            const { requests } = input;
+            if (!requests || requests.length === 0) {
+                return { error: 'no-lock-requests' };
+            }
+            const { publicKey } = await ctx.wallet.getPublicKey({
+                protocolID: LOCK_PROTOCOL,
+                keyID: LOCK_KEY_ID,
+                counterparty: 'self',
+                forSelf: true,
+            });
+            const lockAddress = PublicKey.fromString(publicKey).toAddress();
+            const outputs = [];
+            for (const req of requests) {
+                if (req.satoshis <= 0)
+                    return { error: 'invalid-satoshis' };
+                if (req.until <= 0)
+                    return { error: 'invalid-block-height' };
+                const lockingScript = buildLockScript(lockAddress, req.until);
+                outputs.push({
+                    lockingScript: lockingScript.toHex(),
+                    satoshis: req.satoshis,
+                    outputDescription: `Lock ${req.satoshis} sats until block ${req.until}`,
+                    basket: LOCK_BASKET,
+                    tags: [`until:${req.until}`],
+                    customInstructions: JSON.stringify({
+                        protocolID: LOCK_PROTOCOL,
+                        keyID: LOCK_KEY_ID,
+                    }),
+                });
+            }
+            const result = await ctx.wallet.createAction({
+                description: `Lock BSV in ${requests.length} output(s)`,
+                outputs,
+                options: { signAndProcess: true, acceptDelayedBroadcast: false },
+            });
+            if (!result.txid) {
+                return { error: 'no-txid-returned' };
+            }
+            return {
+                txid: result.txid,
+                rawtx: result.tx ? Utils.toHex(result.tx) : undefined,
+            };
+        }
+        catch (error) {
+            console.error('[lockBsv]', error);
+            return {
+                error: error instanceof Error ? error.message : 'unknown-error',
+            };
+        }
+    },
+};
+/**
+ * Unlock matured BSV locks.
+ */
+export const unlockBsv = {
+    meta: {
+        name: 'unlockBsv',
+        description: 'Unlock all matured time-locked BSV',
+        category: 'locks',
+        inputSchema: {
+            type: 'object',
+            properties: {},
+        },
+    },
+    async execute(ctx) {
+        try {
+            if (!ctx.services)
+                return { error: 'services-required' };
+            const currentHeight = await ctx.services.chaintracks.currentHeight();
+            const result = await ctx.wallet.listOutputs({
+                basket: LOCK_BASKET,
+                includeTags: true,
+                includeCustomInstructions: true,
+                include: 'locking scripts',
+                limit: 10000,
+            });
+            const maturedLocks = [];
+            for (const o of result.outputs) {
+                const untilTag = o.tags?.find((t) => t.startsWith('until:'));
+                if (!untilTag)
+                    continue;
+                const until = Number.parseInt(untilTag.slice(6), 10);
+                let protocolID = LOCK_PROTOCOL;
+                let keyID = LOCK_KEY_ID;
+                if (o.customInstructions) {
+                    const instructions = JSON.parse(o.customInstructions);
+                    protocolID = instructions.protocolID ?? LOCK_PROTOCOL;
+                    keyID = instructions.keyID ?? LOCK_KEY_ID;
+                }
+                if (until <= currentHeight) {
+                    maturedLocks.push({ output: o, until, protocolID, keyID });
+                }
+            }
+            if (maturedLocks.length === 0) {
+                return { error: 'no-matured-locks' };
+            }
+            const totalSats = maturedLocks.reduce((sum, l) => sum + l.output.satoshis, 0);
+            if (totalSats < MIN_UNLOCK_SATS * maturedLocks.length) {
+                return { error: 'insufficient-unlock-amount' };
+            }
+            const maxUntil = Math.max(...maturedLocks.map((l) => l.until));
+            const createResult = await ctx.wallet.createAction({
+                description: `Unlock ${maturedLocks.length} lock(s)`,
+                inputs: maturedLocks.map((l) => ({
+                    outpoint: l.output.outpoint,
+                    inputDescription: 'Locked BSV',
+                    unlockingScriptLength: 180,
+                    sequenceNumber: 0,
+                })),
+                outputs: [
+                    {
+                        lockingScript: '',
+                        satoshis: 0,
+                        outputDescription: 'Unlocked BSV',
+                    },
+                ],
+                lockTime: maxUntil,
+                options: { signAndProcess: false },
+            });
+            if ('error' in createResult && createResult.error) {
+                return { error: String(createResult.error) };
+            }
+            if (!createResult.signableTransaction) {
+                return { error: 'no-signable-transaction' };
+            }
+            const tx = Transaction.fromBEEF(createResult.signableTransaction.tx);
+            const spends = {};
+            for (let i = 0; i < maturedLocks.length; i++) {
+                const lock = maturedLocks[i];
+                const input = tx.inputs[i];
+                if (!lock.output.lockingScript || !input.sourceTXID) {
+                    return { error: 'missing-lock-data' };
+                }
+                const lockingScript = Script.fromHex(lock.output.lockingScript);
+                const preimage = TransactionSignature.format({
+                    sourceTXID: input.sourceTXID,
+                    sourceOutputIndex: input.sourceOutputIndex,
+                    sourceSatoshis: lock.output.satoshis,
+                    transactionVersion: tx.version,
+                    otherInputs: tx.inputs.filter((_, idx) => idx !== i),
+                    outputs: tx.outputs,
+                    inputIndex: i,
+                    subscript: lockingScript,
+                    inputSequence: 0,
+                    lockTime: tx.lockTime,
+                    scope: TransactionSignature.SIGHASH_ALL |
+                        TransactionSignature.SIGHASH_ANYONECANPAY |
+                        TransactionSignature.SIGHASH_FORKID,
+                });
+                const sighash = Hash.sha256(Hash.sha256(preimage));
+                const { signature } = await ctx.wallet.createSignature({
+                    protocolID: lock.protocolID,
+                    keyID: lock.keyID,
+                    counterparty: 'self',
+                    hashToDirectlySign: Array.from(sighash),
+                });
+                const { publicKey } = await ctx.wallet.getPublicKey({
+                    protocolID: lock.protocolID,
+                    keyID: lock.keyID,
+                    counterparty: 'self',
+                    forSelf: true,
+                });
+                const unlockingScript = new Script()
+                    .writeBin(signature)
+                    .writeBin(Utils.toArray(publicKey, 'hex'))
+                    .writeBin(Array.from(preimage));
+                spends[i] = { unlockingScript: unlockingScript.toHex() };
+            }
+            const signResult = await ctx.wallet.signAction({
+                reference: createResult.signableTransaction.reference,
+                spends,
+                options: { acceptDelayedBroadcast: false },
+            });
+            if ('error' in signResult) {
+                return { error: String(signResult.error) };
+            }
+            return {
+                txid: signResult.txid,
+                rawtx: signResult.tx ? Utils.toHex(signResult.tx) : undefined,
+            };
+        }
+        catch (error) {
+            console.error('[unlockBsv]', error);
+            return {
+                error: error instanceof Error ? error.message : 'unknown-error',
+            };
+        }
+    },
+};
+// ============================================================================
+// Module exports
+// ============================================================================
+/** All lock actions for registry */
+export const locksActions = [getLockData, lockBsv, unlockBsv];
+//# sourceMappingURL=index.js.map

package/dist/locks/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/locks/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAEN,IAAI,EACJ,SAAS,EACT,MAAM,EACN,WAAW,EACX,oBAAoB,EACpB,KAAK,GAEL,MAAM,UAAU,CAAA;AACjB,OAAO,EACN,WAAW,EACX,WAAW,EACX,WAAW,EACX,eAAe,GACf,MAAM,cAAc,CAAA;AAGrB,+EAA+E;AAC/E,YAAY;AACZ,+EAA+E;AAE/E,MAAM,aAAa,GAAwB,CAAC,CAAC,EAAE,MAAM,CAAC,CAAA;AACtD,MAAM,WAAW,GAAG,MAAM,CAAA;AA4B1B,+EAA+E;AAC/E,mBAAmB;AACnB,+EAA+E;AAE/E,SAAS,eAAe,CAAC,OAAe,EAAE,KAAa;IACtD,MAAM,GAAG,GAAG,KAAK,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,IAAgB,CAAA;IAC3D,OAAO,IAAI,MAAM,EAAE;SACjB,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;SACxC,QAAQ,CAAC,GAAG,CAAC;SACb,WAAW,CAAC,KAAK,CAAC;SAClB,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAA;AAC3C,CAAC;AASD;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAuC;IAC9D,IAAI,EAAE;QACL,IAAI,EAAE,aAAa;QACnB,WAAW,EACV,wEAAwE;QACzE,QAAQ,EAAE,OAAO;QACjB,WAAW,EAAE;YACZ,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE,EAAE;SACd;KACD;IACD,KAAK,CAAC,OAAO,CAAC,GAAG;QAChB,MAAM,QAAQ,GAAa,EAAE,WAAW,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,CAAA;QAE3E,IAAI,CAAC,GAAG,CAAC,QAAQ;YAAE,OAAO,QAAQ,CAAA;QAClC,MAAM,aAAa,GAAG,MAAM,GAAG,CAAC,QAAQ,CAAC,WAAW,CAAC,aAAa,EAAE,CAAA;QAEpE,MAAM,MAAM,GAAG,MAAM,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC;YAC3C,MAAM,EAAE,WAAW;YACnB,WAAW,EAAE,IAAI;YACjB,KAAK,EAAE,KAAK;SACZ,CAAC,CAAA;QACF,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAA;QAE9B,KAAK,MAAM,CAAC,IAAI,OAAO,EAAE,CAAC;YACzB,MAAM,QAAQ,GAAG,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAA;YAC5D,IAAI,CAAC,QAAQ;gBAAE,SAAQ;YAEvB,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;YACpD,QAAQ,CAAC,WAAW,IAAI,CAAC,CAAC,QAAQ,CAAA;YAElC,IAAI,KAAK,IAAI,aAAa,EAAE,CAAC;gBAC5B,QAAQ,CAAC,UAAU,IAAI,CAAC,CAAC,QAAQ,CAAA;YAClC,CAAC;iBAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,IAAI,KAAK,GAAG,QAAQ,CAAC,UAAU,EAAE,CAAC;gBAChE,QAAQ,CAAC,UAAU,GAAG,KAAK,CAAA;YAC5B,CAAC;QACF,CAAC;QAED,IAAI,QAAQ,CAAC,UAAU,GAAG,eAAe,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;YAC5D,QAAQ,CAAC,UAAU,GAAG,CAAC,CAAA;QACxB,CAAC;QAED,OAAO,QAAQ,CAAA;IAChB,CAAC;CACD,CAAA;AAOD;;GAEG;AACH,MAAM,CAAC,MAAM,OAAO,GAAgD;IACnE,IAAI,EAAE;QACL,IAAI,EAAE,SAAS;QACf,WAAW,EAAE,wCAAwC;QACrD,QAAQ,EAAE,OAAO;QACjB,WAAW,EAAE;YACZ,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACX,QAAQ,EAAE;oBACT,IAAI,EAAE,OAAO;oBACb,WAAW,EAAE,wBAAwB;oBACrC,KAAK,EAAE;wBACN,IAAI,EAAE,QAAQ;wBACd,UAAU,EAAE;4BACX,QAAQ,EAAE;gCACT,IAAI,EAAE,SAAS;gCACf,WAAW,EAAE,4BAA4B;6BACzC;4BACD,KAAK,EAAE;gCACN,IAAI,EAAE,SAAS;gCACf,WAAW,EAAE,kCAAkC;6BAC/C;yBACD;wBACD,QAAQ,EAAE,CAAC,UAAU,EAAE,OAAO,CAAC;qBAC/B;iBACD;aACD;YACD,QAAQ,EAAE,CAAC,UAAU,CAAC;SACtB;KACD;IACD,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK;QACvB,IAAI,CAAC;YACJ,MAAM,EAAE,QAAQ,EAAE,GAAG,KAAK,CAAA;YAC1B,IAAI,CAAC,QAAQ,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACxC,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,CAAA;YACrC,CAAC;YAED,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC;gBACnD,UAAU,EAAE,aAAa;gBACzB,KAAK,EAAE,WAAW;gBAClB,YAAY,EAAE,MAAM;gBACpB,OAAO,EAAE,IAAI;aACb,CAAC,CAAA;YACF,MAAM,WAAW,GAAG,SAAS,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,SAAS,EAAE,CAAA;YAE/D,MAAM,OAAO,GAAyB,EAAE,CAAA;YACxC,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAC;gBAC5B,IAAI,GAAG,CAAC,QAAQ,IAAI,CAAC;oBAAE,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,CAAA;gBAC3D,IAAI,GAAG,CAAC,KAAK,IAAI,CAAC;oBAAE,OAAO,EAAE,KAAK,EAAE,sBAAsB,EAAE,CAAA;gBAE5D,MAAM,aAAa,GAAG,eAAe,CAAC,WAAW,EAAE,GAAG,CAAC,KAAK,CAAC,CAAA;gBAC7D,OAAO,CAAC,IAAI,CAAC;oBACZ,aAAa,EAAE,aAAa,CAAC,KAAK,EAAE;oBACpC,QAAQ,EAAE,GAAG,CAAC,QAAQ;oBACtB,iBAAiB,EAAE,QAAQ,GAAG,CAAC,QAAQ,qBAAqB,GAAG,CAAC,KAAK,EAAE;oBACvE,MAAM,EAAE,WAAW;oBACnB,IAAI,EAAE,CAAC,SAAS,GAAG,CAAC,KAAK,EAAE,CAAC;oBAC5B,kBAAkB,EAAE,IAAI,CAAC,SAAS,CAAC;wBAClC,UAAU,EAAE,aAAa;wBACzB,KAAK,EAAE,WAAW;qBAClB,CAAC;iBACF,CAAC,CAAA;YACH,CAAC;YAED,MAAM,MAAM,GAAG,MAAM,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC;gBAC5C,WAAW,EAAE,eAAe,QAAQ,CAAC,MAAM,YAAY;gBACvD,OAAO;gBACP,OAAO,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,sBAAsB,EAAE,KAAK,EAAE;aAChE,CAAC,CAAA;YAEF,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;gBAClB,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,CAAA;YACrC,CAAC;YACD,OAAO;gBACN,IAAI,EAAE,MAAM,CAAC,IAAI;gBACjB,KAAK,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS;aACrD,CAAA;QACF,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,OAAO,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,CAAC,CAAA;YACjC,OAAO;gBACN,KAAK,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe;aAC/D,CAAA;QACF,CAAC;IACF,CAAC;CACD,CAAA;AAKD;;GAEG;AACH,MAAM,CAAC,MAAM,SAAS,GAAkD;IACvE,IAAI,EAAE;QACL,IAAI,EAAE,WAAW;QACjB,WAAW,EAAE,oCAAoC;QACjD,QAAQ,EAAE,OAAO;QACjB,WAAW,EAAE;YACZ,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE,EAAE;SACd;KACD;IACD,KAAK,CAAC,OAAO,CAAC,GAAG;QAChB,IAAI,CAAC;YACJ,IAAI,CAAC,GAAG,CAAC,QAAQ;gBAAE,OAAO,EAAE,KAAK,EAAE,mBAAmB,EAAE,CAAA;YACxD,MAAM,aAAa,GAAG,MAAM,GAAG,CAAC,QAAQ,CAAC,WAAW,CAAC,aAAa,EAAE,CAAA;YAEpE,MAAM,MAAM,GAAG,MAAM,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC;gBAC3C,MAAM,EAAE,WAAW;gBACnB,WAAW,EAAE,IAAI;gBACjB,yBAAyB,EAAE,IAAI;gBAC/B,OAAO,EAAE,iBAAiB;gBAC1B,KAAK,EAAE,KAAK;aACZ,CAAC,CAAA;YAEF,MAAM,YAAY,GAKb,EAAE,CAAA;YAEP,KAAK,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;gBAChC,MAAM,QAAQ,GAAG,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAA;gBAC5D,IAAI,CAAC,QAAQ;oBAAE,SAAQ;gBAEvB,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;gBAEpD,IAAI,UAAU,GAAG,aAAa,CAAA;gBAC9B,IAAI,KAAK,GAAG,WAAW,CAAA;gBACvB,IAAI,CAAC,CAAC,kBAAkB,EAAE,CAAC;oBAC1B,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAA;oBACrD,UAAU,GAAG,YAAY,CAAC,UAAU,IAAI,aAAa,CAAA;oBACrD,KAAK,GAAG,YAAY,CAAC,KAAK,IAAI,WAAW,CAAA;gBAC1C,CAAC;gBAED,IAAI,KAAK,IAAI,aAAa,EAAE,CAAC;oBAC5B,YAAY,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,CAAA;gBAC3D,CAAC;YACF,CAAC;YAED,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC/B,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,CAAA;YACrC,CAAC;YAED,MAAM,SAAS,GAAG,YAAY,CAAC,MAAM,CACpC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,MAAM,CAAC,QAAQ,EACnC,CAAC,CACD,CAAA;YACD,IAAI,SAAS,GAAG,eAAe,GAAG,YAAY,CAAC,MAAM,EAAE,CAAC;gBACvD,OAAO,EAAE,KAAK,EAAE,4BAA4B,EAAE,CAAA;YAC/C,CAAC;YAED,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAA;YAE9D,MAAM,YAAY,GAAG,MAAM,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC;gBAClD,WAAW,EAAE,UAAU,YAAY,CAAC,MAAM,UAAU;gBACpD,MAAM,EAAE,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;oBAChC,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ;oBAC3B,gBAAgB,EAAE,YAAY;oBAC9B,qBAAqB,EAAE,GAAG;oBAC1B,cAAc,EAAE,CAAC;iBACjB,CAAC,CAAC;gBACH,OAAO,EAAE;oBACR;wBACC,aAAa,EAAE,EAAE;wBACjB,QAAQ,EAAE,CAAC;wBACX,iBAAiB,EAAE,cAAc;qBACjC;iBACD;gBACD,QAAQ,EAAE,QAAQ;gBAClB,OAAO,EAAE,EAAE,cAAc,EAAE,KAAK,EAAE;aAClC,CAAC,CAAA;YAEF,IAAI,OAAO,IAAI,YAAY,IAAI,YAAY,CAAC,KAAK,EAAE,CAAC;gBACnD,OAAO,EAAE,KAAK,EAAE,MAAM,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,CAAA;YAC7C,CAAC;YAED,IAAI,CAAC,YAAY,CAAC,mBAAmB,EAAE,CAAC;gBACvC,OAAO,EAAE,KAAK,EAAE,yBAAyB,EAAE,CAAA;YAC5C,CAAC;YAED,MAAM,EAAE,GAAG,WAAW,CAAC,QAAQ,CAAC,YAAY,CAAC,mBAAmB,CAAC,EAAE,CAAC,CAAA;YAEpE,MAAM,MAAM,GAAgD,EAAE,CAAA;YAE9D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,YAAY,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC9C,MAAM,IAAI,GAAG,YAAY,CAAC,CAAC,CAAC,CAAA;gBAC5B,MAAM,KAAK,GAAG,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;gBAC1B,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC;oBACrD,OAAO,EAAE,KAAK,EAAE,mBAAmB,EAAE,CAAA;gBACtC,CAAC;gBACD,MAAM,aAAa,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAA;gBAE/D,MAAM,QAAQ,GAAG,oBAAoB,CAAC,MAAM,CAAC;oBAC5C,UAAU,EAAE,KAAK,CAAC,UAAU;oBAC5B,iBAAiB,EAAE,KAAK,CAAC,iBAAiB;oBAC1C,cAAc,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ;oBACpC,kBAAkB,EAAE,EAAE,CAAC,OAAO;oBAC9B,WAAW,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,CAAC,GAAG,KAAK,CAAC,CAAC;oBACpD,OAAO,EAAE,EAAE,CAAC,OAAO;oBACnB,UAAU,EAAE,CAAC;oBACb,SAAS,EAAE,aAAa;oBACxB,aAAa,EAAE,CAAC;oBAChB,QAAQ,EAAE,EAAE,CAAC,QAAQ;oBACrB,KAAK,EACJ,oBAAoB,CAAC,WAAW;wBAChC,oBAAoB,CAAC,oBAAoB;wBACzC,oBAAoB,CAAC,cAAc;iBACpC,CAAC,CAAA;gBAEF,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAA;gBAElD,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,GAAG,CAAC,MAAM,CAAC,eAAe,CAAC;oBACtD,UAAU,EAAE,IAAI,CAAC,UAAU;oBAC3B,KAAK,EAAE,IAAI,CAAC,KAAK;oBACjB,YAAY,EAAE,MAAM;oBACpB,kBAAkB,EAAE,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC;iBACvC,CAAC,CAAA;gBAEF,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC;oBACnD,UAAU,EAAE,IAAI,CAAC,UAAU;oBAC3B,KAAK,EAAE,IAAI,CAAC,KAAK;oBACjB,YAAY,EAAE,MAAM;oBACpB,OAAO,EAAE,IAAI;iBACb,CAAC,CAAA;gBAEF,MAAM,eAAe,GAAG,IAAI,MAAM,EAAE;qBAClC,QAAQ,CAAC,SAAS,CAAC;qBACnB,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;qBACzC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAA;gBAEhC,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,eAAe,EAAE,eAAe,CAAC,KAAK,EAAE,EAAE,CAAA;YACzD,CAAC;YAED,MAAM,UAAU,GAAG,MAAM,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC;gBAC9C,SAAS,EAAE,YAAY,CAAC,mBAAmB,CAAC,SAAS;gBACrD,MAAM;gBACN,OAAO,EAAE,EAAE,sBAAsB,EAAE,KAAK,EAAE;aAC1C,CAAC,CAAA;YAEF,IAAI,OAAO,IAAI,UAAU,EAAE,CAAC;gBAC3B,OAAO,EAAE,KAAK,EAAE,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,CAAA;YAC3C,CAAC;YAED,OAAO;gBACN,IAAI,EAAE,UAAU,CAAC,IAAI;gBACrB,KAAK,EAAE,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS;aAC7D,CAAA;QACF,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,OAAO,CAAC,KAAK,CAAC,aAAa,EAAE,KAAK,CAAC,CAAA;YACnC,OAAO;gBACN,KAAK,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe;aAC/D,CAAA;QACF,CAAC;IACF,CAAC;CACD,CAAA;AAED,+EAA+E;AAC/E,iBAAiB;AACjB,+EAA+E;AAE/E,oCAAoC;AACpC,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,WAAW,EAAE,OAAO,EAAE,SAAS,CAAC,CAAA"}

package/dist/ordinals/index.d.ts

@@ -0,0 +1,118 @@
+/**
+ * Ordinals Module
+ *
+ * Actions for managing ordinals/inscriptions.
+ * Returns WalletOutput[] directly from the SDK - no custom mapping needed.
+ */
+import { type CreateActionArgs, type WalletOutput } from '@bsv/sdk';
+import type { Action, OneSatContext } from '../types';
+type PubKeyHex = string;
+export interface TransferItem {
+    /** The ordinal output to transfer (from listOutputs) */
+    ordinal: WalletOutput;
+    /** Recipient's identity public key (preferred) */
+    counterparty?: PubKeyHex;
+    /** Raw P2PKH address */
+    address?: string;
+}
+export interface TransferOrdinalsRequest {
+    /** Ordinals to transfer with their destinations */
+    transfers: TransferItem[];
+    /** BEEF data from listOutputs (include: 'entire transactions') */
+    inputBEEF: number[];
+}
+export interface ListOrdinalRequest {
+    /** The ordinal output to list (from listOutputs) */
+    ordinal: WalletOutput;
+    /** BEEF data from listOutputs (include: 'entire transactions') */
+    inputBEEF: number[];
+    /** Price in satoshis */
+    price: number;
+    /** Address that receives payment on purchase (BRC-29 receive address) */
+    payAddress: string;
+}
+export interface PurchaseOrdinalRequest {
+    /** Outpoint of listing to purchase */
+    outpoint: string;
+    /** Marketplace address for fees */
+    marketplaceAddress?: string;
+    /** Marketplace fee rate (0-1) */
+    marketplaceRate?: number;
+    /** Optional content type - looked up from ordfs API if not provided */
+    contentType?: string;
+    /** Optional origin outpoint - looked up from ordfs API if not provided */
+    origin?: string;
+    /** Optional name from MAP metadata - looked up from ordfs API if not provided */
+    name?: string;
+}
+export interface OrdinalOperationResponse {
+    txid?: string;
+    rawtx?: string;
+    error?: string;
+}
+/**
+ * Build CreateActionArgs for transferring one or more ordinals.
+ * Does NOT execute - returns params for createAction.
+ */
+export declare function buildTransferOrdinals(ctx: OneSatContext, request: TransferOrdinalsRequest): Promise<CreateActionArgs | {
+    error: string;
+}>;
+/**
+ * Build CreateActionArgs for listing an ordinal for sale.
+ * Does NOT execute - returns params for createAction.
+ */
+export declare function buildListOrdinal(ctx: OneSatContext, request: ListOrdinalRequest): Promise<CreateActionArgs | {
+    error: string;
+}>;
+/** Input for getOrdinals action */
+export interface GetOrdinalsInput {
+    /** Max number of ordinals to return */
+    limit?: number;
+    /** Offset for pagination */
+    offset?: number;
+}
+/** Result from getOrdinals action */
+export interface GetOrdinalsResult {
+    outputs: WalletOutput[];
+    BEEF?: number[];
+}
+/**
+ * Get ordinals from the wallet with BEEF for spending.
+ */
+export declare const getOrdinals: Action<GetOrdinalsInput, GetOrdinalsResult>;
+/** Input for deriveCancelAddress action */
+export interface DeriveCancelAddressInput {
+    /** Outpoint of the ordinal listing */
+    outpoint: string;
+}
+/**
+ * Derive a cancel address for an ordinal listing.
+ */
+export declare const deriveCancelAddress: Action<DeriveCancelAddressInput, string>;
+/**
+ * Transfer an ordinal to a new owner.
+ */
+export declare const transferOrdinals: Action<TransferOrdinalsRequest, OrdinalOperationResponse>;
+/**
+ * List an ordinal for sale on the global orderbook.
+ */
+export declare const listOrdinal: Action<ListOrdinalRequest, OrdinalOperationResponse>;
+/** Input for cancelListing action */
+export interface CancelListingInput {
+    /** The listing output to cancel (from listOutputs, must include lockingScript) */
+    listing: WalletOutput;
+    /** BEEF data from listOutputs (include: 'entire transactions') */
+    inputBEEF: number[];
+}
+/**
+ * Cancel an ordinal listing.
+ */
+export declare const cancelListing: Action<CancelListingInput, OrdinalOperationResponse>;
+/**
+ * Purchase an ordinal from the global orderbook.
+ */
+export declare const purchaseOrdinal: Action<PurchaseOrdinalRequest, OrdinalOperationResponse>;
+/** All ordinals actions for registry */
+export declare const ordinalsActions: (Action<GetOrdinalsInput, GetOrdinalsResult> | Action<DeriveCancelAddressInput, string> | Action<TransferOrdinalsRequest, OrdinalOperationResponse> | Action<ListOrdinalRequest, OrdinalOperationResponse> | Action<CancelListingInput, OrdinalOperationResponse> | Action<PurchaseOrdinalRequest, OrdinalOperationResponse>)[];
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/ordinals/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/ordinals/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EAGN,KAAK,gBAAgB,EAWrB,KAAK,YAAY,EAEjB,MAAM,UAAU,CAAA;AAOjB,OAAO,KAAK,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AA2FrD,KAAK,SAAS,GAAG,MAAM,CAAA;AAEvB,MAAM,WAAW,YAAY;IAC5B,wDAAwD;IACxD,OAAO,EAAE,YAAY,CAAA;IACrB,kDAAkD;IAClD,YAAY,CAAC,EAAE,SAAS,CAAA;IACxB,wBAAwB;IACxB,OAAO,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,uBAAuB;IACvC,mDAAmD;IACnD,SAAS,EAAE,YAAY,EAAE,CAAA;IACzB,kEAAkE;IAClE,SAAS,EAAE,MAAM,EAAE,CAAA;CACnB;AAED,MAAM,WAAW,kBAAkB;IAClC,oDAAoD;IACpD,OAAO,EAAE,YAAY,CAAA;IACrB,kEAAkE;IAClE,SAAS,EAAE,MAAM,EAAE,CAAA;IACnB,wBAAwB;IACxB,KAAK,EAAE,MAAM,CAAA;IACb,yEAAyE;IACzE,UAAU,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,sBAAsB;IACtC,sCAAsC;IACtC,QAAQ,EAAE,MAAM,CAAA;IAChB,mCAAmC;IACnC,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,iCAAiC;IACjC,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,uEAAuE;IACvE,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,0EAA0E;IAC1E,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,iFAAiF;IACjF,IAAI,CAAC,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,wBAAwB;IACxC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,KAAK,CAAC,EAAE,MAAM,CAAA;CACd;AA8GD;;;GAGG;AACH,wBAAsB,qBAAqB,CAC1C,GAAG,EAAE,aAAa,EAClB,OAAO,EAAE,uBAAuB,GAC9B,OAAO,CAAC,gBAAgB,GAAG;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC,CAuF/C;AAED;;;GAGG;AACH,wBAAsB,gBAAgB,CACrC,GAAG,EAAE,aAAa,EAClB,OAAO,EAAE,kBAAkB,GACzB,OAAO,CAAC,gBAAgB,GAAG;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC,CAkD/C;AAMD,mCAAmC;AACnC,MAAM,WAAW,gBAAgB;IAChC,uCAAuC;IACvC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,4BAA4B;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAA;CACf;AAED,qCAAqC;AACrC,MAAM,WAAW,iBAAiB;IACjC,OAAO,EAAE,YAAY,EAAE,CAAA;IACvB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;CACf;AAED;;GAEG;AACH,eAAO,MAAM,WAAW,EAAE,MAAM,CAAC,gBAAgB,EAAE,iBAAiB,CAkCnE,CAAA;AAED,2CAA2C;AAC3C,MAAM,WAAW,wBAAwB;IACxC,sCAAsC;IACtC,QAAQ,EAAE,MAAM,CAAA;CAChB;AAED;;GAEG;AACH,eAAO,MAAM,mBAAmB,EAAE,MAAM,CAAC,wBAAwB,EAAE,MAAM,CAmBxE,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,gBAAgB,EAAE,MAAM,CACpC,uBAAuB,EACvB,wBAAwB,CAsIxB,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,WAAW,EAAE,MAAM,CAAC,kBAAkB,EAAE,wBAAwB,CA2E3E,CAAA;AAEF,qCAAqC;AACrC,MAAM,WAAW,kBAAkB;IAClC,kFAAkF;IAClF,OAAO,EAAE,YAAY,CAAA;IACrB,kEAAkE;IAClE,SAAS,EAAE,MAAM,EAAE,CAAA;CACnB;AAED;;GAEG;AACH,eAAO,MAAM,aAAa,EAAE,MAAM,CACjC,kBAAkB,EAClB,wBAAwB,CA+JxB,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,eAAe,EAAE,MAAM,CACnC,sBAAsB,EACtB,wBAAwB,CAqMxB,CAAA;AAMD,wCAAwC;AACxC,eAAO,MAAM,eAAe,iUAO3B,CAAA"}