@originals/sdk 1.2.0 → 1.4.2

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 (244) hide show
  1. package/package.json +1 -1
  2. package/src/did/DIDManager.ts +1 -1
  3. package/src/did/WebVHManager.ts +11 -2
  4. package/src/examples/create-module-original.ts +435 -0
  5. package/src/examples/full-lifecycle-flow.ts +514 -0
  6. package/src/examples/run.ts +59 -4
  7. package/src/index.ts +69 -3
  8. package/src/kinds/KindRegistry.ts +290 -0
  9. package/src/kinds/index.ts +74 -0
  10. package/src/kinds/types.ts +470 -0
  11. package/src/kinds/validators/AgentValidator.ts +257 -0
  12. package/src/kinds/validators/AppValidator.ts +211 -0
  13. package/src/kinds/validators/DatasetValidator.ts +242 -0
  14. package/src/kinds/validators/DocumentValidator.ts +311 -0
  15. package/src/kinds/validators/MediaValidator.ts +269 -0
  16. package/src/kinds/validators/ModuleValidator.ts +225 -0
  17. package/src/kinds/validators/base.ts +276 -0
  18. package/src/kinds/validators/index.ts +12 -0
  19. package/src/lifecycle/LifecycleManager.ts +909 -1
  20. package/src/resources/ResourceManager.ts +655 -0
  21. package/src/resources/index.ts +21 -0
  22. package/src/resources/types.ts +202 -0
  23. package/src/types/common.ts +1 -1
  24. package/src/vc/CredentialManager.ts +647 -2
  25. package/tests/integration/createTypedOriginal.test.ts +379 -0
  26. package/tests/performance/BatchOperations.perf.test.ts +2 -2
  27. package/tests/unit/kinds/KindRegistry.test.ts +329 -0
  28. package/tests/unit/kinds/types.test.ts +409 -0
  29. package/tests/unit/kinds/validators.test.ts +651 -0
  30. package/tests/unit/lifecycle/LifecycleManager.cleanapi.test.ts +441 -0
  31. package/tests/unit/resources/ResourceManager.test.ts +740 -0
  32. package/tests/unit/vc/CredentialManager.helpers.test.ts +527 -0
  33. package/.turbo/turbo-build.log +0 -1
  34. package/dist/adapters/FeeOracleMock.d.ts +0 -6
  35. package/dist/adapters/FeeOracleMock.js +0 -8
  36. package/dist/adapters/index.d.ts +0 -4
  37. package/dist/adapters/index.js +0 -4
  38. package/dist/adapters/providers/OrdHttpProvider.d.ts +0 -56
  39. package/dist/adapters/providers/OrdHttpProvider.js +0 -110
  40. package/dist/adapters/providers/OrdMockProvider.d.ts +0 -70
  41. package/dist/adapters/providers/OrdMockProvider.js +0 -75
  42. package/dist/adapters/types.d.ts +0 -71
  43. package/dist/adapters/types.js +0 -1
  44. package/dist/bitcoin/BitcoinManager.d.ts +0 -15
  45. package/dist/bitcoin/BitcoinManager.js +0 -262
  46. package/dist/bitcoin/BroadcastClient.d.ts +0 -30
  47. package/dist/bitcoin/BroadcastClient.js +0 -35
  48. package/dist/bitcoin/OrdinalsClient.d.ts +0 -21
  49. package/dist/bitcoin/OrdinalsClient.js +0 -105
  50. package/dist/bitcoin/PSBTBuilder.d.ts +0 -24
  51. package/dist/bitcoin/PSBTBuilder.js +0 -80
  52. package/dist/bitcoin/fee-calculation.d.ts +0 -14
  53. package/dist/bitcoin/fee-calculation.js +0 -31
  54. package/dist/bitcoin/providers/OrdNodeProvider.d.ts +0 -38
  55. package/dist/bitcoin/providers/OrdNodeProvider.js +0 -67
  56. package/dist/bitcoin/providers/OrdinalsProvider.d.ts +0 -33
  57. package/dist/bitcoin/providers/OrdinalsProvider.js +0 -50
  58. package/dist/bitcoin/providers/types.d.ts +0 -63
  59. package/dist/bitcoin/providers/types.js +0 -1
  60. package/dist/bitcoin/transactions/commit.d.ts +0 -89
  61. package/dist/bitcoin/transactions/commit.js +0 -311
  62. package/dist/bitcoin/transactions/index.d.ts +0 -7
  63. package/dist/bitcoin/transactions/index.js +0 -8
  64. package/dist/bitcoin/transfer.d.ts +0 -9
  65. package/dist/bitcoin/transfer.js +0 -26
  66. package/dist/bitcoin/utxo-selection.d.ts +0 -78
  67. package/dist/bitcoin/utxo-selection.js +0 -237
  68. package/dist/bitcoin/utxo.d.ts +0 -26
  69. package/dist/bitcoin/utxo.js +0 -78
  70. package/dist/contexts/credentials-v1.json +0 -195
  71. package/dist/contexts/credentials-v2-examples.json +0 -5
  72. package/dist/contexts/credentials-v2.json +0 -301
  73. package/dist/contexts/credentials.json +0 -195
  74. package/dist/contexts/data-integrity-v2.json +0 -81
  75. package/dist/contexts/dids.json +0 -57
  76. package/dist/contexts/ed255192020.json +0 -93
  77. package/dist/contexts/ordinals-plus.json +0 -23
  78. package/dist/contexts/originals.json +0 -22
  79. package/dist/core/OriginalsSDK.d.ts +0 -158
  80. package/dist/core/OriginalsSDK.js +0 -274
  81. package/dist/crypto/Multikey.d.ts +0 -30
  82. package/dist/crypto/Multikey.js +0 -149
  83. package/dist/crypto/Signer.d.ts +0 -21
  84. package/dist/crypto/Signer.js +0 -196
  85. package/dist/crypto/noble-init.d.ts +0 -18
  86. package/dist/crypto/noble-init.js +0 -106
  87. package/dist/did/BtcoDidResolver.d.ts +0 -57
  88. package/dist/did/BtcoDidResolver.js +0 -166
  89. package/dist/did/DIDManager.d.ts +0 -101
  90. package/dist/did/DIDManager.js +0 -493
  91. package/dist/did/Ed25519Verifier.d.ts +0 -30
  92. package/dist/did/Ed25519Verifier.js +0 -59
  93. package/dist/did/KeyManager.d.ts +0 -17
  94. package/dist/did/KeyManager.js +0 -207
  95. package/dist/did/WebVHManager.d.ts +0 -100
  96. package/dist/did/WebVHManager.js +0 -304
  97. package/dist/did/createBtcoDidDocument.d.ts +0 -10
  98. package/dist/did/createBtcoDidDocument.js +0 -42
  99. package/dist/did/providers/OrdinalsClientProviderAdapter.d.ts +0 -23
  100. package/dist/did/providers/OrdinalsClientProviderAdapter.js +0 -51
  101. package/dist/events/EventEmitter.d.ts +0 -115
  102. package/dist/events/EventEmitter.js +0 -198
  103. package/dist/events/index.d.ts +0 -7
  104. package/dist/events/index.js +0 -6
  105. package/dist/events/types.d.ts +0 -286
  106. package/dist/events/types.js +0 -9
  107. package/dist/examples/basic-usage.d.ts +0 -3
  108. package/dist/examples/basic-usage.js +0 -62
  109. package/dist/examples/run.d.ts +0 -1
  110. package/dist/examples/run.js +0 -4
  111. package/dist/index.d.ts +0 -39
  112. package/dist/index.js +0 -47
  113. package/dist/lifecycle/BatchOperations.d.ts +0 -147
  114. package/dist/lifecycle/BatchOperations.js +0 -251
  115. package/dist/lifecycle/LifecycleManager.d.ts +0 -116
  116. package/dist/lifecycle/LifecycleManager.js +0 -971
  117. package/dist/lifecycle/OriginalsAsset.d.ts +0 -164
  118. package/dist/lifecycle/OriginalsAsset.js +0 -380
  119. package/dist/lifecycle/ProvenanceQuery.d.ts +0 -126
  120. package/dist/lifecycle/ProvenanceQuery.js +0 -220
  121. package/dist/lifecycle/ResourceVersioning.d.ts +0 -73
  122. package/dist/lifecycle/ResourceVersioning.js +0 -127
  123. package/dist/migration/MigrationManager.d.ts +0 -86
  124. package/dist/migration/MigrationManager.js +0 -412
  125. package/dist/migration/audit/AuditLogger.d.ts +0 -51
  126. package/dist/migration/audit/AuditLogger.js +0 -156
  127. package/dist/migration/checkpoint/CheckpointManager.d.ts +0 -31
  128. package/dist/migration/checkpoint/CheckpointManager.js +0 -96
  129. package/dist/migration/checkpoint/CheckpointStorage.d.ts +0 -26
  130. package/dist/migration/checkpoint/CheckpointStorage.js +0 -89
  131. package/dist/migration/index.d.ts +0 -22
  132. package/dist/migration/index.js +0 -27
  133. package/dist/migration/operations/BaseMigration.d.ts +0 -48
  134. package/dist/migration/operations/BaseMigration.js +0 -83
  135. package/dist/migration/operations/PeerToBtcoMigration.d.ts +0 -25
  136. package/dist/migration/operations/PeerToBtcoMigration.js +0 -67
  137. package/dist/migration/operations/PeerToWebvhMigration.d.ts +0 -19
  138. package/dist/migration/operations/PeerToWebvhMigration.js +0 -46
  139. package/dist/migration/operations/WebvhToBtcoMigration.d.ts +0 -25
  140. package/dist/migration/operations/WebvhToBtcoMigration.js +0 -67
  141. package/dist/migration/rollback/RollbackManager.d.ts +0 -29
  142. package/dist/migration/rollback/RollbackManager.js +0 -146
  143. package/dist/migration/state/StateMachine.d.ts +0 -25
  144. package/dist/migration/state/StateMachine.js +0 -76
  145. package/dist/migration/state/StateTracker.d.ts +0 -36
  146. package/dist/migration/state/StateTracker.js +0 -123
  147. package/dist/migration/types.d.ts +0 -306
  148. package/dist/migration/types.js +0 -33
  149. package/dist/migration/validation/BitcoinValidator.d.ts +0 -13
  150. package/dist/migration/validation/BitcoinValidator.js +0 -83
  151. package/dist/migration/validation/CredentialValidator.d.ts +0 -13
  152. package/dist/migration/validation/CredentialValidator.js +0 -46
  153. package/dist/migration/validation/DIDCompatibilityValidator.d.ts +0 -16
  154. package/dist/migration/validation/DIDCompatibilityValidator.js +0 -127
  155. package/dist/migration/validation/LifecycleValidator.d.ts +0 -10
  156. package/dist/migration/validation/LifecycleValidator.js +0 -52
  157. package/dist/migration/validation/StorageValidator.d.ts +0 -10
  158. package/dist/migration/validation/StorageValidator.js +0 -65
  159. package/dist/migration/validation/ValidationPipeline.d.ts +0 -29
  160. package/dist/migration/validation/ValidationPipeline.js +0 -180
  161. package/dist/storage/LocalStorageAdapter.d.ts +0 -11
  162. package/dist/storage/LocalStorageAdapter.js +0 -53
  163. package/dist/storage/MemoryStorageAdapter.d.ts +0 -6
  164. package/dist/storage/MemoryStorageAdapter.js +0 -21
  165. package/dist/storage/StorageAdapter.d.ts +0 -16
  166. package/dist/storage/StorageAdapter.js +0 -1
  167. package/dist/storage/index.d.ts +0 -2
  168. package/dist/storage/index.js +0 -2
  169. package/dist/types/bitcoin.d.ts +0 -84
  170. package/dist/types/bitcoin.js +0 -1
  171. package/dist/types/common.d.ts +0 -82
  172. package/dist/types/common.js +0 -1
  173. package/dist/types/credentials.d.ts +0 -75
  174. package/dist/types/credentials.js +0 -1
  175. package/dist/types/did.d.ts +0 -26
  176. package/dist/types/did.js +0 -1
  177. package/dist/types/index.d.ts +0 -5
  178. package/dist/types/index.js +0 -5
  179. package/dist/types/network.d.ts +0 -78
  180. package/dist/types/network.js +0 -145
  181. package/dist/utils/EventLogger.d.ts +0 -71
  182. package/dist/utils/EventLogger.js +0 -232
  183. package/dist/utils/Logger.d.ts +0 -106
  184. package/dist/utils/Logger.js +0 -257
  185. package/dist/utils/MetricsCollector.d.ts +0 -110
  186. package/dist/utils/MetricsCollector.js +0 -264
  187. package/dist/utils/bitcoin-address.d.ts +0 -38
  188. package/dist/utils/bitcoin-address.js +0 -113
  189. package/dist/utils/cbor.d.ts +0 -2
  190. package/dist/utils/cbor.js +0 -9
  191. package/dist/utils/encoding.d.ts +0 -37
  192. package/dist/utils/encoding.js +0 -120
  193. package/dist/utils/hash.d.ts +0 -1
  194. package/dist/utils/hash.js +0 -5
  195. package/dist/utils/retry.d.ts +0 -10
  196. package/dist/utils/retry.js +0 -35
  197. package/dist/utils/satoshi-validation.d.ts +0 -60
  198. package/dist/utils/satoshi-validation.js +0 -156
  199. package/dist/utils/serialization.d.ts +0 -14
  200. package/dist/utils/serialization.js +0 -76
  201. package/dist/utils/telemetry.d.ts +0 -17
  202. package/dist/utils/telemetry.js +0 -24
  203. package/dist/utils/validation.d.ts +0 -5
  204. package/dist/utils/validation.js +0 -98
  205. package/dist/vc/CredentialManager.d.ts +0 -22
  206. package/dist/vc/CredentialManager.js +0 -227
  207. package/dist/vc/Issuer.d.ts +0 -27
  208. package/dist/vc/Issuer.js +0 -70
  209. package/dist/vc/Verifier.d.ts +0 -16
  210. package/dist/vc/Verifier.js +0 -50
  211. package/dist/vc/cryptosuites/bbs.d.ts +0 -44
  212. package/dist/vc/cryptosuites/bbs.js +0 -213
  213. package/dist/vc/cryptosuites/bbsSimple.d.ts +0 -9
  214. package/dist/vc/cryptosuites/bbsSimple.js +0 -12
  215. package/dist/vc/cryptosuites/eddsa.d.ts +0 -30
  216. package/dist/vc/cryptosuites/eddsa.js +0 -81
  217. package/dist/vc/documentLoader.d.ts +0 -16
  218. package/dist/vc/documentLoader.js +0 -59
  219. package/dist/vc/proofs/data-integrity.d.ts +0 -21
  220. package/dist/vc/proofs/data-integrity.js +0 -15
  221. package/dist/vc/utils/jsonld.d.ts +0 -2
  222. package/dist/vc/utils/jsonld.js +0 -15
  223. package/test/logs/did_webvh_QmNTn9Kkp8dQ75WrF9xqJ2kuDp9QhKc3aPiERRMj8XoTBN_example_com.jsonl +0 -1
  224. package/test/logs/did_webvh_QmNu4MNr8Lr5txx5gYNhuhZDchXsZEu3hJXKYuphpWTPDp_example_com_users_etc_passwd.jsonl +0 -1
  225. package/test/logs/did_webvh_QmR9MrGZACzjKETA8SBRNCKG11HxU85c4bVR2qN5eDCfsD_example_com.jsonl +0 -1
  226. package/test/logs/did_webvh_QmUc5suaqRM2P4nrXxZwqYMfqzhdMqjuL7oJaJbEpCQVCd_example_com_users_etc_passwd.jsonl +0 -1
  227. package/test/logs/did_webvh_QmUkiB2RCV2VZ1RTXsCebWN25Eiy9TLvpzDWAJNjhgvB4X_example_com_etc_passwd.jsonl +0 -1
  228. package/test/logs/did_webvh_QmUoRTe8UMwpAQXZSAW7pjAgZK1tq2X3C6Kfxq3UXGcaGy_example_com_secret.jsonl +0 -1
  229. package/test/logs/did_webvh_QmWWot3chx1t6KwTmcE5i2FeDZ5JMkQw3qXycsKDVmJ9Be_example_com_users_alice.jsonl +0 -1
  230. package/test/logs/did_webvh_QmWvVgALL5kjZdpgR7KZay7J8UiiUr834kkRmWeFAxjAuC_example_com_users_etc_passwd.jsonl +0 -1
  231. package/test/logs/did_webvh_QmWwaRQHUZAFcKihFC6xR6tRTTrQhHPTku6azf1egWbpy1_example_com_users_alice.jsonl +0 -1
  232. package/test/logs/did_webvh_QmXJLtkz23r7AozbtXsZMKWnVU6rd38CkVtjdWuATU3Yp6_example_com_users_alice123_profile.jsonl +0 -1
  233. package/test/logs/did_webvh_QmYsce448po14oDE1wXbyaP6wY9HQgHSKLwdezn1k577SF_example_com_my_org_user_name_test_123.jsonl +0 -1
  234. package/test/logs/did_webvh_QmZBeNzzqajxdfwcDUPZ4P8C5YSXyRztrAwmPiKuKUxmAK_example_com.jsonl +0 -1
  235. package/test/logs/did_webvh_QmZhJsqxizwVbRtqCUkmE6XQunSxtxMt3gbTYadVBNAaEq_example_com.jsonl +0 -1
  236. package/test/logs/did_webvh_QmZk7NHU2D57RzzbMq4tWW9gBa9AqtVTWfiRM6RFdwGVj2_example_com.jsonl +0 -1
  237. package/test/logs/did_webvh_QmZshSXp9w8ovH62zGGBS1b5pGGPsuYiu1VQ935sga2hWF_example_com_level1_level2.jsonl +0 -1
  238. package/test/logs/did_webvh_QmbWAmw7HQL7vKJyCsctZihXf1rmT4sGvggKCPKWcUWjw1_example_com.jsonl +0 -1
  239. package/test/logs/did_webvh_QmbdLUMbYs3juR39TLB6hhrFWLcNg45ybUzeBJCS1MhCh1_example_com_C_Windows_System32.jsonl +0 -1
  240. package/test/logs/did_webvh_QmcaQ1Ma4gkSbae85aCm8Mv4rvdT2Sb2RR3JzYwrm5XBq8_example_com_etc_passwd.jsonl +0 -1
  241. package/test/logs/did_webvh_QmcbA7WQhsBqZSoDpKJHjV8Q5o53h8vmgJhQfo6rqTY5ho_example_com.jsonl +0 -1
  242. package/test/logs/did_webvh_Qmdy8uWr2gkUJrXsThynAug3DASTWwb3onEj89LKmMGZYB_example_com.jsonl +0 -1
  243. package/tests/e2e/README.md +0 -97
  244. package/tests/e2e/example.spec.ts +0 -78
@@ -1,207 +0,0 @@
1
- // Initialize noble crypto libraries first (idempotent - safe to import multiple times)
2
- import '../crypto/noble-init.js';
3
- import * as secp256k1 from '@noble/secp256k1';
4
- import * as ed25519 from '@noble/ed25519';
5
- import { p256 } from '@noble/curves/p256';
6
- import { multikey } from '../crypto/Multikey';
7
- function toMultikeyType(type) {
8
- if (type === 'ES256K')
9
- return 'Secp256k1';
10
- if (type === 'Ed25519')
11
- return 'Ed25519';
12
- if (type === 'ES256')
13
- return 'P256';
14
- throw new Error(`Unsupported key type: ${type}`);
15
- }
16
- function fromMultikeyType(type) {
17
- if (type === 'Secp256k1')
18
- return 'ES256K';
19
- if (type === 'Ed25519')
20
- return 'Ed25519';
21
- if (type === 'P256')
22
- return 'ES256';
23
- throw new Error('Unsupported key type');
24
- }
25
- export class KeyManager {
26
- constructor() {
27
- // Noble crypto libraries are initialized via noble-init.ts (imported at SDK entry point)
28
- // No initialization needed here
29
- }
30
- async generateKeyPair(type) {
31
- if (type === 'ES256K') {
32
- const privateKeyBytes = secp256k1.utils.randomPrivateKey();
33
- const publicKeyBytes = secp256k1.getPublicKey(privateKeyBytes, true);
34
- return {
35
- privateKey: multikey.encodePrivateKey(privateKeyBytes, 'Secp256k1'),
36
- publicKey: multikey.encodePublicKey(publicKeyBytes, 'Secp256k1')
37
- };
38
- }
39
- if (type === 'Ed25519') {
40
- const privateKeyBytes = ed25519.utils.randomPrivateKey();
41
- const publicKeyBytes = await ed25519.getPublicKeyAsync(privateKeyBytes);
42
- return {
43
- privateKey: multikey.encodePrivateKey(privateKeyBytes, 'Ed25519'),
44
- publicKey: multikey.encodePublicKey(publicKeyBytes, 'Ed25519')
45
- };
46
- }
47
- if (type === 'ES256') {
48
- const privateKeyBytes = p256.utils.randomPrivateKey();
49
- const publicKeyBytes = p256.getPublicKey(privateKeyBytes, true);
50
- return {
51
- privateKey: multikey.encodePrivateKey(privateKeyBytes, 'P256'),
52
- publicKey: multikey.encodePublicKey(publicKeyBytes, 'P256')
53
- };
54
- }
55
- throw new Error(`Unsupported key type: ${type}`);
56
- }
57
- async rotateKeys(didDoc, newKeyPair) {
58
- const multikeyContext = 'https://w3id.org/security/multikey/v1';
59
- const securityContext = 'https://w3id.org/security/v1';
60
- // Ensure required contexts are present
61
- const updatedContext = [...didDoc['@context']];
62
- if (!updatedContext.includes(multikeyContext)) {
63
- updatedContext.push(multikeyContext);
64
- }
65
- if (!updatedContext.includes(securityContext)) {
66
- updatedContext.push(securityContext);
67
- }
68
- // Generate new key ID
69
- const existingKeys = didDoc.verificationMethod || [];
70
- const keyIndex = existingKeys.length;
71
- const newKeyId = `${didDoc.id}#keys-${keyIndex}`;
72
- // Mark all existing verification methods as revoked with current timestamp
73
- const revokedTimestamp = new Date().toISOString();
74
- const revokedVerificationMethods = existingKeys.map(vm => ({
75
- ...vm,
76
- revoked: revokedTimestamp
77
- }));
78
- // Create new verification method
79
- const newVerificationMethod = {
80
- id: newKeyId,
81
- type: 'Multikey',
82
- controller: didDoc.id,
83
- publicKeyMultibase: newKeyPair.publicKey
84
- };
85
- // Update authentication and assertionMethod arrays to reference only the new key
86
- const newKeyReference = newKeyId;
87
- const updated = {
88
- ...didDoc,
89
- '@context': updatedContext,
90
- verificationMethod: [...revokedVerificationMethods, newVerificationMethod],
91
- authentication: [newKeyReference],
92
- assertionMethod: [newKeyReference]
93
- };
94
- // Preserve other properties if they exist
95
- if (didDoc.keyAgreement) {
96
- updated.keyAgreement = didDoc.keyAgreement;
97
- }
98
- if (didDoc.capabilityInvocation) {
99
- updated.capabilityInvocation = didDoc.capabilityInvocation;
100
- }
101
- if (didDoc.capabilityDelegation) {
102
- updated.capabilityDelegation = didDoc.capabilityDelegation;
103
- }
104
- if (didDoc.service) {
105
- updated.service = didDoc.service;
106
- }
107
- return updated;
108
- }
109
- async recoverFromCompromise(didDoc) {
110
- // Determine key type from existing verification methods or default to Ed25519
111
- let keyType = 'Ed25519';
112
- if (didDoc.verificationMethod && didDoc.verificationMethod.length > 0) {
113
- try {
114
- const firstKey = didDoc.verificationMethod[0];
115
- const decoded = multikey.decodePublicKey(firstKey.publicKeyMultibase);
116
- keyType = fromMultikeyType(decoded.type);
117
- }
118
- catch (e) {
119
- // If decoding fails, use default Ed25519
120
- }
121
- }
122
- // Generate new key pair
123
- const newKeyPair = await this.generateKeyPair(keyType);
124
- // Ensure required contexts
125
- const multikeyContext = 'https://w3id.org/security/multikey/v1';
126
- const securityContext = 'https://w3id.org/security/v1';
127
- const credentialsContext = 'https://www.w3.org/2018/credentials/v1';
128
- const updatedContext = [...didDoc['@context']];
129
- if (!updatedContext.includes(multikeyContext)) {
130
- updatedContext.push(multikeyContext);
131
- }
132
- if (!updatedContext.includes(securityContext)) {
133
- updatedContext.push(securityContext);
134
- }
135
- // Mark all existing verification methods as compromised
136
- const compromisedTimestamp = new Date().toISOString();
137
- const existingKeys = didDoc.verificationMethod || [];
138
- const compromisedVerificationMethods = existingKeys.map(vm => ({
139
- ...vm,
140
- compromised: compromisedTimestamp
141
- }));
142
- // Collect IDs of compromised keys
143
- const previousVerificationMethodIds = existingKeys.map(vm => vm.id);
144
- // Generate new key ID
145
- const keyIndex = existingKeys.length;
146
- const newKeyId = `${didDoc.id}#keys-${keyIndex}`;
147
- // Create new verification method
148
- const newVerificationMethod = {
149
- id: newKeyId,
150
- type: 'Multikey',
151
- controller: didDoc.id,
152
- publicKeyMultibase: newKeyPair.publicKey
153
- };
154
- // Update DID document
155
- const updatedDidDocument = {
156
- ...didDoc,
157
- '@context': updatedContext,
158
- verificationMethod: [...compromisedVerificationMethods, newVerificationMethod],
159
- authentication: [newKeyId],
160
- assertionMethod: [newKeyId]
161
- };
162
- // Preserve other properties
163
- if (didDoc.keyAgreement) {
164
- updatedDidDocument.keyAgreement = didDoc.keyAgreement;
165
- }
166
- if (didDoc.capabilityInvocation) {
167
- updatedDidDocument.capabilityInvocation = didDoc.capabilityInvocation;
168
- }
169
- if (didDoc.capabilityDelegation) {
170
- updatedDidDocument.capabilityDelegation = didDoc.capabilityDelegation;
171
- }
172
- if (didDoc.service) {
173
- updatedDidDocument.service = didDoc.service;
174
- }
175
- // Create recovery credential
176
- const recoveryCredential = {
177
- '@context': [credentialsContext, securityContext],
178
- type: ['VerifiableCredential', 'KeyRecoveryCredential'],
179
- issuer: didDoc.id,
180
- issuanceDate: compromisedTimestamp,
181
- credentialSubject: {
182
- id: didDoc.id,
183
- recoveredAt: compromisedTimestamp,
184
- recoveryReason: 'key_compromise',
185
- previousVerificationMethods: previousVerificationMethodIds,
186
- newVerificationMethod: newKeyId
187
- }
188
- };
189
- return { didDocument: updatedDidDocument, recoveryCredential, newKeyPair };
190
- }
191
- encodePublicKeyMultibase(publicKey, type) {
192
- const mkType = toMultikeyType(type);
193
- return multikey.encodePublicKey(new Uint8Array(publicKey), mkType);
194
- }
195
- decodePublicKeyMultibase(encoded) {
196
- if (!encoded || typeof encoded !== 'string') {
197
- throw new Error('Invalid multibase string');
198
- }
199
- try {
200
- const decoded = multikey.decodePublicKey(encoded);
201
- return { key: Buffer.from(decoded.key), type: fromMultikeyType(decoded.type) };
202
- }
203
- catch {
204
- throw new Error('Invalid multibase string');
205
- }
206
- }
207
- }
@@ -1,100 +0,0 @@
1
- import { DIDDocument, KeyPair, ExternalSigner, ExternalVerifier } from '../types';
2
- interface VerificationMethod {
3
- id?: string;
4
- type: string;
5
- controller?: string;
6
- publicKeyMultibase: string;
7
- secretKeyMultibase?: string;
8
- purpose?: 'authentication' | 'assertionMethod' | 'keyAgreement' | 'capabilityInvocation' | 'capabilityDelegation';
9
- }
10
- interface DIDLogEntry {
11
- versionId: string;
12
- versionTime: string;
13
- parameters: Record<string, unknown>;
14
- state: Record<string, unknown>;
15
- proof?: Record<string, unknown>[];
16
- }
17
- type DIDLog = DIDLogEntry[];
18
- export interface CreateWebVHOptions {
19
- domain: string;
20
- keyPair?: KeyPair;
21
- paths?: string[];
22
- portable?: boolean;
23
- outputDir?: string;
24
- externalSigner?: ExternalSigner;
25
- externalVerifier?: ExternalVerifier;
26
- verificationMethods?: VerificationMethod[];
27
- updateKeys?: string[];
28
- }
29
- export interface CreateWebVHResult {
30
- did: string;
31
- didDocument: DIDDocument;
32
- log: DIDLog;
33
- keyPair: KeyPair;
34
- logPath?: string;
35
- }
36
- /**
37
- * WebVH DID Manager for creating and managing did:webvh identifiers
38
- */
39
- export declare class WebVHManager {
40
- private keyManager;
41
- constructor();
42
- /**
43
- * Creates a new did:webvh DID with proper cryptographic signing
44
- * @param options - Creation options including domain and optional key pair or external signer
45
- * @returns The created DID, document, log, and key pair (if generated)
46
- */
47
- createDIDWebVH(options: CreateWebVHOptions): Promise<CreateWebVHResult>;
48
- /**
49
- * Validates a path segment to prevent directory traversal attacks
50
- * @param segment - Path segment to validate
51
- * @returns true if valid, false otherwise
52
- */
53
- private isValidPathSegment;
54
- /**
55
- * Type guard to validate a DID document structure
56
- * @param doc - Object to validate
57
- * @returns true if the object is a valid DIDDocument
58
- */
59
- private isDIDDocument;
60
- /**
61
- * Saves the DID log to the appropriate did.jsonl path
62
- * @param did - The DID identifier
63
- * @param log - The DID log to save
64
- * @param baseDir - Base directory for saving (e.g., public/.well-known)
65
- * @returns The full path where the log was saved
66
- */
67
- saveDIDLog(did: string, log: DIDLog, baseDir: string): Promise<string>;
68
- /**
69
- * Loads a DID log from a did.jsonl file
70
- * @param logPath - Path to the did.jsonl file
71
- * @returns The loaded DID log
72
- */
73
- loadDIDLog(logPath: string): Promise<DIDLog>;
74
- /**
75
- * Updates a DID:WebVH document
76
- * @param did - The DID to update
77
- * @param currentLog - The current DID log
78
- * @param updates - Updates to apply to the DID document
79
- * @param signer - The signer to use (must be authorized in updateKeys)
80
- * @param verifier - Optional verifier
81
- * @param outputDir - Optional directory to save the updated log
82
- * @returns Updated DID document and log
83
- */
84
- updateDIDWebVH(options: {
85
- did: string;
86
- currentLog: DIDLog;
87
- updates: Partial<DIDDocument>;
88
- signer: ExternalSigner | {
89
- privateKey: string;
90
- publicKey: string;
91
- };
92
- verifier?: ExternalVerifier;
93
- outputDir?: string;
94
- }): Promise<{
95
- didDocument: DIDDocument;
96
- log: DIDLog;
97
- logPath?: string;
98
- }>;
99
- }
100
- export {};
@@ -1,304 +0,0 @@
1
- import { KeyManager } from './KeyManager';
2
- import { multikey } from '../crypto/Multikey';
3
- import { Ed25519Signer } from '../crypto/Signer';
4
- import * as fs from 'fs';
5
- import * as path from 'path';
6
- /**
7
- * Adapter to use Originals SDK signers with didwebvh-ts
8
- */
9
- class OriginalsWebVHSigner {
10
- constructor(privateKeyMultibase, verificationMethod, prepareDataForSigning, options = {}) {
11
- this.privateKeyMultibase = privateKeyMultibase;
12
- this.verificationMethod = options.verificationMethod || verificationMethod;
13
- this.useStaticId = options.useStaticId || false;
14
- this.signer = new Ed25519Signer();
15
- this.prepareDataForSigning = prepareDataForSigning;
16
- }
17
- async sign(input) {
18
- // Prepare the data for signing using didwebvh-ts's canonical approach
19
- const dataToSign = await this.prepareDataForSigning(input.document, input.proof);
20
- // Sign using our Ed25519 signer
21
- const signature = await this.signer.sign(Buffer.from(dataToSign), this.privateKeyMultibase);
22
- // Encode signature as multibase
23
- const proofValue = multikey.encodeMultibase(signature);
24
- return { proofValue };
25
- }
26
- async verify(signature, message, publicKey) {
27
- // Decode the public key to multibase format
28
- const publicKeyMultibase = multikey.encodePublicKey(publicKey, 'Ed25519');
29
- // Verify using our Ed25519 signer
30
- const messageBuffer = Buffer.from(message);
31
- const signatureBuffer = Buffer.from(signature);
32
- return this.signer.verify(messageBuffer, signatureBuffer, publicKeyMultibase);
33
- }
34
- getVerificationMethodId() {
35
- // didwebvh-ts requires verification method to be a did:key: identifier
36
- // Extract the multibase key from the verification method
37
- const publicKeyMultibase = this.verificationMethod?.publicKeyMultibase;
38
- if (!publicKeyMultibase) {
39
- throw new Error('Verification method must have publicKeyMultibase');
40
- }
41
- // Return as did:key format which didwebvh-ts expects
42
- return `did:key:${publicKeyMultibase}`;
43
- }
44
- }
45
- /**
46
- * WebVH DID Manager for creating and managing did:webvh identifiers
47
- */
48
- export class WebVHManager {
49
- constructor() {
50
- this.keyManager = new KeyManager();
51
- }
52
- /**
53
- * Creates a new did:webvh DID with proper cryptographic signing
54
- * @param options - Creation options including domain and optional key pair or external signer
55
- * @returns The created DID, document, log, and key pair (if generated)
56
- */
57
- async createDIDWebVH(options) {
58
- const { domain, keyPair: providedKeyPair, paths = [], portable = false, outputDir, externalSigner, externalVerifier, verificationMethods: providedVerificationMethods, updateKeys: providedUpdateKeys } = options;
59
- // Dynamically import didwebvh-ts to avoid module resolution issues
60
- const mod = await import('didwebvh-ts');
61
- const { createDID, prepareDataForSigning } = mod;
62
- // Runtime validation of imported module
63
- if (typeof createDID !== 'function' || typeof prepareDataForSigning !== 'function') {
64
- throw new Error('Failed to load didwebvh-ts: invalid module exports');
65
- }
66
- let signer;
67
- let verifier;
68
- let keyPair;
69
- let verificationMethods;
70
- let updateKeys;
71
- // Use external signer if provided (e.g., Privy integration)
72
- if (externalSigner) {
73
- if (!providedVerificationMethods || providedVerificationMethods.length === 0) {
74
- throw new Error('verificationMethods are required when using externalSigner');
75
- }
76
- if (!providedUpdateKeys || providedUpdateKeys.length === 0) {
77
- throw new Error('updateKeys are required when using externalSigner');
78
- }
79
- signer = externalSigner;
80
- verifier = externalVerifier || externalSigner; // Use signer as verifier if not provided
81
- verificationMethods = providedVerificationMethods;
82
- updateKeys = providedUpdateKeys;
83
- keyPair = undefined; // No key pair when using external signer
84
- }
85
- else {
86
- // Generate or use provided key pair (Ed25519 for did:webvh)
87
- keyPair = providedKeyPair || await this.keyManager.generateKeyPair('Ed25519');
88
- // Create verification methods
89
- verificationMethods = [
90
- {
91
- type: 'Multikey',
92
- publicKeyMultibase: keyPair.publicKey,
93
- }
94
- ];
95
- // Create signer using our adapter
96
- const internalSigner = new OriginalsWebVHSigner(keyPair.privateKey, verificationMethods[0], prepareDataForSigning, { verificationMethod: verificationMethods[0] });
97
- signer = internalSigner;
98
- verifier = internalSigner; // Use the same signer as verifier
99
- updateKeys = [`did:key:${keyPair.publicKey}`]; // Use did:key format for authorization
100
- }
101
- // Create the DID using didwebvh-ts
102
- const result = await createDID({
103
- domain,
104
- signer,
105
- verifier,
106
- updateKeys,
107
- verificationMethods,
108
- context: [
109
- 'https://www.w3.org/ns/did/v1',
110
- 'https://w3id.org/security/multikey/v1'
111
- ],
112
- paths,
113
- portable,
114
- authentication: ['#key-0'],
115
- assertionMethod: ['#key-0'],
116
- });
117
- // Validate the returned DID document
118
- if (!this.isDIDDocument(result.doc)) {
119
- throw new Error('Invalid DID document returned from createDID');
120
- }
121
- // Save the log to did.jsonl if output directory is provided
122
- let logPath;
123
- if (outputDir) {
124
- logPath = await this.saveDIDLog(result.did, result.log, outputDir);
125
- }
126
- return {
127
- did: result.did,
128
- didDocument: result.doc,
129
- log: result.log,
130
- keyPair: keyPair || { publicKey: '', privateKey: '' }, // Return empty keypair if using external signer
131
- logPath,
132
- };
133
- }
134
- /**
135
- * Validates a path segment to prevent directory traversal attacks
136
- * @param segment - Path segment to validate
137
- * @returns true if valid, false otherwise
138
- */
139
- isValidPathSegment(segment) {
140
- // Reject empty segments, dots, or segments with path separators
141
- if (!segment || segment === '.' || segment === '..') {
142
- return false;
143
- }
144
- // Reject segments containing path separators or other dangerous characters
145
- if (segment.includes('/') || segment.includes('\\') || segment.includes('\0')) {
146
- return false;
147
- }
148
- // Reject absolute paths (starting with / or drive letter on Windows)
149
- if (path.isAbsolute(segment)) {
150
- return false;
151
- }
152
- return true;
153
- }
154
- /**
155
- * Type guard to validate a DID document structure
156
- * @param doc - Object to validate
157
- * @returns true if the object is a valid DIDDocument
158
- */
159
- isDIDDocument(doc) {
160
- if (!doc || typeof doc !== 'object') {
161
- return false;
162
- }
163
- const d = doc;
164
- // Check required fields
165
- if (!Array.isArray(d['@context']) || d['@context'].length === 0) {
166
- return false;
167
- }
168
- if (typeof d.id !== 'string' || !d.id.startsWith('did:')) {
169
- return false;
170
- }
171
- return true;
172
- }
173
- /**
174
- * Saves the DID log to the appropriate did.jsonl path
175
- * @param did - The DID identifier
176
- * @param log - The DID log to save
177
- * @param baseDir - Base directory for saving (e.g., public/.well-known)
178
- * @returns The full path where the log was saved
179
- */
180
- async saveDIDLog(did, log, baseDir) {
181
- // Parse the DID to extract domain and path components
182
- // Format: did:webvh:domain[:port]:path1:path2...
183
- const didParts = did.split(':');
184
- if (didParts.length < 3 || didParts[0] !== 'did' || didParts[1] !== 'webvh') {
185
- throw new Error('Invalid did:webvh format');
186
- }
187
- // Extract path parts (everything after domain)
188
- const pathParts = didParts.slice(3);
189
- // Validate all path segments to prevent directory traversal
190
- for (const segment of pathParts) {
191
- if (!this.isValidPathSegment(segment)) {
192
- throw new Error(`Invalid path segment in DID: "${segment}". Path segments cannot contain '.', '..', path separators, or be absolute paths.`);
193
- }
194
- }
195
- // Extract and sanitize domain for filesystem safety
196
- const rawDomain = decodeURIComponent(didParts[2]);
197
- // Normalize: lowercase and replace any characters not in [a-z0-9._-] with '_'
198
- const safeDomain = rawDomain
199
- .toLowerCase()
200
- .replace(/[^a-z0-9._-]/g, '_');
201
- // Validate the sanitized domain (reject '..' and other dangerous patterns)
202
- if (!this.isValidPathSegment(safeDomain)) {
203
- throw new Error(`Invalid domain segment in DID: "${rawDomain}"`);
204
- }
205
- // Construct the file path with domain isolation
206
- // For did:webvh:example.com:user:alice -> baseDir/did/example.com/user/alice/did.jsonl
207
- // For did:webvh:example.com:alice -> baseDir/did/example.com/alice/did.jsonl
208
- const segments = [safeDomain, ...pathParts];
209
- const didPath = path.join(baseDir, 'did', ...segments, 'did.jsonl');
210
- // Verify the resolved path is still within baseDir (defense in depth)
211
- const resolvedBaseDir = path.resolve(baseDir);
212
- const resolvedPath = path.resolve(didPath);
213
- const relativePath = path.relative(resolvedBaseDir, resolvedPath);
214
- if (relativePath.startsWith('..') || path.isAbsolute(relativePath)) {
215
- throw new Error('Invalid DID path: resolved path is outside base directory');
216
- }
217
- // Create directories if they don't exist
218
- const dirPath = path.dirname(didPath);
219
- await fs.promises.mkdir(dirPath, { recursive: true });
220
- // Convert log to JSONL format (one JSON object per line)
221
- const jsonlContent = log.map((entry) => JSON.stringify(entry)).join('\n');
222
- // Write the log file
223
- await fs.promises.writeFile(didPath, jsonlContent, 'utf8');
224
- return didPath;
225
- }
226
- /**
227
- * Loads a DID log from a did.jsonl file
228
- * @param logPath - Path to the did.jsonl file
229
- * @returns The loaded DID log
230
- */
231
- async loadDIDLog(logPath) {
232
- const content = await fs.promises.readFile(logPath, 'utf8');
233
- const lines = content.trim().split('\n');
234
- return lines.map(line => JSON.parse(line));
235
- }
236
- /**
237
- * Updates a DID:WebVH document
238
- * @param did - The DID to update
239
- * @param currentLog - The current DID log
240
- * @param updates - Updates to apply to the DID document
241
- * @param signer - The signer to use (must be authorized in updateKeys)
242
- * @param verifier - Optional verifier
243
- * @param outputDir - Optional directory to save the updated log
244
- * @returns Updated DID document and log
245
- */
246
- async updateDIDWebVH(options) {
247
- const { did, currentLog, updates, signer: providedSigner, verifier: providedVerifier, outputDir } = options;
248
- // Dynamically import didwebvh-ts
249
- const mod = await import('didwebvh-ts');
250
- const { updateDID, prepareDataForSigning } = mod;
251
- if (typeof updateDID !== 'function') {
252
- throw new Error('Failed to load didwebvh-ts: invalid module exports');
253
- }
254
- let signer;
255
- let verifier;
256
- // Check if using external signer or internal keypair
257
- if ('sign' in providedSigner && 'getVerificationMethodId' in providedSigner) {
258
- // External signer
259
- signer = providedSigner;
260
- verifier = providedVerifier;
261
- }
262
- else {
263
- // Internal signer with keypair
264
- const keyPair = providedSigner;
265
- const verificationMethod = {
266
- type: 'Multikey',
267
- publicKeyMultibase: keyPair.publicKey,
268
- };
269
- const internalSigner = new OriginalsWebVHSigner(keyPair.privateKey, verificationMethod, prepareDataForSigning, { verificationMethod });
270
- signer = internalSigner;
271
- verifier = internalSigner;
272
- }
273
- // Get the current document from the log
274
- const currentEntry = currentLog[currentLog.length - 1];
275
- const currentDoc = currentEntry.state;
276
- // Merge updates with current document
277
- const updatedDoc = {
278
- ...currentDoc,
279
- ...updates,
280
- id: did, // Ensure ID doesn't change
281
- };
282
- // Update the DID using didwebvh-ts
283
- const result = await updateDID({
284
- log: currentLog,
285
- doc: updatedDoc,
286
- signer,
287
- verifier,
288
- });
289
- // Validate the returned DID document
290
- if (!this.isDIDDocument(result.doc)) {
291
- throw new Error('Invalid DID document returned from updateDID');
292
- }
293
- // Save the updated log if output directory is provided
294
- let logPath;
295
- if (outputDir) {
296
- logPath = await this.saveDIDLog(did, result.log, outputDir);
297
- }
298
- return {
299
- didDocument: result.doc,
300
- log: result.log,
301
- logPath,
302
- };
303
- }
304
- }
@@ -1,10 +0,0 @@
1
- import { DIDDocument } from '../types/did';
2
- import { MultikeyType } from '../crypto/Multikey';
3
- export type BitcoinNetwork = 'mainnet' | 'regtest' | 'signet';
4
- interface CreateBtcoDidDocumentParams {
5
- publicKey: Uint8Array;
6
- keyType: MultikeyType;
7
- controller?: string;
8
- }
9
- export declare function createBtcoDidDocument(satNumber: number | string, network: BitcoinNetwork, params: CreateBtcoDidDocumentParams): DIDDocument;
10
- export {};
@@ -1,42 +0,0 @@
1
- import { multikey } from '../crypto/Multikey';
2
- import { validateSatoshiNumber } from '../utils/satoshi-validation';
3
- function getDidPrefix(network) {
4
- if (network === 'mainnet')
5
- return 'did:btco';
6
- if (network === 'signet')
7
- return 'did:btco:sig';
8
- if (network === 'regtest')
9
- return 'did:btco:reg';
10
- throw new Error(`Unsupported Bitcoin network: ${network}`);
11
- }
12
- function buildVerificationMethod(did, params) {
13
- const fragment = '#0';
14
- const id = `${did}${fragment}`;
15
- const controller = params.controller ?? did;
16
- return {
17
- id,
18
- type: 'Multikey',
19
- controller,
20
- publicKeyMultibase: multikey.encodePublicKey(params.publicKey, params.keyType)
21
- };
22
- }
23
- export function createBtcoDidDocument(satNumber, network, params) {
24
- // Validate satNumber parameter at entry
25
- const validation = validateSatoshiNumber(satNumber);
26
- if (!validation.valid) {
27
- throw new Error(`Invalid satoshi number: ${validation.error}`);
28
- }
29
- const did = `${getDidPrefix(network)}:${String(satNumber)}`;
30
- const vm = buildVerificationMethod(did, params);
31
- const document = {
32
- '@context': [
33
- 'https://www.w3.org/ns/did/v1',
34
- 'https://w3id.org/security/multikey/v1'
35
- ],
36
- id: did,
37
- verificationMethod: [vm],
38
- authentication: [vm.id],
39
- assertionMethod: [vm.id]
40
- };
41
- return document;
42
- }
@@ -1,23 +0,0 @@
1
- import type { ResourceProviderLike } from '../BtcoDidResolver';
2
- import { OrdinalsClient } from '../../bitcoin/OrdinalsClient';
3
- export interface OrdinalsClientProviderConfig {
4
- baseUrl: string;
5
- fetchFn?: (url: string, init?: RequestInit) => Promise<Response>;
6
- timeout?: number;
7
- }
8
- export declare class OrdinalsClientProviderAdapter implements ResourceProviderLike {
9
- private client;
10
- private readonly config;
11
- constructor(client: OrdinalsClient, configOrBaseUrl: string | OrdinalsClientProviderConfig);
12
- getSatInfo(satNumber: string): Promise<{
13
- inscription_ids: string[];
14
- }>;
15
- resolveInscription(inscriptionId: string): Promise<{
16
- id: string;
17
- sat: number;
18
- content_type: string;
19
- content_url: string;
20
- }>;
21
- getMetadata(inscriptionId: string): Promise<any>;
22
- }
23
- export default OrdinalsClientProviderAdapter;