@bsv/wallet-toolbox 1.1.56 → 1.1.57

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bsv/wallet-toolbox",
-  "version": "1.1.56",
+  "version": "1.1.57",
   "description": "BRC100 conforming wallet, wallet storage and wallet signer components",
   "main": "./out/src/index.js",
   "types": "./out/src/index.d.ts",
@@ -30,9 +30,9 @@
   },
   "homepage": "https://github.com/bitcoin-sv/wallet-toolbox#readme",
   "dependencies": {
-    "@bsv/auth-express-middleware": "^1.0.6",
+    "@bsv/auth-express-middleware": "^1.0.9",
     "@bsv/payment-express-middleware": "^1.0.3",
-    "@bsv/sdk": "^1.3.28",
+    "@bsv/sdk": "^1.3.29",
     "axios": "^0.29.0",
     "express": "^4.21.2",
     "knex": "^3.1.0",

package/src/sdk/types.ts

@@ -135,7 +135,7 @@ export type ReqHistoryNote = {
 /**
  * `listOutputs` special operation basket name value.
  *
- * Returns wallets current change balance in the `totalOutputs` result property.
+ * Returns wallet's current change balance in the `totalOutputs` result property.
  * The `outputs` result property will always be an empty array.
  */
 export const specOpWalletBalance =

package/src/services/Services.ts

@@ -70,12 +70,12 @@ export class Services implements sdk.WalletServices {
     })
 
     this.postBeefServices = new ServiceCollection<sdk.PostBeefService>()
-      .add({ name: 'TaalArcBeef', service: this.arc.postBeef.bind(this.arc) })
+      //.add({ name: 'TaalArcBeef', service: this.arc.postBeef.bind(this.arc) })
+      //.add({ name: 'WhatsOnChain', service: this.whatsonchain.postBeef.bind(this.whatsonchain) })
       .add({
-        name: 'WhatsOnChain',
-        service: this.whatsonchain.postBeef.bind(this.whatsonchain)
+        name: 'Bitails',
+        service: this.bitails.postBeef.bind(this.bitails)
       })
-    //.add({ name: 'Bitails', service: this.bitails.postBeef.bind(this.bitails) })
 
     this.getUtxoStatusServices =
       new ServiceCollection<sdk.GetUtxoStatusService>().add({

package/src/services/__tests/bitrails.test.ts

@@ -0,0 +1,62 @@
+import {
+  convertProofToMerklePath,
+  sdk,
+  Services,
+  TscMerkleProofApi
+} from '../../index.client'
+import { Bitails, BitailsMerkleProof } from '../providers/Bitails'
+
+describe('bitrails tests', () => {
+  jest.setTimeout(99999999)
+
+  test('0 verify merkle proof to merkle path', async () => {
+    const mp = convertProofToMerklePath(
+      '068f2ce0d01b5f1e7c7a07c209c3c67d583aeae83e11e92801b51c36f81d6b67',
+      proof2
+    )
+    const root = mp.computeRoot(
+      '068f2ce0d01b5f1e7c7a07c209c3c67d583aeae83e11e92801b51c36f81d6b67'
+    )
+    expect(root).toBe(proof2merkleRoot)
+  })
+
+  test('1 ', async () => {
+    const chain: sdk.Chain = 'main'
+    const bitails = new Bitails(chain)
+    const services = new Services(chain)
+
+    for (const txid of [
+      '068f2ce0d01b5f1e7c7a07c209c3c67d583aeae83e11e92801b51c36f81d6b67',
+      'a65c2663d817da6474f7805cf103be6259aae16b01468711552b737c41768c30',
+      '243fb25b94b5ef2f8554cd10d105005f51ff543d8b7a498c4e46ed304c3da24a'
+    ]) {
+      const mp = await bitails.getMerklePath(txid, services)
+      const root = mp.merklePath!.computeRoot(txid)
+      expect(root).toBe(proof2merkleRoot)
+    }
+  })
+})
+
+const proof2merkleRoot =
+  '22b294aac4c3f6f4fdae30dc4f46f68f90feb94f03531c32bcf2ce33be5d4cb0'
+
+const proof2: TscMerkleProofApi = {
+  index: 9443,
+  height: 742198,
+  nodes: [
+    '463c37bf0ccde321b1dc8ee857e03b8eafe76e6b1803cc3a774cfef61c50c37b',
+    'debba259db996d6ca7c4fcfd168d3afe6bfdddab93298466d53ed0421634f405',
+    '6335d744771789ef69545b0f449bcde92ae7b9920e775a591fecc7fcfa37846e',
+    '38366b3723e8f166fbfe5d7528a57885f47aa25a8296c0679832a95c1e6d2f61',
+    '5a999d2186d10a787c3397938fd97a4b3e833aab8cff2ce24cfce7589b9b706b',
+    'db97fbd581b8769602c6079e7fe10eb34cd99b844598b31441018ac21babd7e7',
+    '583e044e2bbc6b19993e73c3363a8ce3b4580a54510524489daadc6c82205f5a',
+    'ba5d97e4fbedb84682f65b254c56f5826f1dc65bd376dc1660f23b81c4035b1d',
+    'bfa39460ee7a8293698e41134a53cfc5ba0054416ca092d79ecbf93ae2b8b71b',
+    '8f3d186687f3f8186c4cbddcf263bbb4b58e3c279e55f9def048076faff0cc83',
+    '287790c47a0044e8e51ee60df33d4d23b972b5a51d8e9be7ac8b635b9f1e7ffc',
+    '19444e7ad68681d847d4d88989efa5f13afa46d7cbb47e8ce91876555c3e414d',
+    '6d71f472dabd52216a3cb24090d580baed96497b449876c199f48ed07f5ea2b0',
+    'af4c17b677b0c7b4d85e7331b4e43fc16f9a7024c9417d7854c55a096ac098b3'
+  ]
+}

package/src/services/providers/Bitails.ts

@@ -1,5 +1,17 @@
-import { Beef, defaultHttpClient, HexString, HttpClient, Utils } from '@bsv/sdk'
-import { doubleSha256BE, sdk, wait } from '../../index.client'
+import {
+  Beef,
+  defaultHttpClient,
+  HexString,
+  HttpClient,
+  MerklePath,
+  Utils
+} from '@bsv/sdk'
+import {
+  convertProofToMerklePath,
+  doubleSha256BE,
+  sdk,
+  wait
+} from '../../index.client'
 import { ReqHistoryNote } from '../../sdk'
 
 export interface BitailsConfig {
@@ -188,6 +200,101 @@ export class Bitails {
     })
     return r
   }
+
+  /**
+   *
+   * @param txid
+   * @param services
+   * @returns
+   */
+  async getMerklePath(
+    txid: string,
+    services: sdk.WalletServices
+  ): Promise<sdk.GetMerklePathResult> {
+    const r: sdk.GetMerklePathResult = { name: 'BitailsTsc', notes: [] }
+
+    const url = `${this.URL}/tx/${txid}/proof/tsc`
+
+    const nn = () => ({
+      name: 'BitailsProofTsc',
+      when: new Date().toISOString(),
+      txid,
+      url
+    })
+
+    const headers = this.getHttpHeaders()
+    const requestOptions = {
+      method: 'GET',
+      headers
+    }
+
+    for (let retry = 0; retry < 2; retry++) {
+      try {
+        const response = await this.httpClient.request<BitailsMerkleProof>(
+          url,
+          requestOptions
+        )
+
+        const nne = () => ({
+          ...nn(),
+          txid,
+          url,
+          status: response.status,
+          statusText: response.statusText
+        })
+
+        if (response.statusText === 'Too Many Requests' && retry < 2) {
+          r.notes!.push({ ...nne(), what: 'getMerklePathRetry' })
+          await wait(2000)
+          continue
+        }
+
+        if (response.status === 404 && response.statusText === 'Not Found') {
+          r.notes!.push({ ...nne(), what: 'getMerklePathNotFound' })
+        } else if (
+          !response.ok ||
+          response.status !== 200 ||
+          response.statusText !== 'OK'
+        ) {
+          r.notes!.push({ ...nne(), what: 'getMerklePathBadStatus' })
+        } else if (!response.data) {
+          // Unmined, proof not yet available.
+          r.notes!.push({ ...nne(), what: 'getMerklePathNoData' })
+        } else {
+          const p = response.data
+          const header = await services.hashToHeader(p.target)
+          if (header) {
+            const proof = {
+              index: p.index,
+              nodes: p.nodes,
+              height: header.height
+            }
+            r.merklePath = convertProofToMerklePath(txid, proof)
+            r.header = header
+            r.notes!.push({ ...nne(), what: 'getMerklePathSuccess' })
+          } else {
+            r.notes!.push({
+              ...nne(),
+              what: 'getMerklePathNoHeader',
+              target: p.target
+            })
+          }
+        }
+      } catch (eu: unknown) {
+        const e = sdk.WalletError.fromUnknown(eu)
+        r.notes!.push({
+          ...nn(),
+          what: 'getMerklePathError',
+          code: e.code,
+          description: e.description
+        })
+        r.error = e
+      }
+      return r
+    }
+    r.notes!.push({ ...nn(), what: 'getMerklePathInternal' })
+    return r
+  }
 }
 
 interface BitailsPostRawsResult {
@@ -197,3 +304,10 @@ interface BitailsPostRawsResult {
     message: string
   }
 }
+
+export interface BitailsMerkleProof {
+  index: number
+  txOrId: string
+  target: string
+  nodes: string[]
+}

package/test/Wallet/local/localWallet.man.test.ts

@@ -3,6 +3,7 @@ import {
   CreateActionArgs,
   CreateActionOptions,
   CreateActionResult,
+  OutpointString,
   P2PKH,
   PrivateKey,
   PublicKey,
@@ -26,6 +27,10 @@ import {
 } from '../../../src'
 import { _tu, TestWalletNoSetup } from '../../utils/TestUtilsWalletStorage'
 import { monitorEventLoopDelay } from 'perf_hooks'
+import {
+  validateCreateActionArgs,
+  ValidCreateActionArgs
+} from '../../../src/sdk'
 
 describe('localWallet tests', () => {
   jest.setTimeout(99999999)
@@ -39,7 +44,7 @@ describe('localWallet tests', () => {
 
     const car = await createOneSatTestOutput(setup, {}, 1)
 
-    await trackReqByTxid(setup, car.txid!)
+    //await trackReqByTxid(setup, car.txid!)
 
     await setup.wallet.destroy()
   })
@@ -58,6 +63,16 @@ describe('localWallet tests', () => {
     await setup.wallet.destroy()
   })
 
+  test('0b create 2 nosend and sendWith', async () => {
+    const setup = await createSetup('test')
+
+    const car = await createOneSatTestOutput(setup, { noSend: true }, 2)
+
+    //await trackReqByTxid(setup, car.txid!)
+
+    await setup.wallet.destroy()
+  })
+
   test('1 recover 1 sat outputs', async () => {
     const setup = await createSetup('test')
 
@@ -178,8 +193,14 @@ async function createOneSatTestOutput(
   options: CreateActionOptions = {},
   howMany: number = 1
 ): Promise<CreateActionResult> {
+  if (howMany < 1) throw new sdk.WERR_INVALID_PARAMETER('howMany', 'at least 1')
+
   let car: CreateActionResult = {}
 
+  let noSendChange: OutpointString[] | undefined = undefined
+  let txids: string[] = []
+  let vargs: ValidCreateActionArgs
+
   for (let i = 0; i < howMany; i++) {
     const args: CreateActionArgs = {
       outputs: [
@@ -198,11 +219,15 @@ async function createOneSatTestOutput(
       ],
       description: 'create test output',
       options: {
-        ...options
+        ...options,
+        noSendChange
       }
     }
+    vargs = validateCreateActionArgs(args)
     car = await setup.wallet.createAction(args)
     expect(car.txid)
+    txids.push(car.txid!)
+    noSendChange = car.noSendChange
 
     const req = await EntityProvenTxReq.fromStorageTxid(
       setup.activeStorage,
@@ -210,12 +235,33 @@ async function createOneSatTestOutput(
     )
     expect(req !== undefined && req.history.notes !== undefined)
     if (req && req.history.notes) {
-      expect(req.status === 'unsent')
-      expect(req.history.notes.length === 1)
-      const n = req.history.notes[0]
-      expect(n.what === 'status' && n.status_now === 'unsent')
+      if (vargs.isNoSend) {
+        expect(req.status === 'nosend').toBe(true)
+        expect(req.history.notes.length).toBe(1)
+        const n = req.history.notes[0]
+        expect(n.what === 'status' && n.status_now === 'nosend').toBe(true)
+      } else {
+        expect(req.status === 'unsent').toBe(true)
+        expect(req.history.notes.length).toBe(1)
+        const n = req.history.notes[0]
+        expect(n.what === 'status' && n.status_now === 'unsent').toBe(true)
+      }
+    }
+  }
+
+  if (vargs!.isNoSend) {
+    // Create final sending transaction
+    const args: CreateActionArgs = {
+      description: 'send batch',
+      options: {
+        ...options,
+        sendWith: txids
+      }
     }
+    vargs = validateCreateActionArgs(args)
+    car = await setup.wallet.createAction(args)
   }
+
   return car
 }