@bsv/sdk 1.8.9 → 1.8.10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bsv/sdk",
-  "version": "1.8.9",
+  "version": "1.8.10",
   "type": "module",
   "description": "BSV Blockchain Software Development Kit",
   "main": "dist/cjs/mod.js",

package/src/transaction/Beef.ts

@@ -869,3 +869,5 @@ export class Beef {
     }
   }
 }
+
+export default Beef

package/src/wallet/WERR_INSUFFICIENT_FUNDS.ts

@@ -0,0 +1,25 @@
+/**
+ * Insufficient funds in the available inputs to cover the cost of the required outputs
+ * and the transaction fee (${moreSatoshisNeeded} more satoshis are needed,
+ * for a total of ${totalSatoshisNeeded}), plus whatever would be required in order
+ * to pay the fee to unlock and spend the outputs used to provide the additional satoshis.
+ */
+export class WERR_INSUFFICIENT_FUNDS extends Error {
+  code: number
+  isError: boolean = true
+
+  /**
+   * @param totalSatoshisNeeded Total satoshis required to fund transactions after net of required inputs and outputs.
+   * @param moreSatoshisNeeded Shortfall on total satoshis required to fund transactions after net of required inputs and outputs.
+   */
+  constructor (
+    public totalSatoshisNeeded: number,
+    public moreSatoshisNeeded: number
+  ) {
+    super(`Insufficient funds in the available inputs to cover the cost of the required outputs and the transaction fee (${moreSatoshisNeeded} more satoshis are needed, for a total of ${totalSatoshisNeeded}), plus whatever would be required in order to pay the fee to unlock and spend the outputs used to provide the additional satoshis.`)
+    this.code = 7
+    this.name = this.constructor.name
+  }
+}
+
+export default WERR_INSUFFICIENT_FUNDS

package/src/wallet/WERR_INVALID_PARAMETER.ts

@@ -0,0 +1,20 @@
+/**
+ * The ${parameter} parameter is invalid.
+ *
+ * This is an example of an error object with a custom property `parameter` and templated `message`.
+ */
+export class WERR_INVALID_PARAMETER extends Error {
+  code: number
+  isError: boolean = true
+
+  constructor (
+    public parameter: string,
+    mustBe?: string
+  ) {
+    super(`The ${parameter} parameter must be ${mustBe ?? 'valid.'}`)
+    this.code = 6
+    this.name = this.constructor.name
+  }
+}
+
+export default WERR_INVALID_PARAMETER

package/src/wallet/WalletClient.ts

@@ -41,6 +41,23 @@ import WalletWireTransceiver from './substrates/WalletWireTransceiver.js'
 import HTTPWalletWire from './substrates/HTTPWalletWire.js'
 import HTTPWalletJSON from './substrates/HTTPWalletJSON.js'
 import ReactNativeWebView from './substrates/ReactNativeWebView.js'
+import {
+  validateAbortActionArgs,
+  validateAcquireDirectCertificateArgs,
+  validateAcquireIssuanceCertificateArgs,
+  validateCreateActionArgs,
+  validateDiscoverByAttributesArgs,
+  validateDiscoverByIdentityKeyArgs,
+  validateInternalizeActionArgs,
+  validateListActionsArgs,
+  validateListCertificatesArgs,
+  validateListOutputsArgs,
+  validateProveCertificateArgs,
+  validateRelinquishCertificateArgs,
+  validateRelinquishOutputArgs,
+  validateSignActionArgs
+} from './validationHelpers.js'
+import { WERR_INVALID_PARAMETER } from './WERR_INVALID_PARAMETER.js'
 
 const MAX_XDM_RESPONSE_WAIT = 200
 
@@ -133,6 +150,7 @@ export default class WalletClient implements WalletInterface {
   }
 
   async createAction (args: CreateActionArgs): Promise<CreateActionResult> {
+    validateCreateActionArgs(args)
     await this.connectToSubstrate()
     return await (this.substrate as WalletInterface).createAction(
       args,
@@ -141,6 +159,7 @@ export default class WalletClient implements WalletInterface {
   }
 
   async signAction (args: SignActionArgs): Promise<SignActionResult> {
+    validateSignActionArgs(args)
     await this.connectToSubstrate()
     return await (this.substrate as WalletInterface).signAction(
       args,
@@ -151,6 +170,7 @@ export default class WalletClient implements WalletInterface {
   async abortAction (args: {
     reference: Base64String
   }): Promise<{ aborted: true }> {
+    validateAbortActionArgs(args)
     await this.connectToSubstrate()
     return await (this.substrate as WalletInterface).abortAction(
       args,
@@ -159,6 +179,7 @@ export default class WalletClient implements WalletInterface {
   }
 
   async listActions (args: ListActionsArgs): Promise<ListActionsResult> {
+    validateListActionsArgs(args)
     await this.connectToSubstrate()
     return await (this.substrate as WalletInterface).listActions(
       args,
@@ -169,6 +190,7 @@ export default class WalletClient implements WalletInterface {
   async internalizeAction (
     args: InternalizeActionArgs
   ): Promise<{ accepted: true }> {
+    validateInternalizeActionArgs(args)
     await this.connectToSubstrate()
     return await (this.substrate as WalletInterface).internalizeAction(
       args,
@@ -177,6 +199,7 @@ export default class WalletClient implements WalletInterface {
   }
 
   async listOutputs (args: ListOutputsArgs): Promise<ListOutputsResult> {
+    validateListOutputsArgs(args)
     await this.connectToSubstrate()
     return await (this.substrate as WalletInterface).listOutputs(
       args,
@@ -188,6 +211,7 @@ export default class WalletClient implements WalletInterface {
     basket: BasketStringUnder300Bytes
     output: OutpointString
   }): Promise<{ relinquished: true }> {
+    validateRelinquishOutputArgs(args)
     await this.connectToSubstrate()
     return await (this.substrate as WalletInterface).relinquishOutput(
       args,
@@ -352,6 +376,7 @@ export default class WalletClient implements WalletInterface {
   async acquireCertificate (
     args: AcquireCertificateArgs
   ): Promise<AcquireCertificateResult> {
+    if (args.acquisitionProtocol === 'direct') { validateAcquireDirectCertificateArgs(args) } else if (args.acquisitionProtocol === 'issuance') { validateAcquireIssuanceCertificateArgs(args) } else { throw new WERR_INVALID_PARAMETER('acquisitionProtocol', `valid. ${String(args.acquisitionProtocol)} is unrecognized.`) }
     await this.connectToSubstrate()
     return await (this.substrate as WalletInterface).acquireCertificate(
       args,
@@ -367,6 +392,7 @@ export default class WalletClient implements WalletInterface {
     privileged?: BooleanDefaultFalse
     privilegedReason?: DescriptionString5to50Bytes
   }): Promise<ListCertificatesResult> {
+    validateListCertificatesArgs(args)
     await this.connectToSubstrate()
     return await (this.substrate as WalletInterface).listCertificates(
       args,
@@ -377,6 +403,7 @@ export default class WalletClient implements WalletInterface {
   async proveCertificate (
     args: ProveCertificateArgs
   ): Promise<ProveCertificateResult> {
+    validateProveCertificateArgs(args)
     await this.connectToSubstrate()
     return await (this.substrate as WalletInterface).proveCertificate(
       args,
@@ -389,6 +416,7 @@ export default class WalletClient implements WalletInterface {
     serialNumber: Base64String
     certifier: PubKeyHex
   }): Promise<{ relinquished: true }> {
+    validateRelinquishCertificateArgs(args)
     await this.connectToSubstrate()
     return await (this.substrate as WalletInterface).relinquishCertificate(
       args,
@@ -401,6 +429,7 @@ export default class WalletClient implements WalletInterface {
     limit?: PositiveIntegerDefault10Max10000
     offset?: PositiveIntegerOrZero
   }): Promise<DiscoverCertificatesResult> {
+    validateDiscoverByIdentityKeyArgs(args)
     await this.connectToSubstrate()
     return await (this.substrate as WalletInterface).discoverByIdentityKey(
       args,
@@ -413,6 +442,7 @@ export default class WalletClient implements WalletInterface {
     limit?: PositiveIntegerDefault10Max10000
     offset?: PositiveIntegerOrZero
   }): Promise<DiscoverCertificatesResult> {
+    validateDiscoverByAttributesArgs(args)
     await this.connectToSubstrate()
     return await (this.substrate as WalletInterface).discoverByAttributes(
       args,

package/src/wallet/WalletError.ts

@@ -13,6 +13,56 @@ export class WalletError extends Error {
       Error.captureStackTrace(this, this.constructor)
     }
   }
+
+  /**
+   * Safely serializes a WalletError (including special cases), Error or unknown error to JSON.
+   *
+   * Safely means avoiding deep, large, circular issues.
+   *
+   * Example deserialization can be found in HTTPWalletJSON.ts of bsv ts-sdk.
+   *
+   * @param error
+   * @returns stringified JSON representation of the error such that it can be deserialized to a WalletError.
+   */
+  static unknownToJson (error: any): string {
+    let e: any | undefined
+    if (typeof error.constructor.name === 'string' && String(error.constructor.name).startsWith('WERR_')) {
+      e = {
+        name: error.constructor.name,
+        message: error.message,
+        isError: true
+      }
+      if (e.name === 'WERR_REVIEW_ACTIONS') {
+        e.reviewActionResults = error.reviewActionResults
+        e.sendWithResults = error.sendWithResults
+        e.txid = error.txid
+        e.tx = error.tx
+        e.noSendChange = error.noSendChange
+        e.code = 5
+      } else if (e.name === 'WERR_INVALID_PARAMETER') {
+        e.parameter = error.parameter
+        e.code = 6
+      } else if (e.name === 'WERR_INSUFFICIENT_FUNDS') {
+        e.totalSatoshisNeeded = error.totalSatoshisNeeded
+        e.moreSatoshisNeeded = error.moreSatoshisNeeded
+        e.code = 7
+      }
+    } else if (error instanceof Error) {
+      e = {
+        name: error.constructor.name,
+        message: error.message,
+        isError: true
+      }
+    } else {
+      e = {
+        name: 'WERR_UNKNOWN',
+        message: String(error),
+        isError: true
+      }
+    }
+    const json = JSON.stringify(e)
+    return json
+  }
 }
 
 // NOTE: Enum values must not exceed the UInt8 range (0–255)
@@ -22,6 +72,8 @@ export enum walletErrors {
   invalidHmac = 3,
   invalidSignature = 4,
   reviewActions = 5,
+  invalidParameter = 6,
+  insufficientFunds = 7,
 }
 
 export type WalletErrorCode = keyof typeof walletErrors

package/src/wallet/__tests/WalletClient.test.ts

@@ -0,0 +1,31 @@
+import { CreateActionArgs } from '../Wallet.interfaces'
+import WalletClient from '../WalletClient'
+describe('WalletClient', () => {
+  it('0 createAction', async () => {
+    const wallet = new WalletClient('auto', '0.WalletClient.test')
+
+    async function testArgs(args: CreateActionArgs, parameter: string) {
+      try {
+        const r = await wallet.createAction(args)
+        expect(true).toBe(false)
+      } catch (e: any) {
+        expect(e.name).toBe('WERR_INVALID_PARAMETER')
+        expect(e.parameter).toBe(parameter)
+      }
+    }
+
+    const args: CreateActionArgs = {
+      description: 't' // too short to be valid
+    }
+    testArgs(args, 'description')
+    args.description = '12345'
+    args.outputs = [{
+      lockingScript: '',
+      satoshis: 0,
+      outputDescription: ''
+    }]
+    testArgs(args, 'lockingScript')
+    args.outputs[0].lockingScript = '1234'
+    testArgs(args, 'outputDescription')
+  })
+})

package/src/wallet/index.ts

@@ -6,5 +6,8 @@ export { default as WalletClient } from './WalletClient.js'
 // Is this an error? should it be 'walletErrors', the enum not the class?
 export { default as WalletErrors } from './WalletError.js'
 export { default as WERR_REVIEW_ACTIONS } from './WERR_REVIEW_ACTIONS.js'
+export { default as WERR_INVALID_PARAMETER } from './WERR_INVALID_PARAMETER.js'
+export { default as WERR_INSUFFICIENT_FUNDS } from './WERR_INSUFFICIENT_FUNDS.js'
 export * from './WalletError.js'
+export * as Validation from './validationHelpers.js'
 export * from './substrates/index.js'

package/src/wallet/substrates/HTTPWalletJSON.ts

@@ -36,7 +36,9 @@ import {
   VersionString7To30Bytes,
 } from '../Wallet.interfaces.js'
 import { WERR_REVIEW_ACTIONS } from '../WERR_REVIEW_ACTIONS.js'
+import { WERR_INVALID_PARAMETER } from '../WERR_INVALID_PARAMETER.js'
 import { toOriginHeader } from './utils/toOriginHeader.js'
+import WERR_INSUFFICIENT_FUNDS from '../WERR_INSUFFICIENT_FUNDS.js'
 
 export default class HTTPWalletJSON implements WalletInterface {
   baseUrl: string
@@ -84,17 +86,25 @@ export default class HTTPWalletJSON implements WalletInterface {
 
       // Check the HTTP status on the original response
       if (!res.ok) {
-        if (res.status === 400 && data.isError && data.code === 5) {
-          const err = new WERR_REVIEW_ACTIONS(data.reviewActionResults, data.sendWithResults, data.txid, data.tx, data.noSendChange)
-          throw err
-        } else {
-          const err = {
-            call,
-            args,
-            message: data.message ?? `HTTP Client error ${res.status}`
+        if (res.status === 400 && data.isError) {
+          let err: any
+          switch (data.code) {
+            case 5:
+              err = new WERR_REVIEW_ACTIONS(data.reviewActionResults, data.sendWithResults, data.txid, data.tx, data.noSendChange); break;
+            case 6:
+              err = new WERR_INVALID_PARAMETER(data.parameter); err.message = data.message; break;
+            case 7:
+              err = new WERR_INSUFFICIENT_FUNDS(data.totalSatoshisNeeded, data.moreSatoshisNeeded); break;
+            default: break;
           }
-          throw new Error(JSON.stringify(err))
+          if (err) throw err
         }
+        const err = {
+          call,
+          args,
+          message: data.message ?? `HTTP Client error ${res.status}`
+        }
+        throw new Error(JSON.stringify(err))
       }
       return data
     }