@bsv/wallet-toolbox 1.1.26 → 1.1.28

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bsv/wallet-toolbox",
-  "version": "1.1.26",
+  "version": "1.1.28",
   "description": "BRC100 conforming wallet, wallet storage and wallet signer components",
   "main": "./out/src/index.js",
   "types": "./out/src/index.d.ts",
@@ -32,7 +32,7 @@
   "dependencies": {
     "@bsv/auth-express-middleware": "^1.0.1",
     "@bsv/payment-express-middleware": "^1.0.1",
-    "@bsv/sdk": "^1.3.20",
+    "@bsv/sdk": "^1.3.22",
     "axios": "^0.29.0",
     "express": "^4.21.2",
     "knex": "^3.1.0",

package/src/Setup.ts

@@ -384,15 +384,7 @@ DEV_KEYS = '{
     args: SetupWalletKnexArgs
   ): Promise<SetupWalletKnex> {
     const wo = await Setup.createWallet(args)
-    const activeStorage = new StorageKnex({
-      chain: wo.chain,
-      knex: args.knex,
-      commissionSatoshis: 0,
-      commissionPubKeyHex: undefined,
-      feeModel: { model: 'sat/kb', value: 1 }
-    })
-    await activeStorage.migrate(args.databaseName, wo.identityKey)
-    await activeStorage.makeAvailable()
+    const activeStorage = await Setup.createStorageKnex(args)
     await wo.storage.addWalletStorageProvider(activeStorage)
     const { user, isNew } = await activeStorage.findOrInsertUser(wo.identityKey)
     const userId = user.userId
@@ -404,6 +396,27 @@ DEV_KEYS = '{
     return r
   }
 
+  /**
+   * @returns {StorageKnex} - `Knex` based storage provider for a wallet. May be used for either active storage or backup storage.
+   */
+  static async createStorageKnex(
+    args: SetupWalletKnexArgs
+  ): Promise<StorageKnex> {
+    // Create a temporary wallet setup to consistently resolve optional args.
+    const wo = await Setup.createWallet(args)
+    const storage = new StorageKnex({
+      chain: wo.chain,
+      knex: args.knex,
+      commissionSatoshis: 0,
+      commissionPubKeyHex: undefined,
+      feeModel: { model: 'sat/kb', value: 1 }
+    })
+    await storage.migrate(args.databaseName, wo.identityKey)
+    await storage.makeAvailable()
+    await wo.wallet.destroy()
+    return storage
+  }
+
   /**
    * @publicbody
    */

package/src/storage/WalletStorageManager.ts

@@ -277,6 +277,7 @@ export class WalletStorageManager implements sdk.WalletStorage {
   }
 
   async destroy(): Promise<void> {
+    if (this.stores.length < 1) return
     return await this.runAsWriter(async writer => {
       for (const store of this.stores) await store.destroy()
     })

package/test/examples/backup.test.ts

@@ -0,0 +1,66 @@
+import { Setup, SetupEnv, SetupWallet } from '../../src'
+import dotenv from 'dotenv'
+dotenv.config()
+
+describe('backup example tests', () => {
+  jest.setTimeout(99999999)
+
+  test('0', () => {})
+  if (Setup.noEnv('test')) return
+  const env = Setup.getEnv('test')
+
+  test('1 backup MY_TEST_IDENTITY', async () => {
+    await backupWalletClient(env, process.env.MY_TEST_IDENTITY || '')
+  })
+
+  test('2 backup MY_TEST_IDENTITY2', async () => {
+    await backupWalletClient(env, process.env.MY_TEST_IDENTITY2 || '')
+  })
+})
+
+/**
+ * @publicbody
+ */
+export async function backup(): Promise<void> {
+  const env = Setup.getEnv('test')
+  await backupWalletClient(env, env.identityKey)
+}
+
+/**
+ * @publicbody
+ */
+export async function backupWalletClient(
+  env: SetupEnv,
+  identityKey: string
+): Promise<void> {
+  const setup = await Setup.createWalletClient({
+    env,
+    rootKeyHex: env.devKeys[identityKey]
+  })
+  await backupToSQLite(setup)
+  await setup.wallet.destroy()
+}
+
+/**
+ * @publicbody
+ */
+export async function backupToSQLite(
+  setup: SetupWallet,
+  filePath?: string,
+  databaseName?: string
+): Promise<void> {
+  const env = Setup.getEnv(setup.chain)
+  filePath ||= `backup_${setup.identityKey}.sqlite`
+  databaseName ||= `${setup.identityKey} backup`
+
+  const backup = await Setup.createStorageKnex({
+    env,
+    knex: Setup.createSQLiteKnex(filePath),
+    databaseName,
+    rootKeyHex: setup.keyDeriver.rootKey.toHex()
+  })
+
+  await setup.storage.addWalletStorageProvider(backup)
+
+  await setup.storage.updateBackups()
+}

package/out/test/Wallet/action/abortAction.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"abortAction.test.d.ts","sourceRoot":"","sources":["../../../../test/Wallet/action/abortAction.test.ts"],"names":[],"mappings":""}

package/out/test/Wallet/action/createAction.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"createAction.test.d.ts","sourceRoot":"","sources":["../../../../test/Wallet/action/createAction.test.ts"],"names":[],"mappings":""}

package/out/test/Wallet/action/createActionToGenerateBeefs.man.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"createActionToGenerateBeefs.man.test.d.ts","sourceRoot":"","sources":["../../../../test/Wallet/action/createActionToGenerateBeefs.man.test.ts"],"names":[],"mappings":""}

package/out/test/Wallet/action/internalizeAction.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"internalizeAction.test.d.ts","sourceRoot":"","sources":["../../../../test/Wallet/action/internalizeAction.test.ts"],"names":[],"mappings":""}

package/out/test/Wallet/action/relinquishOutput.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"relinquishOutput.test.d.ts","sourceRoot":"","sources":["../../../../test/Wallet/action/relinquishOutput.test.ts"],"names":[],"mappings":""}

package/out/test/Wallet/construct/Wallet.constructor.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Wallet.constructor.test.d.ts","sourceRoot":"","sources":["../../../../test/Wallet/construct/Wallet.constructor.test.ts"],"names":[],"mappings":""}

package/out/test/Wallet/list/listActions.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"listActions.test.d.ts","sourceRoot":"","sources":["../../../../test/Wallet/list/listActions.test.ts"],"names":[],"mappings":""}

package/out/test/Wallet/list/listActions2.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"listActions2.test.d.ts","sourceRoot":"","sources":["../../../../test/Wallet/list/listActions2.test.ts"],"names":[],"mappings":""}

package/out/test/Wallet/list/listCertificates.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"listCertificates.test.d.ts","sourceRoot":"","sources":["../../../../test/Wallet/list/listCertificates.test.ts"],"names":[],"mappings":""}

package/out/test/Wallet/list/listOutputs.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"listOutputs.test.d.ts","sourceRoot":"","sources":["../../../../test/Wallet/list/listOutputs.test.ts"],"names":[],"mappings":""}

package/out/test/Wallet/sync/Wallet.sync.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Wallet.sync.test.d.ts","sourceRoot":"","sources":["../../../../test/Wallet/sync/Wallet.sync.test.ts"],"names":[],"mappings":""}