@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,67 @@
1
+ export class OrdNodeProvider {
2
+ constructor(options) {
3
+ this.nodeUrl = options.nodeUrl;
4
+ this.timeout = options.timeout || 5000;
5
+ this.network = options.network || 'mainnet';
6
+ }
7
+ async resolve(resourceId) {
8
+ return {
9
+ id: resourceId,
10
+ type: 'Unknown',
11
+ contentType: 'application/octet-stream',
12
+ content_url: `${this.nodeUrl}/content/${resourceId}`
13
+ };
14
+ }
15
+ async resolveInscription(inscriptionId) {
16
+ return {
17
+ id: inscriptionId,
18
+ sat: 0,
19
+ content_type: 'text/plain',
20
+ content_url: `${this.nodeUrl}/content/${inscriptionId}`
21
+ };
22
+ }
23
+ async resolveInfo(resourceId) {
24
+ return {
25
+ id: resourceId,
26
+ type: 'Unknown',
27
+ contentType: 'application/octet-stream',
28
+ createdAt: new Date().toISOString(),
29
+ updatedAt: new Date().toISOString(),
30
+ content_url: `${this.nodeUrl}/content/${resourceId}`
31
+ };
32
+ }
33
+ async resolveCollection(did, _options = {}) {
34
+ return [];
35
+ }
36
+ async getSatInfo(_satNumber) {
37
+ return { inscription_ids: [] };
38
+ }
39
+ async getMetadata(_inscriptionId) {
40
+ return null;
41
+ }
42
+ async *getAllResources(_options = {}) {
43
+ // no-op generator yields nothing
44
+ return;
45
+ }
46
+ async *getAllResourcesChronological(_options = {}) {
47
+ // no-op generator yields nothing
48
+ return;
49
+ }
50
+ async getInscriptionLocationsByAddress(_address) {
51
+ return [];
52
+ }
53
+ async getInscriptionByNumber(_inscriptionNumber) {
54
+ return {
55
+ id: '0',
56
+ sat: 0,
57
+ content_type: 'text/plain',
58
+ content_url: `${this.nodeUrl}/content/0`
59
+ };
60
+ }
61
+ async getAddressOutputs(_address) {
62
+ return [];
63
+ }
64
+ async getOutputDetails(_outpoint) {
65
+ return { value: 0, script_pubkey: '', spent: false, inscriptions: [] };
66
+ }
67
+ }
@@ -0,0 +1,33 @@
1
+ import { OrdinalsClient } from '../OrdinalsClient';
2
+ export interface OrdinalsProvider {
3
+ getSatInfo(satNumber: string): Promise<{
4
+ inscription_ids: string[];
5
+ }>;
6
+ resolveInscription(inscriptionId: string): Promise<{
7
+ id: string;
8
+ sat: number;
9
+ content_type: string;
10
+ content_url: string;
11
+ }>;
12
+ getMetadata(inscriptionId: string): Promise<any>;
13
+ estimateFee(blocks?: number): Promise<number>;
14
+ }
15
+ export declare class OrdinalsClientProvider implements OrdinalsProvider {
16
+ private client;
17
+ private options?;
18
+ constructor(client: OrdinalsClient, options?: {
19
+ retries?: number;
20
+ baseUrl?: string;
21
+ } | undefined);
22
+ getSatInfo(satNumber: string): Promise<{
23
+ inscription_ids: string[];
24
+ }>;
25
+ resolveInscription(inscriptionId: string): Promise<{
26
+ id: string;
27
+ sat: number;
28
+ content_type: string;
29
+ content_url: string;
30
+ }>;
31
+ getMetadata(inscriptionId: string): Promise<any>;
32
+ estimateFee(blocks?: number): Promise<number>;
33
+ }
@@ -0,0 +1,50 @@
1
+ import { withRetry } from '../../utils/retry';
2
+ export class OrdinalsClientProvider {
3
+ constructor(client, options) {
4
+ this.client = client;
5
+ this.options = options;
6
+ }
7
+ async getSatInfo(satNumber) {
8
+ return withRetry(() => this.client.getSatInfo(satNumber), {
9
+ maxRetries: this.options?.retries ?? 2,
10
+ isRetriable: () => true
11
+ });
12
+ }
13
+ async resolveInscription(inscriptionId) {
14
+ return withRetry(async () => {
15
+ const res = await this.client.getInscriptionById(inscriptionId);
16
+ if (!res)
17
+ throw new Error('Inscription not found');
18
+ if (!res.satoshi)
19
+ throw new Error('Inscription missing satoshi');
20
+ const sat = Number(String(res.satoshi));
21
+ if (Number.isNaN(sat))
22
+ throw new Error('Invalid satoshi value');
23
+ if (!res.contentType)
24
+ throw new Error('Inscription missing contentType');
25
+ const base = (this.options?.baseUrl || '').replace(/\/$/, '');
26
+ if (!base)
27
+ throw new Error('baseUrl is required to construct content_url');
28
+ const id = res.inscriptionId;
29
+ const content_url = `${base}/content/${id}`;
30
+ return {
31
+ id,
32
+ sat,
33
+ content_type: res.contentType,
34
+ content_url
35
+ };
36
+ }, { maxRetries: this.options?.retries ?? 2, isRetriable: () => true });
37
+ }
38
+ async getMetadata(inscriptionId) {
39
+ return withRetry(() => this.client.getMetadata(inscriptionId), {
40
+ maxRetries: this.options?.retries ?? 2,
41
+ isRetriable: () => true
42
+ });
43
+ }
44
+ async estimateFee(blocks) {
45
+ return withRetry(() => this.client.estimateFee(blocks), {
46
+ maxRetries: this.options?.retries ?? 2,
47
+ isRetriable: () => true
48
+ });
49
+ }
50
+ }
@@ -0,0 +1,63 @@
1
+ export interface LinkedResource {
2
+ id: string;
3
+ type: string;
4
+ contentType: string;
5
+ content_url: string;
6
+ }
7
+ export interface Inscription {
8
+ id: string;
9
+ sat: number;
10
+ content_type: string;
11
+ content_url: string;
12
+ number?: number;
13
+ height?: number;
14
+ timestamp?: number;
15
+ }
16
+ export interface ResourceInfo {
17
+ id: string;
18
+ type: string;
19
+ contentType: string;
20
+ createdAt?: string;
21
+ updatedAt?: string;
22
+ content_url: string;
23
+ }
24
+ export interface ResourceProvider {
25
+ resolve(resourceId: string): Promise<LinkedResource>;
26
+ resolveInscription(inscriptionId: string): Promise<Inscription>;
27
+ resolveInfo(resourceId: string): Promise<ResourceInfo>;
28
+ resolveCollection(did: string, options: {
29
+ type?: string;
30
+ limit?: number;
31
+ offset?: number;
32
+ }): Promise<LinkedResource[]>;
33
+ getSatInfo(satNumber: string): Promise<{
34
+ inscription_ids: string[];
35
+ }>;
36
+ getMetadata(inscriptionId: string): Promise<any>;
37
+ getAllResources(options?: ResourceCrawlOptions): AsyncGenerator<LinkedResource[]>;
38
+ getAllResourcesChronological(options?: ResourceCrawlOptions): AsyncGenerator<LinkedResource[]>;
39
+ getInscriptionLocationsByAddress(address: string): Promise<InscriptionRefWithLocation[]>;
40
+ getInscriptionByNumber(inscriptionNumber: number): Promise<Inscription>;
41
+ getAddressOutputs(address: string): Promise<string[]>;
42
+ getOutputDetails(outpoint: string): Promise<{
43
+ value: number;
44
+ script_pubkey: string;
45
+ spent: boolean;
46
+ inscriptions: string[];
47
+ }>;
48
+ }
49
+ export interface ResourceCrawlOptions {
50
+ batchSize?: number;
51
+ startFrom?: number;
52
+ maxResources?: number;
53
+ filter?: (resource: LinkedResource) => boolean;
54
+ }
55
+ export interface ResourceBatch {
56
+ resources: LinkedResource[];
57
+ nextCursor?: number;
58
+ hasMore: boolean;
59
+ }
60
+ export interface InscriptionRefWithLocation {
61
+ id: string;
62
+ location: string;
63
+ }
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,89 @@
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
+ import * as btc from '@scure/btc-signer';
10
+ import { Utxo } from '../../types/bitcoin.js';
11
+ /**
12
+ * Bitcoin network type for @scure/btc-signer
13
+ */
14
+ type BitcoinNetwork = 'mainnet' | 'testnet' | 'regtest' | 'signet';
15
+ /**
16
+ * Parameters for creating a commit transaction
17
+ */
18
+ export interface CommitTransactionParams {
19
+ /** Inscription content as Buffer */
20
+ content: Buffer;
21
+ /** MIME type of the content (e.g., 'text/plain', 'image/png') */
22
+ contentType: string;
23
+ /** Available UTXOs to fund the transaction */
24
+ utxos: Utxo[];
25
+ /** Address to send change back to */
26
+ changeAddress: string;
27
+ /** Fee rate in sats/vB */
28
+ feeRate: number;
29
+ /** Bitcoin network configuration */
30
+ network: BitcoinNetwork;
31
+ /** Optional minimum amount for the commit output */
32
+ minimumCommitAmount?: number;
33
+ /** Optional metadata for the inscription */
34
+ metadata?: Record<string, unknown>;
35
+ /** Optional pointer to target specific satoshi */
36
+ pointer?: number;
37
+ }
38
+ /**
39
+ * Result of the commit transaction creation
40
+ */
41
+ export interface CommitTransactionResult {
42
+ /** P2TR address for the commit output */
43
+ commitAddress: string;
44
+ /** Base64-encoded PSBT for the commit transaction */
45
+ commitPsbtBase64: string;
46
+ /** Raw PSBT object for commit transaction (for direct manipulation) */
47
+ commitPsbt: btc.Transaction;
48
+ /** The exact amount sent to the commit output */
49
+ commitAmount: number;
50
+ /** Selected UTXOs for the transaction */
51
+ selectedUtxos: Utxo[];
52
+ /** Fee information */
53
+ fees: {
54
+ /** Fee for the commit transaction in satoshis */
55
+ commit: number;
56
+ };
57
+ /** Reveal private key (hex string) - needed for reveal transaction */
58
+ revealPrivateKey: string;
59
+ /** Reveal public key (hex string) */
60
+ revealPublicKey: string;
61
+ /** Inscription script for reveal transaction */
62
+ inscriptionScript: {
63
+ script: Uint8Array;
64
+ controlBlock: Uint8Array;
65
+ leafVersion: number;
66
+ };
67
+ }
68
+ /**
69
+ * Creates a commit transaction for an ordinals inscription
70
+ *
71
+ * This function:
72
+ * 1. Validates and filters UTXOs to ensure they are spendable
73
+ * 2. Creates an inscription with the provided content
74
+ * 3. Generates a reveal keypair and script
75
+ * 4. Creates a P2TR commit address
76
+ * 5. Selects UTXOs to fund the transaction (with iterative reselection if needed)
77
+ * 6. Builds a PSBT with commit output and change
78
+ *
79
+ * The function ensures that:
80
+ * - All selected UTXOs have valid scriptPubKey fields
81
+ * - Total input value always covers output value + fees
82
+ * - UTXO selection is re-run if fee increases after accurate calculation
83
+ *
84
+ * @param params - Parameters for the commit transaction
85
+ * @returns Complete information for the prepared commit transaction
86
+ * @throws Error if no valid UTXOs are available or insufficient funds
87
+ */
88
+ export declare function createCommitTransaction(params: CommitTransactionParams): Promise<CommitTransactionResult>;
89
+ export {};
@@ -0,0 +1,311 @@
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
+ import * as btc from '@scure/btc-signer';
10
+ import * as ordinals from 'micro-ordinals';
11
+ import { schnorr } from '@noble/curves/secp256k1';
12
+ import { calculateFee } from '../fee-calculation.js';
13
+ import { selectUtxos } from '../utxo-selection.js';
14
+ // Define minimum dust limit (satoshis)
15
+ const MIN_DUST_LIMIT = 546;
16
+ // Maximum iterations for UTXO reselection to prevent infinite loops
17
+ const MAX_SELECTION_ITERATIONS = 5;
18
+ /**
19
+ * Get @scure/btc-signer network configuration
20
+ */
21
+ function getScureNetwork(network) {
22
+ switch (network) {
23
+ case 'mainnet':
24
+ return btc.NETWORK;
25
+ case 'testnet':
26
+ case 'signet':
27
+ case 'regtest':
28
+ return btc.TEST_NETWORK;
29
+ default:
30
+ return btc.NETWORK;
31
+ }
32
+ }
33
+ /**
34
+ * Validates that a UTXO has all required fields for spending
35
+ *
36
+ * @param utxo - The UTXO to validate
37
+ * @returns true if the UTXO is valid and spendable, false otherwise
38
+ */
39
+ function isValidSpendableUtxo(utxo) {
40
+ return !!(utxo.txid &&
41
+ typeof utxo.vout === 'number' &&
42
+ utxo.value > 0 &&
43
+ utxo.scriptPubKey &&
44
+ utxo.scriptPubKey.length > 0);
45
+ }
46
+ /**
47
+ * Estimates the size of a commit transaction
48
+ *
49
+ * @param inputCount - Number of transaction inputs
50
+ * @param outputCount - Number of transaction outputs (including commit and change)
51
+ * @returns Estimated transaction size in virtual bytes
52
+ */
53
+ function estimateCommitTxSize(inputCount, outputCount) {
54
+ // Transaction overhead
55
+ const overhead = 10.5;
56
+ // P2WPKH inputs (assuming most common case)
57
+ const inputSize = 68 * inputCount;
58
+ // P2TR output for commit and P2WPKH for change
59
+ const commitOutputSize = 43; // P2TR output
60
+ const changeOutputSize = outputCount > 1 ? 31 * (outputCount - 1) : 0; // P2WPKH outputs for change
61
+ return Math.ceil(overhead + inputSize + commitOutputSize + changeOutputSize);
62
+ }
63
+ /**
64
+ * Creates a commit transaction for an ordinals inscription
65
+ *
66
+ * This function:
67
+ * 1. Validates and filters UTXOs to ensure they are spendable
68
+ * 2. Creates an inscription with the provided content
69
+ * 3. Generates a reveal keypair and script
70
+ * 4. Creates a P2TR commit address
71
+ * 5. Selects UTXOs to fund the transaction (with iterative reselection if needed)
72
+ * 6. Builds a PSBT with commit output and change
73
+ *
74
+ * The function ensures that:
75
+ * - All selected UTXOs have valid scriptPubKey fields
76
+ * - Total input value always covers output value + fees
77
+ * - UTXO selection is re-run if fee increases after accurate calculation
78
+ *
79
+ * @param params - Parameters for the commit transaction
80
+ * @returns Complete information for the prepared commit transaction
81
+ * @throws Error if no valid UTXOs are available or insufficient funds
82
+ */
83
+ export async function createCommitTransaction(params) {
84
+ const { content, contentType, utxos, changeAddress, feeRate, network, minimumCommitAmount = MIN_DUST_LIMIT, metadata, pointer } = params;
85
+ // Validate inputs
86
+ if (!utxos || utxos.length === 0) {
87
+ throw new Error('No UTXOs provided to fund the transaction.');
88
+ }
89
+ if (!content || content.length === 0) {
90
+ throw new Error('Invalid inscription: missing content.');
91
+ }
92
+ if (!contentType) {
93
+ throw new Error('Invalid inscription: missing content type.');
94
+ }
95
+ if (!changeAddress) {
96
+ throw new Error('Change address is required.');
97
+ }
98
+ if (feeRate <= 0) {
99
+ throw new Error(`Invalid fee rate: ${feeRate}`);
100
+ }
101
+ // CRITICAL: Pre-filter UTXOs to ensure all have valid scriptPubKey
102
+ // This prevents silent failures where UTXOs are selected but can't be spent
103
+ const validUtxos = utxos.filter(isValidSpendableUtxo);
104
+ if (validUtxos.length === 0) {
105
+ const invalidCount = utxos.length;
106
+ const invalidReasons = [];
107
+ utxos.forEach((utxo, idx) => {
108
+ if (!utxo.scriptPubKey || utxo.scriptPubKey.length === 0) {
109
+ invalidReasons.push(`UTXO ${idx} (${utxo.txid}:${utxo.vout}): missing scriptPubKey`);
110
+ }
111
+ else if (!utxo.txid) {
112
+ invalidReasons.push(`UTXO ${idx}: missing txid`);
113
+ }
114
+ else if (typeof utxo.vout !== 'number') {
115
+ invalidReasons.push(`UTXO ${idx} (${utxo.txid}): missing or invalid vout`);
116
+ }
117
+ else if (utxo.value <= 0) {
118
+ invalidReasons.push(`UTXO ${idx} (${utxo.txid}:${utxo.vout}): invalid value (${utxo.value})`);
119
+ }
120
+ });
121
+ throw new Error(`No valid spendable UTXOs available. ${invalidCount} UTXO(s) provided but all are invalid:\n` +
122
+ invalidReasons.slice(0, 5).join('\n') +
123
+ (invalidReasons.length > 5 ? `\n... and ${invalidReasons.length - 5} more` : ''));
124
+ }
125
+ // Log filtered UTXOs for debugging
126
+ if (validUtxos.length < utxos.length) {
127
+ const filteredCount = utxos.length - validUtxos.length;
128
+ console.warn(`Filtered out ${filteredCount} invalid UTXO(s). ${validUtxos.length} valid UTXO(s) remain.`);
129
+ }
130
+ // Step 1: Create the inscription object
131
+ const tags = {
132
+ contentType
133
+ };
134
+ // Add metadata if provided
135
+ if (metadata && Object.keys(metadata).length > 0) {
136
+ tags.metadata = metadata;
137
+ }
138
+ // Add pointer if provided
139
+ if (typeof pointer !== 'undefined') {
140
+ tags.pointer = pointer;
141
+ }
142
+ const inscription = {
143
+ tags,
144
+ body: new Uint8Array(content)
145
+ };
146
+ // Step 2: Generate a reveal keypair
147
+ // Use random private key for reveal transaction
148
+ const revealPrivateKey = schnorr.utils.randomPrivateKey();
149
+ const revealPublicKey = schnorr.getPublicKey(revealPrivateKey);
150
+ // Step 3: Create the inscription script tree using micro-ordinals
151
+ const scriptTree = ordinals.p2tr_ord_reveal(revealPublicKey, [inscription]);
152
+ // Step 4: Create P2TR address for the commit output
153
+ const scureNetwork = getScureNetwork(network);
154
+ // Create taproot output using the inscription script tree
155
+ // Use the reveal public key as the internal key
156
+ const taprootPayment = btc.p2tr(revealPublicKey, // internal key
157
+ scriptTree, // script tree
158
+ scureNetwork, false, // allowUnknownOutputs
159
+ [ordinals.OutOrdinalReveal] // customScripts
160
+ );
161
+ if (!taprootPayment.address) {
162
+ throw new Error('Failed to generate P2TR commit address');
163
+ }
164
+ const commitAddress = taprootPayment.address;
165
+ // Extract script information from the taproot payment
166
+ if (!taprootPayment.leaves || taprootPayment.leaves.length === 0) {
167
+ throw new Error('Failed to extract taproot leaves from P2TR payment');
168
+ }
169
+ const leaf = taprootPayment.leaves[0];
170
+ const leafVersion = leaf.version ?? 0xc0;
171
+ // Compute control block from leaf data
172
+ // The control block is: version byte | internal key (32 bytes) | merkle path
173
+ const controlBlock = btc.TaprootControlBlock.encode({
174
+ version: leafVersion,
175
+ internalKey: revealPublicKey,
176
+ merklePath: leaf.path
177
+ });
178
+ // Step 5: Calculate minimum amount needed for the commit output
179
+ const commitOutputValue = Math.max(minimumCommitAmount, MIN_DUST_LIMIT);
180
+ // Step 6: Iterative UTXO selection with fee recalculation
181
+ // This ensures that after we know the actual input count, we have enough funds
182
+ let selectedUtxos = [];
183
+ let totalInputValue = 0;
184
+ let estimatedFee = 0;
185
+ let iteration = 0;
186
+ // Start with initial estimate (1 input, 2 outputs)
187
+ let targetAmount = commitOutputValue + Number(calculateFee(estimateCommitTxSize(1, 2), feeRate));
188
+ while (iteration < MAX_SELECTION_ITERATIONS) {
189
+ iteration++;
190
+ // Select UTXOs based on current target amount
191
+ const options = {
192
+ targetAmount
193
+ };
194
+ try {
195
+ const selectionResult = selectUtxos(validUtxos, options);
196
+ selectedUtxos = selectionResult.selectedUtxos;
197
+ totalInputValue = selectionResult.totalInputValue;
198
+ }
199
+ catch (error) {
200
+ throw new Error(`Insufficient funds. Need ${targetAmount} sats for commit output (${commitOutputValue} sats) and estimated fees. ` +
201
+ `Available: ${validUtxos.reduce((sum, u) => sum + u.value, 0)} sats from ${validUtxos.length} valid UTXO(s). ` +
202
+ `${error instanceof Error ? error.message : 'Unknown error'}`);
203
+ }
204
+ // Calculate accurate fee based on actual selected input count
205
+ // Assume 2 outputs (commit + change) for now - we'll adjust later if no change
206
+ const actualInputCount = selectedUtxos.length;
207
+ const estimatedVBytes = estimateCommitTxSize(actualInputCount, 2);
208
+ estimatedFee = Number(calculateFee(estimatedVBytes, feeRate));
209
+ // Check if we need to account for no change output
210
+ const potentialChange = totalInputValue - commitOutputValue - estimatedFee;
211
+ let finalOutputCount = 2;
212
+ if (potentialChange < MIN_DUST_LIMIT) {
213
+ // No change output, recalculate fee with 1 output
214
+ finalOutputCount = 1;
215
+ const adjustedVBytes = estimateCommitTxSize(actualInputCount, finalOutputCount);
216
+ estimatedFee = Number(calculateFee(adjustedVBytes, feeRate));
217
+ }
218
+ // Check if we have enough funds with the accurate fee calculation
219
+ const requiredTotal = commitOutputValue + estimatedFee;
220
+ if (totalInputValue >= requiredTotal) {
221
+ // We have enough funds, break out of loop
222
+ break;
223
+ }
224
+ // Not enough funds, need to reselect with higher target
225
+ // Add a small buffer (5%) to account for potential fee variations
226
+ targetAmount = Math.ceil(requiredTotal * 1.05);
227
+ if (iteration >= MAX_SELECTION_ITERATIONS) {
228
+ throw new Error(`Unable to select sufficient UTXOs after ${MAX_SELECTION_ITERATIONS} iterations. ` +
229
+ `Required: ${requiredTotal} sats (commit: ${commitOutputValue}, fee: ${estimatedFee}), ` +
230
+ `Selected: ${totalInputValue} sats from ${selectedUtxos.length} UTXO(s). ` +
231
+ `Total available: ${validUtxos.reduce((sum, u) => sum + u.value, 0)} sats from ${validUtxos.length} valid UTXO(s).`);
232
+ }
233
+ }
234
+ // Final validation: ensure we have selected UTXOs
235
+ if (!selectedUtxos || selectedUtxos.length === 0) {
236
+ throw new Error('No UTXOs selected for the transaction after selection process.');
237
+ }
238
+ // Step 7: Create transaction using @scure/btc-signer
239
+ const tx = new btc.Transaction();
240
+ // Add inputs - all selected UTXOs are already validated to have scriptPubKey
241
+ for (const utxo of selectedUtxos) {
242
+ // This check is now redundant due to pre-filtering, but kept as defense-in-depth
243
+ if (!utxo.scriptPubKey) {
244
+ throw new Error(`CRITICAL ERROR: Selected UTXO ${utxo.txid}:${utxo.vout} is missing scriptPubKey. ` +
245
+ `This should never happen due to pre-filtering. Please report this bug.`);
246
+ }
247
+ tx.addInput({
248
+ txid: utxo.txid,
249
+ index: utxo.vout,
250
+ witnessUtxo: {
251
+ script: Buffer.from(utxo.scriptPubKey, 'hex'),
252
+ amount: BigInt(utxo.value)
253
+ }
254
+ });
255
+ }
256
+ // Verify input count matches selected UTXOs
257
+ if (tx.inputsLength !== selectedUtxos.length) {
258
+ throw new Error(`Input count mismatch: expected ${selectedUtxos.length} inputs but transaction has ${tx.inputsLength}. ` +
259
+ `This indicates a critical error in transaction construction.`);
260
+ }
261
+ // Step 8: Calculate final fee based on actual transaction structure
262
+ const actualInputCount = tx.inputsLength;
263
+ // Determine if we'll have a change output
264
+ const preliminaryChange = totalInputValue - commitOutputValue - estimatedFee;
265
+ const willHaveChange = preliminaryChange >= MIN_DUST_LIMIT;
266
+ const finalOutputCount = willHaveChange ? 2 : 1;
267
+ // Calculate final fee with correct output count
268
+ const finalVBytes = estimateCommitTxSize(actualInputCount, finalOutputCount);
269
+ const finalFee = Number(calculateFee(finalVBytes, feeRate));
270
+ // CRITICAL: Final validation that inputs cover outputs + fees
271
+ const finalChange = totalInputValue - commitOutputValue - finalFee;
272
+ if (finalChange < 0) {
273
+ throw new Error(`CRITICAL ERROR: Outputs exceed inputs! ` +
274
+ `Inputs: ${totalInputValue} sats, ` +
275
+ `Outputs: ${commitOutputValue} sats (commit) + ${finalFee} sats (fee) = ${commitOutputValue + finalFee} sats. ` +
276
+ `Deficit: ${Math.abs(finalChange)} sats. ` +
277
+ `This should never happen due to iterative selection. Please report this bug.`);
278
+ }
279
+ // Step 9: Add the commit output using the P2TR address
280
+ tx.addOutputAddress(commitAddress, BigInt(commitOutputValue), scureNetwork);
281
+ // Step 10: Add change output if above dust limit
282
+ if (finalChange >= MIN_DUST_LIMIT) {
283
+ tx.addOutputAddress(changeAddress, BigInt(finalChange), scureNetwork);
284
+ }
285
+ else if (finalChange > 0) {
286
+ // If change is below dust limit, it's effectively added to the fee
287
+ console.log(`Change amount ${finalChange} sats is below dust limit (${MIN_DUST_LIMIT} sats), adding to fee. ` +
288
+ `Final fee: ${finalFee + finalChange} sats.`);
289
+ }
290
+ // Step 11: Get the PSBT as base64
291
+ const txPsbt = tx.toPSBT();
292
+ const commitPsbtBase64 = typeof txPsbt === 'string' ? txPsbt : Buffer.from(txPsbt).toString('base64');
293
+ return {
294
+ commitAddress,
295
+ commitPsbtBase64,
296
+ commitPsbt: tx,
297
+ commitAmount: commitOutputValue,
298
+ selectedUtxos,
299
+ fees: {
300
+ // Include dust in final fee if no change output
301
+ commit: finalChange >= MIN_DUST_LIMIT ? finalFee : finalFee + finalChange
302
+ },
303
+ revealPrivateKey: Buffer.from(revealPrivateKey).toString('hex'),
304
+ revealPublicKey: Buffer.from(revealPublicKey).toString('hex'),
305
+ inscriptionScript: {
306
+ script: leaf.script,
307
+ controlBlock,
308
+ leafVersion
309
+ }
310
+ };
311
+ }
@@ -0,0 +1,7 @@
1
+ /**
2
+ * Bitcoin Transactions
3
+ *
4
+ * This directory contains modules for creating and managing Bitcoin transactions,
5
+ * particularly for Ordinals inscriptions.
6
+ */
7
+ export { createCommitTransaction, type CommitTransactionParams, type CommitTransactionResult } from './commit.js';
@@ -0,0 +1,8 @@
1
+ /**
2
+ * Bitcoin Transactions
3
+ *
4
+ * This directory contains modules for creating and managing Bitcoin transactions,
5
+ * particularly for Ordinals inscriptions.
6
+ */
7
+ // Export commit transaction functionality
8
+ export { createCommitTransaction } from './commit.js';
@@ -0,0 +1,9 @@
1
+ import { BitcoinTransaction, Utxo } from '../types';
2
+ import { SelectionOptions, SelectionResult } from './utxo';
3
+ export interface BuildTransferOptions extends Omit<SelectionOptions, 'targetAmountSats' | 'feeRateSatsPerVb'> {
4
+ changeAddress?: string;
5
+ }
6
+ export declare function buildTransferTransaction(availableUtxos: Utxo[], recipientAddress: string, amountSats: number, feeRateSatsPerVb: number, options?: BuildTransferOptions): {
7
+ tx: BitcoinTransaction;
8
+ selection: SelectionResult;
9
+ };
@@ -0,0 +1,26 @@
1
+ import { DUST_LIMIT_SATS } from '../types';
2
+ import { selectUtxos } from './utxo';
3
+ export function buildTransferTransaction(availableUtxos, recipientAddress, amountSats, feeRateSatsPerVb, options = {}) {
4
+ const selection = selectUtxos(availableUtxos, {
5
+ targetAmountSats: amountSats,
6
+ feeRateSatsPerVb,
7
+ allowLocked: options.allowLocked,
8
+ forbidInscriptionBearingInputs: options.forbidInscriptionBearingInputs,
9
+ changeAddress: options.changeAddress,
10
+ feeEstimate: options.feeEstimate
11
+ });
12
+ const vin = selection.selected.map(u => ({ txid: u.txid, vout: u.vout }));
13
+ const outputs = [];
14
+ outputs.push({ value: amountSats, scriptPubKey: 'script', address: recipientAddress });
15
+ if (selection.changeSats >= DUST_LIMIT_SATS) {
16
+ const changeAddress = options.changeAddress || (selection.selected.find(u => !!u.address)?.address ?? 'change');
17
+ outputs.push({ value: selection.changeSats, scriptPubKey: 'script', address: changeAddress });
18
+ }
19
+ const tx = {
20
+ txid: '',
21
+ vin,
22
+ vout: outputs,
23
+ fee: selection.feeSats
24
+ };
25
+ return { tx, selection };
26
+ }