@chainflip/sdk 2.1.0-dev.0 → 2.1.1

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/dist/swap.js CHANGED
@@ -1,6 +1,6 @@
1
- import { assert, getEnvironment, envSafeAssetBlacklist, getEvmChainId, getAllBoostPoolsDepth, parseFoKParams, isNotNullish, isTestnet, ADDRESSES } from './chunk-IXOXOHVV.js';
1
+ import { getEnvironment, assert, getEvmChainId, getAllBoostPoolsDepth, isNotNullish, ADDRESSES } from './chunk-S46ZA3IE.js';
2
2
  import { unreachable } from '@chainflip/utils/assertion';
3
- import { chainflipChains, assetSymbols, isValidAssetAndChain, chainflipAssets, getInternalAssets, assetConstants, getInternalAsset, internalAssetToRpcAsset, readAssetValue, chainflipNetworks } from '@chainflip/utils/chainflip';
3
+ import { chainflipChains, assetSymbols, isValidAssetAndChain, chainflipAssets, getInternalAssets, assetConstants, getInternalAsset, internalAssetToRpcAsset, chainflipNetworks, readAssetValue, anyAssetConstants } from '@chainflip/utils/chainflip';
4
4
  export { getInternalAsset as getChainflipId } from '@chainflip/utils/chainflip';
5
5
  import { initContract, initClient } from '@ts-rest/core';
6
6
  import z3, { z } from 'zod';
@@ -13,7 +13,8 @@ import { hexEncodeNumber } from '@chainflip/utils/number';
13
13
  import { HttpClient } from '@chainflip/rpc';
14
14
  import { bytesToHex } from '@chainflip/utils/bytes';
15
15
  import { priceX128ToPrice } from '@chainflip/utils/tickMath';
16
- import BigNumber from 'bignumber.js';
16
+ import BigNumber2 from 'bignumber.js';
17
+ import { CHAINFLIP_BLOCK_TIME_SECONDS } from '@chainflip/utils/consts';
17
18
  import axios from 'axios';
18
19
 
19
20
  var booleanString = z.string().regex(/^(true|false)$/i).transform((v) => v.toLowerCase() === "true");
@@ -103,7 +104,6 @@ var validators = {
103
104
  mainnet: {
104
105
  Bitcoin: validateBitcoinMainnetAddress,
105
106
  Ethereum: validateEvmAddress,
106
- Polkadot: validatePolkadotAddress,
107
107
  Arbitrum: validateEvmAddress,
108
108
  Solana: validateSolanaAddress,
109
109
  Assethub: validatePolkadotAddress
@@ -111,7 +111,6 @@ var validators = {
111
111
  perseverance: {
112
112
  Bitcoin: validateBitcoinTestnetAddress,
113
113
  Ethereum: validateEvmAddress,
114
- Polkadot: validatePolkadotAddress,
115
114
  Arbitrum: validateEvmAddress,
116
115
  Solana: validateSolanaAddress,
117
116
  Assethub: validatePolkadotAddress
@@ -119,7 +118,6 @@ var validators = {
119
118
  sisyphos: {
120
119
  Bitcoin: validateBitcoinTestnetAddress,
121
120
  Ethereum: validateEvmAddress,
122
- Polkadot: validatePolkadotAddress,
123
121
  Arbitrum: validateEvmAddress,
124
122
  Solana: validateSolanaAddress,
125
123
  Assethub: validatePolkadotAddress
@@ -127,7 +125,6 @@ var validators = {
127
125
  backspin: {
128
126
  Bitcoin: validateBitcoinRegtestAddress,
129
127
  Ethereum: validateEvmAddress,
130
- Polkadot: validatePolkadotAddress,
131
128
  Arbitrum: validateEvmAddress,
132
129
  Solana: validateSolanaAddress,
133
130
  Assethub: validatePolkadotAddress
@@ -135,7 +132,6 @@ var validators = {
135
132
  localnet: {
136
133
  Bitcoin: validateBitcoinRegtestAddress,
137
134
  Ethereum: validateEvmAddress,
138
- Polkadot: validatePolkadotAddress,
139
135
  Arbitrum: validateEvmAddress,
140
136
  Solana: validateSolanaAddress,
141
137
  Assethub: validatePolkadotAddress
@@ -211,13 +207,6 @@ z.object({
211
207
  });
212
208
  hadError = true;
213
209
  }
214
- if (srcAsset === "Dot" || destAsset === "Dot") {
215
- ctx.addIssue({
216
- message: "Dot is not supported",
217
- code: z.ZodIssueCode.custom
218
- });
219
- hadError = true;
220
- }
221
210
  if (args.ccmGasBudget !== void 0 && args.ccmMessageLengthBytes === void 0) {
222
211
  ctx.addIssue({
223
212
  message: `ccmMessageLengthBytes must be set if ccmGasBudget is set`,
@@ -239,6 +228,13 @@ z.object({
239
228
  });
240
229
  hadError = true;
241
230
  }
231
+ if (args.isVaultSwap && args.srcChain === "Assethub") {
232
+ ctx.addIssue({
233
+ message: "Vault swaps are not supported on Assethub",
234
+ code: z.ZodIssueCode.custom
235
+ });
236
+ hadError = true;
237
+ }
242
238
  if (args.isOnChain && args.brokerCommissionBps !== void 0 && args.brokerCommissionBps > 0) {
243
239
  ctx.addIssue({
244
240
  message: "isOnChain cannot be set with a non-zero broker commission",
@@ -265,9 +261,7 @@ var ccmParamsSchema = z.object({
265
261
  // https://github.com/chainflip-io/chainflip-backend/blob/415aa9e20ec4046c68892cd34798e5d831c5b83f/state-chain/chains/src/lib.rs#L709
266
262
  message: hexStringWithMaxByteSize(15e3),
267
263
  // https://github.com/chainflip-io/chainflip-backend/blob/415aa9e20ec4046c68892cd34798e5d831c5b83f/state-chain/chains/src/lib.rs#L710
268
- ccmAdditionalData: hexStringWithMaxByteSize(3e3).optional(),
269
- /** @deprecated DEPRECATED(1.12) pass additionalData instead */
270
- cfParameters: z.never({ message: "cfParameters is deprecated, use ccmAdditionalData instead" }).optional()
264
+ ccmAdditionalData: hexStringWithMaxByteSize(3e3).optional()
271
265
  }).transform(({ gasBudget, message, ccmAdditionalData }) => ({
272
266
  gasBudget,
273
267
  message,
@@ -290,22 +284,10 @@ var fillOrKillParams = z.object({
290
284
  });
291
285
 
292
286
  // ../shared/src/api/openSwapDepositChannel.ts
293
- var assets = z.union([
294
- z.object({
295
- srcAsset: assetAndChain,
296
- destAsset: assetAndChain
297
- }),
298
- /** @deprecated DEPRECATED(1.12): remove this variant */
299
- z.object({
300
- srcAsset: asset,
301
- destAsset: asset,
302
- srcChain: chain,
303
- destChain: chain
304
- }).transform(({ srcAsset, destAsset, srcChain, destChain }) => ({
305
- srcAsset: assetAndChain.parse({ asset: srcAsset, chain: srcChain }),
306
- destAsset: assetAndChain.parse({ asset: destAsset, chain: destChain })
307
- }))
308
- ]);
287
+ var assets = z.object({
288
+ srcAsset: assetAndChain,
289
+ destAsset: assetAndChain
290
+ });
309
291
  var getOpenSwapDepositChannelSchema = (network) => z.intersection(
310
292
  assets,
311
293
  z.object({
@@ -470,7 +452,7 @@ var getVaultSwapParameterEncodingRequestSchema = (network) => z.object({
470
452
  }).transform((data) => {
471
453
  let extraParams;
472
454
  if (data.srcAsset.chain === "Bitcoin") {
473
- const minOutputAmount = BigNumber(data.amount.toString()).multipliedBy(priceX128ToPrice(data.fillOrKillParams.min_price)).toFixed(0);
455
+ const minOutputAmount = BigNumber2(data.amount.toString()).multipliedBy(priceX128ToPrice(data.fillOrKillParams.min_price)).toFixed(0);
474
456
  extraParams = {
475
457
  chain: "Bitcoin",
476
458
  min_output_amount: `0x${BigInt(minOutputAmount).toString(16)}`,
@@ -666,6 +648,59 @@ var MultiCache = class {
666
648
  return cached.value;
667
649
  }
668
650
  };
651
+ var getPriceX128FromPrice = (price, srcAsset, destAsset) => BigNumber2(price).multipliedBy(new BigNumber2(2).pow(128)).shiftedBy(anyAssetConstants[destAsset].decimals - anyAssetConstants[srcAsset].decimals).toFixed(0);
652
+ var blocksPerMinute = 60 / CHAINFLIP_BLOCK_TIME_SECONDS;
653
+ function parseFoKParams(params, quote) {
654
+ const srcAsset = getInternalAsset(quote.srcAsset);
655
+ const destAsset = getInternalAsset(quote.destAsset);
656
+ const lppAvailable = isNotNullish(quote.recommendedLivePriceSlippageTolerancePercent);
657
+ let minPrice;
658
+ let lpp = null;
659
+ if (isNotNullish(params.livePriceSlippageTolerancePercent)) {
660
+ if (!lppAvailable) {
661
+ throw new Error("Live price protection is not available for this asset pair");
662
+ }
663
+ lpp = new BigNumber2(params.livePriceSlippageTolerancePercent);
664
+ assert(!lpp.isNaN(), "Invalid live price slippage tolerance");
665
+ assert(
666
+ lpp.gte(0) && lpp.lte(100),
667
+ "Live price slippage tolerance must be between 0 and 100 inclusive"
668
+ );
669
+ } else if (quote.recommendedLivePriceSlippageTolerancePercent) {
670
+ lpp = new BigNumber2(quote.recommendedLivePriceSlippageTolerancePercent);
671
+ assert(!lpp.isNaN(), "Invalid live price slippage tolerance");
672
+ }
673
+ if ("minPrice" in params) {
674
+ assert(
675
+ !("slippageTolerancePercent" in params),
676
+ "Cannot have both minPrice and slippageTolerancePercent"
677
+ );
678
+ minPrice = params.minPrice;
679
+ } else if ("slippageTolerancePercent" in params) {
680
+ const tolerance = new BigNumber2(params.slippageTolerancePercent);
681
+ assert(!tolerance.isNaN(), "Invalid slippage tolerance");
682
+ assert(
683
+ tolerance.gte(0) && tolerance.lte(100),
684
+ "Slippage tolerance must be between 0 and 100 inclusive",
685
+ RangeError
686
+ );
687
+ const estimatedPrice = new BigNumber2(quote.estimatedPrice);
688
+ assert(!estimatedPrice.isNaN(), "Invalid estimated price");
689
+ minPrice = estimatedPrice.times(new BigNumber2(100).minus(tolerance).dividedBy(100)).toFixed(assetConstants[destAsset].decimals);
690
+ } else {
691
+ throw new Error("Either minPrice or slippageTolerancePercent must be provided");
692
+ }
693
+ const retryDurationBlocks = "retryDurationBlocks" in params ? params.retryDurationBlocks : Math.max(Math.ceil(params.retryDurationMinutes * blocksPerMinute), 0);
694
+ const maxOraclePriceSlippage = lpp?.multipliedBy(100).toNumber() ?? null;
695
+ const parsed = {
696
+ retryDurationBlocks,
697
+ minPriceX128: getPriceX128FromPrice(minPrice, srcAsset, destAsset),
698
+ maxOraclePriceSlippage,
699
+ refundCcmMetadata: params.refundCcmMetadata ?? null
700
+ };
701
+ return "refundAddress" in params ? { ...parsed, refundAddress: params.refundAddress } : parsed;
702
+ }
703
+ var isTestnet = (network) => network !== "mainnet";
669
704
  var MAX_SWAP_AMOUNT = 2n ** 128n - 1n;
670
705
  var validateSwapAmount = (env, asset2, amount) => {
671
706
  const minimumAmount = readAssetValue(env.ingressEgress.minimumDepositAmounts, asset2);
@@ -687,7 +722,6 @@ var validateSwapAmount = (env, asset2, amount) => {
687
722
  var getTokenContractAddress = (asset2, network) => {
688
723
  switch (asset2) {
689
724
  case "Btc":
690
- case "Dot":
691
725
  case "Eth":
692
726
  case "ArbEth":
693
727
  case "Sol":
@@ -705,7 +739,6 @@ var assetNames = {
705
739
  Usdc: "USDC",
706
740
  Usdt: "USDT",
707
741
  Wbtc: "WBTC",
708
- Dot: "Polkadot",
709
742
  Btc: "Bitcoin",
710
743
  ArbEth: "Arbitrum Ether",
711
744
  ArbUsdc: "Arbitrum USDC",
@@ -740,15 +773,13 @@ var getChainData = (chain2, network, env) => ({
740
773
  name: chain2,
741
774
  evmChainId: getEvmChainId(chain2, network),
742
775
  isMainnet: !isTestnet(network),
743
- requiredBlockConfirmations: isNotNullish(
744
- env.ingressEgress.witnessSafetyMargins[chain2]
745
- ) ? Number(env.ingressEgress.witnessSafetyMargins[chain2]) + 1 : void 0,
776
+ requiredBlockConfirmations: isNotNullish(env.ingressEgress.witnessSafetyMargins[chain2]) ? Number(env.ingressEgress.witnessSafetyMargins[chain2]) + 1 : void 0,
746
777
  maxRetryDurationBlocks: env.swapping.maxSwapRetryDurationBlocks
747
778
  });
748
779
 
749
780
  // package.json
750
781
  var package_default = {
751
- version: "2.1.0-dev.0"};
782
+ version: "2.1.1"};
752
783
 
753
784
  // src/swap/consts.ts
754
785
  var CF_SDK_VERSION_HEADERS = { "X-Chainflip-Sdk-Version": package_default.version };
@@ -815,9 +846,7 @@ var SwapSDK = class {
815
846
  cache;
816
847
  dcaEnabled = false;
817
848
  dcaV2Enabled = false;
818
- blackListedAssets;
819
849
  constructor(options = {}) {
820
- assert(options.broker?.commissionBps === void 0, "broker.commissionBps is deprecated");
821
850
  const network = options.network ?? "perseverance";
822
851
  this.options = {
823
852
  ...options,
@@ -847,7 +876,6 @@ var SwapSDK = class {
847
876
  ttl: 6e4
848
877
  }
849
878
  });
850
- this.blackListedAssets = envSafeAssetBlacklist(this.options.network);
851
879
  }
852
880
  async getChains(sourceChain, type = "all") {
853
881
  if (sourceChain && !chainflipChains.includes(sourceChain)) {
@@ -859,14 +887,14 @@ var SwapSDK = class {
859
887
  ]);
860
888
  const supportedChains = new Set(supportedAssets.map((a) => assetConstants[a].chain));
861
889
  if (sourceChain && !supportedChains.has(sourceChain)) return [];
862
- return [...supportedChains].filter((chain2) => chain2 !== "Polkadot").map((chain2) => getChainData(chain2, this.options.network, env)).filter((chain2) => chain2.chain !== sourceChain);
890
+ return [...supportedChains].map((chain2) => getChainData(chain2, this.options.network, env)).filter((chain2) => chain2.chain !== sourceChain);
863
891
  }
864
892
  async getStateChainEnvironment() {
865
893
  return this.cache.read("environment");
866
894
  }
867
895
  async getSupportedAssets(type) {
868
896
  const assets2 = await this.cache.read("networkInfo");
869
- return assets2.assets.filter((a) => !this.blackListedAssets.includes(a.asset)).filter((a) => {
897
+ return assets2.assets.filter((a) => {
870
898
  switch (type) {
871
899
  case "all":
872
900
  return true;
@@ -892,7 +920,7 @@ var SwapSDK = class {
892
920
  this.getStateChainEnvironment(),
893
921
  this.getSupportedAssets(type)
894
922
  ]);
895
- return supportedAssets.filter((asset2) => asset2 !== "Dot").map((asset2) => getAssetData(asset2, this.options.network, env)).filter((asset2) => !chain2 || asset2.chain === chain2);
923
+ return supportedAssets.map((asset2) => getAssetData(asset2, this.options.network, env)).filter((asset2) => !chain2 || asset2.chain === chain2);
896
924
  }
897
925
  // eslint-disable-next-line class-methods-use-this
898
926
  shouldTakeCommission() {
@@ -939,7 +967,7 @@ var SwapSDK = class {
939
967
  const {
940
968
  ingressEgress: { witnessSafetyMargins }
941
969
  } = await this.getStateChainEnvironment();
942
- return chainflipChains.filter((chain2) => chain2 !== "Polkadot").reduce(
970
+ return chainflipChains.reduce(
943
971
  (acc, chain2) => {
944
972
  acc[chain2] = witnessSafetyMargins[chain2] ? Number(witnessSafetyMargins[chain2]) + 1 : null;
945
973
  return acc;
@@ -999,7 +1027,6 @@ var SwapSDK = class {
999
1027
  ccmParams,
1000
1028
  amount: quote.depositAmount
1001
1029
  };
1002
- await this.checkLivePriceProtectionRequirement(depositAddressRequest, quote);
1003
1030
  let response;
1004
1031
  if (this.options.broker) {
1005
1032
  const result = await requestSwapDepositAddress(
@@ -1090,7 +1117,6 @@ var SwapSDK = class {
1090
1117
  commissionBps: brokerCommissionBps,
1091
1118
  affiliates
1092
1119
  };
1093
- await this.checkLivePriceProtectionRequirement(vaultSwapRequest, quote);
1094
1120
  if (this.options.broker) {
1095
1121
  assert(
1096
1122
  !vaultSwapRequest.brokerAccount,
@@ -1152,7 +1178,6 @@ var SwapSDK = class {
1152
1178
  commissionBps: await this.getCommissionBps(brokerCommissionBps),
1153
1179
  affiliates
1154
1180
  };
1155
- await this.checkLivePriceProtectionRequirement(requestParams, quote);
1156
1181
  if (this.options.broker) {
1157
1182
  assert(
1158
1183
  !brokerAccount,
@@ -1199,49 +1224,11 @@ var SwapSDK = class {
1199
1224
  }
1200
1225
  return res.body;
1201
1226
  }
1202
- async checkLivePriceProtectionRequirement(request, quote) {
1203
- if (!this.dcaV2Enabled || quote.type !== "DCA") return;
1204
- const { assets: assets2 } = await this.cache.read("networkInfo");
1205
- const srcAsset = getInternalAsset(request.srcAsset);
1206
- const destAsset = getInternalAsset(request.destAsset);
1207
- if (![srcAsset, destAsset].every(
1208
- (asset2) => assets2.find((a) => a.asset === asset2)?.livePriceProtectionEnabled
1209
- )) {
1210
- return;
1211
- }
1212
- if (isNotNullish(request.fillOrKillParams.maxOraclePriceSlippage)) return;
1213
- throw new Error(
1214
- "Max oracle price slippage must be set in FillOrKillParams when live price protection is enabled for both assets in DCA V2"
1215
- );
1216
- }
1217
- async calculateLivePriceSlippageTolerancePercent(slippageTolerancePercent, brokerCommissionBpsInput, quote) {
1218
- assert(slippageTolerancePercent >= 0, "slippageTolerancePercent must be non-negative");
1219
- assert(
1220
- brokerCommissionBpsInput === void 0 || brokerCommissionBpsInput >= 0,
1221
- "brokerCommissionBps must be non-negative"
1222
- );
1223
- const brokerCommissionBps = await this.getCommissionBps(brokerCommissionBpsInput);
1224
- const { assets: assets2 } = await this.cache.read("networkInfo");
1225
- const srcAsset = getInternalAsset(quote.srcAsset);
1226
- const destAsset = getInternalAsset(quote.destAsset);
1227
- if (![srcAsset, destAsset].every(
1228
- (asset2) => assets2.find((a) => a.asset === asset2)?.livePriceProtectionEnabled
1229
- )) {
1230
- return false;
1231
- }
1232
- const env = await this.getStateChainEnvironment();
1233
- const networkFeeRates = env.swapping.networkFees[quote.isOnChain ? "internalSwapNetworkFee" : "regularNetworkFee"].rates;
1234
- const networkFeeBps = Math.max(
1235
- Number(readAssetValue(networkFeeRates, srcAsset)),
1236
- Number(readAssetValue(networkFeeRates, destAsset))
1237
- ) / 100;
1238
- return slippageTolerancePercent + networkFeeBps / 100 + brokerCommissionBps / 100;
1239
- }
1240
1227
  };
1241
1228
  var arrayToMap = (array) => Object.fromEntries(array.map((item) => [item, item]));
1242
1229
  var ChainflipNetworks = arrayToMap(chainflipNetworks);
1243
- var InternalAssets = arrayToMap(chainflipAssets.filter((asset2) => asset2 !== "Dot"));
1244
- var Chains = arrayToMap(chainflipChains.filter((chain2) => chain2 !== "Polkadot"));
1230
+ var InternalAssets = arrayToMap(chainflipAssets);
1231
+ var Chains = arrayToMap(chainflipChains);
1245
1232
  var Assets = arrayToMap(assetSymbols);
1246
1233
 
1247
1234
  export { Assets, InternalAssets as ChainflipIds, ChainflipNetworks, Chains, SwapSDK };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@chainflip/sdk",
3
- "version": "2.1.0-dev.0",
3
+ "version": "2.1.1",
4
4
  "description": "",
5
5
  "exports": {
6
6
  "./swap": {
@@ -56,10 +56,10 @@
56
56
  "access": "public"
57
57
  },
58
58
  "dependencies": {
59
- "@chainflip/bitcoin": "2.1.0-beta.1",
60
- "@chainflip/rpc": "2.1.0-beta.1",
61
- "@chainflip/solana": "2.2.1-beta.0",
62
- "@chainflip/utils": "2.1.0-beta.1",
59
+ "@chainflip/bitcoin": "2.1.1",
60
+ "@chainflip/rpc": "2.1.3",
61
+ "@chainflip/solana": "2.2.2",
62
+ "@chainflip/utils": "2.1.4",
63
63
  "@ts-rest/core": "^3.52.1",
64
64
  "axios": "^1.10.0",
65
65
  "bignumber.js": "^9.3.0",
@@ -67,7 +67,6 @@
67
67
  "zod": "^3.25.76"
68
68
  },
69
69
  "devDependencies": {
70
- "@trpc/server": "^10.45.2",
71
70
  "tsup": "^8.5.0"
72
71
  },
73
72
  "scripts": {