Add Setup and SetupClient

Author: tonesnotes

README.md

@@ -9,13 +9,13 @@ The BSV Wallet Toolbox builds on the [SDK](https://bitcoin-sv.github.io/ts-sdk)
 
 # Table of Contents
 
-  - [Objective](#objective)
-  - [Getting Started](#getting-started)
-  - [Features \& Deliverables](#features--deliverables)
-  - [Documentation](#documentation)
-  - [Contribution Guidelines](#contribution-guidelines)
-  - [Support \& Contacts](#support--contacts)
-  - [License](#license)
+- [Objective](#objective)
+- [Getting Started](#getting-started)
+- [Features \& Deliverables](#features--deliverables)
+- [Documentation](#documentation)
+- [Contribution Guidelines](#contribution-guidelines)
+- [Support \& Contacts](#support--contacts)
+- [License](#license)
 
 ## Objective
 
@@ -37,14 +37,14 @@ npm install @bsv/wallet-toolbox
 
 Here's a simple example of using the toolbox to create and fund a testnet wallet using SQLite for persistent storage:
 
-```javascript
+```ts
 import { InternalizeActionArgs, PrivateKey, Utils } from '@bsv/sdk'
-import { test } from '@bsv/wallet-toolbox'
+import { Setup } from '@bsv/wallet-toolbox'
 
 const rootKeyHex = PrivateKey.fromRandom().toString()
 console.log(`MAKE A SECURE COPY OF YOUR WALLET PRIVATE ROOT KEY: ${rootKeyHex}`)
 
-const { wallet } = await test._tu.createSQLiteTestWallet({
+const { wallet } = await Setup.createSQLiteWallet({
     filePath: './myTestWallet.sqlite',
     databaseName: 'myTestWallet',
     chain: 'test',
@@ -121,4 +121,3 @@ For questions, bug reports, or feature requests, please open an issue on GitHub
 The license for the code in this repository is the Open BSV License. Refer to [LICENSE.txt](./LICENSE.txt) for the license text.
 
 Thank you for being a part of the BSV Blockchain Libraries Project. Let's build the future of BSV Blockchain together!
-

src/Setup.ts

@@ -0,0 +1,113 @@
+import { Beef, CreateActionArgs, CreateActionOutput, CreateActionResult, KeyDeriver, P2PKH, PrivateKey, PublicKey, SignActionArgs, SignActionResult, WalletInterface } from "@bsv/sdk"
+import { Monitor, sdk, Services, SetupClient, StorageClient, verifyTruthy, Wallet, WalletStorageManager } from "./index.client"
+import { PrivilegedKeyManager } from "./sdk"
+import { Knex, knex as makeKnex } from 'knex'
+import { SetupWalletOnly, StorageKnex } from "./index.all"
+
+/**
+ * This class provides static setup functions to construct BRC-100 compatible
+ * wallets in a variety of configurations.
+ * 
+ * It serves as a starting point for experimentation and customization.
+ * 
+ */
+export abstract class Setup extends SetupClient {
+
+  static async createKnexWallet(args: {
+    knex: Knex<any, any[]>
+    databaseName: string
+    chain?: sdk.Chain
+    rootKeyHex?: string
+    privKeyHex?: string
+  }): Promise<SetupWallet> {
+    const wo = await Setup.createWalletOnly({
+      chain: args.chain,
+      rootKeyHex: args.rootKeyHex,
+      privKeyHex: args.privKeyHex
+    })
+    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()
+    await wo.storage.addWalletStorageProvider(activeStorage)
+    const { user, isNew } = await activeStorage.findOrInsertUser(wo.identityKey)
+    const userId = user.userId
+    const r: SetupWallet = {
+      ...wo,
+      activeStorage,
+      userId
+    }
+    return r
+  }
+
+  static createSQLiteKnex(filename: string): Knex {
+    const config: Knex.Config = {
+      client: 'sqlite3',
+      connection: { filename },
+      useNullAsDefault: true
+    }
+    const knex = makeKnex(config)
+    return knex
+  }
+
+  static createMySQLKnex(connection: string, database?: string): Knex {
+    const c: Knex.MySql2ConnectionConfig = JSON.parse(connection)
+    if (database) {
+        c.database = database
+    }
+    const config: Knex.Config = {
+      client: 'mysql2',
+      connection: c,
+      useNullAsDefault: true,
+      pool: { min: 0, max: 7, idleTimeoutMillis: 15000 }
+    }
+    const knex = makeKnex(config)
+    return knex
+  }
+
+  static async createMySQLWallet(args: {
+    databaseName: string
+    chain?: sdk.Chain
+    rootKeyHex?: string
+    privKeyHex?: string
+  }): Promise<SetupWallet> {
+    const env = Setup.getEnv(args.chain || 'test')
+    return await this.createKnexWallet({
+      ...args,
+      knex: Setup.createMySQLKnex(env.mySQLConnection, args.databaseName)
+    })
+  }
+
+  static async createSQLiteWallet(args: {
+    filePath: string
+    databaseName: string
+    chain?: sdk.Chain
+    rootKeyHex?: string
+    privKeyHex?: string
+  }): Promise<SetupWallet> {
+    return await this.createKnexWallet({
+      ...args,
+      knex: Setup.createSQLiteKnex(args.filePath)
+    })
+  }
+
+}
+
+export interface SetupWallet extends SetupWalletOnly {
+  activeStorage: StorageKnex
+  userId: number
+
+  rootKey: PrivateKey
+  identityKey: string
+  keyDeriver: KeyDeriver
+  chain: sdk.Chain
+  storage: WalletStorageManager
+  services: Services
+  monitor: Monitor
+  wallet: Wallet
+}