@velora-dex/sdk 9.5.0 → 9.5.2-dev.0

package/dist/sdk.cjs.development.js

@@ -3627,7 +3627,7 @@ function _resolvePartnerFee() {
         case 0:
           // externally supplied partner fee data takes precedence
           partnerAddress = options.partnerAddress;
-          partnerFeeBps = (_options$partnerFeeBp = options.partnerFeeBps) != null ? _options$partnerFeeBp : options.deltaPrice.partnerFee ? options.deltaPrice.partnerFee * 100 : undefined;
+          partnerFeeBps = (_options$partnerFeeBp = options.partnerFeeBps) != null ? _options$partnerFeeBp : options.deltaPrice.partnerFee !== undefined ? options.deltaPrice.partnerFee * 100 : undefined;
           partnerTakesSurplus = options.partnerTakesSurplus; // if fee given, takeSurplus is ignored
           feeOrTakeSurplusSupplied = partnerFeeBps !== undefined || partnerTakesSurplus !== undefined;
           if (!(partnerAddress === undefined || feeOrTakeSurplusSupplied)) {
@@ -6837,6 +6837,467 @@ function constructSimpleContractCaller(providerOptions) {
   };
 }
 
+var _OrderKindToSwapSide;
+///// CHECKS //////
+/**
+ * @description Checks whether an order is a TWAP Sell or TWAP Buy order.
+ */
+function isTWAPOrder(order) {
+  return 'numSlices' in order && typeof order.numSlices === 'number';
+}
+/**
+ * @description Checks whether an order is a TWAP Sell order.
+ */
+function isTWAPSellOrder(order) {
+  return isTWAPOrder(order) && 'totalSrcAmount' in order && typeof order.totalSrcAmount === 'string';
+}
+/**
+ * @description Checks whether an order is a TWAP Buy order.
+ */
+function isTWAPBuyOrder(order) {
+  return isTWAPOrder(order) && 'totalDestAmount' in order && typeof order.totalDestAmount === 'string';
+}
+/**
+ * @description Checks whether an order is an External order.
+ */
+function isExternalOrder(order) {
+  return 'handler' in order;
+}
+/**
+ * @description Checks whether an order is a regular Delta auction order.
+ */
+function isDeltaOrder(order) {
+  return !isExternalOrder(order) && 'kind' in order && typeof order.kind === 'number';
+}
+/**
+ * @description Checks whether an auction is a TWAP auction.
+ */
+function isTWAPAuction(auction) {
+  return isTWAPSellAuction(auction) || isTWAPBuyAuction(auction);
+}
+/**
+ * @description Checks whether an auction is a TWAP Sell auction.
+ */
+function isTWAPSellAuction(auction) {
+  return auction.onChainOrderType === 'TWAPOrder';
+}
+/**
+ * @description Checks whether an auction is a TWAP Buy auction.
+ */
+function isTWAPBuyAuction(auction) {
+  return auction.onChainOrderType === 'TWAPBuyOrder';
+}
+/**
+ * @description Checks whether an auction is a Delta auction.
+ */
+function isDeltaAuction(auction) {
+  return auction.onChainOrderType === 'Order';
+}
+/**
+ * @description Checks whether an auction is an External auction.
+ */
+function isExternalAuction(auction) {
+  return auction.onChainOrderType === 'ExternalOrder';
+}
+var checks = {
+  isTWAPOrder: isTWAPOrder,
+  isTWAPSellOrder: isTWAPSellOrder,
+  isTWAPBuyOrder: isTWAPBuyOrder,
+  isExternalOrder: isExternalOrder,
+  isDeltaOrder: isDeltaOrder,
+  isTWAPAuction: isTWAPAuction,
+  isTWAPSellAuction: isTWAPSellAuction,
+  isTWAPBuyAuction: isTWAPBuyAuction,
+  isDeltaAuction: isDeltaAuction,
+  isExternalAuction: isExternalAuction,
+  isOrderCrosschain: isOrderCrosschain,
+  isExecutedAuction: isExecutedAuction,
+  isPartiallyExecutedAuction: isPartiallyExecutedAuction,
+  isFailedAuction: isFailedAuction,
+  isCanceledAuction: isCanceledAuction,
+  isExpiredAuction: isExpiredAuction,
+  isPendingAuction: isPendingAuction
+};
+///// GETTERS //////
+/**
+ * @description Returns the expected source amount for a TWAP order.
+ */
+function getExpectedTwapSrcAmount(order) {
+  if ('totalSrcAmount' in order) {
+    // SELL
+    return order.totalSrcAmount;
+  }
+  return order.maxSrcAmount; // BUY
+}
+/**
+ * @description Returns the expected destination amount for a TWAP order.
+ */
+function getExpectedTwapDestAmount(order) {
+  var destAmount = 'destAmountPerSlice' in order ? BigInt(order.destAmountPerSlice) * BigInt(order.numSlices) // SELL
+  : BigInt(order.totalDestAmount); // BUY
+  if (isOrderCrosschain(order)) {
+    return scaleByFactor(destAmount, order.bridge.scalingFactor).toString();
+  }
+  return destAmount.toString();
+}
+/**
+ * @description Returns expected source and destination amounts for a TWAP order.
+ */
+function getExpectedTwapOrderAmounts(order) {
+  var srcAmount = getExpectedTwapSrcAmount(order);
+  var destAmount = getExpectedTwapDestAmount(order);
+  return {
+    srcAmount: srcAmount,
+    destAmount: destAmount
+  };
+}
+/**
+ * @description Returns expected and, when available, final amounts for a TWAP auction.
+ */
+function getTwapAuctionAmounts(twapAuction) {
+  var isExecuted = isExecutedAuction(twapAuction);
+  var expected = getExpectedTwapOrderAmounts(twapAuction.order);
+  if (isExecuted) {
+    var _final = getTransactionAmounts(twapAuction.transactions);
+    return {
+      "final": _final,
+      expected: expected
+    };
+  }
+  return {
+    expected: expected
+  };
+}
+var getters = {
+  getUnifiedDeltaOrderData: getUnifiedDeltaOrderData,
+  getExpectedTwapSrcAmount: getExpectedTwapSrcAmount,
+  getExpectedTwapDestAmount: getExpectedTwapDestAmount,
+  getExpectedTwapOrderAmounts: getExpectedTwapOrderAmounts,
+  getTwapAuctionAmounts: getTwapAuctionAmounts,
+  getAuctionDestChainId: getAuctionDestChainId,
+  getSwapSideFromDeltaOrder: getSwapSideFromDeltaOrder,
+  getSwapSideFromTwapOrderType: getSwapSideFromTwapOrderType,
+  getAuctionSwapSide: getAuctionSwapSide,
+  getOrderTokenAddresses: getOrderTokenAddresses,
+  getTransactionAmounts: getTransactionAmounts,
+  getAuctionAmounts: getAuctionAmounts,
+  getFilledPercent: getFilledPercent
+};
+var OrderHelpers = {
+  checks: checks,
+  getters: getters
+};
+// -------------------- Auction Unified Data --------------------
+/**
+ * @description Returns the destination chain id for the auction.
+ */
+function getAuctionDestChainId(_ref) {
+  var order = _ref.order,
+    chainId = _ref.chainId;
+  return isOrderCrosschain(order) ? order.bridge.destinationChainId : chainId;
+}
+var OrderKindToSwapSide = (_OrderKindToSwapSide = {}, _OrderKindToSwapSide[OrderKind.Sell] = 'SELL', _OrderKindToSwapSide[OrderKind.Buy] = 'BUY', _OrderKindToSwapSide);
+/**
+ * @description Returns swap side from a Delta or External order kind.
+ */
+function getSwapSideFromDeltaOrder(order) {
+  return OrderKindToSwapSide[order.kind];
+}
+var TwapTypeToSwapSide = {
+  TWAPOrder: 'SELL',
+  TWAPBuyOrder: 'BUY'
+};
+/**
+ * @description Returns swap side from TWAP on-chain order type.
+ */
+function getSwapSideFromTwapOrderType(onChainOrderType) {
+  return TwapTypeToSwapSide[onChainOrderType];
+}
+/**
+ * @description Returns swap side for any auction type.
+ */
+function getAuctionSwapSide(auction) {
+  if (isTWAPAuction(auction)) {
+    // TWAP orders have onChainOrderType instead of kind
+    return getSwapSideFromTwapOrderType(auction.onChainOrderType);
+  }
+  return getSwapSideFromDeltaOrder(auction.order);
+}
+/**
+ * @description Returns unified order data with normalized amounts, tokens, and side.
+ */
+function getUnifiedDeltaOrderData(auction) {
+  var order = auction.order,
+    chainId = auction.chainId;
+  var _getOrderTokenAddress = getOrderTokenAddresses(order),
+    srcToken = _getOrderTokenAddress.srcToken,
+    destToken = _getOrderTokenAddress.destToken;
+  var _getAuctionAmounts = getAuctionAmounts(auction),
+    expected = _getAuctionAmounts.expected,
+    _final2 = _getAuctionAmounts["final"];
+  var srcChainId = chainId;
+  var destChainId = getAuctionDestChainId({
+    order: order,
+    chainId: chainId
+  });
+  var swapSide = getAuctionSwapSide(auction);
+  var filledPercent = getFilledPercent(auction);
+  return {
+    srcChainId: srcChainId,
+    destChainId: destChainId,
+    srcAmount: (_final2 == null ? void 0 : _final2.srcAmount) || expected.srcAmount,
+    destAmount: (_final2 == null ? void 0 : _final2.destAmount) || expected.destAmount,
+    amounts: {
+      expected: expected,
+      "final": _final2
+    },
+    srcToken: srcToken,
+    destToken: destToken,
+    swapSide: swapSide,
+    filledPercent: filledPercent
+  };
+}
+/**
+ * @description Returns source and destination token addresses for an order.
+ */
+function getOrderTokenAddresses(order) {
+  var srcToken = order.srcToken;
+  var destToken = isOrderCrosschain(order) ? order.bridge.outputToken : order.destToken;
+  return {
+    srcToken: srcToken,
+    destToken: destToken
+  };
+}
+/**
+ * @description Aggregates transaction amounts into total source and destination values.
+ */
+function getTransactionAmounts(transactions) {
+  var _transactions$reduce = transactions.reduce(function (acc, _ref2) {
+      var spentAmount = _ref2.spentAmount,
+        receivedAmount = _ref2.receivedAmount,
+        bridgeMetadata = _ref2.bridgeMetadata;
+      return {
+        srcAmount: acc.srcAmount + BigInt(spentAmount),
+        destAmount: acc.destAmount + BigInt(bridgeMetadata ? bridgeMetadata.outputAmount : receivedAmount)
+      };
+    }, {
+      srcAmount: 0n,
+      destAmount: 0n
+    }),
+    srcAmount = _transactions$reduce.srcAmount,
+    destAmount = _transactions$reduce.destAmount;
+  return {
+    srcAmount: srcAmount.toString(),
+    destAmount: destAmount.toString()
+  };
+}
+/**
+ * @description Returns expected and, when available, final amounts for an auction.
+ */
+function getAuctionAmounts(auction) {
+  var isTwap = checks.isTWAPAuction(auction);
+  if (isTwap) {
+    return getTwapAuctionAmounts(auction);
+  }
+  var expected = {
+    srcAmount: auction.order.srcAmount,
+    destAmount: auction.order.expectedAmount || auction.order.destAmount
+  };
+  var order = auction.order;
+  if (isOrderCrosschain(order)) {
+    expected = {
+      srcAmount: expected.srcAmount,
+      destAmount: scaleByFactor(BigInt(expected.destAmount), order.bridge.scalingFactor).toString()
+    };
+  }
+  var isExecuted = isExecutedAuction(auction);
+  if (isExecuted) {
+    var _final3 = getTransactionAmounts(auction.transactions);
+    return {
+      "final": _final3,
+      expected: expected
+    };
+  }
+  return {
+    expected: expected
+  };
+}
+/**
+ * @description Checks whether an order includes valid cross-chain bridge details.
+ */
+function isOrderCrosschain(order
+// Extract<ExternalOrder, { bridge?: Bridge }> == never
+) {
+  return 'bridge' in order && !!order.bridge && order.bridge.destinationChainId !== 0;
+}
+function scaleByFactor(amount, scalingFactor) {
+  if (!amount) return 0n;
+  if (scalingFactor === undefined) return amount;
+  var base = 10n;
+  return scalingFactor < 0 ? amount / Math.pow(base, BigInt(-scalingFactor)) : amount * Math.pow(base, BigInt(scalingFactor));
+}
+/**
+ * @description Checks whether an auction is fully executed.
+ */
+function isExecutedAuction(auction) {
+  if (auction.status !== 'EXECUTED') return false;
+  if (isOrderCrosschain(auction.order)) {
+    var filledPercent = getFilledPercent(auction);
+    return filledPercent === 100;
+  }
+  return true;
+}
+var failedAuctionStatuses = ['FAILED', 'EXPIRED', 'CANCELLED', 'REFUNDED'];
+var failedAuctionStatusesSet = /*#__PURE__*/new Set(failedAuctionStatuses);
+/**
+ * @description Checks whether an auction is failed on source or destination chain.
+ */
+function isFailedAuction(auction) {
+  // already failed on srcChain, whether Order is crosschain or not
+  if (failedAuctionStatusesSet.has(auction.status)) return true;
+  // crosschain Order is executed on srcChain, but failed on destChain
+  if (auction.status === 'EXECUTED' && isOrderCrosschain(auction.order)) {
+    return auction.bridgeStatus === 'expired' || auction.bridgeStatus === 'refunded';
+  }
+  return false;
+}
+/**
+ * @description Checks whether an auction status is cancelled.
+ */
+function isCanceledAuction(auction) {
+  return auction.status === 'CANCELLED';
+}
+/**
+ * @description Checks whether an auction status is expired.
+ */
+function isExpiredAuction(auction) {
+  return auction.status === 'EXPIRED';
+}
+var pendingAuctionStatuses = ['NOT_STARTED', 'AWAITING_PRE_SIGNATURE', 'RUNNING', 'EXECUTING'];
+var pendingAuctionStatusesSet = /*#__PURE__*/new Set(pendingAuctionStatuses);
+/**
+ * @description Checks whether an auction status is in pending execution states.
+ */
+function isPendingAuction(auction) {
+  return pendingAuctionStatusesSet.has(auction.status);
+}
+/**
+ * @description Auction can be cancelled in the middle of execution,
+ * or crosschain-TWAP slices may not all be bridged,
+ * or order can be suspended if it runs out of user balance/allowance.
+ * Orders in the middle of normal execution can also be considered partially executed if they have any transactions.
+ */
+function isPartiallyExecutedAuction(auction) {
+  if (auction.transactions.length === 0) return false;
+  var filledPercent = getFilledPercent(auction);
+  return filledPercent > 0 && filledPercent < 100;
+}
+/**
+ * @description Calculates filled percentage from auction transaction filled bps values.
+ */
+function getFilledPercent(auction) {
+  var transaction = !isOrderCrosschain(auction.order) ? auction.transactions : auction.transactions.filter(function (transaction) {
+    return transaction.bridgeStatus === 'filled';
+  });
+  var filledPercentBps = transaction.reduce(function (acc, _ref3) {
+    var filledPercent = _ref3.filledPercent;
+    return acc + filledPercent;
+  }, 0);
+  var filledPercent = filledPercentBps / 100;
+  return filledPercent;
+}
+///// TESTS //////
+// @TODO remove
+var auction = {};
+var minAuction = {
+  onChainOrderType: 'TWAPOrder',
+  gas: 6
+};
+if (isTWAPAuction(minAuction)) {
+  console.log('🚀 ~ auction:', minAuction);
+  /**
+   * {
+    onChainOrderType: OnChainOrderType;
+    gas: number;
+    } & {
+        onChainOrderType: "TWAPOrder" | "TWAPBuyOrder";
+    }
+   */
+}
+if (isTWAPAuction(auction)) {
+  console.log('🚀 ~ auction:', auction);
+  /**
+   (DeltaAuctionBase & {
+      onChainOrderType: "TWAPOrder";
+      order: TWAPDeltaOrder;
+    }) | (DeltaAuctionBase & {
+        onChainOrderType: "TWAPBuyOrder";
+        order: TWAPBuyDeltaOrder;
+    })
+   */
+}
+if (isTWAPSellAuction(auction)) {
+  console.log('🚀 ~ auction:', auction);
+  /**
+   * DeltaAuctionBase & {
+      onChainOrderType: "TWAPOrder";
+      order: TWAPDeltaOrder;
+    }
+   */
+}
+if (isTWAPBuyAuction(auction)) {
+  console.log('🚀 ~ auction:', auction);
+  /**
+   * DeltaAuctionBase & {
+      onChainOrderType: "TWAPBuyOrder";
+      order: TWAPBuyDeltaOrder;
+    }
+   */
+}
+if (isDeltaAuction(auction)) {
+  console.log('🚀 ~ auction:', auction);
+  /**
+   * DeltaAuctionBase & {
+      onChainOrderType: "Order";
+      order: DeltaAuctionOrder;
+    }
+   */
+}
+if (isExternalAuction(auction)) {
+  console.log('🚀 ~ auction:', auction);
+  /**
+   * DeltaAuctionBase & {
+      onChainOrderType: "ExternalOrder";
+      order: ExternalDeltaOrder;
+    }
+   */
+}
+// ------------------------------------------------------------ //
+var orderAny = {};
+if (isOrderCrosschain(orderAny)) {
+  console.log('🚀 ~ order:', orderAny);
+  /**
+    DeltaAuctionOrder | TWAPDeltaOrder | TWAPBuyDeltaOrder
+   */
+}
+var orderExternal = {};
+if (isOrderCrosschain(orderExternal)) {
+  console.log('🚀 ~ order:', orderExternal);
+  /**
+    never
+   */
+}
+var orderLike = {};
+if (isOrderCrosschain(orderLike)) {
+  console.log('🚀 ~ order:', orderLike);
+  /**
+   * {
+      bridge: Bridge;
+      a: 2;
+    }
+   */
+}
+
 Object.defineProperty(exports, 'ContractMethod', {
   enumerable: true,
   get: function () { return core.ContractMethod; }
@@ -6856,6 +7317,7 @@ Object.defineProperty(exports, 'SwapSide', {
 exports.API_URL = API_URL;
 exports.AssetType = AssetType;
 exports.DEFAULT_VERSION = DEFAULT_VERSION;
+exports.OrderHelpers = OrderHelpers;
 exports.constructAllDeltaOrdersHandlers = constructAllDeltaOrdersHandlers;
 exports.constructAllLimitOrdersHandlers = constructAllLimitOrdersHandlers;
 exports.constructAllNFTOrdersHandlers = constructAllNFTOrdersHandlers;