@bsv/wallet-toolbox 2.10.3 → 2.11.0

package/out/src/WalletPermissionsManager.js

@@ -3,6 +3,39 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.WalletPermissionsManager = void 0;
 const sdk_1 = require("@bsv/sdk");
 const brc114ActionTimeLabels_1 = require("./utility/brc114ActionTimeLabels");
+const brc177NoSendExpiry_1 = require("./utility/brc177NoSendExpiry");
+function brc177PreflightSatoshis(args) {
+    const outputs = args.outputs ?? [];
+    let total = 0;
+    for (const output of outputs) {
+        if (typeof output.satoshis !== 'number' || !Number.isSafeInteger(output.satoshis) || output.satoshis < 0) {
+            throw new Error('BRC-177 outputs must contain valid satoshi amounts');
+        }
+        total += output.satoshis;
+        if (!Number.isSafeInteger(total))
+            throw new Error('BRC-177 output amount exceeds the safely supported range');
+    }
+    // Even an action funded entirely by caller-supplied inputs incurs a wallet
+    // prefunding fee. Require a spending grant before that fee can be broadcast.
+    return Math.max(1, total);
+}
+function validateBrc177CreateActionShape(args) {
+    const request = args;
+    if (!Array.isArray(request.outputs) || request.outputs.length === 0) {
+        throw new Error('BRC-177 protected actions require at least one output');
+    }
+    if (request.options?.noSend !== true)
+        throw new Error('BRC-177 protected actions require noSend');
+    if ((request.options.sendWith?.length ?? 0) > 0) {
+        throw new Error('BRC-177 protected actions cannot use sendWith');
+    }
+    if ((request.options.noSendChange?.length ?? 0) > 0) {
+        throw new Error('BRC-177 protected actions cannot supply noSendChange');
+    }
+    if (request.options.returnTXIDOnly === true) {
+        throw new Error('BRC-177 protected actions cannot use returnTXIDOnly');
+    }
+}
 // Security invariant: only the configured admin originator bypasses permission
 // prompts. Admin-reserved protocols, baskets, and labels are rejected for all
 // other originators; counterparty bypasses require an explicit configuration
@@ -162,7 +195,41 @@ class WalletPermissionsManager {
             seekGroupedPermission: true,
             differentiatePrivilegedOperations: true,
             whitelistedCounterparties: {},
-            ...config // override with user-specified config
+            ...config,
+            permissionModules: {
+                ...config.permissionModules,
+                // BRC-177 is a built-in reserved BRC-111 module in every Toolbox wallet.
+                nosend: {
+                    onRequest: async (req) => {
+                        const labels = req.args.labels;
+                        (0, brc177NoSendExpiry_1.parseBrc177NoSendExpiryLabels)(labels);
+                        if (req.method !== 'createAction' && req.method !== 'listActions') {
+                            throw new Error('BRC-177 noSend expiry labels are only valid for createAction and listActions');
+                        }
+                        if (req.method === 'createAction')
+                            validateBrc177CreateActionShape(req.args);
+                        // Prefunding has a real miner fee, so authorize use of this
+                        // module before the underlying wallet can broadcast it. This is
+                        // deliberately separate from the later amount-specific spend
+                        // authorization for the protected transaction.
+                        await this.ensureLabelAccess({
+                            originator: req.originator,
+                            label: 'BRC-177 noSend expiry',
+                            reason: req.method,
+                            usageType: req.method === 'createAction' ? 'apply' : 'list'
+                        });
+                        if (req.method === 'createAction') {
+                            await this.ensureSpendingAuthorization({
+                                originator: req.originator,
+                                satoshis: brc177PreflightSatoshis(req.args),
+                                reason: 'BRC-177 protected action prefunding'
+                            });
+                        }
+                        return { args: req.args };
+                    },
+                    onResponse: async (res) => res
+                }
+            }
         };
     }
     /* ---------------------------------------------------------------------
@@ -189,12 +256,19 @@ class WalletPermissionsManager {
         if (module == null) {
             throw new Error(`Unsupported P-module scheme: p ${schemeID}`);
         }
+        const request = { method, args, originator };
+        if (module.handleRequest != null) {
+            let nextCalled = false;
+            return (await module.handleRequest(request, async (transformedArgs) => {
+                if (nextCalled) {
+                    throw new Error(`P-module p ${schemeID} called its underlying wallet operation more than once`);
+                }
+                nextCalled = true;
+                return await underlyingCall(transformedArgs, originator);
+            }));
+        }
         // Transform request with module
-        const transformedReq = await module.onRequest({
-            method,
-            args,
-            originator
-        });
+        const transformedReq = await module.onRequest(request);
         // Call underlying method with transformed request
         const results = await underlyingCall(transformedReq.args, originator);
         // Transform response with module
@@ -871,7 +945,7 @@ class WalletPermissionsManager {
      * Ensures the originator has spending authorization (DSAP) for a certain satoshi amount.
      * If the existing token limit is insufficient, attempts to renew. If no token, attempts to create one.
      */
-    async ensureSpendingAuthorization({ originator, satoshis, lineItems, reason, seekPermission = true }) {
+    async ensureSpendingAuthorization({ originator, satoshis, lineItems, reason, seekPermission = true, allowRecentGrant = true }) {
         const { normalized: normalizedOriginator, lookupValues } = this.prepareOriginator(originator);
         originator = normalizedOriginator;
         if (this.isAdminOriginator(originator))
@@ -884,7 +958,7 @@ class WalletPermissionsManager {
         // Spending keys are amount-scoped. The recent-grant window this adds sits
         // inside the pre-existing permissionCache window grantPermission already
         // wrote for spending, so accounting exposure is unchanged.
-        if (await this.hasRecentOrPendingGrant(cacheKey)) {
+        if (allowRecentGrant && (await this.hasRecentOrPendingGrant(cacheKey))) {
             return true;
         }
         const token = await this.findSpendingToken(originator, lookupValues);
@@ -2980,7 +3054,8 @@ class WalletPermissionsManager {
                     originator: originator,
                     satoshis: netSpent,
                     lineItems,
-                    reason: originalDescription
+                    reason: originalDescription,
+                    allowRecentGrant: (0, brc177NoSendExpiry_1.parseBrc177NoSendExpiryLabels)(args.labels) == null
                 });
             }
             catch (err) {