@bsv/wallet-toolbox 1.1.5 → 1.1.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (62) hide show
  1. package/docs/README.md +1 -1
  2. package/docs/client.md +698 -442
  3. package/docs/monitor.md +54 -37
  4. package/docs/services.md +53 -34
  5. package/docs/setup.md +295 -38
  6. package/docs/storage.md +115 -103
  7. package/docs/wallet.md +697 -442
  8. package/out/src/Setup.d.ts +3 -3
  9. package/out/src/Setup.js +5 -5
  10. package/out/src/SetupClient.d.ts +105 -12
  11. package/out/src/SetupClient.d.ts.map +1 -1
  12. package/out/src/SetupClient.js +3 -4
  13. package/out/src/SetupClient.js.map +1 -1
  14. package/out/src/Wallet.d.ts +4 -0
  15. package/out/src/Wallet.d.ts.map +1 -1
  16. package/out/src/Wallet.js +7 -0
  17. package/out/src/Wallet.js.map +1 -1
  18. package/out/src/sdk/WalletError.d.ts +0 -1
  19. package/out/src/sdk/WalletError.d.ts.map +1 -1
  20. package/out/src/sdk/WalletError.js +0 -1
  21. package/out/src/sdk/WalletError.js.map +1 -1
  22. package/out/src/sdk/validationHelpers.d.ts +1 -0
  23. package/out/src/sdk/validationHelpers.d.ts.map +1 -1
  24. package/out/src/sdk/validationHelpers.js +2 -1
  25. package/out/src/sdk/validationHelpers.js.map +1 -1
  26. package/out/src/storage/StorageProvider.d.ts +1 -4
  27. package/out/src/storage/StorageProvider.d.ts.map +1 -1
  28. package/out/src/storage/StorageProvider.js +1 -4
  29. package/out/src/storage/StorageProvider.js.map +1 -1
  30. package/out/src/storage/methods/createAction.d.ts.map +1 -1
  31. package/out/src/storage/methods/createAction.js +42 -11
  32. package/out/src/storage/methods/createAction.js.map +1 -1
  33. package/out/src/storage/methods/generateChange.js +1 -1
  34. package/out/src/storage/methods/generateChange.js.map +1 -1
  35. package/out/src/storage/schema/tables/ProvenTxReq.d.ts +4 -4
  36. package/out/test/examples/README.man.test.js +1 -1
  37. package/out/test/utils/TestUtilsWalletStorage.d.ts +2 -1
  38. package/out/test/utils/TestUtilsWalletStorage.d.ts.map +1 -1
  39. package/out/test/utils/TestUtilsWalletStorage.js +112 -27
  40. package/out/test/utils/TestUtilsWalletStorage.js.map +1 -1
  41. package/out/test/wallet/action/createAction.test.js +31 -5
  42. package/out/test/wallet/action/createAction.test.js.map +1 -1
  43. package/out/test/wallet/action/createAction2.test.d.ts +37 -0
  44. package/out/test/wallet/action/createAction2.test.d.ts.map +1 -0
  45. package/out/test/wallet/action/createAction2.test.js +1145 -0
  46. package/out/test/wallet/action/createAction2.test.js.map +1 -0
  47. package/out/tsconfig.all.tsbuildinfo +1 -1
  48. package/package.json +2 -2
  49. package/src/Setup.ts +5 -5
  50. package/src/SetupClient.ts +107 -15
  51. package/src/Wallet.ts +9 -0
  52. package/src/sdk/WalletError.ts +0 -1
  53. package/src/sdk/validationHelpers.ts +3 -1
  54. package/src/storage/StorageProvider.ts +1 -4
  55. package/src/storage/methods/createAction.ts +48 -12
  56. package/src/storage/methods/generateChange.ts +1 -1
  57. package/src/storage/schema/tables/ProvenTxReq.ts +4 -4
  58. package/test/examples/README.man.test.ts +1 -1
  59. package/test/utils/TestUtilsWalletStorage.ts +131 -35
  60. package/test/wallet/action/createAction.test.ts +36 -5
  61. package/test/wallet/action/createAction2.test.ts +1400 -0
  62. package/ts2md.json +6 -6
@@ -0,0 +1,37 @@
1
+ import { AtomicBEEF, CreateActionResult, ListActionsResult, Transaction } from '@bsv/sdk';
2
+ /**
3
+ * Generates a formatted log string from an AtomicBEEF object.
4
+ * @param {AtomicBEEF} atomicBeef - The AtomicBEEF object containing transaction data.
5
+ * @param {ListActionsResult} [actionsResult] - The result of listing actions, used for additional transaction metadata.
6
+ * @param {boolean} [showKey=true] - Whether to display key transaction details.
7
+ * @returns {Promise<{ log: string; logColor: string }>} - An object containing the formatted log string and a colorized version.
8
+ */
9
+ export declare function toLogString(atomicBeef: AtomicBEEF, actionsResult?: ListActionsResult, showKey?: boolean): {
10
+ log: string;
11
+ logColor: string;
12
+ };
13
+ export declare function createActionResultToTxLogString(createActionResult: CreateActionResult, actionsResult?: ListActionsResult, showKey?: boolean): {
14
+ log: string;
15
+ logColor: string;
16
+ };
17
+ /**
18
+ * Generates a formatted log string from a Transaction object.
19
+ * Ensures proper indentation and prevents recursion errors.
20
+ * @param {Transaction} tx - The Transaction object containing transaction data.
21
+ * @param {number} indent - The current indentation level.
22
+ * @param {boolean} [showKey=true] - Whether to display key transaction details.
23
+ * @param {ListActionsResult} [actionsResult] - The result of listing actions.
24
+ * @returns {{ log: string; logColor: string }} - A formatted log string and colorized version.
25
+ */
26
+ export declare function txToLogString(tx: Transaction, indent?: number, showKey?: boolean, actionsResult?: ListActionsResult): {
27
+ log: string;
28
+ logColor: string;
29
+ };
30
+ /**
31
+ * Checks if an object is empty.
32
+ * @param {unknown} obj - The object to check.
33
+ * @returns {boolean} - Returns true if the object is empty, otherwise false.
34
+ */
35
+ export declare const isEmptyObject: (obj: unknown) => boolean;
36
+ export declare function numberArrayToHexString(numbers: number[]): string;
37
+ //# sourceMappingURL=createAction2.test.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"createAction2.test.d.ts","sourceRoot":"","sources":["../../../../test/wallet/action/createAction2.test.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,UAAU,EAGV,kBAAkB,EAClB,iBAAiB,EAEjB,WAAW,EAKZ,MAAM,UAAU,CAAA;AAo5BjB;;;;;;GAMG;AACH,wBAAgB,WAAW,CACzB,UAAU,EAAE,UAAU,EACtB,aAAa,CAAC,EAAE,iBAAiB,EACjC,OAAO,GAAE,OAAc,GACtB;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CA+EnC;AAED,wBAAgB,+BAA+B,CAC7C,kBAAkB,EAAE,kBAAkB,EACtC,aAAa,CAAC,EAAE,iBAAiB,EACjC,OAAO,GAAE,OAAe,GACvB;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAanC;AA2GD;;;;;;;;GAQG;AACH,wBAAgB,aAAa,CAC3B,EAAE,EAAE,WAAW,EACf,MAAM,GAAE,MAAU,EAClB,OAAO,GAAE,OAAe,EACxB,aAAa,CAAC,EAAE,iBAAiB,GAChC;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAsEnC;AAED;;;;GAIG;AACH,eAAO,MAAM,aAAa,QAAS,OAAO,KAAG,OAE5C,CAAA;AAcD,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,MAAM,CAEhE"}