@originals/sdk 1.4.2 → 1.4.3

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 (212) hide show
  1. package/package.json +4 -1
  2. package/.eslintrc.json +0 -33
  3. package/src/adapters/FeeOracleMock.ts +0 -9
  4. package/src/adapters/index.ts +0 -5
  5. package/src/adapters/providers/OrdHttpProvider.ts +0 -126
  6. package/src/adapters/providers/OrdMockProvider.ts +0 -101
  7. package/src/adapters/types.ts +0 -66
  8. package/src/bitcoin/BitcoinManager.ts +0 -330
  9. package/src/bitcoin/BroadcastClient.ts +0 -54
  10. package/src/bitcoin/OrdinalsClient.ts +0 -119
  11. package/src/bitcoin/PSBTBuilder.ts +0 -106
  12. package/src/bitcoin/fee-calculation.ts +0 -38
  13. package/src/bitcoin/providers/OrdNodeProvider.ts +0 -92
  14. package/src/bitcoin/providers/OrdinalsProvider.ts +0 -56
  15. package/src/bitcoin/providers/types.ts +0 -59
  16. package/src/bitcoin/transactions/commit.ts +0 -465
  17. package/src/bitcoin/transactions/index.ts +0 -13
  18. package/src/bitcoin/transfer.ts +0 -43
  19. package/src/bitcoin/utxo-selection.ts +0 -322
  20. package/src/bitcoin/utxo.ts +0 -113
  21. package/src/contexts/credentials-v1.json +0 -237
  22. package/src/contexts/credentials-v2-examples.json +0 -5
  23. package/src/contexts/credentials-v2.json +0 -340
  24. package/src/contexts/credentials.json +0 -237
  25. package/src/contexts/data-integrity-v2.json +0 -81
  26. package/src/contexts/dids.json +0 -58
  27. package/src/contexts/ed255192020.json +0 -93
  28. package/src/contexts/ordinals-plus.json +0 -23
  29. package/src/contexts/originals.json +0 -22
  30. package/src/core/OriginalsSDK.ts +0 -416
  31. package/src/crypto/Multikey.ts +0 -194
  32. package/src/crypto/Signer.ts +0 -254
  33. package/src/crypto/noble-init.ts +0 -121
  34. package/src/did/BtcoDidResolver.ts +0 -227
  35. package/src/did/DIDManager.ts +0 -694
  36. package/src/did/Ed25519Verifier.ts +0 -68
  37. package/src/did/KeyManager.ts +0 -236
  38. package/src/did/WebVHManager.ts +0 -498
  39. package/src/did/createBtcoDidDocument.ts +0 -59
  40. package/src/did/providers/OrdinalsClientProviderAdapter.ts +0 -68
  41. package/src/events/EventEmitter.ts +0 -222
  42. package/src/events/index.ts +0 -19
  43. package/src/events/types.ts +0 -331
  44. package/src/examples/basic-usage.ts +0 -78
  45. package/src/examples/create-module-original.ts +0 -435
  46. package/src/examples/full-lifecycle-flow.ts +0 -514
  47. package/src/examples/run.ts +0 -60
  48. package/src/index.ts +0 -150
  49. package/src/kinds/KindRegistry.ts +0 -290
  50. package/src/kinds/index.ts +0 -74
  51. package/src/kinds/types.ts +0 -470
  52. package/src/kinds/validators/AgentValidator.ts +0 -257
  53. package/src/kinds/validators/AppValidator.ts +0 -211
  54. package/src/kinds/validators/DatasetValidator.ts +0 -242
  55. package/src/kinds/validators/DocumentValidator.ts +0 -311
  56. package/src/kinds/validators/MediaValidator.ts +0 -269
  57. package/src/kinds/validators/ModuleValidator.ts +0 -225
  58. package/src/kinds/validators/base.ts +0 -276
  59. package/src/kinds/validators/index.ts +0 -12
  60. package/src/lifecycle/BatchOperations.ts +0 -373
  61. package/src/lifecycle/LifecycleManager.ts +0 -2126
  62. package/src/lifecycle/OriginalsAsset.ts +0 -524
  63. package/src/lifecycle/ProvenanceQuery.ts +0 -280
  64. package/src/lifecycle/ResourceVersioning.ts +0 -163
  65. package/src/migration/MigrationManager.ts +0 -527
  66. package/src/migration/audit/AuditLogger.ts +0 -176
  67. package/src/migration/checkpoint/CheckpointManager.ts +0 -112
  68. package/src/migration/checkpoint/CheckpointStorage.ts +0 -101
  69. package/src/migration/index.ts +0 -33
  70. package/src/migration/operations/BaseMigration.ts +0 -126
  71. package/src/migration/operations/PeerToBtcoMigration.ts +0 -105
  72. package/src/migration/operations/PeerToWebvhMigration.ts +0 -62
  73. package/src/migration/operations/WebvhToBtcoMigration.ts +0 -105
  74. package/src/migration/rollback/RollbackManager.ts +0 -170
  75. package/src/migration/state/StateMachine.ts +0 -92
  76. package/src/migration/state/StateTracker.ts +0 -156
  77. package/src/migration/types.ts +0 -344
  78. package/src/migration/validation/BitcoinValidator.ts +0 -107
  79. package/src/migration/validation/CredentialValidator.ts +0 -62
  80. package/src/migration/validation/DIDCompatibilityValidator.ts +0 -151
  81. package/src/migration/validation/LifecycleValidator.ts +0 -64
  82. package/src/migration/validation/StorageValidator.ts +0 -79
  83. package/src/migration/validation/ValidationPipeline.ts +0 -213
  84. package/src/resources/ResourceManager.ts +0 -655
  85. package/src/resources/index.ts +0 -21
  86. package/src/resources/types.ts +0 -202
  87. package/src/storage/LocalStorageAdapter.ts +0 -61
  88. package/src/storage/MemoryStorageAdapter.ts +0 -29
  89. package/src/storage/StorageAdapter.ts +0 -25
  90. package/src/storage/index.ts +0 -3
  91. package/src/types/bitcoin.ts +0 -98
  92. package/src/types/common.ts +0 -92
  93. package/src/types/credentials.ts +0 -88
  94. package/src/types/did.ts +0 -31
  95. package/src/types/external-shims.d.ts +0 -53
  96. package/src/types/index.ts +0 -7
  97. package/src/types/network.ts +0 -175
  98. package/src/utils/EventLogger.ts +0 -298
  99. package/src/utils/Logger.ts +0 -322
  100. package/src/utils/MetricsCollector.ts +0 -358
  101. package/src/utils/bitcoin-address.ts +0 -130
  102. package/src/utils/cbor.ts +0 -12
  103. package/src/utils/encoding.ts +0 -127
  104. package/src/utils/hash.ts +0 -6
  105. package/src/utils/retry.ts +0 -46
  106. package/src/utils/satoshi-validation.ts +0 -196
  107. package/src/utils/serialization.ts +0 -96
  108. package/src/utils/telemetry.ts +0 -40
  109. package/src/utils/validation.ts +0 -119
  110. package/src/vc/CredentialManager.ts +0 -918
  111. package/src/vc/Issuer.ts +0 -100
  112. package/src/vc/Verifier.ts +0 -47
  113. package/src/vc/cryptosuites/bbs.ts +0 -253
  114. package/src/vc/cryptosuites/bbsSimple.ts +0 -21
  115. package/src/vc/cryptosuites/eddsa.ts +0 -99
  116. package/src/vc/documentLoader.ts +0 -67
  117. package/src/vc/proofs/data-integrity.ts +0 -33
  118. package/src/vc/utils/jsonld.ts +0 -18
  119. package/tests/__mocks__/bbs-signatures.js +0 -17
  120. package/tests/__mocks__/mf-base58.js +0 -24
  121. package/tests/fixtures/did-documents.ts +0 -247
  122. package/tests/index.test.ts +0 -21
  123. package/tests/integration/BatchOperations.test.ts +0 -531
  124. package/tests/integration/CompleteLifecycle.e2e.test.ts +0 -735
  125. package/tests/integration/CredentialManager.test.ts +0 -42
  126. package/tests/integration/DIDManager.test.ts +0 -41
  127. package/tests/integration/DidPeerToWebVhFlow.test.ts +0 -351
  128. package/tests/integration/Events.test.ts +0 -435
  129. package/tests/integration/Lifecycle.transfer.btco.integration.test.ts +0 -25
  130. package/tests/integration/LifecycleManager.test.ts +0 -21
  131. package/tests/integration/MultikeyFlow.test.ts +0 -52
  132. package/tests/integration/TelemetryIntegration.test.ts +0 -395
  133. package/tests/integration/WebVhPublish.test.ts +0 -48
  134. package/tests/integration/createTypedOriginal.test.ts +0 -379
  135. package/tests/integration/migration/peer-to-webvh.test.ts +0 -172
  136. package/tests/manual/test-commit-creation.ts +0 -323
  137. package/tests/mocks/MockKeyStore.ts +0 -38
  138. package/tests/mocks/adapters/MemoryStorageAdapter.ts +0 -24
  139. package/tests/mocks/adapters/MockFeeOracle.ts +0 -11
  140. package/tests/mocks/adapters/MockOrdinalsProvider.ts +0 -76
  141. package/tests/mocks/adapters/OrdMockProvider.test.ts +0 -176
  142. package/tests/mocks/adapters/index.ts +0 -6
  143. package/tests/performance/BatchOperations.perf.test.ts +0 -403
  144. package/tests/performance/logging.perf.test.ts +0 -336
  145. package/tests/sdk.test.ts +0 -43
  146. package/tests/security/bitcoin-penetration-tests.test.ts +0 -622
  147. package/tests/setup.bun.ts +0 -69
  148. package/tests/setup.jest.ts +0 -23
  149. package/tests/stress/batch-operations-stress.test.ts +0 -571
  150. package/tests/unit/adapters/FeeOracleMock.test.ts +0 -40
  151. package/tests/unit/bitcoin/BitcoinManager.test.ts +0 -293
  152. package/tests/unit/bitcoin/BroadcastClient.test.ts +0 -52
  153. package/tests/unit/bitcoin/OrdNodeProvider.test.ts +0 -53
  154. package/tests/unit/bitcoin/OrdinalsClient.test.ts +0 -381
  155. package/tests/unit/bitcoin/OrdinalsClientProvider.test.ts +0 -102
  156. package/tests/unit/bitcoin/PSBTBuilder.test.ts +0 -84
  157. package/tests/unit/bitcoin/fee-calculation.test.ts +0 -261
  158. package/tests/unit/bitcoin/transactions/commit.test.ts +0 -649
  159. package/tests/unit/bitcoin/transfer.test.ts +0 -31
  160. package/tests/unit/bitcoin/utxo-selection-new.test.ts +0 -502
  161. package/tests/unit/bitcoin/utxo.more.test.ts +0 -39
  162. package/tests/unit/bitcoin/utxo.selection.test.ts +0 -38
  163. package/tests/unit/core/OriginalsSDK.test.ts +0 -152
  164. package/tests/unit/crypto/Multikey.test.ts +0 -206
  165. package/tests/unit/crypto/Signer.test.ts +0 -408
  166. package/tests/unit/did/BtcoDidResolver.test.ts +0 -611
  167. package/tests/unit/did/DIDManager.more.test.ts +0 -43
  168. package/tests/unit/did/DIDManager.test.ts +0 -185
  169. package/tests/unit/did/Ed25519Verifier.test.ts +0 -160
  170. package/tests/unit/did/KeyManager.test.ts +0 -452
  171. package/tests/unit/did/OrdinalsClientProviderAdapter.test.ts +0 -45
  172. package/tests/unit/did/WebVHManager.test.ts +0 -435
  173. package/tests/unit/did/createBtcoDidDocument.test.ts +0 -67
  174. package/tests/unit/did/providers/OrdinalsClientProviderAdapter.test.ts +0 -159
  175. package/tests/unit/events/EventEmitter.test.ts +0 -407
  176. package/tests/unit/kinds/KindRegistry.test.ts +0 -329
  177. package/tests/unit/kinds/types.test.ts +0 -409
  178. package/tests/unit/kinds/validators.test.ts +0 -651
  179. package/tests/unit/lifecycle/BatchOperations.test.ts +0 -527
  180. package/tests/unit/lifecycle/LifecycleManager.cleanapi.test.ts +0 -441
  181. package/tests/unit/lifecycle/LifecycleManager.keymanagement.test.ts +0 -312
  182. package/tests/unit/lifecycle/LifecycleManager.prov.test.ts +0 -18
  183. package/tests/unit/lifecycle/LifecycleManager.test.ts +0 -213
  184. package/tests/unit/lifecycle/LifecycleManager.transfer.unit.test.ts +0 -30
  185. package/tests/unit/lifecycle/OriginalsAsset.test.ts +0 -176
  186. package/tests/unit/lifecycle/ProvenanceQuery.test.ts +0 -577
  187. package/tests/unit/lifecycle/ResourceVersioning.test.ts +0 -651
  188. package/tests/unit/resources/ResourceManager.test.ts +0 -740
  189. package/tests/unit/storage/MemoryStorageAdapter.test.ts +0 -93
  190. package/tests/unit/types/network.test.ts +0 -255
  191. package/tests/unit/utils/EventIntegration.test.ts +0 -384
  192. package/tests/unit/utils/Logger.test.ts +0 -473
  193. package/tests/unit/utils/MetricsCollector.test.ts +0 -358
  194. package/tests/unit/utils/bitcoin-address.test.ts +0 -250
  195. package/tests/unit/utils/cbor.test.ts +0 -35
  196. package/tests/unit/utils/encoding.test.ts +0 -318
  197. package/tests/unit/utils/hash.test.ts +0 -12
  198. package/tests/unit/utils/retry.test.ts +0 -100
  199. package/tests/unit/utils/satoshi-validation.test.ts +0 -354
  200. package/tests/unit/utils/serialization.test.ts +0 -124
  201. package/tests/unit/utils/telemetry.test.ts +0 -52
  202. package/tests/unit/utils/validation.test.ts +0 -141
  203. package/tests/unit/vc/CredentialManager.helpers.test.ts +0 -527
  204. package/tests/unit/vc/CredentialManager.test.ts +0 -487
  205. package/tests/unit/vc/Issuer.test.ts +0 -107
  206. package/tests/unit/vc/Verifier.test.ts +0 -525
  207. package/tests/unit/vc/bbs.test.ts +0 -282
  208. package/tests/unit/vc/cryptosuites/eddsa.test.ts +0 -398
  209. package/tests/unit/vc/documentLoader.test.ts +0 -121
  210. package/tests/unit/vc/proofs/data-integrity.test.ts +0 -24
  211. package/tsconfig.json +0 -31
  212. package/tsconfig.test.json +0 -15
@@ -1,918 +0,0 @@
1
- import {
2
- VerifiableCredential,
3
- VerifiablePresentation,
4
- CredentialSubject,
5
- OriginalsConfig,
6
- Proof,
7
- ExternalSigner,
8
- LayerType,
9
- AssetResource
10
- } from '../types';
11
- import { canonicalizeDocument } from '../utils/serialization';
12
- import { encodeBase64UrlMultibase, decodeBase64UrlMultibase } from '../utils/encoding';
13
- import { sha256 } from '@noble/hashes/sha2.js';
14
- import { bytesToHex } from '@noble/hashes/utils.js';
15
- import { Signer, ES256KSigner, Ed25519Signer, ES256Signer } from '../crypto/Signer';
16
- import { DIDManager } from '../did/DIDManager';
17
- import { Issuer, VerificationMethodLike } from './Issuer';
18
- import { createDocumentLoader } from './documentLoader';
19
- import { Verifier } from './Verifier';
20
- import { BBSCryptosuiteUtils } from './cryptosuites/bbs';
21
-
22
- // ===== Credential Factory Types =====
23
-
24
- /**
25
- * Subject data for a ResourceCreated credential
26
- */
27
- export interface ResourceCreatedSubject {
28
- /** ID of the subject (typically the resource DID or asset DID) */
29
- id: string;
30
- /** Resource identifier */
31
- resourceId: string;
32
- /** Resource type (e.g., 'code', 'text', 'image') */
33
- resourceType: string;
34
- /** Content hash of the resource */
35
- contentHash: string;
36
- /** MIME content type */
37
- contentType: string;
38
- /** Creator DID */
39
- creator: string;
40
- /** Creation timestamp */
41
- createdAt: string;
42
- }
43
-
44
- /**
45
- * Subject data for a ResourceUpdated credential
46
- */
47
- export interface ResourceUpdatedSubject {
48
- /** ID of the subject (typically the asset DID) */
49
- id: string;
50
- /** Resource identifier */
51
- resourceId: string;
52
- /** Previous content hash */
53
- previousHash: string;
54
- /** New content hash */
55
- newHash: string;
56
- /** Previous version number */
57
- fromVersion: number;
58
- /** New version number */
59
- toVersion: number;
60
- /** Update timestamp */
61
- updatedAt: string;
62
- /** Optional description of changes */
63
- updateReason?: string;
64
- }
65
-
66
- /**
67
- * Subject data for a MigrationCompleted credential
68
- */
69
- export interface MigrationSubject {
70
- /** ID of the subject (typically the asset DID) */
71
- id: string;
72
- /** Source DID (before migration) */
73
- sourceDid: string;
74
- /** Target DID (after migration) */
75
- targetDid?: string;
76
- /** Layer migrated from */
77
- fromLayer: LayerType;
78
- /** Layer migrated to */
79
- toLayer: LayerType;
80
- /** Migration timestamp */
81
- migratedAt: string;
82
- /** Transaction ID (for Bitcoin migrations) */
83
- transactionId?: string;
84
- /** Inscription ID (for Bitcoin migrations) */
85
- inscriptionId?: string;
86
- /** Satoshi number (for Bitcoin migrations) */
87
- satoshi?: string;
88
- /** Optional reason for migration */
89
- migrationReason?: string;
90
- }
91
-
92
- /**
93
- * Subject data for an OwnershipTransferred credential
94
- */
95
- export interface OwnershipSubject {
96
- /** ID of the subject (typically the asset DID) */
97
- id: string;
98
- /** Previous owner DID or address */
99
- previousOwner: string;
100
- /** New owner DID or address */
101
- newOwner: string;
102
- /** Transfer timestamp */
103
- transferredAt: string;
104
- /** Transaction ID for the transfer */
105
- transactionId: string;
106
- /** Satoshi number of the inscription */
107
- satoshi?: string;
108
- /** Optional transfer reason or notes */
109
- transferReason?: string;
110
- }
111
-
112
- /**
113
- * Options for creating credentials with chaining
114
- */
115
- export interface CredentialChainOptions {
116
- /** Previous credential ID to chain from */
117
- previousCredentialId?: string;
118
- /** Hash of the previous credential for verification */
119
- previousCredentialHash?: string;
120
- /** Optional expiration date */
121
- expirationDate?: string;
122
- /** Optional credential status information */
123
- credentialStatus?: {
124
- id: string;
125
- type: string;
126
- };
127
- }
128
-
129
- /**
130
- * Options for BBS+ selective disclosure
131
- */
132
- export interface SelectiveDisclosureOptions {
133
- /** JSON Pointer paths to fields that must always be disclosed */
134
- mandatoryPointers: string[];
135
- /** JSON Pointer paths to fields the holder can selectively disclose */
136
- selectivePointers?: string[];
137
- }
138
-
139
- /**
140
- * Result of creating a derived proof with selective disclosure
141
- */
142
- export interface DerivedProofResult {
143
- /** The credential with derived proof */
144
- credential: VerifiableCredential;
145
- /** Fields that were disclosed */
146
- disclosedFields: string[];
147
- /** Fields that were hidden */
148
- hiddenFields: string[];
149
- }
150
-
151
- export class CredentialManager {
152
- constructor(private config: OriginalsConfig, private didManager?: DIDManager) {}
153
-
154
- async createResourceCredential(
155
- type: 'ResourceCreated' | 'ResourceUpdated' | 'ResourceMigrated',
156
- subject: CredentialSubject,
157
- issuer: string
158
- ): Promise<VerifiableCredential> {
159
- return {
160
- '@context': ['https://www.w3.org/2018/credentials/v1'],
161
- type: ['VerifiableCredential', type],
162
- issuer,
163
- issuanceDate: new Date().toISOString(),
164
- credentialSubject: subject
165
- };
166
- }
167
-
168
- async signCredential(
169
- credential: VerifiableCredential,
170
- privateKeyMultibase: string,
171
- verificationMethod: string
172
- ): Promise<VerifiableCredential> {
173
- if (this.didManager && typeof verificationMethod === 'string' && verificationMethod.startsWith('did:')) {
174
- try {
175
- const loader = createDocumentLoader(this.didManager);
176
- const { document } = await loader(verificationMethod);
177
- if (document && document.publicKeyMultibase) {
178
- const vm: VerificationMethodLike = {
179
- id: verificationMethod,
180
- controller: typeof credential.issuer === 'string' ? credential.issuer : (credential.issuer as any)?.id,
181
- publicKeyMultibase: document.publicKeyMultibase,
182
- secretKeyMultibase: privateKeyMultibase,
183
- type: document.type || 'Multikey'
184
- } as any;
185
- const issuer = new Issuer(this.didManager, vm);
186
- const unsigned: any = { ...credential };
187
- delete unsigned['@context'];
188
- delete unsigned.proof;
189
- return issuer.issueCredential(unsigned, { proofPurpose: 'assertionMethod' });
190
- }
191
- } catch {
192
- // fall through to legacy signing
193
- }
194
- }
195
-
196
- // fallback to legacy local signer
197
- const proofBase: Proof = {
198
- type: 'DataIntegrityProof',
199
- created: new Date().toISOString(),
200
- verificationMethod,
201
- proofPurpose: 'assertionMethod',
202
- proofValue: ''
203
- };
204
- const proofValue = await this.generateProofValue(credential, privateKeyMultibase, proofBase);
205
- const proof: Proof = { ...proofBase, proofValue };
206
- return { ...credential, proof };
207
- }
208
-
209
- /**
210
- * Sign a credential using an external signer (e.g., hardware wallet, Turnkey)
211
- * @param credential - The unsigned credential
212
- * @param signer - External signer implementation
213
- * @returns Signed verifiable credential
214
- */
215
- async signCredentialWithExternalSigner(
216
- credential: VerifiableCredential,
217
- signer: ExternalSigner
218
- ): Promise<VerifiableCredential> {
219
- const verificationMethodId = await signer.getVerificationMethodId();
220
-
221
- // Create proof structure
222
- const proofBase = {
223
- type: 'DataIntegrityProof',
224
- cryptosuite: 'eddsa-rdfc-2022', // Or derive from signer type
225
- created: new Date().toISOString(),
226
- verificationMethod: verificationMethodId,
227
- proofPurpose: 'assertionMethod'
228
- };
229
-
230
- // Prepare unsigned credential
231
- const unsignedCredential: any = { ...credential };
232
- delete unsignedCredential.proof;
233
-
234
- // Use external signer to sign
235
- const { proofValue } = await signer.sign({
236
- document: unsignedCredential,
237
- proof: proofBase
238
- });
239
-
240
- // Return signed credential
241
- return {
242
- ...credential,
243
- proof: {
244
- ...proofBase,
245
- proofValue
246
- }
247
- };
248
- }
249
-
250
- async verifyCredential(credential: VerifiableCredential): Promise<boolean> {
251
- if (this.didManager) {
252
- const proofAny: any = (credential as any).proof;
253
- if (proofAny && (proofAny.cryptosuite || (Array.isArray(proofAny) && proofAny[0]?.cryptosuite))) {
254
- const verifier = new Verifier(this.didManager);
255
- const res = await verifier.verifyCredential(credential);
256
- return res.verified;
257
- }
258
- }
259
-
260
- const proof = credential.proof as Proof | undefined;
261
- if (!proof) {
262
- return false;
263
- }
264
-
265
- const { proofValue, verificationMethod } = proof;
266
- if (!proofValue || !verificationMethod) return false;
267
-
268
- const signature = this.decodeMultibase(proofValue);
269
- if (!signature) return false;
270
-
271
- const proofSansValue = { ...proof } as any;
272
- delete proofSansValue.proofValue;
273
- const proofInput: any = { ...proofSansValue };
274
- const credentialContext = (credential as any)['@context'];
275
- if (credentialContext && !proofInput['@context']) {
276
- proofInput['@context'] = credentialContext;
277
- }
278
- const unsignedCredential: any = { ...credential };
279
- delete unsignedCredential.proof;
280
-
281
- const c14nProof = await canonicalizeDocument(proofInput);
282
- const c14nCred = await canonicalizeDocument(unsignedCredential);
283
- const hProof = Buffer.from(sha256(Buffer.from(c14nProof, 'utf8')));
284
- const hCred = Buffer.from(sha256(Buffer.from(c14nCred, 'utf8')));
285
- const digest = Buffer.concat([hProof, hCred]);
286
- const signer = this.getSigner();
287
- try {
288
- const resolvedKey = (proof as any).publicKeyMultibase
289
- || await this.resolveVerificationMethodMultibase(verificationMethod);
290
- if (!resolvedKey) {
291
- return false;
292
- }
293
- return await signer.verify(Buffer.from(digest), Buffer.from(signature), resolvedKey);
294
- } catch {
295
- return false;
296
- }
297
- }
298
-
299
- async createPresentation(
300
- credentials: VerifiableCredential[],
301
- holder: string
302
- ): Promise<VerifiablePresentation> {
303
- return {
304
- '@context': ['https://www.w3.org/2018/credentials/v1'],
305
- type: ['VerifiablePresentation'],
306
- holder,
307
- verifiableCredential: credentials
308
- } as any;
309
- }
310
-
311
- private async generateProofValue(
312
- credential: VerifiableCredential,
313
- privateKeyMultibase: string,
314
- proofBase: Proof
315
- ): Promise<string> {
316
- // Construct canonical digest including provided proof sans proofValue
317
- const proofSansValue = { ...proofBase } as any;
318
- delete proofSansValue.proofValue;
319
- const proofInput: any = { ...proofSansValue };
320
- const credentialContext = (credential as any)['@context'];
321
- if (credentialContext && !proofInput['@context']) {
322
- proofInput['@context'] = credentialContext;
323
- }
324
- const unsignedCredential: any = { ...credential };
325
- delete unsignedCredential.proof;
326
-
327
- const c14nProof = await canonicalizeDocument(proofInput);
328
- const c14nCred = await canonicalizeDocument(unsignedCredential);
329
- const hProof = Buffer.from(sha256(Buffer.from(c14nProof, 'utf8')));
330
- const hCred = Buffer.from(sha256(Buffer.from(c14nCred, 'utf8')));
331
- const digest = Buffer.concat([hProof, hCred]);
332
- const signer = this.getSigner();
333
- const sig = await signer.sign(Buffer.from(digest), privateKeyMultibase);
334
- return encodeBase64UrlMultibase(sig);
335
- }
336
-
337
- private getSigner(): Signer {
338
- switch (this.config.defaultKeyType) {
339
- case 'ES256K':
340
- return new ES256KSigner();
341
- case 'Ed25519':
342
- return new Ed25519Signer();
343
- case 'ES256':
344
- return new ES256Signer();
345
- default:
346
- return new ES256KSigner();
347
- }
348
- }
349
-
350
- private async resolveVerificationMethodMultibase(
351
- verificationMethod: string
352
- ): Promise<string | null> {
353
- if (typeof verificationMethod === 'string' && verificationMethod.startsWith('z')) {
354
- return verificationMethod;
355
- }
356
-
357
- if (!this.didManager || typeof verificationMethod !== 'string' || !verificationMethod.startsWith('did:')) {
358
- return null;
359
- }
360
-
361
- const loader = createDocumentLoader(this.didManager);
362
- try {
363
- const { document } = await loader(verificationMethod);
364
- if (document && typeof document.publicKeyMultibase === 'string') {
365
- return document.publicKeyMultibase;
366
- }
367
- } catch (err) {
368
- // Document loader failed; will try alternative resolution method
369
- if (this.config.enableLogging) {
370
- console.warn('Failed to load verification method via document loader:', err);
371
- }
372
- }
373
-
374
- try {
375
- const did = verificationMethod.split('#')[0];
376
- if (!did) {
377
- return null;
378
- }
379
- const didDoc = await this.didManager.resolveDID(did);
380
- const vms = (didDoc as any)?.verificationMethod;
381
- if (Array.isArray(vms)) {
382
- const vm = vms.find((m: any) => m?.id === verificationMethod);
383
- if (vm && typeof vm.publicKeyMultibase === 'string') {
384
- return vm.publicKeyMultibase;
385
- }
386
- }
387
- } catch (err) {
388
- // Failed to resolve DID document
389
- if (this.config.enableLogging) {
390
- console.warn('Failed to resolve DID for verification method:', err);
391
- }
392
- }
393
-
394
- return null;
395
- }
396
-
397
- private decodeMultibase(s: string): Uint8Array | null {
398
- try {
399
- return decodeBase64UrlMultibase(s);
400
- } catch {
401
- return null;
402
- }
403
- }
404
-
405
- // ===== Credential Factory Methods =====
406
-
407
- /**
408
- * Issue a ResourceCreated credential for a newly created resource
409
- *
410
- * @param resource - The created resource
411
- * @param assetDid - The DID of the asset containing the resource
412
- * @param creatorDid - The DID of the creator
413
- * @param chainOptions - Optional chaining options for linking to previous credentials
414
- * @returns Unsigned verifiable credential
415
- *
416
- * @example
417
- * ```typescript
418
- * const credential = await credentialManager.issueResourceCredential(
419
- * resource,
420
- * 'did:peer:abc...',
421
- * 'did:peer:creator...'
422
- * );
423
- * // Sign the credential with your key
424
- * const signed = await credentialManager.signCredential(credential, privateKey, vmId);
425
- * ```
426
- */
427
- async issueResourceCredential(
428
- resource: AssetResource,
429
- assetDid: string,
430
- creatorDid: string,
431
- chainOptions?: CredentialChainOptions
432
- ): Promise<VerifiableCredential> {
433
- const subject: ResourceCreatedSubject = {
434
- id: assetDid,
435
- resourceId: resource.id,
436
- resourceType: resource.type,
437
- contentHash: resource.hash,
438
- contentType: resource.contentType,
439
- creator: creatorDid,
440
- createdAt: resource.createdAt || new Date().toISOString()
441
- };
442
-
443
- const credential = await this.createCredentialWithChain(
444
- 'ResourceCreated',
445
- subject,
446
- creatorDid,
447
- chainOptions
448
- );
449
-
450
- return credential;
451
- }
452
-
453
- /**
454
- * Issue a ResourceUpdated credential for a resource version update
455
- *
456
- * @param resourceId - The logical resource ID
457
- * @param assetDid - The DID of the asset
458
- * @param previousHash - Hash of the previous version
459
- * @param newHash - Hash of the new version
460
- * @param fromVersion - Previous version number
461
- * @param toVersion - New version number
462
- * @param updaterDid - DID of the entity performing the update
463
- * @param updateReason - Optional reason for the update
464
- * @param chainOptions - Optional chaining options
465
- * @returns Unsigned verifiable credential
466
- *
467
- * @example
468
- * ```typescript
469
- * const credential = await credentialManager.issueResourceUpdateCredential(
470
- * 'main.js',
471
- * 'did:webvh:example.com:asset',
472
- * 'abc123...',
473
- * 'def456...',
474
- * 1,
475
- * 2,
476
- * 'did:webvh:example.com:user',
477
- * 'Bug fix'
478
- * );
479
- * ```
480
- */
481
- async issueResourceUpdateCredential(
482
- resourceId: string,
483
- assetDid: string,
484
- previousHash: string,
485
- newHash: string,
486
- fromVersion: number,
487
- toVersion: number,
488
- updaterDid: string,
489
- updateReason?: string,
490
- chainOptions?: CredentialChainOptions
491
- ): Promise<VerifiableCredential> {
492
- const subject: ResourceUpdatedSubject = {
493
- id: assetDid,
494
- resourceId,
495
- previousHash,
496
- newHash,
497
- fromVersion,
498
- toVersion,
499
- updatedAt: new Date().toISOString(),
500
- ...(updateReason && { updateReason })
501
- };
502
-
503
- const credential = await this.createCredentialWithChain(
504
- 'ResourceUpdated',
505
- subject,
506
- updaterDid,
507
- chainOptions
508
- );
509
-
510
- return credential;
511
- }
512
-
513
- /**
514
- * Issue a MigrationCompleted credential for layer migrations
515
- *
516
- * Records the migration of an asset between Originals layers (peer -> webvh -> btco).
517
- *
518
- * @param sourceDid - The source DID (before migration)
519
- * @param targetDid - The target DID (after migration, if different)
520
- * @param fromLayer - The source layer
521
- * @param toLayer - The target layer
522
- * @param issuerDid - The DID issuing this credential
523
- * @param details - Optional migration details (transactionId, inscriptionId, satoshi)
524
- * @param chainOptions - Optional chaining options
525
- * @returns Unsigned verifiable credential
526
- *
527
- * @example
528
- * ```typescript
529
- * const credential = await credentialManager.issueMigrationCredential(
530
- * 'did:peer:abc...',
531
- * 'did:webvh:example.com:asset',
532
- * 'did:peer',
533
- * 'did:webvh',
534
- * 'did:webvh:example.com:publisher'
535
- * );
536
- * ```
537
- */
538
- async issueMigrationCredential(
539
- sourceDid: string,
540
- targetDid: string | undefined,
541
- fromLayer: LayerType,
542
- toLayer: LayerType,
543
- issuerDid: string,
544
- details?: {
545
- transactionId?: string;
546
- inscriptionId?: string;
547
- satoshi?: string;
548
- migrationReason?: string;
549
- },
550
- chainOptions?: CredentialChainOptions
551
- ): Promise<VerifiableCredential> {
552
- const subject: MigrationSubject = {
553
- id: targetDid || sourceDid,
554
- sourceDid,
555
- ...(targetDid && { targetDid }),
556
- fromLayer,
557
- toLayer,
558
- migratedAt: new Date().toISOString(),
559
- ...(details?.transactionId && { transactionId: details.transactionId }),
560
- ...(details?.inscriptionId && { inscriptionId: details.inscriptionId }),
561
- ...(details?.satoshi && { satoshi: details.satoshi }),
562
- ...(details?.migrationReason && { migrationReason: details.migrationReason })
563
- };
564
-
565
- const credential = await this.createCredentialWithChain(
566
- 'MigrationCompleted',
567
- subject,
568
- issuerDid,
569
- chainOptions
570
- );
571
-
572
- return credential;
573
- }
574
-
575
- /**
576
- * Issue an OwnershipTransferred credential for Bitcoin-anchored asset transfers
577
- *
578
- * Records the transfer of ownership of a did:btco asset to a new owner.
579
- *
580
- * @param assetDid - The DID of the asset being transferred
581
- * @param previousOwner - The previous owner (DID or Bitcoin address)
582
- * @param newOwner - The new owner (Bitcoin address)
583
- * @param transactionId - The Bitcoin transaction ID
584
- * @param issuerDid - The DID issuing this credential
585
- * @param details - Optional additional details
586
- * @param chainOptions - Optional chaining options
587
- * @returns Unsigned verifiable credential
588
- *
589
- * @example
590
- * ```typescript
591
- * const credential = await credentialManager.issueOwnershipCredential(
592
- * 'did:btco:12345',
593
- * 'bc1q...oldowner',
594
- * 'bc1q...newowner',
595
- * 'abc123...txid',
596
- * 'did:btco:12345'
597
- * );
598
- * ```
599
- */
600
- async issueOwnershipCredential(
601
- assetDid: string,
602
- previousOwner: string,
603
- newOwner: string,
604
- transactionId: string,
605
- issuerDid: string,
606
- details?: {
607
- satoshi?: string;
608
- transferReason?: string;
609
- },
610
- chainOptions?: CredentialChainOptions
611
- ): Promise<VerifiableCredential> {
612
- const subject: OwnershipSubject = {
613
- id: assetDid,
614
- previousOwner,
615
- newOwner,
616
- transferredAt: new Date().toISOString(),
617
- transactionId,
618
- ...(details?.satoshi && { satoshi: details.satoshi }),
619
- ...(details?.transferReason && { transferReason: details.transferReason })
620
- };
621
-
622
- const credential = await this.createCredentialWithChain(
623
- 'OwnershipTransferred',
624
- subject,
625
- issuerDid,
626
- chainOptions
627
- );
628
-
629
- return credential;
630
- }
631
-
632
- /**
633
- * Create a credential with optional chaining to a previous credential
634
- *
635
- * Credential chaining creates a verifiable provenance chain by linking
636
- * credentials together through their IDs and hashes.
637
- *
638
- * @param type - The credential type
639
- * @param subject - The credential subject
640
- * @param issuer - The issuer DID
641
- * @param chainOptions - Optional chaining options
642
- * @returns Unsigned verifiable credential with chain metadata
643
- */
644
- private async createCredentialWithChain(
645
- type: string,
646
- subject: CredentialSubject,
647
- issuer: string,
648
- chainOptions?: CredentialChainOptions
649
- ): Promise<VerifiableCredential> {
650
- const credential: VerifiableCredential = {
651
- '@context': [
652
- 'https://www.w3.org/2018/credentials/v1',
653
- 'https://w3id.org/security/data-integrity/v2'
654
- ],
655
- type: ['VerifiableCredential', type],
656
- id: this.generateCredentialId(),
657
- issuer,
658
- issuanceDate: new Date().toISOString(),
659
- credentialSubject: subject
660
- };
661
-
662
- // Add expiration if specified
663
- if (chainOptions?.expirationDate) {
664
- credential.expirationDate = chainOptions.expirationDate;
665
- }
666
-
667
- // Add credential status if specified
668
- if (chainOptions?.credentialStatus) {
669
- credential.credentialStatus = chainOptions.credentialStatus;
670
- }
671
-
672
- // Add chaining metadata if provided
673
- if (chainOptions?.previousCredentialId || chainOptions?.previousCredentialHash) {
674
- (credential.credentialSubject as any).previousCredential = {
675
- ...(chainOptions.previousCredentialId && { id: chainOptions.previousCredentialId }),
676
- ...(chainOptions.previousCredentialHash && { hash: chainOptions.previousCredentialHash })
677
- };
678
- }
679
-
680
- return credential;
681
- }
682
-
683
- /**
684
- * Generate a unique credential ID
685
- */
686
- private generateCredentialId(): string {
687
- const timestamp = Date.now();
688
- const randomBytes = new Uint8Array(16);
689
- if (typeof globalThis.crypto?.getRandomValues === 'function') {
690
- globalThis.crypto.getRandomValues(randomBytes);
691
- } else {
692
- // Fallback for environments without crypto.getRandomValues
693
- for (let i = 0; i < 16; i++) {
694
- randomBytes[i] = Math.floor(Math.random() * 256);
695
- }
696
- }
697
- const randomHex = bytesToHex(randomBytes);
698
- return `urn:uuid:${timestamp}-${randomHex.substring(0, 8)}-${randomHex.substring(8, 16)}`;
699
- }
700
-
701
- /**
702
- * Compute the hash of a credential for chaining purposes
703
- *
704
- * @param credential - The credential to hash
705
- * @returns SHA-256 hash of the canonicalized credential
706
- */
707
- async computeCredentialHash(credential: VerifiableCredential): Promise<string> {
708
- const canonicalized = await canonicalizeDocument(credential as any);
709
- const hash = sha256(Buffer.from(canonicalized, 'utf8'));
710
- return bytesToHex(hash);
711
- }
712
-
713
- /**
714
- * Verify a credential chain by checking all previous credential links
715
- *
716
- * @param credentials - Array of credentials in chain order (oldest first)
717
- * @returns Verification result with chain integrity status
718
- */
719
- async verifyCredentialChain(credentials: VerifiableCredential[]): Promise<{
720
- valid: boolean;
721
- errors: string[];
722
- chainLength: number;
723
- }> {
724
- const errors: string[] = [];
725
-
726
- if (credentials.length === 0) {
727
- return { valid: true, errors: [], chainLength: 0 };
728
- }
729
-
730
- // Verify each credential individually
731
- for (let i = 0; i < credentials.length; i++) {
732
- const isValid = await this.verifyCredential(credentials[i]);
733
- if (!isValid) {
734
- errors.push(`Credential at index ${i} failed verification`);
735
- }
736
- }
737
-
738
- // Verify chain links
739
- for (let i = 1; i < credentials.length; i++) {
740
- const current = credentials[i];
741
- const previous = credentials[i - 1];
742
-
743
- const previousCredRef = (current.credentialSubject as any)?.previousCredential;
744
-
745
- if (previousCredRef) {
746
- // Verify ID link
747
- if (previousCredRef.id && previousCredRef.id !== previous.id) {
748
- errors.push(`Chain broken at index ${i}: previousCredential.id doesn't match`);
749
- }
750
-
751
- // Verify hash link
752
- if (previousCredRef.hash) {
753
- const expectedHash = await this.computeCredentialHash(previous);
754
- if (previousCredRef.hash !== expectedHash) {
755
- errors.push(`Chain broken at index ${i}: previousCredential.hash doesn't match`);
756
- }
757
- }
758
- }
759
- }
760
-
761
- return {
762
- valid: errors.length === 0,
763
- errors,
764
- chainLength: credentials.length
765
- };
766
- }
767
-
768
- // ===== BBS+ Selective Disclosure =====
769
-
770
- /**
771
- * Prepare a credential for BBS+ selective disclosure
772
- *
773
- * This creates a base proof that can later be derived into a proof
774
- * that selectively discloses only certain fields.
775
- *
776
- * Note: This requires BBS+ keys and is primarily used for privacy-preserving
777
- * credential presentations.
778
- *
779
- * @param credential - The credential to prepare
780
- * @param options - Selective disclosure options
781
- * @returns The credential with BBS+ base proof metadata
782
- */
783
- async prepareSelectiveDisclosure(
784
- credential: VerifiableCredential,
785
- options: SelectiveDisclosureOptions
786
- ): Promise<{
787
- credential: VerifiableCredential;
788
- mandatoryPointers: string[];
789
- selectivePointers: string[];
790
- }> {
791
- // Validate mandatory pointers
792
- if (!options.mandatoryPointers || options.mandatoryPointers.length === 0) {
793
- throw new Error('At least one mandatory pointer is required for selective disclosure');
794
- }
795
-
796
- // Validate pointer format (JSON Pointers must start with /)
797
- for (const pointer of options.mandatoryPointers) {
798
- if (!pointer.startsWith('/')) {
799
- throw new Error(`Invalid JSON Pointer: ${pointer} (must start with /)`);
800
- }
801
- }
802
-
803
- const selectivePointers = options.selectivePointers || [];
804
- for (const pointer of selectivePointers) {
805
- if (!pointer.startsWith('/')) {
806
- throw new Error(`Invalid JSON Pointer: ${pointer} (must start with /)`);
807
- }
808
- }
809
-
810
- // Add selective disclosure metadata to credential
811
- const enhancedCredential = {
812
- ...credential,
813
- // Store pointers in credential for later derivation
814
- // In a full implementation, this would involve creating a BBS+ base proof
815
- };
816
-
817
- return {
818
- credential: enhancedCredential,
819
- mandatoryPointers: options.mandatoryPointers,
820
- selectivePointers
821
- };
822
- }
823
-
824
- /**
825
- * Create a derived proof with selective disclosure
826
- *
827
- * Given a credential with a BBS+ base proof, creates a derived proof
828
- * that only reveals the specified fields.
829
- *
830
- * @param credential - The credential with BBS+ base proof
831
- * @param fieldsToDisclose - JSON Pointer paths to disclose
832
- * @param presentationHeader - Optional presentation-specific data
833
- * @returns The credential with derived proof
834
- */
835
- async deriveSelectiveProof(
836
- credential: VerifiableCredential,
837
- fieldsToDisclose: string[],
838
- presentationHeader?: Uint8Array
839
- ): Promise<DerivedProofResult> {
840
- // Validate that all disclosed fields are valid JSON pointers
841
- for (const field of fieldsToDisclose) {
842
- if (!field.startsWith('/')) {
843
- throw new Error(`Invalid JSON Pointer for disclosure: ${field}`);
844
- }
845
- }
846
-
847
- // Determine which fields will be hidden
848
- const allFields = this.extractFieldPaths(credential);
849
- const disclosedSet = new Set(fieldsToDisclose);
850
- const hiddenFields = allFields.filter(f => !disclosedSet.has(f));
851
-
852
- // In a full implementation, this would:
853
- // 1. Parse the base proof
854
- // 2. Create selective indexes from fieldsToDisclose
855
- // 3. Generate the derived BBS+ proof
856
- // For now, we return a structure showing what would be disclosed
857
-
858
- return {
859
- credential: {
860
- ...credential,
861
- // A real implementation would have a derived proof here
862
- },
863
- disclosedFields: fieldsToDisclose,
864
- hiddenFields
865
- };
866
- }
867
-
868
- /**
869
- * Extract all field paths from a credential as JSON Pointers
870
- */
871
- private extractFieldPaths(obj: any, prefix = ''): string[] {
872
- const paths: string[] = [];
873
-
874
- if (typeof obj !== 'object' || obj === null) {
875
- return paths;
876
- }
877
-
878
- for (const [key, value] of Object.entries(obj)) {
879
- const path = `${prefix}/${key}`;
880
- paths.push(path);
881
-
882
- if (typeof value === 'object' && value !== null && !Array.isArray(value)) {
883
- paths.push(...this.extractFieldPaths(value, path));
884
- }
885
- }
886
-
887
- return paths;
888
- }
889
-
890
- /**
891
- * Get field value from credential using JSON Pointer
892
- *
893
- * @param credential - The credential to read from
894
- * @param pointer - JSON Pointer path (e.g., /credentialSubject/name)
895
- * @returns The value at the pointer path, or undefined if not found
896
- */
897
- getFieldByPointer(credential: VerifiableCredential, pointer: string): any {
898
- if (!pointer.startsWith('/')) {
899
- throw new Error('JSON Pointer must start with /');
900
- }
901
-
902
- const parts = pointer.slice(1).split('/');
903
- let current: any = credential;
904
-
905
- for (const part of parts) {
906
- if (current === null || current === undefined) {
907
- return undefined;
908
- }
909
- // Handle escaped characters in JSON Pointer
910
- const unescaped = part.replace(/~1/g, '/').replace(/~0/g, '~');
911
- current = current[unescaped];
912
- }
913
-
914
- return current;
915
- }
916
- }
917
-
918
-