@bsv/wallet-toolbox 1.1.3 → 1.1.5

package/out/src/Setup.js

@@ -5,25 +5,30 @@ const index_client_1 = require("./index.client");
 const knex_1 = require("knex");
 const index_all_1 = require("./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`.
+ *
  */
 class Setup extends index_client_1.SetupClient {
     /**
      * Adds `Knex` based storage to a `Wallet` configured by `Setup.createWalletOnly`
      *
-     * @param args
-     * @returns
+     * @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) {
-        const wo = await Setup.createWalletOnly({
-            chain: args.chain,
-            rootKeyHex: args.rootKeyHex,
-            privKeyHex: args.privKeyHex
-        });
+        const wo = await Setup.createWallet(args);
         const activeStorage = new index_all_1.StorageKnex({
             chain: wo.chain,
             knex: args.knex,
@@ -43,6 +48,9 @@ class Setup extends index_client_1.SetupClient {
         };
         return r;
     }
+    /**
+     * @publicbody
+     */
     static createSQLiteKnex(filename) {
         const config = {
             client: 'sqlite3',
@@ -52,6 +60,9 @@ class Setup extends index_client_1.SetupClient {
         const knex = (0, knex_1.knex)(config);
         return knex;
     }
+    /**
+     * @publicbody
+     */
     static createMySQLKnex(connection, database) {
         const c = JSON.parse(connection);
         if (database) {
@@ -66,13 +77,18 @@ class Setup extends index_client_1.SetupClient {
         const knex = (0, knex_1.knex)(config);
         return knex;
     }
+    /**
+     * @publicbody
+     */
     static async createMySQLWallet(args) {
-        const env = Setup.getEnv(args.chain || 'test');
         return await this.createKnexWallet({
             ...args,
-            knex: Setup.createMySQLKnex(env.mySQLConnection, args.databaseName)
+            knex: Setup.createMySQLKnex(args.env.mySQLConnection, args.databaseName)
         });
     }
+    /**
+     * @publicbody
+     */
     static async createSQLiteWallet(args) {
         return await this.createKnexWallet({
             ...args,

package/out/src/Setup.js.map

@@ -1 +1 @@
-{"version":3,"file":"Setup.js","sourceRoot":"","sources":["../../src/Setup.ts"],"names":[],"mappings":";;;AAaA,iDASuB;AAEvB,+BAA6C;AAC7C,2CAA0D;AAE1D;;;;;;GAMG;AACH,MAAsB,KAAM,SAAQ,0BAAW;IAC7C;;;;;OAKG;IACH,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,IAW7B;QACC,MAAM,EAAE,GAAG,MAAM,KAAK,CAAC,gBAAgB,CAAC;YACtC,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,UAAU,EAAE,IAAI,CAAC,UAAU;SAC5B,CAAC,CAAA;QACF,MAAM,aAAa,GAAG,IAAI,uBAAW,CAAC;YACpC,KAAK,EAAE,EAAE,CAAC,KAAK;YACf,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,kBAAkB,EAAE,CAAC;YACrB,mBAAmB,EAAE,SAAS;YAC9B,QAAQ,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,EAAE;SACxC,CAAC,CAAA;QACF,MAAM,aAAa,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,CAAC,WAAW,CAAC,CAAA;QAC9D,MAAM,aAAa,CAAC,aAAa,EAAE,CAAA;QACnC,MAAM,EAAE,CAAC,OAAO,CAAC,wBAAwB,CAAC,aAAa,CAAC,CAAA;QACxD,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,aAAa,CAAC,gBAAgB,CAAC,EAAE,CAAC,WAAW,CAAC,CAAA;QAC5E,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAA;QAC1B,MAAM,CAAC,GAAgB;YACrB,GAAG,EAAE;YACL,aAAa;YACb,MAAM;SACP,CAAA;QACD,OAAO,CAAC,CAAA;IACV,CAAC;IAED,MAAM,CAAC,gBAAgB,CAAC,QAAgB;QACtC,MAAM,MAAM,GAAgB;YAC1B,MAAM,EAAE,SAAS;YACjB,UAAU,EAAE,EAAE,QAAQ,EAAE;YACxB,gBAAgB,EAAE,IAAI;SACvB,CAAA;QACD,MAAM,IAAI,GAAG,IAAA,WAAQ,EAAC,MAAM,CAAC,CAAA;QAC7B,OAAO,IAAI,CAAA;IACb,CAAC;IAED,MAAM,CAAC,eAAe,CAAC,UAAkB,EAAE,QAAiB;QAC1D,MAAM,CAAC,GAAgC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;QAC7D,IAAI,QAAQ,EAAE,CAAC;YACb,CAAC,CAAC,QAAQ,GAAG,QAAQ,CAAA;QACvB,CAAC;QACD,MAAM,MAAM,GAAgB;YAC1B,MAAM,EAAE,QAAQ;YAChB,UAAU,EAAE,CAAC;YACb,gBAAgB,EAAE,IAAI;YACtB,IAAI,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,iBAAiB,EAAE,KAAK,EAAE;SACnD,CAAA;QACD,MAAM,IAAI,GAAG,IAAA,WAAQ,EAAC,MAAM,CAAC,CAAA;QAC7B,OAAO,IAAI,CAAA;IACb,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,IAK9B;QACC,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,IAAI,MAAM,CAAC,CAAA;QAC9C,OAAO,MAAM,IAAI,CAAC,gBAAgB,CAAC;YACjC,GAAG,IAAI;YACP,IAAI,EAAE,KAAK,CAAC,eAAe,CAAC,GAAG,CAAC,eAAe,EAAE,IAAI,CAAC,YAAY,CAAC;SACpE,CAAC,CAAA;IACJ,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,IAM/B;QACC,OAAO,MAAM,IAAI,CAAC,gBAAgB,CAAC;YACjC,GAAG,IAAI;YACP,IAAI,EAAE,KAAK,CAAC,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC;SAC5C,CAAC,CAAA;IACJ,CAAC;CACF;AA9FD,sBA8FC"}
+{"version":3,"file":"Setup.js","sourceRoot":"","sources":["../../src/Setup.ts"],"names":[],"mappings":";;;AACA,iDAOuB;AACvB,+BAA6C;AAC7C,2CAAuE;AAEvE;;;;;;;;;GASG;AACH,MAAsB,KAAM,SAAQ,0BAAW;IAC7C;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAC3B,IAAyB;QAEzB,MAAM,EAAE,GAAG,MAAM,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,CAAA;QACzC,MAAM,aAAa,GAAG,IAAI,uBAAW,CAAC;YACpC,KAAK,EAAE,EAAE,CAAC,KAAK;YACf,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,kBAAkB,EAAE,CAAC;YACrB,mBAAmB,EAAE,SAAS;YAC9B,QAAQ,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,EAAE;SACxC,CAAC,CAAA;QACF,MAAM,aAAa,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,CAAC,WAAW,CAAC,CAAA;QAC9D,MAAM,aAAa,CAAC,aAAa,EAAE,CAAA;QACnC,MAAM,EAAE,CAAC,OAAO,CAAC,wBAAwB,CAAC,aAAa,CAAC,CAAA;QACxD,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,aAAa,CAAC,gBAAgB,CAAC,EAAE,CAAC,WAAW,CAAC,CAAA;QAC5E,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAA;QAC1B,MAAM,CAAC,GAAoB;YACzB,GAAG,EAAE;YACL,aAAa;YACb,MAAM;SACP,CAAA;QACD,OAAO,CAAC,CAAA;IACV,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,gBAAgB,CAAC,QAAgB;QACtC,MAAM,MAAM,GAAgB;YAC1B,MAAM,EAAE,SAAS;YACjB,UAAU,EAAE,EAAE,QAAQ,EAAE;YACxB,gBAAgB,EAAE,IAAI;SACvB,CAAA;QACD,MAAM,IAAI,GAAG,IAAA,WAAQ,EAAC,MAAM,CAAC,CAAA;QAC7B,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,eAAe,CAAC,UAAkB,EAAE,QAAiB;QAC1D,MAAM,CAAC,GAAgC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;QAC7D,IAAI,QAAQ,EAAE,CAAC;YACb,CAAC,CAAC,QAAQ,GAAG,QAAQ,CAAA;QACvB,CAAC;QACD,MAAM,MAAM,GAAgB;YAC1B,MAAM,EAAE,QAAQ;YAChB,UAAU,EAAE,CAAC;YACb,gBAAgB,EAAE,IAAI;YACtB,IAAI,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,iBAAiB,EAAE,KAAK,EAAE;SACnD,CAAA;QACD,MAAM,IAAI,GAAG,IAAA,WAAQ,EAAC,MAAM,CAAC,CAAA;QAC7B,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAC5B,IAA0B;QAE1B,OAAO,MAAM,IAAI,CAAC,gBAAgB,CAAC;YACjC,GAAG,IAAI;YACP,IAAI,EAAE,KAAK,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,eAAe,EAAE,IAAI,CAAC,YAAY,CAAC;SACzE,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAC7B,IAA2B;QAE3B,OAAO,MAAM,IAAI,CAAC,gBAAgB,CAAC;YACjC,GAAG,IAAI;YACP,IAAI,EAAE,KAAK,CAAC,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC;SAC5C,CAAC,CAAA;IACJ,CAAC;CACF;AA3FD,sBA2FC"}

package/out/src/SetupClient.d.ts

@@ -1,60 +1,134 @@
-import { CreateActionResult, KeyDeriver, PrivateKey, PublicKey, SignActionResult, WalletInterface } from '@bsv/sdk';
+import { BEEF, CreateActionOptions, CreateActionOutput, CreateActionResult, KeyDeriver, PrivateKey, PublicKey, WalletInterface } from '@bsv/sdk';
 import { Monitor, sdk, Services, Wallet, WalletStorageManager } from './index.client';
 /**
- * This class provides static setup functions to construct BRC-100 compatible
+ * The `SetupClient` 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 declare abstract class SetupClient {
-    static makeEnv(chain: sdk.Chain): void;
-    static getEnv(chain: sdk.Chain): {
-        chain: sdk.Chain;
-        identityKey: string | undefined;
-        identityKey2: string | undefined;
-        mainTaalApiKey: string;
-        testTaalApiKey: string;
-        devKeys: Record<string, string>;
-        mySQLConnection: string;
-    };
-    static createNoSendP2PKHOutpoint(basket: string, address: string, satoshis: number, noSendChange: string[] | undefined, wallet: WalletInterface): Promise<{
-        noSendChange: string[];
-        txid: string;
-        cr: CreateActionResult;
-        sr: SignActionResult;
-    }>;
-    static createNoSendP2PKHOutpoints(count: number, basket: string, address: string, satoshis: number, noSendChange: string[] | undefined, wallet: WalletInterface): Promise<{
-        noSendChange: string[];
-        txid: string;
-        cr: CreateActionResult;
-        sr: SignActionResult;
-    }>;
+    /**
+     * Creates content for .env file with some private keys, identity keys, sample API keys, and sample MySQL connection string.
+     *
+     * Two new, random private keys are generated each time, with their associated public identity keys.
+     *
+     * Loading secrets from a .env file is intended only for experimentation and getting started.
+     * Private keys should never be included directly in your source code.
+     *
+     * @publicBody
+     */
+    static makeEnv(): string;
+    /**
+     * Reads a .env file of the format created by `makeEnv`.
+     *
+     * Returns values for designated `chain`.
+     *
+     * Access private keys through the `devKeys` object: `devKeys[identityKey]`
+     *
+     * @param chain Which chain to use: 'test' or 'main'
+     * @returns {SetupEnv} with configuration environment secrets used by `Setup` functions.
+     *
+     * @publicBody
+     */
+    static getEnv(chain: sdk.Chain): SetupEnv;
+    /**
+     * Create a `Wallet`. Storage can optionally be provided or configured later.
+     *
+     * The following components are configured: KeyDeriver, WalletStorageManager, WalletService, WalletStorage.
+     * Optionally, PrivilegedKeyManager is also configured.
+     *
+     * @publicbody
+     */
+    static createWallet(args: SetupWalletArgs): Promise<SetupWallet>;
+    /**
+     * @publicBody
+     */
+    static createWalletWithStorageClient(args: SetupWalletClientArgs): Promise<SetupWalletClient>;
+    /**
+     * @publicBody
+     */
     static getKeyPair(priv?: string | PrivateKey): KeyPairAddress;
+    /**
+     * @publicBody
+     */
     static getLockP2PKH(address: string): import("@bsv/sdk").LockingScript;
-    static getUnlockP2PKH(priv: PrivateKey, satoshis: number): {
-        sign: (tx: import("@bsv/sdk").Transaction, inputIndex: number) => Promise<import("@bsv/sdk").UnlockingScript>;
-        estimateLength: () => Promise<108>;
-    };
-    static createWalletOnly(args: {
-        chain?: sdk.Chain;
-        rootKeyHex?: string;
-        active?: sdk.WalletStorageProvider;
-        backups?: sdk.WalletStorageProvider[];
-        privKeyHex?: string;
-    }): Promise<SetupWalletOnly>;
-    static createWalletWithStorageClient(args: {
-        rootKeyHex?: string;
-        endpointUrl?: string;
-        chain?: sdk.Chain;
-    }): Promise<SetupWalletOnly>;
+    /**
+     * @publicBody
+     */
+    static getUnlockP2PKH(priv: PrivateKey, satoshis: number): sdk.ScriptTemplateUnlock;
+    /**
+     * @publicBody
+     */
+    static createP2PKHOutputs(outputs: {
+        address: string;
+        satoshis: number;
+        outputDescription?: string;
+        basket?: string;
+        tags?: string[];
+    }[]): CreateActionOutput[];
+    /**
+     * @publicBody
+     */
+    static createP2PKHOutputsAction(wallet: WalletInterface, outputs: {
+        address: string;
+        satoshis: number;
+        outputDescription?: string;
+        basket?: string;
+        tags?: string[];
+    }[], options?: CreateActionOptions): Promise<{
+        cr: CreateActionResult;
+        outpoints: string[] | undefined;
+    }>;
+    /**
+     * @publicBody
+     */
+    static fundWalletFromP2PKHOutpoints(wallet: WalletInterface, outpoints: string[], p2pkhKey: KeyPairAddress, inputBEEF?: BEEF): Promise<void>;
 }
+/**
+ *
+ */
 export type KeyPairAddress = {
     privateKey: PrivateKey;
     publicKey: PublicKey;
     address: string;
 };
-export interface SetupWalletOnly {
+/**
+ *
+ */
+export interface SetupEnv {
+    chain: sdk.Chain;
+    identityKey: string;
+    identityKey2: string;
+    taalApiKey: string;
+    devKeys: Record<string, string>;
+    mySQLConnection: string;
+}
+/**
+ * Arguments used to construct a `Wallet`
+ *
+ * @param env Configuration "secrets" typically obtained by `Setup.makeEnv` and `Setup.getEnv` functions.
+ * @param chain Optional. Which chain this wallet is on: 'main' or 'test'.
+ * Defaults to `env.chain`.
+ * @param rootKeyHex Optional. The non-privileged private key used to initialize the `KeyDeriver` and determine the `identityKey`.
+ * Defaults to `env.devKeys[env.identityKey]
+ * @param privKeyHex Optional. The privileged private key used to initialize the `PrivilegedKeyManager`.
+ * Defaults to undefined.
+ * @param active. Optional. Active wallet storage. Can be added later.
+ * @param backups. Optional. One or more storage providers managed as backup destinations. Can be added later.
+ */
+export interface SetupWalletArgs {
+    env: SetupEnv;
+    chain?: sdk.Chain;
+    rootKeyHex?: string;
+    privKeyHex?: string;
+    active?: sdk.WalletStorageProvider;
+    backups?: sdk.WalletStorageProvider[];
+}
+export interface SetupWallet {
     rootKey: PrivateKey;
     identityKey: string;
     keyDeriver: KeyDeriver;
@@ -64,4 +138,10 @@ export interface SetupWalletOnly {
     monitor: Monitor;
     wallet: Wallet;
 }
+export interface SetupWalletClientArgs extends SetupWalletArgs {
+    endpointUrl?: string;
+}
+export interface SetupWalletClient extends SetupWallet {
+    endpointUrl: string;
+}
 //# sourceMappingURL=SetupClient.d.ts.map

package/out/src/SetupClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SetupClient.d.ts","sourceRoot":"","sources":["../../src/SetupClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,kBAAkB,EAClB,UAAU,EAEV,UAAU,EACV,SAAS,EAET,gBAAgB,EAChB,eAAe,EAChB,MAAM,UAAU,CAAA;AACjB,OAAO,EACL,OAAO,EACP,GAAG,EACH,QAAQ,EAGR,MAAM,EACN,oBAAoB,EACrB,MAAM,gBAAgB,CAAA;AAGvB;;;;;;GAMG;AACH,8BAAsB,WAAW;IAC/B,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,KAAK,GAAG,IAAI;IA6BtC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,KAAK;;;;;;iBA2BO,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;;;WAK9C,yBAAyB,CACpC,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,MAAM,EAAE,GAAG,SAAS,EAClC,MAAM,EAAE,eAAe,GACtB,OAAO,CAAC;QACT,YAAY,EAAE,MAAM,EAAE,CAAA;QACtB,IAAI,EAAE,MAAM,CAAA;QACZ,EAAE,EAAE,kBAAkB,CAAA;QACtB,EAAE,EAAE,gBAAgB,CAAA;KACrB,CAAC;WAWW,0BAA0B,CACrC,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,MAAM,EAAE,GAAG,SAAS,EAClC,MAAM,EAAE,eAAe,GACtB,OAAO,CAAC;QACT,YAAY,EAAE,MAAM,EAAE,CAAA;QACtB,IAAI,EAAE,MAAM,CAAA;QACZ,EAAE,EAAE,kBAAkB,CAAA;QACtB,EAAE,EAAE,gBAAgB,CAAA;KACrB,CAAC;IAiDF,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,cAAc;IAS7D,MAAM,CAAC,YAAY,CAAC,OAAO,EAAE,MAAM;IAMnC,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM;;;;WAY3C,gBAAgB,CAAC,IAAI,EAAE;QAClC,KAAK,CAAC,EAAE,GAAG,CAAC,KAAK,CAAA;QACjB,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,MAAM,CAAC,EAAE,GAAG,CAAC,qBAAqB,CAAA;QAClC,OAAO,CAAC,EAAE,GAAG,CAAC,qBAAqB,EAAE,CAAA;QACrC,UAAU,CAAC,EAAE,MAAM,CAAA;KACpB,GAAG,OAAO,CAAC,eAAe,CAAC;WA+Cf,6BAA6B,CAAC,IAAI,EAAE;QAC/C,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,KAAK,CAAC,EAAE,GAAG,CAAC,KAAK,CAAA;KAClB,GAAG,OAAO,CAAC,eAAe,CAAC;CAiB7B;AAED,MAAM,MAAM,cAAc,GAAG;IAC3B,UAAU,EAAE,UAAU,CAAA;IACtB,SAAS,EAAE,SAAS,CAAA;IACpB,OAAO,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,UAAU,CAAA;IACnB,WAAW,EAAE,MAAM,CAAA;IACnB,UAAU,EAAE,UAAU,CAAA;IACtB,KAAK,EAAE,GAAG,CAAC,KAAK,CAAA;IAChB,OAAO,EAAE,oBAAoB,CAAA;IAC7B,QAAQ,EAAE,QAAQ,CAAA;IAClB,OAAO,EAAE,OAAO,CAAA;IAChB,MAAM,EAAE,MAAM,CAAA;CACf"}
+{"version":3,"file":"SetupClient.d.ts","sourceRoot":"","sources":["../../src/SetupClient.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,IAAI,EAGJ,mBAAmB,EACnB,kBAAkB,EAClB,kBAAkB,EAClB,UAAU,EAEV,UAAU,EACV,SAAS,EAKT,eAAe,EAChB,MAAM,UAAU,CAAA;AACjB,OAAO,EACL,OAAO,EACP,GAAG,EACH,QAAQ,EAGR,MAAM,EACN,oBAAoB,EACrB,MAAM,gBAAgB,CAAA;AAEvB;;;;;;;;;GASG;AACH,8BAAsB,WAAW;IAC/B;;;;;;;;;OASG;IACH,MAAM,CAAC,OAAO,IAAI,MAAM;IA+BxB;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,KAAK,GAAG,QAAQ;IAkCzC;;;;;;;OAOG;WACU,YAAY,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,WAAW,CAAC;IAiDtE;;OAEG;WACU,6BAA6B,CACxC,IAAI,EAAE,qBAAqB,GAC1B,OAAO,CAAC,iBAAiB,CAAC;IAmB7B;;OAEG;IACH,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,cAAc;IAS7D;;OAEG;IACH,MAAM,CAAC,YAAY,CAAC,OAAO,EAAE,MAAM;IAMnC;;OAEG;IACH,MAAM,CAAC,cAAc,CACnB,IAAI,EAAE,UAAU,EAChB,QAAQ,EAAE,MAAM,GACf,GAAG,CAAC,oBAAoB;IAY3B;;OAEG;IACH,MAAM,CAAC,kBAAkB,CACvB,OAAO,EAAE;QACP,OAAO,EAAE,MAAM,CAAA;QACf,QAAQ,EAAE,MAAM,CAAA;QAChB,iBAAiB,CAAC,EAAE,MAAM,CAAA;QAC1B,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;KAChB,EAAE,GACF,kBAAkB,EAAE;IAgBvB;;OAEG;WACU,wBAAwB,CACnC,MAAM,EAAE,eAAe,EACvB,OAAO,EAAE;QACP,OAAO,EAAE,MAAM,CAAA;QACf,QAAQ,EAAE,MAAM,CAAA;QAChB,iBAAiB,CAAC,EAAE,MAAM,CAAA;QAC1B,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;KAChB,EAAE,EACH,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC;QACT,EAAE,EAAE,kBAAkB,CAAA;QACtB,SAAS,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;KAChC,CAAC;IAwBF;;OAEG;WACU,4BAA4B,CACvC,MAAM,EAAE,eAAe,EACvB,SAAS,EAAE,MAAM,EAAE,EACnB,QAAQ,EAAE,cAAc,EACxB,SAAS,CAAC,EAAE,IAAI;CAInB;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,UAAU,EAAE,UAAU,CAAA;IACtB,SAAS,EAAE,SAAS,CAAA;IACpB,OAAO,EAAE,MAAM,CAAA;CAChB,CAAA;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,KAAK,EAAE,GAAG,CAAC,KAAK,CAAA;IAChB,WAAW,EAAE,MAAM,CAAA;IACnB,YAAY,EAAE,MAAM,CAAA;IACpB,UAAU,EAAE,MAAM,CAAA;IAClB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC/B,eAAe,EAAE,MAAM,CAAA;CACxB;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,eAAe;IAC9B,GAAG,EAAE,QAAQ,CAAA;IACb,KAAK,CAAC,EAAE,GAAG,CAAC,KAAK,CAAA;IACjB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,MAAM,CAAC,EAAE,GAAG,CAAC,qBAAqB,CAAA;IAClC,OAAO,CAAC,EAAE,GAAG,CAAC,qBAAqB,EAAE,CAAA;CACtC;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,UAAU,CAAA;IACnB,WAAW,EAAE,MAAM,CAAA;IACnB,UAAU,EAAE,UAAU,CAAA;IACtB,KAAK,EAAE,GAAG,CAAC,KAAK,CAAA;IAChB,OAAO,EAAE,oBAAoB,CAAA;IAC7B,QAAQ,EAAE,QAAQ,CAAA;IAClB,OAAO,EAAE,OAAO,CAAA;IAChB,MAAM,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,qBAAsB,SAAQ,eAAe;IAC5D,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED,MAAM,WAAW,iBAAkB,SAAQ,WAAW;IACpD,WAAW,EAAE,MAAM,CAAA;CACpB"}

package/out/src/SetupClient.js

@@ -3,16 +3,28 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.SetupClient = void 0;
 const sdk_1 = require("@bsv/sdk");
 const index_client_1 = require("./index.client");
-const sdk_2 = require("./sdk");
 /**
- * This class provides static setup functions to construct BRC-100 compatible
+ * The `SetupClient` 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`.
+ *
  */
 class SetupClient {
-    static makeEnv(chain) {
+    /**
+     * Creates content for .env file with some private keys, identity keys, sample API keys, and sample MySQL connection string.
+     *
+     * Two new, random private keys are generated each time, with their associated public identity keys.
+     *
+     * Loading secrets from a .env file is intended only for experimentation and getting started.
+     * Private keys should never be included directly in your source code.
+     *
+     * @publicBody
+     */
+    static makeEnv() {
         const testPrivKey1 = sdk_1.PrivateKey.fromRandom();
         const testIdentityKey1 = testPrivKey1.toPublicKey().toString();
         const testPrivKey2 = sdk_1.PrivateKey.fromRandom();
@@ -38,11 +50,22 @@ class SetupClient {
     MYSQL_CONNECTION='{"port":3306,"host":"127.0.0.1","user":"root","password":"<your_password>","database":"<your_database>", "timezone": "Z"}'
     `;
         console.log(log);
+        return log;
     }
+    /**
+     * Reads a .env file of the format created by `makeEnv`.
+     *
+     * Returns values for designated `chain`.
+     *
+     * Access private keys through the `devKeys` object: `devKeys[identityKey]`
+     *
+     * @param chain Which chain to use: 'test' or 'main'
+     * @returns {SetupEnv} with configuration environment secrets used by `Setup` functions.
+     *
+     * @publicBody
+     */
     static getEnv(chain) {
         // Identity keys of the lead maintainer of this repo...
-        const mainTaalApiKey = (0, index_client_1.verifyTruthy)(process.env.MAIN_TAAL_API_KEY || '', `.env value for 'mainTaalApiKey' is required.`);
-        const testTaalApiKey = (0, index_client_1.verifyTruthy)(process.env.TEST_TAAL_API_KEY || '', `.env value for 'testTaalApiKey' is required.`);
         const identityKey = chain === 'main'
             ? process.env.MY_MAIN_IDENTITY
             : process.env.MY_TEST_IDENTITY;
@@ -51,89 +74,31 @@ class SetupClient {
             : process.env.MY_TEST_IDENTITY2;
         const DEV_KEYS = process.env.DEV_KEYS || '{}';
         const mySQLConnection = process.env.MYSQL_CONNECTION || '{}';
+        const taalApiKey = (0, index_client_1.verifyTruthy)(chain === 'main'
+            ? process.env.MAIN_TAAL_API_KEY
+            : process.env.TEST_TAAL_API_KEY, `.env value for '${chain.toUpperCase()}_TAAL_API_KEY' is required.`);
+        if (!identityKey || !identityKey2)
+            throw new index_client_1.sdk.WERR_INVALID_OPERATION('.env is not a valid SetupEnv configuration.');
         return {
             chain,
             identityKey,
             identityKey2,
-            mainTaalApiKey,
-            testTaalApiKey,
+            taalApiKey,
             devKeys: JSON.parse(DEV_KEYS),
             mySQLConnection
         };
     }
-    static async createNoSendP2PKHOutpoint(basket, address, satoshis, noSendChange, wallet) {
-        return await SetupClient.createNoSendP2PKHOutpoints(1, basket, address, satoshis, noSendChange, wallet);
-    }
-    static async createNoSendP2PKHOutpoints(count, basket, address, satoshis, noSendChange, wallet) {
-        const outputs = [];
-        for (let i = 0; i < count; i++) {
-            outputs.push({
-                basket,
-                satoshis,
-                lockingScript: SetupClient.getLockP2PKH(address).toHex(),
-                outputDescription: `p2pkh ${i}`
-            });
-        }
-        const createArgs = {
-            description: `to ${address}`,
-            outputs,
-            options: {
-                noSendChange,
-                randomizeOutputs: false,
-                signAndProcess: false,
-                noSend: true
-            }
-        };
-        const cr = await wallet.createAction(createArgs);
-        noSendChange = cr.noSendChange;
-        const st = cr.signableTransaction;
-        // const tx = Transaction.fromAtomicBEEF(st.tx) // Transaction doesn't support V2 Beef yet.
-        const beef = sdk_1.Beef.fromBinary(st.tx);
-        const btx = beef.txs.slice(-1)[0];
-        const tx = beef.findAtomicTransaction(btx.txid);
-        // sign and complete
-        const signArgs = {
-            reference: st.reference,
-            spends: {},
-            options: {
-                returnTXIDOnly: true,
-                noSend: true
-            }
-        };
-        const sr = await wallet.signAction(signArgs);
-        let txid = sr.txid;
-        // Update the noSendChange txid to final signed value.
-        noSendChange = noSendChange.map(op => `${txid}.${op.split('.')[1]}`);
-        return { noSendChange, txid, cr, sr };
-    }
-    static getKeyPair(priv) {
-        if (priv === undefined)
-            priv = sdk_1.PrivateKey.fromRandom();
-        else if (typeof priv === 'string')
-            priv = new sdk_1.PrivateKey(priv, 'hex');
-        const pub = sdk_1.PublicKey.fromPrivateKey(priv);
-        const address = pub.toAddress();
-        return { privateKey: priv, publicKey: pub, address };
-    }
-    static getLockP2PKH(address) {
-        const p2pkh = new sdk_1.P2PKH();
-        const lock = p2pkh.lock(address);
-        return lock;
-    }
-    static getUnlockP2PKH(priv, satoshis) {
-        const p2pkh = new sdk_1.P2PKH();
-        const lock = SetupClient.getLockP2PKH(SetupClient.getKeyPair(priv).address);
-        // Prepare to pay with SIGHASH_ALL and without ANYONE_CAN_PAY.
-        // In otherwords:
-        // - all outputs must remain in the current order, amount and locking scripts.
-        // - all inputs must remain from the current outpoints and sequence numbers.
-        // (unlock scripts are never signed)
-        const unlock = p2pkh.unlock(priv, 'all', false, satoshis, lock);
-        return unlock;
-    }
-    static async createWalletOnly(args) {
-        args.chain || (args.chain = 'test');
-        args.rootKeyHex || (args.rootKeyHex = '1'.repeat(64));
+    /**
+     * Create a `Wallet`. Storage can optionally be provided or configured later.
+     *
+     * The following components are configured: KeyDeriver, WalletStorageManager, WalletService, WalletStorage.
+     * Optionally, PrivilegedKeyManager is also configured.
+     *
+     * @publicbody
+     */
+    static async createWallet(args) {
+        args.chain || (args.chain = args.env.chain);
+        args.rootKeyHex || (args.rootKeyHex = args.env.devKeys[args.env.identityKey]);
         const rootKey = sdk_1.PrivateKey.fromHex(args.rootKeyHex);
         const identityKey = rootKey.toPublicKey().toString();
         const keyDeriver = new sdk_1.KeyDeriver(rootKey);
@@ -141,6 +106,8 @@ class SetupClient {
         const storage = new index_client_1.WalletStorageManager(identityKey, args.active, args.backups);
         if (storage.stores.length > 0)
             await storage.makeAvailable();
+        const serviceOptions = index_client_1.Services.createDefaultOptions(chain);
+        serviceOptions.taalApiKey = args.env.taalApiKey;
         const services = new index_client_1.Services(args.chain);
         const monopts = index_client_1.Monitor.createDefaultWalletMonitorOptions(chain, storage, services);
         const monitor = new index_client_1.Monitor(monopts);
@@ -148,7 +115,7 @@ class SetupClient {
         let privilegedKeyManager = undefined;
         if (args.privKeyHex) {
             const privKey = sdk_1.PrivateKey.fromString(args.privKeyHex);
-            privilegedKeyManager = new sdk_2.PrivilegedKeyManager(async () => privKey);
+            privilegedKeyManager = new index_client_1.sdk.PrivilegedKeyManager(async () => privKey);
         }
         const wallet = new index_client_1.Wallet({
             chain,
@@ -170,18 +137,100 @@ class SetupClient {
         };
         return r;
     }
+    /**
+     * @publicBody
+     */
     static async createWalletWithStorageClient(args) {
-        if (args.chain === 'main')
+        const wo = await SetupClient.createWallet(args);
+        if (wo.chain === 'main')
             throw new index_client_1.sdk.WERR_INVALID_PARAMETER('chain', `'test' for now, 'main' is not yet supported.`);
-        const wo = await SetupClient.createWalletOnly({
-            chain: 'test',
-            rootKeyHex: args.rootKeyHex
-        });
-        args.endpointUrl || (args.endpointUrl = 'https://staging-dojo.babbage.systems');
-        const client = new index_client_1.StorageClient(wo.wallet, args.endpointUrl);
+        const endpointUrl = args.endpointUrl || 'https://staging-dojo.babbage.systems';
+        const client = new index_client_1.StorageClient(wo.wallet, endpointUrl);
         await wo.storage.addWalletStorageProvider(client);
         await wo.storage.makeAvailable();
-        return wo;
+        return {
+            ...wo,
+            endpointUrl
+        };
+    }
+    /**
+     * @publicBody
+     */
+    static getKeyPair(priv) {
+        if (priv === undefined)
+            priv = sdk_1.PrivateKey.fromRandom();
+        else if (typeof priv === 'string')
+            priv = new sdk_1.PrivateKey(priv, 'hex');
+        const pub = sdk_1.PublicKey.fromPrivateKey(priv);
+        const address = pub.toAddress();
+        return { privateKey: priv, publicKey: pub, address };
+    }
+    /**
+     * @publicBody
+     */
+    static getLockP2PKH(address) {
+        const p2pkh = new sdk_1.P2PKH();
+        const lock = p2pkh.lock(address);
+        return lock;
+    }
+    /**
+     * @publicBody
+     */
+    static getUnlockP2PKH(priv, satoshis) {
+        const p2pkh = new sdk_1.P2PKH();
+        const lock = SetupClient.getLockP2PKH(SetupClient.getKeyPair(priv).address);
+        // Prepare to pay with SIGHASH_ALL and without ANYONE_CAN_PAY.
+        // In otherwords:
+        // - all outputs must remain in the current order, amount and locking scripts.
+        // - all inputs must remain from the current outpoints and sequence numbers.
+        // (unlock scripts are never signed)
+        const unlock = p2pkh.unlock(priv, 'all', false, satoshis, lock);
+        return unlock;
+    }
+    /**
+     * @publicBody
+     */
+    static createP2PKHOutputs(outputs) {
+        const os = [];
+        const count = outputs.length;
+        for (let i = 0; i < count; i++) {
+            const o = outputs[i];
+            os.push({
+                basket: o.basket,
+                tags: o.tags,
+                satoshis: o.satoshis,
+                lockingScript: SetupClient.getLockP2PKH(o.address).toHex(),
+                outputDescription: o.outputDescription || `p2pkh ${i}`
+            });
+        }
+        return os;
+    }
+    /**
+     * @publicBody
+     */
+    static async createP2PKHOutputsAction(wallet, outputs, options) {
+        const os = SetupClient.createP2PKHOutputs(outputs);
+        const createArgs = {
+            description: `createP2PKHOutputs`,
+            outputs: os,
+            options: {
+                ...options,
+                // Don't randomize so we can simplify outpoint creation
+                randomizeOutputs: false
+            }
+        };
+        const cr = await wallet.createAction(createArgs);
+        let outpoints;
+        if (cr.txid) {
+            outpoints = os.map((o, i) => `${cr.txid}.${i}`);
+        }
+        return { cr, outpoints };
+    }
+    /**
+     * @publicBody
+     */
+    static async fundWalletFromP2PKHOutpoints(wallet, outpoints, p2pkhKey, inputBEEF) {
+        // TODO
     }
 }
 exports.SetupClient = SetupClient;

package/out/src/SetupClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"SetupClient.js","sourceRoot":"","sources":["../../src/SetupClient.ts"],"names":[],"mappings":";;;AAAA,kCAYiB;AACjB,iDAQuB;AACvB,+BAA4C;AAE5C;;;;;;GAMG;AACH,MAAsB,WAAW;IAC/B,MAAM,CAAC,OAAO,CAAC,KAAgB;QAC7B,MAAM,YAAY,GAAG,gBAAU,CAAC,UAAU,EAAE,CAAA;QAC5C,MAAM,gBAAgB,GAAG,YAAY,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE,CAAA;QAC9D,MAAM,YAAY,GAAG,gBAAU,CAAC,UAAU,EAAE,CAAA;QAC5C,MAAM,gBAAgB,GAAG,YAAY,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE,CAAA;QAC9D,MAAM,YAAY,GAAG,gBAAU,CAAC,UAAU,EAAE,CAAA;QAC5C,MAAM,gBAAgB,GAAG,YAAY,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE,CAAA;QAC9D,MAAM,YAAY,GAAG,gBAAU,CAAC,UAAU,EAAE,CAAA;QAC5C,MAAM,gBAAgB,GAAG,YAAY,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE,CAAA;QAE9D,MAAM,GAAG,GAAG;;;;0BAIU,gBAAgB;2BACf,gBAAgB;0BACjB,gBAAgB;2BACf,gBAAgB;;WAEhC,gBAAgB,OAAO,YAAY,CAAC,QAAQ,EAAE;WAC9C,gBAAgB,OAAO,YAAY,CAAC,QAAQ,EAAE;WAC9C,gBAAgB,OAAO,YAAY,CAAC,QAAQ,EAAE;WAC9C,gBAAgB,OAAO,YAAY,CAAC,QAAQ,EAAE;;;KAGpD,CAAA;QACD,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;IAClB,CAAC;IAED,MAAM,CAAC,MAAM,CAAC,KAAgB;QAC5B,uDAAuD;QACvD,MAAM,cAAc,GAAG,IAAA,2BAAY,EACjC,OAAO,CAAC,GAAG,CAAC,iBAAiB,IAAI,EAAE,EACnC,8CAA8C,CAC/C,CAAA;QACD,MAAM,cAAc,GAAG,IAAA,2BAAY,EACjC,OAAO,CAAC,GAAG,CAAC,iBAAiB,IAAI,EAAE,EACnC,8CAA8C,CAC/C,CAAA;QACD,MAAM,WAAW,GACf,KAAK,KAAK,MAAM;YACd,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB;YAC9B,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAA;QAClC,MAAM,YAAY,GAChB,KAAK,KAAK,MAAM;YACd,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB;YAC/B,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAA;QACnC,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,IAAI,IAAI,CAAA;QAC7C,MAAM,eAAe,GAAG,OAAO,CAAC,GAAG,CAAC,gBAAgB,IAAI,IAAI,CAAA;QAE5D,OAAO;YACL,KAAK;YACL,WAAW;YACX,YAAY;YACZ,cAAc;YACd,cAAc;YACd,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,QAAQ,CAA2B;YACvD,eAAe;SAChB,CAAA;IACH,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,yBAAyB,CACpC,MAAc,EACd,OAAe,EACf,QAAgB,EAChB,YAAkC,EAClC,MAAuB;QAOvB,OAAO,MAAM,WAAW,CAAC,0BAA0B,CACjD,CAAC,EACD,MAAM,EACN,OAAO,EACP,QAAQ,EACR,YAAY,EACZ,MAAM,CACP,CAAA;IACH,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,0BAA0B,CACrC,KAAa,EACb,MAAc,EACd,OAAe,EACf,QAAgB,EAChB,YAAkC,EAClC,MAAuB;QAOvB,MAAM,OAAO,GAAyB,EAAE,CAAA;QACxC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC;YAC/B,OAAO,CAAC,IAAI,CAAC;gBACX,MAAM;gBACN,QAAQ;gBACR,aAAa,EAAE,WAAW,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE;gBACxD,iBAAiB,EAAE,SAAS,CAAC,EAAE;aAChC,CAAC,CAAA;QACJ,CAAC;QAED,MAAM,UAAU,GAAqB;YACnC,WAAW,EAAE,MAAM,OAAO,EAAE;YAC5B,OAAO;YACP,OAAO,EAAE;gBACP,YAAY;gBACZ,gBAAgB,EAAE,KAAK;gBACvB,cAAc,EAAE,KAAK;gBACrB,MAAM,EAAE,IAAI;aACb;SACF,CAAA;QAED,MAAM,EAAE,GAAG,MAAM,MAAM,CAAC,YAAY,CAAC,UAAU,CAAC,CAAA;QAChD,YAAY,GAAG,EAAE,CAAC,YAAY,CAAA;QAE9B,MAAM,EAAE,GAAG,EAAE,CAAC,mBAAoB,CAAA;QAClC,2FAA2F;QAC3F,MAAM,IAAI,GAAG,UAAI,CAAC,UAAU,CAAC,EAAE,CAAC,EAAE,CAAC,CAAA;QACnC,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;QACjC,MAAM,EAAE,GAAG,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;QAE/C,oBAAoB;QACpB,MAAM,QAAQ,GAAmB;YAC/B,SAAS,EAAE,EAAE,CAAC,SAAS;YACvB,MAAM,EAAE,EAAE;YACV,OAAO,EAAE;gBACP,cAAc,EAAE,IAAI;gBACpB,MAAM,EAAE,IAAI;aACb;SACF,CAAA;QAED,MAAM,EAAE,GAAG,MAAM,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAA;QAE5C,IAAI,IAAI,GAAG,EAAE,CAAC,IAAK,CAAA;QACnB,sDAAsD;QACtD,YAAY,GAAG,YAAa,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,IAAI,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAA;QACrE,OAAO,EAAE,YAAY,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,EAAE,CAAA;IACvC,CAAC;IAED,MAAM,CAAC,UAAU,CAAC,IAA0B;QAC1C,IAAI,IAAI,KAAK,SAAS;YAAE,IAAI,GAAG,gBAAU,CAAC,UAAU,EAAE,CAAA;aACjD,IAAI,OAAO,IAAI,KAAK,QAAQ;YAAE,IAAI,GAAG,IAAI,gBAAU,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;QAErE,MAAM,GAAG,GAAG,eAAS,CAAC,cAAc,CAAC,IAAI,CAAC,CAAA;QAC1C,MAAM,OAAO,GAAG,GAAG,CAAC,SAAS,EAAE,CAAA;QAC/B,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,EAAE,OAAO,EAAE,CAAA;IACtD,CAAC;IAED,MAAM,CAAC,YAAY,CAAC,OAAe;QACjC,MAAM,KAAK,GAAG,IAAI,WAAK,EAAE,CAAA;QACzB,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QAChC,OAAO,IAAI,CAAA;IACb,CAAC;IAED,MAAM,CAAC,cAAc,CAAC,IAAgB,EAAE,QAAgB;QACtD,MAAM,KAAK,GAAG,IAAI,WAAK,EAAE,CAAA;QACzB,MAAM,IAAI,GAAG,WAAW,CAAC,YAAY,CAAC,WAAW,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAA;QAC3E,8DAA8D;QAC9D,iBAAiB;QACjB,8EAA8E;QAC9E,4EAA4E;QAC5E,oCAAoC;QACpC,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAA;QAC/D,OAAO,MAAM,CAAA;IACf,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,IAM7B;QACC,IAAI,CAAC,KAAK,KAAV,IAAI,CAAC,KAAK,GAAK,MAAM,EAAA;QACrB,IAAI,CAAC,UAAU,KAAf,IAAI,CAAC,UAAU,GAAK,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,EAAA;QAClC,MAAM,OAAO,GAAG,gBAAU,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;QACnD,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE,CAAA;QACpD,MAAM,UAAU,GAAG,IAAI,gBAAU,CAAC,OAAO,CAAC,CAAA;QAC1C,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAA;QACxB,MAAM,OAAO,GAAG,IAAI,mCAAoB,CACtC,WAAW,EACX,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,OAAO,CACb,CAAA;QACD,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC;YAAE,MAAM,OAAO,CAAC,aAAa,EAAE,CAAA;QAC5D,MAAM,QAAQ,GAAG,IAAI,uBAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QACzC,MAAM,OAAO,GAAG,sBAAO,CAAC,iCAAiC,CACvD,KAAK,EACL,OAAO,EACP,QAAQ,CACT,CAAA;QACD,MAAM,OAAO,GAAG,IAAI,sBAAO,CAAC,OAAO,CAAC,CAAA;QACpC,OAAO,CAAC,eAAe,EAAE,CAAA;QACzB,IAAI,oBAAoB,GAAqC,SAAS,CAAA;QACtE,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACpB,MAAM,OAAO,GAAG,gBAAU,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;YACtD,oBAAoB,GAAG,IAAI,0BAAoB,CAAC,KAAK,IAAI,EAAE,CAAC,OAAO,CAAC,CAAA;QACtE,CAAC;QACD,MAAM,MAAM,GAAG,IAAI,qBAAM,CAAC;YACxB,KAAK;YACL,UAAU;YACV,OAAO;YACP,QAAQ;YACR,OAAO;YACP,oBAAoB;SACrB,CAAC,CAAA;QACF,MAAM,CAAC,GAAoB;YACzB,OAAO;YACP,WAAW;YACX,UAAU;YACV,KAAK;YACL,OAAO;YACP,QAAQ;YACR,OAAO;YACP,MAAM;SACP,CAAA;QACD,OAAO,CAAC,CAAA;IACV,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,6BAA6B,CAAC,IAI1C;QACC,IAAI,IAAI,CAAC,KAAK,KAAK,MAAM;YACvB,MAAM,IAAI,kBAAG,CAAC,sBAAsB,CAClC,OAAO,EACP,8CAA8C,CAC/C,CAAA;QAEH,MAAM,EAAE,GAAG,MAAM,WAAW,CAAC,gBAAgB,CAAC;YAC5C,KAAK,EAAE,MAAM;YACb,UAAU,EAAE,IAAI,CAAC,UAAU;SAC5B,CAAC,CAAA;QACF,IAAI,CAAC,WAAW,KAAhB,IAAI,CAAC,WAAW,GAAK,sCAAsC,EAAA;QAC3D,MAAM,MAAM,GAAG,IAAI,4BAAa,CAAC,EAAE,CAAC,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,CAAA;QAC7D,MAAM,EAAE,CAAC,OAAO,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAA;QACjD,MAAM,EAAE,CAAC,OAAO,CAAC,aAAa,EAAE,CAAA;QAChC,OAAO,EAAE,CAAA;IACX,CAAC;CACF;AAtPD,kCAsPC"}
+{"version":3,"file":"SetupClient.js","sourceRoot":"","sources":["../../src/SetupClient.ts"],"names":[],"mappings":";;;AAAA,kCAgBiB;AACjB,iDAQuB;AAEvB;;;;;;;;;GASG;AACH,MAAsB,WAAW;IAC/B;;;;;;;;;OASG;IACH,MAAM,CAAC,OAAO;QACZ,MAAM,YAAY,GAAG,gBAAU,CAAC,UAAU,EAAE,CAAA;QAC5C,MAAM,gBAAgB,GAAG,YAAY,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE,CAAA;QAC9D,MAAM,YAAY,GAAG,gBAAU,CAAC,UAAU,EAAE,CAAA;QAC5C,MAAM,gBAAgB,GAAG,YAAY,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE,CAAA;QAC9D,MAAM,YAAY,GAAG,gBAAU,CAAC,UAAU,EAAE,CAAA;QAC5C,MAAM,gBAAgB,GAAG,YAAY,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE,CAAA;QAC9D,MAAM,YAAY,GAAG,gBAAU,CAAC,UAAU,EAAE,CAAA;QAC5C,MAAM,gBAAgB,GAAG,YAAY,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE,CAAA;QAE9D,MAAM,GAAG,GAAG;;;;0BAIU,gBAAgB;2BACf,gBAAgB;0BACjB,gBAAgB;2BACf,gBAAgB;;WAEhC,gBAAgB,OAAO,YAAY,CAAC,QAAQ,EAAE;WAC9C,gBAAgB,OAAO,YAAY,CAAC,QAAQ,EAAE;WAC9C,gBAAgB,OAAO,YAAY,CAAC,QAAQ,EAAE;WAC9C,gBAAgB,OAAO,YAAY,CAAC,QAAQ,EAAE;;;KAGpD,CAAA;QACD,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QAEhB,OAAO,GAAG,CAAA;IACZ,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,MAAM,CAAC,KAAgB;QAC5B,uDAAuD;QACvD,MAAM,WAAW,GACf,KAAK,KAAK,MAAM;YACd,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB;YAC9B,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAA;QAClC,MAAM,YAAY,GAChB,KAAK,KAAK,MAAM;YACd,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB;YAC/B,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAA;QACnC,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,IAAI,IAAI,CAAA;QAC7C,MAAM,eAAe,GAAG,OAAO,CAAC,GAAG,CAAC,gBAAgB,IAAI,IAAI,CAAA;QAC5D,MAAM,UAAU,GAAG,IAAA,2BAAY,EAC7B,KAAK,KAAK,MAAM;YACd,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB;YAC/B,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,EACjC,mBAAmB,KAAK,CAAC,WAAW,EAAE,6BAA6B,CACpE,CAAA;QAED,IAAI,CAAC,WAAW,IAAI,CAAC,YAAY;YAC/B,MAAM,IAAI,kBAAG,CAAC,sBAAsB,CAClC,6CAA6C,CAC9C,CAAA;QAEH,OAAO;YACL,KAAK;YACL,WAAW;YACX,YAAY;YACZ,UAAU;YACV,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,QAAQ,CAA2B;YACvD,eAAe;SAChB,CAAA;IACH,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,IAAqB;QAC7C,IAAI,CAAC,KAAK,KAAV,IAAI,CAAC,KAAK,GAAK,IAAI,CAAC,GAAG,CAAC,KAAK,EAAA;QAC7B,IAAI,CAAC,UAAU,KAAf,IAAI,CAAC,UAAU,GAAK,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,EAAA;QAC1D,MAAM,OAAO,GAAG,gBAAU,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;QACnD,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE,CAAA;QACpD,MAAM,UAAU,GAAG,IAAI,gBAAU,CAAC,OAAO,CAAC,CAAA;QAC1C,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAA;QACxB,MAAM,OAAO,GAAG,IAAI,mCAAoB,CACtC,WAAW,EACX,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,OAAO,CACb,CAAA;QACD,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC;YAAE,MAAM,OAAO,CAAC,aAAa,EAAE,CAAA;QAC5D,MAAM,cAAc,GAAG,uBAAQ,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAA;QAC3D,cAAc,CAAC,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,UAAU,CAAA;QAC/C,MAAM,QAAQ,GAAG,IAAI,uBAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QACzC,MAAM,OAAO,GAAG,sBAAO,CAAC,iCAAiC,CACvD,KAAK,EACL,OAAO,EACP,QAAQ,CACT,CAAA;QACD,MAAM,OAAO,GAAG,IAAI,sBAAO,CAAC,OAAO,CAAC,CAAA;QACpC,OAAO,CAAC,eAAe,EAAE,CAAA;QACzB,IAAI,oBAAoB,GAAyC,SAAS,CAAA;QAC1E,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACpB,MAAM,OAAO,GAAG,gBAAU,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;YACtD,oBAAoB,GAAG,IAAI,kBAAG,CAAC,oBAAoB,CAAC,KAAK,IAAI,EAAE,CAAC,OAAO,CAAC,CAAA;QAC1E,CAAC;QACD,MAAM,MAAM,GAAG,IAAI,qBAAM,CAAC;YACxB,KAAK;YACL,UAAU;YACV,OAAO;YACP,QAAQ;YACR,OAAO;YACP,oBAAoB;SACrB,CAAC,CAAA;QACF,MAAM,CAAC,GAAgB;YACrB,OAAO;YACP,WAAW;YACX,UAAU;YACV,KAAK;YACL,OAAO;YACP,QAAQ;YACR,OAAO;YACP,MAAM;SACP,CAAA;QACD,OAAO,CAAC,CAAA;IACV,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,KAAK,CAAC,6BAA6B,CACxC,IAA2B;QAE3B,MAAM,EAAE,GAAG,MAAM,WAAW,CAAC,YAAY,CAAC,IAAI,CAAC,CAAA;QAC/C,IAAI,EAAE,CAAC,KAAK,KAAK,MAAM;YACrB,MAAM,IAAI,kBAAG,CAAC,sBAAsB,CAClC,OAAO,EACP,8CAA8C,CAC/C,CAAA;QAEH,MAAM,WAAW,GACf,IAAI,CAAC,WAAW,IAAI,sCAAsC,CAAA;QAC5D,MAAM,MAAM,GAAG,IAAI,4BAAa,CAAC,EAAE,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;QACxD,MAAM,EAAE,CAAC,OAAO,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAA;QACjD,MAAM,EAAE,CAAC,OAAO,CAAC,aAAa,EAAE,CAAA;QAChC,OAAO;YACL,GAAG,EAAE;YACL,WAAW;SACZ,CAAA;IACH,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,UAAU,CAAC,IAA0B;QAC1C,IAAI,IAAI,KAAK,SAAS;YAAE,IAAI,GAAG,gBAAU,CAAC,UAAU,EAAE,CAAA;aACjD,IAAI,OAAO,IAAI,KAAK,QAAQ;YAAE,IAAI,GAAG,IAAI,gBAAU,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;QAErE,MAAM,GAAG,GAAG,eAAS,CAAC,cAAc,CAAC,IAAI,CAAC,CAAA;QAC1C,MAAM,OAAO,GAAG,GAAG,CAAC,SAAS,EAAE,CAAA;QAC/B,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,EAAE,OAAO,EAAE,CAAA;IACtD,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,YAAY,CAAC,OAAe;QACjC,MAAM,KAAK,GAAG,IAAI,WAAK,EAAE,CAAA;QACzB,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QAChC,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,cAAc,CACnB,IAAgB,EAChB,QAAgB;QAEhB,MAAM,KAAK,GAAG,IAAI,WAAK,EAAE,CAAA;QACzB,MAAM,IAAI,GAAG,WAAW,CAAC,YAAY,CAAC,WAAW,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAA;QAC3E,8DAA8D;QAC9D,iBAAiB;QACjB,8EAA8E;QAC9E,4EAA4E;QAC5E,oCAAoC;QACpC,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAA;QAC/D,OAAO,MAAM,CAAA;IACf,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,kBAAkB,CACvB,OAMG;QAEH,MAAM,EAAE,GAAyB,EAAE,CAAA;QACnC,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAA;QAC5B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC;YAC/B,MAAM,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;YACpB,EAAE,CAAC,IAAI,CAAC;gBACN,MAAM,EAAE,CAAC,CAAC,MAAM;gBAChB,IAAI,EAAE,CAAC,CAAC,IAAI;gBACZ,QAAQ,EAAE,CAAC,CAAC,QAAQ;gBACpB,aAAa,EAAE,WAAW,CAAC,YAAY,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE;gBAC1D,iBAAiB,EAAE,CAAC,CAAC,iBAAiB,IAAI,SAAS,CAAC,EAAE;aACvD,CAAC,CAAA;QACJ,CAAC;QACD,OAAO,EAAE,CAAA;IACX,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,KAAK,CAAC,wBAAwB,CACnC,MAAuB,EACvB,OAMG,EACH,OAA6B;QAK7B,MAAM,EAAE,GAAG,WAAW,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAA;QAElD,MAAM,UAAU,GAAqB;YACnC,WAAW,EAAE,oBAAoB;YACjC,OAAO,EAAE,EAAE;YACX,OAAO,EAAE;gBACP,GAAG,OAAO;gBACV,uDAAuD;gBACvD,gBAAgB,EAAE,KAAK;aACxB;SACF,CAAA;QAED,MAAM,EAAE,GAAG,MAAM,MAAM,CAAC,YAAY,CAAC,UAAU,CAAC,CAAA;QAEhD,IAAI,SAA+B,CAAA;QAEnC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC;YACZ,SAAS,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,EAAE,CAAC,IAAI,IAAI,CAAC,EAAE,CAAC,CAAA;QACjD,CAAC;QAED,OAAO,EAAE,EAAE,EAAE,SAAS,EAAE,CAAA;IAC1B,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,KAAK,CAAC,4BAA4B,CACvC,MAAuB,EACvB,SAAmB,EACnB,QAAwB,EACxB,SAAgB;QAEhB,OAAO;IACT,CAAC;CACF;AA9RD,kCA8RC"}

package/out/src/Wallet.d.ts

@@ -15,6 +15,16 @@ export declare class Wallet implements WalletInterface, ProtoWallet {
     services?: sdk.WalletServices;
     monitor?: Monitor;
     identityKey: string;
+    /**
+     * The wallet creates a `BeefParty` when it is created.
+     * All the Beefs that pass through the wallet are merged into this beef.
+     * Thus what it contains at any time is the union of all transactions and proof data processed.
+     * The class `BeefParty` derives from `Beef`, adding the ability to track the source of merged data.
+     *
+     * This allows it to generate beefs to send to a particular “party” (storage or the user)
+     * that includes “txid only proofs” for transactions they already know about.
+     * Over time, this allows an active wallet to drastically reduce the amount of data transmitted.
+     */
     beef: BeefParty;
     trustSelf?: TrustSelf;
     userParty: string;