Merge branch 'nextVersion'

Author: tonesnotes

docs/setup.md

@@ -81,7 +81,31 @@ export abstract class Setup extends SetupClient {
         chain?: sdk.Chain;
         rootKeyHex?: string;
         privKeyHex?: string;
-    }): Promise<SetupWallet> 
+    }): 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 
     static createMySQLKnex(connection: string, database?: string): Knex 
     static async createMySQLWallet(args: {
@@ -100,7 +124,7 @@ export abstract class Setup extends SetupClient {
 }
 ```
 
-See also: [Chain](#type-chain), [SetupClient](#class-setupclient), [SetupWallet](#interface-setupwallet)
+See also: [Chain](#type-chain), [SetupClient](#class-setupclient), [SetupWallet](#interface-setupwallet), [StorageKnex](#class-storageknex)
 
 <details>
 
@@ -117,9 +141,44 @@ static async createKnexWallet(args: {
     chain?: sdk.Chain;
     rootKeyHex?: string;
     privKeyHex?: string;
-}): Promise<SetupWallet> 
+}): 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;
+}
 ```
-See also: [Chain](#type-chain), [SetupWallet](#interface-setupwallet)
+See also: [Chain](#type-chain), [Setup](#class-setup), [SetupWallet](#interface-setupwallet), [StorageKnex](#class-storageknex)
+
+Argument Details
+
++ **args.knex**
+  + `Knex` object configured for either MySQL or SQLite database access.
+Schema will be created and migrated as needed.
+For MySQL, a schema corresponding to databaseName must exist with full access permissions.
++ **args.databaseName**
+  + Name for this storage. For MySQL, the schema name within the MySQL instance.
++ **args.chain**
+  + Which chain this wallet is on: 'main' or 'test'. Defaults to 'test'.
 
 </details>
 
@@ -135,7 +194,7 @@ It serves as a starting point for experimentation and customization.
 
 ```ts
 export abstract class SetupClient {
-    static makeEnv(chain: sdk.Chain): void {
+    static makeEnv(): void {
         const testPrivKey1 = PrivateKey.fromRandom();
         const testIdentityKey1 = testPrivKey1.toPublicKey().toString();
         const testPrivKey2 = PrivateKey.fromRandom();
@@ -195,6 +254,24 @@ export abstract class SetupClient {
 
 See also: [Chain](#type-chain), [KeyPairAddress](#type-keypairaddress), [SetupWalletOnly](#interface-setupwalletonly), [WalletStorageProvider](#interface-walletstorageprovider)
 
+<details>
+
+<summary>Class SetupClient Details</summary>
+
+#### Method makeEnv
+
+Create content for .env file with some private keys, identity keys, sample API keys, and sample MySQL connection string.
+
+Private keys should never be included directly in you source code.
+
+Loading them from a .env file is intended only for experimentation and getting started.
+
+```ts
+static makeEnv(): void 
+```
+
+</details>
+
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
 
 ---

src/Setup.ts

@@ -1,41 +1,45 @@
-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 {
+  KeyDeriver,
+  PrivateKey,
+} from '@bsv/sdk'
+import {
+  Monitor,
+  sdk,
+  Services,
+  SetupClient,
+  Wallet,
+  WalletStorageManager
+} from './index.client'
 import { Knex, knex as makeKnex } from 'knex'
-import { SetupWalletOnly, StorageKnex } from "./index.all"
+import { SetupWallet, SetupWalletArgs, StorageKnex } from './index.all'
 
 /**
- * This class provides static setup functions to construct BRC-100 compatible
+ * The 'Setup` 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.
- * 
+ *
+ * `SetupClient` references only browser compatible code including storage via `StorageClient`.
+ * `Setup` extends `SetupClient` adding database storage via `Knex` and `StorageKnex`.
+ *
  */
 export abstract class Setup extends SetupClient {
-
-    /**
-     * Adds `Knex` based storage to a `Wallet` configured by `Setup.createWalletOnly`
-     * 
-     * @param args 
-     * @returns 
-     */
-  static async createKnexWallet(args: {
-    /**
-     * `Knex` object configured for either MySQL or SQLite database access.
-     * Schema will be created and migrated as needed.
-     * For MySQL, a schema corresponding to databaseName must exist with full access permissions.
-     */
-    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
-    })
+  /**
+   * Adds `Knex` based storage to a `Wallet` configured by `Setup.createWalletOnly`
+   *
+   * @param args.knex `Knex` object configured for either MySQL or SQLite database access.
+   * Schema will be created and migrated as needed.
+   * For MySQL, a schema corresponding to databaseName must exist with full access permissions.
+   * @param args.databaseName Name for this storage. For MySQL, the schema name within the MySQL instance.
+   * @param args.chain Which chain this wallet is on: 'main' or 'test'. Defaults to 'test'.
+   * @param args.rootKeyHex
+   *
+   * @publicbody
+   */
+  static async createKnexWallet(
+    args: SetupWalletKnexArgs
+  ): Promise<SetupWalletKnex> {
+    const wo = await Setup.createWallet(args)
     const activeStorage = new StorageKnex({
       chain: wo.chain,
       knex: args.knex,
@@ -48,7 +52,7 @@ export abstract class Setup extends SetupClient {
     await wo.storage.addWalletStorageProvider(activeStorage)
     const { user, isNew } = await activeStorage.findOrInsertUser(wo.identityKey)
     const userId = user.userId
-    const r: SetupWallet = {
+    const r: SetupWalletKnex = {
       ...wo,
       activeStorage,
       userId
@@ -69,7 +73,7 @@ export abstract class Setup extends SetupClient {
   static createMySQLKnex(connection: string, database?: string): Knex {
     const c: Knex.MySql2ConnectionConfig = JSON.parse(connection)
     if (database) {
-        c.database = database
+      c.database = database
     }
     const config: Knex.Config = {
       client: 'mysql2',
@@ -81,35 +85,40 @@ export abstract class Setup extends SetupClient {
     return knex
   }
 
-  static async createMySQLWallet(args: {
-    databaseName: string
-    chain?: sdk.Chain
-    rootKeyHex?: string
-    privKeyHex?: string
-  }): Promise<SetupWallet> {
-    const env = Setup.getEnv(args.chain || 'test')
+  static async createMySQLWallet(
+    args: SetupWalletMySQLArgs
+  ): Promise<SetupWalletKnex> {
     return await this.createKnexWallet({
       ...args,
-      knex: Setup.createMySQLKnex(env.mySQLConnection, args.databaseName)
+      knex: Setup.createMySQLKnex(args.env.mySQLConnection, args.databaseName)
     })
   }
 
-  static async createSQLiteWallet(args: {
-    filePath: string
-    databaseName: string
-    chain?: sdk.Chain
-    rootKeyHex?: string
-    privKeyHex?: string
-  }): Promise<SetupWallet> {
+  static async createSQLiteWallet(
+    args: SetupWalletSQLiteArgs
+  ): Promise<SetupWalletKnex> {
     return await this.createKnexWallet({
       ...args,
       knex: Setup.createSQLiteKnex(args.filePath)
     })
   }
+}
+
+export interface SetupWalletKnexArgs extends SetupWalletArgs {
+  knex: Knex<any, any[]>
+  databaseName: string
+}
+
+export interface SetupWalletMySQLArgs extends SetupWalletArgs {
+  databaseName: string
+}
 
+export interface SetupWalletSQLiteArgs extends SetupWalletArgs {
+  filePath: string
+  databaseName: string
 }
 
-export interface SetupWallet extends SetupWalletOnly {
+export interface SetupWalletKnex extends SetupWallet {
   activeStorage: StorageKnex
   userId: number