@atomiqlabs/sdk 8.9.1 → 8.9.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +201 -201
- package/README.md +1760 -1760
- package/api/index.d.ts +1 -1
- package/api/index.js +3 -3
- package/dist/ApiList.d.ts +37 -37
- package/dist/ApiList.js +30 -30
- package/dist/SmartChainAssets.d.ts +181 -181
- package/dist/SmartChainAssets.js +181 -181
- package/dist/api/ApiEndpoints.d.ts +393 -393
- package/dist/api/ApiEndpoints.js +2 -2
- package/dist/api/ApiParser.d.ts +10 -10
- package/dist/api/ApiParser.js +134 -134
- package/dist/api/ApiTypes.d.ts +157 -157
- package/dist/api/ApiTypes.js +75 -75
- package/dist/api/SerializedAction.d.ts +40 -40
- package/dist/api/SerializedAction.js +59 -59
- package/dist/api/SwapperApi.d.ts +50 -50
- package/dist/api/SwapperApi.js +431 -431
- package/dist/api/index.d.ts +5 -5
- package/dist/api/index.js +24 -24
- package/dist/bitcoin/coinselect2/accumulative.d.ts +7 -7
- package/dist/bitcoin/coinselect2/accumulative.js +52 -52
- package/dist/bitcoin/coinselect2/blackjack.d.ts +7 -7
- package/dist/bitcoin/coinselect2/blackjack.js +38 -38
- package/dist/bitcoin/coinselect2/index.d.ts +20 -20
- package/dist/bitcoin/coinselect2/index.js +69 -69
- package/dist/bitcoin/coinselect2/utils.d.ts +82 -82
- package/dist/bitcoin/coinselect2/utils.js +158 -158
- package/dist/bitcoin/wallet/BitcoinWallet.d.ts +113 -113
- package/dist/bitcoin/wallet/BitcoinWallet.js +335 -335
- package/dist/bitcoin/wallet/IBitcoinWallet.d.ts +116 -116
- package/dist/bitcoin/wallet/IBitcoinWallet.js +21 -21
- package/dist/bitcoin/wallet/SingleAddressBitcoinWallet.d.ts +106 -106
- package/dist/bitcoin/wallet/SingleAddressBitcoinWallet.js +196 -196
- package/dist/enums/FeeType.d.ts +15 -15
- package/dist/enums/FeeType.js +19 -19
- package/dist/enums/SwapAmountType.d.ts +15 -15
- package/dist/enums/SwapAmountType.js +19 -19
- package/dist/enums/SwapDirection.d.ts +15 -15
- package/dist/enums/SwapDirection.js +19 -19
- package/dist/enums/SwapSide.d.ts +15 -15
- package/dist/enums/SwapSide.js +19 -19
- package/dist/enums/SwapType.d.ts +75 -75
- package/dist/enums/SwapType.js +79 -79
- package/dist/errors/IntermediaryError.d.ts +13 -13
- package/dist/errors/IntermediaryError.js +27 -27
- package/dist/errors/RequestError.d.ts +32 -32
- package/dist/errors/RequestError.js +54 -54
- package/dist/errors/UserError.d.ts +8 -8
- package/dist/errors/UserError.js +16 -16
- package/dist/events/UnifiedSwapEventListener.d.ts +24 -24
- package/dist/events/UnifiedSwapEventListener.js +138 -138
- package/dist/http/HttpUtils.d.ts +29 -29
- package/dist/http/HttpUtils.js +97 -97
- package/dist/http/paramcoders/IParamReader.d.ts +8 -8
- package/dist/http/paramcoders/IParamReader.js +2 -2
- package/dist/http/paramcoders/ParamDecoder.d.ts +44 -44
- package/dist/http/paramcoders/ParamDecoder.js +137 -137
- package/dist/http/paramcoders/ParamEncoder.d.ts +20 -20
- package/dist/http/paramcoders/ParamEncoder.js +36 -36
- package/dist/http/paramcoders/SchemaVerifier.d.ts +26 -26
- package/dist/http/paramcoders/SchemaVerifier.js +145 -145
- package/dist/http/paramcoders/client/ResponseParamDecoder.d.ts +11 -11
- package/dist/http/paramcoders/client/ResponseParamDecoder.js +57 -57
- package/dist/http/paramcoders/client/StreamParamEncoder.d.ts +13 -13
- package/dist/http/paramcoders/client/StreamParamEncoder.js +26 -26
- package/dist/http/paramcoders/client/StreamingFetchPromise.d.ts +17 -17
- package/dist/http/paramcoders/client/StreamingFetchPromise.js +175 -175
- package/dist/index.d.ts +86 -86
- package/dist/index.js +159 -159
- package/dist/intermediaries/Intermediary.d.ts +178 -178
- package/dist/intermediaries/Intermediary.js +166 -166
- package/dist/intermediaries/IntermediaryDiscovery.d.ts +216 -216
- package/dist/intermediaries/IntermediaryDiscovery.js +424 -424
- package/dist/intermediaries/apis/IntermediaryAPI.d.ts +607 -607
- package/dist/intermediaries/apis/IntermediaryAPI.js +764 -764
- package/dist/intermediaries/apis/TrustedIntermediaryAPI.d.ts +155 -155
- package/dist/intermediaries/apis/TrustedIntermediaryAPI.js +137 -137
- package/dist/intermediaries/auth/SignedKeyBasedAuth.d.ts +14 -14
- package/dist/intermediaries/auth/SignedKeyBasedAuth.js +68 -68
- package/dist/lnurl/LNURL.d.ts +102 -102
- package/dist/lnurl/LNURL.js +321 -321
- package/dist/prices/RedundantSwapPrice.d.ts +110 -110
- package/dist/prices/RedundantSwapPrice.js +222 -222
- package/dist/prices/SingleSwapPrice.d.ts +34 -34
- package/dist/prices/SingleSwapPrice.js +44 -44
- package/dist/prices/SwapPriceWithChain.d.ts +107 -107
- package/dist/prices/SwapPriceWithChain.js +128 -128
- package/dist/prices/abstract/ICachedSwapPrice.d.ts +28 -28
- package/dist/prices/abstract/ICachedSwapPrice.js +62 -62
- package/dist/prices/abstract/IPriceProvider.d.ts +81 -81
- package/dist/prices/abstract/IPriceProvider.js +74 -74
- package/dist/prices/abstract/ISwapPrice.d.ts +168 -168
- package/dist/prices/abstract/ISwapPrice.js +279 -279
- package/dist/prices/providers/BinancePriceProvider.d.ts +23 -23
- package/dist/prices/providers/BinancePriceProvider.js +30 -30
- package/dist/prices/providers/CoinGeckoPriceProvider.d.ts +23 -23
- package/dist/prices/providers/CoinGeckoPriceProvider.js +29 -29
- package/dist/prices/providers/CoinPaprikaPriceProvider.d.ts +25 -25
- package/dist/prices/providers/CoinPaprikaPriceProvider.js +29 -29
- package/dist/prices/providers/CustomPriceProvider.d.ts +24 -24
- package/dist/prices/providers/CustomPriceProvider.js +35 -35
- package/dist/prices/providers/KrakenPriceProvider.d.ts +38 -38
- package/dist/prices/providers/KrakenPriceProvider.js +45 -45
- package/dist/prices/providers/OKXPriceProvider.d.ts +34 -34
- package/dist/prices/providers/OKXPriceProvider.js +29 -29
- package/dist/prices/providers/abstract/ExchangePriceProvider.d.ts +17 -17
- package/dist/prices/providers/abstract/ExchangePriceProvider.js +21 -21
- package/dist/prices/providers/abstract/HttpPriceProvider.d.ts +7 -7
- package/dist/prices/providers/abstract/HttpPriceProvider.js +12 -12
- package/dist/storage/IUnifiedStorage.d.ts +127 -127
- package/dist/storage/IUnifiedStorage.js +2 -2
- package/dist/storage/UnifiedSwapStorage.d.ts +120 -120
- package/dist/storage/UnifiedSwapStorage.js +154 -154
- package/dist/storage-browser/IndexedDBUnifiedStorage.d.ts +63 -63
- package/dist/storage-browser/IndexedDBUnifiedStorage.js +298 -298
- package/dist/storage-browser/LocalStorageManager.d.ts +49 -49
- package/dist/storage-browser/LocalStorageManager.js +93 -93
- package/dist/swapper/Swapper.d.ts +765 -770
- package/dist/swapper/Swapper.js +1749 -1758
- package/dist/swapper/SwapperFactory.d.ts +135 -135
- package/dist/swapper/SwapperFactory.js +162 -162
- package/dist/swapper/SwapperUtils.d.ts +222 -222
- package/dist/swapper/SwapperUtils.js +519 -519
- package/dist/swapper/SwapperWithChain.d.ts +404 -404
- package/dist/swapper/SwapperWithChain.js +469 -469
- package/dist/swapper/SwapperWithSigner.d.ts +322 -322
- package/dist/swapper/SwapperWithSigner.js +318 -318
- package/dist/swaps/IAddressSwap.d.ts +22 -22
- package/dist/swaps/IAddressSwap.js +14 -14
- package/dist/swaps/IBTCWalletSwap.d.ts +73 -73
- package/dist/swaps/IBTCWalletSwap.js +18 -18
- package/dist/swaps/IClaimableSwap.d.ts +49 -49
- package/dist/swaps/IClaimableSwap.js +15 -15
- package/dist/swaps/IClaimableSwapWrapper.d.ts +15 -15
- package/dist/swaps/IClaimableSwapWrapper.js +2 -2
- package/dist/swaps/IRefundableSwap.d.ts +43 -43
- package/dist/swaps/IRefundableSwap.js +14 -14
- package/dist/swaps/ISwap.d.ts +453 -453
- package/dist/swaps/ISwap.js +371 -371
- package/dist/swaps/ISwapWithGasDrop.d.ts +21 -21
- package/dist/swaps/ISwapWithGasDrop.js +12 -12
- package/dist/swaps/ISwapWrapper.d.ts +295 -295
- package/dist/swaps/ISwapWrapper.js +373 -373
- package/dist/swaps/escrow_swaps/IEscrowSelfInitSwap.d.ts +98 -98
- package/dist/swaps/escrow_swaps/IEscrowSelfInitSwap.js +126 -126
- package/dist/swaps/escrow_swaps/IEscrowSwap.d.ts +139 -139
- package/dist/swaps/escrow_swaps/IEscrowSwap.js +172 -172
- package/dist/swaps/escrow_swaps/IEscrowSwapWrapper.d.ts +129 -129
- package/dist/swaps/escrow_swaps/IEscrowSwapWrapper.js +167 -167
- package/dist/swaps/escrow_swaps/frombtc/IFromBTCLNWrapper.d.ts +107 -107
- package/dist/swaps/escrow_swaps/frombtc/IFromBTCLNWrapper.js +130 -130
- package/dist/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.d.ts +162 -162
- package/dist/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.js +190 -190
- package/dist/swaps/escrow_swaps/frombtc/IFromBTCWrapper.d.ts +64 -64
- package/dist/swaps/escrow_swaps/frombtc/IFromBTCWrapper.js +82 -82
- package/dist/swaps/escrow_swaps/frombtc/ln/FromBTCLNSwap.d.ts +547 -547
- package/dist/swaps/escrow_swaps/frombtc/ln/FromBTCLNSwap.js +1419 -1419
- package/dist/swaps/escrow_swaps/frombtc/ln/FromBTCLNWrapper.d.ts +192 -192
- package/dist/swaps/escrow_swaps/frombtc/ln/FromBTCLNWrapper.js +432 -432
- package/dist/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoSwap.d.ts +650 -650
- package/dist/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoSwap.js +1577 -1577
- package/dist/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoWrapper.d.ts +237 -237
- package/dist/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoWrapper.js +525 -525
- package/dist/swaps/escrow_swaps/frombtc/onchain/FromBTCSwap.d.ts +491 -491
- package/dist/swaps/escrow_swaps/frombtc/onchain/FromBTCSwap.js +1463 -1463
- package/dist/swaps/escrow_swaps/frombtc/onchain/FromBTCWrapper.d.ts +204 -204
- package/dist/swaps/escrow_swaps/frombtc/onchain/FromBTCWrapper.js +406 -406
- package/dist/swaps/escrow_swaps/tobtc/IToBTCSwap.d.ts +446 -446
- package/dist/swaps/escrow_swaps/tobtc/IToBTCSwap.js +1097 -1097
- package/dist/swaps/escrow_swaps/tobtc/IToBTCWrapper.d.ts +68 -68
- package/dist/swaps/escrow_swaps/tobtc/IToBTCWrapper.js +117 -117
- package/dist/swaps/escrow_swaps/tobtc/ln/ToBTCLNSwap.d.ts +127 -127
- package/dist/swaps/escrow_swaps/tobtc/ln/ToBTCLNSwap.js +256 -256
- package/dist/swaps/escrow_swaps/tobtc/ln/ToBTCLNWrapper.d.ts +252 -252
- package/dist/swaps/escrow_swaps/tobtc/ln/ToBTCLNWrapper.js +535 -535
- package/dist/swaps/escrow_swaps/tobtc/onchain/ToBTCSwap.d.ts +73 -73
- package/dist/swaps/escrow_swaps/tobtc/onchain/ToBTCSwap.js +155 -155
- package/dist/swaps/escrow_swaps/tobtc/onchain/ToBTCWrapper.d.ts +134 -134
- package/dist/swaps/escrow_swaps/tobtc/onchain/ToBTCWrapper.js +286 -286
- package/dist/swaps/spv_swaps/SpvFromBTCSwap.d.ts +694 -694
- package/dist/swaps/spv_swaps/SpvFromBTCSwap.js +1687 -1687
- package/dist/swaps/spv_swaps/SpvFromBTCWrapper.d.ts +259 -259
- package/dist/swaps/spv_swaps/SpvFromBTCWrapper.js +947 -947
- package/dist/swaps/trusted/ln/LnForGasSwap.d.ts +302 -302
- package/dist/swaps/trusted/ln/LnForGasSwap.js +625 -625
- package/dist/swaps/trusted/ln/LnForGasWrapper.d.ts +40 -40
- package/dist/swaps/trusted/ln/LnForGasWrapper.js +82 -82
- package/dist/swaps/trusted/onchain/OnchainForGasSwap.d.ts +343 -343
- package/dist/swaps/trusted/onchain/OnchainForGasSwap.js +698 -698
- package/dist/swaps/trusted/onchain/OnchainForGasWrapper.d.ts +71 -71
- package/dist/swaps/trusted/onchain/OnchainForGasWrapper.js +93 -93
- package/dist/types/AmountData.d.ts +10 -10
- package/dist/types/AmountData.js +2 -2
- package/dist/types/CustomPriceFunction.d.ts +11 -11
- package/dist/types/CustomPriceFunction.js +2 -2
- package/dist/types/PriceInfoType.d.ts +28 -28
- package/dist/types/PriceInfoType.js +57 -57
- package/dist/types/SwapExecutionAction.d.ts +195 -195
- package/dist/types/SwapExecutionAction.js +106 -106
- package/dist/types/SwapExecutionStep.d.ts +144 -144
- package/dist/types/SwapExecutionStep.js +87 -87
- package/dist/types/SwapStateInfo.d.ts +5 -5
- package/dist/types/SwapStateInfo.js +2 -2
- package/dist/types/SwapWithSigner.d.ts +17 -17
- package/dist/types/SwapWithSigner.js +43 -43
- package/dist/types/Token.d.ts +99 -99
- package/dist/types/Token.js +76 -76
- package/dist/types/TokenAmount.d.ts +75 -75
- package/dist/types/TokenAmount.js +85 -85
- package/dist/types/fees/Fee.d.ts +50 -50
- package/dist/types/fees/Fee.js +2 -2
- package/dist/types/fees/FeeBreakdown.d.ts +11 -11
- package/dist/types/fees/FeeBreakdown.js +2 -2
- package/dist/types/fees/PercentagePPM.d.ts +17 -17
- package/dist/types/fees/PercentagePPM.js +18 -18
- package/dist/types/lnurl/LNURLPay.d.ts +61 -61
- package/dist/types/lnurl/LNURLPay.js +31 -31
- package/dist/types/lnurl/LNURLWithdraw.d.ts +48 -48
- package/dist/types/lnurl/LNURLWithdraw.js +27 -27
- package/dist/types/wallets/LightningInvoiceCreateService.d.ts +24 -24
- package/dist/types/wallets/LightningInvoiceCreateService.js +15 -15
- package/dist/types/wallets/MinimalBitcoinWalletInterface.d.ts +23 -23
- package/dist/types/wallets/MinimalBitcoinWalletInterface.js +2 -2
- package/dist/types/wallets/MinimalLightningNetworkWalletInterface.d.ts +9 -9
- package/dist/types/wallets/MinimalLightningNetworkWalletInterface.js +2 -2
- package/dist/utils/AutomaticClockDriftCorrection.d.ts +1 -1
- package/dist/utils/AutomaticClockDriftCorrection.js +70 -70
- package/dist/utils/BitcoinUtils.d.ts +18 -18
- package/dist/utils/BitcoinUtils.js +174 -174
- package/dist/utils/BitcoinWalletUtils.d.ts +7 -7
- package/dist/utils/BitcoinWalletUtils.js +14 -14
- package/dist/utils/Logger.d.ts +7 -7
- package/dist/utils/Logger.js +12 -12
- package/dist/utils/RetryUtils.d.ts +22 -22
- package/dist/utils/RetryUtils.js +67 -67
- package/dist/utils/SwapUtils.d.ts +88 -88
- package/dist/utils/SwapUtils.js +72 -72
- package/dist/utils/TimeoutUtils.d.ts +17 -17
- package/dist/utils/TimeoutUtils.js +55 -55
- package/dist/utils/TokenUtils.d.ts +19 -19
- package/dist/utils/TokenUtils.js +37 -37
- package/dist/utils/TypeUtils.d.ts +7 -7
- package/dist/utils/TypeUtils.js +2 -2
- package/dist/utils/Utils.d.ts +69 -69
- package/dist/utils/Utils.js +214 -214
- package/package.json +46 -46
- package/src/SmartChainAssets.ts +186 -186
- package/src/api/ApiEndpoints.ts +427 -427
- package/src/api/ApiParser.ts +138 -138
- package/src/api/ApiTypes.ts +229 -229
- package/src/api/SerializedAction.ts +97 -97
- package/src/api/SwapperApi.ts +545 -545
- package/src/api/index.ts +5 -5
- package/src/bitcoin/coinselect2/accumulative.ts +69 -69
- package/src/bitcoin/coinselect2/blackjack.ts +50 -50
- package/src/bitcoin/coinselect2/index.ts +93 -93
- package/src/bitcoin/coinselect2/utils.ts +236 -236
- package/src/bitcoin/wallet/BitcoinWallet.ts +439 -439
- package/src/bitcoin/wallet/IBitcoinWallet.ts +140 -140
- package/src/bitcoin/wallet/SingleAddressBitcoinWallet.ts +225 -225
- package/src/enums/FeeType.ts +15 -15
- package/src/enums/SwapAmountType.ts +16 -16
- package/src/enums/SwapDirection.ts +15 -15
- package/src/enums/SwapSide.ts +16 -16
- package/src/enums/SwapType.ts +75 -75
- package/src/errors/IntermediaryError.ts +28 -28
- package/src/errors/RequestError.ts +64 -64
- package/src/errors/UserError.ts +15 -15
- package/src/events/UnifiedSwapEventListener.ts +181 -181
- package/src/http/HttpUtils.ts +97 -97
- package/src/http/paramcoders/IParamReader.ts +9 -9
- package/src/http/paramcoders/ParamDecoder.ts +145 -145
- package/src/http/paramcoders/ParamEncoder.ts +40 -40
- package/src/http/paramcoders/SchemaVerifier.ts +153 -153
- package/src/http/paramcoders/client/ResponseParamDecoder.ts +57 -57
- package/src/http/paramcoders/client/StreamParamEncoder.ts +28 -28
- package/src/http/paramcoders/client/StreamingFetchPromise.ts +194 -194
- package/src/index.ts +141 -141
- package/src/intermediaries/Intermediary.ts +280 -280
- package/src/intermediaries/IntermediaryDiscovery.ts +548 -548
- package/src/intermediaries/apis/IntermediaryAPI.ts +1247 -1247
- package/src/intermediaries/auth/SignedKeyBasedAuth.ts +69 -69
- package/src/lnurl/LNURL.ts +402 -402
- package/src/prices/RedundantSwapPrice.ts +264 -264
- package/src/prices/SingleSwapPrice.ts +50 -50
- package/src/prices/SwapPriceWithChain.ts +194 -194
- package/src/prices/abstract/ICachedSwapPrice.ts +85 -85
- package/src/prices/abstract/IPriceProvider.ts +127 -127
- package/src/prices/abstract/ISwapPrice.ts +390 -390
- package/src/prices/providers/BinancePriceProvider.ts +48 -48
- package/src/prices/providers/CoinGeckoPriceProvider.ts +46 -46
- package/src/prices/providers/CoinPaprikaPriceProvider.ts +49 -49
- package/src/prices/providers/CustomPriceProvider.ts +40 -40
- package/src/prices/providers/KrakenPriceProvider.ts +83 -83
- package/src/prices/providers/OKXPriceProvider.ts +59 -59
- package/src/prices/providers/abstract/ExchangePriceProvider.ts +31 -31
- package/src/prices/providers/abstract/HttpPriceProvider.ts +14 -14
- package/src/storage/IUnifiedStorage.ts +136 -136
- package/src/storage/UnifiedSwapStorage.ts +175 -175
- package/src/storage-browser/IndexedDBUnifiedStorage.ts +350 -350
- package/src/storage-browser/LocalStorageManager.ts +106 -106
- package/src/swapper/Swapper.ts +2557 -2570
- package/src/swapper/SwapperFactory.ts +307 -307
- package/src/swapper/SwapperUtils.ts +610 -610
- package/src/swapper/SwapperWithChain.ts +707 -707
- package/src/swapper/SwapperWithSigner.ts +511 -511
- package/src/swaps/IAddressSwap.ts +30 -30
- package/src/swaps/IBTCWalletSwap.ts +92 -92
- package/src/swaps/IClaimableSwap.ts +65 -65
- package/src/swaps/IClaimableSwapWrapper.ts +17 -17
- package/src/swaps/IRefundableSwap.ts +58 -58
- package/src/swaps/ISwap.ts +775 -775
- package/src/swaps/ISwapWithGasDrop.ts +25 -25
- package/src/swaps/ISwapWrapper.ts +564 -564
- package/src/swaps/escrow_swaps/IEscrowSelfInitSwap.ts +217 -217
- package/src/swaps/escrow_swaps/IEscrowSwap.ts +271 -271
- package/src/swaps/escrow_swaps/IEscrowSwapWrapper.ts +284 -284
- package/src/swaps/escrow_swaps/frombtc/IFromBTCLNWrapper.ts +172 -172
- package/src/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.ts +300 -300
- package/src/swaps/escrow_swaps/frombtc/IFromBTCWrapper.ts +107 -107
- package/src/swaps/escrow_swaps/frombtc/ln/FromBTCLNSwap.ts +1670 -1671
- package/src/swaps/escrow_swaps/frombtc/ln/FromBTCLNWrapper.ts +603 -603
- package/src/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoSwap.ts +1883 -1883
- package/src/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoWrapper.ts +752 -752
- package/src/swaps/escrow_swaps/frombtc/onchain/FromBTCSwap.ts +1753 -1753
- package/src/swaps/escrow_swaps/frombtc/onchain/FromBTCWrapper.ts +612 -612
- package/src/swaps/escrow_swaps/tobtc/IToBTCSwap.ts +1327 -1327
- package/src/swaps/escrow_swaps/tobtc/IToBTCWrapper.ts +138 -138
- package/src/swaps/escrow_swaps/tobtc/ln/ToBTCLNSwap.ts +304 -304
- package/src/swaps/escrow_swaps/tobtc/ln/ToBTCLNWrapper.ts +787 -787
- package/src/swaps/escrow_swaps/tobtc/onchain/ToBTCSwap.ts +206 -206
- package/src/swaps/escrow_swaps/tobtc/onchain/ToBTCWrapper.ts +403 -403
- package/src/swaps/spv_swaps/SpvFromBTCSwap.ts +2148 -2148
- package/src/swaps/spv_swaps/SpvFromBTCWrapper.ts +1238 -1238
- package/src/swaps/trusted/ln/LnForGasSwap.ts +753 -753
- package/src/swaps/trusted/ln/LnForGasWrapper.ts +90 -90
- package/src/swaps/trusted/onchain/OnchainForGasSwap.ts +843 -843
- package/src/swaps/trusted/onchain/OnchainForGasWrapper.ts +133 -133
- package/src/types/AmountData.ts +9 -9
- package/src/types/CustomPriceFunction.ts +11 -11
- package/src/types/PriceInfoType.ts +66 -66
- package/src/types/SwapExecutionAction.ts +323 -323
- package/src/types/SwapExecutionStep.ts +224 -224
- package/src/types/SwapStateInfo.ts +6 -6
- package/src/types/SwapWithSigner.ts +61 -61
- package/src/types/Token.ts +163 -163
- package/src/types/TokenAmount.ts +167 -167
- package/src/types/fees/Fee.ts +56 -56
- package/src/types/fees/FeeBreakdown.ts +11 -11
- package/src/types/fees/PercentagePPM.ts +26 -26
- package/src/types/lnurl/LNURLPay.ts +79 -79
- package/src/types/lnurl/LNURLWithdraw.ts +61 -61
- package/src/types/wallets/LightningInvoiceCreateService.ts +30 -30
- package/src/types/wallets/MinimalBitcoinWalletInterface.ts +21 -21
- package/src/types/wallets/MinimalLightningNetworkWalletInterface.ts +9 -9
- package/src/utils/AutomaticClockDriftCorrection.ts +71 -71
- package/src/utils/BitcoinUtils.ts +164 -164
- package/src/utils/BitcoinWalletUtils.ts +15 -15
- package/src/utils/Logger.ts +14 -14
- package/src/utils/RetryUtils.ts +78 -78
- package/src/utils/SwapUtils.ts +99 -99
- package/src/utils/TimeoutUtils.ts +49 -49
- package/src/utils/TokenUtils.ts +33 -33
- package/src/utils/TypeUtils.ts +8 -8
- package/src/utils/Utils.ts +221 -221
package/src/api/ApiTypes.ts
CHANGED
|
@@ -1,229 +1,229 @@
|
|
|
1
|
-
import {BitcoinTokens, Token} from "../types/Token";
|
|
2
|
-
import {TokenAmount, toTokenAmount} from "../types/TokenAmount";
|
|
3
|
-
import {LNURLPay, LNURLPayParamsWithUrl} from "../types/lnurl/LNURLPay";
|
|
4
|
-
import {LNURLWithdraw, LNURLWithdrawParamsWithUrl} from "../types/lnurl/LNURLWithdraw";
|
|
5
|
-
import {parseApiInput} from "./ApiParser";
|
|
6
|
-
import {Swapper} from "../swapper/Swapper";
|
|
7
|
-
|
|
8
|
-
/**
|
|
9
|
-
* Unified amount type for all API responses
|
|
10
|
-
*
|
|
11
|
-
* @category API
|
|
12
|
-
*/
|
|
13
|
-
export type ApiAmount = {
|
|
14
|
-
/** Decimal format of the amount, e.g. "1.5" */
|
|
15
|
-
amount: string;
|
|
16
|
-
/** Raw base units as string, e.g. "1500000000000000000" */
|
|
17
|
-
rawAmount: string;
|
|
18
|
-
/** Token decimals, e.g. 18 */
|
|
19
|
-
decimals: number;
|
|
20
|
-
/** Token ticker, e.g. "STRK" */
|
|
21
|
-
symbol: string;
|
|
22
|
-
/** Chain identifier, e.g. "STARKNET", "BITCOIN", "LIGHTNING" */
|
|
23
|
-
chain: string;
|
|
24
|
-
}
|
|
25
|
-
|
|
26
|
-
/**
|
|
27
|
-
* Serializable token representation for API responses
|
|
28
|
-
*
|
|
29
|
-
* @category API
|
|
30
|
-
*/
|
|
31
|
-
export type ApiToken = {
|
|
32
|
-
/** Canonical token identifier accepted by the API, e.g. "BITCOIN-BTC", "LIGHTNING-BTC", "STARKNET-STRK" */
|
|
33
|
-
id: string;
|
|
34
|
-
/** Chain identifier, e.g. "STARKNET", "BITCOIN", "LIGHTNING" */
|
|
35
|
-
chainId: string;
|
|
36
|
-
/** Token ticker, e.g. "STRK" */
|
|
37
|
-
ticker: string;
|
|
38
|
-
/** Full token name */
|
|
39
|
-
name: string;
|
|
40
|
-
/** Decimal places of the token */
|
|
41
|
-
decimals: number;
|
|
42
|
-
/** Token contract address, or empty string for BTC on Bitcoin/Lightning */
|
|
43
|
-
address: string;
|
|
44
|
-
}
|
|
45
|
-
|
|
46
|
-
/**
|
|
47
|
-
* Serializable LNURL-pay representation for API responses
|
|
48
|
-
*
|
|
49
|
-
* @category API
|
|
50
|
-
*/
|
|
51
|
-
export type ApiLNURLPay = {
|
|
52
|
-
/** Marks the LNURL payload as an LNURL-pay response. */
|
|
53
|
-
type: "pay";
|
|
54
|
-
/** Minimum payable amount supported by the LNURL-pay endpoint. */
|
|
55
|
-
min: ApiAmount;
|
|
56
|
-
/** Maximum payable amount supported by the LNURL-pay endpoint. */
|
|
57
|
-
max: ApiAmount;
|
|
58
|
-
/** Maximum comment length accepted by the LNURL-pay endpoint. */
|
|
59
|
-
commentMaxLength: number;
|
|
60
|
-
/** Short human-readable description of the payee, when provided by the LNURL service. */
|
|
61
|
-
shortDescription?: string;
|
|
62
|
-
/** Longer human-readable description of the payee, when provided by the LNURL service. */
|
|
63
|
-
longDescription?: string;
|
|
64
|
-
/** Optional icon for the payee, usually encoded as a data URL. */
|
|
65
|
-
icon?: string;
|
|
66
|
-
/** Raw LNURL-pay metadata and callback parameters. */
|
|
67
|
-
params: LNURLPayParamsWithUrl;
|
|
68
|
-
}
|
|
69
|
-
|
|
70
|
-
/**
|
|
71
|
-
* Serializable LNURL-withdraw representation for API responses
|
|
72
|
-
*
|
|
73
|
-
* @category API
|
|
74
|
-
*/
|
|
75
|
-
export type ApiLNURLWithdraw = {
|
|
76
|
-
/** Marks the LNURL payload as an LNURL-withdraw response. */
|
|
77
|
-
type: "withdraw";
|
|
78
|
-
/** Minimum withdrawable amount supported by the LNURL-withdraw endpoint. */
|
|
79
|
-
min: ApiAmount;
|
|
80
|
-
/** Maximum withdrawable amount supported by the LNURL-withdraw endpoint. */
|
|
81
|
-
max: ApiAmount;
|
|
82
|
-
/** Raw LNURL-withdraw metadata and callback parameters. */
|
|
83
|
-
params: LNURLWithdrawParamsWithUrl;
|
|
84
|
-
}
|
|
85
|
-
|
|
86
|
-
/**
|
|
87
|
-
* Serializable LNURL representation for API responses
|
|
88
|
-
*
|
|
89
|
-
* @category API
|
|
90
|
-
*/
|
|
91
|
-
export type ApiLNURL = ApiLNURLPay | ApiLNURLWithdraw;
|
|
92
|
-
|
|
93
|
-
/**
|
|
94
|
-
* Converts a TokenAmount to the serializable ApiAmount format
|
|
95
|
-
*
|
|
96
|
-
* @category API
|
|
97
|
-
*/
|
|
98
|
-
export function toApiAmount(tokenAmount: TokenAmount): ApiAmount {
|
|
99
|
-
return {
|
|
100
|
-
amount: tokenAmount.amount,
|
|
101
|
-
rawAmount: tokenAmount.rawAmount != null ? tokenAmount.rawAmount.toString() : "0",
|
|
102
|
-
decimals: tokenAmount.token.decimals,
|
|
103
|
-
symbol: tokenAmount.token.ticker,
|
|
104
|
-
chain: tokenAmount.token.chainId
|
|
105
|
-
};
|
|
106
|
-
}
|
|
107
|
-
|
|
108
|
-
/**
|
|
109
|
-
* Converts a Token to the serializable ApiToken format
|
|
110
|
-
*
|
|
111
|
-
* @category API
|
|
112
|
-
*/
|
|
113
|
-
export function toApiToken(token: Token): ApiToken {
|
|
114
|
-
return {
|
|
115
|
-
id: `${token.chainId}-${token.ticker}`,
|
|
116
|
-
chainId: token.chainId,
|
|
117
|
-
ticker: token.ticker,
|
|
118
|
-
name: token.name,
|
|
119
|
-
decimals: token.decimals,
|
|
120
|
-
address: token.address
|
|
121
|
-
};
|
|
122
|
-
}
|
|
123
|
-
|
|
124
|
-
/**
|
|
125
|
-
* Converts LNURL data to the serializable API format
|
|
126
|
-
*
|
|
127
|
-
* @category API
|
|
128
|
-
*/
|
|
129
|
-
export function toApiLNURL(lnurl: LNURLPay | LNURLWithdraw, swapper: Swapper<any>): ApiLNURL {
|
|
130
|
-
if(lnurl.type === "pay") {
|
|
131
|
-
return {
|
|
132
|
-
type: "pay",
|
|
133
|
-
min: toApiAmount(toTokenAmount(lnurl.min, BitcoinTokens.BTCLN, swapper.prices)),
|
|
134
|
-
max: toApiAmount(toTokenAmount(lnurl.max, BitcoinTokens.BTCLN, swapper.prices)),
|
|
135
|
-
commentMaxLength: lnurl.commentMaxLength,
|
|
136
|
-
...(lnurl.shortDescription != null ? {shortDescription: lnurl.shortDescription} : {}),
|
|
137
|
-
...(lnurl.longDescription != null ? {longDescription: lnurl.longDescription} : {}),
|
|
138
|
-
...(lnurl.icon != null ? {icon: lnurl.icon} : {}),
|
|
139
|
-
params: lnurl.params
|
|
140
|
-
};
|
|
141
|
-
}
|
|
142
|
-
|
|
143
|
-
return {
|
|
144
|
-
type: "withdraw",
|
|
145
|
-
min: toApiAmount(toTokenAmount(lnurl.min, BitcoinTokens.BTCLN, swapper.prices)),
|
|
146
|
-
max: toApiAmount(toTokenAmount(lnurl.max, BitcoinTokens.BTCLN, swapper.prices)),
|
|
147
|
-
params: lnurl.params
|
|
148
|
-
};
|
|
149
|
-
}
|
|
150
|
-
|
|
151
|
-
/**
|
|
152
|
-
* Maps a TypeScript type to its schema type string representation
|
|
153
|
-
*
|
|
154
|
-
* @category API
|
|
155
|
-
*/
|
|
156
|
-
type TypeToSchemaType<T> =
|
|
157
|
-
NonNullable<T> extends string ? "string" :
|
|
158
|
-
NonNullable<T> extends number ? "number" :
|
|
159
|
-
NonNullable<T> extends bigint ? "bigint" :
|
|
160
|
-
NonNullable<T> extends boolean ? "boolean" :
|
|
161
|
-
NonNullable<T> extends any[] ? "array" :
|
|
162
|
-
"object";
|
|
163
|
-
|
|
164
|
-
/**
|
|
165
|
-
* Schema definition for a single API input field.
|
|
166
|
-
*
|
|
167
|
-
* @category API
|
|
168
|
-
*/
|
|
169
|
-
export type InputSchemaField<T = unknown> = {
|
|
170
|
-
/** Primitive schema type inferred from the TypeScript field type. */
|
|
171
|
-
type: TypeToSchemaType<T>;
|
|
172
|
-
/** Whether the field is required by the endpoint input parser. */
|
|
173
|
-
required: boolean;
|
|
174
|
-
/** Human-readable description of the field exposed by the API schema. */
|
|
175
|
-
description: string;
|
|
176
|
-
/** Nested schema properties for object-like fields. */
|
|
177
|
-
properties?: T extends readonly any[] ? never :
|
|
178
|
-
T extends object ? {
|
|
179
|
-
[K in keyof T]-?: InputSchemaField<T[K]>;
|
|
180
|
-
} : never; // Specifies nested object properties
|
|
181
|
-
/** Schema definition for array items when the field is an array. */
|
|
182
|
-
items?: T extends readonly (infer U)[] ? InputSchemaField<U> : never; // Specifies type of the array items
|
|
183
|
-
/** Enumerated allowed values for string, number, or bigint fields when constrained. */
|
|
184
|
-
allowedValues?: NonNullable<T> extends string | number | bigint ? NonNullable<T>[] : never; // An array of allowed values for a given field
|
|
185
|
-
};
|
|
186
|
-
|
|
187
|
-
/**
|
|
188
|
-
* Schema definition describing the accepted input shape for an API endpoint.
|
|
189
|
-
*
|
|
190
|
-
* @category API
|
|
191
|
-
*/
|
|
192
|
-
export type InputSchema<TInput> = {
|
|
193
|
-
[K in keyof TInput]-?: InputSchemaField<TInput[K]>;
|
|
194
|
-
};
|
|
195
|
-
|
|
196
|
-
/**
|
|
197
|
-
* Typed API endpoint definition for framework-agnostic integration
|
|
198
|
-
*
|
|
199
|
-
* @category API
|
|
200
|
-
*/
|
|
201
|
-
export type ApiEndpoint<TInput, TOutput, Type extends "GET" | "POST"> = {
|
|
202
|
-
/** HTTP method used by the endpoint. */
|
|
203
|
-
type: Type;
|
|
204
|
-
/** Human-readable description of what this endpoint does, written for AI agent consumption. */
|
|
205
|
-
description: string;
|
|
206
|
-
/** Structured schema describing the accepted input payload. */
|
|
207
|
-
inputSchema: InputSchema<TInput>;
|
|
208
|
-
/** Typed endpoint implementation that receives already-validated input. */
|
|
209
|
-
callback: (input: TInput, abortSignal?: AbortSignal) => Promise<TOutput>;
|
|
210
|
-
/** Raw endpoint implementation that parses unknown input into the typed callback. */
|
|
211
|
-
callbackRaw: (input: unknown, abortSignal?: AbortSignal) => Promise<TOutput>;
|
|
212
|
-
}
|
|
213
|
-
|
|
214
|
-
export function createApiEndpoint<TInput, TOutput, Type extends "GET" | "POST">(
|
|
215
|
-
type: Type,
|
|
216
|
-
description: string,
|
|
217
|
-
callback: (input: TInput, abortSignal?: AbortSignal) => Promise<TOutput>,
|
|
218
|
-
inputSchema: InputSchema<TInput>
|
|
219
|
-
): ApiEndpoint<TInput, TOutput, Type> {
|
|
220
|
-
return {
|
|
221
|
-
type,
|
|
222
|
-
description,
|
|
223
|
-
callback,
|
|
224
|
-
inputSchema,
|
|
225
|
-
callbackRaw: (input, abortSignal?: AbortSignal) => {
|
|
226
|
-
return callback(parseApiInput(inputSchema, input), abortSignal);
|
|
227
|
-
}
|
|
228
|
-
}
|
|
229
|
-
}
|
|
1
|
+
import {BitcoinTokens, Token} from "../types/Token";
|
|
2
|
+
import {TokenAmount, toTokenAmount} from "../types/TokenAmount";
|
|
3
|
+
import {LNURLPay, LNURLPayParamsWithUrl} from "../types/lnurl/LNURLPay";
|
|
4
|
+
import {LNURLWithdraw, LNURLWithdrawParamsWithUrl} from "../types/lnurl/LNURLWithdraw";
|
|
5
|
+
import {parseApiInput} from "./ApiParser";
|
|
6
|
+
import {Swapper} from "../swapper/Swapper";
|
|
7
|
+
|
|
8
|
+
/**
|
|
9
|
+
* Unified amount type for all API responses
|
|
10
|
+
*
|
|
11
|
+
* @category API
|
|
12
|
+
*/
|
|
13
|
+
export type ApiAmount = {
|
|
14
|
+
/** Decimal format of the amount, e.g. "1.5" */
|
|
15
|
+
amount: string;
|
|
16
|
+
/** Raw base units as string, e.g. "1500000000000000000" */
|
|
17
|
+
rawAmount: string;
|
|
18
|
+
/** Token decimals, e.g. 18 */
|
|
19
|
+
decimals: number;
|
|
20
|
+
/** Token ticker, e.g. "STRK" */
|
|
21
|
+
symbol: string;
|
|
22
|
+
/** Chain identifier, e.g. "STARKNET", "BITCOIN", "LIGHTNING" */
|
|
23
|
+
chain: string;
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
/**
|
|
27
|
+
* Serializable token representation for API responses
|
|
28
|
+
*
|
|
29
|
+
* @category API
|
|
30
|
+
*/
|
|
31
|
+
export type ApiToken = {
|
|
32
|
+
/** Canonical token identifier accepted by the API, e.g. "BITCOIN-BTC", "LIGHTNING-BTC", "STARKNET-STRK" */
|
|
33
|
+
id: string;
|
|
34
|
+
/** Chain identifier, e.g. "STARKNET", "BITCOIN", "LIGHTNING" */
|
|
35
|
+
chainId: string;
|
|
36
|
+
/** Token ticker, e.g. "STRK" */
|
|
37
|
+
ticker: string;
|
|
38
|
+
/** Full token name */
|
|
39
|
+
name: string;
|
|
40
|
+
/** Decimal places of the token */
|
|
41
|
+
decimals: number;
|
|
42
|
+
/** Token contract address, or empty string for BTC on Bitcoin/Lightning */
|
|
43
|
+
address: string;
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
/**
|
|
47
|
+
* Serializable LNURL-pay representation for API responses
|
|
48
|
+
*
|
|
49
|
+
* @category API
|
|
50
|
+
*/
|
|
51
|
+
export type ApiLNURLPay = {
|
|
52
|
+
/** Marks the LNURL payload as an LNURL-pay response. */
|
|
53
|
+
type: "pay";
|
|
54
|
+
/** Minimum payable amount supported by the LNURL-pay endpoint. */
|
|
55
|
+
min: ApiAmount;
|
|
56
|
+
/** Maximum payable amount supported by the LNURL-pay endpoint. */
|
|
57
|
+
max: ApiAmount;
|
|
58
|
+
/** Maximum comment length accepted by the LNURL-pay endpoint. */
|
|
59
|
+
commentMaxLength: number;
|
|
60
|
+
/** Short human-readable description of the payee, when provided by the LNURL service. */
|
|
61
|
+
shortDescription?: string;
|
|
62
|
+
/** Longer human-readable description of the payee, when provided by the LNURL service. */
|
|
63
|
+
longDescription?: string;
|
|
64
|
+
/** Optional icon for the payee, usually encoded as a data URL. */
|
|
65
|
+
icon?: string;
|
|
66
|
+
/** Raw LNURL-pay metadata and callback parameters. */
|
|
67
|
+
params: LNURLPayParamsWithUrl;
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
/**
|
|
71
|
+
* Serializable LNURL-withdraw representation for API responses
|
|
72
|
+
*
|
|
73
|
+
* @category API
|
|
74
|
+
*/
|
|
75
|
+
export type ApiLNURLWithdraw = {
|
|
76
|
+
/** Marks the LNURL payload as an LNURL-withdraw response. */
|
|
77
|
+
type: "withdraw";
|
|
78
|
+
/** Minimum withdrawable amount supported by the LNURL-withdraw endpoint. */
|
|
79
|
+
min: ApiAmount;
|
|
80
|
+
/** Maximum withdrawable amount supported by the LNURL-withdraw endpoint. */
|
|
81
|
+
max: ApiAmount;
|
|
82
|
+
/** Raw LNURL-withdraw metadata and callback parameters. */
|
|
83
|
+
params: LNURLWithdrawParamsWithUrl;
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
/**
|
|
87
|
+
* Serializable LNURL representation for API responses
|
|
88
|
+
*
|
|
89
|
+
* @category API
|
|
90
|
+
*/
|
|
91
|
+
export type ApiLNURL = ApiLNURLPay | ApiLNURLWithdraw;
|
|
92
|
+
|
|
93
|
+
/**
|
|
94
|
+
* Converts a TokenAmount to the serializable ApiAmount format
|
|
95
|
+
*
|
|
96
|
+
* @category API
|
|
97
|
+
*/
|
|
98
|
+
export function toApiAmount(tokenAmount: TokenAmount): ApiAmount {
|
|
99
|
+
return {
|
|
100
|
+
amount: tokenAmount.amount,
|
|
101
|
+
rawAmount: tokenAmount.rawAmount != null ? tokenAmount.rawAmount.toString() : "0",
|
|
102
|
+
decimals: tokenAmount.token.decimals,
|
|
103
|
+
symbol: tokenAmount.token.ticker,
|
|
104
|
+
chain: tokenAmount.token.chainId
|
|
105
|
+
};
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
/**
|
|
109
|
+
* Converts a Token to the serializable ApiToken format
|
|
110
|
+
*
|
|
111
|
+
* @category API
|
|
112
|
+
*/
|
|
113
|
+
export function toApiToken(token: Token): ApiToken {
|
|
114
|
+
return {
|
|
115
|
+
id: `${token.chainId}-${token.ticker}`,
|
|
116
|
+
chainId: token.chainId,
|
|
117
|
+
ticker: token.ticker,
|
|
118
|
+
name: token.name,
|
|
119
|
+
decimals: token.decimals,
|
|
120
|
+
address: token.address
|
|
121
|
+
};
|
|
122
|
+
}
|
|
123
|
+
|
|
124
|
+
/**
|
|
125
|
+
* Converts LNURL data to the serializable API format
|
|
126
|
+
*
|
|
127
|
+
* @category API
|
|
128
|
+
*/
|
|
129
|
+
export function toApiLNURL(lnurl: LNURLPay | LNURLWithdraw, swapper: Swapper<any>): ApiLNURL {
|
|
130
|
+
if(lnurl.type === "pay") {
|
|
131
|
+
return {
|
|
132
|
+
type: "pay",
|
|
133
|
+
min: toApiAmount(toTokenAmount(lnurl.min, BitcoinTokens.BTCLN, swapper.prices)),
|
|
134
|
+
max: toApiAmount(toTokenAmount(lnurl.max, BitcoinTokens.BTCLN, swapper.prices)),
|
|
135
|
+
commentMaxLength: lnurl.commentMaxLength,
|
|
136
|
+
...(lnurl.shortDescription != null ? {shortDescription: lnurl.shortDescription} : {}),
|
|
137
|
+
...(lnurl.longDescription != null ? {longDescription: lnurl.longDescription} : {}),
|
|
138
|
+
...(lnurl.icon != null ? {icon: lnurl.icon} : {}),
|
|
139
|
+
params: lnurl.params
|
|
140
|
+
};
|
|
141
|
+
}
|
|
142
|
+
|
|
143
|
+
return {
|
|
144
|
+
type: "withdraw",
|
|
145
|
+
min: toApiAmount(toTokenAmount(lnurl.min, BitcoinTokens.BTCLN, swapper.prices)),
|
|
146
|
+
max: toApiAmount(toTokenAmount(lnurl.max, BitcoinTokens.BTCLN, swapper.prices)),
|
|
147
|
+
params: lnurl.params
|
|
148
|
+
};
|
|
149
|
+
}
|
|
150
|
+
|
|
151
|
+
/**
|
|
152
|
+
* Maps a TypeScript type to its schema type string representation
|
|
153
|
+
*
|
|
154
|
+
* @category API
|
|
155
|
+
*/
|
|
156
|
+
type TypeToSchemaType<T> =
|
|
157
|
+
NonNullable<T> extends string ? "string" :
|
|
158
|
+
NonNullable<T> extends number ? "number" :
|
|
159
|
+
NonNullable<T> extends bigint ? "bigint" :
|
|
160
|
+
NonNullable<T> extends boolean ? "boolean" :
|
|
161
|
+
NonNullable<T> extends any[] ? "array" :
|
|
162
|
+
"object";
|
|
163
|
+
|
|
164
|
+
/**
|
|
165
|
+
* Schema definition for a single API input field.
|
|
166
|
+
*
|
|
167
|
+
* @category API
|
|
168
|
+
*/
|
|
169
|
+
export type InputSchemaField<T = unknown> = {
|
|
170
|
+
/** Primitive schema type inferred from the TypeScript field type. */
|
|
171
|
+
type: TypeToSchemaType<T>;
|
|
172
|
+
/** Whether the field is required by the endpoint input parser. */
|
|
173
|
+
required: boolean;
|
|
174
|
+
/** Human-readable description of the field exposed by the API schema. */
|
|
175
|
+
description: string;
|
|
176
|
+
/** Nested schema properties for object-like fields. */
|
|
177
|
+
properties?: T extends readonly any[] ? never :
|
|
178
|
+
T extends object ? {
|
|
179
|
+
[K in keyof T]-?: InputSchemaField<T[K]>;
|
|
180
|
+
} : never; // Specifies nested object properties
|
|
181
|
+
/** Schema definition for array items when the field is an array. */
|
|
182
|
+
items?: T extends readonly (infer U)[] ? InputSchemaField<U> : never; // Specifies type of the array items
|
|
183
|
+
/** Enumerated allowed values for string, number, or bigint fields when constrained. */
|
|
184
|
+
allowedValues?: NonNullable<T> extends string | number | bigint ? NonNullable<T>[] : never; // An array of allowed values for a given field
|
|
185
|
+
};
|
|
186
|
+
|
|
187
|
+
/**
|
|
188
|
+
* Schema definition describing the accepted input shape for an API endpoint.
|
|
189
|
+
*
|
|
190
|
+
* @category API
|
|
191
|
+
*/
|
|
192
|
+
export type InputSchema<TInput> = {
|
|
193
|
+
[K in keyof TInput]-?: InputSchemaField<TInput[K]>;
|
|
194
|
+
};
|
|
195
|
+
|
|
196
|
+
/**
|
|
197
|
+
* Typed API endpoint definition for framework-agnostic integration
|
|
198
|
+
*
|
|
199
|
+
* @category API
|
|
200
|
+
*/
|
|
201
|
+
export type ApiEndpoint<TInput, TOutput, Type extends "GET" | "POST"> = {
|
|
202
|
+
/** HTTP method used by the endpoint. */
|
|
203
|
+
type: Type;
|
|
204
|
+
/** Human-readable description of what this endpoint does, written for AI agent consumption. */
|
|
205
|
+
description: string;
|
|
206
|
+
/** Structured schema describing the accepted input payload. */
|
|
207
|
+
inputSchema: InputSchema<TInput>;
|
|
208
|
+
/** Typed endpoint implementation that receives already-validated input. */
|
|
209
|
+
callback: (input: TInput, abortSignal?: AbortSignal) => Promise<TOutput>;
|
|
210
|
+
/** Raw endpoint implementation that parses unknown input into the typed callback. */
|
|
211
|
+
callbackRaw: (input: unknown, abortSignal?: AbortSignal) => Promise<TOutput>;
|
|
212
|
+
}
|
|
213
|
+
|
|
214
|
+
export function createApiEndpoint<TInput, TOutput, Type extends "GET" | "POST">(
|
|
215
|
+
type: Type,
|
|
216
|
+
description: string,
|
|
217
|
+
callback: (input: TInput, abortSignal?: AbortSignal) => Promise<TOutput>,
|
|
218
|
+
inputSchema: InputSchema<TInput>
|
|
219
|
+
): ApiEndpoint<TInput, TOutput, Type> {
|
|
220
|
+
return {
|
|
221
|
+
type,
|
|
222
|
+
description,
|
|
223
|
+
callback,
|
|
224
|
+
inputSchema,
|
|
225
|
+
callbackRaw: (input, abortSignal?: AbortSignal) => {
|
|
226
|
+
return callback(parseApiInput(inputSchema, input), abortSignal);
|
|
227
|
+
}
|
|
228
|
+
}
|
|
229
|
+
}
|
|
@@ -1,97 +1,97 @@
|
|
|
1
|
-
import {
|
|
2
|
-
SwapExecutionAction,
|
|
3
|
-
SwapExecutionActionSendToAddress,
|
|
4
|
-
SwapExecutionActionSignPSBT,
|
|
5
|
-
SwapExecutionActionSignSmartChainTx,
|
|
6
|
-
SwapExecutionActionWait
|
|
7
|
-
} from "../types/SwapExecutionAction";
|
|
8
|
-
import {ApiAmount, toApiAmount} from "./ApiTypes";
|
|
9
|
-
|
|
10
|
-
/**
|
|
11
|
-
* Strips non-serializable fields (functions, complex objects) from SwapExecutionAction types.
|
|
12
|
-
* Uses key-remapping to truly omit function keys from the resulting type.
|
|
13
|
-
*
|
|
14
|
-
* - SignSmartChainTransaction: functions removed, txs → string[]
|
|
15
|
-
* - SignPSBT: functions removed, txs[].psbt (Transaction object) omitted
|
|
16
|
-
* - SendToAddress: functions removed, txs[].amount (TokenAmount) → ApiAmount
|
|
17
|
-
* - Wait: functions removed, data fields kept as-is
|
|
18
|
-
*
|
|
19
|
-
* @category API
|
|
20
|
-
*/
|
|
21
|
-
export type SerializedAction<T extends SwapExecutionAction> =
|
|
22
|
-
T["type"] extends "SignSmartChainTransaction" ? {
|
|
23
|
-
[K in keyof T as T[K] extends Function ? never : K]:
|
|
24
|
-
K extends "txs" ? string[] : T[K]
|
|
25
|
-
} :
|
|
26
|
-
T["type"] extends "SignPSBT" ? {
|
|
27
|
-
[K in keyof T as T[K] extends Function ? never : K]:
|
|
28
|
-
K extends "txs" ? (T extends { txs: (infer U)[] }
|
|
29
|
-
? Omit<U, "psbt">[] : never) : T[K]
|
|
30
|
-
} :
|
|
31
|
-
T["type"] extends "SendToAddress" ? {
|
|
32
|
-
[K in keyof T as T[K] extends Function ? never : K]:
|
|
33
|
-
K extends "txs" ? (T extends { txs: (infer U)[] }
|
|
34
|
-
? (Omit<U, "amount"> & { amount: ApiAmount })[] : never) : T[K]
|
|
35
|
-
} : {
|
|
36
|
-
[K in keyof T as T[K] extends Function ? never : K]: T[K]
|
|
37
|
-
};
|
|
38
|
-
|
|
39
|
-
/**
|
|
40
|
-
* Runtime serializer that strips non-serializable fields from a SwapExecutionAction.
|
|
41
|
-
* Matches the compile-time SerializedAction<T> type.
|
|
42
|
-
*
|
|
43
|
-
* @param action The swap execution action to serialize
|
|
44
|
-
* @param txSerializer Optional chain-specific transaction serializer for SignSmartChainTransaction actions.
|
|
45
|
-
* Accepts the chain identifier and raw transaction, returns the serialized string.
|
|
46
|
-
* Falls back to JSON.stringify if not provided.
|
|
47
|
-
*
|
|
48
|
-
* @category API
|
|
49
|
-
*/
|
|
50
|
-
export async function serializeAction(
|
|
51
|
-
action: SwapExecutionAction,
|
|
52
|
-
txSerializer?: (chainId: string, tx: any) => Promise<string>
|
|
53
|
-
): Promise<SerializedAction<SwapExecutionAction>> {
|
|
54
|
-
switch (action.type) {
|
|
55
|
-
case "SendToAddress": {
|
|
56
|
-
const {waitForTransactions, ...rest} = action as SwapExecutionActionSendToAddress<boolean>;
|
|
57
|
-
return {
|
|
58
|
-
...rest,
|
|
59
|
-
txs: rest.txs.map(tx => ({
|
|
60
|
-
type: tx.type,
|
|
61
|
-
address: tx.address,
|
|
62
|
-
hyperlink: tx.hyperlink,
|
|
63
|
-
amount: toApiAmount(tx.amount)
|
|
64
|
-
}))
|
|
65
|
-
} as unknown as SerializedAction<SwapExecutionAction>;
|
|
66
|
-
}
|
|
67
|
-
case "SignPSBT": {
|
|
68
|
-
const {submitPsbt, txs, ...rest} = action as SwapExecutionActionSignPSBT<"FUNDED_PSBT" | "RAW_PSBT">;
|
|
69
|
-
return {
|
|
70
|
-
...rest,
|
|
71
|
-
txs: txs.map(tx => {
|
|
72
|
-
const {psbt, ...txRest} = tx;
|
|
73
|
-
return txRest;
|
|
74
|
-
})
|
|
75
|
-
} as unknown as SerializedAction<SwapExecutionAction>;
|
|
76
|
-
}
|
|
77
|
-
case "SignSmartChainTransaction": {
|
|
78
|
-
const {submitTransactions, ...rest} = action as SwapExecutionActionSignSmartChainTx;
|
|
79
|
-
return {
|
|
80
|
-
...rest,
|
|
81
|
-
txs: await Promise.all(rest.txs.map(tx =>
|
|
82
|
-
txSerializer != null
|
|
83
|
-
? txSerializer(rest.chain, tx)
|
|
84
|
-
: Promise.resolve(JSON.stringify(tx))
|
|
85
|
-
))
|
|
86
|
-
} as unknown as SerializedAction<SwapExecutionAction>;
|
|
87
|
-
}
|
|
88
|
-
case "Wait": {
|
|
89
|
-
const {wait, ...rest} = action as SwapExecutionActionWait;
|
|
90
|
-
return rest as unknown as SerializedAction<SwapExecutionAction>;
|
|
91
|
-
}
|
|
92
|
-
default: {
|
|
93
|
-
const _exhaustive: never = action;
|
|
94
|
-
throw new Error(`Unknown action type: ${(_exhaustive as any).type}`);
|
|
95
|
-
}
|
|
96
|
-
}
|
|
97
|
-
}
|
|
1
|
+
import {
|
|
2
|
+
SwapExecutionAction,
|
|
3
|
+
SwapExecutionActionSendToAddress,
|
|
4
|
+
SwapExecutionActionSignPSBT,
|
|
5
|
+
SwapExecutionActionSignSmartChainTx,
|
|
6
|
+
SwapExecutionActionWait
|
|
7
|
+
} from "../types/SwapExecutionAction";
|
|
8
|
+
import {ApiAmount, toApiAmount} from "./ApiTypes";
|
|
9
|
+
|
|
10
|
+
/**
|
|
11
|
+
* Strips non-serializable fields (functions, complex objects) from SwapExecutionAction types.
|
|
12
|
+
* Uses key-remapping to truly omit function keys from the resulting type.
|
|
13
|
+
*
|
|
14
|
+
* - SignSmartChainTransaction: functions removed, txs → string[]
|
|
15
|
+
* - SignPSBT: functions removed, txs[].psbt (Transaction object) omitted
|
|
16
|
+
* - SendToAddress: functions removed, txs[].amount (TokenAmount) → ApiAmount
|
|
17
|
+
* - Wait: functions removed, data fields kept as-is
|
|
18
|
+
*
|
|
19
|
+
* @category API
|
|
20
|
+
*/
|
|
21
|
+
export type SerializedAction<T extends SwapExecutionAction> =
|
|
22
|
+
T["type"] extends "SignSmartChainTransaction" ? {
|
|
23
|
+
[K in keyof T as T[K] extends Function ? never : K]:
|
|
24
|
+
K extends "txs" ? string[] : T[K]
|
|
25
|
+
} :
|
|
26
|
+
T["type"] extends "SignPSBT" ? {
|
|
27
|
+
[K in keyof T as T[K] extends Function ? never : K]:
|
|
28
|
+
K extends "txs" ? (T extends { txs: (infer U)[] }
|
|
29
|
+
? Omit<U, "psbt">[] : never) : T[K]
|
|
30
|
+
} :
|
|
31
|
+
T["type"] extends "SendToAddress" ? {
|
|
32
|
+
[K in keyof T as T[K] extends Function ? never : K]:
|
|
33
|
+
K extends "txs" ? (T extends { txs: (infer U)[] }
|
|
34
|
+
? (Omit<U, "amount"> & { amount: ApiAmount })[] : never) : T[K]
|
|
35
|
+
} : {
|
|
36
|
+
[K in keyof T as T[K] extends Function ? never : K]: T[K]
|
|
37
|
+
};
|
|
38
|
+
|
|
39
|
+
/**
|
|
40
|
+
* Runtime serializer that strips non-serializable fields from a SwapExecutionAction.
|
|
41
|
+
* Matches the compile-time SerializedAction<T> type.
|
|
42
|
+
*
|
|
43
|
+
* @param action The swap execution action to serialize
|
|
44
|
+
* @param txSerializer Optional chain-specific transaction serializer for SignSmartChainTransaction actions.
|
|
45
|
+
* Accepts the chain identifier and raw transaction, returns the serialized string.
|
|
46
|
+
* Falls back to JSON.stringify if not provided.
|
|
47
|
+
*
|
|
48
|
+
* @category API
|
|
49
|
+
*/
|
|
50
|
+
export async function serializeAction(
|
|
51
|
+
action: SwapExecutionAction,
|
|
52
|
+
txSerializer?: (chainId: string, tx: any) => Promise<string>
|
|
53
|
+
): Promise<SerializedAction<SwapExecutionAction>> {
|
|
54
|
+
switch (action.type) {
|
|
55
|
+
case "SendToAddress": {
|
|
56
|
+
const {waitForTransactions, ...rest} = action as SwapExecutionActionSendToAddress<boolean>;
|
|
57
|
+
return {
|
|
58
|
+
...rest,
|
|
59
|
+
txs: rest.txs.map(tx => ({
|
|
60
|
+
type: tx.type,
|
|
61
|
+
address: tx.address,
|
|
62
|
+
hyperlink: tx.hyperlink,
|
|
63
|
+
amount: toApiAmount(tx.amount)
|
|
64
|
+
}))
|
|
65
|
+
} as unknown as SerializedAction<SwapExecutionAction>;
|
|
66
|
+
}
|
|
67
|
+
case "SignPSBT": {
|
|
68
|
+
const {submitPsbt, txs, ...rest} = action as SwapExecutionActionSignPSBT<"FUNDED_PSBT" | "RAW_PSBT">;
|
|
69
|
+
return {
|
|
70
|
+
...rest,
|
|
71
|
+
txs: txs.map(tx => {
|
|
72
|
+
const {psbt, ...txRest} = tx;
|
|
73
|
+
return txRest;
|
|
74
|
+
})
|
|
75
|
+
} as unknown as SerializedAction<SwapExecutionAction>;
|
|
76
|
+
}
|
|
77
|
+
case "SignSmartChainTransaction": {
|
|
78
|
+
const {submitTransactions, ...rest} = action as SwapExecutionActionSignSmartChainTx;
|
|
79
|
+
return {
|
|
80
|
+
...rest,
|
|
81
|
+
txs: await Promise.all(rest.txs.map(tx =>
|
|
82
|
+
txSerializer != null
|
|
83
|
+
? txSerializer(rest.chain, tx)
|
|
84
|
+
: Promise.resolve(JSON.stringify(tx))
|
|
85
|
+
))
|
|
86
|
+
} as unknown as SerializedAction<SwapExecutionAction>;
|
|
87
|
+
}
|
|
88
|
+
case "Wait": {
|
|
89
|
+
const {wait, ...rest} = action as SwapExecutionActionWait;
|
|
90
|
+
return rest as unknown as SerializedAction<SwapExecutionAction>;
|
|
91
|
+
}
|
|
92
|
+
default: {
|
|
93
|
+
const _exhaustive: never = action;
|
|
94
|
+
throw new Error(`Unknown action type: ${(_exhaustive as any).type}`);
|
|
95
|
+
}
|
|
96
|
+
}
|
|
97
|
+
}
|