@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,62 +0,0 @@
1
- import { OriginalsSDK } from '../index';
2
- async function basicExample() {
3
- const sdk = OriginalsSDK.create({
4
- network: 'regtest',
5
- enableLogging: true,
6
- // Example uses defaults; provide adapters in your app or tests
7
- telemetry: {
8
- onEvent: (e) => console.log('[telemetry]', e.name, e.attributes || {}),
9
- onError: (err) => console.warn('[error]', err.code, err.message)
10
- }
11
- });
12
- // Create new digital asset
13
- const resources = [{
14
- id: 'image-1',
15
- type: 'image',
16
- content: 'base64-encoded-image-data',
17
- contentType: 'image/png',
18
- hash: 'sha256-hash'
19
- }];
20
- try {
21
- // Create asset in did:peer layer (private, offline)
22
- const asset = await sdk.lifecycle.createAsset(resources);
23
- console.log('Created asset:', asset.id);
24
- console.log('Current layer:', asset.currentLayer); // 'did:peer'
25
- // Publish to web for discovery (did:webvh layer)
26
- await sdk.lifecycle.publishToWeb(asset, 'example.com');
27
- console.log('Published to web, current layer:', asset.currentLayer); // 'did:webvh'
28
- // Inscribe on Bitcoin for permanent ownership (did:btco layer)
29
- await sdk.lifecycle.inscribeOnBitcoin(asset);
30
- console.log('Inscribed on Bitcoin, current layer:', asset.currentLayer); // 'did:btco'
31
- // Get full provenance chain
32
- const provenance = asset.getProvenance();
33
- console.log('Provenance:', provenance);
34
- // Verify asset integrity
35
- const isValid = await asset.verify();
36
- console.log('Asset is valid:', isValid);
37
- }
38
- catch (error) {
39
- console.error('Error:', error);
40
- }
41
- }
42
- async function digitalArtExample() {
43
- const sdk = OriginalsSDK.create();
44
- // Artist creates digital artwork
45
- const artwork = [{
46
- id: 'artwork-001',
47
- type: 'image',
48
- url: 'https://artist-site.com/my-artwork.jpg',
49
- contentType: 'image/jpeg',
50
- hash: 'abcd1234...' // SHA-256 hash of image
51
- }];
52
- // Create private version for experimentation
53
- const asset = await sdk.lifecycle.createAsset(artwork);
54
- // Make discoverable when ready
55
- await sdk.lifecycle.publishToWeb(asset, 'artist-gallery.com');
56
- // Inscribe on Bitcoin when sold
57
- await sdk.lifecycle.inscribeOnBitcoin(asset);
58
- // Transfer to buyer
59
- await sdk.lifecycle.transferOwnership(asset, 'buyer-address');
60
- }
61
- // Export examples
62
- export { basicExample, digitalArtExample };
@@ -1 +0,0 @@
1
- export {};
@@ -1,4 +0,0 @@
1
- import { basicExample } from './basic-usage';
2
- import { digitalArtExample } from './basic-usage';
3
- basicExample();
4
- digitalArtExample();
package/dist/index.d.ts DELETED
@@ -1,39 +0,0 @@
1
- import './crypto/noble-init.js';
2
- import { OriginalsSDK } from './core/OriginalsSDK.js';
3
- export { OriginalsSDK } from './core/OriginalsSDK.js';
4
- export type { OriginalsSDKOptions, OriginalResult, CreateOriginalOptions, UpdateOriginalOptions, CreateDIDOriginalOptions, UpdateDIDOriginalOptions } from './core/OriginalsSDK.js';
5
- export { OriginalsAsset } from './lifecycle/OriginalsAsset.js';
6
- export type { ProvenanceChain } from './lifecycle/OriginalsAsset.js';
7
- export * from './types/index.js';
8
- export { DIDManager, type CreateWebVHOptions, type CreateWebVHResult } from './did/DIDManager.js';
9
- export { KeyManager } from './did/KeyManager.js';
10
- export { Ed25519Verifier } from './did/Ed25519Verifier.js';
11
- export * as encoding from './utils/encoding.js';
12
- export { CredentialManager } from './vc/CredentialManager.js';
13
- export { LifecycleManager } from './lifecycle/LifecycleManager.js';
14
- export { BitcoinManager } from './bitcoin/BitcoinManager.js';
15
- export { OrdinalsClient } from './bitcoin/OrdinalsClient.js';
16
- export { buildTransferTransaction } from './bitcoin/transfer.js';
17
- export { selectUtxos, UtxoSelectionError, estimateFeeSats } from './bitcoin/utxo.js';
18
- export { selectUtxos as selectUtxosSimple, selectResourceUtxos, selectUtxosForPayment, tagResourceUtxos, estimateTransactionSize } from './bitcoin/utxo-selection.js';
19
- export { calculateFee } from './bitcoin/fee-calculation.js';
20
- export { BBSCryptosuiteUtils } from './vc/cryptosuites/bbs.js';
21
- export { BbsSimple } from './vc/cryptosuites/bbsSimple.js';
22
- export * from './storage/index.js';
23
- export { Signer, ES256KSigner, Ed25519Signer, ES256Signer, Bls12381G2Signer } from './crypto/Signer.js';
24
- export { multikey } from './crypto/Multikey.js';
25
- export type { MultikeyType } from './crypto/Multikey.js';
26
- export * from './events/index.js';
27
- export { MigrationManager } from './migration/index.js';
28
- export * from './migration/types.js';
29
- export { BatchOperationExecutor, BatchValidator, BatchError, type BatchResult, type BatchOperationOptions, type BatchInscriptionOptions, type BatchInscriptionResult, type ValidationResult } from './lifecycle/BatchOperations.js';
30
- export * from './utils/validation.js';
31
- export * from './utils/satoshi-validation.js';
32
- export * from './utils/serialization.js';
33
- export * from './utils/retry.js';
34
- export * from './utils/telemetry.js';
35
- export { sha256Bytes } from './utils/hash.js';
36
- export { OrdMockProvider } from './adapters/providers/OrdMockProvider.js';
37
- export { FeeOracleMock } from './adapters/FeeOracleMock.js';
38
- export type { OrdinalsProvider, FeeOracleAdapter, StorageAdapter } from './adapters/types.js';
39
- export default OriginalsSDK;
package/dist/index.js DELETED
@@ -1,47 +0,0 @@
1
- /* istanbul ignore file */
2
- // Initialize noble crypto libraries first (must run before any crypto operations)
3
- import './crypto/noble-init.js';
4
- import { OriginalsSDK } from './core/OriginalsSDK.js';
5
- // Main exports
6
- export { OriginalsSDK } from './core/OriginalsSDK.js';
7
- export { OriginalsAsset } from './lifecycle/OriginalsAsset.js';
8
- // Type exports
9
- export * from './types/index.js';
10
- // Manager exports
11
- export { DIDManager } from './did/DIDManager.js';
12
- export { KeyManager } from './did/KeyManager.js';
13
- export { Ed25519Verifier } from './did/Ed25519Verifier.js';
14
- export * as encoding from './utils/encoding.js';
15
- export { CredentialManager } from './vc/CredentialManager.js';
16
- export { LifecycleManager } from './lifecycle/LifecycleManager.js';
17
- export { BitcoinManager } from './bitcoin/BitcoinManager.js';
18
- export { OrdinalsClient } from './bitcoin/OrdinalsClient.js';
19
- export { buildTransferTransaction } from './bitcoin/transfer.js';
20
- export { selectUtxos, UtxoSelectionError, estimateFeeSats } from './bitcoin/utxo.js';
21
- export { selectUtxos as selectUtxosSimple, selectResourceUtxos, selectUtxosForPayment, tagResourceUtxos, estimateTransactionSize } from './bitcoin/utxo-selection.js';
22
- export { calculateFee } from './bitcoin/fee-calculation.js';
23
- export { BBSCryptosuiteUtils } from './vc/cryptosuites/bbs.js';
24
- export { BbsSimple } from './vc/cryptosuites/bbsSimple.js';
25
- export * from './storage/index.js';
26
- // Crypto exports
27
- export { Signer, ES256KSigner, Ed25519Signer, ES256Signer, Bls12381G2Signer } from './crypto/Signer.js';
28
- export { multikey } from './crypto/Multikey.js';
29
- // Event system exports
30
- export * from './events/index.js';
31
- // Migration system exports
32
- export { MigrationManager } from './migration/index.js';
33
- export * from './migration/types.js';
34
- // Batch operations exports
35
- export { BatchOperationExecutor, BatchValidator, BatchError } from './lifecycle/BatchOperations.js';
36
- // Utility exports
37
- export * from './utils/validation.js';
38
- export * from './utils/satoshi-validation.js';
39
- export * from './utils/serialization.js';
40
- export * from './utils/retry.js';
41
- export * from './utils/telemetry.js';
42
- export { sha256Bytes } from './utils/hash.js';
43
- // Adapter exports (for testing and custom integrations)
44
- export { OrdMockProvider } from './adapters/providers/OrdMockProvider.js';
45
- export { FeeOracleMock } from './adapters/FeeOracleMock.js';
46
- // Default export
47
- export default OriginalsSDK;
@@ -1,147 +0,0 @@
1
- /**
2
- * Batch Operations for Originals SDK
3
- *
4
- * Enables efficient processing of multiple assets with:
5
- * - Configurable concurrency
6
- * - Retry logic with exponential backoff
7
- * - Fail-fast vs continue-on-error modes
8
- * - Pre-validation of all items
9
- * - Detailed timing and error tracking
10
- */
11
- /**
12
- * Result of a batch operation containing successful and failed items
13
- */
14
- export interface BatchResult<T> {
15
- successful: Array<{
16
- index: number;
17
- result: T;
18
- duration: number;
19
- }>;
20
- failed: Array<{
21
- index: number;
22
- error: Error;
23
- duration: number;
24
- retryAttempts?: number;
25
- }>;
26
- totalProcessed: number;
27
- totalDuration: number;
28
- batchId: string;
29
- startedAt: string;
30
- completedAt: string;
31
- }
32
- /**
33
- * Options for configuring batch operation execution
34
- */
35
- export interface BatchOperationOptions {
36
- continueOnError?: boolean;
37
- maxConcurrent?: number;
38
- retryCount?: number;
39
- retryDelay?: number;
40
- timeoutMs?: number;
41
- validateFirst?: boolean;
42
- }
43
- /**
44
- * Options for batch inscription operations with Bitcoin-specific settings
45
- */
46
- export interface BatchInscriptionOptions extends BatchOperationOptions {
47
- singleTransaction?: boolean;
48
- feeRate?: number;
49
- }
50
- /**
51
- * Error thrown when a batch operation fails
52
- */
53
- export declare class BatchError extends Error {
54
- batchId: string;
55
- operation: string;
56
- partialResults: {
57
- successful: number;
58
- failed: number;
59
- };
60
- constructor(batchId: string, operation: string, partialResults: {
61
- successful: number;
62
- failed: number;
63
- }, message: string);
64
- }
65
- /**
66
- * Result of a single-transaction batch inscription with cost analysis
67
- */
68
- export interface BatchInscriptionResult<T> {
69
- batchTransactionId: string;
70
- individualInscriptionIds: string[];
71
- assets: T[];
72
- totalFee: number;
73
- feePerAsset: number[];
74
- feeSavings: {
75
- batchFee: number;
76
- individualFees: number;
77
- savings: number;
78
- savingsPercentage: number;
79
- };
80
- batchId: string;
81
- processingTime: number;
82
- }
83
- /**
84
- * Executor for batch operations with configurable options
85
- */
86
- export declare class BatchOperationExecutor {
87
- private defaultOptions;
88
- constructor(defaultOptions?: BatchOperationOptions);
89
- /**
90
- * Execute a batch operation on multiple items
91
- *
92
- * @param items - Array of items to process
93
- * @param operation - Function to execute on each item
94
- * @param options - Batch operation options
95
- * @param predeterminedBatchId - Optional pre-generated batch ID for event correlation
96
- * @returns BatchResult with successful and failed operations
97
- */
98
- execute<T, R>(items: T[], operation: (item: T, index: number) => Promise<R>, options?: BatchOperationOptions, predeterminedBatchId?: string): Promise<BatchResult<R>>;
99
- /**
100
- * Generate unique batch ID
101
- */
102
- generateBatchId(): string;
103
- /**
104
- * Calculate retry delay with exponential backoff
105
- */
106
- private calculateRetryDelay;
107
- /**
108
- * Execute operation with timeout
109
- */
110
- private executeWithTimeout;
111
- /**
112
- * Sleep for specified milliseconds
113
- */
114
- private sleep;
115
- /**
116
- * Chunk array into smaller arrays of specified size
117
- */
118
- private chunkArray;
119
- }
120
- /**
121
- * Validation result for batch operations
122
- */
123
- export interface ValidationResult {
124
- isValid: boolean;
125
- errors: string[];
126
- warnings?: string[];
127
- }
128
- /**
129
- * Validator for batch operations
130
- */
131
- export declare class BatchValidator {
132
- /**
133
- * Validate batch of resources for asset creation
134
- */
135
- validateBatchCreate(resourcesList: any[][]): ValidationResult[];
136
- /**
137
- * Validate batch of assets for inscription
138
- */
139
- validateBatchInscription(assets: any[]): ValidationResult[];
140
- /**
141
- * Validate batch of transfer operations
142
- */
143
- validateBatchTransfer(transfers: Array<{
144
- asset: any;
145
- to: string;
146
- }>): ValidationResult[];
147
- }
@@ -1,251 +0,0 @@
1
- /**
2
- * Batch Operations for Originals SDK
3
- *
4
- * Enables efficient processing of multiple assets with:
5
- * - Configurable concurrency
6
- * - Retry logic with exponential backoff
7
- * - Fail-fast vs continue-on-error modes
8
- * - Pre-validation of all items
9
- * - Detailed timing and error tracking
10
- */
11
- import { randomBytes, bytesToHex } from '@noble/hashes/utils.js';
12
- /**
13
- * Error thrown when a batch operation fails
14
- */
15
- export class BatchError extends Error {
16
- constructor(batchId, operation, partialResults, message) {
17
- super(message);
18
- this.batchId = batchId;
19
- this.operation = operation;
20
- this.partialResults = partialResults;
21
- this.name = 'BatchError';
22
- }
23
- }
24
- /**
25
- * Executor for batch operations with configurable options
26
- */
27
- export class BatchOperationExecutor {
28
- constructor(defaultOptions = {}) {
29
- this.defaultOptions = defaultOptions;
30
- }
31
- /**
32
- * Execute a batch operation on multiple items
33
- *
34
- * @param items - Array of items to process
35
- * @param operation - Function to execute on each item
36
- * @param options - Batch operation options
37
- * @param predeterminedBatchId - Optional pre-generated batch ID for event correlation
38
- * @returns BatchResult with successful and failed operations
39
- */
40
- async execute(items, operation, options, predeterminedBatchId) {
41
- const opts = { ...this.defaultOptions, ...options };
42
- const { continueOnError = false, maxConcurrent = 1, retryCount = 0, retryDelay = 1000, timeoutMs = 30000 } = opts;
43
- const batchId = predeterminedBatchId || this.generateBatchId();
44
- const startedAt = new Date().toISOString();
45
- const startTime = Date.now();
46
- const successful = [];
47
- const failed = [];
48
- // Process items with concurrency control
49
- const processItem = async (item, index) => {
50
- const itemStartTime = Date.now();
51
- let lastError = null;
52
- let attempts = 0;
53
- for (let attempt = 0; attempt <= retryCount; attempt++) {
54
- attempts = attempt + 1;
55
- try {
56
- // Execute with timeout
57
- const result = await this.executeWithTimeout(() => operation(item, index), timeoutMs);
58
- const duration = Date.now() - itemStartTime;
59
- successful.push({ index, result, duration });
60
- return;
61
- }
62
- catch (error) {
63
- lastError = error instanceof Error ? error : new Error(String(error));
64
- // If not last attempt, wait with exponential backoff
65
- if (attempt < retryCount) {
66
- const delay = this.calculateRetryDelay(attempt, retryDelay);
67
- await this.sleep(delay);
68
- }
69
- }
70
- }
71
- // All retries failed
72
- const duration = Date.now() - itemStartTime;
73
- failed.push({
74
- index,
75
- error: lastError,
76
- duration,
77
- retryAttempts: attempts - 1
78
- });
79
- // If fail-fast mode, throw error
80
- if (!continueOnError) {
81
- throw lastError;
82
- }
83
- };
84
- // Process items in batches based on maxConcurrent
85
- try {
86
- if (maxConcurrent === 1) {
87
- // Sequential processing
88
- for (let i = 0; i < items.length; i++) {
89
- await processItem(items[i], i);
90
- }
91
- }
92
- else {
93
- // Concurrent processing with limit
94
- const chunks = this.chunkArray(items, maxConcurrent);
95
- for (const chunk of chunks) {
96
- await Promise.all(chunk.map((item, chunkIndex) => {
97
- const globalIndex = chunks.slice(0, chunks.indexOf(chunk))
98
- .reduce((acc, c) => acc + c.length, 0) + chunkIndex;
99
- return processItem(item, globalIndex);
100
- }));
101
- }
102
- }
103
- }
104
- catch (error) {
105
- // In fail-fast mode, re-throw the error so callers can handle it
106
- if (!continueOnError) {
107
- throw error instanceof Error ? error : new Error(String(error));
108
- }
109
- // In continue-on-error mode, the error was already logged in processItem
110
- // and we'll return the partial results below
111
- }
112
- const totalDuration = Date.now() - startTime;
113
- const completedAt = new Date().toISOString();
114
- return {
115
- successful,
116
- failed,
117
- totalProcessed: successful.length + failed.length,
118
- totalDuration,
119
- batchId,
120
- startedAt,
121
- completedAt
122
- };
123
- }
124
- /**
125
- * Generate unique batch ID
126
- */
127
- generateBatchId() {
128
- return `batch_${Date.now()}_${bytesToHex(randomBytes(8))}`;
129
- }
130
- /**
131
- * Calculate retry delay with exponential backoff
132
- */
133
- calculateRetryDelay(attempt, baseDelay) {
134
- // Exponential backoff: baseDelay * 2^attempt
135
- return baseDelay * Math.pow(2, attempt);
136
- }
137
- /**
138
- * Execute operation with timeout
139
- */
140
- async executeWithTimeout(operation, timeoutMs) {
141
- return Promise.race([
142
- operation(),
143
- new Promise((_, reject) => setTimeout(() => reject(new Error(`Operation timeout after ${timeoutMs}ms`)), timeoutMs))
144
- ]);
145
- }
146
- /**
147
- * Sleep for specified milliseconds
148
- */
149
- sleep(ms) {
150
- return new Promise(resolve => setTimeout(resolve, ms));
151
- }
152
- /**
153
- * Chunk array into smaller arrays of specified size
154
- */
155
- chunkArray(array, size) {
156
- const chunks = [];
157
- for (let i = 0; i < array.length; i += size) {
158
- chunks.push(array.slice(i, i + size));
159
- }
160
- return chunks;
161
- }
162
- }
163
- /**
164
- * Validator for batch operations
165
- */
166
- export class BatchValidator {
167
- /**
168
- * Validate batch of resources for asset creation
169
- */
170
- validateBatchCreate(resourcesList) {
171
- return resourcesList.map((resources, index) => {
172
- const errors = [];
173
- if (!Array.isArray(resources)) {
174
- errors.push(`Item ${index}: Resources must be an array`);
175
- return { isValid: false, errors };
176
- }
177
- if (resources.length === 0) {
178
- errors.push(`Item ${index}: At least one resource is required`);
179
- return { isValid: false, errors };
180
- }
181
- // Validate each resource
182
- for (let i = 0; i < resources.length; i++) {
183
- const resource = resources[i];
184
- if (!resource || typeof resource !== 'object') {
185
- errors.push(`Item ${index}, resource ${i}: Invalid resource object`);
186
- continue;
187
- }
188
- if (!resource.id || typeof resource.id !== 'string') {
189
- errors.push(`Item ${index}, resource ${i}: Missing or invalid id`);
190
- }
191
- if (!resource.type || typeof resource.type !== 'string') {
192
- errors.push(`Item ${index}, resource ${i}: Missing or invalid type`);
193
- }
194
- if (!resource.contentType || typeof resource.contentType !== 'string') {
195
- errors.push(`Item ${index}, resource ${i}: Missing or invalid contentType`);
196
- }
197
- if (!resource.hash || typeof resource.hash !== 'string' || !/^[0-9a-fA-F]+$/.test(resource.hash)) {
198
- errors.push(`Item ${index}, resource ${i}: Missing or invalid hash`);
199
- }
200
- }
201
- return { isValid: errors.length === 0, errors };
202
- });
203
- }
204
- /**
205
- * Validate batch of assets for inscription
206
- */
207
- validateBatchInscription(assets) {
208
- return assets.map((asset, index) => {
209
- const errors = [];
210
- if (!asset || typeof asset !== 'object') {
211
- errors.push(`Item ${index}: Invalid asset object`);
212
- return { isValid: false, errors };
213
- }
214
- if (!asset.id || typeof asset.id !== 'string') {
215
- errors.push(`Item ${index}: Missing or invalid asset id`);
216
- }
217
- if (!asset.currentLayer) {
218
- errors.push(`Item ${index}: Missing currentLayer`);
219
- }
220
- else if (asset.currentLayer === 'did:btco') {
221
- errors.push(`Item ${index}: Asset already inscribed on Bitcoin`);
222
- }
223
- if (!asset.resources || !Array.isArray(asset.resources) || asset.resources.length === 0) {
224
- errors.push(`Item ${index}: Asset must have at least one resource`);
225
- }
226
- return { isValid: errors.length === 0, errors };
227
- });
228
- }
229
- /**
230
- * Validate batch of transfer operations
231
- */
232
- validateBatchTransfer(transfers) {
233
- return transfers.map((transfer, index) => {
234
- const errors = [];
235
- if (!transfer || typeof transfer !== 'object') {
236
- errors.push(`Item ${index}: Invalid transfer object`);
237
- return { isValid: false, errors };
238
- }
239
- if (!transfer.asset || typeof transfer.asset !== 'object') {
240
- errors.push(`Item ${index}: Invalid asset`);
241
- }
242
- else if (transfer.asset.currentLayer !== 'did:btco') {
243
- errors.push(`Item ${index}: Asset must be inscribed on Bitcoin before transfer`);
244
- }
245
- if (!transfer.to || typeof transfer.to !== 'string') {
246
- errors.push(`Item ${index}: Invalid destination address`);
247
- }
248
- return { isValid: errors.length === 0, errors };
249
- });
250
- }
251
- }
@@ -1,116 +0,0 @@
1
- import { OriginalsConfig, AssetResource, BitcoinTransaction, KeyStore, ExternalSigner } from '../types';
2
- import { BitcoinManager } from '../bitcoin/BitcoinManager';
3
- import { DIDManager } from '../did/DIDManager';
4
- import { CredentialManager } from '../vc/CredentialManager';
5
- import { OriginalsAsset } from './OriginalsAsset';
6
- import type { EventHandler, EventTypeMap } from '../events/types';
7
- import { type BatchResult, type BatchOperationOptions, type BatchInscriptionOptions } from './BatchOperations';
8
- export declare class LifecycleManager {
9
- private config;
10
- private didManager;
11
- private credentialManager;
12
- private deps?;
13
- private keyStore?;
14
- private eventEmitter;
15
- private batchExecutor;
16
- private batchValidator;
17
- private logger;
18
- private metrics;
19
- constructor(config: OriginalsConfig, didManager: DIDManager, credentialManager: CredentialManager, deps?: {
20
- bitcoinManager?: BitcoinManager;
21
- } | undefined, keyStore?: KeyStore | undefined);
22
- /**
23
- * Subscribe to a lifecycle event
24
- * @param eventType - The type of event to subscribe to
25
- * @param handler - The handler function to call when the event is emitted
26
- * @returns A function to unsubscribe from the event
27
- */
28
- on<K extends keyof EventTypeMap>(eventType: K, handler: EventHandler<EventTypeMap[K]>): () => void;
29
- /**
30
- * Subscribe to a lifecycle event once
31
- * @param eventType - The type of event to subscribe to
32
- * @param handler - The handler function to call when the event is emitted (will only fire once)
33
- * @returns A function to unsubscribe from the event
34
- */
35
- once<K extends keyof EventTypeMap>(eventType: K, handler: EventHandler<EventTypeMap[K]>): () => void;
36
- /**
37
- * Unsubscribe from a lifecycle event
38
- * @param eventType - The type of event to unsubscribe from
39
- * @param handler - The handler function to remove
40
- */
41
- off<K extends keyof EventTypeMap>(eventType: K, handler: EventHandler<EventTypeMap[K]>): void;
42
- registerKey(verificationMethodId: string, privateKey: string): Promise<void>;
43
- createAsset(resources: AssetResource[]): Promise<OriginalsAsset>;
44
- publishToWeb(asset: OriginalsAsset, publisherDidOrSigner: string | ExternalSigner): Promise<OriginalsAsset>;
45
- private extractPublisherInfo;
46
- private parseWebVHDid;
47
- private publishResources;
48
- private emitResourcePublishedEvent;
49
- private issuePublicationCredential;
50
- private signWithKeyStore;
51
- inscribeOnBitcoin(asset: OriginalsAsset, feeRate?: number): Promise<OriginalsAsset>;
52
- transferOwnership(asset: OriginalsAsset, newOwner: string): Promise<BitcoinTransaction>;
53
- /**
54
- * Create multiple assets in batch
55
- *
56
- * @param resourcesList - Array of resource arrays, one per asset to create
57
- * @param options - Batch operation options
58
- * @returns BatchResult with created assets
59
- */
60
- batchCreateAssets(resourcesList: AssetResource[][], options?: BatchOperationOptions): Promise<BatchResult<OriginalsAsset>>;
61
- /**
62
- * Publish multiple assets to web storage in batch
63
- *
64
- * @param assets - Array of assets to publish
65
- * @param domain - Domain to publish to
66
- * @param options - Batch operation options
67
- * @returns BatchResult with published assets
68
- */
69
- batchPublishToWeb(assets: OriginalsAsset[], domain: string, options?: BatchOperationOptions): Promise<BatchResult<OriginalsAsset>>;
70
- /**
71
- * Inscribe multiple assets on Bitcoin with cost optimization
72
- * KEY FEATURE: singleTransaction option for 30%+ cost savings
73
- *
74
- * @param assets - Array of assets to inscribe
75
- * @param options - Batch inscription options
76
- * @returns BatchResult with inscribed assets
77
- */
78
- batchInscribeOnBitcoin(assets: OriginalsAsset[], options?: BatchInscriptionOptions): Promise<BatchResult<OriginalsAsset>>;
79
- /**
80
- * CORE INNOVATION: Single-transaction batch inscription
81
- * Combines multiple assets into one Bitcoin transaction for 30%+ cost savings
82
- *
83
- * @param assets - Array of assets to inscribe
84
- * @param options - Batch inscription options
85
- * @returns BatchResult with inscribed assets and cost savings data
86
- */
87
- private batchInscribeSingleTransaction;
88
- /**
89
- * Individual transaction batch inscription (fallback mode)
90
- * Each asset is inscribed in its own transaction
91
- *
92
- * @param assets - Array of assets to inscribe
93
- * @param options - Batch inscription options
94
- * @returns BatchResult with inscribed assets
95
- */
96
- private batchInscribeIndividualTransactions;
97
- /**
98
- * Transfer ownership of multiple assets in batch
99
- *
100
- * @param transfers - Array of transfer operations
101
- * @param options - Batch operation options
102
- * @returns BatchResult with transaction results
103
- */
104
- batchTransferOwnership(transfers: Array<{
105
- asset: OriginalsAsset;
106
- to: string;
107
- }>, options?: BatchOperationOptions): Promise<BatchResult<BitcoinTransaction>>;
108
- /**
109
- * Calculate total data size for all assets in a batch
110
- */
111
- private calculateTotalDataSize;
112
- /**
113
- * Estimate cost savings from batch inscription vs individual inscriptions
114
- */
115
- private estimateBatchSavings;
116
- }