@velora-dex/sdk 8.1.1-dev.0 → 8.1.1-dev.2

package/package.json

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

package/src/examples/helpers/delta.ts

@@ -1,4 +1,4 @@
-import { DeltaAuction, GetDeltaOrdersFunctions } from '../..';
+import { DeltaAuction, DeltaOrderFromAPI } from '../..';
 
 function isExecutedDeltaAuction(
   auction: Omit<DeltaAuction, 'signature'>,
@@ -14,9 +14,7 @@ function isExecutedDeltaAuction(
   return true;
 }
 
-type GetDeltaOrderFn = () => ReturnType<
-  GetDeltaOrdersFunctions['getDeltaOrderById']
->;
+type GetDeltaOrderFn = () => Promise<DeltaOrderFromAPI>;
 
 function fetchOrderPeriodically(getDeltaOrder: GetDeltaOrderFn) {
   const intervalId = setInterval(async () => {

package/src/index.ts

@@ -11,12 +11,17 @@ import {
 import {
   constructGetSpender,
   GetSpenderFunctions,
+  AdaptersContractsResult,
 } from './methods/swap/spender';
 import {
   constructGetAdapters,
   GetAdaptersFunctions,
 } from './methods/swap/adapters';
-import { constructGetRate, GetRateFunctions } from './methods/swap/rates';
+import {
+  constructGetRate,
+  GetRateFunctions,
+  GetRateInput,
+} from './methods/swap/rates';
 import { constructSwapTx, GetSwapTxFunctions } from './methods/swap/swapTx';
 import { constructGetTokens, GetTokensFunctions } from './methods/swap/token';
 import { BuildTxFunctions, constructBuildTx } from './methods/swap/transaction';
@@ -134,6 +139,7 @@ import type {
 import type {
   DeltaAuctionOrder,
   DeltaAuction,
+  DeltaAuctionStatus,
   BridgeMetadata,
   BridgeStatus,
   Bridge,
@@ -143,6 +149,7 @@ import {
   BuildDeltaOrderFunctions,
   constructBuildDeltaOrder,
   SignableDeltaOrderData,
+  SwapSideUnion,
 } from './methods/delta/buildDeltaOrder';
 import {
   constructBuildCrosschainOrderBridge,
@@ -152,6 +159,7 @@ import {
 } from './methods/delta/buildCrosschainOrderBridge';
 import {
   constructPostDeltaOrder,
+  DeltaOrderApiResponse,
   PostDeltaOrderFunctions,
   PostDeltaOrderParams,
 } from './methods/delta/postDeltaOrder';
@@ -173,6 +181,7 @@ import {
 import {
   constructGetDeltaOrders,
   GetDeltaOrdersFunctions,
+  DeltaOrderFromAPI,
 } from './methods/delta/getDeltaOrders';
 import {
   ApproveTokenForDeltaFunctions,
@@ -329,9 +338,11 @@ export type {
   ApproveTokenFunctions,
   GetBalancesFunctions,
   GetSpenderFunctions,
+  AdaptersContractsResult,
   GetTokensFunctions,
   GetAdaptersFunctions,
   GetRateFunctions,
+  GetRateInput,
   BuildTxFunctions,
   GetSwapTxFunctions,
   // types for limitOrders methods:
@@ -365,6 +376,9 @@ export type {
   DeltaPriceParams,
   DeltaAuctionOrder,
   DeltaAuction,
+  DeltaAuctionStatus,
+  DeltaOrderApiResponse,
+  DeltaOrderFromAPI,
   // bridge part of DeltaOrder
   BridgeMetadata,
   BridgeStatus,
@@ -411,6 +425,7 @@ export type {
   OptionalRate,
   FetcherErrorInterface,
   APIVersion,
+  SwapSideUnion,
 };
 
 export { SDKConfig, constructPartialSDK } from './sdk/partial';

package/src/methods/delta/buildDeltaOrder.ts

@@ -16,7 +16,7 @@ import { BeneficiaryType } from '../common/orders/types';
 import { SwapSide } from '../../constants';
 export type { SignableDeltaOrderData } from './helpers/buildDeltaOrderData';
 
-type SwapSideUnion = EnumerateLiteral<typeof SwapSide>;
+export type SwapSideUnion = EnumerateLiteral<typeof SwapSide>;
 
 export type BuildDeltaOrderDataParams = {
   /** @description The address of the order owner */

package/src/methods/delta/cancelDeltaOrder.ts

@@ -2,7 +2,6 @@ import type {
   ConstructProviderFetchInput,
   RequestParameters,
 } from '../../types';
-import { DeltaAuction } from './helpers/types';
 import {
   buildCancelDeltaOrderSignableData,
   CancelDeltaOrderData,
@@ -27,7 +26,7 @@ export type PostCancelDeltaOrderRequest = (
 ) => Promise<SuccessResponse>;
 
 export type CancelDeltaOrder = (
-  params: Pick<DeltaAuction, 'id'>[],
+  params: CancelDeltaOrderData,
   requestParams?: RequestParameters
 ) => Promise<SuccessResponse>;
 
@@ -83,10 +82,9 @@ export const constructCancelDeltaOrder = (
   };
 
   const cancelLimitDeltaOrders: CancelDeltaOrder = async (
-    params,
+    { orderIds },
     requestParams
   ) => {
-    const orderIds = params.map(({ id }) => id);
     const signature = await signCancelLimitDeltaOrderRequest(
       { orderIds },
       requestParams

package/src/methods/delta/getDeltaOrders.ts

@@ -7,17 +7,17 @@ import type {
 } from '../../types';
 import type { DeltaAuction } from './helpers/types';
 
-type OrderFromAPI = Omit<DeltaAuction, 'signature'>;
+export type DeltaOrderFromAPI = Omit<DeltaAuction, 'signature'>;
 
 type GetDeltaOrderById = (
   orderId: string,
   requestParams?: RequestParameters
-) => Promise<OrderFromAPI>;
+) => Promise<DeltaOrderFromAPI>;
 
 type GetDeltaOrderByHash = (
   orderHash: string,
   requestParams?: RequestParameters
-) => Promise<OrderFromAPI>;
+) => Promise<DeltaOrderFromAPI>;
 
 type OrdersFilter = {
   /** @description Order.owner to fetch Delta Order for */
@@ -36,7 +36,7 @@ type OrderFiltersQuery = OrdersFilter;
 type GetDeltaOrders = (
   options: OrdersFilter,
   requestParams?: RequestParameters
-) => Promise<OrderFromAPI[]>;
+) => Promise<DeltaOrderFromAPI[]>;
 
 type GetRequiredBalanceParams = {
   userAddress: Address;
@@ -68,7 +68,7 @@ export const constructGetDeltaOrders = ({
   ) => {
     const fetchURL = `${baseUrl}/${orderId}` as const;
 
-    const order = await fetcher<OrderFromAPI>({
+    const order = await fetcher<DeltaOrderFromAPI>({
       url: fetchURL,
       method: 'GET',
       requestParams,
@@ -83,7 +83,7 @@ export const constructGetDeltaOrders = ({
   ) => {
     const fetchURL = `${baseUrl}/hash/${orderHash}` as const;
 
-    const order = await fetcher<OrderFromAPI>({
+    const order = await fetcher<DeltaOrderFromAPI>({
       url: fetchURL,
       method: 'GET',
       requestParams,
@@ -103,7 +103,7 @@ export const constructGetDeltaOrders = ({
 
     const fetchURL = `${baseUrl}${search}` as const;
 
-    const orders = await fetcher<OrderFromAPI[]>({
+    const orders = await fetcher<DeltaOrderFromAPI[]>({
       url: fetchURL,
       method: 'GET',
       requestParams,

package/src/methods/delta/getDeltaPrice.ts

@@ -24,6 +24,8 @@ export type DeltaPriceParams = {
   destDecimals: number;
   /** @description User's Wallet Address */
   userAddress?: string;
+  /** @description Beneficiary Address */
+  beneficiary?: string; // beneficiary==owner if no transferTo
   /** @description Partner string. */
   partner?: string;
   /** @description Destination Chain ID for Crosschain Orders */

package/src/methods/delta/helpers/types.ts

@@ -52,18 +52,15 @@ export type Bridge = {
   protocolData: string; // Hex string
 };
 
-type DeltaAuctionStatus =
+export type DeltaAuctionStatus =
   | 'NOT_STARTED'
   | 'RUNNING'
   | 'EXECUTING'
   | 'EXECUTED'
   | 'FAILED'
   | 'EXPIRED'
-  | 'CANCELLED'; // @TODO check if added
-// these are not exposed, but are coerced into FAILED
-// | 'INSUFFICIENT_BALANCE'
-// | 'INSUFFICIENT_ALLOWANCE'
-// | 'INVALIDATED';
+  | 'CANCELLED'
+  | 'SUSPENDED';
 
 type DeltaAuctionTransaction = {
   id: string;

package/src/methods/swap/spender.ts

@@ -20,7 +20,7 @@ export type GetSpenderFunctions = {
   getContracts: GetContracts;
 };
 
-interface AdaptersContractsResult {
+export interface AdaptersContractsResult {
   AugustusSwapper: string;
   TokenTransferProxy: string;
   AugustusRFQ: string;