@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.
- package/.eslintrc.json +33 -0
- package/.turbo/turbo-build.log +1 -0
- package/.turbo/turbo-test.log +68353 -0
- package/dist/adapters/FeeOracleMock.d.ts +6 -0
- package/dist/adapters/FeeOracleMock.js +8 -0
- package/dist/adapters/index.d.ts +4 -0
- package/dist/adapters/index.js +4 -0
- package/dist/adapters/providers/OrdHttpProvider.d.ts +56 -0
- package/dist/adapters/providers/OrdHttpProvider.js +110 -0
- package/dist/adapters/providers/OrdMockProvider.d.ts +70 -0
- package/dist/adapters/providers/OrdMockProvider.js +75 -0
- package/dist/adapters/types.d.ts +71 -0
- package/dist/adapters/types.js +1 -0
- package/dist/bitcoin/BitcoinManager.d.ts +15 -0
- package/dist/bitcoin/BitcoinManager.js +262 -0
- package/dist/bitcoin/BroadcastClient.d.ts +30 -0
- package/dist/bitcoin/BroadcastClient.js +35 -0
- package/dist/bitcoin/OrdinalsClient.d.ts +21 -0
- package/dist/bitcoin/OrdinalsClient.js +105 -0
- package/dist/bitcoin/PSBTBuilder.d.ts +24 -0
- package/dist/bitcoin/PSBTBuilder.js +80 -0
- package/dist/bitcoin/fee-calculation.d.ts +14 -0
- package/dist/bitcoin/fee-calculation.js +31 -0
- package/dist/bitcoin/providers/OrdNodeProvider.d.ts +38 -0
- package/dist/bitcoin/providers/OrdNodeProvider.js +67 -0
- package/dist/bitcoin/providers/OrdinalsProvider.d.ts +33 -0
- package/dist/bitcoin/providers/OrdinalsProvider.js +50 -0
- package/dist/bitcoin/providers/types.d.ts +63 -0
- package/dist/bitcoin/providers/types.js +1 -0
- package/dist/bitcoin/transactions/commit.d.ts +89 -0
- package/dist/bitcoin/transactions/commit.js +311 -0
- package/dist/bitcoin/transactions/index.d.ts +7 -0
- package/dist/bitcoin/transactions/index.js +8 -0
- package/dist/bitcoin/transfer.d.ts +9 -0
- package/dist/bitcoin/transfer.js +26 -0
- package/dist/bitcoin/utxo-selection.d.ts +78 -0
- package/dist/bitcoin/utxo-selection.js +237 -0
- package/dist/bitcoin/utxo.d.ts +26 -0
- package/dist/bitcoin/utxo.js +78 -0
- package/dist/contexts/credentials-v1.json +195 -0
- package/dist/contexts/credentials-v2-examples.json +5 -0
- package/dist/contexts/credentials-v2.json +301 -0
- package/dist/contexts/credentials.json +195 -0
- package/dist/contexts/data-integrity-v2.json +81 -0
- package/dist/contexts/dids.json +57 -0
- package/dist/contexts/ed255192020.json +93 -0
- package/dist/contexts/ordinals-plus.json +23 -0
- package/dist/contexts/originals.json +22 -0
- package/dist/core/OriginalsSDK.d.ts +158 -0
- package/dist/core/OriginalsSDK.js +274 -0
- package/dist/crypto/Multikey.d.ts +30 -0
- package/dist/crypto/Multikey.js +149 -0
- package/dist/crypto/Signer.d.ts +21 -0
- package/dist/crypto/Signer.js +196 -0
- package/dist/crypto/noble-init.d.ts +18 -0
- package/dist/crypto/noble-init.js +106 -0
- package/dist/did/BtcoDidResolver.d.ts +57 -0
- package/dist/did/BtcoDidResolver.js +166 -0
- package/dist/did/DIDManager.d.ts +101 -0
- package/dist/did/DIDManager.js +493 -0
- package/dist/did/Ed25519Verifier.d.ts +30 -0
- package/dist/did/Ed25519Verifier.js +59 -0
- package/dist/did/KeyManager.d.ts +17 -0
- package/dist/did/KeyManager.js +207 -0
- package/dist/did/WebVHManager.d.ts +100 -0
- package/dist/did/WebVHManager.js +304 -0
- package/dist/did/createBtcoDidDocument.d.ts +10 -0
- package/dist/did/createBtcoDidDocument.js +42 -0
- package/dist/did/providers/OrdinalsClientProviderAdapter.d.ts +23 -0
- package/dist/did/providers/OrdinalsClientProviderAdapter.js +51 -0
- package/dist/events/EventEmitter.d.ts +115 -0
- package/dist/events/EventEmitter.js +198 -0
- package/dist/events/index.d.ts +7 -0
- package/dist/events/index.js +6 -0
- package/dist/events/types.d.ts +286 -0
- package/dist/events/types.js +9 -0
- package/dist/examples/basic-usage.d.ts +3 -0
- package/dist/examples/basic-usage.js +62 -0
- package/dist/examples/run.d.ts +1 -0
- package/dist/examples/run.js +4 -0
- package/dist/index.d.ts +39 -0
- package/dist/index.js +47 -0
- package/dist/lifecycle/BatchOperations.d.ts +147 -0
- package/dist/lifecycle/BatchOperations.js +251 -0
- package/dist/lifecycle/LifecycleManager.d.ts +116 -0
- package/dist/lifecycle/LifecycleManager.js +971 -0
- package/dist/lifecycle/OriginalsAsset.d.ts +164 -0
- package/dist/lifecycle/OriginalsAsset.js +380 -0
- package/dist/lifecycle/ProvenanceQuery.d.ts +126 -0
- package/dist/lifecycle/ProvenanceQuery.js +220 -0
- package/dist/lifecycle/ResourceVersioning.d.ts +73 -0
- package/dist/lifecycle/ResourceVersioning.js +127 -0
- package/dist/migration/MigrationManager.d.ts +86 -0
- package/dist/migration/MigrationManager.js +412 -0
- package/dist/migration/audit/AuditLogger.d.ts +51 -0
- package/dist/migration/audit/AuditLogger.js +156 -0
- package/dist/migration/checkpoint/CheckpointManager.d.ts +31 -0
- package/dist/migration/checkpoint/CheckpointManager.js +96 -0
- package/dist/migration/checkpoint/CheckpointStorage.d.ts +26 -0
- package/dist/migration/checkpoint/CheckpointStorage.js +89 -0
- package/dist/migration/index.d.ts +22 -0
- package/dist/migration/index.js +27 -0
- package/dist/migration/operations/BaseMigration.d.ts +48 -0
- package/dist/migration/operations/BaseMigration.js +83 -0
- package/dist/migration/operations/PeerToBtcoMigration.d.ts +25 -0
- package/dist/migration/operations/PeerToBtcoMigration.js +67 -0
- package/dist/migration/operations/PeerToWebvhMigration.d.ts +19 -0
- package/dist/migration/operations/PeerToWebvhMigration.js +46 -0
- package/dist/migration/operations/WebvhToBtcoMigration.d.ts +25 -0
- package/dist/migration/operations/WebvhToBtcoMigration.js +67 -0
- package/dist/migration/rollback/RollbackManager.d.ts +29 -0
- package/dist/migration/rollback/RollbackManager.js +146 -0
- package/dist/migration/state/StateMachine.d.ts +25 -0
- package/dist/migration/state/StateMachine.js +76 -0
- package/dist/migration/state/StateTracker.d.ts +36 -0
- package/dist/migration/state/StateTracker.js +123 -0
- package/dist/migration/types.d.ts +306 -0
- package/dist/migration/types.js +33 -0
- package/dist/migration/validation/BitcoinValidator.d.ts +13 -0
- package/dist/migration/validation/BitcoinValidator.js +83 -0
- package/dist/migration/validation/CredentialValidator.d.ts +13 -0
- package/dist/migration/validation/CredentialValidator.js +46 -0
- package/dist/migration/validation/DIDCompatibilityValidator.d.ts +16 -0
- package/dist/migration/validation/DIDCompatibilityValidator.js +127 -0
- package/dist/migration/validation/LifecycleValidator.d.ts +10 -0
- package/dist/migration/validation/LifecycleValidator.js +52 -0
- package/dist/migration/validation/StorageValidator.d.ts +10 -0
- package/dist/migration/validation/StorageValidator.js +65 -0
- package/dist/migration/validation/ValidationPipeline.d.ts +29 -0
- package/dist/migration/validation/ValidationPipeline.js +180 -0
- package/dist/storage/LocalStorageAdapter.d.ts +11 -0
- package/dist/storage/LocalStorageAdapter.js +53 -0
- package/dist/storage/MemoryStorageAdapter.d.ts +6 -0
- package/dist/storage/MemoryStorageAdapter.js +21 -0
- package/dist/storage/StorageAdapter.d.ts +16 -0
- package/dist/storage/StorageAdapter.js +1 -0
- package/dist/storage/index.d.ts +2 -0
- package/dist/storage/index.js +2 -0
- package/dist/types/bitcoin.d.ts +84 -0
- package/dist/types/bitcoin.js +1 -0
- package/dist/types/common.d.ts +82 -0
- package/dist/types/common.js +1 -0
- package/dist/types/credentials.d.ts +75 -0
- package/dist/types/credentials.js +1 -0
- package/dist/types/did.d.ts +26 -0
- package/dist/types/did.js +1 -0
- package/dist/types/index.d.ts +5 -0
- package/dist/types/index.js +5 -0
- package/dist/types/network.d.ts +78 -0
- package/dist/types/network.js +145 -0
- package/dist/utils/EventLogger.d.ts +71 -0
- package/dist/utils/EventLogger.js +232 -0
- package/dist/utils/Logger.d.ts +106 -0
- package/dist/utils/Logger.js +257 -0
- package/dist/utils/MetricsCollector.d.ts +110 -0
- package/dist/utils/MetricsCollector.js +264 -0
- package/dist/utils/bitcoin-address.d.ts +38 -0
- package/dist/utils/bitcoin-address.js +113 -0
- package/dist/utils/cbor.d.ts +2 -0
- package/dist/utils/cbor.js +9 -0
- package/dist/utils/encoding.d.ts +37 -0
- package/dist/utils/encoding.js +120 -0
- package/dist/utils/hash.d.ts +1 -0
- package/dist/utils/hash.js +5 -0
- package/dist/utils/retry.d.ts +10 -0
- package/dist/utils/retry.js +35 -0
- package/dist/utils/satoshi-validation.d.ts +60 -0
- package/dist/utils/satoshi-validation.js +156 -0
- package/dist/utils/serialization.d.ts +14 -0
- package/dist/utils/serialization.js +76 -0
- package/dist/utils/telemetry.d.ts +17 -0
- package/dist/utils/telemetry.js +24 -0
- package/dist/utils/validation.d.ts +5 -0
- package/dist/utils/validation.js +98 -0
- package/dist/vc/CredentialManager.d.ts +22 -0
- package/dist/vc/CredentialManager.js +227 -0
- package/dist/vc/Issuer.d.ts +27 -0
- package/dist/vc/Issuer.js +70 -0
- package/dist/vc/Verifier.d.ts +16 -0
- package/dist/vc/Verifier.js +50 -0
- package/dist/vc/cryptosuites/bbs.d.ts +44 -0
- package/dist/vc/cryptosuites/bbs.js +213 -0
- package/dist/vc/cryptosuites/bbsSimple.d.ts +9 -0
- package/dist/vc/cryptosuites/bbsSimple.js +12 -0
- package/dist/vc/cryptosuites/eddsa.d.ts +30 -0
- package/dist/vc/cryptosuites/eddsa.js +81 -0
- package/dist/vc/documentLoader.d.ts +16 -0
- package/dist/vc/documentLoader.js +59 -0
- package/dist/vc/proofs/data-integrity.d.ts +21 -0
- package/dist/vc/proofs/data-integrity.js +15 -0
- package/dist/vc/utils/jsonld.d.ts +2 -0
- package/dist/vc/utils/jsonld.js +15 -0
- package/package.json +79 -0
- package/src/adapters/FeeOracleMock.ts +9 -0
- package/src/adapters/index.ts +5 -0
- package/src/adapters/providers/OrdHttpProvider.ts +126 -0
- package/src/adapters/providers/OrdMockProvider.ts +101 -0
- package/src/adapters/types.ts +66 -0
- package/src/bitcoin/BitcoinManager.ts +330 -0
- package/src/bitcoin/BroadcastClient.ts +54 -0
- package/src/bitcoin/OrdinalsClient.ts +119 -0
- package/src/bitcoin/PSBTBuilder.ts +106 -0
- package/src/bitcoin/fee-calculation.ts +38 -0
- package/src/bitcoin/providers/OrdNodeProvider.ts +92 -0
- package/src/bitcoin/providers/OrdinalsProvider.ts +56 -0
- package/src/bitcoin/providers/types.ts +59 -0
- package/src/bitcoin/transactions/commit.ts +465 -0
- package/src/bitcoin/transactions/index.ts +13 -0
- package/src/bitcoin/transfer.ts +43 -0
- package/src/bitcoin/utxo-selection.ts +322 -0
- package/src/bitcoin/utxo.ts +113 -0
- package/src/contexts/credentials-v1.json +237 -0
- package/src/contexts/credentials-v2-examples.json +5 -0
- package/src/contexts/credentials-v2.json +340 -0
- package/src/contexts/credentials.json +237 -0
- package/src/contexts/data-integrity-v2.json +81 -0
- package/src/contexts/dids.json +58 -0
- package/src/contexts/ed255192020.json +93 -0
- package/src/contexts/ordinals-plus.json +23 -0
- package/src/contexts/originals.json +22 -0
- package/src/core/OriginalsSDK.ts +416 -0
- package/src/crypto/Multikey.ts +194 -0
- package/src/crypto/Signer.ts +254 -0
- package/src/crypto/noble-init.ts +121 -0
- package/src/did/BtcoDidResolver.ts +227 -0
- package/src/did/DIDManager.ts +694 -0
- package/src/did/Ed25519Verifier.ts +68 -0
- package/src/did/KeyManager.ts +236 -0
- package/src/did/WebVHManager.ts +489 -0
- package/src/did/createBtcoDidDocument.ts +59 -0
- package/src/did/providers/OrdinalsClientProviderAdapter.ts +68 -0
- package/src/events/EventEmitter.ts +222 -0
- package/src/events/index.ts +19 -0
- package/src/events/types.ts +331 -0
- package/src/examples/basic-usage.ts +78 -0
- package/src/examples/run.ts +5 -0
- package/src/index.ts +84 -0
- package/src/lifecycle/BatchOperations.ts +373 -0
- package/src/lifecycle/LifecycleManager.ts +1218 -0
- package/src/lifecycle/OriginalsAsset.ts +524 -0
- package/src/lifecycle/ProvenanceQuery.ts +280 -0
- package/src/lifecycle/ResourceVersioning.ts +163 -0
- package/src/migration/MigrationManager.ts +527 -0
- package/src/migration/audit/AuditLogger.ts +176 -0
- package/src/migration/checkpoint/CheckpointManager.ts +112 -0
- package/src/migration/checkpoint/CheckpointStorage.ts +101 -0
- package/src/migration/index.ts +33 -0
- package/src/migration/operations/BaseMigration.ts +126 -0
- package/src/migration/operations/PeerToBtcoMigration.ts +105 -0
- package/src/migration/operations/PeerToWebvhMigration.ts +62 -0
- package/src/migration/operations/WebvhToBtcoMigration.ts +105 -0
- package/src/migration/rollback/RollbackManager.ts +170 -0
- package/src/migration/state/StateMachine.ts +92 -0
- package/src/migration/state/StateTracker.ts +156 -0
- package/src/migration/types.ts +344 -0
- package/src/migration/validation/BitcoinValidator.ts +107 -0
- package/src/migration/validation/CredentialValidator.ts +62 -0
- package/src/migration/validation/DIDCompatibilityValidator.ts +151 -0
- package/src/migration/validation/LifecycleValidator.ts +64 -0
- package/src/migration/validation/StorageValidator.ts +79 -0
- package/src/migration/validation/ValidationPipeline.ts +213 -0
- package/src/storage/LocalStorageAdapter.ts +61 -0
- package/src/storage/MemoryStorageAdapter.ts +29 -0
- package/src/storage/StorageAdapter.ts +25 -0
- package/src/storage/index.ts +3 -0
- package/src/types/bitcoin.ts +98 -0
- package/src/types/common.ts +92 -0
- package/src/types/credentials.ts +88 -0
- package/src/types/did.ts +31 -0
- package/src/types/external-shims.d.ts +53 -0
- package/src/types/index.ts +7 -0
- package/src/types/network.ts +175 -0
- package/src/utils/EventLogger.ts +298 -0
- package/src/utils/Logger.ts +322 -0
- package/src/utils/MetricsCollector.ts +358 -0
- package/src/utils/bitcoin-address.ts +130 -0
- package/src/utils/cbor.ts +12 -0
- package/src/utils/encoding.ts +127 -0
- package/src/utils/hash.ts +6 -0
- package/src/utils/retry.ts +46 -0
- package/src/utils/satoshi-validation.ts +196 -0
- package/src/utils/serialization.ts +96 -0
- package/src/utils/telemetry.ts +40 -0
- package/src/utils/validation.ts +119 -0
- package/src/vc/CredentialManager.ts +273 -0
- package/src/vc/Issuer.ts +100 -0
- package/src/vc/Verifier.ts +47 -0
- package/src/vc/cryptosuites/bbs.ts +253 -0
- package/src/vc/cryptosuites/bbsSimple.ts +21 -0
- package/src/vc/cryptosuites/eddsa.ts +99 -0
- package/src/vc/documentLoader.ts +67 -0
- package/src/vc/proofs/data-integrity.ts +33 -0
- package/src/vc/utils/jsonld.ts +18 -0
- package/test/logs/did_webvh_QmQsRNhXxPSCSeLjpbKYcNMZj8b1kBQAoC6cZmkFAgmpHt_example_com.jsonl +1 -0
- package/test/logs/did_webvh_QmSQkpD58qxcqMWHYcEmDUn3wk7hHvJwzYTrZmhh6zjPQ8_example_com_users_alice123_profile.jsonl +1 -0
- package/test/logs/did_webvh_QmTMda6VW3cUPdKk5Yc3onnv1vdgEumvWWdP2noAYFSjeG_example_com.jsonl +1 -0
- package/test/logs/did_webvh_QmTkb8KnCYcsnKKDCY4eUQuKQdKJLrCinvhw13v3zETxpE_example_com_users_etc_passwd.jsonl +1 -0
- package/test/logs/did_webvh_QmTn9FdCfpXFDrxHH52pwB4iNrDFVvNDjJ5FQTcDbmM3Fg_example_com.jsonl +1 -0
- package/test/logs/did_webvh_QmUCQUi1xjtJjnSQ1XJZgKqcWgErx1v7E2dz4DAPraAyJP_example_com_etc_passwd.jsonl +1 -0
- package/test/logs/did_webvh_QmUENQJCDKBJVRS5BkL6zjaUvcRjkb9xHmy7foCgRjmv3W_example_com.jsonl +1 -0
- package/test/logs/did_webvh_QmUPdGyjYBEnQ3aQUkmqyyBKTyjvCP5RZQGiaEDeTtf6dc_example_com.jsonl +1 -0
- package/test/logs/did_webvh_QmUoHTuHMWzQM29ZFrE9VLtMxkZ5u869yqee8LwcCLN39M_example_com.jsonl +1 -0
- package/test/logs/did_webvh_QmUrnms8G65ggVKsr9oQeWrLUBuGChwQPPb2LCFvaoNxaw_example_com_users_alice.jsonl +1 -0
- package/test/logs/did_webvh_QmUwiw3eSXdHG1hPvoAGu3cuK5jF4aXRYDLBAjPXfv1qzb_example_com_level1_level2.jsonl +1 -0
- package/test/logs/did_webvh_QmW7bzKh6yFEKNAtmVsrPGvvsMHTUQdzJSNsTZkbuGFpbj_example_com_secret.jsonl +1 -0
- package/test/logs/did_webvh_QmXbFTFBBJ8zpjdz9WE1DNN44A2wprFmdvAubjSffeyoAG_example_com.jsonl +1 -0
- package/test/logs/did_webvh_QmXyVXFPCTffGb2mTUFDeMCsScjnpLWkyUkVkB6q6QoeBf_example_com_C_Windows_System32.jsonl +1 -0
- package/test/logs/did_webvh_QmZK9B81gxZtvo5fYHYKDtKt8zZfZZPhmCMhbujBJuRRzE_example_com_etc_passwd.jsonl +1 -0
- package/test/logs/did_webvh_QmbNLCVSdXSVLrwFBvCBQPAabjtRb1SGHjkGVyw3QUbfBL_example_com_users_etc_passwd.jsonl +1 -0
- package/test/logs/did_webvh_QmbeaicmGW3Q7Yzbqmftc8a9jLBngokveb5A2KVKfVGZRb_example_com_my_org_user_name_test_123.jsonl +1 -0
- package/test/logs/did_webvh_Qmdv7c7AjUreUfoKyvkN2UpAWTozxKsv99srQetPJMJEnp_example_com_users_etc_passwd.jsonl +1 -0
- package/test/logs/did_webvh_QmeioWY3uypYLkYpCXe9eCYnn4xBVruP9C1d79azMrTEHG_example_com.jsonl +1 -0
- package/test/logs/did_webvh_Qmf4QH5dsA6Ecr5HJ6KaJL9uJRyY8RxrQdqoRCM25DzvPi_example_com_users_alice.jsonl +1 -0
- package/tests/__mocks__/bbs-signatures.js +17 -0
- package/tests/__mocks__/mf-base58.js +24 -0
- package/tests/e2e/README.md +97 -0
- package/tests/e2e/example.spec.ts +78 -0
- package/tests/fixtures/did-documents.ts +247 -0
- package/tests/index.test.ts +21 -0
- package/tests/integration/BatchOperations.test.ts +531 -0
- package/tests/integration/CompleteLifecycle.e2e.test.ts +735 -0
- package/tests/integration/CredentialManager.test.ts +42 -0
- package/tests/integration/DIDManager.test.ts +41 -0
- package/tests/integration/DidPeerToWebVhFlow.test.ts +351 -0
- package/tests/integration/Events.test.ts +435 -0
- package/tests/integration/Lifecycle.transfer.btco.integration.test.ts +25 -0
- package/tests/integration/LifecycleManager.test.ts +21 -0
- package/tests/integration/MultikeyFlow.test.ts +52 -0
- package/tests/integration/TelemetryIntegration.test.ts +395 -0
- package/tests/integration/WebVhPublish.test.ts +48 -0
- package/tests/integration/migration/peer-to-webvh.test.ts +172 -0
- package/tests/manual/test-commit-creation.ts +323 -0
- package/tests/mocks/MockKeyStore.ts +38 -0
- package/tests/mocks/adapters/MemoryStorageAdapter.ts +24 -0
- package/tests/mocks/adapters/MockFeeOracle.ts +11 -0
- package/tests/mocks/adapters/MockOrdinalsProvider.ts +76 -0
- package/tests/mocks/adapters/OrdMockProvider.test.ts +176 -0
- package/tests/mocks/adapters/index.ts +6 -0
- package/tests/performance/BatchOperations.perf.test.ts +403 -0
- package/tests/performance/logging.perf.test.ts +336 -0
- package/tests/sdk.test.ts +43 -0
- package/tests/security/bitcoin-penetration-tests.test.ts +622 -0
- package/tests/setup.bun.ts +69 -0
- package/tests/setup.jest.ts +23 -0
- package/tests/stress/batch-operations-stress.test.ts +571 -0
- package/tests/unit/adapters/FeeOracleMock.test.ts +40 -0
- package/tests/unit/bitcoin/BitcoinManager.test.ts +293 -0
- package/tests/unit/bitcoin/BroadcastClient.test.ts +52 -0
- package/tests/unit/bitcoin/OrdNodeProvider.test.ts +53 -0
- package/tests/unit/bitcoin/OrdinalsClient.test.ts +381 -0
- package/tests/unit/bitcoin/OrdinalsClientProvider.test.ts +102 -0
- package/tests/unit/bitcoin/PSBTBuilder.test.ts +84 -0
- package/tests/unit/bitcoin/fee-calculation.test.ts +261 -0
- package/tests/unit/bitcoin/transactions/commit.test.ts +649 -0
- package/tests/unit/bitcoin/transfer.test.ts +31 -0
- package/tests/unit/bitcoin/utxo-selection-new.test.ts +502 -0
- package/tests/unit/bitcoin/utxo.more.test.ts +39 -0
- package/tests/unit/bitcoin/utxo.selection.test.ts +38 -0
- package/tests/unit/core/OriginalsSDK.test.ts +152 -0
- package/tests/unit/crypto/Multikey.test.ts +206 -0
- package/tests/unit/crypto/Signer.test.ts +408 -0
- package/tests/unit/did/BtcoDidResolver.test.ts +611 -0
- package/tests/unit/did/DIDManager.more.test.ts +43 -0
- package/tests/unit/did/DIDManager.test.ts +185 -0
- package/tests/unit/did/Ed25519Verifier.test.ts +160 -0
- package/tests/unit/did/KeyManager.test.ts +452 -0
- package/tests/unit/did/OrdinalsClientProviderAdapter.test.ts +45 -0
- package/tests/unit/did/WebVHManager.test.ts +435 -0
- package/tests/unit/did/createBtcoDidDocument.test.ts +67 -0
- package/tests/unit/did/providers/OrdinalsClientProviderAdapter.test.ts +159 -0
- package/tests/unit/events/EventEmitter.test.ts +407 -0
- package/tests/unit/lifecycle/BatchOperations.test.ts +527 -0
- package/tests/unit/lifecycle/LifecycleManager.keymanagement.test.ts +312 -0
- package/tests/unit/lifecycle/LifecycleManager.prov.test.ts +18 -0
- package/tests/unit/lifecycle/LifecycleManager.test.ts +213 -0
- package/tests/unit/lifecycle/LifecycleManager.transfer.unit.test.ts +30 -0
- package/tests/unit/lifecycle/OriginalsAsset.test.ts +176 -0
- package/tests/unit/lifecycle/ProvenanceQuery.test.ts +577 -0
- package/tests/unit/lifecycle/ResourceVersioning.test.ts +651 -0
- package/tests/unit/storage/MemoryStorageAdapter.test.ts +93 -0
- package/tests/unit/types/network.test.ts +255 -0
- package/tests/unit/utils/EventIntegration.test.ts +384 -0
- package/tests/unit/utils/Logger.test.ts +473 -0
- package/tests/unit/utils/MetricsCollector.test.ts +358 -0
- package/tests/unit/utils/bitcoin-address.test.ts +250 -0
- package/tests/unit/utils/cbor.test.ts +35 -0
- package/tests/unit/utils/encoding.test.ts +318 -0
- package/tests/unit/utils/hash.test.ts +12 -0
- package/tests/unit/utils/retry.test.ts +100 -0
- package/tests/unit/utils/satoshi-validation.test.ts +354 -0
- package/tests/unit/utils/serialization.test.ts +124 -0
- package/tests/unit/utils/telemetry.test.ts +52 -0
- package/tests/unit/utils/validation.test.ts +141 -0
- package/tests/unit/vc/CredentialManager.test.ts +487 -0
- package/tests/unit/vc/Issuer.test.ts +107 -0
- package/tests/unit/vc/Verifier.test.ts +525 -0
- package/tests/unit/vc/bbs.test.ts +282 -0
- package/tests/unit/vc/cryptosuites/eddsa.test.ts +398 -0
- package/tests/unit/vc/documentLoader.test.ts +121 -0
- package/tests/unit/vc/proofs/data-integrity.test.ts +24 -0
- package/tsconfig.json +32 -0
- package/tsconfig.test.json +15 -0
- package/tsconfig.tsbuildinfo +1 -0
|
@@ -0,0 +1,262 @@
|
|
|
1
|
+
import { DUST_LIMIT_SATS } from '../types';
|
|
2
|
+
import { emitTelemetry, StructuredError } from '../utils/telemetry';
|
|
3
|
+
import { validateBitcoinAddress } from '../utils/bitcoin-address';
|
|
4
|
+
import { validateSatoshiNumber } from '../utils/satoshi-validation';
|
|
5
|
+
export class BitcoinManager {
|
|
6
|
+
constructor(config) {
|
|
7
|
+
this.config = config;
|
|
8
|
+
this.feeOracle = config.feeOracle;
|
|
9
|
+
this.ord = config.ordinalsProvider;
|
|
10
|
+
}
|
|
11
|
+
async resolveFeeRate(targetBlocks = 1, provided) {
|
|
12
|
+
// 1) Prefer external fee oracle
|
|
13
|
+
if (this.feeOracle) {
|
|
14
|
+
try {
|
|
15
|
+
const estimated = await this.feeOracle.estimateFeeRate(targetBlocks);
|
|
16
|
+
if (typeof estimated === 'number' && Number.isFinite(estimated) && estimated > 0) {
|
|
17
|
+
emitTelemetry(this.config.telemetry, {
|
|
18
|
+
name: 'bitcoin.fee.estimated',
|
|
19
|
+
attributes: { feeRate: estimated, source: 'feeOracle' }
|
|
20
|
+
});
|
|
21
|
+
return estimated;
|
|
22
|
+
}
|
|
23
|
+
}
|
|
24
|
+
catch (error) {
|
|
25
|
+
emitTelemetry(this.config.telemetry, {
|
|
26
|
+
name: 'bitcoin.fee.error',
|
|
27
|
+
level: 'warn',
|
|
28
|
+
attributes: { error: String(error), source: 'feeOracle' }
|
|
29
|
+
});
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
// 2) Fallback to ordinals provider if present
|
|
33
|
+
if (this.ord) {
|
|
34
|
+
try {
|
|
35
|
+
const estimated = await this.ord.estimateFee(targetBlocks);
|
|
36
|
+
if (typeof estimated === 'number' && Number.isFinite(estimated) && estimated > 0) {
|
|
37
|
+
emitTelemetry(this.config.telemetry, {
|
|
38
|
+
name: 'bitcoin.fee.estimated',
|
|
39
|
+
attributes: { feeRate: estimated, source: 'ordinalsProvider' }
|
|
40
|
+
});
|
|
41
|
+
return estimated;
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
catch (error) {
|
|
45
|
+
emitTelemetry(this.config.telemetry, {
|
|
46
|
+
name: 'bitcoin.fee.error',
|
|
47
|
+
level: 'warn',
|
|
48
|
+
attributes: { error: String(error), source: 'ordinalsProvider' }
|
|
49
|
+
});
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
// 3) If caller provided a valid non-zero fee rate, use it as last resort
|
|
53
|
+
if (typeof provided === 'number' && Number.isFinite(provided) && provided > 0) {
|
|
54
|
+
return provided;
|
|
55
|
+
}
|
|
56
|
+
return undefined;
|
|
57
|
+
}
|
|
58
|
+
async inscribeData(data, contentType, feeRate) {
|
|
59
|
+
// Input validation
|
|
60
|
+
if (!data) {
|
|
61
|
+
throw new StructuredError('INVALID_INPUT', 'Data to inscribe cannot be null or undefined');
|
|
62
|
+
}
|
|
63
|
+
if (!contentType || typeof contentType !== 'string') {
|
|
64
|
+
throw new StructuredError('INVALID_INPUT', 'Content type must be a non-empty string');
|
|
65
|
+
}
|
|
66
|
+
// Validate contentType is a valid MIME type
|
|
67
|
+
if (!/^[a-zA-Z0-9][a-zA-Z0-9!#$&^_.+-]{0,126}\/[a-zA-Z0-9][a-zA-Z0-9!#$&^_.+-]{0,126}$/.test(contentType)) {
|
|
68
|
+
throw new StructuredError('INVALID_INPUT', `Invalid MIME type format: ${contentType}`);
|
|
69
|
+
}
|
|
70
|
+
if (feeRate !== undefined && (typeof feeRate !== 'number' || feeRate <= 0 || !Number.isFinite(feeRate))) {
|
|
71
|
+
throw new StructuredError('INVALID_INPUT', 'Fee rate must be a positive number');
|
|
72
|
+
}
|
|
73
|
+
// Security: Reject extremely high fee rates to prevent accidental fund drainage
|
|
74
|
+
const MAX_REASONABLE_FEE_RATE = 10000; // sat/vB
|
|
75
|
+
if (feeRate !== undefined && feeRate > MAX_REASONABLE_FEE_RATE) {
|
|
76
|
+
throw new StructuredError('INVALID_INPUT', `Fee rate ${feeRate} exceeds maximum reasonable fee rate of ${MAX_REASONABLE_FEE_RATE} sat/vB`);
|
|
77
|
+
}
|
|
78
|
+
const effectiveFeeRate = await this.resolveFeeRate(1, feeRate);
|
|
79
|
+
if (!this.ord) {
|
|
80
|
+
throw new StructuredError('ORD_PROVIDER_REQUIRED', 'Ordinals provider must be configured to inscribe data on Bitcoin. ' +
|
|
81
|
+
'Please provide an ordinalsProvider in your SDK configuration. ' +
|
|
82
|
+
'For testing, use: import { OrdMockProvider } from \'@originals/sdk\';');
|
|
83
|
+
}
|
|
84
|
+
if (typeof this.ord.createInscription !== 'function') {
|
|
85
|
+
throw new StructuredError('ORD_PROVIDER_UNSUPPORTED', 'Configured ordinals provider does not support inscription creation');
|
|
86
|
+
}
|
|
87
|
+
const creation = await this.ord.createInscription({ data, contentType, feeRate: effectiveFeeRate });
|
|
88
|
+
const txid = creation.txid ?? creation.revealTxId;
|
|
89
|
+
if (!creation.inscriptionId || !txid) {
|
|
90
|
+
throw new StructuredError('ORD_PROVIDER_INVALID_RESPONSE', 'Ordinals provider did not return a valid inscription identifier or transaction id');
|
|
91
|
+
}
|
|
92
|
+
let satoshi = creation.satoshi ?? '';
|
|
93
|
+
if (!satoshi) {
|
|
94
|
+
satoshi = (await this.getSatoshiFromInscription(creation.inscriptionId)) ?? '';
|
|
95
|
+
}
|
|
96
|
+
// Validate satoshi before using it
|
|
97
|
+
if (satoshi) {
|
|
98
|
+
const validation = validateSatoshiNumber(satoshi);
|
|
99
|
+
if (!validation.valid) {
|
|
100
|
+
throw new StructuredError('INVALID_SATOSHI', `Ordinals provider returned invalid satoshi identifier: ${validation.error}`);
|
|
101
|
+
}
|
|
102
|
+
}
|
|
103
|
+
let recordedFeeRate;
|
|
104
|
+
if (this.feeOracle) {
|
|
105
|
+
recordedFeeRate = effectiveFeeRate;
|
|
106
|
+
}
|
|
107
|
+
else if (typeof feeRate === 'number' && Number.isFinite(feeRate) && feeRate > 0) {
|
|
108
|
+
recordedFeeRate = feeRate;
|
|
109
|
+
}
|
|
110
|
+
else {
|
|
111
|
+
recordedFeeRate = creation.feeRate ?? effectiveFeeRate;
|
|
112
|
+
}
|
|
113
|
+
const inscription = {
|
|
114
|
+
satoshi,
|
|
115
|
+
inscriptionId: creation.inscriptionId,
|
|
116
|
+
content: creation.content ?? data,
|
|
117
|
+
contentType: creation.contentType ?? contentType,
|
|
118
|
+
txid,
|
|
119
|
+
vout: typeof creation.vout === 'number' ? creation.vout : 0,
|
|
120
|
+
blockHeight: creation.blockHeight,
|
|
121
|
+
revealTxId: creation.revealTxId,
|
|
122
|
+
commitTxId: creation.commitTxId,
|
|
123
|
+
feeRate: recordedFeeRate
|
|
124
|
+
};
|
|
125
|
+
return inscription;
|
|
126
|
+
}
|
|
127
|
+
async trackInscription(inscriptionId) {
|
|
128
|
+
if (this.ord) {
|
|
129
|
+
const info = await this.ord.getInscriptionById(inscriptionId);
|
|
130
|
+
if (!info)
|
|
131
|
+
return null;
|
|
132
|
+
return {
|
|
133
|
+
satoshi: info.satoshi ?? '',
|
|
134
|
+
inscriptionId: info.inscriptionId,
|
|
135
|
+
content: info.content,
|
|
136
|
+
contentType: info.contentType,
|
|
137
|
+
txid: info.txid,
|
|
138
|
+
vout: info.vout,
|
|
139
|
+
blockHeight: info.blockHeight
|
|
140
|
+
};
|
|
141
|
+
}
|
|
142
|
+
return null;
|
|
143
|
+
}
|
|
144
|
+
async transferInscription(inscription, toAddress) {
|
|
145
|
+
// Input validation
|
|
146
|
+
if (!inscription || typeof inscription !== 'object') {
|
|
147
|
+
throw new StructuredError('INVALID_INPUT', 'Inscription must be a valid OrdinalsInscription object');
|
|
148
|
+
}
|
|
149
|
+
if (!inscription.inscriptionId || typeof inscription.inscriptionId !== 'string') {
|
|
150
|
+
throw new StructuredError('INVALID_INPUT', 'Inscription must have a valid inscriptionId');
|
|
151
|
+
}
|
|
152
|
+
if (!toAddress || typeof toAddress !== 'string') {
|
|
153
|
+
throw new StructuredError('INVALID_INPUT', 'Destination address must be a non-empty string');
|
|
154
|
+
}
|
|
155
|
+
// Validate Bitcoin address format and checksum
|
|
156
|
+
try {
|
|
157
|
+
validateBitcoinAddress(toAddress, this.config.network);
|
|
158
|
+
}
|
|
159
|
+
catch (error) {
|
|
160
|
+
const message = error instanceof Error ? error.message : 'Invalid Bitcoin address';
|
|
161
|
+
throw new StructuredError('INVALID_ADDRESS', message);
|
|
162
|
+
}
|
|
163
|
+
const effectiveFeeRate = await this.resolveFeeRate(1);
|
|
164
|
+
if (!this.ord) {
|
|
165
|
+
throw new StructuredError('ORD_PROVIDER_REQUIRED', 'Ordinals provider must be configured to transfer inscriptions on Bitcoin. ' +
|
|
166
|
+
'Please provide an ordinalsProvider in your SDK configuration. ' +
|
|
167
|
+
'For testing, use: import { OrdMockProvider } from \'@originals/sdk\';');
|
|
168
|
+
}
|
|
169
|
+
if (typeof this.ord.transferInscription !== 'function') {
|
|
170
|
+
throw new StructuredError('ORD_PROVIDER_UNSUPPORTED', 'Configured ordinals provider does not support inscription transfers');
|
|
171
|
+
}
|
|
172
|
+
const response = await this.ord.transferInscription(inscription.inscriptionId, toAddress, {
|
|
173
|
+
feeRate: effectiveFeeRate
|
|
174
|
+
});
|
|
175
|
+
if (!response || !response.txid) {
|
|
176
|
+
throw new StructuredError('ORD_PROVIDER_INVALID_RESPONSE', 'Ordinals provider did not return a valid transfer transaction');
|
|
177
|
+
}
|
|
178
|
+
if (response.satoshi) {
|
|
179
|
+
inscription.satoshi = response.satoshi;
|
|
180
|
+
}
|
|
181
|
+
return {
|
|
182
|
+
txid: response.txid,
|
|
183
|
+
vin: response.vin ?? [{ txid: inscription.txid, vout: inscription.vout }],
|
|
184
|
+
vout: response.vout?.length
|
|
185
|
+
? response.vout
|
|
186
|
+
: [{ value: DUST_LIMIT_SATS, scriptPubKey: 'script', address: toAddress }],
|
|
187
|
+
fee: response.fee,
|
|
188
|
+
blockHeight: response.blockHeight,
|
|
189
|
+
confirmations: response.confirmations
|
|
190
|
+
};
|
|
191
|
+
}
|
|
192
|
+
async preventFrontRunning(satoshi) {
|
|
193
|
+
if (!satoshi)
|
|
194
|
+
throw new StructuredError('SATOSHI_REQUIRED', 'Satoshi identifier is required');
|
|
195
|
+
// Naive implementation: check for multiple inscriptions on same satoshi via provider
|
|
196
|
+
if (this.ord) {
|
|
197
|
+
const list = await this.ord.getInscriptionsBySatoshi(satoshi);
|
|
198
|
+
return list.length <= 1;
|
|
199
|
+
}
|
|
200
|
+
return true;
|
|
201
|
+
}
|
|
202
|
+
async getSatoshiFromInscription(inscriptionId) {
|
|
203
|
+
if (this.ord) {
|
|
204
|
+
const info = await this.ord.getInscriptionById(inscriptionId);
|
|
205
|
+
const satoshi = info?.satoshi;
|
|
206
|
+
// Validate satoshi before returning
|
|
207
|
+
if (satoshi) {
|
|
208
|
+
const validation = validateSatoshiNumber(satoshi);
|
|
209
|
+
if (!validation.valid) {
|
|
210
|
+
// Return null if validation fails (don't return empty or invalid string)
|
|
211
|
+
return null;
|
|
212
|
+
}
|
|
213
|
+
return satoshi;
|
|
214
|
+
}
|
|
215
|
+
return null;
|
|
216
|
+
}
|
|
217
|
+
return null;
|
|
218
|
+
}
|
|
219
|
+
async validateBTCODID(didId) {
|
|
220
|
+
// Validate that a did:btco DID exists on Bitcoin
|
|
221
|
+
const satoshi = this.extractSatoshiFromBTCODID(didId);
|
|
222
|
+
if (!satoshi)
|
|
223
|
+
return false;
|
|
224
|
+
// Validate the extracted satoshi number
|
|
225
|
+
const validation = validateSatoshiNumber(satoshi);
|
|
226
|
+
if (!validation.valid)
|
|
227
|
+
return false;
|
|
228
|
+
if (!this.ord)
|
|
229
|
+
return false;
|
|
230
|
+
const inscriptions = await this.ord.getInscriptionsBySatoshi(satoshi);
|
|
231
|
+
return inscriptions.length > 0;
|
|
232
|
+
}
|
|
233
|
+
extractSatoshiFromBTCODID(didId) {
|
|
234
|
+
// Extract satoshi identifier from did:btco DID
|
|
235
|
+
if (!didId.startsWith('did:btco:'))
|
|
236
|
+
return null;
|
|
237
|
+
const parts = didId.split(':');
|
|
238
|
+
let satoshi = null;
|
|
239
|
+
// Handle different network prefixes:
|
|
240
|
+
// did:btco:123456 (mainnet) - 3 parts
|
|
241
|
+
// did:btco:test:123456 or did:btco:sig:123456 - 4 parts
|
|
242
|
+
if (parts.length === 3) {
|
|
243
|
+
satoshi = parts[2];
|
|
244
|
+
}
|
|
245
|
+
else if (parts.length === 4) {
|
|
246
|
+
// Validate network prefix - only 'test' and 'sig' are allowed
|
|
247
|
+
const network = parts[2];
|
|
248
|
+
if (network !== 'test' && network !== 'sig') {
|
|
249
|
+
return null;
|
|
250
|
+
}
|
|
251
|
+
satoshi = parts[3];
|
|
252
|
+
}
|
|
253
|
+
// Validate the extracted satoshi format
|
|
254
|
+
if (satoshi) {
|
|
255
|
+
const validation = validateSatoshiNumber(satoshi);
|
|
256
|
+
if (!validation.valid) {
|
|
257
|
+
return null;
|
|
258
|
+
}
|
|
259
|
+
}
|
|
260
|
+
return satoshi;
|
|
261
|
+
}
|
|
262
|
+
}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
export interface TransactionStatus {
|
|
2
|
+
confirmed: boolean;
|
|
3
|
+
confirmations?: number;
|
|
4
|
+
}
|
|
5
|
+
export interface Broadcaster {
|
|
6
|
+
(txHex: string): Promise<string>;
|
|
7
|
+
}
|
|
8
|
+
export interface StatusProvider {
|
|
9
|
+
(txid: string): Promise<TransactionStatus>;
|
|
10
|
+
}
|
|
11
|
+
export interface BroadcastOptions {
|
|
12
|
+
pollIntervalMs?: number;
|
|
13
|
+
maxAttempts?: number;
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
* Broadcast client with idempotency and confirmation polling.
|
|
17
|
+
* Designed to be predictable and simple, honoring behavior expected by the
|
|
18
|
+
* ordinalsplus legacy components which are finicky about retries.
|
|
19
|
+
*/
|
|
20
|
+
export declare class BroadcastClient {
|
|
21
|
+
private readonly broadcaster;
|
|
22
|
+
private readonly statusProvider;
|
|
23
|
+
private inflight;
|
|
24
|
+
constructor(broadcaster: Broadcaster, statusProvider: StatusProvider);
|
|
25
|
+
broadcastIdempotent(txidKey: string, create: () => Promise<string>): Promise<string>;
|
|
26
|
+
broadcastAndConfirm(txHex: string, options?: BroadcastOptions): Promise<{
|
|
27
|
+
txid: string;
|
|
28
|
+
confirmations: number;
|
|
29
|
+
}>;
|
|
30
|
+
}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Broadcast client with idempotency and confirmation polling.
|
|
3
|
+
* Designed to be predictable and simple, honoring behavior expected by the
|
|
4
|
+
* ordinalsplus legacy components which are finicky about retries.
|
|
5
|
+
*/
|
|
6
|
+
export class BroadcastClient {
|
|
7
|
+
constructor(broadcaster, statusProvider) {
|
|
8
|
+
this.broadcaster = broadcaster;
|
|
9
|
+
this.statusProvider = statusProvider;
|
|
10
|
+
this.inflight = new Map();
|
|
11
|
+
}
|
|
12
|
+
broadcastIdempotent(txidKey, create) {
|
|
13
|
+
if (this.inflight.has(txidKey))
|
|
14
|
+
return this.inflight.get(txidKey);
|
|
15
|
+
const p = (async () => create())();
|
|
16
|
+
this.inflight.set(txidKey, p);
|
|
17
|
+
return p.finally(() => this.inflight.delete(txidKey));
|
|
18
|
+
}
|
|
19
|
+
async broadcastAndConfirm(txHex, options = {}) {
|
|
20
|
+
const txid = await this.broadcastIdempotent(txHex, () => this.broadcaster(txHex));
|
|
21
|
+
const interval = Math.max(100, options.pollIntervalMs ?? 500);
|
|
22
|
+
const maxAttempts = Math.max(1, options.maxAttempts ?? 20);
|
|
23
|
+
let attempts = 0;
|
|
24
|
+
let last = { confirmed: false };
|
|
25
|
+
while (attempts < maxAttempts) {
|
|
26
|
+
last = await this.statusProvider(txid);
|
|
27
|
+
if (last.confirmed) {
|
|
28
|
+
return { txid, confirmations: last.confirmations ?? 1 };
|
|
29
|
+
}
|
|
30
|
+
await new Promise(r => setTimeout(r, interval));
|
|
31
|
+
attempts++;
|
|
32
|
+
}
|
|
33
|
+
return { txid, confirmations: last.confirmations ?? 0 };
|
|
34
|
+
}
|
|
35
|
+
}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import { OrdinalsInscription, BitcoinTransaction } from '../types';
|
|
2
|
+
export declare class OrdinalsClient {
|
|
3
|
+
private rpcUrl;
|
|
4
|
+
private network;
|
|
5
|
+
constructor(rpcUrl: string, network: 'mainnet' | 'regtest' | 'signet');
|
|
6
|
+
getInscriptionById(id: string): Promise<OrdinalsInscription | null>;
|
|
7
|
+
getInscriptionsBySatoshi(satoshi: string): Promise<OrdinalsInscription[]>;
|
|
8
|
+
broadcastTransaction(tx: BitcoinTransaction): Promise<string>;
|
|
9
|
+
getTransactionStatus(txid: string): Promise<{
|
|
10
|
+
confirmed: boolean;
|
|
11
|
+
blockHeight?: number;
|
|
12
|
+
confirmations?: number;
|
|
13
|
+
}>;
|
|
14
|
+
estimateFee(blocks?: number): Promise<number>;
|
|
15
|
+
getSatInfo(satoshi: string): Promise<{
|
|
16
|
+
inscription_ids: string[];
|
|
17
|
+
}>;
|
|
18
|
+
resolveInscription(identifier: string): Promise<OrdinalsInscription | null>;
|
|
19
|
+
getMetadata(inscriptionId: string): Promise<Record<string, unknown> | null>;
|
|
20
|
+
private fetchJson;
|
|
21
|
+
}
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
import { decode as decodeCbor } from '../utils/cbor';
|
|
2
|
+
import { hexToBytes } from '../utils/encoding';
|
|
3
|
+
export class OrdinalsClient {
|
|
4
|
+
constructor(rpcUrl, network) {
|
|
5
|
+
this.rpcUrl = rpcUrl;
|
|
6
|
+
this.network = network;
|
|
7
|
+
}
|
|
8
|
+
async getInscriptionById(id) {
|
|
9
|
+
if (!id)
|
|
10
|
+
return null;
|
|
11
|
+
return this.resolveInscription(id);
|
|
12
|
+
}
|
|
13
|
+
async getInscriptionsBySatoshi(satoshi) {
|
|
14
|
+
const info = await this.getSatInfo(satoshi);
|
|
15
|
+
if (!info.inscription_ids.length)
|
|
16
|
+
return [];
|
|
17
|
+
const inscriptions = await Promise.all(info.inscription_ids.map(id => this.resolveInscription(id)));
|
|
18
|
+
return inscriptions.filter((x) => x !== null);
|
|
19
|
+
}
|
|
20
|
+
async broadcastTransaction(tx) {
|
|
21
|
+
return tx.txid || 'txid';
|
|
22
|
+
}
|
|
23
|
+
async getTransactionStatus(txid) {
|
|
24
|
+
return { confirmed: false };
|
|
25
|
+
}
|
|
26
|
+
async estimateFee(blocks = 1) {
|
|
27
|
+
return Math.max(1, blocks) * 10;
|
|
28
|
+
}
|
|
29
|
+
// Added provider-like helper methods commonly expected by higher-level resolvers
|
|
30
|
+
// Minimal placeholder implementations suitable for unit testing
|
|
31
|
+
async getSatInfo(satoshi) {
|
|
32
|
+
const data = await this.fetchJson(`/sat/${satoshi}`);
|
|
33
|
+
if (!data)
|
|
34
|
+
return { inscription_ids: [] };
|
|
35
|
+
// Support both {inscription_ids: []} and {data: {inscription_ids: []}} shapes via fetchJson
|
|
36
|
+
const inscriptionIds = Array.isArray(data.inscription_ids) ? data.inscription_ids : [];
|
|
37
|
+
return { inscription_ids: inscriptionIds };
|
|
38
|
+
}
|
|
39
|
+
async resolveInscription(identifier) {
|
|
40
|
+
if (!identifier)
|
|
41
|
+
return null;
|
|
42
|
+
const info = await this.fetchJson(`/inscription/${identifier}`);
|
|
43
|
+
if (!info)
|
|
44
|
+
return null;
|
|
45
|
+
// Fetch content bytes
|
|
46
|
+
const contentUrl = info.content_url || `${this.rpcUrl}/content/${identifier}`;
|
|
47
|
+
const contentRes = await fetch(contentUrl);
|
|
48
|
+
if (!contentRes.ok)
|
|
49
|
+
throw new Error(`Failed to fetch inscription content: ${contentRes.status}`);
|
|
50
|
+
const contentArrayBuf = await contentRes.arrayBuffer();
|
|
51
|
+
const content = Buffer.from(new Uint8Array(contentArrayBuf));
|
|
52
|
+
// owner_output may be 'txid:vout'
|
|
53
|
+
let txid = 'unknown';
|
|
54
|
+
let vout = 0;
|
|
55
|
+
if (typeof info.owner_output === 'string' && info.owner_output.includes(':')) {
|
|
56
|
+
const [tid, v] = info.owner_output.split(':');
|
|
57
|
+
txid = tid;
|
|
58
|
+
vout = Number(v) || 0;
|
|
59
|
+
}
|
|
60
|
+
// sat number provided as number or string
|
|
61
|
+
const satoshi = String(info.sat ?? '');
|
|
62
|
+
const inscription = {
|
|
63
|
+
satoshi,
|
|
64
|
+
inscriptionId: info.inscription_id || identifier,
|
|
65
|
+
content,
|
|
66
|
+
contentType: info.content_type || 'application/octet-stream',
|
|
67
|
+
txid,
|
|
68
|
+
vout,
|
|
69
|
+
blockHeight: info.block_height
|
|
70
|
+
};
|
|
71
|
+
return inscription;
|
|
72
|
+
}
|
|
73
|
+
async getMetadata(inscriptionId) {
|
|
74
|
+
if (!inscriptionId)
|
|
75
|
+
return null;
|
|
76
|
+
const base = this.rpcUrl.replace(/\/$/, '');
|
|
77
|
+
const res = await fetch(`${base}/r/metadata/${inscriptionId}`, { headers: { 'Accept': 'application/json' } });
|
|
78
|
+
if (!res.ok) {
|
|
79
|
+
return null;
|
|
80
|
+
}
|
|
81
|
+
let text = (await res.text()).trim();
|
|
82
|
+
if (text.startsWith('"') && text.endsWith('"')) {
|
|
83
|
+
try {
|
|
84
|
+
text = JSON.parse(text);
|
|
85
|
+
}
|
|
86
|
+
catch (_) { }
|
|
87
|
+
}
|
|
88
|
+
try {
|
|
89
|
+
const bytes = hexToBytes(text);
|
|
90
|
+
return decodeCbor(bytes);
|
|
91
|
+
}
|
|
92
|
+
catch (_) {
|
|
93
|
+
return null;
|
|
94
|
+
}
|
|
95
|
+
}
|
|
96
|
+
async fetchJson(path) {
|
|
97
|
+
const url = `${this.rpcUrl.replace(/\/$/, '')}${path}`;
|
|
98
|
+
const res = await fetch(url, { headers: { 'Accept': 'application/json' } });
|
|
99
|
+
if (!res.ok)
|
|
100
|
+
return null;
|
|
101
|
+
const body = await res.json();
|
|
102
|
+
// Accept { data: T } or T
|
|
103
|
+
return (body && typeof body === 'object' && 'data' in body) ? body.data : body;
|
|
104
|
+
}
|
|
105
|
+
}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import type { Utxo } from '../types/bitcoin';
|
|
2
|
+
export interface PsbtOutput {
|
|
3
|
+
address: string;
|
|
4
|
+
value: number;
|
|
5
|
+
}
|
|
6
|
+
export interface BuildPsbtParams {
|
|
7
|
+
utxos: Utxo[];
|
|
8
|
+
outputs: PsbtOutput[];
|
|
9
|
+
changeAddress: string;
|
|
10
|
+
feeRate: number;
|
|
11
|
+
network: 'mainnet' | 'testnet' | 'regtest' | 'signet';
|
|
12
|
+
dustLimit?: number;
|
|
13
|
+
}
|
|
14
|
+
export interface BuildPsbtResult {
|
|
15
|
+
psbtBase64: string;
|
|
16
|
+
selectedUtxos: Utxo[];
|
|
17
|
+
fee: number;
|
|
18
|
+
changeOutput?: PsbtOutput;
|
|
19
|
+
}
|
|
20
|
+
export declare class PSBTBuilder {
|
|
21
|
+
private readonly dustLimit;
|
|
22
|
+
constructor(dustLimit?: number);
|
|
23
|
+
build(params: BuildPsbtParams): BuildPsbtResult;
|
|
24
|
+
}
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
function estimateVBytes(inputs, outputs) {
|
|
2
|
+
const overhead = 10; // base tx overhead
|
|
3
|
+
const inSize = 68; // rough P2WPKH/any-segwit input size
|
|
4
|
+
const outSize = 31; // P2WPKH output size
|
|
5
|
+
return Math.ceil(overhead + inputs * inSize + outputs * outSize);
|
|
6
|
+
}
|
|
7
|
+
export class PSBTBuilder {
|
|
8
|
+
constructor(dustLimit = 546) {
|
|
9
|
+
this.dustLimit = dustLimit;
|
|
10
|
+
}
|
|
11
|
+
build(params) {
|
|
12
|
+
const { utxos, outputs, changeAddress, feeRate } = params;
|
|
13
|
+
if (!utxos || utxos.length === 0)
|
|
14
|
+
throw new Error('No UTXOs');
|
|
15
|
+
if (!outputs || outputs.length === 0)
|
|
16
|
+
throw new Error('No outputs');
|
|
17
|
+
// Sort UTXOs ascending by value for simple greedy selection
|
|
18
|
+
const sorted = [...utxos].sort((a, b) => a.value - b.value);
|
|
19
|
+
// Start with smallest set to cover target + estimated fee; refine iteratively
|
|
20
|
+
const targetValue = outputs.reduce((s, o) => s + o.value, 0);
|
|
21
|
+
let selected = [];
|
|
22
|
+
let total = 0;
|
|
23
|
+
const pick = () => {
|
|
24
|
+
selected = [];
|
|
25
|
+
total = 0;
|
|
26
|
+
for (const u of sorted) {
|
|
27
|
+
selected.push(u);
|
|
28
|
+
total += u.value;
|
|
29
|
+
const vbytes = estimateVBytes(selected.length, outputs.length + 1); // +1 potential change
|
|
30
|
+
const fee = Math.ceil(vbytes * feeRate);
|
|
31
|
+
if (total >= targetValue + fee)
|
|
32
|
+
break;
|
|
33
|
+
}
|
|
34
|
+
if (total < targetValue)
|
|
35
|
+
throw new Error('Insufficient funds');
|
|
36
|
+
};
|
|
37
|
+
pick();
|
|
38
|
+
const initialVBytes = estimateVBytes(selected.length, outputs.length + 1);
|
|
39
|
+
let fee = Math.ceil(initialVBytes * feeRate);
|
|
40
|
+
let change = total - targetValue - fee;
|
|
41
|
+
let includeChange = change >= this.dustLimit;
|
|
42
|
+
// Re-estimate once we know whether change is included
|
|
43
|
+
const finalVBytes = estimateVBytes(selected.length, outputs.length + (includeChange ? 1 : 0));
|
|
44
|
+
fee = Math.ceil(finalVBytes * feeRate);
|
|
45
|
+
change = total - targetValue - fee;
|
|
46
|
+
includeChange = change >= this.dustLimit;
|
|
47
|
+
let changeOutput;
|
|
48
|
+
if (!includeChange) {
|
|
49
|
+
// Add dust to fee
|
|
50
|
+
fee = total - targetValue;
|
|
51
|
+
}
|
|
52
|
+
else {
|
|
53
|
+
changeOutput = { address: changeAddress, value: change };
|
|
54
|
+
}
|
|
55
|
+
// Construct a minimal PSBT-like payload for dry-run/testing. We intentionally avoid
|
|
56
|
+
// bringing heavy bitcoin libraries here; this builder focuses on deterministic
|
|
57
|
+
// selection, fee estimation, and change handling.
|
|
58
|
+
const payload = {
|
|
59
|
+
version: 0,
|
|
60
|
+
inputs: selected.map(u => ({ txid: u.txid, vout: u.vout })),
|
|
61
|
+
outputs: [
|
|
62
|
+
...outputs.map(o => ({ address: o.address, value: o.value })),
|
|
63
|
+
...(changeOutput ? [changeOutput] : [])
|
|
64
|
+
],
|
|
65
|
+
fee
|
|
66
|
+
};
|
|
67
|
+
// Base64 encode via Node when available; fallback to btoa if present
|
|
68
|
+
const json = JSON.stringify(payload);
|
|
69
|
+
let psbtBase64;
|
|
70
|
+
try {
|
|
71
|
+
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
72
|
+
const B = global.Buffer;
|
|
73
|
+
psbtBase64 = B ? B.from(json, 'utf8').toString('base64') : global.btoa(json);
|
|
74
|
+
}
|
|
75
|
+
catch {
|
|
76
|
+
psbtBase64 = `psbt:${json}`;
|
|
77
|
+
}
|
|
78
|
+
return { psbtBase64, selectedUtxos: selected, fee, changeOutput };
|
|
79
|
+
}
|
|
80
|
+
}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Bitcoin Transaction Fee Calculation
|
|
3
|
+
*
|
|
4
|
+
* Utilities for calculating transaction fees based on size and fee rate.
|
|
5
|
+
* Ported from legacy ordinalsplus transaction infrastructure.
|
|
6
|
+
*/
|
|
7
|
+
/**
|
|
8
|
+
* Calculate transaction fee based on vbytes and fee rate, ensuring minimum relay fee.
|
|
9
|
+
*
|
|
10
|
+
* @param vbytes - The virtual size of the transaction.
|
|
11
|
+
* @param feeRate - The desired fee rate in sats/vbyte.
|
|
12
|
+
* @returns The calculated fee in satoshis (bigint).
|
|
13
|
+
*/
|
|
14
|
+
export declare const calculateFee: (vbytes: number, feeRate: number) => bigint;
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Bitcoin Transaction Fee Calculation
|
|
3
|
+
*
|
|
4
|
+
* Utilities for calculating transaction fees based on size and fee rate.
|
|
5
|
+
* Ported from legacy ordinalsplus transaction infrastructure.
|
|
6
|
+
*/
|
|
7
|
+
// Define minimum relay fee rate (sats/vB)
|
|
8
|
+
// Increased slightly from Bitcoin Core default of 1.0 for safety
|
|
9
|
+
const MIN_RELAY_FEE_RATE = 1.1;
|
|
10
|
+
/**
|
|
11
|
+
* Calculate transaction fee based on vbytes and fee rate, ensuring minimum relay fee.
|
|
12
|
+
*
|
|
13
|
+
* @param vbytes - The virtual size of the transaction.
|
|
14
|
+
* @param feeRate - The desired fee rate in sats/vbyte.
|
|
15
|
+
* @returns The calculated fee in satoshis (bigint).
|
|
16
|
+
*/
|
|
17
|
+
export const calculateFee = (vbytes, feeRate) => {
|
|
18
|
+
// Ensure inputs are valid numbers
|
|
19
|
+
if (isNaN(vbytes) || vbytes <= 0 || isNaN(feeRate) || feeRate <= 0) {
|
|
20
|
+
console.warn(`[calculateFee] Invalid input: vbytes=${vbytes}, feeRate=${feeRate}. Returning 0.`);
|
|
21
|
+
return 0n;
|
|
22
|
+
}
|
|
23
|
+
// Calculate fee based on the desired fee rate
|
|
24
|
+
const calculatedFee = Math.ceil(vbytes * feeRate);
|
|
25
|
+
// Calculate the minimum fee required for relay
|
|
26
|
+
const minimumFee = Math.ceil(vbytes * MIN_RELAY_FEE_RATE);
|
|
27
|
+
// Return the higher of the calculated fee or minimum relay fee
|
|
28
|
+
// Ensure the result is a positive integer (minimum 1 sat)
|
|
29
|
+
const finalFee = BigInt(Math.max(1, calculatedFee, minimumFee));
|
|
30
|
+
return finalFee;
|
|
31
|
+
};
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
import type { ResourceProvider, LinkedResource, ResourceInfo, Inscription, ResourceCrawlOptions } from './types';
|
|
2
|
+
export interface OrdNodeProviderOptions {
|
|
3
|
+
nodeUrl: string;
|
|
4
|
+
timeout?: number;
|
|
5
|
+
network?: 'mainnet' | 'testnet' | 'signet';
|
|
6
|
+
}
|
|
7
|
+
export declare class OrdNodeProvider implements ResourceProvider {
|
|
8
|
+
private readonly nodeUrl;
|
|
9
|
+
private readonly timeout;
|
|
10
|
+
private readonly network;
|
|
11
|
+
constructor(options: OrdNodeProviderOptions);
|
|
12
|
+
resolve(resourceId: string): Promise<LinkedResource>;
|
|
13
|
+
resolveInscription(inscriptionId: string): Promise<Inscription>;
|
|
14
|
+
resolveInfo(resourceId: string): Promise<ResourceInfo>;
|
|
15
|
+
resolveCollection(did: string, _options?: {
|
|
16
|
+
type?: string;
|
|
17
|
+
limit?: number;
|
|
18
|
+
offset?: number;
|
|
19
|
+
}): Promise<LinkedResource[]>;
|
|
20
|
+
getSatInfo(_satNumber: string): Promise<{
|
|
21
|
+
inscription_ids: string[];
|
|
22
|
+
}>;
|
|
23
|
+
getMetadata(_inscriptionId: string): Promise<any>;
|
|
24
|
+
getAllResources(_options?: ResourceCrawlOptions): AsyncGenerator<LinkedResource[]>;
|
|
25
|
+
getAllResourcesChronological(_options?: ResourceCrawlOptions): AsyncGenerator<LinkedResource[]>;
|
|
26
|
+
getInscriptionLocationsByAddress(_address: string): Promise<{
|
|
27
|
+
id: string;
|
|
28
|
+
location: string;
|
|
29
|
+
}[]>;
|
|
30
|
+
getInscriptionByNumber(_inscriptionNumber: number): Promise<Inscription>;
|
|
31
|
+
getAddressOutputs(_address: string): Promise<string[]>;
|
|
32
|
+
getOutputDetails(_outpoint: string): Promise<{
|
|
33
|
+
value: number;
|
|
34
|
+
script_pubkey: string;
|
|
35
|
+
spent: boolean;
|
|
36
|
+
inscriptions: string[];
|
|
37
|
+
}>;
|
|
38
|
+
}
|