@velora-dex/sdk 9.4.2 → 9.4.3-dev.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@velora-dex/sdk",
-  "version": "9.4.2",
+  "version": "9.4.3-dev.1",
   "main": "dist/index.js",
   "module": "dist/sdk.esm.js",
   "typings": "dist/index.d.ts",

package/src/index.ts

@@ -141,12 +141,20 @@ import type {
   DeltaAuctionOrder,
   DeltaAuction,
   DeltaAuctionStatus,
+  DeltaAuctionTransaction,
   BridgeMetadata,
   BridgeStatus,
   Bridge,
   ExternalDeltaOrder,
+  TWAPDeltaOrder,
+  TWAPBuyDeltaOrder,
+  TWAPOnChainOrderType,
   OnChainOrderType,
   SwapSideUnion,
+  DeltaAmountsWithSlippage,
+  DeltaAmountsSellSlippage,
+  DeltaAmountsBuySlippage,
+  DeltaAmountsExplicit,
 } from './methods/delta/helpers/types';
 import {
   BuildDeltaOrderDataParams,
@@ -156,6 +164,7 @@ import {
 } from './methods/delta/buildDeltaOrder';
 import {
   constructPostDeltaOrder,
+  DeltaOrderToPost,
   PostDeltaOrderFunctions,
   PostDeltaOrderParams,
 } from './methods/delta/postDeltaOrder';
@@ -224,6 +233,28 @@ import {
   PreSignExternalDeltaOrderFunctions,
 } from './methods/delta/preSignExternalDeltaOrder';
 
+import {
+  BuildTWAPDeltaOrderParams,
+  BuildTWAPSellOrderParams,
+  BuildTWAPBuyOrderParams,
+  BuildTWAPDeltaOrderFunctions,
+  constructBuildTWAPDeltaOrder,
+} from './methods/delta/buildTWAPDeltaOrder';
+import type { SignableTWAPOrderData } from './methods/delta/helpers/buildTWAPOrderData';
+import {
+  constructSignTWAPDeltaOrder,
+  SignTWAPDeltaOrderFunctions,
+} from './methods/delta/signTWAPDeltaOrder';
+import {
+  constructPostTWAPDeltaOrder,
+  PostTWAPDeltaOrderFunctions,
+  PostTWAPDeltaOrderParams,
+} from './methods/delta/postTWAPDeltaOrder';
+import {
+  constructPreSignTWAPDeltaOrder,
+  PreSignTWAPDeltaOrderFunctions,
+} from './methods/delta/preSignTWAPDeltaOrder';
+
 import {
   constructGetQuote,
   GetQuoteFunctions,
@@ -244,6 +275,10 @@ import {
   DepositNativeAndPreSignParams,
   DepositNativeAndPreSignDeltaOrderParams,
 } from './methods/delta/deltaTokenModule';
+import {
+  CancelDeltaOrderData,
+  SignableCancelDeltaOrderData,
+} from './methods/delta/helpers/buildCancelDeltaOrderData';
 
 export { constructSwapSDK, SwapSDKMethods } from './methods/swap';
 
@@ -257,9 +292,11 @@ export {
   constructAllDeltaOrdersHandlers,
   constructSubmitDeltaOrder,
   constructSubmitExternalDeltaOrder,
+  constructSubmitTWAPDeltaOrder,
   DeltaOrderHandlers,
   SubmitDeltaOrderParams,
   SubmitExternalDeltaOrderParams,
+  SubmitTWAPDeltaOrderParams,
 } from './methods/delta';
 
 export type {
@@ -337,6 +374,11 @@ export {
   constructSignExternalDeltaOrder,
   constructPostExternalDeltaOrder,
   constructPreSignExternalDeltaOrder,
+  // TWAP Delta methods
+  constructBuildTWAPDeltaOrder,
+  constructSignTWAPDeltaOrder,
+  constructPostTWAPDeltaOrder,
+  constructPreSignTWAPDeltaOrder,
   // Quote methods
   constructGetQuote,
   // different helpers
@@ -409,8 +451,11 @@ export type {
   DeltaAuctionOrder,
   DeltaAuction,
   DeltaAuctionStatus,
+  DeltaAuctionTransaction,
   DeltaOrderFilterByStatus,
   DeltaOrderFromAPI,
+  CancelDeltaOrderData,
+  SignableCancelDeltaOrderData,
   // bridge part of DeltaOrder
   BridgeMetadata,
   BridgeStatus,
@@ -421,6 +466,7 @@ export type {
   BuildDeltaOrderDataParams,
   BuildDeltaOrderFunctions,
   SignableDeltaOrderData,
+  DeltaOrderToPost,
   PostDeltaOrderFunctions,
   PostDeltaOrderParams,
   SignDeltaOrderFunctions,
@@ -436,7 +482,14 @@ export type {
   DepositNativeAndPreSignDeltaOrderParams,
   // External Delta types
   ExternalDeltaOrder,
+  TWAPDeltaOrder,
+  TWAPBuyDeltaOrder,
+  TWAPOnChainOrderType,
   OnChainOrderType,
+  DeltaAmountsWithSlippage,
+  DeltaAmountsSellSlippage,
+  DeltaAmountsBuySlippage,
+  DeltaAmountsExplicit,
   SignableExternalOrderData,
   BuildExternalDeltaOrderParams,
   BuildExternalDeltaOrderFunctions,
@@ -444,6 +497,16 @@ export type {
   PostExternalDeltaOrderFunctions,
   PostExternalDeltaOrderParams,
   PreSignExternalDeltaOrderFunctions,
+  // TWAP Delta types
+  BuildTWAPDeltaOrderParams,
+  BuildTWAPSellOrderParams,
+  BuildTWAPBuyOrderParams,
+  BuildTWAPDeltaOrderFunctions,
+  SignableTWAPOrderData,
+  SignTWAPDeltaOrderFunctions,
+  PostTWAPDeltaOrderFunctions,
+  PostTWAPDeltaOrderParams,
+  PreSignTWAPDeltaOrderFunctions,
   // types for Quote methods
   GetQuoteFunctions,
   QuoteParams,

package/src/methods/delta/buildDeltaOrder.ts

@@ -7,7 +7,7 @@ import {
   type BuildDeltaOrderDataInput,
   type SignableDeltaOrderData,
 } from './helpers/buildDeltaOrderData';
-import type { AmountsWithSlippage } from './helpers/types';
+import type { DeltaAmountsWithSlippage } from './helpers/types';
 import { SwapSideToOrderKind } from './helpers/types';
 import { resolvePartnerFee, resolveAmounts } from './helpers/misc';
 import type { MarkOptional } from 'ts-essentials';
@@ -63,7 +63,7 @@ type BuildDeltaOrderDataParamsBase = {
 };
 
 export type BuildDeltaOrderDataParams = BuildDeltaOrderDataParamsBase &
-  AmountsWithSlippage;
+  DeltaAmountsWithSlippage;
 
 type BuildDeltaOrder = (
   buildOrderParams: BuildDeltaOrderDataParams,

package/src/methods/delta/buildExternalDeltaOrder.ts

@@ -7,7 +7,7 @@ import {
   type BuildExternalOrderDataInput,
   type SignableExternalOrderData,
 } from './helpers/buildExternalOrderData';
-import type { AmountsWithSlippage } from './helpers/types';
+import type { DeltaAmountsWithSlippage } from './helpers/types';
 import { SwapSideToOrderKind } from './helpers/types';
 import type { MarkOptional } from 'ts-essentials';
 import { resolvePartnerFee, resolveAmounts } from './helpers/misc';
@@ -54,7 +54,7 @@ type BuildExternalDeltaOrderParamsBase = {
 };
 
 export type BuildExternalDeltaOrderParams = BuildExternalDeltaOrderParamsBase &
-  AmountsWithSlippage;
+  DeltaAmountsWithSlippage;
 
 type BuildExternalDeltaOrder = (
   buildOrderParams: BuildExternalDeltaOrderParams,

package/src/methods/delta/buildTWAPDeltaOrder.ts

@@ -0,0 +1,187 @@
+import type { ConstructFetchInput, RequestParameters } from '../../types';
+import { DEFAULT_BRIDGE } from './constants';
+import { constructGetDeltaContract } from './getDeltaContract';
+import type { BridgePrice } from './getDeltaPrice';
+import { constructGetPartnerFee } from './getPartnerFee';
+import {
+  buildTWAPSignableOrderData,
+  TWAPOrderCommonInput,
+  type BuildTWAPOrderDataInput,
+  type SignableTWAPOrderData,
+} from './helpers/buildTWAPOrderData';
+import { applySlippage, resolvePartnerFee } from './helpers/misc';
+import type { MarkOptional } from 'ts-essentials';
+export type { SignableTWAPOrderData } from './helpers/buildTWAPOrderData';
+
+type BuildTWAPDeltaOrderParamsBase = {
+  /** @description The address of the order owner */
+  owner: string;
+  /** @description The address of the order beneficiary */
+  beneficiary?: string;
+  /** @description The address of the src token */
+  srcToken: string;
+  /** @description The address of the dest token. For Crosschain Order - destination token on the destination chain */
+  destToken: string;
+  /** @description The deadline for the order */
+  deadline?: number;
+  /** @description The nonce of the order */
+  nonce?: number | string;
+  /** @description Optional permit signature for the src token */
+  permit?: string;
+  /** @description Partner string */
+  partner?: string;
+  /** @description Destination Chain ID for Crosschain Orders */
+  destChainId?: number;
+  /** @description Seconds between slice executions (min 60) */
+  interval: number;
+  /** @description Number of slices (min 2) */
+  numSlices: number;
+  /** @description Slippage in basis points (bps). 10000 = 100%, 50 = 0.5% */
+  slippage?: number;
+
+  /** @description price response received from /delta/prices (getDeltaPrice method) for a single slice */
+  deltaPrice: MarkOptional<
+    Pick<
+      BridgePrice,
+      | 'destAmount'
+      | 'partner'
+      | 'partnerFee'
+      | 'destToken'
+      | 'srcAmount'
+      | 'bridge'
+    >,
+    'partner' | 'partnerFee'
+  >;
+
+  /** @description partner fee in basis points (bps), 50bps=0.5% */
+  partnerFeeBps?: number;
+  /** @description partner address */
+  partnerAddress?: string;
+  /** @description take surplus */
+  partnerTakesSurplus?: boolean;
+  /** @description A boolean indicating whether the surplus should be capped. True by default */
+  capSurplus?: boolean;
+  /** @description Metadata for the order, hex string */
+  metadata?: string;
+};
+
+export type BuildTWAPSellOrderParams = BuildTWAPDeltaOrderParamsBase & {
+  /** @description Must be "TWAPOrder" for sell orders */
+  onChainOrderType: 'TWAPOrder';
+  /** @description Total source token amount across all slices */
+  totalSrcAmount: string;
+};
+
+export type BuildTWAPBuyOrderParams = BuildTWAPDeltaOrderParamsBase & {
+  /** @description Must be "TWAPBuyOrder" for buy orders */
+  onChainOrderType: 'TWAPBuyOrder';
+  /** @description Total destination token amount to buy across all slices */
+  totalDestAmount: string;
+  /** @description Maximum source token amount willing to spend */
+  maxSrcAmount: string;
+};
+
+export type BuildTWAPDeltaOrderParams =
+  | BuildTWAPSellOrderParams
+  | BuildTWAPBuyOrderParams;
+
+type BuildTWAPDeltaOrder = (
+  buildOrderParams: BuildTWAPDeltaOrderParams,
+  requestParams?: RequestParameters
+) => Promise<SignableTWAPOrderData>;
+
+export type BuildTWAPDeltaOrderFunctions = {
+  /** @description Build TWAP Orders (sell or buy) to be posted to Delta API for execution */
+  buildTWAPDeltaOrder: BuildTWAPDeltaOrder;
+};
+
+export const constructBuildTWAPDeltaOrder = (
+  options: ConstructFetchInput
+): BuildTWAPDeltaOrderFunctions => {
+  const { chainId } = options;
+
+  const { getDeltaContract } = constructGetDeltaContract(options);
+  const { getPartnerFee } = constructGetPartnerFee(options);
+
+  const buildTWAPDeltaOrder: BuildTWAPDeltaOrder = async (
+    params,
+    requestParams
+  ) => {
+    const ParaswapDelta = await getDeltaContract(requestParams);
+    if (!ParaswapDelta) {
+      throw new Error(`Delta is not available on chain ${chainId}`);
+    }
+
+    const { partnerAddress, partnerFeeBps, partnerTakesSurplus } =
+      await resolvePartnerFee(params, getPartnerFee, requestParams);
+
+    const commonInput: TWAPOrderCommonInput = {
+      owner: params.owner,
+      beneficiary: params.beneficiary,
+      srcToken: params.srcToken,
+      destToken: params.deltaPrice.destToken,
+      deadline: params.deadline,
+      nonce: params.nonce?.toString(10),
+      permit: params.permit,
+      metadata: params.metadata,
+      interval: params.interval,
+      numSlices: params.numSlices,
+      bridge: {
+        ...params.deltaPrice.bridge,
+        // TWAP child orders get their bridge data at execution time
+        protocolData: DEFAULT_BRIDGE.protocolData,
+      },
+
+      chainId,
+      paraswapDeltaAddress: ParaswapDelta,
+      partnerAddress,
+      partnerTakesSurplus,
+      partnerFeeBps,
+      capSurplus: params.capSurplus,
+    };
+
+    let input: BuildTWAPOrderDataInput;
+
+    if (params.onChainOrderType === 'TWAPOrder') {
+      const slippage = params.slippage ?? 0;
+      const destAmountPerSlice =
+        slippage > 0
+          ? applySlippage({
+              amount: params.deltaPrice.destAmount,
+              slippageBps: slippage,
+              increase: false,
+            })
+          : params.deltaPrice.destAmount;
+
+      input = {
+        ...commonInput,
+        onChainOrderType: 'TWAPOrder',
+        destAmountPerSlice,
+        totalSrcAmount: params.totalSrcAmount,
+      };
+    } else {
+      const slippage = params.slippage ?? 0;
+      const maxSrcAmount =
+        slippage > 0
+          ? applySlippage({
+              amount: params.maxSrcAmount,
+              slippageBps: slippage,
+              increase: true,
+            })
+          : params.maxSrcAmount;
+
+      input = {
+        ...commonInput,
+        onChainOrderType: 'TWAPBuyOrder',
+        totalDestAmount: params.totalDestAmount,
+        maxSrcAmount,
+      };
+    }
+
+    return buildTWAPSignableOrderData(input);
+  };
+
+  return {
+    buildTWAPDeltaOrder,
+  };
+};

package/src/methods/delta/deltaTokenModule.ts

@@ -8,7 +8,11 @@ import { sanitizeDeltaOrderData } from './helpers/misc';
 import { SignableDeltaOrderData } from './helpers/buildDeltaOrderData';
 import { produceDeltaOrderHash } from './preSignDeltaOrder';
 import type { ExtractAbiMethodNames } from '../../helpers/misc';
-import type { DeltaAuctionOrder } from './helpers/types';
+import type {
+  DeltaAuctionOrder,
+  TWAPDeltaOrder,
+  TWAPBuyDeltaOrder,
+} from './helpers/types';
 import { DEFAULT_BRIDGE } from './constants';
 
 export type CancelAndWithdrawDeltaOrderParams = {
@@ -41,6 +45,18 @@ export type DepositNativeAndPreSign<T> = (
   requestParams?: RequestParameters
 ) => Promise<T>;
 
+export type CancelTWAPAndWithdrawDeltaOrder<T> = (
+  order: TWAPDeltaOrder,
+  overrides?: TxSendOverrides,
+  requestParams?: RequestParameters
+) => Promise<T>;
+
+export type CancelTWAPBuyAndWithdrawDeltaOrder<T> = (
+  order: TWAPBuyDeltaOrder,
+  overrides?: TxSendOverrides,
+  requestParams?: RequestParameters
+) => Promise<T>;
+
 export type DepositNativeAndPreSignDeltaOrderParams = Pick<
   DepositNativeAndPreSignParams,
   'depositAmount'
@@ -63,6 +79,10 @@ export type DeltaTokenModuleFunctions<T> = {
   depositNativeAndPreSign: DepositNativeAndPreSign<T>;
   /** @description Deposit native ETH and pre-sign a Delta order from signable order data */
   depositNativeAndPreSignDeltaOrder: DepositNativeAndPreSignDeltaOrder<T>;
+  /** @description Cancel a TWAP sell order on-chain and withdraw native ETH back to the owner */
+  cancelTWAPAndWithdrawDeltaOrder: CancelTWAPAndWithdrawDeltaOrder<T>;
+  /** @description Cancel a TWAP buy order on-chain and withdraw native ETH back to the owner */
+  cancelTWAPBuyAndWithdrawDeltaOrder: CancelTWAPBuyAndWithdrawDeltaOrder<T>;
 };
 
 const DeltaTokenModuleAbi = [
@@ -217,6 +237,174 @@ const DeltaTokenModuleAbi = [
     outputs: [],
     stateMutability: 'nonpayable',
   },
+  {
+    type: 'function',
+    name: 'cancelTWAPAndWithdraw',
+    inputs: [
+      {
+        name: 'order',
+        type: 'tuple',
+        internalType: 'struct TWAPOrder',
+        components: [
+          { name: 'owner', type: 'address', internalType: 'address' },
+          {
+            name: 'beneficiary',
+            type: 'address',
+            internalType: 'address',
+          },
+          {
+            name: 'srcToken',
+            type: 'address',
+            internalType: 'address',
+          },
+          {
+            name: 'destToken',
+            type: 'address',
+            internalType: 'address',
+          },
+          { name: 'nonce', type: 'uint256', internalType: 'uint256' },
+          {
+            name: 'partnerAndFee',
+            type: 'uint256',
+            internalType: 'uint256',
+          },
+          { name: 'deadline', type: 'uint64', internalType: 'uint64' },
+          { name: 'interval', type: 'uint64', internalType: 'uint64' },
+          { name: 'numSlices', type: 'uint32', internalType: 'uint32' },
+          {
+            name: 'destAmountPerSlice',
+            type: 'uint256',
+            internalType: 'uint256',
+          },
+          {
+            name: 'totalSrcAmount',
+            type: 'uint256',
+            internalType: 'uint256',
+          },
+          { name: 'permit', type: 'bytes', internalType: 'bytes' },
+          { name: 'metadata', type: 'bytes', internalType: 'bytes' },
+          {
+            name: 'bridge',
+            type: 'tuple',
+            internalType: 'struct Bridge',
+            components: [
+              {
+                name: 'protocolSelector',
+                type: 'bytes4',
+                internalType: 'bytes4',
+              },
+              {
+                name: 'destinationChainId',
+                type: 'uint256',
+                internalType: 'uint256',
+              },
+              {
+                name: 'outputToken',
+                type: 'address',
+                internalType: 'address',
+              },
+              {
+                name: 'scalingFactor',
+                type: 'int8',
+                internalType: 'int8',
+              },
+              {
+                name: 'protocolData',
+                type: 'bytes',
+                internalType: 'bytes',
+              },
+            ],
+          },
+        ],
+      },
+    ],
+    outputs: [],
+    stateMutability: 'nonpayable',
+  },
+  {
+    type: 'function',
+    name: 'cancelTWAPBuyAndWithdraw',
+    inputs: [
+      {
+        name: 'order',
+        type: 'tuple',
+        internalType: 'struct TWAPBuyOrder',
+        components: [
+          { name: 'owner', type: 'address', internalType: 'address' },
+          {
+            name: 'beneficiary',
+            type: 'address',
+            internalType: 'address',
+          },
+          {
+            name: 'srcToken',
+            type: 'address',
+            internalType: 'address',
+          },
+          {
+            name: 'destToken',
+            type: 'address',
+            internalType: 'address',
+          },
+          { name: 'nonce', type: 'uint256', internalType: 'uint256' },
+          {
+            name: 'partnerAndFee',
+            type: 'uint256',
+            internalType: 'uint256',
+          },
+          { name: 'deadline', type: 'uint64', internalType: 'uint64' },
+          { name: 'interval', type: 'uint64', internalType: 'uint64' },
+          { name: 'numSlices', type: 'uint32', internalType: 'uint32' },
+          {
+            name: 'totalDestAmount',
+            type: 'uint256',
+            internalType: 'uint256',
+          },
+          {
+            name: 'maxSrcAmount',
+            type: 'uint256',
+            internalType: 'uint256',
+          },
+          { name: 'permit', type: 'bytes', internalType: 'bytes' },
+          { name: 'metadata', type: 'bytes', internalType: 'bytes' },
+          {
+            name: 'bridge',
+            type: 'tuple',
+            internalType: 'struct Bridge',
+            components: [
+              {
+                name: 'protocolSelector',
+                type: 'bytes4',
+                internalType: 'bytes4',
+              },
+              {
+                name: 'destinationChainId',
+                type: 'uint256',
+                internalType: 'uint256',
+              },
+              {
+                name: 'outputToken',
+                type: 'address',
+                internalType: 'address',
+              },
+              {
+                name: 'scalingFactor',
+                type: 'int8',
+                internalType: 'int8',
+              },
+              {
+                name: 'protocolData',
+                type: 'bytes',
+                internalType: 'bytes',
+              },
+            ],
+          },
+        ],
+      },
+    ],
+    outputs: [],
+    stateMutability: 'nonpayable',
+  },
   {
     type: 'function',
     name: 'withdrawNative',
@@ -358,10 +546,50 @@ export const constructDeltaTokenModule = <T>(
     return res;
   };
 
+  const cancelTWAPAndWithdrawDeltaOrder: CancelTWAPAndWithdrawDeltaOrder<
+    T
+  > = async (order, overrides = {}, requestParams) => {
+    const ParaswapDelta = await getDeltaContract(requestParams);
+    if (!ParaswapDelta) {
+      throw new Error(`Delta is not available on chain ${options.chainId}`);
+    }
+
+    const res = await options.contractCaller.transactCall<AvailableMethods>({
+      address: ParaswapDelta,
+      abi: DeltaTokenModuleAbi,
+      contractMethod: 'cancelTWAPAndWithdraw',
+      args: [order],
+      overrides,
+    });
+
+    return res;
+  };
+
+  const cancelTWAPBuyAndWithdrawDeltaOrder: CancelTWAPBuyAndWithdrawDeltaOrder<
+    T
+  > = async (order, overrides = {}, requestParams) => {
+    const ParaswapDelta = await getDeltaContract(requestParams);
+    if (!ParaswapDelta) {
+      throw new Error(`Delta is not available on chain ${options.chainId}`);
+    }
+
+    const res = await options.contractCaller.transactCall<AvailableMethods>({
+      address: ParaswapDelta,
+      abi: DeltaTokenModuleAbi,
+      contractMethod: 'cancelTWAPBuyAndWithdraw',
+      args: [order],
+      overrides,
+    });
+
+    return res;
+  };
+
   return {
     cancelAndWithdrawDeltaOrder,
     withdrawDeltaNative,
     depositNativeAndPreSign,
     depositNativeAndPreSignDeltaOrder,
+    cancelTWAPAndWithdrawDeltaOrder,
+    cancelTWAPBuyAndWithdrawDeltaOrder,
   };
 };