@cmdoss/memwal-sdk 0.7.0 → 0.9.0

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 (229) hide show
  1. package/README.md +427 -41
  2. package/dist/client/ClientMemoryManager.js +2 -2
  3. package/dist/client/ClientMemoryManager.js.map +1 -1
  4. package/dist/client/PersonalDataWallet.d.ts.map +1 -1
  5. package/dist/client/SimplePDWClient.d.ts +88 -1
  6. package/dist/client/SimplePDWClient.d.ts.map +1 -1
  7. package/dist/client/SimplePDWClient.js +102 -11
  8. package/dist/client/SimplePDWClient.js.map +1 -1
  9. package/dist/client/namespaces/IndexNamespace.d.ts +1 -1
  10. package/dist/client/namespaces/IndexNamespace.d.ts.map +1 -1
  11. package/dist/client/namespaces/IndexNamespace.js +7 -4
  12. package/dist/client/namespaces/IndexNamespace.js.map +1 -1
  13. package/dist/client/namespaces/MemoryNamespace.d.ts +45 -0
  14. package/dist/client/namespaces/MemoryNamespace.d.ts.map +1 -1
  15. package/dist/client/namespaces/MemoryNamespace.js +292 -46
  16. package/dist/client/namespaces/MemoryNamespace.js.map +1 -1
  17. package/dist/client/namespaces/consolidated/AdvancedNamespace.d.ts +215 -0
  18. package/dist/client/namespaces/consolidated/AdvancedNamespace.d.ts.map +1 -0
  19. package/dist/client/namespaces/consolidated/AdvancedNamespace.js +214 -0
  20. package/dist/client/namespaces/consolidated/AdvancedNamespace.js.map +1 -0
  21. package/dist/client/namespaces/consolidated/BlockchainNamespace.d.ts +12 -2
  22. package/dist/client/namespaces/consolidated/BlockchainNamespace.d.ts.map +1 -1
  23. package/dist/client/namespaces/consolidated/BlockchainNamespace.js +40 -2
  24. package/dist/client/namespaces/consolidated/BlockchainNamespace.js.map +1 -1
  25. package/dist/client/namespaces/consolidated/StorageNamespace.d.ts +67 -2
  26. package/dist/client/namespaces/consolidated/StorageNamespace.d.ts.map +1 -1
  27. package/dist/client/namespaces/consolidated/StorageNamespace.js +549 -16
  28. package/dist/client/namespaces/consolidated/StorageNamespace.js.map +1 -1
  29. package/dist/client/namespaces/consolidated/index.d.ts +1 -0
  30. package/dist/client/namespaces/consolidated/index.d.ts.map +1 -1
  31. package/dist/client/namespaces/consolidated/index.js +1 -0
  32. package/dist/client/namespaces/consolidated/index.js.map +1 -1
  33. package/dist/config/ConfigurationHelper.js +61 -61
  34. package/dist/config/defaults.d.ts.map +1 -1
  35. package/dist/config/defaults.js +11 -6
  36. package/dist/config/defaults.js.map +1 -1
  37. package/dist/core/types/index.d.ts +4 -0
  38. package/dist/core/types/index.d.ts.map +1 -1
  39. package/dist/core/types/index.js.map +1 -1
  40. package/dist/graph/GraphService.js +20 -20
  41. package/dist/infrastructure/seal/EncryptionService.d.ts +9 -5
  42. package/dist/infrastructure/seal/EncryptionService.d.ts.map +1 -1
  43. package/dist/infrastructure/seal/EncryptionService.js +37 -15
  44. package/dist/infrastructure/seal/EncryptionService.js.map +1 -1
  45. package/dist/infrastructure/seal/SealService.d.ts +13 -5
  46. package/dist/infrastructure/seal/SealService.d.ts.map +1 -1
  47. package/dist/infrastructure/seal/SealService.js +36 -34
  48. package/dist/infrastructure/seal/SealService.js.map +1 -1
  49. package/dist/infrastructure/walrus/WalrusStorageService.d.ts +6 -0
  50. package/dist/infrastructure/walrus/WalrusStorageService.d.ts.map +1 -1
  51. package/dist/infrastructure/walrus/WalrusStorageService.js +23 -4
  52. package/dist/infrastructure/walrus/WalrusStorageService.js.map +1 -1
  53. package/dist/langchain/createPDWRAG.js +30 -30
  54. package/dist/retrieval/MemoryDecryptionPipeline.d.ts.map +1 -1
  55. package/dist/retrieval/MemoryDecryptionPipeline.js +2 -1
  56. package/dist/retrieval/MemoryDecryptionPipeline.js.map +1 -1
  57. package/dist/services/CapabilityService.d.ts.map +1 -1
  58. package/dist/services/CapabilityService.js +30 -14
  59. package/dist/services/CapabilityService.js.map +1 -1
  60. package/dist/services/CrossContextPermissionService.d.ts.map +1 -1
  61. package/dist/services/CrossContextPermissionService.js +9 -7
  62. package/dist/services/CrossContextPermissionService.js.map +1 -1
  63. package/dist/services/EmbeddingService.d.ts +9 -0
  64. package/dist/services/EmbeddingService.d.ts.map +1 -1
  65. package/dist/services/EmbeddingService.js +31 -10
  66. package/dist/services/EmbeddingService.js.map +1 -1
  67. package/dist/services/EncryptionService.d.ts.map +1 -1
  68. package/dist/services/EncryptionService.js +6 -5
  69. package/dist/services/EncryptionService.js.map +1 -1
  70. package/dist/services/GeminiAIService.js +309 -309
  71. package/dist/services/MemoryIndexService.d.ts +2 -0
  72. package/dist/services/MemoryIndexService.d.ts.map +1 -1
  73. package/dist/services/MemoryIndexService.js +11 -4
  74. package/dist/services/MemoryIndexService.js.map +1 -1
  75. package/dist/services/StorageService.d.ts +1 -0
  76. package/dist/services/StorageService.d.ts.map +1 -1
  77. package/dist/services/StorageService.js +60 -10
  78. package/dist/services/StorageService.js.map +1 -1
  79. package/dist/services/TransactionService.d.ts +20 -0
  80. package/dist/services/TransactionService.d.ts.map +1 -1
  81. package/dist/services/TransactionService.js +43 -0
  82. package/dist/services/TransactionService.js.map +1 -1
  83. package/dist/services/VectorService.js +1 -1
  84. package/dist/services/VectorService.js.map +1 -1
  85. package/dist/services/ViewService.js +2 -2
  86. package/dist/services/ViewService.js.map +1 -1
  87. package/dist/vector/BrowserHnswIndexService.js +1 -1
  88. package/dist/vector/BrowserHnswIndexService.js.map +1 -1
  89. package/dist/vector/HnswWasmService.js +1 -1
  90. package/dist/vector/HnswWasmService.js.map +1 -1
  91. package/dist/vector/NodeHnswService.js +1 -1
  92. package/dist/vector/NodeHnswService.js.map +1 -1
  93. package/package.json +1 -1
  94. package/src/access/PermissionService.ts +635 -635
  95. package/src/access/index.ts +8 -8
  96. package/src/aggregation/AggregationService.ts +389 -389
  97. package/src/aggregation/index.ts +8 -8
  98. package/src/ai-sdk/PDWVectorStore.ts +715 -715
  99. package/src/ai-sdk/index.ts +65 -65
  100. package/src/ai-sdk/tools.ts +460 -460
  101. package/src/ai-sdk/types.ts +404 -404
  102. package/src/batch/BatchManager.ts +597 -597
  103. package/src/batch/BatchingService.ts +429 -429
  104. package/src/batch/MemoryProcessingCache.ts +492 -492
  105. package/src/batch/index.ts +30 -30
  106. package/src/browser.ts +200 -200
  107. package/src/client/ClientMemoryManager.ts +987 -987
  108. package/src/client/PersonalDataWallet.ts +345 -345
  109. package/src/client/SimplePDWClient.ts +1369 -1237
  110. package/src/client/factory.ts +154 -154
  111. package/src/client/namespaces/AnalyticsNamespace.ts +377 -377
  112. package/src/client/namespaces/BatchNamespace.ts +356 -356
  113. package/src/client/namespaces/CacheNamespace.ts +123 -123
  114. package/src/client/namespaces/CapabilityNamespace.ts +217 -217
  115. package/src/client/namespaces/ClassifyNamespace.ts +169 -169
  116. package/src/client/namespaces/ContextNamespace.ts +297 -297
  117. package/src/client/namespaces/EmbeddingsNamespace.ts +99 -99
  118. package/src/client/namespaces/EncryptionNamespace.ts +221 -221
  119. package/src/client/namespaces/GraphNamespace.ts +468 -468
  120. package/src/client/namespaces/IndexNamespace.ts +364 -361
  121. package/src/client/namespaces/MemoryNamespace.ts +1569 -1272
  122. package/src/client/namespaces/PermissionsNamespace.ts +254 -254
  123. package/src/client/namespaces/PipelineNamespace.ts +220 -220
  124. package/src/client/namespaces/SearchNamespace.ts +1049 -1049
  125. package/src/client/namespaces/StorageNamespace.ts +458 -458
  126. package/src/client/namespaces/TxNamespace.ts +260 -260
  127. package/src/client/namespaces/WalletNamespace.ts +243 -243
  128. package/src/client/namespaces/consolidated/AINamespace.ts +449 -449
  129. package/src/client/namespaces/consolidated/AdvancedNamespace.ts +264 -0
  130. package/src/client/namespaces/consolidated/BlockchainNamespace.ts +607 -564
  131. package/src/client/namespaces/consolidated/SecurityNamespace.ts +648 -648
  132. package/src/client/namespaces/consolidated/StorageNamespace.ts +1141 -497
  133. package/src/client/namespaces/consolidated/index.ts +41 -39
  134. package/src/client/signers/DappKitSigner.ts +207 -207
  135. package/src/client/signers/KeypairSigner.ts +108 -108
  136. package/src/client/signers/UnifiedSigner.ts +110 -110
  137. package/src/client/signers/WalletAdapterSigner.ts +159 -159
  138. package/src/client/signers/index.ts +26 -26
  139. package/src/config/ConfigurationHelper.ts +412 -412
  140. package/src/config/defaults.ts +56 -51
  141. package/src/config/index.ts +8 -8
  142. package/src/config/validation.ts +70 -70
  143. package/src/core/index.ts +14 -14
  144. package/src/core/interfaces/IService.ts +307 -307
  145. package/src/core/interfaces/index.ts +8 -8
  146. package/src/core/types/capability.ts +297 -297
  147. package/src/core/types/index.ts +874 -870
  148. package/src/core/types/wallet.ts +270 -270
  149. package/src/core/types.ts +9 -9
  150. package/src/core/wallet.ts +222 -222
  151. package/src/embedding/index.ts +19 -19
  152. package/src/embedding/types.ts +357 -357
  153. package/src/errors/index.ts +602 -602
  154. package/src/errors/recovery.ts +461 -461
  155. package/src/errors/validation.ts +567 -567
  156. package/src/generated/pdw/capability.ts +319 -319
  157. package/src/generated/pdw/deps/sui/object.ts +12 -12
  158. package/src/generated/pdw/deps/sui/vec_map.ts +32 -32
  159. package/src/generated/pdw/memory.ts +1087 -1087
  160. package/src/generated/pdw/wallet.ts +123 -123
  161. package/src/generated/utils/index.ts +159 -159
  162. package/src/graph/GraphService.ts +887 -887
  163. package/src/graph/KnowledgeGraphManager.ts +728 -728
  164. package/src/graph/index.ts +25 -25
  165. package/src/index.ts +498 -498
  166. package/src/infrastructure/index.ts +22 -22
  167. package/src/infrastructure/seal/EncryptionService.ts +628 -603
  168. package/src/infrastructure/seal/SealService.ts +613 -615
  169. package/src/infrastructure/seal/index.ts +9 -9
  170. package/src/infrastructure/sui/BlockchainManager.ts +627 -627
  171. package/src/infrastructure/sui/SuiService.ts +888 -888
  172. package/src/infrastructure/sui/index.ts +9 -9
  173. package/src/infrastructure/walrus/StorageManager.ts +604 -604
  174. package/src/infrastructure/walrus/WalrusStorageService.ts +637 -612
  175. package/src/infrastructure/walrus/index.ts +9 -9
  176. package/src/langchain/PDWEmbeddings.ts +145 -145
  177. package/src/langchain/PDWVectorStore.ts +456 -456
  178. package/src/langchain/createPDWRAG.ts +303 -303
  179. package/src/langchain/index.ts +47 -47
  180. package/src/permissions/ConsentRepository.browser.ts +249 -249
  181. package/src/permissions/ConsentRepository.ts +364 -364
  182. package/src/permissions/index.ts +9 -9
  183. package/src/pipeline/MemoryPipeline.ts +862 -862
  184. package/src/pipeline/PipelineManager.ts +683 -683
  185. package/src/pipeline/index.ts +26 -26
  186. package/src/retrieval/AdvancedSearchService.ts +629 -629
  187. package/src/retrieval/MemoryAnalyticsService.ts +711 -711
  188. package/src/retrieval/MemoryDecryptionPipeline.ts +825 -824
  189. package/src/retrieval/MemoryRetrievalService.ts +904 -904
  190. package/src/retrieval/index.ts +42 -42
  191. package/src/services/BatchService.ts +352 -352
  192. package/src/services/CapabilityService.ts +464 -448
  193. package/src/services/ClassifierService.ts +465 -465
  194. package/src/services/CrossContextPermissionService.ts +486 -484
  195. package/src/services/EmbeddingService.ts +796 -771
  196. package/src/services/EncryptionService.ts +712 -711
  197. package/src/services/GeminiAIService.ts +753 -753
  198. package/src/services/IndexManager.ts +977 -977
  199. package/src/services/MemoryIndexService.ts +1009 -1003
  200. package/src/services/MemoryService.ts +369 -369
  201. package/src/services/QueryService.ts +890 -890
  202. package/src/services/StorageService.ts +1182 -1126
  203. package/src/services/TransactionService.ts +838 -790
  204. package/src/services/VectorService.ts +462 -462
  205. package/src/services/ViewService.ts +484 -484
  206. package/src/services/index.ts +25 -25
  207. package/src/services/storage/BlobAttributesManager.ts +333 -333
  208. package/src/services/storage/KnowledgeGraphManager.ts +425 -425
  209. package/src/services/storage/MemorySearchManager.ts +387 -387
  210. package/src/services/storage/QuiltBatchManager.ts +1130 -1130
  211. package/src/services/storage/WalrusMetadataManager.ts +268 -268
  212. package/src/services/storage/WalrusStorageManager.ts +287 -287
  213. package/src/services/storage/index.ts +57 -57
  214. package/src/types/index.ts +13 -13
  215. package/src/utils/LRUCache.ts +378 -378
  216. package/src/utils/index.ts +76 -76
  217. package/src/utils/memoryIndexOnChain.ts +507 -507
  218. package/src/utils/rebuildIndex.ts +290 -290
  219. package/src/utils/rebuildIndexNode.ts +771 -771
  220. package/src/vector/BrowserHnswIndexService.ts +758 -758
  221. package/src/vector/HnswWasmService.ts +731 -731
  222. package/src/vector/IHnswService.ts +233 -233
  223. package/src/vector/NodeHnswService.ts +833 -833
  224. package/src/vector/VectorManager.ts +478 -478
  225. package/src/vector/createHnswService.ts +135 -135
  226. package/src/vector/index.ts +56 -56
  227. package/src/wallet/ContextWalletService.ts +656 -656
  228. package/src/wallet/MainWalletService.ts +317 -317
  229. package/src/wallet/index.ts +17 -17
@@ -1,108 +1,108 @@
1
- /**
2
- * Keypair Signer Implementation
3
- *
4
- * Wraps @mysten/sui Keypair for use with SimplePDWClient.
5
- * Suitable for Node.js, backend services, CLI tools.
6
- *
7
- * @example
8
- * ```typescript
9
- * import { Ed25519Keypair } from '@mysten/sui/keypairs/ed25519';
10
- * import { KeypairSigner } from 'personal-data-wallet-sdk/client';
11
- *
12
- * const keypair = Ed25519Keypair.fromSecretKey(privateKey);
13
- * const signer = new KeypairSigner(keypair, suiClient);
14
- *
15
- * const pdw = await createPDWClient({
16
- * signer,
17
- * network: 'testnet'
18
- * });
19
- * ```
20
- *
21
- * @module client/signers
22
- */
23
-
24
- import type { SuiClient } from '@mysten/sui/client';
25
- import type { Keypair, Signer } from '@mysten/sui/cryptography';
26
- import type { Transaction } from '@mysten/sui/transactions';
27
- import type {
28
- UnifiedSigner,
29
- SignAndExecuteResult,
30
- SignPersonalMessageResult
31
- } from './UnifiedSigner';
32
-
33
- /**
34
- * Keypair-based signer for Node.js and backend environments
35
- */
36
- export class KeypairSigner implements UnifiedSigner {
37
- constructor(
38
- private keypair: Keypair,
39
- private client: SuiClient
40
- ) {}
41
-
42
- /**
43
- * Sign and execute transaction using keypair
44
- */
45
- async signAndExecuteTransaction(transaction: Transaction): Promise<SignAndExecuteResult> {
46
- const result = await this.client.signAndExecuteTransaction({
47
- transaction,
48
- signer: this.keypair,
49
- options: {
50
- showEffects: true,
51
- showEvents: true,
52
- showObjectChanges: true
53
- }
54
- });
55
-
56
- // Wait for transaction to be finalized to prevent gas coin version conflicts
57
- if (result.digest) {
58
- await this.client.waitForTransaction({ digest: result.digest });
59
- }
60
-
61
- return {
62
- digest: result.digest,
63
- effects: result.effects,
64
- events: result.events || undefined,
65
- objectChanges: result.objectChanges || undefined
66
- };
67
- }
68
-
69
- /**
70
- * Sign personal message using keypair
71
- */
72
- async signPersonalMessage(message: Uint8Array): Promise<SignPersonalMessageResult> {
73
- const { signature } = await this.keypair.signPersonalMessage(message);
74
-
75
- return {
76
- signature, // Base64 string
77
- bytes: message // Original message bytes
78
- };
79
- }
80
-
81
- /**
82
- * Get Sui address from keypair
83
- */
84
- getAddress(): string {
85
- return this.keypair.getPublicKey().toSuiAddress();
86
- }
87
-
88
- /**
89
- * Get public key bytes
90
- */
91
- getPublicKey(): Uint8Array {
92
- return this.keypair.getPublicKey().toRawBytes();
93
- }
94
-
95
- /**
96
- * Get underlying Signer (Keypair)
97
- */
98
- getSigner(): Signer {
99
- return this.keypair;
100
- }
101
-
102
- /**
103
- * Get SuiClient instance
104
- */
105
- getClient(): SuiClient {
106
- return this.client;
107
- }
108
- }
1
+ /**
2
+ * Keypair Signer Implementation
3
+ *
4
+ * Wraps @mysten/sui Keypair for use with SimplePDWClient.
5
+ * Suitable for Node.js, backend services, CLI tools.
6
+ *
7
+ * @example
8
+ * ```typescript
9
+ * import { Ed25519Keypair } from '@mysten/sui/keypairs/ed25519';
10
+ * import { KeypairSigner } from 'personal-data-wallet-sdk/client';
11
+ *
12
+ * const keypair = Ed25519Keypair.fromSecretKey(privateKey);
13
+ * const signer = new KeypairSigner(keypair, suiClient);
14
+ *
15
+ * const pdw = await createPDWClient({
16
+ * signer,
17
+ * network: 'testnet'
18
+ * });
19
+ * ```
20
+ *
21
+ * @module client/signers
22
+ */
23
+
24
+ import type { SuiClient } from '@mysten/sui/client';
25
+ import type { Keypair, Signer } from '@mysten/sui/cryptography';
26
+ import type { Transaction } from '@mysten/sui/transactions';
27
+ import type {
28
+ UnifiedSigner,
29
+ SignAndExecuteResult,
30
+ SignPersonalMessageResult
31
+ } from './UnifiedSigner';
32
+
33
+ /**
34
+ * Keypair-based signer for Node.js and backend environments
35
+ */
36
+ export class KeypairSigner implements UnifiedSigner {
37
+ constructor(
38
+ private keypair: Keypair,
39
+ private client: SuiClient
40
+ ) {}
41
+
42
+ /**
43
+ * Sign and execute transaction using keypair
44
+ */
45
+ async signAndExecuteTransaction(transaction: Transaction): Promise<SignAndExecuteResult> {
46
+ const result = await this.client.signAndExecuteTransaction({
47
+ transaction,
48
+ signer: this.keypair,
49
+ options: {
50
+ showEffects: true,
51
+ showEvents: true,
52
+ showObjectChanges: true
53
+ }
54
+ });
55
+
56
+ // Wait for transaction to be finalized to prevent gas coin version conflicts
57
+ if (result.digest) {
58
+ await this.client.waitForTransaction({ digest: result.digest });
59
+ }
60
+
61
+ return {
62
+ digest: result.digest,
63
+ effects: result.effects,
64
+ events: result.events || undefined,
65
+ objectChanges: result.objectChanges || undefined
66
+ };
67
+ }
68
+
69
+ /**
70
+ * Sign personal message using keypair
71
+ */
72
+ async signPersonalMessage(message: Uint8Array): Promise<SignPersonalMessageResult> {
73
+ const { signature } = await this.keypair.signPersonalMessage(message);
74
+
75
+ return {
76
+ signature, // Base64 string
77
+ bytes: message // Original message bytes
78
+ };
79
+ }
80
+
81
+ /**
82
+ * Get Sui address from keypair
83
+ */
84
+ getAddress(): string {
85
+ return this.keypair.getPublicKey().toSuiAddress();
86
+ }
87
+
88
+ /**
89
+ * Get public key bytes
90
+ */
91
+ getPublicKey(): Uint8Array {
92
+ return this.keypair.getPublicKey().toRawBytes();
93
+ }
94
+
95
+ /**
96
+ * Get underlying Signer (Keypair)
97
+ */
98
+ getSigner(): Signer {
99
+ return this.keypair;
100
+ }
101
+
102
+ /**
103
+ * Get SuiClient instance
104
+ */
105
+ getClient(): SuiClient {
106
+ return this.client;
107
+ }
108
+ }
@@ -1,110 +1,110 @@
1
- /**
2
- * Unified Signer Interface
3
- *
4
- * Abstracts signing operations to work with both:
5
- * - Keypair (Node.js, backend, CLI)
6
- * - WalletAdapter (Browser, React dApps)
7
- *
8
- * This allows SimplePDWClient to work in any environment.
9
- *
10
- * @module client/signers
11
- */
12
-
13
- import type { Transaction } from '@mysten/sui/transactions';
14
- import type { Signer } from '@mysten/sui/cryptography';
15
- import type { SuiClient } from '@mysten/sui/client';
16
-
17
- /**
18
- * Result of signing and executing a transaction
19
- */
20
- export interface SignAndExecuteResult {
21
- /**
22
- * Transaction digest
23
- */
24
- digest: string;
25
-
26
- /**
27
- * Transaction effects
28
- */
29
- effects?: any;
30
-
31
- /**
32
- * Events emitted
33
- */
34
- events?: any[];
35
-
36
- /**
37
- * Object changes
38
- */
39
- objectChanges?: any[];
40
- }
41
-
42
- /**
43
- * Result of signing a personal message
44
- */
45
- export interface SignPersonalMessageResult {
46
- /**
47
- * Signature (Base64-encoded string)
48
- */
49
- signature: string;
50
-
51
- /**
52
- * Signed bytes
53
- */
54
- bytes: Uint8Array;
55
- }
56
-
57
- /**
58
- * Unified Signer Interface
59
- *
60
- * Provides consistent signing API across different wallet types
61
- */
62
- export interface UnifiedSigner {
63
- /**
64
- * Sign and execute a transaction on Sui blockchain
65
- *
66
- * @param transaction - The transaction to sign and execute
67
- * @returns Transaction result with digest and effects
68
- */
69
- signAndExecuteTransaction(transaction: Transaction): Promise<SignAndExecuteResult>;
70
-
71
- /**
72
- * Sign a personal message (for SEAL encryption identity)
73
- *
74
- * @param message - The message bytes to sign
75
- * @returns Signature result
76
- */
77
- signPersonalMessage(message: Uint8Array): Promise<SignPersonalMessageResult>;
78
-
79
- /**
80
- * Get the Sui address of this signer
81
- *
82
- * @returns Sui address (0x-prefixed hex string)
83
- */
84
- getAddress(): string;
85
-
86
- /**
87
- * Get the public key (if available)
88
- *
89
- * @returns Public key bytes or null
90
- */
91
- getPublicKey?(): Uint8Array | null;
92
-
93
- /**
94
- * Get the underlying Signer (for services that need full Signer interface)
95
- *
96
- * Note: This may not be available for all signer types (e.g., wallet adapters)
97
- * @returns Signer instance or throws error if not available
98
- */
99
- getSigner(): Signer;
100
-
101
- /**
102
- * Get the SuiClient instance (optional)
103
- *
104
- * Used by managers that need to build transactions or wait for confirmations.
105
- * Returns null if not available (e.g., WalletAdapterSigner).
106
- *
107
- * @returns SuiClient instance or null
108
- */
109
- getClient?(): SuiClient | null;
110
- }
1
+ /**
2
+ * Unified Signer Interface
3
+ *
4
+ * Abstracts signing operations to work with both:
5
+ * - Keypair (Node.js, backend, CLI)
6
+ * - WalletAdapter (Browser, React dApps)
7
+ *
8
+ * This allows SimplePDWClient to work in any environment.
9
+ *
10
+ * @module client/signers
11
+ */
12
+
13
+ import type { Transaction } from '@mysten/sui/transactions';
14
+ import type { Signer } from '@mysten/sui/cryptography';
15
+ import type { SuiClient } from '@mysten/sui/client';
16
+
17
+ /**
18
+ * Result of signing and executing a transaction
19
+ */
20
+ export interface SignAndExecuteResult {
21
+ /**
22
+ * Transaction digest
23
+ */
24
+ digest: string;
25
+
26
+ /**
27
+ * Transaction effects
28
+ */
29
+ effects?: any;
30
+
31
+ /**
32
+ * Events emitted
33
+ */
34
+ events?: any[];
35
+
36
+ /**
37
+ * Object changes
38
+ */
39
+ objectChanges?: any[];
40
+ }
41
+
42
+ /**
43
+ * Result of signing a personal message
44
+ */
45
+ export interface SignPersonalMessageResult {
46
+ /**
47
+ * Signature (Base64-encoded string)
48
+ */
49
+ signature: string;
50
+
51
+ /**
52
+ * Signed bytes
53
+ */
54
+ bytes: Uint8Array;
55
+ }
56
+
57
+ /**
58
+ * Unified Signer Interface
59
+ *
60
+ * Provides consistent signing API across different wallet types
61
+ */
62
+ export interface UnifiedSigner {
63
+ /**
64
+ * Sign and execute a transaction on Sui blockchain
65
+ *
66
+ * @param transaction - The transaction to sign and execute
67
+ * @returns Transaction result with digest and effects
68
+ */
69
+ signAndExecuteTransaction(transaction: Transaction): Promise<SignAndExecuteResult>;
70
+
71
+ /**
72
+ * Sign a personal message (for SEAL encryption identity)
73
+ *
74
+ * @param message - The message bytes to sign
75
+ * @returns Signature result
76
+ */
77
+ signPersonalMessage(message: Uint8Array): Promise<SignPersonalMessageResult>;
78
+
79
+ /**
80
+ * Get the Sui address of this signer
81
+ *
82
+ * @returns Sui address (0x-prefixed hex string)
83
+ */
84
+ getAddress(): string;
85
+
86
+ /**
87
+ * Get the public key (if available)
88
+ *
89
+ * @returns Public key bytes or null
90
+ */
91
+ getPublicKey?(): Uint8Array | null;
92
+
93
+ /**
94
+ * Get the underlying Signer (for services that need full Signer interface)
95
+ *
96
+ * Note: This may not be available for all signer types (e.g., wallet adapters)
97
+ * @returns Signer instance or throws error if not available
98
+ */
99
+ getSigner(): Signer;
100
+
101
+ /**
102
+ * Get the SuiClient instance (optional)
103
+ *
104
+ * Used by managers that need to build transactions or wait for confirmations.
105
+ * Returns null if not available (e.g., WalletAdapterSigner).
106
+ *
107
+ * @returns SuiClient instance or null
108
+ */
109
+ getClient?(): SuiClient | null;
110
+ }