@bsv/sdk 1.3.12 → 1.3.14

package/dist/esm/src/wallet/substrates/WalletWireTransceiver.js

@@ -1,3 +1,4 @@
+import { SecurityLevels } from '../Wallet.interfaces.js';
 import { Certificate } from '../../auth/index.js';
 import { Utils } from '../../primitives/index.js';
 import calls from './WalletWireCalls.js';
@@ -48,7 +49,7 @@ export default class WalletWireTransceiver {
         paramWriter.writeVarIntNum(descriptionBytes.length);
         paramWriter.write(descriptionBytes);
         // input BEEF
-        if (args.inputBEEF) {
+        if (args.inputBEEF != null) {
             paramWriter.writeVarIntNum(args.inputBEEF.length);
             paramWriter.write(args.inputBEEF);
         }
@@ -56,20 +57,20 @@ export default class WalletWireTransceiver {
             paramWriter.writeVarIntNum(-1);
         }
         // Serialize inputs
-        if (args.inputs) {
+        if (args.inputs != null) {
             paramWriter.writeVarIntNum(args.inputs.length);
             for (const input of args.inputs) {
                 // outpoint
                 paramWriter.write(this.encodeOutpoint(input.outpoint));
                 // unlockingScript / unlockingScriptLength
-                if (input.unlockingScript) {
+                if (input.unlockingScript != null && input.unlockingScript !== '') {
                     const unlockingScriptBytes = Utils.toArray(input.unlockingScript, 'hex');
                     paramWriter.writeVarIntNum(unlockingScriptBytes.length);
                     paramWriter.write(unlockingScriptBytes);
                 }
                 else {
                     paramWriter.writeVarIntNum(-1);
-                    paramWriter.writeVarIntNum(input.unlockingScriptLength);
+                    paramWriter.writeVarIntNum(input.unlockingScriptLength ?? 0);
                 }
                 // inputDescription
                 const inputDescriptionBytes = Utils.toArray(input.inputDescription, 'utf8');
@@ -88,7 +89,7 @@ export default class WalletWireTransceiver {
             paramWriter.writeVarIntNum(-1);
         }
         // Serialize outputs
-        if (args.outputs) {
+        if (args.outputs != null) {
             paramWriter.writeVarIntNum(args.outputs.length);
             for (const output of args.outputs) {
                 // lockingScript
@@ -102,7 +103,7 @@ export default class WalletWireTransceiver {
                 paramWriter.writeVarIntNum(outputDescriptionBytes.length);
                 paramWriter.write(outputDescriptionBytes);
                 // basket
-                if (output.basket) {
+                if (output.basket != null && output.basket !== '') {
                     const basketBytes = Utils.toArray(output.basket, 'utf8');
                     paramWriter.writeVarIntNum(basketBytes.length);
                     paramWriter.write(basketBytes);
@@ -111,7 +112,7 @@ export default class WalletWireTransceiver {
                     paramWriter.writeVarIntNum(-1);
                 }
                 // customInstructions
-                if (output.customInstructions) {
+                if (output.customInstructions != null && output.customInstructions !== '') {
                     const customInstructionsBytes = Utils.toArray(output.customInstructions, 'utf8');
                     paramWriter.writeVarIntNum(customInstructionsBytes.length);
                     paramWriter.write(customInstructionsBytes);
@@ -120,7 +121,7 @@ export default class WalletWireTransceiver {
                     paramWriter.writeVarIntNum(-1);
                 }
                 // tags
-                if (output.tags) {
+                if (output.tags != null) {
                     paramWriter.writeVarIntNum(output.tags.length);
                     for (const tag of output.tags) {
                         const tagBytes = Utils.toArray(tag, 'utf8');
@@ -151,7 +152,7 @@ export default class WalletWireTransceiver {
             paramWriter.writeVarIntNum(-1);
         }
         // Serialize labels
-        if (args.labels) {
+        if (args.labels != null) {
             paramWriter.writeVarIntNum(args.labels.length);
             for (const label of args.labels) {
                 const labelBytes = Utils.toArray(label, 'utf8');
@@ -163,7 +164,7 @@ export default class WalletWireTransceiver {
             paramWriter.writeVarIntNum(-1);
         }
         // Serialize options
-        if (args.options) {
+        if (args.options != null) {
             paramWriter.writeInt8(1); // options present
             // signAndProcess
             if (typeof args.options.signAndProcess === 'boolean') {
@@ -187,7 +188,7 @@ export default class WalletWireTransceiver {
                 paramWriter.writeInt8(-1);
             }
             // knownTxids
-            if (args.options.knownTxids) {
+            if (args.options.knownTxids != null) {
                 paramWriter.writeVarIntNum(args.options.knownTxids.length);
                 for (const txid of args.options.knownTxids) {
                     const txidBytes = Utils.toArray(txid, 'hex');
@@ -212,7 +213,7 @@ export default class WalletWireTransceiver {
                 paramWriter.writeInt8(-1);
             }
             // noSendChange
-            if (args.options.noSendChange) {
+            if (args.options.noSendChange != null) {
                 paramWriter.writeVarIntNum(args.options.noSendChange.length);
                 for (const outpoint of args.options.noSendChange) {
                     paramWriter.write(this.encodeOutpoint(outpoint));
@@ -222,7 +223,7 @@ export default class WalletWireTransceiver {
                 paramWriter.writeVarIntNum(-1);
             }
             // sendWith
-            if (args.options.sendWith) {
+            if (args.options.sendWith != null) {
                 paramWriter.writeVarIntNum(args.options.sendWith.length);
                 for (const txid of args.options.sendWith) {
                     const txidBytes = Utils.toArray(txid, 'hex');
@@ -276,7 +277,7 @@ export default class WalletWireTransceiver {
                 const txidBytes = resultReader.read(32);
                 const txid = Utils.toHex(txidBytes);
                 const statusCode = resultReader.readInt8();
-                let status;
+                let status = 'unproven';
                 if (statusCode === 1)
                     status = 'unproven';
                 else if (statusCode === 2)
@@ -325,7 +326,7 @@ export default class WalletWireTransceiver {
         paramWriter.writeVarIntNum(referenceBytes.length);
         paramWriter.write(referenceBytes);
         // Serialize options
-        if (args.options) {
+        if (args.options != null) {
             paramWriter.writeInt8(1); // options present
             // acceptDelayedBroadcast
             if (typeof args.options.acceptDelayedBroadcast === 'boolean') {
@@ -349,7 +350,7 @@ export default class WalletWireTransceiver {
                 paramWriter.writeInt8(-1);
             }
             // sendWith
-            if (args.options.sendWith) {
+            if (args.options.sendWith != null) {
                 paramWriter.writeVarIntNum(args.options.sendWith.length);
                 for (const txid of args.options.sendWith) {
                     const txidBytes = Utils.toArray(txid, 'hex');
@@ -387,7 +388,7 @@ export default class WalletWireTransceiver {
                 const txidBytes = resultReader.read(32);
                 const txid = Utils.toHex(txidBytes);
                 const statusCode = resultReader.readInt8();
-                let status;
+                let status = 'unproven';
                 if (statusCode === 1)
                     status = 'unproven';
                 else if (statusCode === 2)
@@ -453,7 +454,11 @@ export default class WalletWireTransceiver {
             paramWriter.writeVarIntNum(-1);
         }
         // Serialize seekPermission
-        paramWriter.writeInt8(typeof args.seekPermission === 'boolean' ? args.seekPermission ? 1 : 0 : -1);
+        paramWriter.writeInt8(typeof args.seekPermission === 'boolean'
+            ? args.seekPermission
+                ? 1
+                : 0
+            : -1);
         // Transmit and parse response
         const result = await this.transmit('listActions', originator, paramWriter.toArray());
         const resultReader = new Utils.Reader(result);
@@ -624,6 +629,9 @@ export default class WalletWireTransceiver {
         for (const out of args.outputs) {
             paramWriter.writeVarIntNum(out.outputIndex);
             if (out.protocol === 'wallet payment') {
+                if (out.paymentRemittance == null) {
+                    throw new Error('Payment remittance is required for wallet payment');
+                }
                 paramWriter.writeUInt8(1);
                 paramWriter.write(Utils.toArray(out.paymentRemittance.senderIdentityKey, 'hex'));
                 const derivationPrefixAsArray = Utils.toArray(out.paymentRemittance.derivationPrefix, 'base64');
@@ -635,10 +643,10 @@ export default class WalletWireTransceiver {
             }
             else {
                 paramWriter.writeUInt8(2);
-                const basketAsArray = Utils.toArray(out.insertionRemittance.basket, 'utf8');
+                const basketAsArray = Utils.toArray(out.insertionRemittance?.basket, 'utf8');
                 paramWriter.writeVarIntNum(basketAsArray.length);
                 paramWriter.write(basketAsArray);
-                if (typeof out.insertionRemittance.customInstructions) {
+                if (typeof out.insertionRemittance?.customInstructions === 'string' && out.insertionRemittance.customInstructions !== '') {
                     const customInstructionsAsArray = Utils.toArray(out.insertionRemittance.customInstructions, 'utf8');
                     paramWriter.writeVarIntNum(customInstructionsAsArray.length);
                     paramWriter.write(customInstructionsAsArray);
@@ -646,7 +654,7 @@ export default class WalletWireTransceiver {
                 else {
                     paramWriter.writeVarIntNum(-1);
                 }
-                if (typeof out.insertionRemittance.tags === 'object') {
+                if (typeof out.insertionRemittance?.tags === 'object') {
                     paramWriter.writeVarIntNum(out.insertionRemittance.tags.length);
                     for (const tag of out.insertionRemittance.tags) {
                         const tagAsArray = Utils.toArray(tag, 'utf8');
@@ -674,7 +682,11 @@ export default class WalletWireTransceiver {
         paramWriter.writeVarIntNum(descriptionAsArray.length);
         paramWriter.write(descriptionAsArray);
         // Serialize seekPermission
-        paramWriter.writeInt8(typeof args.seekPermission === 'boolean' ? args.seekPermission ? 1 : 0 : -1);
+        paramWriter.writeInt8(typeof args.seekPermission === 'boolean'
+            ? args.seekPermission
+                ? 1
+                : 0
+            : -1);
         await this.transmit('internalizeAction', originator, paramWriter.toArray());
         return { accepted: true };
     }
@@ -743,12 +755,16 @@ export default class WalletWireTransceiver {
             paramWriter.writeVarIntNum(-1);
         }
         // Serialize seekPermission
-        paramWriter.writeInt8(typeof args.seekPermission === 'boolean' ? args.seekPermission ? 1 : 0 : -1);
+        paramWriter.writeInt8(typeof args.seekPermission === 'boolean'
+            ? args.seekPermission
+                ? 1
+                : 0
+            : -1);
         const result = await this.transmit('listOutputs', originator, paramWriter.toArray());
         const resultReader = new Utils.Reader(result);
         const totalOutputs = resultReader.readVarIntNum();
         const beefLength = resultReader.readVarIntNum();
-        let BEEF = undefined;
+        let BEEF;
         if (beefLength >= 0) {
             BEEF = resultReader.read(beefLength);
         }
@@ -820,7 +836,7 @@ export default class WalletWireTransceiver {
         const paramWriter = new Utils.Writer();
         paramWriter.writeUInt8(args.identityKey ? 1 : 0);
         if (!args.identityKey) {
-            paramWriter.write(this.encodeKeyRelatedParams(args.protocolID, args.keyID, args.counterparty, args.privileged, args.privilegedReason));
+            paramWriter.write(this.encodeKeyRelatedParams(args.protocolID ??= [SecurityLevels.Silent, 'default'], args.keyID ??= '', args.counterparty, args.privileged, args.privilegedReason));
             if (typeof args.forSelf === 'boolean') {
                 paramWriter.writeInt8(args.forSelf ? 1 : 0);
             }
@@ -832,7 +848,11 @@ export default class WalletWireTransceiver {
             paramWriter.write(this.encodePrivilegedParams(args.privileged, args.privilegedReason));
         }
         // Serialize seekPermission
-        paramWriter.writeInt8(typeof args.seekPermission === 'boolean' ? args.seekPermission ? 1 : 0 : -1);
+        paramWriter.writeInt8(typeof args.seekPermission === 'boolean'
+            ? args.seekPermission
+                ? 1
+                : 0
+            : -1);
         const result = await this.transmit('getPublicKey', originator, paramWriter.toArray());
         return {
             publicKey: Utils.toHex(result)
@@ -899,7 +919,11 @@ export default class WalletWireTransceiver {
         paramWriter.writeVarIntNum(args.plaintext.length);
         paramWriter.write(args.plaintext);
         // Serialize seekPermission
-        paramWriter.writeInt8(typeof args.seekPermission === 'boolean' ? args.seekPermission ? 1 : 0 : -1);
+        paramWriter.writeInt8(typeof args.seekPermission === 'boolean'
+            ? args.seekPermission
+                ? 1
+                : 0
+            : -1);
         return {
             ciphertext: await this.transmit('encrypt', originator, paramWriter.toArray())
         };
@@ -910,7 +934,11 @@ export default class WalletWireTransceiver {
         paramWriter.writeVarIntNum(args.ciphertext.length);
         paramWriter.write(args.ciphertext);
         // Serialize seekPermission
-        paramWriter.writeInt8(typeof args.seekPermission === 'boolean' ? args.seekPermission ? 1 : 0 : -1);
+        paramWriter.writeInt8(typeof args.seekPermission === 'boolean'
+            ? args.seekPermission
+                ? 1
+                : 0
+            : -1);
         return {
             plaintext: await this.transmit('decrypt', originator, paramWriter.toArray())
         };
@@ -921,7 +949,11 @@ export default class WalletWireTransceiver {
         paramWriter.writeVarIntNum(args.data.length);
         paramWriter.write(args.data);
         // Serialize seekPermission
-        paramWriter.writeInt8(typeof args.seekPermission === 'boolean' ? args.seekPermission ? 1 : 0 : -1);
+        paramWriter.writeInt8(typeof args.seekPermission === 'boolean'
+            ? args.seekPermission
+                ? 1
+                : 0
+            : -1);
         return {
             hmac: await this.transmit('createHmac', originator, paramWriter.toArray())
         };
@@ -933,7 +965,11 @@ export default class WalletWireTransceiver {
         paramWriter.writeVarIntNum(args.data.length);
         paramWriter.write(args.data);
         // Serialize seekPermission
-        paramWriter.writeInt8(typeof args.seekPermission === 'boolean' ? args.seekPermission ? 1 : 0 : -1);
+        paramWriter.writeInt8(typeof args.seekPermission === 'boolean'
+            ? args.seekPermission
+                ? 1
+                : 0
+            : -1);
         await this.transmit('verifyHmac', originator, paramWriter.toArray());
         return { valid: true };
     }
@@ -947,10 +983,14 @@ export default class WalletWireTransceiver {
         }
         else {
             paramWriter.writeUInt8(2);
-            paramWriter.write(args.hashToDirectlySign);
+            paramWriter.write(args.hashToDirectlySign ??= []);
         }
         // Serialize seekPermission
-        paramWriter.writeInt8(typeof args.seekPermission === 'boolean' ? args.seekPermission ? 1 : 0 : -1);
+        paramWriter.writeInt8(typeof args.seekPermission === 'boolean'
+            ? args.seekPermission
+                ? 1
+                : 0
+            : -1);
         return {
             signature: await this.transmit('createSignature', originator, paramWriter.toArray())
         };
@@ -973,10 +1013,14 @@ export default class WalletWireTransceiver {
         }
         else {
             paramWriter.writeUInt8(2);
-            paramWriter.write(args.hashToDirectlyVerify);
+            paramWriter.write(args.hashToDirectlyVerify ?? []);
         }
         // Serialize seekPermission
-        paramWriter.writeInt8(typeof args.seekPermission === 'boolean' ? args.seekPermission ? 1 : 0 : -1);
+        paramWriter.writeInt8(typeof args.seekPermission === 'boolean'
+            ? args.seekPermission
+                ? 1
+                : 0
+            : -1);
         await this.transmit('verifySignature', originator, paramWriter.toArray());
         return { valid: true };
     }
@@ -1022,7 +1066,7 @@ export default class WalletWireTransceiver {
         paramWriter.writeUInt8(args.acquisitionProtocol === 'direct' ? 1 : 2);
         if (args.acquisitionProtocol === 'direct') {
             paramWriter.write(Utils.toArray(args.serialNumber, 'base64'));
-            paramWriter.write(this.encodeOutpoint(args.revocationOutpoint));
+            paramWriter.write(this.encodeOutpoint(args.revocationOutpoint ?? ''));
             const signatureAsArray = Utils.toArray(args.signature, 'hex');
             paramWriter.writeVarIntNum(signatureAsArray.length);
             paramWriter.write(signatureAsArray);
@@ -1030,13 +1074,13 @@ export default class WalletWireTransceiver {
                 ? Utils.toArray(args.keyringRevealer, 'hex')
                 : [11];
             paramWriter.write(keyringRevealerAsArray);
-            const keyringKeys = Object.keys(args.keyringForSubject);
+            const keyringKeys = Object.keys(args.keyringForSubject ?? {});
             paramWriter.writeVarIntNum(keyringKeys.length);
             for (let i = 0; i < keyringKeys.length; i++) {
                 const keyringKeysAsArray = Utils.toArray(keyringKeys[i], 'utf8');
                 paramWriter.writeVarIntNum(keyringKeysAsArray.length);
                 paramWriter.write(keyringKeysAsArray);
-                const keyringForSubjectAsArray = Utils.toArray(args.keyringForSubject[keyringKeys[i]], 'base64');
+                const keyringForSubjectAsArray = Utils.toArray(args.keyringForSubject?.[keyringKeys[i]], 'base64');
                 paramWriter.writeVarIntNum(keyringForSubjectAsArray.length);
                 paramWriter.write(keyringForSubjectAsArray);
             }
@@ -1122,12 +1166,12 @@ export default class WalletWireTransceiver {
         paramWriter.write(serialNumberAsArray);
         const certifierAsArray = Utils.toArray(args.certificate.certifier, 'hex');
         paramWriter.write(certifierAsArray);
-        const revocationOutpointAsArray = this.encodeOutpoint(args.certificate.revocationOutpoint);
+        const revocationOutpointAsArray = this.encodeOutpoint(args.certificate.revocationOutpoint ?? '');
         paramWriter.write(revocationOutpointAsArray);
         const signatureAsArray = Utils.toArray(args.certificate.signature, 'hex');
         paramWriter.writeVarIntNum(signatureAsArray.length);
         paramWriter.write(signatureAsArray);
-        const fieldEntries = Object.entries(args.certificate.fields);
+        const fieldEntries = Object.entries(args.certificate.fields ?? {});
         paramWriter.writeVarIntNum(fieldEntries.length);
         for (const [key, value] of fieldEntries) {
             const keyAsArray = Utils.toArray(key, 'utf8');
@@ -1230,7 +1274,11 @@ export default class WalletWireTransceiver {
             paramWriter.writeVarIntNum(-1);
         }
         // Serialize seekPermission
-        paramWriter.writeInt8(typeof args.seekPermission === 'boolean' ? args.seekPermission ? 1 : 0 : -1);
+        paramWriter.writeInt8(typeof args.seekPermission === 'boolean'
+            ? args.seekPermission
+                ? 1
+                : 0
+            : -1);
         const result = await this.transmit('discoverByIdentityKey', originator, paramWriter.toArray());
         return this.parseDiscoveryResult(result);
     }
@@ -1257,14 +1305,18 @@ export default class WalletWireTransceiver {
             paramWriter.writeVarIntNum(-1);
         }
         // Serialize seekPermission
-        paramWriter.writeInt8(typeof args.seekPermission === 'boolean' ? args.seekPermission ? 1 : 0 : -1);
+        paramWriter.writeInt8(typeof args.seekPermission === 'boolean'
+            ? args.seekPermission
+                ? 1
+                : 0
+            : -1);
         const result = await this.transmit('discoverByAttributes', originator, paramWriter.toArray());
         return this.parseDiscoveryResult(result);
     }
     async isAuthenticated(args, originator) {
         const result = await this.transmit('isAuthenticated', originator);
-        // @ts-ignore
-        return { authenticated: !!result[0] };
+        // @ts-expect-error
+        return { authenticated: result[0] === 1 };
     }
     async waitForAuthentication(args, originator) {
         await this.transmit('waitForAuthentication', originator);