@originals/sdk 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (403) hide show
  1. package/.eslintrc.json +33 -0
  2. package/.turbo/turbo-build.log +1 -0
  3. package/.turbo/turbo-test.log +68353 -0
  4. package/dist/adapters/FeeOracleMock.d.ts +6 -0
  5. package/dist/adapters/FeeOracleMock.js +8 -0
  6. package/dist/adapters/index.d.ts +4 -0
  7. package/dist/adapters/index.js +4 -0
  8. package/dist/adapters/providers/OrdHttpProvider.d.ts +56 -0
  9. package/dist/adapters/providers/OrdHttpProvider.js +110 -0
  10. package/dist/adapters/providers/OrdMockProvider.d.ts +70 -0
  11. package/dist/adapters/providers/OrdMockProvider.js +75 -0
  12. package/dist/adapters/types.d.ts +71 -0
  13. package/dist/adapters/types.js +1 -0
  14. package/dist/bitcoin/BitcoinManager.d.ts +15 -0
  15. package/dist/bitcoin/BitcoinManager.js +262 -0
  16. package/dist/bitcoin/BroadcastClient.d.ts +30 -0
  17. package/dist/bitcoin/BroadcastClient.js +35 -0
  18. package/dist/bitcoin/OrdinalsClient.d.ts +21 -0
  19. package/dist/bitcoin/OrdinalsClient.js +105 -0
  20. package/dist/bitcoin/PSBTBuilder.d.ts +24 -0
  21. package/dist/bitcoin/PSBTBuilder.js +80 -0
  22. package/dist/bitcoin/fee-calculation.d.ts +14 -0
  23. package/dist/bitcoin/fee-calculation.js +31 -0
  24. package/dist/bitcoin/providers/OrdNodeProvider.d.ts +38 -0
  25. package/dist/bitcoin/providers/OrdNodeProvider.js +67 -0
  26. package/dist/bitcoin/providers/OrdinalsProvider.d.ts +33 -0
  27. package/dist/bitcoin/providers/OrdinalsProvider.js +50 -0
  28. package/dist/bitcoin/providers/types.d.ts +63 -0
  29. package/dist/bitcoin/providers/types.js +1 -0
  30. package/dist/bitcoin/transactions/commit.d.ts +89 -0
  31. package/dist/bitcoin/transactions/commit.js +311 -0
  32. package/dist/bitcoin/transactions/index.d.ts +7 -0
  33. package/dist/bitcoin/transactions/index.js +8 -0
  34. package/dist/bitcoin/transfer.d.ts +9 -0
  35. package/dist/bitcoin/transfer.js +26 -0
  36. package/dist/bitcoin/utxo-selection.d.ts +78 -0
  37. package/dist/bitcoin/utxo-selection.js +237 -0
  38. package/dist/bitcoin/utxo.d.ts +26 -0
  39. package/dist/bitcoin/utxo.js +78 -0
  40. package/dist/contexts/credentials-v1.json +195 -0
  41. package/dist/contexts/credentials-v2-examples.json +5 -0
  42. package/dist/contexts/credentials-v2.json +301 -0
  43. package/dist/contexts/credentials.json +195 -0
  44. package/dist/contexts/data-integrity-v2.json +81 -0
  45. package/dist/contexts/dids.json +57 -0
  46. package/dist/contexts/ed255192020.json +93 -0
  47. package/dist/contexts/ordinals-plus.json +23 -0
  48. package/dist/contexts/originals.json +22 -0
  49. package/dist/core/OriginalsSDK.d.ts +158 -0
  50. package/dist/core/OriginalsSDK.js +274 -0
  51. package/dist/crypto/Multikey.d.ts +30 -0
  52. package/dist/crypto/Multikey.js +149 -0
  53. package/dist/crypto/Signer.d.ts +21 -0
  54. package/dist/crypto/Signer.js +196 -0
  55. package/dist/crypto/noble-init.d.ts +18 -0
  56. package/dist/crypto/noble-init.js +106 -0
  57. package/dist/did/BtcoDidResolver.d.ts +57 -0
  58. package/dist/did/BtcoDidResolver.js +166 -0
  59. package/dist/did/DIDManager.d.ts +101 -0
  60. package/dist/did/DIDManager.js +493 -0
  61. package/dist/did/Ed25519Verifier.d.ts +30 -0
  62. package/dist/did/Ed25519Verifier.js +59 -0
  63. package/dist/did/KeyManager.d.ts +17 -0
  64. package/dist/did/KeyManager.js +207 -0
  65. package/dist/did/WebVHManager.d.ts +100 -0
  66. package/dist/did/WebVHManager.js +304 -0
  67. package/dist/did/createBtcoDidDocument.d.ts +10 -0
  68. package/dist/did/createBtcoDidDocument.js +42 -0
  69. package/dist/did/providers/OrdinalsClientProviderAdapter.d.ts +23 -0
  70. package/dist/did/providers/OrdinalsClientProviderAdapter.js +51 -0
  71. package/dist/events/EventEmitter.d.ts +115 -0
  72. package/dist/events/EventEmitter.js +198 -0
  73. package/dist/events/index.d.ts +7 -0
  74. package/dist/events/index.js +6 -0
  75. package/dist/events/types.d.ts +286 -0
  76. package/dist/events/types.js +9 -0
  77. package/dist/examples/basic-usage.d.ts +3 -0
  78. package/dist/examples/basic-usage.js +62 -0
  79. package/dist/examples/run.d.ts +1 -0
  80. package/dist/examples/run.js +4 -0
  81. package/dist/index.d.ts +39 -0
  82. package/dist/index.js +47 -0
  83. package/dist/lifecycle/BatchOperations.d.ts +147 -0
  84. package/dist/lifecycle/BatchOperations.js +251 -0
  85. package/dist/lifecycle/LifecycleManager.d.ts +116 -0
  86. package/dist/lifecycle/LifecycleManager.js +971 -0
  87. package/dist/lifecycle/OriginalsAsset.d.ts +164 -0
  88. package/dist/lifecycle/OriginalsAsset.js +380 -0
  89. package/dist/lifecycle/ProvenanceQuery.d.ts +126 -0
  90. package/dist/lifecycle/ProvenanceQuery.js +220 -0
  91. package/dist/lifecycle/ResourceVersioning.d.ts +73 -0
  92. package/dist/lifecycle/ResourceVersioning.js +127 -0
  93. package/dist/migration/MigrationManager.d.ts +86 -0
  94. package/dist/migration/MigrationManager.js +412 -0
  95. package/dist/migration/audit/AuditLogger.d.ts +51 -0
  96. package/dist/migration/audit/AuditLogger.js +156 -0
  97. package/dist/migration/checkpoint/CheckpointManager.d.ts +31 -0
  98. package/dist/migration/checkpoint/CheckpointManager.js +96 -0
  99. package/dist/migration/checkpoint/CheckpointStorage.d.ts +26 -0
  100. package/dist/migration/checkpoint/CheckpointStorage.js +89 -0
  101. package/dist/migration/index.d.ts +22 -0
  102. package/dist/migration/index.js +27 -0
  103. package/dist/migration/operations/BaseMigration.d.ts +48 -0
  104. package/dist/migration/operations/BaseMigration.js +83 -0
  105. package/dist/migration/operations/PeerToBtcoMigration.d.ts +25 -0
  106. package/dist/migration/operations/PeerToBtcoMigration.js +67 -0
  107. package/dist/migration/operations/PeerToWebvhMigration.d.ts +19 -0
  108. package/dist/migration/operations/PeerToWebvhMigration.js +46 -0
  109. package/dist/migration/operations/WebvhToBtcoMigration.d.ts +25 -0
  110. package/dist/migration/operations/WebvhToBtcoMigration.js +67 -0
  111. package/dist/migration/rollback/RollbackManager.d.ts +29 -0
  112. package/dist/migration/rollback/RollbackManager.js +146 -0
  113. package/dist/migration/state/StateMachine.d.ts +25 -0
  114. package/dist/migration/state/StateMachine.js +76 -0
  115. package/dist/migration/state/StateTracker.d.ts +36 -0
  116. package/dist/migration/state/StateTracker.js +123 -0
  117. package/dist/migration/types.d.ts +306 -0
  118. package/dist/migration/types.js +33 -0
  119. package/dist/migration/validation/BitcoinValidator.d.ts +13 -0
  120. package/dist/migration/validation/BitcoinValidator.js +83 -0
  121. package/dist/migration/validation/CredentialValidator.d.ts +13 -0
  122. package/dist/migration/validation/CredentialValidator.js +46 -0
  123. package/dist/migration/validation/DIDCompatibilityValidator.d.ts +16 -0
  124. package/dist/migration/validation/DIDCompatibilityValidator.js +127 -0
  125. package/dist/migration/validation/LifecycleValidator.d.ts +10 -0
  126. package/dist/migration/validation/LifecycleValidator.js +52 -0
  127. package/dist/migration/validation/StorageValidator.d.ts +10 -0
  128. package/dist/migration/validation/StorageValidator.js +65 -0
  129. package/dist/migration/validation/ValidationPipeline.d.ts +29 -0
  130. package/dist/migration/validation/ValidationPipeline.js +180 -0
  131. package/dist/storage/LocalStorageAdapter.d.ts +11 -0
  132. package/dist/storage/LocalStorageAdapter.js +53 -0
  133. package/dist/storage/MemoryStorageAdapter.d.ts +6 -0
  134. package/dist/storage/MemoryStorageAdapter.js +21 -0
  135. package/dist/storage/StorageAdapter.d.ts +16 -0
  136. package/dist/storage/StorageAdapter.js +1 -0
  137. package/dist/storage/index.d.ts +2 -0
  138. package/dist/storage/index.js +2 -0
  139. package/dist/types/bitcoin.d.ts +84 -0
  140. package/dist/types/bitcoin.js +1 -0
  141. package/dist/types/common.d.ts +82 -0
  142. package/dist/types/common.js +1 -0
  143. package/dist/types/credentials.d.ts +75 -0
  144. package/dist/types/credentials.js +1 -0
  145. package/dist/types/did.d.ts +26 -0
  146. package/dist/types/did.js +1 -0
  147. package/dist/types/index.d.ts +5 -0
  148. package/dist/types/index.js +5 -0
  149. package/dist/types/network.d.ts +78 -0
  150. package/dist/types/network.js +145 -0
  151. package/dist/utils/EventLogger.d.ts +71 -0
  152. package/dist/utils/EventLogger.js +232 -0
  153. package/dist/utils/Logger.d.ts +106 -0
  154. package/dist/utils/Logger.js +257 -0
  155. package/dist/utils/MetricsCollector.d.ts +110 -0
  156. package/dist/utils/MetricsCollector.js +264 -0
  157. package/dist/utils/bitcoin-address.d.ts +38 -0
  158. package/dist/utils/bitcoin-address.js +113 -0
  159. package/dist/utils/cbor.d.ts +2 -0
  160. package/dist/utils/cbor.js +9 -0
  161. package/dist/utils/encoding.d.ts +37 -0
  162. package/dist/utils/encoding.js +120 -0
  163. package/dist/utils/hash.d.ts +1 -0
  164. package/dist/utils/hash.js +5 -0
  165. package/dist/utils/retry.d.ts +10 -0
  166. package/dist/utils/retry.js +35 -0
  167. package/dist/utils/satoshi-validation.d.ts +60 -0
  168. package/dist/utils/satoshi-validation.js +156 -0
  169. package/dist/utils/serialization.d.ts +14 -0
  170. package/dist/utils/serialization.js +76 -0
  171. package/dist/utils/telemetry.d.ts +17 -0
  172. package/dist/utils/telemetry.js +24 -0
  173. package/dist/utils/validation.d.ts +5 -0
  174. package/dist/utils/validation.js +98 -0
  175. package/dist/vc/CredentialManager.d.ts +22 -0
  176. package/dist/vc/CredentialManager.js +227 -0
  177. package/dist/vc/Issuer.d.ts +27 -0
  178. package/dist/vc/Issuer.js +70 -0
  179. package/dist/vc/Verifier.d.ts +16 -0
  180. package/dist/vc/Verifier.js +50 -0
  181. package/dist/vc/cryptosuites/bbs.d.ts +44 -0
  182. package/dist/vc/cryptosuites/bbs.js +213 -0
  183. package/dist/vc/cryptosuites/bbsSimple.d.ts +9 -0
  184. package/dist/vc/cryptosuites/bbsSimple.js +12 -0
  185. package/dist/vc/cryptosuites/eddsa.d.ts +30 -0
  186. package/dist/vc/cryptosuites/eddsa.js +81 -0
  187. package/dist/vc/documentLoader.d.ts +16 -0
  188. package/dist/vc/documentLoader.js +59 -0
  189. package/dist/vc/proofs/data-integrity.d.ts +21 -0
  190. package/dist/vc/proofs/data-integrity.js +15 -0
  191. package/dist/vc/utils/jsonld.d.ts +2 -0
  192. package/dist/vc/utils/jsonld.js +15 -0
  193. package/package.json +79 -0
  194. package/src/adapters/FeeOracleMock.ts +9 -0
  195. package/src/adapters/index.ts +5 -0
  196. package/src/adapters/providers/OrdHttpProvider.ts +126 -0
  197. package/src/adapters/providers/OrdMockProvider.ts +101 -0
  198. package/src/adapters/types.ts +66 -0
  199. package/src/bitcoin/BitcoinManager.ts +330 -0
  200. package/src/bitcoin/BroadcastClient.ts +54 -0
  201. package/src/bitcoin/OrdinalsClient.ts +119 -0
  202. package/src/bitcoin/PSBTBuilder.ts +106 -0
  203. package/src/bitcoin/fee-calculation.ts +38 -0
  204. package/src/bitcoin/providers/OrdNodeProvider.ts +92 -0
  205. package/src/bitcoin/providers/OrdinalsProvider.ts +56 -0
  206. package/src/bitcoin/providers/types.ts +59 -0
  207. package/src/bitcoin/transactions/commit.ts +465 -0
  208. package/src/bitcoin/transactions/index.ts +13 -0
  209. package/src/bitcoin/transfer.ts +43 -0
  210. package/src/bitcoin/utxo-selection.ts +322 -0
  211. package/src/bitcoin/utxo.ts +113 -0
  212. package/src/contexts/credentials-v1.json +237 -0
  213. package/src/contexts/credentials-v2-examples.json +5 -0
  214. package/src/contexts/credentials-v2.json +340 -0
  215. package/src/contexts/credentials.json +237 -0
  216. package/src/contexts/data-integrity-v2.json +81 -0
  217. package/src/contexts/dids.json +58 -0
  218. package/src/contexts/ed255192020.json +93 -0
  219. package/src/contexts/ordinals-plus.json +23 -0
  220. package/src/contexts/originals.json +22 -0
  221. package/src/core/OriginalsSDK.ts +416 -0
  222. package/src/crypto/Multikey.ts +194 -0
  223. package/src/crypto/Signer.ts +254 -0
  224. package/src/crypto/noble-init.ts +121 -0
  225. package/src/did/BtcoDidResolver.ts +227 -0
  226. package/src/did/DIDManager.ts +694 -0
  227. package/src/did/Ed25519Verifier.ts +68 -0
  228. package/src/did/KeyManager.ts +236 -0
  229. package/src/did/WebVHManager.ts +489 -0
  230. package/src/did/createBtcoDidDocument.ts +59 -0
  231. package/src/did/providers/OrdinalsClientProviderAdapter.ts +68 -0
  232. package/src/events/EventEmitter.ts +222 -0
  233. package/src/events/index.ts +19 -0
  234. package/src/events/types.ts +331 -0
  235. package/src/examples/basic-usage.ts +78 -0
  236. package/src/examples/run.ts +5 -0
  237. package/src/index.ts +84 -0
  238. package/src/lifecycle/BatchOperations.ts +373 -0
  239. package/src/lifecycle/LifecycleManager.ts +1218 -0
  240. package/src/lifecycle/OriginalsAsset.ts +524 -0
  241. package/src/lifecycle/ProvenanceQuery.ts +280 -0
  242. package/src/lifecycle/ResourceVersioning.ts +163 -0
  243. package/src/migration/MigrationManager.ts +527 -0
  244. package/src/migration/audit/AuditLogger.ts +176 -0
  245. package/src/migration/checkpoint/CheckpointManager.ts +112 -0
  246. package/src/migration/checkpoint/CheckpointStorage.ts +101 -0
  247. package/src/migration/index.ts +33 -0
  248. package/src/migration/operations/BaseMigration.ts +126 -0
  249. package/src/migration/operations/PeerToBtcoMigration.ts +105 -0
  250. package/src/migration/operations/PeerToWebvhMigration.ts +62 -0
  251. package/src/migration/operations/WebvhToBtcoMigration.ts +105 -0
  252. package/src/migration/rollback/RollbackManager.ts +170 -0
  253. package/src/migration/state/StateMachine.ts +92 -0
  254. package/src/migration/state/StateTracker.ts +156 -0
  255. package/src/migration/types.ts +344 -0
  256. package/src/migration/validation/BitcoinValidator.ts +107 -0
  257. package/src/migration/validation/CredentialValidator.ts +62 -0
  258. package/src/migration/validation/DIDCompatibilityValidator.ts +151 -0
  259. package/src/migration/validation/LifecycleValidator.ts +64 -0
  260. package/src/migration/validation/StorageValidator.ts +79 -0
  261. package/src/migration/validation/ValidationPipeline.ts +213 -0
  262. package/src/storage/LocalStorageAdapter.ts +61 -0
  263. package/src/storage/MemoryStorageAdapter.ts +29 -0
  264. package/src/storage/StorageAdapter.ts +25 -0
  265. package/src/storage/index.ts +3 -0
  266. package/src/types/bitcoin.ts +98 -0
  267. package/src/types/common.ts +92 -0
  268. package/src/types/credentials.ts +88 -0
  269. package/src/types/did.ts +31 -0
  270. package/src/types/external-shims.d.ts +53 -0
  271. package/src/types/index.ts +7 -0
  272. package/src/types/network.ts +175 -0
  273. package/src/utils/EventLogger.ts +298 -0
  274. package/src/utils/Logger.ts +322 -0
  275. package/src/utils/MetricsCollector.ts +358 -0
  276. package/src/utils/bitcoin-address.ts +130 -0
  277. package/src/utils/cbor.ts +12 -0
  278. package/src/utils/encoding.ts +127 -0
  279. package/src/utils/hash.ts +6 -0
  280. package/src/utils/retry.ts +46 -0
  281. package/src/utils/satoshi-validation.ts +196 -0
  282. package/src/utils/serialization.ts +96 -0
  283. package/src/utils/telemetry.ts +40 -0
  284. package/src/utils/validation.ts +119 -0
  285. package/src/vc/CredentialManager.ts +273 -0
  286. package/src/vc/Issuer.ts +100 -0
  287. package/src/vc/Verifier.ts +47 -0
  288. package/src/vc/cryptosuites/bbs.ts +253 -0
  289. package/src/vc/cryptosuites/bbsSimple.ts +21 -0
  290. package/src/vc/cryptosuites/eddsa.ts +99 -0
  291. package/src/vc/documentLoader.ts +67 -0
  292. package/src/vc/proofs/data-integrity.ts +33 -0
  293. package/src/vc/utils/jsonld.ts +18 -0
  294. package/test/logs/did_webvh_QmQsRNhXxPSCSeLjpbKYcNMZj8b1kBQAoC6cZmkFAgmpHt_example_com.jsonl +1 -0
  295. package/test/logs/did_webvh_QmSQkpD58qxcqMWHYcEmDUn3wk7hHvJwzYTrZmhh6zjPQ8_example_com_users_alice123_profile.jsonl +1 -0
  296. package/test/logs/did_webvh_QmTMda6VW3cUPdKk5Yc3onnv1vdgEumvWWdP2noAYFSjeG_example_com.jsonl +1 -0
  297. package/test/logs/did_webvh_QmTkb8KnCYcsnKKDCY4eUQuKQdKJLrCinvhw13v3zETxpE_example_com_users_etc_passwd.jsonl +1 -0
  298. package/test/logs/did_webvh_QmTn9FdCfpXFDrxHH52pwB4iNrDFVvNDjJ5FQTcDbmM3Fg_example_com.jsonl +1 -0
  299. package/test/logs/did_webvh_QmUCQUi1xjtJjnSQ1XJZgKqcWgErx1v7E2dz4DAPraAyJP_example_com_etc_passwd.jsonl +1 -0
  300. package/test/logs/did_webvh_QmUENQJCDKBJVRS5BkL6zjaUvcRjkb9xHmy7foCgRjmv3W_example_com.jsonl +1 -0
  301. package/test/logs/did_webvh_QmUPdGyjYBEnQ3aQUkmqyyBKTyjvCP5RZQGiaEDeTtf6dc_example_com.jsonl +1 -0
  302. package/test/logs/did_webvh_QmUoHTuHMWzQM29ZFrE9VLtMxkZ5u869yqee8LwcCLN39M_example_com.jsonl +1 -0
  303. package/test/logs/did_webvh_QmUrnms8G65ggVKsr9oQeWrLUBuGChwQPPb2LCFvaoNxaw_example_com_users_alice.jsonl +1 -0
  304. package/test/logs/did_webvh_QmUwiw3eSXdHG1hPvoAGu3cuK5jF4aXRYDLBAjPXfv1qzb_example_com_level1_level2.jsonl +1 -0
  305. package/test/logs/did_webvh_QmW7bzKh6yFEKNAtmVsrPGvvsMHTUQdzJSNsTZkbuGFpbj_example_com_secret.jsonl +1 -0
  306. package/test/logs/did_webvh_QmXbFTFBBJ8zpjdz9WE1DNN44A2wprFmdvAubjSffeyoAG_example_com.jsonl +1 -0
  307. package/test/logs/did_webvh_QmXyVXFPCTffGb2mTUFDeMCsScjnpLWkyUkVkB6q6QoeBf_example_com_C_Windows_System32.jsonl +1 -0
  308. package/test/logs/did_webvh_QmZK9B81gxZtvo5fYHYKDtKt8zZfZZPhmCMhbujBJuRRzE_example_com_etc_passwd.jsonl +1 -0
  309. package/test/logs/did_webvh_QmbNLCVSdXSVLrwFBvCBQPAabjtRb1SGHjkGVyw3QUbfBL_example_com_users_etc_passwd.jsonl +1 -0
  310. package/test/logs/did_webvh_QmbeaicmGW3Q7Yzbqmftc8a9jLBngokveb5A2KVKfVGZRb_example_com_my_org_user_name_test_123.jsonl +1 -0
  311. package/test/logs/did_webvh_Qmdv7c7AjUreUfoKyvkN2UpAWTozxKsv99srQetPJMJEnp_example_com_users_etc_passwd.jsonl +1 -0
  312. package/test/logs/did_webvh_QmeioWY3uypYLkYpCXe9eCYnn4xBVruP9C1d79azMrTEHG_example_com.jsonl +1 -0
  313. package/test/logs/did_webvh_Qmf4QH5dsA6Ecr5HJ6KaJL9uJRyY8RxrQdqoRCM25DzvPi_example_com_users_alice.jsonl +1 -0
  314. package/tests/__mocks__/bbs-signatures.js +17 -0
  315. package/tests/__mocks__/mf-base58.js +24 -0
  316. package/tests/e2e/README.md +97 -0
  317. package/tests/e2e/example.spec.ts +78 -0
  318. package/tests/fixtures/did-documents.ts +247 -0
  319. package/tests/index.test.ts +21 -0
  320. package/tests/integration/BatchOperations.test.ts +531 -0
  321. package/tests/integration/CompleteLifecycle.e2e.test.ts +735 -0
  322. package/tests/integration/CredentialManager.test.ts +42 -0
  323. package/tests/integration/DIDManager.test.ts +41 -0
  324. package/tests/integration/DidPeerToWebVhFlow.test.ts +351 -0
  325. package/tests/integration/Events.test.ts +435 -0
  326. package/tests/integration/Lifecycle.transfer.btco.integration.test.ts +25 -0
  327. package/tests/integration/LifecycleManager.test.ts +21 -0
  328. package/tests/integration/MultikeyFlow.test.ts +52 -0
  329. package/tests/integration/TelemetryIntegration.test.ts +395 -0
  330. package/tests/integration/WebVhPublish.test.ts +48 -0
  331. package/tests/integration/migration/peer-to-webvh.test.ts +172 -0
  332. package/tests/manual/test-commit-creation.ts +323 -0
  333. package/tests/mocks/MockKeyStore.ts +38 -0
  334. package/tests/mocks/adapters/MemoryStorageAdapter.ts +24 -0
  335. package/tests/mocks/adapters/MockFeeOracle.ts +11 -0
  336. package/tests/mocks/adapters/MockOrdinalsProvider.ts +76 -0
  337. package/tests/mocks/adapters/OrdMockProvider.test.ts +176 -0
  338. package/tests/mocks/adapters/index.ts +6 -0
  339. package/tests/performance/BatchOperations.perf.test.ts +403 -0
  340. package/tests/performance/logging.perf.test.ts +336 -0
  341. package/tests/sdk.test.ts +43 -0
  342. package/tests/security/bitcoin-penetration-tests.test.ts +622 -0
  343. package/tests/setup.bun.ts +69 -0
  344. package/tests/setup.jest.ts +23 -0
  345. package/tests/stress/batch-operations-stress.test.ts +571 -0
  346. package/tests/unit/adapters/FeeOracleMock.test.ts +40 -0
  347. package/tests/unit/bitcoin/BitcoinManager.test.ts +293 -0
  348. package/tests/unit/bitcoin/BroadcastClient.test.ts +52 -0
  349. package/tests/unit/bitcoin/OrdNodeProvider.test.ts +53 -0
  350. package/tests/unit/bitcoin/OrdinalsClient.test.ts +381 -0
  351. package/tests/unit/bitcoin/OrdinalsClientProvider.test.ts +102 -0
  352. package/tests/unit/bitcoin/PSBTBuilder.test.ts +84 -0
  353. package/tests/unit/bitcoin/fee-calculation.test.ts +261 -0
  354. package/tests/unit/bitcoin/transactions/commit.test.ts +649 -0
  355. package/tests/unit/bitcoin/transfer.test.ts +31 -0
  356. package/tests/unit/bitcoin/utxo-selection-new.test.ts +502 -0
  357. package/tests/unit/bitcoin/utxo.more.test.ts +39 -0
  358. package/tests/unit/bitcoin/utxo.selection.test.ts +38 -0
  359. package/tests/unit/core/OriginalsSDK.test.ts +152 -0
  360. package/tests/unit/crypto/Multikey.test.ts +206 -0
  361. package/tests/unit/crypto/Signer.test.ts +408 -0
  362. package/tests/unit/did/BtcoDidResolver.test.ts +611 -0
  363. package/tests/unit/did/DIDManager.more.test.ts +43 -0
  364. package/tests/unit/did/DIDManager.test.ts +185 -0
  365. package/tests/unit/did/Ed25519Verifier.test.ts +160 -0
  366. package/tests/unit/did/KeyManager.test.ts +452 -0
  367. package/tests/unit/did/OrdinalsClientProviderAdapter.test.ts +45 -0
  368. package/tests/unit/did/WebVHManager.test.ts +435 -0
  369. package/tests/unit/did/createBtcoDidDocument.test.ts +67 -0
  370. package/tests/unit/did/providers/OrdinalsClientProviderAdapter.test.ts +159 -0
  371. package/tests/unit/events/EventEmitter.test.ts +407 -0
  372. package/tests/unit/lifecycle/BatchOperations.test.ts +527 -0
  373. package/tests/unit/lifecycle/LifecycleManager.keymanagement.test.ts +312 -0
  374. package/tests/unit/lifecycle/LifecycleManager.prov.test.ts +18 -0
  375. package/tests/unit/lifecycle/LifecycleManager.test.ts +213 -0
  376. package/tests/unit/lifecycle/LifecycleManager.transfer.unit.test.ts +30 -0
  377. package/tests/unit/lifecycle/OriginalsAsset.test.ts +176 -0
  378. package/tests/unit/lifecycle/ProvenanceQuery.test.ts +577 -0
  379. package/tests/unit/lifecycle/ResourceVersioning.test.ts +651 -0
  380. package/tests/unit/storage/MemoryStorageAdapter.test.ts +93 -0
  381. package/tests/unit/types/network.test.ts +255 -0
  382. package/tests/unit/utils/EventIntegration.test.ts +384 -0
  383. package/tests/unit/utils/Logger.test.ts +473 -0
  384. package/tests/unit/utils/MetricsCollector.test.ts +358 -0
  385. package/tests/unit/utils/bitcoin-address.test.ts +250 -0
  386. package/tests/unit/utils/cbor.test.ts +35 -0
  387. package/tests/unit/utils/encoding.test.ts +318 -0
  388. package/tests/unit/utils/hash.test.ts +12 -0
  389. package/tests/unit/utils/retry.test.ts +100 -0
  390. package/tests/unit/utils/satoshi-validation.test.ts +354 -0
  391. package/tests/unit/utils/serialization.test.ts +124 -0
  392. package/tests/unit/utils/telemetry.test.ts +52 -0
  393. package/tests/unit/utils/validation.test.ts +141 -0
  394. package/tests/unit/vc/CredentialManager.test.ts +487 -0
  395. package/tests/unit/vc/Issuer.test.ts +107 -0
  396. package/tests/unit/vc/Verifier.test.ts +525 -0
  397. package/tests/unit/vc/bbs.test.ts +282 -0
  398. package/tests/unit/vc/cryptosuites/eddsa.test.ts +398 -0
  399. package/tests/unit/vc/documentLoader.test.ts +121 -0
  400. package/tests/unit/vc/proofs/data-integrity.test.ts +24 -0
  401. package/tsconfig.json +32 -0
  402. package/tsconfig.test.json +15 -0
  403. package/tsconfig.tsbuildinfo +1 -0
@@ -0,0 +1,92 @@
1
+ import type { ResourceProvider, LinkedResource, ResourceInfo, Inscription, ResourceCrawlOptions } from './types';
2
+
3
+ export interface OrdNodeProviderOptions {
4
+ nodeUrl: string;
5
+ timeout?: number;
6
+ network?: 'mainnet' | 'testnet' | 'signet';
7
+ }
8
+
9
+ export class OrdNodeProvider implements ResourceProvider {
10
+ private readonly nodeUrl: string;
11
+ private readonly timeout: number;
12
+ private readonly network: 'mainnet' | 'testnet' | 'signet';
13
+
14
+ constructor(options: OrdNodeProviderOptions) {
15
+ this.nodeUrl = options.nodeUrl;
16
+ this.timeout = options.timeout || 5000;
17
+ this.network = options.network || 'mainnet';
18
+ }
19
+
20
+ async resolve(resourceId: string): Promise<LinkedResource> {
21
+ return {
22
+ id: resourceId,
23
+ type: 'Unknown',
24
+ contentType: 'application/octet-stream',
25
+ content_url: `${this.nodeUrl}/content/${resourceId}`
26
+ };
27
+ }
28
+
29
+ async resolveInscription(inscriptionId: string): Promise<Inscription> {
30
+ return {
31
+ id: inscriptionId,
32
+ sat: 0,
33
+ content_type: 'text/plain',
34
+ content_url: `${this.nodeUrl}/content/${inscriptionId}`
35
+ };
36
+ }
37
+
38
+ async resolveInfo(resourceId: string): Promise<ResourceInfo> {
39
+ return {
40
+ id: resourceId,
41
+ type: 'Unknown',
42
+ contentType: 'application/octet-stream',
43
+ createdAt: new Date().toISOString(),
44
+ updatedAt: new Date().toISOString(),
45
+ content_url: `${this.nodeUrl}/content/${resourceId}`
46
+ };
47
+ }
48
+
49
+ async resolveCollection(did: string, _options: { type?: string; limit?: number; offset?: number } = {}): Promise<LinkedResource[]> {
50
+ return [];
51
+ }
52
+
53
+ async getSatInfo(_satNumber: string): Promise<{ inscription_ids: string[] }> {
54
+ return { inscription_ids: [] };
55
+ }
56
+
57
+ async getMetadata(_inscriptionId: string): Promise<any> {
58
+ return null;
59
+ }
60
+
61
+ async *getAllResources(_options: ResourceCrawlOptions = {}): AsyncGenerator<LinkedResource[]> {
62
+ // no-op generator yields nothing
63
+ return;
64
+ }
65
+
66
+ async *getAllResourcesChronological(_options: ResourceCrawlOptions = {}): AsyncGenerator<LinkedResource[]> {
67
+ // no-op generator yields nothing
68
+ return;
69
+ }
70
+
71
+ async getInscriptionLocationsByAddress(_address: string): Promise<{ id: string; location: string }[]> {
72
+ return [];
73
+ }
74
+
75
+ async getInscriptionByNumber(_inscriptionNumber: number): Promise<Inscription> {
76
+ return {
77
+ id: '0',
78
+ sat: 0,
79
+ content_type: 'text/plain',
80
+ content_url: `${this.nodeUrl}/content/0`
81
+ };
82
+ }
83
+
84
+ async getAddressOutputs(_address: string): Promise<string[]> {
85
+ return [];
86
+ }
87
+
88
+ async getOutputDetails(_outpoint: string): Promise<{ value: number; script_pubkey: string; spent: boolean; inscriptions: string[] }> {
89
+ return { value: 0, script_pubkey: '', spent: false, inscriptions: [] };
90
+ }
91
+ }
92
+
@@ -0,0 +1,56 @@
1
+ import { OrdinalsClient } from '../OrdinalsClient';
2
+ import { withRetry } from '../../utils/retry';
3
+
4
+ export interface OrdinalsProvider {
5
+ getSatInfo(satNumber: string): Promise<{ inscription_ids: string[] }>;
6
+ resolveInscription(inscriptionId: string): Promise<{ id: string; sat: number; content_type: string; content_url: string }>;
7
+ getMetadata(inscriptionId: string): Promise<any>;
8
+ estimateFee(blocks?: number): Promise<number>;
9
+ }
10
+
11
+ export class OrdinalsClientProvider implements OrdinalsProvider {
12
+ constructor(private client: OrdinalsClient, private options?: { retries?: number; baseUrl?: string }) {}
13
+
14
+ async getSatInfo(satNumber: string): Promise<{ inscription_ids: string[] }> {
15
+ return withRetry(() => this.client.getSatInfo(satNumber), {
16
+ maxRetries: this.options?.retries ?? 2,
17
+ isRetriable: () => true
18
+ });
19
+ }
20
+
21
+ async resolveInscription(inscriptionId: string): Promise<{ id: string; sat: number; content_type: string; content_url: string }> {
22
+ return withRetry(async () => {
23
+ const res = await this.client.getInscriptionById(inscriptionId);
24
+ if (!res) throw new Error('Inscription not found');
25
+ if (!res.satoshi) throw new Error('Inscription missing satoshi');
26
+ const sat = Number(String(res.satoshi));
27
+ if (Number.isNaN(sat)) throw new Error('Invalid satoshi value');
28
+ if (!res.contentType) throw new Error('Inscription missing contentType');
29
+ const base = (this.options?.baseUrl || '').replace(/\/$/, '');
30
+ if (!base) throw new Error('baseUrl is required to construct content_url');
31
+ const id = res.inscriptionId;
32
+ const content_url = `${base}/content/${id}`;
33
+ return {
34
+ id,
35
+ sat,
36
+ content_type: res.contentType,
37
+ content_url
38
+ };
39
+ }, { maxRetries: this.options?.retries ?? 2, isRetriable: () => true });
40
+ }
41
+
42
+ async getMetadata(inscriptionId: string): Promise<any> {
43
+ return withRetry(() => this.client.getMetadata(inscriptionId), {
44
+ maxRetries: this.options?.retries ?? 2,
45
+ isRetriable: () => true
46
+ });
47
+ }
48
+
49
+ async estimateFee(blocks?: number): Promise<number> {
50
+ return withRetry(() => this.client.estimateFee(blocks), {
51
+ maxRetries: this.options?.retries ?? 2,
52
+ isRetriable: () => true
53
+ });
54
+ }
55
+ }
56
+
@@ -0,0 +1,59 @@
1
+ export interface LinkedResource {
2
+ id: string;
3
+ type: string;
4
+ contentType: string;
5
+ content_url: string;
6
+ }
7
+
8
+ export interface Inscription {
9
+ id: string;
10
+ sat: number;
11
+ content_type: string;
12
+ content_url: string;
13
+ number?: number;
14
+ height?: number;
15
+ timestamp?: number;
16
+ }
17
+
18
+ export interface ResourceInfo {
19
+ id: string;
20
+ type: string;
21
+ contentType: string;
22
+ createdAt?: string;
23
+ updatedAt?: string;
24
+ content_url: string;
25
+ }
26
+
27
+ export interface ResourceProvider {
28
+ resolve(resourceId: string): Promise<LinkedResource>;
29
+ resolveInscription(inscriptionId: string): Promise<Inscription>;
30
+ resolveInfo(resourceId: string): Promise<ResourceInfo>;
31
+ resolveCollection(did: string, options: { type?: string; limit?: number; offset?: number }): Promise<LinkedResource[]>;
32
+ getSatInfo(satNumber: string): Promise<{ inscription_ids: string[] }>;
33
+ getMetadata(inscriptionId: string): Promise<any>;
34
+ getAllResources(options?: ResourceCrawlOptions): AsyncGenerator<LinkedResource[]>;
35
+ getAllResourcesChronological(options?: ResourceCrawlOptions): AsyncGenerator<LinkedResource[]>;
36
+ getInscriptionLocationsByAddress(address: string): Promise<InscriptionRefWithLocation[]>;
37
+ getInscriptionByNumber(inscriptionNumber: number): Promise<Inscription>;
38
+ getAddressOutputs(address: string): Promise<string[]>;
39
+ getOutputDetails(outpoint: string): Promise<{ value: number; script_pubkey: string; spent: boolean; inscriptions: string[] }>;
40
+ }
41
+
42
+ export interface ResourceCrawlOptions {
43
+ batchSize?: number;
44
+ startFrom?: number;
45
+ maxResources?: number;
46
+ filter?: (resource: LinkedResource) => boolean;
47
+ }
48
+
49
+ export interface ResourceBatch {
50
+ resources: LinkedResource[];
51
+ nextCursor?: number;
52
+ hasMore: boolean;
53
+ }
54
+
55
+ export interface InscriptionRefWithLocation {
56
+ id: string;
57
+ location: string;
58
+ }
59
+
@@ -0,0 +1,465 @@
1
+ /**
2
+ * Commit Transaction Processing for Ordinals
3
+ *
4
+ * This module implements the commit transaction process for ordinals inscriptions.
5
+ * It handles the generation of the commit address and preparation of the commit transaction.
6
+ *
7
+ * Ported from legacy ordinalsplus transaction infrastructure.
8
+ */
9
+
10
+ import * as btc from '@scure/btc-signer';
11
+ import * as ordinals from 'micro-ordinals';
12
+ import { schnorr } from '@noble/curves/secp256k1';
13
+ import { Utxo } from '../../types/bitcoin.js';
14
+ import { calculateFee } from '../fee-calculation.js';
15
+ import { selectUtxos, SimpleUtxoSelectionOptions } from '../utxo-selection.js';
16
+
17
+ // Define minimum dust limit (satoshis)
18
+ const MIN_DUST_LIMIT = 546;
19
+
20
+ // Maximum iterations for UTXO reselection to prevent infinite loops
21
+ const MAX_SELECTION_ITERATIONS = 5;
22
+
23
+ /**
24
+ * Bitcoin network type for @scure/btc-signer
25
+ */
26
+ type BitcoinNetwork = 'mainnet' | 'testnet' | 'regtest' | 'signet';
27
+
28
+ /**
29
+ * Get @scure/btc-signer network configuration
30
+ */
31
+ function getScureNetwork(network: BitcoinNetwork): typeof btc.NETWORK {
32
+ switch (network) {
33
+ case 'mainnet':
34
+ return btc.NETWORK;
35
+ case 'testnet':
36
+ case 'signet':
37
+ case 'regtest':
38
+ return btc.TEST_NETWORK;
39
+ default:
40
+ return btc.NETWORK;
41
+ }
42
+ }
43
+
44
+ /**
45
+ * Validates that a UTXO has all required fields for spending
46
+ *
47
+ * @param utxo - The UTXO to validate
48
+ * @returns true if the UTXO is valid and spendable, false otherwise
49
+ */
50
+ function isValidSpendableUtxo(utxo: Utxo): boolean {
51
+ return !!(
52
+ utxo.txid &&
53
+ typeof utxo.vout === 'number' &&
54
+ utxo.value > 0 &&
55
+ utxo.scriptPubKey &&
56
+ utxo.scriptPubKey.length > 0
57
+ );
58
+ }
59
+
60
+ /**
61
+ * Parameters for creating a commit transaction
62
+ */
63
+ export interface CommitTransactionParams {
64
+ /** Inscription content as Buffer */
65
+ content: Buffer;
66
+ /** MIME type of the content (e.g., 'text/plain', 'image/png') */
67
+ contentType: string;
68
+ /** Available UTXOs to fund the transaction */
69
+ utxos: Utxo[];
70
+ /** Address to send change back to */
71
+ changeAddress: string;
72
+ /** Fee rate in sats/vB */
73
+ feeRate: number;
74
+ /** Bitcoin network configuration */
75
+ network: BitcoinNetwork;
76
+ /** Optional minimum amount for the commit output */
77
+ minimumCommitAmount?: number;
78
+ /** Optional metadata for the inscription */
79
+ metadata?: Record<string, unknown>;
80
+ /** Optional pointer to target specific satoshi */
81
+ pointer?: number;
82
+ }
83
+
84
+ /**
85
+ * Result of the commit transaction creation
86
+ */
87
+ export interface CommitTransactionResult {
88
+ /** P2TR address for the commit output */
89
+ commitAddress: string;
90
+ /** Base64-encoded PSBT for the commit transaction */
91
+ commitPsbtBase64: string;
92
+ /** Raw PSBT object for commit transaction (for direct manipulation) */
93
+ commitPsbt: btc.Transaction;
94
+ /** The exact amount sent to the commit output */
95
+ commitAmount: number;
96
+ /** Selected UTXOs for the transaction */
97
+ selectedUtxos: Utxo[];
98
+ /** Fee information */
99
+ fees: {
100
+ /** Fee for the commit transaction in satoshis */
101
+ commit: number;
102
+ };
103
+ /** Reveal private key (hex string) - needed for reveal transaction */
104
+ revealPrivateKey: string;
105
+ /** Reveal public key (hex string) */
106
+ revealPublicKey: string;
107
+ /** Inscription script for reveal transaction */
108
+ inscriptionScript: {
109
+ script: Uint8Array;
110
+ controlBlock: Uint8Array;
111
+ leafVersion: number;
112
+ };
113
+ }
114
+
115
+ /**
116
+ * Estimates the size of a commit transaction
117
+ *
118
+ * @param inputCount - Number of transaction inputs
119
+ * @param outputCount - Number of transaction outputs (including commit and change)
120
+ * @returns Estimated transaction size in virtual bytes
121
+ */
122
+ function estimateCommitTxSize(inputCount: number, outputCount: number): number {
123
+ // Transaction overhead
124
+ const overhead = 10.5;
125
+
126
+ // P2WPKH inputs (assuming most common case)
127
+ const inputSize = 68 * inputCount;
128
+
129
+ // P2TR output for commit and P2WPKH for change
130
+ const commitOutputSize = 43; // P2TR output
131
+ const changeOutputSize = outputCount > 1 ? 31 * (outputCount - 1) : 0; // P2WPKH outputs for change
132
+
133
+ return Math.ceil(overhead + inputSize + commitOutputSize + changeOutputSize);
134
+ }
135
+
136
+ /**
137
+ * Creates a commit transaction for an ordinals inscription
138
+ *
139
+ * This function:
140
+ * 1. Validates and filters UTXOs to ensure they are spendable
141
+ * 2. Creates an inscription with the provided content
142
+ * 3. Generates a reveal keypair and script
143
+ * 4. Creates a P2TR commit address
144
+ * 5. Selects UTXOs to fund the transaction (with iterative reselection if needed)
145
+ * 6. Builds a PSBT with commit output and change
146
+ *
147
+ * The function ensures that:
148
+ * - All selected UTXOs have valid scriptPubKey fields
149
+ * - Total input value always covers output value + fees
150
+ * - UTXO selection is re-run if fee increases after accurate calculation
151
+ *
152
+ * @param params - Parameters for the commit transaction
153
+ * @returns Complete information for the prepared commit transaction
154
+ * @throws Error if no valid UTXOs are available or insufficient funds
155
+ */
156
+ export async function createCommitTransaction(
157
+ params: CommitTransactionParams
158
+ ): Promise<CommitTransactionResult> {
159
+ const {
160
+ content,
161
+ contentType,
162
+ utxos,
163
+ changeAddress,
164
+ feeRate,
165
+ network,
166
+ minimumCommitAmount = MIN_DUST_LIMIT,
167
+ metadata,
168
+ pointer
169
+ } = params;
170
+
171
+ // Validate inputs
172
+ if (!utxos || utxos.length === 0) {
173
+ throw new Error('No UTXOs provided to fund the transaction.');
174
+ }
175
+
176
+ if (!content || content.length === 0) {
177
+ throw new Error('Invalid inscription: missing content.');
178
+ }
179
+
180
+ if (!contentType) {
181
+ throw new Error('Invalid inscription: missing content type.');
182
+ }
183
+
184
+ if (!changeAddress) {
185
+ throw new Error('Change address is required.');
186
+ }
187
+
188
+ if (feeRate <= 0) {
189
+ throw new Error(`Invalid fee rate: ${feeRate}`);
190
+ }
191
+
192
+ // CRITICAL: Pre-filter UTXOs to ensure all have valid scriptPubKey
193
+ // This prevents silent failures where UTXOs are selected but can't be spent
194
+ const validUtxos = utxos.filter(isValidSpendableUtxo);
195
+
196
+ if (validUtxos.length === 0) {
197
+ const invalidCount = utxos.length;
198
+ const invalidReasons: string[] = [];
199
+
200
+ utxos.forEach((utxo, idx) => {
201
+ if (!utxo.scriptPubKey || utxo.scriptPubKey.length === 0) {
202
+ invalidReasons.push(`UTXO ${idx} (${utxo.txid}:${utxo.vout}): missing scriptPubKey`);
203
+ } else if (!utxo.txid) {
204
+ invalidReasons.push(`UTXO ${idx}: missing txid`);
205
+ } else if (typeof utxo.vout !== 'number') {
206
+ invalidReasons.push(`UTXO ${idx} (${utxo.txid}): missing or invalid vout`);
207
+ } else if (utxo.value <= 0) {
208
+ invalidReasons.push(`UTXO ${idx} (${utxo.txid}:${utxo.vout}): invalid value (${utxo.value})`);
209
+ }
210
+ });
211
+
212
+ throw new Error(
213
+ `No valid spendable UTXOs available. ${invalidCount} UTXO(s) provided but all are invalid:\n` +
214
+ invalidReasons.slice(0, 5).join('\n') +
215
+ (invalidReasons.length > 5 ? `\n... and ${invalidReasons.length - 5} more` : '')
216
+ );
217
+ }
218
+
219
+ // Log filtered UTXOs for debugging
220
+ if (validUtxos.length < utxos.length) {
221
+ const filteredCount = utxos.length - validUtxos.length;
222
+ console.warn(`Filtered out ${filteredCount} invalid UTXO(s). ${validUtxos.length} valid UTXO(s) remain.`);
223
+ }
224
+
225
+ // Step 1: Create the inscription object
226
+ const tags: ordinals.Tags = {
227
+ contentType
228
+ };
229
+
230
+ // Add metadata if provided
231
+ if (metadata && Object.keys(metadata).length > 0) {
232
+ tags.metadata = metadata;
233
+ }
234
+
235
+ // Add pointer if provided
236
+ if (typeof pointer !== 'undefined') {
237
+ (tags as any).pointer = pointer;
238
+ }
239
+
240
+ const inscription: ordinals.Inscription = {
241
+ tags,
242
+ body: new Uint8Array(content)
243
+ };
244
+
245
+ // Step 2: Generate a reveal keypair
246
+ // Use random private key for reveal transaction
247
+ const revealPrivateKey = schnorr.utils.randomPrivateKey();
248
+ const revealPublicKey = schnorr.getPublicKey(revealPrivateKey);
249
+
250
+ // Step 3: Create the inscription script tree using micro-ordinals
251
+ const scriptTree = ordinals.p2tr_ord_reveal(revealPublicKey, [inscription]);
252
+
253
+ // Step 4: Create P2TR address for the commit output
254
+ const scureNetwork = getScureNetwork(network);
255
+
256
+ // Create taproot output using the inscription script tree
257
+ // Use the reveal public key as the internal key
258
+ const taprootPayment = btc.p2tr(
259
+ revealPublicKey, // internal key
260
+ scriptTree, // script tree
261
+ scureNetwork,
262
+ false, // allowUnknownOutputs
263
+ [ordinals.OutOrdinalReveal] // customScripts
264
+ );
265
+
266
+ if (!taprootPayment.address) {
267
+ throw new Error('Failed to generate P2TR commit address');
268
+ }
269
+
270
+ const commitAddress = taprootPayment.address;
271
+
272
+ // Extract script information from the taproot payment
273
+ if (!taprootPayment.leaves || taprootPayment.leaves.length === 0) {
274
+ throw new Error('Failed to extract taproot leaves from P2TR payment');
275
+ }
276
+
277
+ const leaf = taprootPayment.leaves[0];
278
+ const leafVersion = leaf.version ?? 0xc0;
279
+
280
+ // Compute control block from leaf data
281
+ // The control block is: version byte | internal key (32 bytes) | merkle path
282
+ const controlBlock = btc.TaprootControlBlock.encode({
283
+ version: leafVersion,
284
+ internalKey: revealPublicKey,
285
+ merklePath: leaf.path
286
+ });
287
+
288
+ // Step 5: Calculate minimum amount needed for the commit output
289
+ const commitOutputValue = Math.max(minimumCommitAmount, MIN_DUST_LIMIT);
290
+
291
+ // Step 6: Iterative UTXO selection with fee recalculation
292
+ // This ensures that after we know the actual input count, we have enough funds
293
+ let selectedUtxos: Utxo[] = [];
294
+ let totalInputValue = 0;
295
+ let estimatedFee = 0;
296
+ let iteration = 0;
297
+
298
+ // Start with initial estimate (1 input, 2 outputs)
299
+ let targetAmount = commitOutputValue + Number(calculateFee(estimateCommitTxSize(1, 2), feeRate));
300
+
301
+ while (iteration < MAX_SELECTION_ITERATIONS) {
302
+ iteration++;
303
+
304
+ // Select UTXOs based on current target amount
305
+ const options: SimpleUtxoSelectionOptions = {
306
+ targetAmount
307
+ };
308
+
309
+ try {
310
+ const selectionResult = selectUtxos(validUtxos, options);
311
+ selectedUtxos = selectionResult.selectedUtxos;
312
+ totalInputValue = selectionResult.totalInputValue;
313
+ } catch (error) {
314
+ throw new Error(
315
+ `Insufficient funds. Need ${targetAmount} sats for commit output (${commitOutputValue} sats) and estimated fees. ` +
316
+ `Available: ${validUtxos.reduce((sum, u) => sum + u.value, 0)} sats from ${validUtxos.length} valid UTXO(s). ` +
317
+ `${error instanceof Error ? error.message : 'Unknown error'}`
318
+ );
319
+ }
320
+
321
+ // Calculate accurate fee based on actual selected input count
322
+ // Assume 2 outputs (commit + change) for now - we'll adjust later if no change
323
+ const actualInputCount = selectedUtxos.length;
324
+ const estimatedVBytes = estimateCommitTxSize(actualInputCount, 2);
325
+ estimatedFee = Number(calculateFee(estimatedVBytes, feeRate));
326
+
327
+ // Check if we need to account for no change output
328
+ const potentialChange = totalInputValue - commitOutputValue - estimatedFee;
329
+ let finalOutputCount = 2;
330
+
331
+ if (potentialChange < MIN_DUST_LIMIT) {
332
+ // No change output, recalculate fee with 1 output
333
+ finalOutputCount = 1;
334
+ const adjustedVBytes = estimateCommitTxSize(actualInputCount, finalOutputCount);
335
+ estimatedFee = Number(calculateFee(adjustedVBytes, feeRate));
336
+ }
337
+
338
+ // Check if we have enough funds with the accurate fee calculation
339
+ const requiredTotal = commitOutputValue + estimatedFee;
340
+
341
+ if (totalInputValue >= requiredTotal) {
342
+ // We have enough funds, break out of loop
343
+ break;
344
+ }
345
+
346
+ // Not enough funds, need to reselect with higher target
347
+ // Add a small buffer (5%) to account for potential fee variations
348
+ targetAmount = Math.ceil(requiredTotal * 1.05);
349
+
350
+ if (iteration >= MAX_SELECTION_ITERATIONS) {
351
+ throw new Error(
352
+ `Unable to select sufficient UTXOs after ${MAX_SELECTION_ITERATIONS} iterations. ` +
353
+ `Required: ${requiredTotal} sats (commit: ${commitOutputValue}, fee: ${estimatedFee}), ` +
354
+ `Selected: ${totalInputValue} sats from ${selectedUtxos.length} UTXO(s). ` +
355
+ `Total available: ${validUtxos.reduce((sum, u) => sum + u.value, 0)} sats from ${validUtxos.length} valid UTXO(s).`
356
+ );
357
+ }
358
+ }
359
+
360
+ // Final validation: ensure we have selected UTXOs
361
+ if (!selectedUtxos || selectedUtxos.length === 0) {
362
+ throw new Error('No UTXOs selected for the transaction after selection process.');
363
+ }
364
+
365
+ // Step 7: Create transaction using @scure/btc-signer
366
+ const tx = new btc.Transaction();
367
+
368
+ // Add inputs - all selected UTXOs are already validated to have scriptPubKey
369
+ for (const utxo of selectedUtxos) {
370
+ // This check is now redundant due to pre-filtering, but kept as defense-in-depth
371
+ if (!utxo.scriptPubKey) {
372
+ throw new Error(
373
+ `CRITICAL ERROR: Selected UTXO ${utxo.txid}:${utxo.vout} is missing scriptPubKey. ` +
374
+ `This should never happen due to pre-filtering. Please report this bug.`
375
+ );
376
+ }
377
+
378
+ tx.addInput({
379
+ txid: utxo.txid,
380
+ index: utxo.vout,
381
+ witnessUtxo: {
382
+ script: Buffer.from(utxo.scriptPubKey, 'hex'),
383
+ amount: BigInt(utxo.value)
384
+ }
385
+ });
386
+ }
387
+
388
+ // Verify input count matches selected UTXOs
389
+ if (tx.inputsLength !== selectedUtxos.length) {
390
+ throw new Error(
391
+ `Input count mismatch: expected ${selectedUtxos.length} inputs but transaction has ${tx.inputsLength}. ` +
392
+ `This indicates a critical error in transaction construction.`
393
+ );
394
+ }
395
+
396
+ // Step 8: Calculate final fee based on actual transaction structure
397
+ const actualInputCount = tx.inputsLength;
398
+
399
+ // Determine if we'll have a change output
400
+ const preliminaryChange = totalInputValue - commitOutputValue - estimatedFee;
401
+ const willHaveChange = preliminaryChange >= MIN_DUST_LIMIT;
402
+ const finalOutputCount = willHaveChange ? 2 : 1;
403
+
404
+ // Calculate final fee with correct output count
405
+ const finalVBytes = estimateCommitTxSize(actualInputCount, finalOutputCount);
406
+ const finalFee = Number(calculateFee(finalVBytes, feeRate));
407
+
408
+ // CRITICAL: Final validation that inputs cover outputs + fees
409
+ const finalChange = totalInputValue - commitOutputValue - finalFee;
410
+
411
+ if (finalChange < 0) {
412
+ throw new Error(
413
+ `CRITICAL ERROR: Outputs exceed inputs! ` +
414
+ `Inputs: ${totalInputValue} sats, ` +
415
+ `Outputs: ${commitOutputValue} sats (commit) + ${finalFee} sats (fee) = ${commitOutputValue + finalFee} sats. ` +
416
+ `Deficit: ${Math.abs(finalChange)} sats. ` +
417
+ `This should never happen due to iterative selection. Please report this bug.`
418
+ );
419
+ }
420
+
421
+ // Step 9: Add the commit output using the P2TR address
422
+ tx.addOutputAddress(
423
+ commitAddress,
424
+ BigInt(commitOutputValue),
425
+ scureNetwork
426
+ );
427
+
428
+ // Step 10: Add change output if above dust limit
429
+ if (finalChange >= MIN_DUST_LIMIT) {
430
+ tx.addOutputAddress(
431
+ changeAddress,
432
+ BigInt(finalChange),
433
+ scureNetwork
434
+ );
435
+ } else if (finalChange > 0) {
436
+ // If change is below dust limit, it's effectively added to the fee
437
+ console.log(
438
+ `Change amount ${finalChange} sats is below dust limit (${MIN_DUST_LIMIT} sats), adding to fee. ` +
439
+ `Final fee: ${finalFee + finalChange} sats.`
440
+ );
441
+ }
442
+
443
+ // Step 11: Get the PSBT as base64
444
+ const txPsbt = tx.toPSBT();
445
+ const commitPsbtBase64 = typeof txPsbt === 'string' ? txPsbt : Buffer.from(txPsbt).toString('base64');
446
+
447
+ return {
448
+ commitAddress,
449
+ commitPsbtBase64,
450
+ commitPsbt: tx,
451
+ commitAmount: commitOutputValue,
452
+ selectedUtxos,
453
+ fees: {
454
+ // Include dust in final fee if no change output
455
+ commit: finalChange >= MIN_DUST_LIMIT ? finalFee : finalFee + finalChange
456
+ },
457
+ revealPrivateKey: Buffer.from(revealPrivateKey).toString('hex'),
458
+ revealPublicKey: Buffer.from(revealPublicKey).toString('hex'),
459
+ inscriptionScript: {
460
+ script: leaf.script,
461
+ controlBlock,
462
+ leafVersion
463
+ }
464
+ };
465
+ }
@@ -0,0 +1,13 @@
1
+ /**
2
+ * Bitcoin Transactions
3
+ *
4
+ * This directory contains modules for creating and managing Bitcoin transactions,
5
+ * particularly for Ordinals inscriptions.
6
+ */
7
+
8
+ // Export commit transaction functionality
9
+ export {
10
+ createCommitTransaction,
11
+ type CommitTransactionParams,
12
+ type CommitTransactionResult
13
+ } from './commit.js';