@bsv/wallet-toolbox 1.1.12 → 1.1.14

package/docs/setup.md

@@ -60,6 +60,7 @@ export interface SetupEnv {
     chain: sdk.Chain;
     identityKey: string;
     identityKey2: string;
+    filePath: string | undefined;
     taalApiKey: string;
     devKeys: Record<string, string>;
     mySQLConnection: string;
@@ -85,6 +86,14 @@ A map of public keys (identity keys, hex strings) to private keys (hex strings).
 devKeys: Record<string, string>
 ```
 
+###### Property filePath
+
+Filepath to sqlite file to be used for identityKey wallet.
+
+```ts
+filePath: string | undefined
+```
+
 ###### Property identityKey
 
 The user's primary identity key (public key).
@@ -559,21 +568,21 @@ export abstract class SetupClient {
         const mainPrivKey2 = PrivateKey.fromRandom();
         const mainIdentityKey2 = mainPrivKey2.toPublicKey().toString();
         const log = `
-    # Add the following to .env file:
-    MAIN_TAAL_API_KEY='mainnet_9596de07e92300c6287e4393594ae39c'
-    TEST_TAAL_API_KEY='testnet_0e6cf72133b43ea2d7861da2a38684e3'
-    MY_TEST_IDENTITY = '${testIdentityKey1}'
-    MY_TEST_IDENTITY2 = '${testIdentityKey2}'
-    MY_MAIN_IDENTITY = '${mainIdentityKey1}'
-    MY_MAIN_IDENTITY2 = '${mainIdentityKey2}'
-    DEV_KEYS = '{
-        "${testIdentityKey1}": "${testPrivKey1.toString()}",
-        "${testIdentityKey2}": "${testPrivKey2.toString()}"
-        "${mainIdentityKey1}": "${mainPrivKey1.toString()}",
-        "${mainIdentityKey2}": "${mainPrivKey2.toString()}"
-    }'
-    MYSQL_CONNECTION='{"port":3306,"host":"127.0.0.1","user":"root","password":"<your_password>","database":"<your_database>", "timezone": "Z"}'
-    `;
+# .env file template for working with wallet-toolbox Setup functions.
+MY_TEST_IDENTITY = '${testIdentityKey1}'
+MY_TEST_IDENTITY2 = '${testIdentityKey2}'
+MY_MAIN_IDENTITY = '${mainIdentityKey1}'
+MY_MAIN_IDENTITY2 = '${mainIdentityKey2}'
+MAIN_TAAL_API_KEY='mainnet_9596de07e92300c6287e4393594ae39c'
+TEST_TAAL_API_KEY='testnet_0e6cf72133b43ea2d7861da2a38684e3'
+MYSQL_CONNECTION='{"port":3306,"host":"127.0.0.1","user":"root","password":"<your_password>","database":"<your_database>", "timezone": "Z"}'
+DEV_KEYS = '{
+    "${testIdentityKey1}": "${testPrivKey1.toString()}",
+    "${testIdentityKey2}": "${testPrivKey2.toString()}"
+    "${mainIdentityKey1}": "${mainPrivKey1.toString()}",
+    "${mainIdentityKey2}": "${mainPrivKey2.toString()}"
+}'
+`;
         console.log(log);
         return log;
     }
@@ -584,6 +593,9 @@ export abstract class SetupClient {
         const identityKey2 = chain === "main"
             ? process.env.MY_MAIN_IDENTITY2
             : process.env.MY_TEST_IDENTITY2;
+        const filePath = chain === "main"
+            ? process.env.MY_MAIN_FILEPATH
+            : process.env.MY_TEST_FILEPATH;
         const DEV_KEYS = process.env.DEV_KEYS || "{}";
         const mySQLConnection = process.env.MYSQL_CONNECTION || "{}";
         const taalApiKey = verifyTruthy(chain === "main"
@@ -595,6 +607,7 @@ export abstract class SetupClient {
             chain,
             identityKey,
             identityKey2,
+            filePath,
             taalApiKey,
             devKeys: JSON.parse(DEV_KEYS) as Record<string, string>,
             mySQLConnection
@@ -642,9 +655,8 @@ export abstract class SetupClient {
     }
     static async createWalletClient(args: SetupWalletClientArgs): Promise<SetupWalletClient> {
         const wo = await SetupClient.createWallet(args);
-        if (wo.chain === "main")
-            throw new sdk.WERR_INVALID_PARAMETER("chain", `'test' for now, 'main' is not yet supported.`);
-        const endpointUrl = args.endpointUrl || "https://staging-dojo.babbage.systems";
+        const endpointUrl = args.endpointUrl ||
+            `https://${args.env.chain !== "main" ? "staging-" : ""}storage.babbage.systems`;
         const client = new StorageClient(wo.wallet, endpointUrl);
         await wo.storage.addWalletStorageProvider(client);
         await wo.storage.makeAvailable();
@@ -725,7 +737,7 @@ export abstract class SetupClient {
 }
 ```
 
-See also: [Chain](./client.md#type-chain), [KeyPairAddress](./setup.md#interface-keypairaddress), [Monitor](./monitor.md#class-monitor), [PrivilegedKeyManager](./client.md#class-privilegedkeymanager), [ScriptTemplateUnlock](./client.md#interface-scripttemplateunlock), [Services](./services.md#class-services), [SetupEnv](./setup.md#interface-setupenv), [SetupWallet](./setup.md#interface-setupwallet), [SetupWalletArgs](./setup.md#interface-setupwalletargs), [SetupWalletClient](./setup.md#interface-setupwalletclient), [SetupWalletClientArgs](./setup.md#interface-setupwalletclientargs), [StorageClient](./storage.md#class-storageclient), [WERR_INVALID_OPERATION](./client.md#class-werr_invalid_operation), [WERR_INVALID_PARAMETER](./client.md#class-werr_invalid_parameter), [Wallet](./client.md#class-wallet), [WalletStorageManager](./storage.md#class-walletstoragemanager), [createAction](./storage.md#function-createaction), [verifyTruthy](./client.md#function-verifytruthy)
+See also: [Chain](./client.md#type-chain), [KeyPairAddress](./setup.md#interface-keypairaddress), [Monitor](./monitor.md#class-monitor), [PrivilegedKeyManager](./client.md#class-privilegedkeymanager), [ScriptTemplateUnlock](./client.md#interface-scripttemplateunlock), [Services](./services.md#class-services), [Setup](./setup.md#class-setup), [SetupEnv](./setup.md#interface-setupenv), [SetupWallet](./setup.md#interface-setupwallet), [SetupWalletArgs](./setup.md#interface-setupwalletargs), [SetupWalletClient](./setup.md#interface-setupwalletclient), [SetupWalletClientArgs](./setup.md#interface-setupwalletclientargs), [StorageClient](./storage.md#class-storageclient), [WERR_INVALID_OPERATION](./client.md#class-werr_invalid_operation), [Wallet](./client.md#class-wallet), [WalletStorageManager](./storage.md#class-walletstoragemanager), [createAction](./storage.md#function-createaction), [verifyTruthy](./client.md#function-verifytruthy)
 
 ###### Method createWallet
 
@@ -794,6 +806,9 @@ static getEnv(chain: sdk.Chain): SetupEnv {
     const identityKey2 = chain === "main"
         ? process.env.MY_MAIN_IDENTITY2
         : process.env.MY_TEST_IDENTITY2;
+    const filePath = chain === "main"
+        ? process.env.MY_MAIN_FILEPATH
+        : process.env.MY_TEST_FILEPATH;
     const DEV_KEYS = process.env.DEV_KEYS || "{}";
     const mySQLConnection = process.env.MYSQL_CONNECTION || "{}";
     const taalApiKey = verifyTruthy(chain === "main"
@@ -805,6 +820,7 @@ static getEnv(chain: sdk.Chain): SetupEnv {
         chain,
         identityKey,
         identityKey2,
+        filePath,
         taalApiKey,
         devKeys: JSON.parse(DEV_KEYS) as Record<string, string>,
         mySQLConnection
@@ -842,25 +858,26 @@ static makeEnv(): string {
     const mainPrivKey2 = PrivateKey.fromRandom();
     const mainIdentityKey2 = mainPrivKey2.toPublicKey().toString();
     const log = `
-    # Add the following to .env file:
-    MAIN_TAAL_API_KEY='mainnet_9596de07e92300c6287e4393594ae39c'
-    TEST_TAAL_API_KEY='testnet_0e6cf72133b43ea2d7861da2a38684e3'
-    MY_TEST_IDENTITY = '${testIdentityKey1}'
-    MY_TEST_IDENTITY2 = '${testIdentityKey2}'
-    MY_MAIN_IDENTITY = '${mainIdentityKey1}'
-    MY_MAIN_IDENTITY2 = '${mainIdentityKey2}'
-    DEV_KEYS = '{
-        "${testIdentityKey1}": "${testPrivKey1.toString()}",
-        "${testIdentityKey2}": "${testPrivKey2.toString()}"
-        "${mainIdentityKey1}": "${mainPrivKey1.toString()}",
-        "${mainIdentityKey2}": "${mainPrivKey2.toString()}"
-    }'
-    MYSQL_CONNECTION='{"port":3306,"host":"127.0.0.1","user":"root","password":"<your_password>","database":"<your_database>", "timezone": "Z"}'
-    `;
+# .env file template for working with wallet-toolbox Setup functions.
+MY_TEST_IDENTITY = '${testIdentityKey1}'
+MY_TEST_IDENTITY2 = '${testIdentityKey2}'
+MY_MAIN_IDENTITY = '${mainIdentityKey1}'
+MY_MAIN_IDENTITY2 = '${mainIdentityKey2}'
+MAIN_TAAL_API_KEY='mainnet_9596de07e92300c6287e4393594ae39c'
+TEST_TAAL_API_KEY='testnet_0e6cf72133b43ea2d7861da2a38684e3'
+MYSQL_CONNECTION='{"port":3306,"host":"127.0.0.1","user":"root","password":"<your_password>","database":"<your_database>", "timezone": "Z"}'
+DEV_KEYS = '{
+    "${testIdentityKey1}": "${testPrivKey1.toString()}",
+    "${testIdentityKey2}": "${testPrivKey2.toString()}"
+    "${mainIdentityKey1}": "${mainPrivKey1.toString()}",
+    "${mainIdentityKey2}": "${mainPrivKey2.toString()}"
+}'
+`;
     console.log(log);
     return log;
 }
 ```
+See also: [Setup](./setup.md#class-setup)
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
 

package/docs/storage.md

@@ -34,9 +34,9 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
 | [GetReqsAndBeefDetail](#interface-getreqsandbeefdetail) | [TableCertificate](#interface-tablecertificate) | [TableTxLabel](#interface-tabletxlabel) |
 | [GetReqsAndBeefResult](#interface-getreqsandbeefresult) | [TableCertificateField](#interface-tablecertificatefield) | [TableTxLabelMap](#interface-tabletxlabelmap) |
 | [PostBeefResultForTxidApi](#interface-postbeefresultfortxidapi) | [TableCertificateX](#interface-tablecertificatex) | [TableUser](#interface-tableuser) |
-| [PostReqsToNetworkDetails](#interface-postreqstonetworkdetails) | [TableCommission](#interface-tablecommission) | [WalletStorageServerOptions](#interface-walletstorageserveroptions) |
-| [PostReqsToNetworkResult](#interface-postreqstonetworkresult) | [TableMonitorEvent](#interface-tablemonitorevent) | [XValidCreateActionOutput](#interface-xvalidcreateactionoutput) |
-| [ProvenTxFromTxidResult](#interface-proventxfromtxidresult) | [TableOutput](#interface-tableoutput) |  |
+| [PostReqsToNetworkDetails](#interface-postreqstonetworkdetails) | [TableCommission](#interface-tablecommission) | [ValidateGenerateChangeSdkParamsResult](#interface-validategeneratechangesdkparamsresult) |
+| [PostReqsToNetworkResult](#interface-postreqstonetworkresult) | [TableMonitorEvent](#interface-tablemonitorevent) | [WalletStorageServerOptions](#interface-walletstorageserveroptions) |
+| [ProvenTxFromTxidResult](#interface-proventxfromtxidresult) | [TableOutput](#interface-tableoutput) | [XValidCreateActionOutput](#interface-xvalidcreateactionoutput) |
 | [ProvenTxReqHistory](#interface-proventxreqhistory) | [TableOutputBasket](#interface-tableoutputbasket) |  |
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
@@ -227,6 +227,10 @@ export interface GenerateChangeSdkResult {
     size: number;
     fee: number;
     satsPerKb: number;
+    maxPossibleSatoshisAdjustment?: {
+        fixedOutputIndex: number;
+        satoshis: number;
+    };
 }
 ```
 
@@ -1109,6 +1113,17 @@ identityKey: string
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
 
+---
+##### Interface: ValidateGenerateChangeSdkParamsResult
+
+```ts
+export interface ValidateGenerateChangeSdkParamsResult {
+    hasMaxPossibleOutput?: number;
+}
+```
+
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
+
 ---
 ##### Interface: WalletStorageServerOptions
 
@@ -3956,10 +3971,10 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
 ##### Function: validateGenerateChangeSdkParams
 
 ```ts
-export function validateGenerateChangeSdkParams(params: GenerateChangeSdkParams) 
+export function validateGenerateChangeSdkParams(params: GenerateChangeSdkParams): ValidateGenerateChangeSdkParamsResult 
 ```
 
-See also: [GenerateChangeSdkParams](./storage.md#interface-generatechangesdkparams)
+See also: [GenerateChangeSdkParams](./storage.md#interface-generatechangesdkparams), [ValidateGenerateChangeSdkParamsResult](./storage.md#interface-validategeneratechangesdkparamsresult)
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
 
@@ -4051,6 +4066,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
 
 | |
 | --- |
+| [maxPossibleSatoshis](#variable-maxpossiblesatoshis) |
 | [outputColumnsWithoutLockingScript](#variable-outputcolumnswithoutlockingscript) |
 | [transactionColumnsWithoutRawTx](#variable-transactioncolumnswithoutrawtx) |
 
@@ -4058,6 +4074,15 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
 
 ---
 
+##### Variable: maxPossibleSatoshis
+
+```ts
+maxPossibleSatoshis = 2099999999999999
+```
+
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
+
+---
 ##### Variable: outputColumnsWithoutLockingScript
 
 ```ts