@cmdoss/memwal-sdk 0.6.2 → 0.8.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 (247) hide show
  1. package/ARCHITECTURE.md +547 -547
  2. package/BENCHMARKS.md +238 -238
  3. package/README.md +310 -181
  4. package/dist/ai-sdk/tools.d.ts +2 -2
  5. package/dist/ai-sdk/tools.js +2 -2
  6. package/dist/client/ClientMemoryManager.js +2 -2
  7. package/dist/client/ClientMemoryManager.js.map +1 -1
  8. package/dist/client/PersonalDataWallet.d.ts.map +1 -1
  9. package/dist/client/SimplePDWClient.d.ts +29 -1
  10. package/dist/client/SimplePDWClient.d.ts.map +1 -1
  11. package/dist/client/SimplePDWClient.js +45 -13
  12. package/dist/client/SimplePDWClient.js.map +1 -1
  13. package/dist/client/namespaces/EmbeddingsNamespace.d.ts +1 -1
  14. package/dist/client/namespaces/EmbeddingsNamespace.js +1 -1
  15. package/dist/client/namespaces/MemoryNamespace.d.ts +31 -0
  16. package/dist/client/namespaces/MemoryNamespace.d.ts.map +1 -1
  17. package/dist/client/namespaces/MemoryNamespace.js +272 -39
  18. package/dist/client/namespaces/MemoryNamespace.js.map +1 -1
  19. package/dist/client/namespaces/consolidated/AINamespace.d.ts +2 -2
  20. package/dist/client/namespaces/consolidated/AINamespace.js +2 -2
  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 +62 -4
  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/config/ConfigurationHelper.js +61 -61
  30. package/dist/config/defaults.js +2 -2
  31. package/dist/config/defaults.js.map +1 -1
  32. package/dist/graph/GraphService.js +21 -21
  33. package/dist/graph/GraphService.js.map +1 -1
  34. package/dist/index.d.ts +3 -1
  35. package/dist/index.d.ts.map +1 -1
  36. package/dist/index.js +3 -1
  37. package/dist/index.js.map +1 -1
  38. package/dist/infrastructure/seal/EncryptionService.d.ts +9 -5
  39. package/dist/infrastructure/seal/EncryptionService.d.ts.map +1 -1
  40. package/dist/infrastructure/seal/EncryptionService.js +37 -15
  41. package/dist/infrastructure/seal/EncryptionService.js.map +1 -1
  42. package/dist/infrastructure/seal/SealService.d.ts +13 -5
  43. package/dist/infrastructure/seal/SealService.d.ts.map +1 -1
  44. package/dist/infrastructure/seal/SealService.js +36 -34
  45. package/dist/infrastructure/seal/SealService.js.map +1 -1
  46. package/dist/langchain/createPDWRAG.js +30 -30
  47. package/dist/retrieval/MemoryDecryptionPipeline.d.ts.map +1 -1
  48. package/dist/retrieval/MemoryDecryptionPipeline.js +2 -1
  49. package/dist/retrieval/MemoryDecryptionPipeline.js.map +1 -1
  50. package/dist/retrieval/MemoryRetrievalService.d.ts +31 -0
  51. package/dist/retrieval/MemoryRetrievalService.d.ts.map +1 -1
  52. package/dist/retrieval/MemoryRetrievalService.js +44 -4
  53. package/dist/retrieval/MemoryRetrievalService.js.map +1 -1
  54. package/dist/services/CapabilityService.d.ts.map +1 -1
  55. package/dist/services/CapabilityService.js +30 -14
  56. package/dist/services/CapabilityService.js.map +1 -1
  57. package/dist/services/CrossContextPermissionService.d.ts.map +1 -1
  58. package/dist/services/CrossContextPermissionService.js +9 -7
  59. package/dist/services/CrossContextPermissionService.js.map +1 -1
  60. package/dist/services/EmbeddingService.d.ts +28 -1
  61. package/dist/services/EmbeddingService.d.ts.map +1 -1
  62. package/dist/services/EmbeddingService.js +54 -0
  63. package/dist/services/EmbeddingService.js.map +1 -1
  64. package/dist/services/EncryptionService.d.ts.map +1 -1
  65. package/dist/services/EncryptionService.js +6 -5
  66. package/dist/services/EncryptionService.js.map +1 -1
  67. package/dist/services/GeminiAIService.js +309 -309
  68. package/dist/services/IndexManager.d.ts +5 -1
  69. package/dist/services/IndexManager.d.ts.map +1 -1
  70. package/dist/services/IndexManager.js +17 -40
  71. package/dist/services/IndexManager.js.map +1 -1
  72. package/dist/services/QueryService.js +1 -1
  73. package/dist/services/QueryService.js.map +1 -1
  74. package/dist/services/StorageService.d.ts +11 -0
  75. package/dist/services/StorageService.d.ts.map +1 -1
  76. package/dist/services/StorageService.js +73 -10
  77. package/dist/services/StorageService.js.map +1 -1
  78. package/dist/services/TransactionService.d.ts +20 -0
  79. package/dist/services/TransactionService.d.ts.map +1 -1
  80. package/dist/services/TransactionService.js +43 -0
  81. package/dist/services/TransactionService.js.map +1 -1
  82. package/dist/services/ViewService.js +2 -2
  83. package/dist/services/ViewService.js.map +1 -1
  84. package/dist/services/storage/QuiltBatchManager.d.ts +101 -1
  85. package/dist/services/storage/QuiltBatchManager.d.ts.map +1 -1
  86. package/dist/services/storage/QuiltBatchManager.js +410 -20
  87. package/dist/services/storage/QuiltBatchManager.js.map +1 -1
  88. package/dist/services/storage/index.d.ts +1 -1
  89. package/dist/services/storage/index.d.ts.map +1 -1
  90. package/dist/services/storage/index.js.map +1 -1
  91. package/dist/utils/LRUCache.d.ts +106 -0
  92. package/dist/utils/LRUCache.d.ts.map +1 -0
  93. package/dist/utils/LRUCache.js +281 -0
  94. package/dist/utils/LRUCache.js.map +1 -0
  95. package/dist/utils/index.d.ts +1 -0
  96. package/dist/utils/index.d.ts.map +1 -1
  97. package/dist/utils/index.js +2 -0
  98. package/dist/utils/index.js.map +1 -1
  99. package/dist/utils/memoryIndexOnChain.d.ts +212 -0
  100. package/dist/utils/memoryIndexOnChain.d.ts.map +1 -0
  101. package/dist/utils/memoryIndexOnChain.js +312 -0
  102. package/dist/utils/memoryIndexOnChain.js.map +1 -0
  103. package/dist/utils/rebuildIndexNode.d.ts +29 -0
  104. package/dist/utils/rebuildIndexNode.d.ts.map +1 -1
  105. package/dist/utils/rebuildIndexNode.js +366 -98
  106. package/dist/utils/rebuildIndexNode.js.map +1 -1
  107. package/dist/vector/HnswWasmService.d.ts +20 -5
  108. package/dist/vector/HnswWasmService.d.ts.map +1 -1
  109. package/dist/vector/HnswWasmService.js +73 -40
  110. package/dist/vector/HnswWasmService.js.map +1 -1
  111. package/dist/vector/IHnswService.d.ts +10 -1
  112. package/dist/vector/IHnswService.d.ts.map +1 -1
  113. package/dist/vector/IHnswService.js.map +1 -1
  114. package/dist/vector/NodeHnswService.d.ts +16 -0
  115. package/dist/vector/NodeHnswService.d.ts.map +1 -1
  116. package/dist/vector/NodeHnswService.js +84 -5
  117. package/dist/vector/NodeHnswService.js.map +1 -1
  118. package/dist/vector/createHnswService.d.ts +1 -1
  119. package/dist/vector/createHnswService.js +1 -1
  120. package/dist/vector/index.d.ts +1 -1
  121. package/dist/vector/index.js +1 -1
  122. package/package.json +157 -157
  123. package/src/access/PermissionService.ts +635 -635
  124. package/src/aggregation/AggregationService.ts +389 -389
  125. package/src/ai-sdk/PDWVectorStore.ts +715 -715
  126. package/src/ai-sdk/index.ts +65 -65
  127. package/src/ai-sdk/tools.ts +460 -460
  128. package/src/ai-sdk/types.ts +404 -404
  129. package/src/batch/BatchManager.ts +597 -597
  130. package/src/batch/BatchingService.ts +429 -429
  131. package/src/batch/MemoryProcessingCache.ts +492 -492
  132. package/src/batch/index.ts +30 -30
  133. package/src/browser.ts +200 -200
  134. package/src/client/ClientMemoryManager.ts +987 -987
  135. package/src/client/PersonalDataWallet.ts +345 -345
  136. package/src/client/SimplePDWClient.ts +1289 -1222
  137. package/src/client/factory.ts +154 -154
  138. package/src/client/namespaces/AnalyticsNamespace.ts +377 -377
  139. package/src/client/namespaces/BatchNamespace.ts +356 -356
  140. package/src/client/namespaces/CacheNamespace.ts +123 -123
  141. package/src/client/namespaces/CapabilityNamespace.ts +217 -217
  142. package/src/client/namespaces/ClassifyNamespace.ts +169 -169
  143. package/src/client/namespaces/ContextNamespace.ts +297 -297
  144. package/src/client/namespaces/EmbeddingsNamespace.ts +99 -99
  145. package/src/client/namespaces/EncryptionNamespace.ts +221 -221
  146. package/src/client/namespaces/GraphNamespace.ts +468 -468
  147. package/src/client/namespaces/IndexNamespace.ts +361 -361
  148. package/src/client/namespaces/MemoryNamespace.ts +1422 -1135
  149. package/src/client/namespaces/PermissionsNamespace.ts +254 -254
  150. package/src/client/namespaces/PipelineNamespace.ts +220 -220
  151. package/src/client/namespaces/SearchNamespace.ts +1049 -1049
  152. package/src/client/namespaces/StorageNamespace.ts +458 -458
  153. package/src/client/namespaces/TxNamespace.ts +260 -260
  154. package/src/client/namespaces/WalletNamespace.ts +243 -243
  155. package/src/client/namespaces/consolidated/AINamespace.ts +449 -449
  156. package/src/client/namespaces/consolidated/BlockchainNamespace.ts +607 -546
  157. package/src/client/namespaces/consolidated/SecurityNamespace.ts +648 -648
  158. package/src/client/namespaces/consolidated/StorageNamespace.ts +1141 -497
  159. package/src/client/namespaces/consolidated/index.ts +39 -39
  160. package/src/client/signers/KeypairSigner.ts +108 -108
  161. package/src/client/signers/UnifiedSigner.ts +110 -110
  162. package/src/client/signers/WalletAdapterSigner.ts +159 -159
  163. package/src/client/signers/index.ts +26 -26
  164. package/src/config/ConfigurationHelper.ts +412 -412
  165. package/src/config/defaults.ts +51 -51
  166. package/src/config/index.ts +8 -8
  167. package/src/config/validation.ts +70 -70
  168. package/src/core/index.ts +14 -14
  169. package/src/core/interfaces/IService.ts +307 -307
  170. package/src/core/interfaces/index.ts +8 -8
  171. package/src/core/types/capability.ts +297 -297
  172. package/src/core/types/index.ts +870 -870
  173. package/src/core/types/wallet.ts +270 -270
  174. package/src/core/types.ts +9 -9
  175. package/src/core/wallet.ts +222 -222
  176. package/src/embedding/index.ts +19 -19
  177. package/src/embedding/types.ts +357 -357
  178. package/src/errors/index.ts +602 -602
  179. package/src/errors/recovery.ts +461 -461
  180. package/src/errors/validation.ts +567 -567
  181. package/src/generated/pdw/capability.ts +319 -319
  182. package/src/graph/GraphService.ts +887 -887
  183. package/src/graph/KnowledgeGraphManager.ts +728 -728
  184. package/src/graph/index.ts +25 -25
  185. package/src/index.ts +498 -474
  186. package/src/infrastructure/index.ts +22 -22
  187. package/src/infrastructure/seal/EncryptionService.ts +628 -603
  188. package/src/infrastructure/seal/SealService.ts +613 -615
  189. package/src/infrastructure/seal/index.ts +9 -9
  190. package/src/infrastructure/sui/BlockchainManager.ts +627 -627
  191. package/src/infrastructure/sui/SuiService.ts +888 -888
  192. package/src/infrastructure/sui/index.ts +9 -9
  193. package/src/infrastructure/walrus/StorageManager.ts +604 -604
  194. package/src/infrastructure/walrus/WalrusStorageService.ts +612 -612
  195. package/src/infrastructure/walrus/index.ts +9 -9
  196. package/src/langchain/PDWEmbeddings.ts +145 -145
  197. package/src/langchain/PDWVectorStore.ts +456 -456
  198. package/src/langchain/createPDWRAG.ts +303 -303
  199. package/src/langchain/index.ts +47 -47
  200. package/src/permissions/ConsentRepository.browser.ts +249 -249
  201. package/src/permissions/ConsentRepository.ts +364 -364
  202. package/src/pipeline/MemoryPipeline.ts +862 -862
  203. package/src/pipeline/PipelineManager.ts +683 -683
  204. package/src/pipeline/index.ts +26 -26
  205. package/src/retrieval/AdvancedSearchService.ts +629 -629
  206. package/src/retrieval/MemoryAnalyticsService.ts +711 -711
  207. package/src/retrieval/MemoryDecryptionPipeline.ts +825 -824
  208. package/src/retrieval/MemoryRetrievalService.ts +904 -830
  209. package/src/retrieval/index.ts +42 -42
  210. package/src/services/BatchService.ts +352 -352
  211. package/src/services/CapabilityService.ts +464 -448
  212. package/src/services/ClassifierService.ts +465 -465
  213. package/src/services/CrossContextPermissionService.ts +486 -484
  214. package/src/services/EmbeddingService.ts +771 -706
  215. package/src/services/EncryptionService.ts +712 -711
  216. package/src/services/GeminiAIService.ts +753 -753
  217. package/src/services/IndexManager.ts +977 -1004
  218. package/src/services/MemoryIndexService.ts +1003 -1003
  219. package/src/services/MemoryService.ts +369 -369
  220. package/src/services/QueryService.ts +890 -890
  221. package/src/services/StorageService.ts +1182 -1111
  222. package/src/services/TransactionService.ts +838 -790
  223. package/src/services/VectorService.ts +462 -462
  224. package/src/services/ViewService.ts +484 -484
  225. package/src/services/index.ts +25 -25
  226. package/src/services/storage/BlobAttributesManager.ts +333 -333
  227. package/src/services/storage/KnowledgeGraphManager.ts +425 -425
  228. package/src/services/storage/MemorySearchManager.ts +387 -387
  229. package/src/services/storage/QuiltBatchManager.ts +1130 -660
  230. package/src/services/storage/WalrusMetadataManager.ts +268 -268
  231. package/src/services/storage/WalrusStorageManager.ts +287 -287
  232. package/src/services/storage/index.ts +57 -52
  233. package/src/types/index.ts +13 -13
  234. package/src/utils/LRUCache.ts +378 -0
  235. package/src/utils/index.ts +76 -68
  236. package/src/utils/memoryIndexOnChain.ts +507 -0
  237. package/src/utils/rebuildIndex.ts +290 -290
  238. package/src/utils/rebuildIndexNode.ts +771 -424
  239. package/src/vector/BrowserHnswIndexService.ts +758 -758
  240. package/src/vector/HnswWasmService.ts +731 -679
  241. package/src/vector/IHnswService.ts +233 -224
  242. package/src/vector/NodeHnswService.ts +833 -735
  243. package/src/vector/VectorManager.ts +478 -478
  244. package/src/vector/createHnswService.ts +135 -135
  245. package/src/vector/index.ts +56 -56
  246. package/src/wallet/ContextWalletService.ts +656 -656
  247. package/src/wallet/MainWalletService.ts +317 -317
@@ -1,448 +1,464 @@
1
- /**
2
- * CapabilityService - Capability-based access control for Personal Data Wallet
3
- *
4
- * This service implements the SEAL PrivateData pattern for simplified access control
5
- * using Move's capability pattern. It replaces the old HD wallet + allowlist architecture.
6
- *
7
- * Key benefits:
8
- * - 1 user wallet instead of N HD wallets
9
- * - Object ownership = access permission (SEAL idiomatic)
10
- * - No global registry needed
11
- * - 60% gas savings vs allowlist pattern
12
- * - Type-safe access control
13
- *
14
- * @see CAPABILITY-ARCHITECTURE-SUMMARY.md
15
- */
16
-
17
- import { SuiClient } from '@mysten/sui/client';
18
- import { Transaction } from '@mysten/sui/transactions';
19
- import { sha3_256 } from '@noble/hashes/sha3.js';
20
- import { bcs } from '@mysten/sui/bcs';
21
- import type {
22
- MemoryCap,
23
- CreateMemoryCapOptions,
24
- TransferCapOptions,
25
- BurnCapOptions,
26
- ListCapsOptions,
27
- GetOrCreateCapOptions,
28
- MemoryCapList,
29
- ComputeKeyIdOptions
30
- } from '../core/types/capability';
31
-
32
- /**
33
- * Configuration for CapabilityService
34
- */
35
- export interface CapabilityServiceConfig {
36
- /** Sui client instance */
37
- suiClient: SuiClient;
38
- /** Package ID for Move contracts */
39
- packageId: string;
40
- }
41
-
42
- /**
43
- * CapabilityService handles MemoryCap object operations
44
- *
45
- * Implements the SEAL PrivateData pattern for simplified access control.
46
- */
47
- export class CapabilityService {
48
- private suiClient: SuiClient;
49
- private packageId: string;
50
-
51
- constructor(config: CapabilityServiceConfig) {
52
- this.suiClient = config.suiClient;
53
- this.packageId = config.packageId;
54
- }
55
-
56
- /**
57
- * Create a new MemoryCap for an app context
58
- *
59
- * @param options - Creation options
60
- * @param signer - Transaction signer
61
- * @returns Created MemoryCap
62
- */
63
- async create(
64
- options: CreateMemoryCapOptions,
65
- signer: any
66
- ): Promise<MemoryCap> {
67
- const tx = new Transaction();
68
-
69
- tx.moveCall({
70
- target: `${this.packageId}::capability::create_memory_cap`,
71
- arguments: [
72
- tx.pure.string(options.appId),
73
- ],
74
- });
75
-
76
- const result = await this.suiClient.signAndExecuteTransaction({
77
- transaction: tx,
78
- signer,
79
- options: {
80
- showEffects: true,
81
- showEvents: true,
82
- showObjectChanges: true,
83
- },
84
- });
85
-
86
- // Wait for transaction to be finalized to prevent gas coin version conflicts
87
- if (result.digest) {
88
- await this.suiClient.waitForTransaction({ digest: result.digest });
89
- }
90
-
91
- if (result.effects?.status?.status !== 'success') {
92
- throw new Error(`Failed to create MemoryCap: ${result.effects?.status?.error}`);
93
- }
94
-
95
- // Extract created MemoryCap from events
96
- const createdEvent = result.events?.find(
97
- (event: any) => event.type.includes('::capability::MemoryCapCreated')
98
- );
99
-
100
- if (!createdEvent) {
101
- throw new Error('MemoryCapCreated event not found');
102
- }
103
-
104
- const eventData = createdEvent.parsedJson as any;
105
-
106
- return {
107
- id: eventData.cap_id,
108
- nonce: eventData.nonce,
109
- appId: eventData.app_id,
110
- owner: eventData.owner,
111
- createdAt: eventData.created_at,
112
- };
113
- }
114
-
115
- /**
116
- * Get a MemoryCap by app ID for a user
117
- *
118
- * @param userAddress - User's Sui address
119
- * @param appId - Application identifier
120
- * @returns MemoryCap or null if not found
121
- */
122
- async get(userAddress: string, appId: string): Promise<MemoryCap | null> {
123
- const caps = await this.list({ userAddress, appId });
124
- return caps.length > 0 ? caps[0] : null;
125
- }
126
-
127
- /**
128
- * Get or create a MemoryCap for an app context
129
- *
130
- * @param options - Get or create options
131
- * @param signer - Transaction signer (required for creation)
132
- * @returns Existing or newly created MemoryCap
133
- */
134
- async getOrCreate(
135
- options: GetOrCreateCapOptions,
136
- signer: any
137
- ): Promise<MemoryCap> {
138
- const userAddress = options.userAddress || await signer.getPublicKey?.()?.toSuiAddress?.() || '';
139
-
140
- // Try to get existing capability
141
- const existing = await this.get(userAddress, options.appId);
142
- if (existing) {
143
- return existing;
144
- }
145
-
146
- // Create new capability
147
- return await this.create({ appId: options.appId }, signer);
148
- }
149
-
150
- /**
151
- * List all MemoryCaps owned by a user
152
- *
153
- * @param options - List options (filter by appId, userAddress)
154
- * @returns Array of MemoryCaps
155
- */
156
- async list(options?: ListCapsOptions): Promise<MemoryCap[]> {
157
- const userAddress = options?.userAddress;
158
- if (!userAddress) {
159
- throw new Error('userAddress is required for listing capabilities');
160
- }
161
-
162
- const response = await this.suiClient.getOwnedObjects({
163
- owner: userAddress,
164
- filter: {
165
- StructType: `${this.packageId}::capability::MemoryCap`
166
- },
167
- options: {
168
- showContent: true,
169
- showType: true,
170
- },
171
- });
172
-
173
- const caps: MemoryCap[] = [];
174
-
175
- for (const obj of response.data) {
176
- if (!obj.data?.content || obj.data.content.dataType !== 'moveObject') {
177
- continue;
178
- }
179
-
180
- const fields = obj.data.content.fields as any;
181
- const appId = fields.app_id;
182
-
183
- // Filter by appId if specified
184
- if (options?.appId && appId !== options.appId) {
185
- continue;
186
- }
187
-
188
- // Convert nonce from bytes to hex string
189
- const nonceBytes: number[] = Array.isArray(fields.nonce)
190
- ? fields.nonce
191
- : [];
192
- const nonceHex = nonceBytes
193
- .map((b: number) => b.toString(16).padStart(2, '0'))
194
- .join('');
195
-
196
- caps.push({
197
- id: obj.data.objectId,
198
- nonce: nonceHex,
199
- appId,
200
- owner: userAddress,
201
- });
202
- }
203
-
204
- return caps;
205
- }
206
-
207
- /**
208
- * Transfer a MemoryCap to another address
209
- *
210
- * After transfer:
211
- * - New owner can call seal_approve
212
- * - New owner can decrypt memories
213
- * - Original owner loses access
214
- *
215
- * @param options - Transfer options
216
- * @param signer - Transaction signer
217
- */
218
- async transfer(options: TransferCapOptions, signer: any): Promise<void> {
219
- const tx = new Transaction();
220
-
221
- tx.moveCall({
222
- target: `${this.packageId}::capability::transfer_cap`,
223
- arguments: [
224
- tx.object(options.capId),
225
- tx.pure.address(options.recipient),
226
- ],
227
- });
228
-
229
- const result = await this.suiClient.signAndExecuteTransaction({
230
- transaction: tx,
231
- signer,
232
- options: {
233
- showEffects: true,
234
- showEvents: true,
235
- },
236
- });
237
-
238
- // Wait for transaction to be finalized to prevent gas coin version conflicts
239
- if (result.digest) {
240
- await this.suiClient.waitForTransaction({ digest: result.digest });
241
- }
242
-
243
- if (result.effects?.status?.status !== 'success') {
244
- throw new Error(`Failed to transfer MemoryCap: ${result.effects?.status?.error}`);
245
- }
246
- }
247
-
248
- /**
249
- * Burn (revoke) a MemoryCap
250
- *
251
- * This permanently revokes the capability.
252
- * After burning:
253
- * - No one can decrypt memories for this context
254
- * - Object is permanently deleted
255
- *
256
- * @param options - Burn options
257
- * @param signer - Transaction signer
258
- */
259
- async burn(options: BurnCapOptions, signer: any): Promise<void> {
260
- const tx = new Transaction();
261
-
262
- tx.moveCall({
263
- target: `${this.packageId}::capability::burn_cap`,
264
- arguments: [
265
- tx.object(options.capId),
266
- ],
267
- });
268
-
269
- const result = await this.suiClient.signAndExecuteTransaction({
270
- transaction: tx,
271
- signer,
272
- options: {
273
- showEffects: true,
274
- showEvents: true,
275
- },
276
- });
277
-
278
- // Wait for transaction to be finalized to prevent gas coin version conflicts
279
- if (result.digest) {
280
- await this.suiClient.waitForTransaction({ digest: result.digest });
281
- }
282
-
283
- if (result.effects?.status?.status !== 'success') {
284
- throw new Error(`Failed to burn MemoryCap: ${result.effects?.status?.error}`);
285
- }
286
- }
287
-
288
- /**
289
- * Compute SEAL key ID for a capability
290
- *
291
- * key_id = keccak256(owner || nonce)
292
- *
293
- * @param cap - MemoryCap object
294
- * @returns Key ID as hex string
295
- */
296
- computeKeyId(cap: MemoryCap): string {
297
- return this.computeKeyIdFromParts({
298
- owner: cap.owner,
299
- nonce: cap.nonce,
300
- });
301
- }
302
-
303
- /**
304
- * Compute SEAL key ID from owner and nonce
305
- *
306
- * @param options - Owner address and nonce
307
- * @returns Key ID as hex string
308
- */
309
- computeKeyIdFromParts(options: ComputeKeyIdOptions): string {
310
- // Convert owner address to bytes (32 bytes for Sui address)
311
- const ownerBytes = this.addressToBytes(options.owner);
312
-
313
- // Convert nonce from hex string to bytes
314
- const nonceBytes = this.hexToBytes(options.nonce);
315
-
316
- // Concatenate: owner || nonce
317
- const data = new Uint8Array(ownerBytes.length + nonceBytes.length);
318
- data.set(ownerBytes, 0);
319
- data.set(nonceBytes, ownerBytes.length);
320
-
321
- // Hash with keccak256
322
- const hash = sha3_256(data);
323
-
324
- // Return as hex string
325
- return '0x' + Array.from(hash)
326
- .map(b => b.toString(16).padStart(2, '0'))
327
- .join('');
328
- }
329
-
330
- /**
331
- * Get MemoryCap object by ID
332
- *
333
- * @param capId - Capability object ID
334
- * @returns MemoryCap or null
335
- */
336
- async getById(capId: string): Promise<MemoryCap | null> {
337
- try {
338
- const response = await this.suiClient.getObject({
339
- id: capId,
340
- options: {
341
- showContent: true,
342
- showOwner: true,
343
- },
344
- });
345
-
346
- if (!response.data?.content || response.data.content.dataType !== 'moveObject') {
347
- return null;
348
- }
349
-
350
- const fields = response.data.content.fields as any;
351
-
352
- // Get owner from object ownership
353
- let owner = '';
354
- if (response.data.owner && typeof response.data.owner === 'object') {
355
- if ('AddressOwner' in response.data.owner) {
356
- owner = response.data.owner.AddressOwner;
357
- }
358
- }
359
-
360
- // Convert nonce
361
- const nonceBytes: number[] = Array.isArray(fields.nonce)
362
- ? fields.nonce
363
- : [];
364
- const nonceHex = nonceBytes
365
- .map((b: number) => b.toString(16).padStart(2, '0'))
366
- .join('');
367
-
368
- return {
369
- id: capId,
370
- nonce: nonceHex,
371
- appId: fields.app_id,
372
- owner,
373
- };
374
- } catch (error) {
375
- console.error('Error fetching MemoryCap by ID:', error);
376
- return null;
377
- }
378
- }
379
-
380
- /**
381
- * Check if user has capability for an app context
382
- *
383
- * @param userAddress - User's Sui address
384
- * @param appId - Application identifier
385
- * @returns True if capability exists
386
- */
387
- async hasCapability(userAddress: string, appId: string): Promise<boolean> {
388
- const cap = await this.get(userAddress, appId);
389
- return cap !== null;
390
- }
391
-
392
- /**
393
- * Build transaction for creating MemoryCap (for PTB composition)
394
- *
395
- * @param tx - Transaction to add call to
396
- * @param appId - Application identifier
397
- */
398
- buildCreateCall(tx: Transaction, appId: string): void {
399
- tx.moveCall({
400
- target: `${this.packageId}::capability::create_memory_cap`,
401
- arguments: [
402
- tx.pure.string(appId),
403
- ],
404
- });
405
- }
406
-
407
- /**
408
- * Build seal_approve transaction argument
409
- *
410
- * @param tx - Transaction to add call to
411
- * @param capId - Capability object ID
412
- * @param keyId - SEAL key ID (as hex string)
413
- */
414
- buildSealApproveCall(tx: Transaction, capId: string, keyId: string): void {
415
- const keyIdBytes = this.hexToBytes(keyId);
416
-
417
- tx.moveCall({
418
- target: `${this.packageId}::capability::seal_approve`,
419
- arguments: [
420
- tx.object(capId),
421
- tx.pure(bcs.vector(bcs.u8()).serialize(Array.from(keyIdBytes))),
422
- ],
423
- });
424
- }
425
-
426
- // ========== Private Helper Methods ==========
427
-
428
- private addressToBytes(address: string): Uint8Array {
429
- // Remove 0x prefix if present
430
- const cleanAddr = address.startsWith('0x') ? address.slice(2) : address;
431
-
432
- // Sui addresses are 32 bytes (64 hex chars)
433
- const padded = cleanAddr.padStart(64, '0');
434
-
435
- return this.hexToBytes(padded);
436
- }
437
-
438
- private hexToBytes(hex: string): Uint8Array {
439
- const cleanHex = hex.startsWith('0x') ? hex.slice(2) : hex;
440
- const bytes = new Uint8Array(cleanHex.length / 2);
441
-
442
- for (let i = 0; i < cleanHex.length; i += 2) {
443
- bytes[i / 2] = parseInt(cleanHex.slice(i, i + 2), 16);
444
- }
445
-
446
- return bytes;
447
- }
448
- }
1
+ /**
2
+ * CapabilityService - Capability-based access control for Personal Data Wallet
3
+ *
4
+ * This service implements the SEAL PrivateData pattern for simplified access control
5
+ * using Move's capability pattern. It replaces the old HD wallet + allowlist architecture.
6
+ *
7
+ * Key benefits:
8
+ * - 1 user wallet instead of N HD wallets
9
+ * - Object ownership = access permission (SEAL idiomatic)
10
+ * - No global registry needed
11
+ * - 60% gas savings vs allowlist pattern
12
+ * - Type-safe access control
13
+ *
14
+ * @see CAPABILITY-ARCHITECTURE-SUMMARY.md
15
+ */
16
+
17
+ import { SuiClient } from '@mysten/sui/client';
18
+ import { Transaction } from '@mysten/sui/transactions';
19
+ import { keccak_256 } from '@noble/hashes/sha3.js';
20
+ import { bcs } from '@mysten/sui/bcs';
21
+ import type {
22
+ MemoryCap,
23
+ CreateMemoryCapOptions,
24
+ TransferCapOptions,
25
+ BurnCapOptions,
26
+ ListCapsOptions,
27
+ GetOrCreateCapOptions,
28
+ MemoryCapList,
29
+ ComputeKeyIdOptions
30
+ } from '../core/types/capability';
31
+
32
+ /**
33
+ * Configuration for CapabilityService
34
+ */
35
+ export interface CapabilityServiceConfig {
36
+ /** Sui client instance */
37
+ suiClient: SuiClient;
38
+ /** Package ID for Move contracts */
39
+ packageId: string;
40
+ }
41
+
42
+ /**
43
+ * CapabilityService handles MemoryCap object operations
44
+ *
45
+ * Implements the SEAL PrivateData pattern for simplified access control.
46
+ */
47
+ export class CapabilityService {
48
+ private suiClient: SuiClient;
49
+ private packageId: string;
50
+
51
+ constructor(config: CapabilityServiceConfig) {
52
+ this.suiClient = config.suiClient;
53
+ this.packageId = config.packageId;
54
+ }
55
+
56
+ /**
57
+ * Create a new MemoryCap for an app context
58
+ *
59
+ * @param options - Creation options
60
+ * @param signer - Transaction signer
61
+ * @returns Created MemoryCap
62
+ */
63
+ async create(
64
+ options: CreateMemoryCapOptions,
65
+ signer: any
66
+ ): Promise<MemoryCap> {
67
+ const tx = new Transaction();
68
+
69
+ tx.moveCall({
70
+ target: `${this.packageId}::capability::create_memory_cap`,
71
+ arguments: [
72
+ tx.pure.string(options.appId),
73
+ ],
74
+ });
75
+
76
+ // Use signer's signAndExecuteTransaction for browser wallet compatibility
77
+ let result: any;
78
+ if ('signAndExecuteTransaction' in signer && typeof signer.signAndExecuteTransaction === 'function') {
79
+ // Browser wallet (DappKitSigner) - call signAndExecuteTransaction directly
80
+ result = await signer.signAndExecuteTransaction(tx);
81
+ } else {
82
+ // Server-side signer - use SuiClient
83
+ result = await this.suiClient.signAndExecuteTransaction({
84
+ transaction: tx,
85
+ signer,
86
+ options: {
87
+ showEffects: true,
88
+ showEvents: true,
89
+ showObjectChanges: true,
90
+ },
91
+ });
92
+ }
93
+
94
+ // Wait for transaction to be finalized to prevent gas coin version conflicts
95
+ if (result.digest) {
96
+ await this.suiClient.waitForTransaction({ digest: result.digest });
97
+ }
98
+
99
+ if (result.effects?.status?.status !== 'success') {
100
+ throw new Error(`Failed to create MemoryCap: ${result.effects?.status?.error}`);
101
+ }
102
+
103
+ // Extract created MemoryCap from events
104
+ const createdEvent = result.events?.find(
105
+ (event: any) => event.type.includes('::capability::MemoryCapCreated')
106
+ );
107
+
108
+ if (!createdEvent) {
109
+ throw new Error('MemoryCapCreated event not found');
110
+ }
111
+
112
+ const eventData = createdEvent.parsedJson as any;
113
+
114
+ // Convert nonce from bytes array to hex string (same as in list())
115
+ const nonceBytes: number[] = Array.isArray(eventData.nonce)
116
+ ? eventData.nonce
117
+ : [];
118
+ const nonceHex = nonceBytes
119
+ .map((b: number) => b.toString(16).padStart(2, '0'))
120
+ .join('');
121
+
122
+ return {
123
+ id: eventData.cap_id,
124
+ nonce: nonceHex,
125
+ appId: eventData.app_id,
126
+ owner: eventData.owner,
127
+ createdAt: eventData.created_at,
128
+ };
129
+ }
130
+
131
+ /**
132
+ * Get a MemoryCap by app ID for a user
133
+ *
134
+ * @param userAddress - User's Sui address
135
+ * @param appId - Application identifier
136
+ * @returns MemoryCap or null if not found
137
+ */
138
+ async get(userAddress: string, appId: string): Promise<MemoryCap | null> {
139
+ const caps = await this.list({ userAddress, appId });
140
+ return caps.length > 0 ? caps[0] : null;
141
+ }
142
+
143
+ /**
144
+ * Get or create a MemoryCap for an app context
145
+ *
146
+ * @param options - Get or create options
147
+ * @param signer - Transaction signer (required for creation)
148
+ * @returns Existing or newly created MemoryCap
149
+ */
150
+ async getOrCreate(
151
+ options: GetOrCreateCapOptions,
152
+ signer: any
153
+ ): Promise<MemoryCap> {
154
+ const userAddress = options.userAddress || await signer.getPublicKey?.()?.toSuiAddress?.() || '';
155
+
156
+ // Try to get existing capability
157
+ const existing = await this.get(userAddress, options.appId);
158
+ if (existing) {
159
+ return existing;
160
+ }
161
+
162
+ // Create new capability
163
+ return await this.create({ appId: options.appId }, signer);
164
+ }
165
+
166
+ /**
167
+ * List all MemoryCaps owned by a user
168
+ *
169
+ * @param options - List options (filter by appId, userAddress)
170
+ * @returns Array of MemoryCaps
171
+ */
172
+ async list(options?: ListCapsOptions): Promise<MemoryCap[]> {
173
+ const userAddress = options?.userAddress;
174
+ if (!userAddress) {
175
+ throw new Error('userAddress is required for listing capabilities');
176
+ }
177
+
178
+ const response = await this.suiClient.getOwnedObjects({
179
+ owner: userAddress,
180
+ filter: {
181
+ StructType: `${this.packageId}::capability::MemoryCap`
182
+ },
183
+ options: {
184
+ showContent: true,
185
+ showType: true,
186
+ },
187
+ });
188
+
189
+ const caps: MemoryCap[] = [];
190
+
191
+ for (const obj of response.data) {
192
+ if (!obj.data?.content || obj.data.content.dataType !== 'moveObject') {
193
+ continue;
194
+ }
195
+
196
+ const fields = obj.data.content.fields as any;
197
+ const appId = fields.app_id;
198
+
199
+ // Filter by appId if specified
200
+ if (options?.appId && appId !== options.appId) {
201
+ continue;
202
+ }
203
+
204
+ // Convert nonce from bytes to hex string
205
+ const nonceBytes: number[] = Array.isArray(fields.nonce)
206
+ ? fields.nonce
207
+ : [];
208
+ const nonceHex = nonceBytes
209
+ .map((b: number) => b.toString(16).padStart(2, '0'))
210
+ .join('');
211
+
212
+ caps.push({
213
+ id: obj.data.objectId,
214
+ nonce: nonceHex,
215
+ appId,
216
+ owner: userAddress,
217
+ });
218
+ }
219
+
220
+ return caps;
221
+ }
222
+
223
+ /**
224
+ * Transfer a MemoryCap to another address
225
+ *
226
+ * After transfer:
227
+ * - New owner can call seal_approve
228
+ * - New owner can decrypt memories
229
+ * - Original owner loses access
230
+ *
231
+ * @param options - Transfer options
232
+ * @param signer - Transaction signer
233
+ */
234
+ async transfer(options: TransferCapOptions, signer: any): Promise<void> {
235
+ const tx = new Transaction();
236
+
237
+ tx.moveCall({
238
+ target: `${this.packageId}::capability::transfer_cap`,
239
+ arguments: [
240
+ tx.object(options.capId),
241
+ tx.pure.address(options.recipient),
242
+ ],
243
+ });
244
+
245
+ const result = await this.suiClient.signAndExecuteTransaction({
246
+ transaction: tx,
247
+ signer,
248
+ options: {
249
+ showEffects: true,
250
+ showEvents: true,
251
+ },
252
+ });
253
+
254
+ // Wait for transaction to be finalized to prevent gas coin version conflicts
255
+ if (result.digest) {
256
+ await this.suiClient.waitForTransaction({ digest: result.digest });
257
+ }
258
+
259
+ if (result.effects?.status?.status !== 'success') {
260
+ throw new Error(`Failed to transfer MemoryCap: ${result.effects?.status?.error}`);
261
+ }
262
+ }
263
+
264
+ /**
265
+ * Burn (revoke) a MemoryCap
266
+ *
267
+ * This permanently revokes the capability.
268
+ * After burning:
269
+ * - No one can decrypt memories for this context
270
+ * - Object is permanently deleted
271
+ *
272
+ * @param options - Burn options
273
+ * @param signer - Transaction signer
274
+ */
275
+ async burn(options: BurnCapOptions, signer: any): Promise<void> {
276
+ const tx = new Transaction();
277
+
278
+ tx.moveCall({
279
+ target: `${this.packageId}::capability::burn_cap`,
280
+ arguments: [
281
+ tx.object(options.capId),
282
+ ],
283
+ });
284
+
285
+ const result = await this.suiClient.signAndExecuteTransaction({
286
+ transaction: tx,
287
+ signer,
288
+ options: {
289
+ showEffects: true,
290
+ showEvents: true,
291
+ },
292
+ });
293
+
294
+ // Wait for transaction to be finalized to prevent gas coin version conflicts
295
+ if (result.digest) {
296
+ await this.suiClient.waitForTransaction({ digest: result.digest });
297
+ }
298
+
299
+ if (result.effects?.status?.status !== 'success') {
300
+ throw new Error(`Failed to burn MemoryCap: ${result.effects?.status?.error}`);
301
+ }
302
+ }
303
+
304
+ /**
305
+ * Compute SEAL key ID for a capability
306
+ *
307
+ * key_id = keccak256(owner || nonce)
308
+ *
309
+ * @param cap - MemoryCap object
310
+ * @returns Key ID as hex string
311
+ */
312
+ computeKeyId(cap: MemoryCap): string {
313
+ return this.computeKeyIdFromParts({
314
+ owner: cap.owner,
315
+ nonce: cap.nonce,
316
+ });
317
+ }
318
+
319
+ /**
320
+ * Compute SEAL key ID from owner and nonce
321
+ *
322
+ * @param options - Owner address and nonce
323
+ * @returns Key ID as hex string
324
+ */
325
+ computeKeyIdFromParts(options: ComputeKeyIdOptions): string {
326
+ // Convert owner address to bytes (32 bytes for Sui address)
327
+ const ownerBytes = this.addressToBytes(options.owner);
328
+
329
+ // Convert nonce from hex string to bytes
330
+ const nonceBytes = this.hexToBytes(options.nonce);
331
+
332
+ // Concatenate: owner || nonce
333
+ const data = new Uint8Array(ownerBytes.length + nonceBytes.length);
334
+ data.set(ownerBytes, 0);
335
+ data.set(nonceBytes, ownerBytes.length);
336
+
337
+ // Hash with keccak256 (NOT sha3_256 - they use different padding!)
338
+ const hash = keccak_256(data);
339
+
340
+ // Return as hex string
341
+ return '0x' + Array.from(hash)
342
+ .map((b: number) => b.toString(16).padStart(2, '0'))
343
+ .join('');
344
+ }
345
+
346
+ /**
347
+ * Get MemoryCap object by ID
348
+ *
349
+ * @param capId - Capability object ID
350
+ * @returns MemoryCap or null
351
+ */
352
+ async getById(capId: string): Promise<MemoryCap | null> {
353
+ try {
354
+ const response = await this.suiClient.getObject({
355
+ id: capId,
356
+ options: {
357
+ showContent: true,
358
+ showOwner: true,
359
+ },
360
+ });
361
+
362
+ if (!response.data?.content || response.data.content.dataType !== 'moveObject') {
363
+ return null;
364
+ }
365
+
366
+ const fields = response.data.content.fields as any;
367
+
368
+ // Get owner from object ownership
369
+ let owner = '';
370
+ if (response.data.owner && typeof response.data.owner === 'object') {
371
+ if ('AddressOwner' in response.data.owner) {
372
+ owner = response.data.owner.AddressOwner;
373
+ }
374
+ }
375
+
376
+ // Convert nonce
377
+ const nonceBytes: number[] = Array.isArray(fields.nonce)
378
+ ? fields.nonce
379
+ : [];
380
+ const nonceHex = nonceBytes
381
+ .map((b: number) => b.toString(16).padStart(2, '0'))
382
+ .join('');
383
+
384
+ return {
385
+ id: capId,
386
+ nonce: nonceHex,
387
+ appId: fields.app_id,
388
+ owner,
389
+ };
390
+ } catch (error) {
391
+ console.error('Error fetching MemoryCap by ID:', error);
392
+ return null;
393
+ }
394
+ }
395
+
396
+ /**
397
+ * Check if user has capability for an app context
398
+ *
399
+ * @param userAddress - User's Sui address
400
+ * @param appId - Application identifier
401
+ * @returns True if capability exists
402
+ */
403
+ async hasCapability(userAddress: string, appId: string): Promise<boolean> {
404
+ const cap = await this.get(userAddress, appId);
405
+ return cap !== null;
406
+ }
407
+
408
+ /**
409
+ * Build transaction for creating MemoryCap (for PTB composition)
410
+ *
411
+ * @param tx - Transaction to add call to
412
+ * @param appId - Application identifier
413
+ */
414
+ buildCreateCall(tx: Transaction, appId: string): void {
415
+ tx.moveCall({
416
+ target: `${this.packageId}::capability::create_memory_cap`,
417
+ arguments: [
418
+ tx.pure.string(appId),
419
+ ],
420
+ });
421
+ }
422
+
423
+ /**
424
+ * Build seal_approve transaction argument
425
+ *
426
+ * @param tx - Transaction to add call to
427
+ * @param capId - Capability object ID
428
+ * @param keyId - SEAL key ID (as hex string)
429
+ */
430
+ buildSealApproveCall(tx: Transaction, capId: string, keyId: string): void {
431
+ const keyIdBytes = this.hexToBytes(keyId);
432
+
433
+ tx.moveCall({
434
+ target: `${this.packageId}::capability::seal_approve`,
435
+ arguments: [
436
+ tx.object(capId),
437
+ tx.pure(bcs.vector(bcs.u8()).serialize(Array.from(keyIdBytes))),
438
+ ],
439
+ });
440
+ }
441
+
442
+ // ========== Private Helper Methods ==========
443
+
444
+ private addressToBytes(address: string): Uint8Array {
445
+ // Remove 0x prefix if present
446
+ const cleanAddr = address.startsWith('0x') ? address.slice(2) : address;
447
+
448
+ // Sui addresses are 32 bytes (64 hex chars)
449
+ const padded = cleanAddr.padStart(64, '0');
450
+
451
+ return this.hexToBytes(padded);
452
+ }
453
+
454
+ private hexToBytes(hex: string): Uint8Array {
455
+ const cleanHex = hex.startsWith('0x') ? hex.slice(2) : hex;
456
+ const bytes = new Uint8Array(cleanHex.length / 2);
457
+
458
+ for (let i = 0; i < cleanHex.length; i += 2) {
459
+ bytes[i / 2] = parseInt(cleanHex.slice(i, i + 2), 16);
460
+ }
461
+
462
+ return bytes;
463
+ }
464
+ }