@bsv/wallet-toolbox 1.1.51 → 1.1.53

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bsv/wallet-toolbox",
-  "version": "1.1.51",
+  "version": "1.1.53",
   "description": "BRC100 conforming wallet, wallet storage and wallet signer components",
   "main": "./out/src/index.js",
   "types": "./out/src/index.d.ts",

package/src/storage/methods/listOutputs.ts

@@ -7,6 +7,89 @@ import {
 import { TableOutput, TableOutputBasket, TableOutputTag } from '../index.client'
 import { asString, sdk, verifyId, verifyOne } from '../../index.client'
 import { StorageKnex } from '../StorageKnex'
+import { ValidListOutputsArgs } from '../../sdk'
+
+interface SpecOp {
+  name: string
+  useBasket?: string
+  ignoreLimit?: boolean
+  resultFromOutputs?: (
+    s: StorageKnex,
+    vargs: ValidListOutputsArgs,
+    outputs: TableOutput[]
+  ) => Promise<ListOutputsResult>
+  filterOutputs?: (
+    s: StorageKnex,
+    vargs: ValidListOutputsArgs,
+    outputs: TableOutput[]
+  ) => Promise<TableOutput[]>
+}
+
+const basketToSpecOp: Record<string, SpecOp> = {
+  f61dc9289ceea604247ebde125b93a4099931f69c0e95ecd43ce0a480b9bb6c9: {
+    name: 'reserved...'
+  },
+  '69a57cc2b34058d5218927ecfd3e9e4254d8395b6fda9d57c689c753c6d6cad5': {
+    name: 'reserved...'
+  },
+  '893b7646de0e1c9f741bd6e9169b76a8847ae34adef7bef1e6a285371206d2e8': {
+    name: 'totalOutputsIsWalletBalance',
+    useBasket: 'default',
+    ignoreLimit: true,
+    resultFromOutputs: async (
+      s: StorageKnex,
+      vargs: ValidListOutputsArgs,
+      outputs: TableOutput[]
+    ): Promise<ListOutputsResult> => {
+      let totalOutputs = 0
+      for (const o of outputs) totalOutputs += o.satoshis
+      return { totalOutputs, outputs: [] }
+    }
+  },
+  '5a76fd430a311f8bc0553859061710a4475c19fed46e2ff95969aa918e612e57': {
+    name: 'invalidChangeOutputs',
+    useBasket: 'default',
+    ignoreLimit: true,
+    filterOutputs: async (
+      s: StorageKnex,
+      vargs: ValidListOutputsArgs,
+      outputs: TableOutput[]
+    ): Promise<TableOutput[]> => {
+      const filteredOutputs: TableOutput[] = []
+      let ok = false
+
+      for (const o of outputs) {
+        if (o.lockingScript && o.lockingScript.length > 0) {
+          const r = await s
+            .getServices()
+            .getUtxoStatus(asString(o.lockingScript), 'script')
+          if (r.status === 'success' && r.isUtxo && r.details?.length > 0) {
+            if (
+              r.details.some(
+                d =>
+                  d.txid === o.txid &&
+                  d.satoshis === o.satoshis &&
+                  d.index === o.vout
+              )
+            ) {
+              ok = true
+            }
+          }
+        }
+
+        if (!ok) {
+          filteredOutputs.push(o)
+        }
+      }
+      if (vargs.tags[0] === 'release') {
+        for (const o of filteredOutputs) {
+          await s.updateOutput(o.outputId, { spendable: false })
+        }
+      }
+      return filteredOutputs
+    }
+  }
+}
 
 export async function listOutputs(
   dsk: StorageKnex,
@@ -38,20 +121,26 @@ export async function listOutputs(
         }
     */
 
+  let specOp: SpecOp | undefined = undefined
   let basketId: number | undefined = undefined
   const basketsById: Record<number, TableOutputBasket> = {}
   if (vargs.basket) {
-    const baskets = await dsk.findOutputBaskets({
-      partial: { userId, name: vargs.basket },
-      trx
-    })
-    if (baskets.length !== 1) {
-      // If basket does not exist, result is no outputs.
-      return r
+    let b = vargs.basket
+    specOp = basketToSpecOp[b]
+    b = specOp ? (specOp.useBasket ? specOp.useBasket : '') : b
+    if (b) {
+      const baskets = await dsk.findOutputBaskets({
+        partial: { userId, name: b },
+        trx
+      })
+      if (baskets.length !== 1) {
+        // If basket does not exist, result is no outputs.
+        return r
+      }
+      const basket = baskets[0]
+      basketId = basket.basketId!
+      basketsById[basketId!] = basket
     }
-    const basket = baskets[0]
-    basketId = basket.basketId!
-    basketsById[basketId!] = basket
   }
 
   let tagIds: number[] = []
@@ -132,9 +221,20 @@ export async function listOutputs(
     : makeWithTagsQueries()
 
   // Sort order when limit and offset are possible must be ascending for determinism.
-  q.limit(limit).offset(offset).orderBy('outputId', 'asc')
+  if (!specOp || !specOp.ignoreLimit) q.limit(limit).offset(offset)
 
-  const outputs: TableOutput[] = await q
+  q.orderBy('outputId', 'asc')
+
+  let outputs: TableOutput[] = await q
+
+  if (specOp) {
+    if (specOp.filterOutputs)
+      outputs = await specOp.filterOutputs(dsk, vargs, outputs)
+    if (specOp.resultFromOutputs) {
+      const r = await specOp.resultFromOutputs(dsk, vargs, outputs)
+      return r
+    }
+  }
 
   if (!limit || outputs.length < limit) r.totalOutputs = outputs.length
   else {

package/src/storage/schema/entities/Transaction.ts

@@ -242,7 +242,7 @@ export class EntityTransaction extends EntityBase<TableTransaction> {
       (ei.provenTxId &&
         eo.provenTxId !==
           (syncMap
-            ? syncMap.transaction.idMap[verifyId(ei.provenTxId)]
+            ? syncMap.provenTx.idMap[verifyId(ei.provenTxId)]
             : ei.provenTxId))
     )
       return false
@@ -303,7 +303,7 @@ export class EntityTransaction extends EntityBase<TableTransaction> {
       this.isOutgoing = ei.isOutgoing
       this.status = ei.status
       this.provenTxId = ei.provenTxId
-        ? syncMap.transaction.idMap[ei.provenTxId]
+        ? syncMap.provenTx.idMap[ei.provenTxId]
         : undefined
       this.satoshis = ei.satoshis
       this.txid = ei.txid

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

@@ -163,7 +163,8 @@ async function createSetup(chain: sdk.Chain): Promise<TestWalletNoSetup> {
     rootKeyHex: env.devKeys[env.testIdentityKey],
     filePath: env.testFilePath,
     setActiveClient: false,
-    addLocalBackup: false
+    addLocalBackup: false,
+    useMySQLConnectionForClient: false
   })
 
   console.log(`ACTIVE STORAGE: ${setup.storage.getActiveStoreName()}`)

package/test/Wallet/specOps/specOps.man.test.ts

@@ -0,0 +1,58 @@
+import { sdk } from '../../../src'
+import { _tu, TestWalletNoSetup } from '../../utils/TestUtilsWalletStorage'
+
+describe('specOps tests', () => {
+  jest.setTimeout(99999999)
+
+  test('00', () => {})
+  if (_tu.noTestEnv('test')) return
+  if (_tu.noTestEnv('main')) return
+
+  test('0 wallet balance specOp', async () => {
+    const setup = await createSetup('test')
+
+    const r = await setup.wallet.listOutputs({
+      basket: '893b7646de0e1c9f741bd6e9169b76a8847ae34adef7bef1e6a285371206d2e8'
+    })
+
+    expect(r.totalOutputs > 0).toBe(true)
+    expect(r.outputs.length === 0).toBe(true)
+
+    await setup.wallet.destroy()
+  })
+
+  test('1 wallet invalid change outputs', async () => {
+    const setup = await createSetup('test')
+
+    const r = await setup.wallet.listOutputs({
+      basket: '5a76fd430a311f8bc0553859061710a4475c19fed46e2ff95969aa918e612e57'
+      // tags: ['release']
+    })
+
+    expect(r.totalOutputs).toBe(0)
+    expect(r.outputs.length).toBe(0)
+
+    await setup.wallet.destroy()
+  })
+})
+
+async function createSetup(chain: sdk.Chain): Promise<TestWalletNoSetup> {
+  const env = _tu.getEnv(chain)
+  if (!env.testIdentityKey)
+    throw new sdk.WERR_INVALID_PARAMETER('env.testIdentityKey', 'valid')
+  if (!env.testFilePath)
+    throw new sdk.WERR_INVALID_PARAMETER('env.testFilePath', 'valid')
+
+  const setup = await _tu.createTestWallet({
+    chain,
+    rootKeyHex: env.devKeys[env.testIdentityKey],
+    filePath: env.testFilePath,
+    setActiveClient: false,
+    addLocalBackup: false,
+    useMySQLConnectionForClient: false
+  })
+
+  console.log(`ACTIVE STORAGE: ${setup.storage.getActiveStoreName()}`)
+
+  return setup
+}

package/test/utils/TestUtilsWalletStorage.ts

@@ -352,6 +352,7 @@ export abstract class TestUtilsWalletStorage {
     let filePath: string
     let addLocalBackup = false
     let setActiveClient = false
+    let useMySQLConnectionForClient = false
     if (typeof args === 'string') {
       chain = args
       const env = _tu.getEnv(chain)
@@ -369,6 +370,7 @@ export abstract class TestUtilsWalletStorage {
       filePath = args.filePath
       addLocalBackup = args.addLocalBackup === true
       setActiveClient = args.setActiveClient === true
+      useMySQLConnectionForClient = args.useMySQLConnectionForClient === true
     }
 
     const databaseName = path.parse(filePath).name
@@ -380,12 +382,28 @@ export abstract class TestUtilsWalletStorage {
     })
     setup.localStorageIdentityKey = setup.storage.getActiveStore()
 
-    const endpointUrl =
-      chain === 'main'
-        ? 'https://storage.babbage.systems'
-        : 'https://staging-storage.babbage.systems'
+    let client: sdk.WalletStorageProvider
+    if (useMySQLConnectionForClient) {
+      const env = _tu.getEnv(chain)
+      if (!env.cloudMySQLConnection)
+        throw new sdk.WERR_INVALID_PARAMETER(
+          'env.cloundMySQLConnection',
+          'valid'
+        )
+      const connection = JSON.parse(env.cloudMySQLConnection)
+      client = new StorageKnex({
+        ...StorageKnex.defaultOptions(),
+        knex: _tu.createMySQLFromConnection(connection),
+        chain: env.chain
+      })
+    } else {
+      const endpointUrl =
+        chain === 'main'
+          ? 'https://storage.babbage.systems'
+          : 'https://staging-storage.babbage.systems'
 
-    const client = new StorageClient(setup.wallet, endpointUrl)
+      client = new StorageClient(setup.wallet, endpointUrl)
+    }
     setup.clientStorageIdentityKey = (
       await client.makeAvailable()
     ).storageIdentityKey
@@ -2515,4 +2533,5 @@ export interface CreateTestWalletArgs {
   filePath: string
   addLocalBackup?: boolean
   setActiveClient?: boolean
+  useMySQLConnectionForClient?: boolean
 }