@originals/sdk 1.1.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 (247) hide show
  1. package/package.json +3 -2
  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/tsconfig.json +0 -1
  34. package/.turbo/turbo-build.log +0 -1
  35. package/.turbo/turbo-test.log +0 -68353
  36. package/dist/adapters/FeeOracleMock.d.ts +0 -6
  37. package/dist/adapters/FeeOracleMock.js +0 -8
  38. package/dist/adapters/index.d.ts +0 -4
  39. package/dist/adapters/index.js +0 -4
  40. package/dist/adapters/providers/OrdHttpProvider.d.ts +0 -56
  41. package/dist/adapters/providers/OrdHttpProvider.js +0 -110
  42. package/dist/adapters/providers/OrdMockProvider.d.ts +0 -70
  43. package/dist/adapters/providers/OrdMockProvider.js +0 -75
  44. package/dist/adapters/types.d.ts +0 -71
  45. package/dist/adapters/types.js +0 -1
  46. package/dist/bitcoin/BitcoinManager.d.ts +0 -15
  47. package/dist/bitcoin/BitcoinManager.js +0 -262
  48. package/dist/bitcoin/BroadcastClient.d.ts +0 -30
  49. package/dist/bitcoin/BroadcastClient.js +0 -35
  50. package/dist/bitcoin/OrdinalsClient.d.ts +0 -21
  51. package/dist/bitcoin/OrdinalsClient.js +0 -105
  52. package/dist/bitcoin/PSBTBuilder.d.ts +0 -24
  53. package/dist/bitcoin/PSBTBuilder.js +0 -80
  54. package/dist/bitcoin/fee-calculation.d.ts +0 -14
  55. package/dist/bitcoin/fee-calculation.js +0 -31
  56. package/dist/bitcoin/providers/OrdNodeProvider.d.ts +0 -38
  57. package/dist/bitcoin/providers/OrdNodeProvider.js +0 -67
  58. package/dist/bitcoin/providers/OrdinalsProvider.d.ts +0 -33
  59. package/dist/bitcoin/providers/OrdinalsProvider.js +0 -50
  60. package/dist/bitcoin/providers/types.d.ts +0 -63
  61. package/dist/bitcoin/providers/types.js +0 -1
  62. package/dist/bitcoin/transactions/commit.d.ts +0 -89
  63. package/dist/bitcoin/transactions/commit.js +0 -311
  64. package/dist/bitcoin/transactions/index.d.ts +0 -7
  65. package/dist/bitcoin/transactions/index.js +0 -8
  66. package/dist/bitcoin/transfer.d.ts +0 -9
  67. package/dist/bitcoin/transfer.js +0 -26
  68. package/dist/bitcoin/utxo-selection.d.ts +0 -78
  69. package/dist/bitcoin/utxo-selection.js +0 -237
  70. package/dist/bitcoin/utxo.d.ts +0 -26
  71. package/dist/bitcoin/utxo.js +0 -78
  72. package/dist/contexts/credentials-v1.json +0 -195
  73. package/dist/contexts/credentials-v2-examples.json +0 -5
  74. package/dist/contexts/credentials-v2.json +0 -301
  75. package/dist/contexts/credentials.json +0 -195
  76. package/dist/contexts/data-integrity-v2.json +0 -81
  77. package/dist/contexts/dids.json +0 -57
  78. package/dist/contexts/ed255192020.json +0 -93
  79. package/dist/contexts/ordinals-plus.json +0 -23
  80. package/dist/contexts/originals.json +0 -22
  81. package/dist/core/OriginalsSDK.d.ts +0 -158
  82. package/dist/core/OriginalsSDK.js +0 -274
  83. package/dist/crypto/Multikey.d.ts +0 -30
  84. package/dist/crypto/Multikey.js +0 -149
  85. package/dist/crypto/Signer.d.ts +0 -21
  86. package/dist/crypto/Signer.js +0 -196
  87. package/dist/crypto/noble-init.d.ts +0 -18
  88. package/dist/crypto/noble-init.js +0 -106
  89. package/dist/did/BtcoDidResolver.d.ts +0 -57
  90. package/dist/did/BtcoDidResolver.js +0 -166
  91. package/dist/did/DIDManager.d.ts +0 -101
  92. package/dist/did/DIDManager.js +0 -493
  93. package/dist/did/Ed25519Verifier.d.ts +0 -30
  94. package/dist/did/Ed25519Verifier.js +0 -59
  95. package/dist/did/KeyManager.d.ts +0 -17
  96. package/dist/did/KeyManager.js +0 -207
  97. package/dist/did/WebVHManager.d.ts +0 -100
  98. package/dist/did/WebVHManager.js +0 -304
  99. package/dist/did/createBtcoDidDocument.d.ts +0 -10
  100. package/dist/did/createBtcoDidDocument.js +0 -42
  101. package/dist/did/providers/OrdinalsClientProviderAdapter.d.ts +0 -23
  102. package/dist/did/providers/OrdinalsClientProviderAdapter.js +0 -51
  103. package/dist/events/EventEmitter.d.ts +0 -115
  104. package/dist/events/EventEmitter.js +0 -198
  105. package/dist/events/index.d.ts +0 -7
  106. package/dist/events/index.js +0 -6
  107. package/dist/events/types.d.ts +0 -286
  108. package/dist/events/types.js +0 -9
  109. package/dist/examples/basic-usage.d.ts +0 -3
  110. package/dist/examples/basic-usage.js +0 -62
  111. package/dist/examples/run.d.ts +0 -1
  112. package/dist/examples/run.js +0 -4
  113. package/dist/index.d.ts +0 -39
  114. package/dist/index.js +0 -47
  115. package/dist/lifecycle/BatchOperations.d.ts +0 -147
  116. package/dist/lifecycle/BatchOperations.js +0 -251
  117. package/dist/lifecycle/LifecycleManager.d.ts +0 -116
  118. package/dist/lifecycle/LifecycleManager.js +0 -971
  119. package/dist/lifecycle/OriginalsAsset.d.ts +0 -164
  120. package/dist/lifecycle/OriginalsAsset.js +0 -380
  121. package/dist/lifecycle/ProvenanceQuery.d.ts +0 -126
  122. package/dist/lifecycle/ProvenanceQuery.js +0 -220
  123. package/dist/lifecycle/ResourceVersioning.d.ts +0 -73
  124. package/dist/lifecycle/ResourceVersioning.js +0 -127
  125. package/dist/migration/MigrationManager.d.ts +0 -86
  126. package/dist/migration/MigrationManager.js +0 -412
  127. package/dist/migration/audit/AuditLogger.d.ts +0 -51
  128. package/dist/migration/audit/AuditLogger.js +0 -156
  129. package/dist/migration/checkpoint/CheckpointManager.d.ts +0 -31
  130. package/dist/migration/checkpoint/CheckpointManager.js +0 -96
  131. package/dist/migration/checkpoint/CheckpointStorage.d.ts +0 -26
  132. package/dist/migration/checkpoint/CheckpointStorage.js +0 -89
  133. package/dist/migration/index.d.ts +0 -22
  134. package/dist/migration/index.js +0 -27
  135. package/dist/migration/operations/BaseMigration.d.ts +0 -48
  136. package/dist/migration/operations/BaseMigration.js +0 -83
  137. package/dist/migration/operations/PeerToBtcoMigration.d.ts +0 -25
  138. package/dist/migration/operations/PeerToBtcoMigration.js +0 -67
  139. package/dist/migration/operations/PeerToWebvhMigration.d.ts +0 -19
  140. package/dist/migration/operations/PeerToWebvhMigration.js +0 -46
  141. package/dist/migration/operations/WebvhToBtcoMigration.d.ts +0 -25
  142. package/dist/migration/operations/WebvhToBtcoMigration.js +0 -67
  143. package/dist/migration/rollback/RollbackManager.d.ts +0 -29
  144. package/dist/migration/rollback/RollbackManager.js +0 -146
  145. package/dist/migration/state/StateMachine.d.ts +0 -25
  146. package/dist/migration/state/StateMachine.js +0 -76
  147. package/dist/migration/state/StateTracker.d.ts +0 -36
  148. package/dist/migration/state/StateTracker.js +0 -123
  149. package/dist/migration/types.d.ts +0 -306
  150. package/dist/migration/types.js +0 -33
  151. package/dist/migration/validation/BitcoinValidator.d.ts +0 -13
  152. package/dist/migration/validation/BitcoinValidator.js +0 -83
  153. package/dist/migration/validation/CredentialValidator.d.ts +0 -13
  154. package/dist/migration/validation/CredentialValidator.js +0 -46
  155. package/dist/migration/validation/DIDCompatibilityValidator.d.ts +0 -16
  156. package/dist/migration/validation/DIDCompatibilityValidator.js +0 -127
  157. package/dist/migration/validation/LifecycleValidator.d.ts +0 -10
  158. package/dist/migration/validation/LifecycleValidator.js +0 -52
  159. package/dist/migration/validation/StorageValidator.d.ts +0 -10
  160. package/dist/migration/validation/StorageValidator.js +0 -65
  161. package/dist/migration/validation/ValidationPipeline.d.ts +0 -29
  162. package/dist/migration/validation/ValidationPipeline.js +0 -180
  163. package/dist/storage/LocalStorageAdapter.d.ts +0 -11
  164. package/dist/storage/LocalStorageAdapter.js +0 -53
  165. package/dist/storage/MemoryStorageAdapter.d.ts +0 -6
  166. package/dist/storage/MemoryStorageAdapter.js +0 -21
  167. package/dist/storage/StorageAdapter.d.ts +0 -16
  168. package/dist/storage/StorageAdapter.js +0 -1
  169. package/dist/storage/index.d.ts +0 -2
  170. package/dist/storage/index.js +0 -2
  171. package/dist/types/bitcoin.d.ts +0 -84
  172. package/dist/types/bitcoin.js +0 -1
  173. package/dist/types/common.d.ts +0 -82
  174. package/dist/types/common.js +0 -1
  175. package/dist/types/credentials.d.ts +0 -75
  176. package/dist/types/credentials.js +0 -1
  177. package/dist/types/did.d.ts +0 -26
  178. package/dist/types/did.js +0 -1
  179. package/dist/types/index.d.ts +0 -5
  180. package/dist/types/index.js +0 -5
  181. package/dist/types/network.d.ts +0 -78
  182. package/dist/types/network.js +0 -145
  183. package/dist/utils/EventLogger.d.ts +0 -71
  184. package/dist/utils/EventLogger.js +0 -232
  185. package/dist/utils/Logger.d.ts +0 -106
  186. package/dist/utils/Logger.js +0 -257
  187. package/dist/utils/MetricsCollector.d.ts +0 -110
  188. package/dist/utils/MetricsCollector.js +0 -264
  189. package/dist/utils/bitcoin-address.d.ts +0 -38
  190. package/dist/utils/bitcoin-address.js +0 -113
  191. package/dist/utils/cbor.d.ts +0 -2
  192. package/dist/utils/cbor.js +0 -9
  193. package/dist/utils/encoding.d.ts +0 -37
  194. package/dist/utils/encoding.js +0 -120
  195. package/dist/utils/hash.d.ts +0 -1
  196. package/dist/utils/hash.js +0 -5
  197. package/dist/utils/retry.d.ts +0 -10
  198. package/dist/utils/retry.js +0 -35
  199. package/dist/utils/satoshi-validation.d.ts +0 -60
  200. package/dist/utils/satoshi-validation.js +0 -156
  201. package/dist/utils/serialization.d.ts +0 -14
  202. package/dist/utils/serialization.js +0 -76
  203. package/dist/utils/telemetry.d.ts +0 -17
  204. package/dist/utils/telemetry.js +0 -24
  205. package/dist/utils/validation.d.ts +0 -5
  206. package/dist/utils/validation.js +0 -98
  207. package/dist/vc/CredentialManager.d.ts +0 -22
  208. package/dist/vc/CredentialManager.js +0 -227
  209. package/dist/vc/Issuer.d.ts +0 -27
  210. package/dist/vc/Issuer.js +0 -70
  211. package/dist/vc/Verifier.d.ts +0 -16
  212. package/dist/vc/Verifier.js +0 -50
  213. package/dist/vc/cryptosuites/bbs.d.ts +0 -44
  214. package/dist/vc/cryptosuites/bbs.js +0 -213
  215. package/dist/vc/cryptosuites/bbsSimple.d.ts +0 -9
  216. package/dist/vc/cryptosuites/bbsSimple.js +0 -12
  217. package/dist/vc/cryptosuites/eddsa.d.ts +0 -30
  218. package/dist/vc/cryptosuites/eddsa.js +0 -81
  219. package/dist/vc/documentLoader.d.ts +0 -16
  220. package/dist/vc/documentLoader.js +0 -59
  221. package/dist/vc/proofs/data-integrity.d.ts +0 -21
  222. package/dist/vc/proofs/data-integrity.js +0 -15
  223. package/dist/vc/utils/jsonld.d.ts +0 -2
  224. package/dist/vc/utils/jsonld.js +0 -15
  225. package/test/logs/did_webvh_QmQsRNhXxPSCSeLjpbKYcNMZj8b1kBQAoC6cZmkFAgmpHt_example_com.jsonl +0 -1
  226. package/test/logs/did_webvh_QmSQkpD58qxcqMWHYcEmDUn3wk7hHvJwzYTrZmhh6zjPQ8_example_com_users_alice123_profile.jsonl +0 -1
  227. package/test/logs/did_webvh_QmTMda6VW3cUPdKk5Yc3onnv1vdgEumvWWdP2noAYFSjeG_example_com.jsonl +0 -1
  228. package/test/logs/did_webvh_QmTkb8KnCYcsnKKDCY4eUQuKQdKJLrCinvhw13v3zETxpE_example_com_users_etc_passwd.jsonl +0 -1
  229. package/test/logs/did_webvh_QmTn9FdCfpXFDrxHH52pwB4iNrDFVvNDjJ5FQTcDbmM3Fg_example_com.jsonl +0 -1
  230. package/test/logs/did_webvh_QmUCQUi1xjtJjnSQ1XJZgKqcWgErx1v7E2dz4DAPraAyJP_example_com_etc_passwd.jsonl +0 -1
  231. package/test/logs/did_webvh_QmUENQJCDKBJVRS5BkL6zjaUvcRjkb9xHmy7foCgRjmv3W_example_com.jsonl +0 -1
  232. package/test/logs/did_webvh_QmUPdGyjYBEnQ3aQUkmqyyBKTyjvCP5RZQGiaEDeTtf6dc_example_com.jsonl +0 -1
  233. package/test/logs/did_webvh_QmUoHTuHMWzQM29ZFrE9VLtMxkZ5u869yqee8LwcCLN39M_example_com.jsonl +0 -1
  234. package/test/logs/did_webvh_QmUrnms8G65ggVKsr9oQeWrLUBuGChwQPPb2LCFvaoNxaw_example_com_users_alice.jsonl +0 -1
  235. package/test/logs/did_webvh_QmUwiw3eSXdHG1hPvoAGu3cuK5jF4aXRYDLBAjPXfv1qzb_example_com_level1_level2.jsonl +0 -1
  236. package/test/logs/did_webvh_QmW7bzKh6yFEKNAtmVsrPGvvsMHTUQdzJSNsTZkbuGFpbj_example_com_secret.jsonl +0 -1
  237. package/test/logs/did_webvh_QmXbFTFBBJ8zpjdz9WE1DNN44A2wprFmdvAubjSffeyoAG_example_com.jsonl +0 -1
  238. package/test/logs/did_webvh_QmXyVXFPCTffGb2mTUFDeMCsScjnpLWkyUkVkB6q6QoeBf_example_com_C_Windows_System32.jsonl +0 -1
  239. package/test/logs/did_webvh_QmZK9B81gxZtvo5fYHYKDtKt8zZfZZPhmCMhbujBJuRRzE_example_com_etc_passwd.jsonl +0 -1
  240. package/test/logs/did_webvh_QmbNLCVSdXSVLrwFBvCBQPAabjtRb1SGHjkGVyw3QUbfBL_example_com_users_etc_passwd.jsonl +0 -1
  241. package/test/logs/did_webvh_QmbeaicmGW3Q7Yzbqmftc8a9jLBngokveb5A2KVKfVGZRb_example_com_my_org_user_name_test_123.jsonl +0 -1
  242. package/test/logs/did_webvh_Qmdv7c7AjUreUfoKyvkN2UpAWTozxKsv99srQetPJMJEnp_example_com_users_etc_passwd.jsonl +0 -1
  243. package/test/logs/did_webvh_QmeioWY3uypYLkYpCXe9eCYnn4xBVruP9C1d79azMrTEHG_example_com.jsonl +0 -1
  244. package/test/logs/did_webvh_Qmf4QH5dsA6Ecr5HJ6KaJL9uJRyY8RxrQdqoRCM25DzvPi_example_com_users_alice.jsonl +0 -1
  245. package/tests/e2e/README.md +0 -97
  246. package/tests/e2e/example.spec.ts +0 -78
  247. package/tsconfig.tsbuildinfo +0 -1
@@ -1,93 +0,0 @@
1
- {
2
- "@context": {
3
- "id": "@id",
4
- "type": "@type",
5
- "@protected": true,
6
- "proof": {
7
- "@id": "https://w3id.org/security#proof",
8
- "@type": "@id",
9
- "@container": "@graph"
10
- },
11
- "Ed25519VerificationKey2020": {
12
- "@id": "https://w3id.org/security#Ed25519VerificationKey2020",
13
- "@context": {
14
- "@protected": true,
15
- "id": "@id",
16
- "type": "@type",
17
- "controller": {
18
- "@id": "https://w3id.org/security#controller",
19
- "@type": "@id"
20
- },
21
- "revoked": {
22
- "@id": "https://w3id.org/security#revoked",
23
- "@type": "http://www.w3.org/2001/XMLSchema#dateTime"
24
- },
25
- "publicKeyMultibase": {
26
- "@id": "https://w3id.org/security#publicKeyMultibase",
27
- "@type": "https://w3id.org/security#multibase"
28
- }
29
- }
30
- },
31
- "Ed25519Signature2020": {
32
- "@id": "https://w3id.org/security#Ed25519Signature2020",
33
- "@context": {
34
- "@protected": true,
35
- "id": "@id",
36
- "type": "@type",
37
- "challenge": "https://w3id.org/security#challenge",
38
- "created": {
39
- "@id": "http://purl.org/dc/terms/created",
40
- "@type": "http://www.w3.org/2001/XMLSchema#dateTime"
41
- },
42
- "domain": "https://w3id.org/security#domain",
43
- "expires": {
44
- "@id": "https://w3id.org/security#expiration",
45
- "@type": "http://www.w3.org/2001/XMLSchema#dateTime"
46
- },
47
- "nonce": "https://w3id.org/security#nonce",
48
- "proofPurpose": {
49
- "@id": "https://w3id.org/security#proofPurpose",
50
- "@type": "@vocab",
51
- "@context": {
52
- "@protected": true,
53
- "id": "@id",
54
- "type": "@type",
55
- "assertionMethod": {
56
- "@id": "https://w3id.org/security#assertionMethod",
57
- "@type": "@id",
58
- "@container": "@set"
59
- },
60
- "authentication": {
61
- "@id": "https://w3id.org/security#authenticationMethod",
62
- "@type": "@id",
63
- "@container": "@set"
64
- },
65
- "capabilityInvocation": {
66
- "@id": "https://w3id.org/security#capabilityInvocationMethod",
67
- "@type": "@id",
68
- "@container": "@set"
69
- },
70
- "capabilityDelegation": {
71
- "@id": "https://w3id.org/security#capabilityDelegationMethod",
72
- "@type": "@id",
73
- "@container": "@set"
74
- },
75
- "keyAgreement": {
76
- "@id": "https://w3id.org/security#keyAgreementMethod",
77
- "@type": "@id",
78
- "@container": "@set"
79
- }
80
- }
81
- },
82
- "proofValue": {
83
- "@id": "https://w3id.org/security#proofValue",
84
- "@type": "https://w3id.org/security#multibase"
85
- },
86
- "verificationMethod": {
87
- "@id": "https://w3id.org/security#verificationMethod",
88
- "@type": "@id"
89
- }
90
- }
91
- }
92
- }
93
- }
@@ -1,23 +0,0 @@
1
- {
2
- "@context": {
3
- "@version": 1.1,
4
- "id": "@id",
5
- "type": "@type",
6
- "VerifiableCollectible": "https://ordinals.plus/vocab/v1#VerifiableCollectible",
7
- "VerifiableCollectibleCredential": "https://ordinals.plus/vocab/v1#VerifiableCollectibleCredential",
8
- "VerifiableCollectibleTrait": "https://ordinals.plus/vocab/v1#VerifiableCollectibleTrait",
9
- "VerifiableCollectibleTraitCredential": "https://ordinals.plus/vocab/v1#VerifiableCollectibleTraitCredential",
10
- "CuratedCollection": "https://ordinals.plus/vocab/v1#CuratedCollection",
11
- "CuratedCollectionCredential": "https://ordinals.plus/vocab/v1#CuratedCollectionCredential",
12
- "attributes": {
13
- "@id": "https://ordinals.plus/vocab/v1#attributes",
14
- "@container": "@set"
15
- },
16
- "items": {
17
- "@id": "https://ordinals.plus/vocab/v1#items",
18
- "@container": "@set"
19
- },
20
- "traitType": "https://ordinals.plus/vocab/v1#traitType",
21
- "value": "https://ordinals.plus/vocab/v1#traitValue"
22
- }
23
- }
@@ -1,22 +0,0 @@
1
- {
2
- "@context": {
3
- "@version": 1.1,
4
- "type": "@type",
5
- "id": "@id",
6
- "Originals": "https://originals.build",
7
- "OriginalsBundle": "Originals:OriginalsBundle",
8
- "ResourceCreated": "Originals:ResourceCreated",
9
- "ResourceUpdated": "Originals:ResourceUpdated",
10
- "ResourceMigrated": "Originals:ResourceMigrated",
11
- "attributes": {
12
- "@id": "Originals:attributes",
13
- "@container": "@set"
14
- },
15
- "resources": "Originals:resources",
16
- "verifiableCredentials": "Originals:verifiableCredentials",
17
- "content": "Originals:content",
18
- "trait_type": "Originals:trait_type",
19
- "display_type": "Originals:display_type",
20
- "value": "Originals:value"
21
- }
22
- }
@@ -1,158 +0,0 @@
1
- import { DIDManager } from '../did/DIDManager';
2
- import { CredentialManager } from '../vc/CredentialManager';
3
- import { LifecycleManager } from '../lifecycle/LifecycleManager';
4
- import { BitcoinManager } from '../bitcoin/BitcoinManager';
5
- import { OriginalsConfig, KeyStore, ExternalSigner, ExternalVerifier } from '../types';
6
- import { DIDDocument, VerificationMethod, ServiceEndpoint } from '../types/did';
7
- import { Logger } from '../utils/Logger';
8
- import { MetricsCollector } from '../utils/MetricsCollector';
9
- interface DIDLogEntry {
10
- versionId: string;
11
- versionTime: string;
12
- parameters: Record<string, unknown>;
13
- state: Record<string, unknown>;
14
- proof?: Record<string, unknown>[];
15
- }
16
- type DIDLog = DIDLogEntry[];
17
- interface DIDResolutionMeta {
18
- versionId: string;
19
- created: string;
20
- updated: string;
21
- previousLogEntryHash?: string;
22
- updateKeys: string[];
23
- scid: string;
24
- prerotation: boolean;
25
- portable: boolean;
26
- nextKeyHashes: string[];
27
- deactivated: boolean;
28
- witness?: unknown;
29
- watchers?: string[] | null;
30
- error?: string;
31
- problemDetails?: unknown;
32
- latestVersionId?: string;
33
- }
34
- export interface OriginalResult {
35
- did: string;
36
- doc: DIDDocument;
37
- log: DIDLog;
38
- meta: DIDResolutionMeta;
39
- }
40
- export interface CreateDIDOriginalOptions {
41
- type: 'did';
42
- domain: string;
43
- signer: ExternalSigner;
44
- verifier?: ExternalVerifier;
45
- updateKeys: string[];
46
- verificationMethods: VerificationMethod[];
47
- paths?: string[];
48
- controller?: string;
49
- context?: string | string[] | object | object[];
50
- alsoKnownAs?: string[];
51
- portable?: boolean;
52
- nextKeyHashes?: string[];
53
- authentication?: string[];
54
- assertionMethod?: string[];
55
- keyAgreement?: string[];
56
- services?: ServiceEndpoint[];
57
- }
58
- export interface UpdateDIDOriginalOptions {
59
- type: 'did';
60
- log: DIDLog;
61
- signer: ExternalSigner;
62
- verifier?: ExternalVerifier;
63
- updateKeys?: string[];
64
- verificationMethods?: VerificationMethod[];
65
- services?: ServiceEndpoint[];
66
- controller?: string;
67
- context?: string | string[] | object | object[];
68
- alsoKnownAs?: string[];
69
- portable?: boolean;
70
- nextKeyHashes?: string[];
71
- authentication?: string[];
72
- assertionMethod?: string[];
73
- keyAgreement?: string[];
74
- domain?: string;
75
- }
76
- export type CreateOriginalOptions = CreateDIDOriginalOptions;
77
- export type UpdateOriginalOptions = UpdateDIDOriginalOptions;
78
- export interface OriginalsSDKOptions extends Partial<OriginalsConfig> {
79
- keyStore?: KeyStore;
80
- }
81
- export declare class OriginalsSDK {
82
- readonly did: DIDManager;
83
- readonly credentials: CredentialManager;
84
- readonly lifecycle: LifecycleManager;
85
- readonly bitcoin: BitcoinManager;
86
- readonly logger: Logger;
87
- readonly metrics: MetricsCollector;
88
- private eventLogger;
89
- private config;
90
- constructor(config: OriginalsConfig, keyStore?: KeyStore);
91
- /**
92
- * Set up event logging integration
93
- */
94
- private setupEventLogging;
95
- /**
96
- * Validates that the SDK is properly configured for Bitcoin operations.
97
- * Throws a StructuredError if ordinalsProvider is not configured.
98
- *
99
- * @throws {StructuredError} When ordinalsProvider is not configured
100
- */
101
- validateBitcoinConfig(): void;
102
- static create(options?: OriginalsSDKOptions): OriginalsSDK;
103
- /**
104
- * Prepare data for signing using didwebvh-ts's canonical approach
105
- * This is a public static helper method that wraps didwebvh-ts's prepareDataForSigning
106
- * to ensure didwebvh-ts is only imported within the SDK
107
- */
108
- static prepareDIDDataForSigning(document: Record<string, unknown>, proof: Record<string, unknown>): Promise<Uint8Array>;
109
- /**
110
- * Verify a DID signature using Ed25519
111
- * This is a public static helper method that provides browser-compatible Ed25519 verification
112
- * Works with Uint8Array inputs (no Buffer required)
113
- *
114
- * @param signature - The signature bytes (Uint8Array)
115
- * @param message - The message bytes that were signed (Uint8Array)
116
- * @param publicKey - The public key bytes (Uint8Array, should be 32 bytes for Ed25519)
117
- * @returns True if the signature is valid
118
- */
119
- static verifyDIDSignature(signature: Uint8Array, message: Uint8Array, publicKey: Uint8Array): Promise<boolean>;
120
- /**
121
- * Create a new Original
122
- * This is a convenience proxy that routes to the appropriate specialized creation method.
123
- * Currently proxies to createDIDOriginal(), but can be extended for other Original types.
124
- *
125
- * @param options - Creation options (discriminated union by type)
126
- * @returns Created DID, document, log, and metadata
127
- */
128
- static createOriginal(options: CreateOriginalOptions): Promise<OriginalResult>;
129
- /**
130
- * Create a new DID-based Original (DID document/log)
131
- * This wraps didwebvh-ts's createDID function to ensure didwebvh-ts is only imported within the SDK.
132
- *
133
- * A DID-based Original represents a decentralized identity that can be used as the foundation
134
- * for other Originals (e.g., asset Originals, credential Originals, etc.).
135
- *
136
- * @param options - Creation options matching didwebvh-ts createDID interface
137
- * @returns Created DID, document, log, and metadata
138
- */
139
- static createDIDOriginal(options: CreateDIDOriginalOptions): Promise<OriginalResult>;
140
- /**
141
- * Update an existing Original
142
- * This is a convenience proxy that routes to the appropriate specialized update method.
143
- * Currently proxies to updateDIDOriginal(), but can be extended for other Original types.
144
- *
145
- * @param options - Update options (discriminated union by type)
146
- * @returns Updated DID, document, log, and metadata
147
- */
148
- static updateOriginal(options: UpdateOriginalOptions): Promise<OriginalResult>;
149
- /**
150
- * Update an existing DID-based Original (DID document/log)
151
- * This wraps didwebvh-ts's updateDID function to ensure didwebvh-ts is only imported within the SDK.
152
- *
153
- * @param options - Update options matching didwebvh-ts updateDID interface
154
- * @returns Updated DID, document, log, and metadata
155
- */
156
- static updateDIDOriginal(options: UpdateDIDOriginalOptions): Promise<OriginalResult>;
157
- }
158
- export {};
@@ -1,274 +0,0 @@
1
- import { DIDManager } from '../did/DIDManager';
2
- import { CredentialManager } from '../vc/CredentialManager';
3
- import { LifecycleManager } from '../lifecycle/LifecycleManager';
4
- import { BitcoinManager } from '../bitcoin/BitcoinManager';
5
- import { DEFAULT_WEBVH_NETWORK } from '../types/network';
6
- import { emitTelemetry, StructuredError } from '../utils/telemetry';
7
- import { Logger } from '../utils/Logger';
8
- import { MetricsCollector } from '../utils/MetricsCollector';
9
- import { EventLogger } from '../utils/EventLogger';
10
- import { createDID } from 'didwebvh-ts';
11
- export class OriginalsSDK {
12
- constructor(config, keyStore) {
13
- // Input validation
14
- if (!config || typeof config !== 'object') {
15
- throw new Error('Configuration object is required');
16
- }
17
- if (!config.network || !['mainnet', 'regtest', 'signet'].includes(config.network)) {
18
- throw new Error('Invalid network: must be mainnet, regtest, or signet');
19
- }
20
- if (!config.defaultKeyType || !['ES256K', 'Ed25519', 'ES256'].includes(config.defaultKeyType)) {
21
- throw new Error('Invalid defaultKeyType: must be ES256K, Ed25519, or ES256');
22
- }
23
- this.config = config;
24
- // Initialize logger and metrics
25
- this.logger = new Logger('SDK', config);
26
- this.metrics = new MetricsCollector();
27
- this.eventLogger = new EventLogger(this.logger.child('Events'), this.metrics);
28
- // Log SDK initialization
29
- this.logger.info('Initializing Originals SDK', {
30
- network: config.network,
31
- keyType: config.defaultKeyType
32
- });
33
- emitTelemetry(config.telemetry, { name: 'sdk.init', attributes: { network: config.network } });
34
- // Initialize managers
35
- this.did = new DIDManager(config);
36
- this.credentials = new CredentialManager(config, this.did);
37
- this.lifecycle = new LifecycleManager(config, this.did, this.credentials, undefined, keyStore);
38
- this.bitcoin = new BitcoinManager(config);
39
- // Set up event logging integration
40
- this.setupEventLogging();
41
- this.logger.info('SDK initialized successfully');
42
- }
43
- /**
44
- * Set up event logging integration
45
- */
46
- setupEventLogging() {
47
- // Configure event logging from config
48
- if (this.config.logging?.eventLogging) {
49
- this.eventLogger.configureEventLogging(this.config.logging.eventLogging);
50
- }
51
- // Subscribe to lifecycle events
52
- this.eventLogger.subscribeToEvents(this.lifecycle.eventEmitter);
53
- }
54
- /**
55
- * Validates that the SDK is properly configured for Bitcoin operations.
56
- * Throws a StructuredError if ordinalsProvider is not configured.
57
- *
58
- * @throws {StructuredError} When ordinalsProvider is not configured
59
- */
60
- validateBitcoinConfig() {
61
- if (!this.config.ordinalsProvider) {
62
- throw new StructuredError('ORD_PROVIDER_REQUIRED', 'Bitcoin operations require an ordinalsProvider to be configured. ' +
63
- 'Please provide an ordinalsProvider when creating the SDK. ' +
64
- 'See README.md for configuration examples.');
65
- }
66
- }
67
- static create(options) {
68
- const { keyStore, ...configOptions } = options || {};
69
- const defaultConfig = {
70
- network: 'mainnet',
71
- defaultKeyType: 'ES256K',
72
- enableLogging: false,
73
- webvhNetwork: DEFAULT_WEBVH_NETWORK, // Default to 'pichu' (production)
74
- };
75
- return new OriginalsSDK({ ...defaultConfig, ...configOptions }, keyStore);
76
- }
77
- /**
78
- * Prepare data for signing using didwebvh-ts's canonical approach
79
- * This is a public static helper method that wraps didwebvh-ts's prepareDataForSigning
80
- * to ensure didwebvh-ts is only imported within the SDK
81
- */
82
- static async prepareDIDDataForSigning(document, proof) {
83
- // Dynamically import didwebvh-ts to avoid module resolution issues
84
- const mod = await import('didwebvh-ts');
85
- const { prepareDataForSigning } = mod;
86
- // Runtime validation
87
- if (typeof prepareDataForSigning !== 'function') {
88
- throw new Error('Failed to load didwebvh-ts: prepareDataForSigning is not a function');
89
- }
90
- return prepareDataForSigning(document, proof);
91
- }
92
- /**
93
- * Verify a DID signature using Ed25519
94
- * This is a public static helper method that provides browser-compatible Ed25519 verification
95
- * Works with Uint8Array inputs (no Buffer required)
96
- *
97
- * @param signature - The signature bytes (Uint8Array)
98
- * @param message - The message bytes that were signed (Uint8Array)
99
- * @param publicKey - The public key bytes (Uint8Array, should be 32 bytes for Ed25519)
100
- * @returns True if the signature is valid
101
- */
102
- static async verifyDIDSignature(signature, message, publicKey) {
103
- // Dynamically import @noble/ed25519 to avoid module resolution issues
104
- const ed25519Mod = await import('@noble/ed25519');
105
- // Ed25519 public keys must be exactly 32 bytes
106
- // Some keys may have a version byte prefix, so remove it if present
107
- let ed25519PublicKey = publicKey;
108
- if (publicKey.length === 33) {
109
- ed25519PublicKey = publicKey.slice(1);
110
- }
111
- else if (publicKey.length !== 32) {
112
- throw new Error(`Invalid Ed25519 public key length: ${publicKey.length} (expected 32 bytes)`);
113
- }
114
- // Verify using @noble/ed25519 with Uint8Array (browser-compatible)
115
- // ed25519.verifyAsync accepts Uint8Array directly
116
- try {
117
- return await ed25519Mod.verifyAsync(signature, message, ed25519PublicKey);
118
- }
119
- catch (error) {
120
- // Verification failed or error occurred
121
- return false;
122
- }
123
- }
124
- /**
125
- * Create a new Original
126
- * This is a convenience proxy that routes to the appropriate specialized creation method.
127
- * Currently proxies to createDIDOriginal(), but can be extended for other Original types.
128
- *
129
- * @param options - Creation options (discriminated union by type)
130
- * @returns Created DID, document, log, and metadata
131
- */
132
- static async createOriginal(options) {
133
- // Route based on type discriminator
134
- switch (options.type) {
135
- case 'did':
136
- return OriginalsSDK.createDIDOriginal(options);
137
- default:
138
- // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
139
- throw new Error(`Unsupported Original type: ${options.type}`);
140
- }
141
- }
142
- /**
143
- * Create a new DID-based Original (DID document/log)
144
- * This wraps didwebvh-ts's createDID function to ensure didwebvh-ts is only imported within the SDK.
145
- *
146
- * A DID-based Original represents a decentralized identity that can be used as the foundation
147
- * for other Originals (e.g., asset Originals, credential Originals, etc.).
148
- *
149
- * @param options - Creation options matching didwebvh-ts createDID interface
150
- * @returns Created DID, document, log, and metadata
151
- */
152
- static async createDIDOriginal(options) {
153
- // Dynamically import didwebvh-ts to avoid module resolution issues
154
- // const mod = await import('didwebvh-ts') as unknown as {
155
- // createDID: (options: Record<string, unknown>) => Promise<{
156
- // did: string;
157
- // doc: Record<string, unknown>;
158
- // log: DIDLog;
159
- // meta: DIDResolutionMeta;
160
- // }>;
161
- // };
162
- // const { createDID } = mod;
163
- // Runtime validation
164
- if (typeof createDID !== 'function') {
165
- throw new Error('Failed to load didwebvh-ts: createDID is not a function');
166
- }
167
- // Create the DID using didwebvh-ts
168
- const result = await createDID({
169
- domain: options.domain,
170
- signer: options.signer,
171
- verifier: options.verifier,
172
- paths: options.paths,
173
- updateKeys: options.updateKeys,
174
- verificationMethods: options.verificationMethods,
175
- context: options.context || [
176
- 'https://www.w3.org/ns/did/v1',
177
- 'https://w3id.org/security/multikey/v1'
178
- ],
179
- });
180
- return {
181
- did: result.did,
182
- doc: result.doc,
183
- log: result.log,
184
- meta: result.meta
185
- };
186
- }
187
- /**
188
- * Update an existing Original
189
- * This is a convenience proxy that routes to the appropriate specialized update method.
190
- * Currently proxies to updateDIDOriginal(), but can be extended for other Original types.
191
- *
192
- * @param options - Update options (discriminated union by type)
193
- * @returns Updated DID, document, log, and metadata
194
- */
195
- static async updateOriginal(options) {
196
- // Route based on type discriminator
197
- switch (options.type) {
198
- case 'did':
199
- return OriginalsSDK.updateDIDOriginal(options);
200
- default:
201
- // TypeScript exhaustiveness check
202
- const _exhaustive = options;
203
- throw new Error(`Unsupported Original type: ${_exhaustive.type}`);
204
- }
205
- }
206
- /**
207
- * Update an existing DID-based Original (DID document/log)
208
- * This wraps didwebvh-ts's updateDID function to ensure didwebvh-ts is only imported within the SDK.
209
- *
210
- * @param options - Update options matching didwebvh-ts updateDID interface
211
- * @returns Updated DID, document, log, and metadata
212
- */
213
- static async updateDIDOriginal(options) {
214
- // Dynamically import didwebvh-ts to avoid module resolution issues
215
- const mod = await import('didwebvh-ts');
216
- const { updateDID } = mod;
217
- // Runtime validation
218
- if (typeof updateDID !== 'function') {
219
- throw new Error('Failed to load didwebvh-ts: updateDID is not a function');
220
- }
221
- // Prepare options for updateDID
222
- const updateOptions = {
223
- log: options.log,
224
- signer: options.signer,
225
- verifier: options.verifier || options.signer, // Use signer as verifier if not provided
226
- };
227
- // Add optional parameters
228
- if (options.updateKeys !== undefined)
229
- updateOptions.updateKeys = options.updateKeys;
230
- if (options.verificationMethods !== undefined)
231
- updateOptions.verificationMethods = options.verificationMethods;
232
- if (options.services !== undefined)
233
- updateOptions.services = options.services;
234
- if (options.controller !== undefined)
235
- updateOptions.controller = options.controller;
236
- if (options.context !== undefined)
237
- updateOptions.context = options.context;
238
- if (options.alsoKnownAs !== undefined)
239
- updateOptions.alsoKnownAs = options.alsoKnownAs;
240
- if (options.portable !== undefined)
241
- updateOptions.portable = options.portable;
242
- if (options.nextKeyHashes !== undefined)
243
- updateOptions.nextKeyHashes = options.nextKeyHashes;
244
- if (options.authentication !== undefined)
245
- updateOptions.authentication = options.authentication;
246
- if (options.assertionMethod !== undefined)
247
- updateOptions.assertionMethod = options.assertionMethod;
248
- if (options.keyAgreement !== undefined)
249
- updateOptions.keyAgreement = options.keyAgreement;
250
- if (options.domain !== undefined)
251
- updateOptions.domain = options.domain;
252
- // Update the DID using didwebvh-ts
253
- const result = await updateDID(updateOptions);
254
- // Extract DID from the log if not returned directly
255
- let did;
256
- if (result.did) {
257
- did = result.did;
258
- }
259
- else if (result.log && result.log.length > 0) {
260
- // Extract DID from the document in the log
261
- const latestDoc = result.log[result.log.length - 1]?.state;
262
- did = latestDoc?.id || '';
263
- }
264
- else {
265
- throw new Error('Cannot determine DID from update result');
266
- }
267
- return {
268
- did,
269
- doc: result.doc,
270
- log: result.log,
271
- meta: result.meta
272
- };
273
- }
274
- }
@@ -1,30 +0,0 @@
1
- export declare const MULTICODEC_ED25519_PUB_HEADER: Uint8Array<ArrayBuffer>;
2
- export declare const MULTICODEC_ED25519_PRIV_HEADER: Uint8Array<ArrayBuffer>;
3
- export declare const MULTICODEC_SECP256K1_PUB_HEADER: Uint8Array<ArrayBuffer>;
4
- export declare const MULTICODEC_SECP256K1_PRIV_HEADER: Uint8Array<ArrayBuffer>;
5
- export declare const MULTICODEC_BLS12381_G2_PUB_HEADER: Uint8Array<ArrayBuffer>;
6
- export declare const MULTICODEC_BLS12381_G2_PRIV_HEADER: Uint8Array<ArrayBuffer>;
7
- export declare const MULTICODEC_P256_PUB_HEADER: Uint8Array<ArrayBuffer>;
8
- export declare const MULTICODEC_P256_PRIV_HEADER: Uint8Array<ArrayBuffer>;
9
- export type MultikeyType = 'Ed25519' | 'Secp256k1' | 'Bls12381G2' | 'P256';
10
- /**
11
- * Validates that a key string uses proper multikey format.
12
- * @param key - The multibase-encoded key string to validate
13
- * @param expectedType - The expected key type (e.g., 'Ed25519', 'Secp256k1')
14
- * @param isPrivate - Whether this is a private key (true) or public key (false)
15
- * @throws Error with descriptive message if validation fails
16
- */
17
- export declare function validateMultikeyFormat(key: string, expectedType: MultikeyType, isPrivate: boolean): void;
18
- export declare const multikey: {
19
- encodePublicKey: (publicKey: Uint8Array, type: MultikeyType) => string;
20
- encodePrivateKey: (privateKey: Uint8Array, type: MultikeyType) => string;
21
- encodeMultibase: (data: Uint8Array | Buffer) => string;
22
- decodePublicKey: (publicKeyMultibase: string) => {
23
- key: Uint8Array;
24
- type: MultikeyType;
25
- };
26
- decodePrivateKey: (privateKeyMultibase: string) => {
27
- key: Uint8Array;
28
- type: MultikeyType;
29
- };
30
- };