@bsv/wallet-toolbox 1.1.3 → 1.1.5

package/src/index.all.ts

@@ -1,7 +1,15 @@
 export * as sdk from './sdk/index'
 export * from './utility/index.all'
 export * from './Wallet'
-export * from './SetupClient'
+export {
+  SetupClient,
+  KeyPairAddress,
+  SetupEnv,
+  SetupWalletArgs,
+  SetupWallet,
+  SetupWalletClient,
+  SetupWalletClientArgs
+} from './SetupClient'
 export * from './Setup'
 export * from './signer/WalletSigner'
 export * from './storage/index.all'

package/src/sdk/types.ts

@@ -1,3 +1,5 @@
+import { Transaction, UnlockingScript } from '@bsv/sdk'
+
 /**
  * Identifies a unique transaction output by its `txid` and index `vout`
  */
@@ -113,3 +115,8 @@ export interface EntityTimeStamp {
   created_at: Date
   updated_at: Date
 }
+
+export interface ScriptTemplateUnlock {
+  sign: (tx: Transaction, inputIndex: number) => Promise<UnlockingScript>
+  estimateLength: (tx: Transaction, inputIndex: number) => Promise<number>
+}

package/src/storage/WalletStorageManager.ts

@@ -21,7 +21,7 @@ import {
 } from '../index.client'
 
 /**
- * The `SignerStorage` class delivers authentication checking storage access to the wallet.
+ * The `WalletStorageManager` class delivers authentication checking storage access to the wallet.
  *
  * If manages multiple `StorageBase` derived storage services: one actice, the rest as backups.
  *

package/src/storage/methods/listOutputs.ts

@@ -45,8 +45,10 @@ export async function listOutputs(
       partial: { userId, name: vargs.basket },
       trx
     })
-    if (baskets.length !== 1)
-      throw new sdk.WERR_INVALID_PARAMETER('basket', 'valid basket name.')
+    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

package/src/utility/ScriptTemplateSABPPP.ts

@@ -18,6 +18,10 @@ export interface ScriptTemplateParamsSABPPP {
 
 export const brc29ProtocolID: WalletProtocol = [2, '3241645161d8']
 
+/**
+ * Simple Authenticated BSV P2PKH Payment Protocol
+ * https://brc.dev/29
+ */
 export class ScriptTemplateSABPPP implements ScriptTemplate {
   p2pkh: P2PKH
 

package/test/examples/README.man.test.ts

@@ -1,20 +1,20 @@
 import { InternalizeActionArgs, PrivateKey, Utils } from '@bsv/sdk'
 import { Setup } from '../../src'
 
-describe.skip('examples README tests', () => {
+describe('examples README tests', () => {
   jest.setTimeout(99999999)
 
-  it('0', async () => {
-    const rootKeyHex = PrivateKey.fromRandom().toString()
-    console.log(
-      `MAKE A SECURE COPY OF YOUR WALLET PRIVATE ROOT KEY: ${rootKeyHex}`
-    )
+  it('0 makeEnv', async () => {
+    const envString = Setup.makeEnv()
+  })
+
+  it('1 internalize wallet payment', async () => {
+    const env = Setup.getEnv('test')
 
     const { wallet } = await Setup.createSQLiteWallet({
+      env,
       filePath: './myTestWallet.sqlite',
-      databaseName: 'myTestWallet',
-      chain: 'test',
-      rootKeyHex
+      databaseName: 'myTestWallet'
     })
 
     // Obtain a Wallet Payment for your new wallet from a testnet funding faucet.

package/test/wallet/list/listOutputs.test.ts

@@ -143,7 +143,7 @@ describe('listOutputs test', () => {
     }
   })
 
-  test('1_default', async () => {
+  test('2a default', async () => {
     for (const { wallet } of ctxs) {
       {
         let log = `\n${testName()}\n`
@@ -166,7 +166,7 @@ describe('listOutputs test', () => {
     }
   })
 
-  test('2_default', async () => {
+  test('2b default with originators', async () => {
     for (const { wallet } of ctxs) {
       {
         let log = `\n${testName()}\n`
@@ -260,18 +260,12 @@ describe('listOutputs test', () => {
 
   test('6_non-existent basket', async () => {
     for (const { wallet } of ctxs) {
-      {
-        let log = `\n${testName()}\n`
-        const args: ListOutputsArgs = {
-          basket: 'non-existent-basket',
-          tags: ['babbage_action_originator projectbabbage.com'],
-          includeTags: true
-        }
-        await expectToThrowWERR(
-          sdk.WERR_INVALID_PARAMETER,
-          async () => await wallet.listOutputs(args)
-        )
+      // non-existent basket should return zero results.
+      const args: ListOutputsArgs = {
+        basket: 'admin foo'
       }
+      const r = await wallet.listOutputs(args)
+      expect(r.totalOutputs === 0)
     }
   })
 

package/ts2md.json

@@ -1,13 +1,5 @@
 {
   "options": [
-    {
-      "inputFilename": "src/index.ts",
-      "outputFilename": "docs/setup.md",
-      "firstHeadingLevel": 1,
-      "filenameSubString": "Setup"
-    }
-  ],
-  "options2": [
     {
       "inputFilename": "src/index.ts",
       "outputFilename": "docs/setup.md",

package/tsconfig.all.json

@@ -20,7 +20,7 @@
   "include": [
     "src/**/*",
     "test/**/*"
-  ], // Include test files
+  ],
   "exclude": [
     "node_modules",
     "out",

package/LICENSE.txt

@@ -1,28 +0,0 @@
-Open BSV License version 4
-
-Copyright (c) 2023 BSV Blockchain Association ("Bitcoin Association")
- 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
- 
-1 - The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-2 - The Software, and any software that is derived from the Software or parts thereof,
-can only be used on the Bitcoin SV blockchains. The Bitcoin SV blockchains are defined,
-for purposes of this license, as the Bitcoin blockchain containing block height #556767
-with the hash "000000000000000001d956714215d96ffc00e0afda4cd0a96c96f8d802b1662b" and
-that contains the longest persistent chain of blocks accepted by this Software and which are valid under the rules set forth in the Bitcoin white paper (S. Nakamoto, Bitcoin: A Peer-to-Peer Electronic Cash System, posted online October 2008) and the latest version of this Software available in this repository or another repository designated by Bitcoin Association,
-as well as the test blockchains that contain the longest persistent chains of blocks accepted by this Software and which are valid under the rules set forth in the Bitcoin whitepaper (S. Nakamoto, Bitcoin: A Peer-to-Peer Electronic Cash System, posted online October 2008) and the latest version of this Software available in this repository, or another repository designated by Bitcoin Association
- 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.

package/knexfile.js

@@ -1,9 +0,0 @@
-module.exports = {
-  development: {
-    client: 'sqlite3',
-    connection: {
-      filename: 'test/data/tmp/updatetest.sqlite'
-    },
-    useNullAsDefault: true
-  }
-}