@1sat/actions 0.0.234 → 0.1.0

package/dist/1color/send.js

@@ -0,0 +1,175 @@
+/**
+ * 1Color (BRC-162) send to a BRC-169 handle through the wallet's BRC-207
+ * `color` module, delivered per BRC-232.
+ *
+ * 1. Resolve the handle (`resolveHandle`): identity key + messagebox.
+ * 2. Derive the recipient's key under `colorProtocolID(assetId, prefix,
+ *    suffix)` (fresh random base64 prefix and suffix), keyID `color`,
+ *    counterparty = the recipient, and build the 1Color value output.
+ * 3. One `createAction` with that single output, the BRC-207 plan (assets
+ *    `[assetId]`, no owned outputs, one `transfer`) plus the BRC-177 label
+ *    `p nosend expiry seconds <n>`, `noSend` and `randomizeOutputs: false`:
+ *    the handoff. The module selects the token inputs, splits to the exact
+ *    amount when it has to, signs and asks for consent. The action is not
+ *    broadcast; the recipient submits it.
+ * 4. Delivery: a signed BRC-169 envelope to the resolved messagebox, box
+ *    `transaction-delivery`, `payment: null`, whose encrypted content is the
+ *    BRC-232 MIME entity with one `basket insertion` receipt into
+ *    `p color <assetTag>`.
+ *
+ * When delivery fails the result carries the error with `txid` and `tx`, so
+ * the caller can retry delivery or `abortAction` the send.
+ */
+import { resolveHandle } from '@1sat/client';
+import { OneColor } from '@1sat/templates';
+import { COLOR_SEND_EXPIRY_SECONDS, TRANSACTION_DELIVERY_BOX, } from '@1sat/types';
+import { COLOR_KEY_ID, ColorPlan, ISSUE, assetBasket, colorProtocolID, } from '@bsv/color-permission-module';
+import { Beef, PublicKey, Utils } from '@bsv/sdk';
+import { randomBase64, sendEnvelope } from '../metanet/deliver.js';
+import { encodeTransactionDeliveryMime } from '../metanet/delivery.js';
+import { colorReceiptInstructions } from './receipt.js';
+export const send1Color = {
+    meta: {
+        name: 'send1Color',
+        description: "Send 1Color (BRC-162) tokens to a BRC-169 handle: a BRC-177 handoff built by the wallet's BRC-207 color module, delivered (BRC-232) in a signed envelope to the handle's transaction-delivery box; the recipient submits it",
+        category: 'tokens',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                assetId: {
+                    type: 'string',
+                    description: 'The asset id, <txid>_<vout>',
+                },
+                amount: {
+                    type: 'string',
+                    description: 'Amount in raw units (string for bigint)',
+                },
+                destination: {
+                    type: 'object',
+                    description: '{ handle } — a BRC-169 handle (@handle@domain)',
+                },
+                expirySeconds: {
+                    type: 'integer',
+                    description: 'BRC-177 nosend expiry in seconds (default 31536000, one year)',
+                },
+                memo: {
+                    type: 'string',
+                    description: 'Optional memo carried in the delivery',
+                },
+            },
+            required: ['assetId', 'amount', 'destination'],
+        },
+    },
+    async execute(ctx, input) {
+        try {
+            const { assetId } = input;
+            let basket;
+            try {
+                if (assetId === ISSUE)
+                    throw new Error('ISSUE');
+                basket = assetBasket(assetId, 'value');
+            }
+            catch {
+                return { error: 'invalid-asset-id: expected <txid>_<vout>' };
+            }
+            const amount = BigInt(input.amount);
+            if (amount <= 0n)
+                return { error: 'amount-must-be-positive' };
+            // 1. Resolve the handle; the recipient key is derived from it.
+            const resolution = await resolveHandle(input.destination.handle);
+            // 2. The recipient's output.
+            const derivationPrefix = randomBase64();
+            const derivationSuffix = randomBase64();
+            const { publicKey } = await ctx.wallet.getPublicKey({
+                protocolID: colorProtocolID(assetId, derivationPrefix, derivationSuffix),
+                keyID: COLOR_KEY_ID,
+                counterparty: resolution.identityKey,
+            });
+            const lockingScript = OneColor.value(assetId, amount, {
+                lock: PublicKey.fromString(publicKey).toHash(),
+            })
+                .lock()
+                .toHex();
+            // The delivery body, checked (memo bound, receipt) before the handoff
+            // exists, so a bad memo leaves no noSend action behind.
+            const { publicKey: senderIdentityKey } = await ctx.wallet.getPublicKey({
+                identityKey: true,
+            });
+            const delivery = (txid, beef) => encodeTransactionDeliveryMime({
+                version: 1,
+                txid: Uint8Array.from(txid),
+                beef: Uint8Array.from(beef),
+                outputs: [
+                    {
+                        outputIndex: 0,
+                        protocol: 'basket insertion',
+                        insertionRemittance: {
+                            basket,
+                            customInstructions: colorReceiptInstructions({
+                                assetId,
+                                derivationPrefix,
+                                derivationSuffix,
+                                senderIdentityKey,
+                            }),
+                        },
+                    },
+                ],
+                // wallet-toolbox cannot issue BRC-177 lifecycle statements yet.
+                lifecycles: [],
+                ...(input.memo !== undefined && { memo: input.memo }),
+            });
+            delivery(new Array(32).fill(0), []);
+            // 3. The handoff; the module funds, splits and signs.
+            const expiry = input.expirySeconds ?? COLOR_SEND_EXPIRY_SECONDS;
+            const result = await ctx.wallet.createAction({
+                description: `Send ${amount} 1Color tokens`.slice(0, 50),
+                outputs: [
+                    { lockingScript, satoshis: 1, outputDescription: '1Color tokens' },
+                ],
+                labels: [
+                    ...ColorPlan.toLabels({
+                        version: 1,
+                        assets: [assetId],
+                        ownedOutputs: [],
+                        operations: [{ assetId, operation: 'transfer' }],
+                        inputPositions: [],
+                        changePositions: [],
+                        sighashTypes: [],
+                    }),
+                    `p nosend expiry seconds ${expiry}`,
+                ],
+                options: { noSend: true, randomizeOutputs: false },
+            });
+            if (!result.txid || !result.tx)
+                return { error: 'no-transaction' };
+            const txid = result.txid;
+            const tx = Array.from(result.tx);
+            // 4. Deliver.
+            try {
+                const plaintext = delivery(Utils.toArray(txid, 'hex'), Beef.fromBinary(tx).toBinary());
+                const sent = await sendEnvelope(ctx.wallet, resolution, {
+                    senderIdentityKey,
+                    plaintext: Array.from(plaintext),
+                    payment: null,
+                    messageBox: TRANSACTION_DELIVERY_BOX,
+                });
+                return { txid, tx, delivered: 'envelope', messageId: sent.messageId };
+            }
+            catch (error) {
+                // The send exists as a noSend action: return it so the caller can
+                // retry delivery or abortAction it.
+                return {
+                    txid,
+                    tx,
+                    error: `delivery-failed: ${error instanceof Error ? error.message : String(error)}`,
+                };
+            }
+        }
+        catch (error) {
+            return {
+                error: error instanceof Error ? error.message : String(error),
+            };
+        }
+    },
+};
+//# sourceMappingURL=send.js.map

package/dist/1color/send.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"send.js","sourceRoot":"","sources":["../../src/1color/send.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AAC5C,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAA;AAC1C,OAAO,EACN,yBAAyB,EACzB,wBAAwB,GACxB,MAAM,aAAa,CAAA;AACpB,OAAO,EACN,YAAY,EACZ,SAAS,EACT,KAAK,EACL,WAAW,EACX,eAAe,GACf,MAAM,8BAA8B,CAAA;AACrC,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,UAAU,CAAA;AACjD,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AAClE,OAAO,EAAE,6BAA6B,EAAE,MAAM,wBAAwB,CAAA;AAEtE,OAAO,EAAE,wBAAwB,EAAE,MAAM,cAAc,CAAA;AA6BvD,MAAM,CAAC,MAAM,UAAU,GAA8C;IACpE,IAAI,EAAE;QACL,IAAI,EAAE,YAAY;QAClB,WAAW,EACV,6NAA6N;QAC9N,QAAQ,EAAE,QAAQ;QAClB,WAAW,EAAE;YACZ,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACX,OAAO,EAAE;oBACR,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,6BAA6B;iBAC1C;gBACD,MAAM,EAAE;oBACP,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,yCAAyC;iBACtD;gBACD,WAAW,EAAE;oBACZ,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,gDAAgD;iBAC7D;gBACD,aAAa,EAAE;oBACd,IAAI,EAAE,SAAS;oBACf,WAAW,EACV,+DAA+D;iBAChE;gBACD,IAAI,EAAE;oBACL,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,uCAAuC;iBACpD;aACD;YACD,QAAQ,EAAE,CAAC,SAAS,EAAE,QAAQ,EAAE,aAAa,CAAC;SAC9C;KACD;IAED,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK;QACvB,IAAI,CAAC;YACJ,MAAM,EAAE,OAAO,EAAE,GAAG,KAAK,CAAA;YACzB,IAAI,MAAc,CAAA;YAClB,IAAI,CAAC;gBACJ,IAAI,OAAO,KAAK,KAAK;oBAAE,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,CAAA;gBAC/C,MAAM,GAAG,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;YACvC,CAAC;YAAC,MAAM,CAAC;gBACR,OAAO,EAAE,KAAK,EAAE,0CAA0C,EAAE,CAAA;YAC7D,CAAC;YACD,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;YACnC,IAAI,MAAM,IAAI,EAAE;gBAAE,OAAO,EAAE,KAAK,EAAE,yBAAyB,EAAE,CAAA;YAE7D,+DAA+D;YAC/D,MAAM,UAAU,GAAG,MAAM,aAAa,CAAC,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,CAAA;YAEhE,6BAA6B;YAC7B,MAAM,gBAAgB,GAAG,YAAY,EAAE,CAAA;YACvC,MAAM,gBAAgB,GAAG,YAAY,EAAE,CAAA;YACvC,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC;gBACnD,UAAU,EAAE,eAAe,CAC1B,OAAO,EACP,gBAAgB,EAChB,gBAAgB,CAChB;gBACD,KAAK,EAAE,YAAY;gBACnB,YAAY,EAAE,UAAU,CAAC,WAAW;aACpC,CAAC,CAAA;YACF,MAAM,aAAa,GAAG,QAAQ,CAAC,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE;gBACrD,IAAI,EAAE,SAAS,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,MAAM,EAAc;aAC1D,CAAC;iBACA,IAAI,EAAE;iBACN,KAAK,EAAE,CAAA;YAET,sEAAsE;YACtE,wDAAwD;YACxD,MAAM,EAAE,SAAS,EAAE,iBAAiB,EAAE,GAAG,MAAM,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC;gBACtE,WAAW,EAAE,IAAI;aACjB,CAAC,CAAA;YACF,MAAM,QAAQ,GAAG,CAAC,IAAc,EAAE,IAAc,EAAE,EAAE,CACnD,6BAA6B,CAAC;gBAC7B,OAAO,EAAE,CAAC;gBACV,IAAI,EAAE,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC;gBAC3B,IAAI,EAAE,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC;gBAC3B,OAAO,EAAE;oBACR;wBACC,WAAW,EAAE,CAAC;wBACd,QAAQ,EAAE,kBAAkB;wBAC5B,mBAAmB,EAAE;4BACpB,MAAM;4BACN,kBAAkB,EAAE,wBAAwB,CAAC;gCAC5C,OAAO;gCACP,gBAAgB;gCAChB,gBAAgB;gCAChB,iBAAiB;6BACjB,CAAC;yBACF;qBACD;iBACD;gBACD,gEAAgE;gBAChE,UAAU,EAAE,EAAE;gBACd,GAAG,CAAC,KAAK,CAAC,IAAI,KAAK,SAAS,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC;aACrD,CAAC,CAAA;YACH,QAAQ,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;YAEnC,sDAAsD;YACtD,MAAM,MAAM,GAAG,KAAK,CAAC,aAAa,IAAI,yBAAyB,CAAA;YAC/D,MAAM,MAAM,GAAG,MAAM,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC;gBAC5C,WAAW,EAAE,QAAQ,MAAM,gBAAgB,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC;gBACxD,OAAO,EAAE;oBACR,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC,EAAE,iBAAiB,EAAE,eAAe,EAAE;iBAClE;gBACD,MAAM,EAAE;oBACP,GAAG,SAAS,CAAC,QAAQ,CAAC;wBACrB,OAAO,EAAE,CAAC;wBACV,MAAM,EAAE,CAAC,OAAO,CAAC;wBACjB,YAAY,EAAE,EAAE;wBAChB,UAAU,EAAE,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,CAAC;wBAChD,cAAc,EAAE,EAAE;wBAClB,eAAe,EAAE,EAAE;wBACnB,YAAY,EAAE,EAAE;qBAChB,CAAC;oBACF,2BAA2B,MAAM,EAAE;iBACnC;gBACD,OAAO,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,EAAE,KAAK,EAAE;aAClD,CAAC,CAAA;YACF,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,EAAE;gBAAE,OAAO,EAAE,KAAK,EAAE,gBAAgB,EAAE,CAAA;YAClE,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAA;YACxB,MAAM,EAAE,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;YAEhC,cAAc;YACd,IAAI,CAAC;gBACJ,MAAM,SAAS,GAAG,QAAQ,CACzB,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,EAC1B,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,QAAQ,EAAE,CAC9B,CAAA;gBACD,MAAM,IAAI,GAAG,MAAM,YAAY,CAAC,GAAG,CAAC,MAAM,EAAE,UAAU,EAAE;oBACvD,iBAAiB;oBACjB,SAAS,EAAE,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC;oBAChC,OAAO,EAAE,IAAI;oBACb,UAAU,EAAE,wBAAwB;iBACpC,CAAC,CAAA;gBACF,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,SAAS,EAAE,UAAU,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,CAAA;YACtE,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBAChB,kEAAkE;gBAClE,oCAAoC;gBACpC,OAAO;oBACN,IAAI;oBACJ,EAAE;oBACF,KAAK,EAAE,oBAAoB,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE;iBACnF,CAAA;YACF,CAAC;QACF,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,OAAO;gBACN,KAAK,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC;aAC7D,CAAA;QACF,CAAC;IACF,CAAC;CACD,CAAA"}

package/dist/{mandala → 1color}/send.test.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"send.test.d.ts","sourceRoot":"","sources":["../../src/mandala/send.test.ts"],"names":[],"mappings":""}
+{"version":3,"file":"send.test.d.ts","sourceRoot":"","sources":["../../src/1color/send.test.ts"],"names":[],"mappings":""}