@velora-dex/sdk 8.0.0

package/dist/types.d.ts

@@ -0,0 +1,161 @@
+import type { OptimalRate, OptionalRate, ParaSwapVersion } from '@paraswap/core';
+import type { Address, AddressOrSymbol, PriceString, Token, TxHash } from './helpers/token';
+import type { SignableTypedData } from './methods/common/orders/buildOrderData';
+import { TransactionParams } from './methods/swap/transaction';
+export type { Address, AddressOrSymbol, PriceString, Token, TxHash, OptimalRate, OptionalRate, };
+export type EnumerateLiteral<T extends Record<string, any>> = {
+    [K in keyof T]: T[K] extends `${infer n}` ? n : never;
+}[keyof T];
+/** @description Passed to version API endpoints as ?version: to /prices and /adapters */
+export type APIVersion = EnumerateLiteral<typeof ParaSwapVersion>;
+export interface ConstructBaseInput {
+    apiURL?: string;
+    version?: APIVersion;
+    chainId: number;
+}
+/** @description Any params that can be passed to fetcher. E.g. Axios fetcher can accept signal and timeout, fetch can accept signal */
+export type RequestParameters = {
+    [K: string]: any;
+    signal?: AbortSignal;
+};
+interface FetcherInputBase<URL extends string = string> {
+    url: URL;
+    headers?: Record<string, string>;
+    requestParams?: RequestParameters;
+}
+export interface FetcherGetInput<URL extends string = string> extends FetcherInputBase<URL> {
+    method: 'GET';
+}
+export interface FetcherPostInput<URL extends string = string> extends FetcherInputBase<URL> {
+    method: 'POST';
+    data: Record<string, any>;
+}
+export type FetcherFunction = <T, URL extends string = string>(params: FetcherGetInput<URL> | FetcherPostInput<URL>) => Promise<T>;
+export type ExtraFetchParams = {
+    apiKey?: string;
+};
+export interface ConstructFetchInput extends ConstructBaseInput {
+    fetcher: FetcherFunction;
+}
+interface OverridesBase {
+    from?: string;
+    gasPrice?: string;
+    maxFeePerGas?: string;
+    maxPriorityFeePerGas?: string;
+    gas?: number;
+    value?: number | string;
+}
+type BlockTag = string | number | 'latest' | 'pending' | 'earliest' | 'genesis';
+export interface StaticCallOverrides extends OverridesBase {
+    block?: BlockTag;
+}
+export interface TxSendOverrides extends OverridesBase {
+    nonce?: number;
+}
+interface ContractCallInput<T extends string> {
+    address: Address;
+    abi: ReadonlyArray<JsonFragment>;
+    contractMethod: T;
+    args: any[];
+}
+export interface ContractCallStaticInput<T extends string> extends ContractCallInput<T> {
+    overrides: StaticCallOverrides;
+}
+interface ContractCallTransactionInput<T extends string> extends ContractCallInput<T> {
+    overrides: TxSendOverrides;
+}
+export type StaticContractCallerFn = <T, M extends string = string>(params: ContractCallStaticInput<M>) => Promise<T>;
+export type TransactionContractCallerFn<T> = <M extends string = string>(params: ContractCallTransactionInput<M>) => Promise<T>;
+export type SignTypedDataContractCallerFn = (typedData: SignableTypedData) => Promise<string>;
+export interface ContractCallerFunctions<T> {
+    staticCall: StaticContractCallerFn;
+    transactCall: TransactionContractCallerFn<T>;
+    signTypedDataCall: SignTypedDataContractCallerFn;
+}
+export interface ConstructProviderFetchInput<T, D extends keyof ContractCallerFunctions<T> = keyof ContractCallerFunctions<T>> extends ConstructFetchInput {
+    contractCaller: Pick<ContractCallerFunctions<T>, D>;
+}
+export type TokenFromApi = Pick<Token, 'address' | 'decimals' | 'symbol' | 'balance' | 'allowance'>;
+export interface TokensApiResponse {
+    tokens: TokenFromApi[];
+}
+export interface TokenApiResponse {
+    token?: TokenFromApi;
+}
+export type NoExtraKeysCheck<Checking, CheckAgainst> = Exclude<keyof Checking, keyof CheckAgainst> extends never ? Checking : never;
+export type PriceRouteApiResponse = {
+    priceRoute: OptimalRate;
+};
+export type SwapApiResponse = {
+    priceRoute: OptimalRate;
+    txParams: Omit<TransactionParams, 'gas'>;
+};
+export type PriceRouteApiErrorResponse = {
+    error: string;
+} | {
+    error: string;
+    value: string;
+    priceRoute: OptimalRate;
+};
+export type AnyFunction = (...args: any[]) => any;
+export interface JsonFragmentType {
+    /**
+     *  The parameter name.
+     */
+    readonly name?: string;
+    /**
+     *  If the parameter is indexed.
+     */
+    readonly indexed?: boolean;
+    /**
+     *  The type of the parameter.
+     */
+    readonly type?: string;
+    /**
+     *  The internal Solidity type.
+     */
+    readonly internalType?: string;
+    /**
+     *  The components for a tuple.
+     */
+    readonly components?: ReadonlyArray<JsonFragmentType>;
+}
+export interface JsonFragment {
+    /**
+     *  The name of the error, event, function, etc.
+     */
+    readonly name?: string;
+    /**
+     *  The type of the fragment (e.g. ``event``, ``"function"``, etc.)
+     */
+    readonly type?: string;
+    /**
+     *  If the event is anonymous.
+     */
+    readonly anonymous?: boolean;
+    /**
+     *  If the function is payable.
+     */
+    readonly payable?: boolean;
+    /**
+     *  If the function is constant.
+     */
+    readonly constant?: boolean;
+    /**
+     *  The mutability state of the function.
+     */
+    readonly stateMutability?: string;
+    /**
+     *  The input parameters.
+     */
+    readonly inputs?: ReadonlyArray<JsonFragmentType>;
+    /**
+     *  The output parameters.
+     */
+    readonly outputs?: ReadonlyArray<JsonFragmentType>;
+    /**
+     *  The gas limit to use when sending a transaction for this function.
+     */
+    readonly gas?: string;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,WAAW,EACX,YAAY,EACZ,eAAe,EAChB,MAAM,gBAAgB,CAAC;AACxB,OAAO,KAAK,EACV,OAAO,EACP,eAAe,EACf,WAAW,EACX,KAAK,EACL,MAAM,EACP,MAAM,iBAAiB,CAAC;AACzB,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wCAAwC,CAAC;AAChF,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAE/D,YAAY,EACV,OAAO,EACP,eAAe,EACf,WAAW,EACX,KAAK,EACL,MAAM,EACN,WAAW,EACX,YAAY,GACb,CAAC;AAEF,MAAM,MAAM,gBAAgB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI;KAC3D,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,GAAG,MAAM,CAAC,EAAE,GAAG,CAAC,GAAG,KAAK;CACtD,CAAC,MAAM,CAAC,CAAC,CAAC;AAKX,yFAAyF;AACzF,MAAM,MAAM,UAAU,GAAG,gBAAgB,CAAC,OAAO,eAAe,CAAC,CAAC;AAElE,MAAM,WAAW,kBAAkB;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,UAAU,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,uIAAuI;AACvI,MAAM,MAAM,iBAAiB,GAAG;IAAE,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC;IAAC,MAAM,CAAC,EAAE,WAAW,CAAA;CAAE,CAAC;AAE3E,UAAU,gBAAgB,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM;IACpD,GAAG,EAAE,GAAG,CAAC;IACT,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,aAAa,CAAC,EAAE,iBAAiB,CAAC;CACnC;AACD,MAAM,WAAW,eAAe,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM,CAC1D,SAAQ,gBAAgB,CAAC,GAAG,CAAC;IAC7B,MAAM,EAAE,KAAK,CAAC;CACf;AACD,MAAM,WAAW,gBAAgB,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM,CAC3D,SAAQ,gBAAgB,CAAC,GAAG,CAAC;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC3B;AAED,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,EAAE,GAAG,SAAS,MAAM,GAAG,MAAM,EAC3D,MAAM,EAAE,eAAe,CAAC,GAAG,CAAC,GAAG,gBAAgB,CAAC,GAAG,CAAC,KACjD,OAAO,CAAC,CAAC,CAAC,CAAC;AAGhB,MAAM,MAAM,gBAAgB,GAAG;IAAE,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAEnD,MAAM,WAAW,mBAAoB,SAAQ,kBAAkB;IAC7D,OAAO,EAAE,eAAe,CAAC;CAC1B;AAED,UAAU,aAAa;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CACzB;AAED,KAAK,QAAQ,GAAG,MAAM,GAAG,MAAM,GAAG,QAAQ,GAAG,SAAS,GAAG,UAAU,GAAG,SAAS,CAAC;AAEhF,MAAM,WAAW,mBAAoB,SAAQ,aAAa;IACxD,KAAK,CAAC,EAAE,QAAQ,CAAC;CAClB;AACD,MAAM,WAAW,eAAgB,SAAQ,aAAa;IACpD,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,UAAU,iBAAiB,CAAC,CAAC,SAAS,MAAM;IAC1C,OAAO,EAAE,OAAO,CAAC;IACjB,GAAG,EAAE,aAAa,CAAC,YAAY,CAAC,CAAC;IACjC,cAAc,EAAE,CAAC,CAAC;IAClB,IAAI,EAAE,GAAG,EAAE,CAAC;CACb;AAED,MAAM,WAAW,uBAAuB,CAAC,CAAC,SAAS,MAAM,CACvD,SAAQ,iBAAiB,CAAC,CAAC,CAAC;IAC5B,SAAS,EAAE,mBAAmB,CAAC;CAChC;AAED,UAAU,4BAA4B,CAAC,CAAC,SAAS,MAAM,CACrD,SAAQ,iBAAiB,CAAC,CAAC,CAAC;IAC5B,SAAS,EAAE,eAAe,CAAC;CAC5B;AAGD,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,GAAG,MAAM,EAChE,MAAM,EAAE,uBAAuB,CAAC,CAAC,CAAC,KAC/B,OAAO,CAAC,CAAC,CAAC,CAAC;AAChB,MAAM,MAAM,2BAA2B,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,EACrE,MAAM,EAAE,4BAA4B,CAAC,CAAC,CAAC,KACpC,OAAO,CAAC,CAAC,CAAC,CAAC;AAChB,MAAM,MAAM,6BAA6B,GAAG,CAC1C,SAAS,EAAE,iBAAiB,KACzB,OAAO,CAAC,MAAM,CAAC,CAAC;AAErB,MAAM,WAAW,uBAAuB,CAAC,CAAC;IACxC,UAAU,EAAE,sBAAsB,CAAC;IACnC,YAAY,EAAE,2BAA2B,CAAC,CAAC,CAAC,CAAC;IAC7C,iBAAiB,EAAE,6BAA6B,CAAC;CAClD;AAED,MAAM,WAAW,2BAA2B,CAC1C,CAAC,EACD,CAAC,SAAS,MAAM,uBAAuB,CAAC,CAAC,CAAC,GAAG,MAAM,uBAAuB,CAAC,CAAC,CAAC,CAC7E,SAAQ,mBAAmB;IAC3B,cAAc,EAAE,IAAI,CAAC,uBAAuB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;CACrD;AAED,MAAM,MAAM,YAAY,GAAG,IAAI,CAC7B,KAAK,EACL,SAAS,GAAG,UAAU,GAAG,QAAQ,GAAG,SAAS,GAAG,WAAW,CAC5D,CAAC;AAEF,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,YAAY,EAAE,CAAC;CACxB;AACD,MAAM,WAAW,gBAAgB;IAC/B,KAAK,CAAC,EAAE,YAAY,CAAC;CACtB;AAGD,MAAM,MAAM,gBAAgB,CAAC,QAAQ,EAAE,YAAY,IAAI,OAAO,CAC5D,MAAM,QAAQ,EACd,MAAM,YAAY,CACnB,SAAS,KAAK,GACX,QAAQ,GACR,KAAK,CAAC;AAEV,MAAM,MAAM,qBAAqB,GAAG;IAClC,UAAU,EAAE,WAAW,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,UAAU,EAAE,WAAW,CAAC;IACxB,QAAQ,EAAE,IAAI,CAAC,iBAAiB,EAAE,KAAK,CAAC,CAAC;CAC1C,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAClC;IACE,KAAK,EAAE,MAAM,CAAC;CACf,GACD;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,UAAU,EAAE,WAAW,CAAA;CAAE,CAAC;AAE9D,MAAM,MAAM,WAAW,GAAG,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC;AAGlD,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;IAE3B;;OAEG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,aAAa,CAAC,gBAAgB,CAAC,CAAC;CACvD;AAED,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;IAE3B;;OAEG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAE5B;;OAEG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,CAAC;IAElC;;OAEG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,aAAa,CAAC,gBAAgB,CAAC,CAAC;IAElD;;OAEG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,aAAa,CAAC,gBAAgB,CAAC,CAAC;IAEnD;;OAEG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC;CACvB"}

package/docs/DELTA.md

@@ -0,0 +1,207 @@
+**Velora Delta** is an intent-based protocol that enables a Velora user to make gasless swaps where multiple agents compete to execute the trade at the best price possible.
+This way the user doesn't need to make a transaction themselves but only to sign a Delta Order.
+The easiest way to make use of the Delta Order is to use the SDK following these steps:
+
+### 1. Construct an SDK object
+
+```ts
+const account = userAddress;
+const deltaSDK = constructSimpleSDK(
+  {chainId: 1, axios},
+  {
+    ethersProviderOrSigner: provider, // JsonRpcProvider
+    EthersContract: ethers.Contract,
+    account,
+  });
+  // for usage with different web3 provider libraries refer to the main [README](./README.md)
+```
+
+### 2. Request prices for a Token pair
+
+```ts
+const DAI_TOKEN = '0x6b175474e89094c44da98b954eedeac495271d0f';
+const USDC_TOKEN = '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48';
+const amount = '1000000000000'; // in wei
+
+const deltaPrice = await deltaSDK.getDeltaPrice({
+  srcToken: DAI_TOKEN,
+  destToken: USDC_TOKEN,
+  amount,
+  userAddress: account,
+  srcDecimals: 18,
+  destDecimals: 6,
+  // partner: "..." // if available
+});
+```
+
+
+### 3. Approve srcToken for DeltaContract
+
+```ts
+const tx = await deltaSDK.approveTokenForDelta(amount, DAI_TOKEN);
+await tx.wait();
+```
+
+Alternatively sign Permit (DAI or Permit1) or Permit2 TransferFrom with DeltaContract as the verifyingContract
+
+```ts
+const DeltaContract = await deltaSDK.getDeltaContract();
+
+// values depend on the Permit type and the srcToken
+const signature = await signer._signTypedData(domain, types, message);
+```
+
+See more on accepted Permit variants in [Velora documentation](https://developers.velora.xyz/api/velora-api/velora-delta-api/build-a-delta-order-to-sign#supported-permits)
+
+
+### 4. Sign and submit a Delta Order
+
+```ts
+// calculate acceptable destAmount
+const slippagePercent = 0.5;
+  const destAmountAfterSlippage = (
+    +deltaPrice.destAmount *
+    (1 - slippagePercent / 100)
+  ).toString(10);
+
+const deltaAuction = await deltaSDK.submitDeltaOrder({
+  deltaPrice,
+  owner: account,
+  // beneficiary: anotherAccount, // if need to send destToken to another account
+  // permit: "0x1234...", // if signed a Permit1 or Permit2 TransferFrom for DeltaContract
+  srcToken: DAI_TOKEN,
+  destToken: USDC_TOKEN,
+  srcAmount: amount,
+  destAmount: destAmountAfterSlippage, // minimum acceptable destAmount
+});
+```
+
+### 5. Wait for Delta Order execution
+
+```ts
+// poll if necessary
+const auction = await deltaSDK.getDeltaOrderById(deltaAuction.id);
+if (auction?.status === 'EXECUTED') {
+  console.log('Auction was executed');
+}
+```
+
+#### A more detailed example of Delta Order usage can be found in [examples/delta](./src/examples/delta.ts)
+
+
+
+
+---------------------------------------------------
+
+## Crosschain Delta Orders
+
+In case you want to perform a crosschain swap, the process is a little more involved.
+
+### 1. Construct an SDK object
+
+```ts
+const SRC_CHAIN_ID = 1 // Ethereum
+const DEST_CHAIN_ID = 10; // Optimism
+
+const account = userAddress;
+const deltaSDK = constructSimpleSDK(
+  {chainId: SRC_CHAIN_ID, axios},
+  {
+    ethersProviderOrSigner: provider, // JsonRpcProvider
+    EthersContract: ethers.Contract,
+    account,
+  });
+  // for usage with different web3 provider libraries refer to the main [README](./README.md)
+```
+
+### 2. Check which tokens are available on the destination chain.
+
+A limited list of tokens are available in Across, the service facilitating crosschain bridging
+
+```ts
+const bridgeInfo = await deltaSDK.getBridgeInfo();
+
+const tokensAvailableForBridging = bridgeInfo[SRC_CHAIN_ID]?.[DEST_CHAIN_ID]
+```
+
+
+### 3. Request prices for a Token pair
+
+```ts
+const DAI_TOKEN = '0x6b175474e89094c44da98b954eedeac495271d0f';
+
+const USDC_TOKEN_ON_DEST_CHAIN = '0x0b2C639c533813f4Aa9D7837CAf62653d097Ff85'; // available for bridging on Optimism
+const amount = '1000000000000'; // in wei
+
+const deltaPrice = await deltaSDK.getDeltaPrice({
+  srcToken: DAI_TOKEN,
+  destToken: USDC_TOKEN_ON_DEST_CHAIN,
+  destChainId: DEST_CHAIN_ID, // required to get deltaPrice for a Crosschain Order
+  amount,
+  userAddress: account,
+  srcDecimals: 18,
+  destDecimals: 6,
+  // partner: "..." // if available
+});
+```
+
+
+### 4. Approve srcToken for DeltaContract
+
+```ts
+const tx = await deltaSDK.approveTokenForDelta(amount, DAI_TOKEN);
+await tx.wait();
+```
+
+Alternatively sign Permit (DAI or Permit1) or Permit2 TransferFrom with DeltaContract as the verifyingContract
+
+```ts
+const DeltaContract = await deltaSDK.getDeltaContract();
+
+// values depend on the Permit type and the srcToken
+const signature = await signer._signTypedData(domain, types, message);
+```
+
+See more on accepted Permit variants in [Velora documentation](https://developers.velora.xyz/api/velora-api/velora-delta-api/build-a-delta-order-to-sign#supported-permits)
+
+
+### 5. Sign and submit a Delta Order
+
+```ts
+// calculate acceptable destAmount
+const slippagePercent = 0.5;
+const destAmountAfterSlippage = (
+  +deltaPrice.destAmount *
+  (1 - slippagePercent / 100)
+).toString(10);
+
+const deltaAuction = await deltaSDK.submitDeltaOrder({
+  deltaPrice,
+  owner: account,
+  // permit: "0x1234...", // if signed a Permit1 or Permit2 TransferFrom for DeltaContract
+  srcToken: DAI_TOKEN,
+  destToken: USDC_TOKEN_ON_DEST_CHAIN,
+  srcAmount: amount,
+  destAmount: destAmountAfterSlippage, // minimum acceptable destAmount
+  destChainId: DEST_CHAIN_ID, // required to construct a Crosschain Order
+  beneficiary: anotherAccount, // if need to send destToken to another account on destChain
+  beneficiaryType: 'EOA', // whether the beneficiary on destChain is a smart contract
+  // bridge, // user-constructed Bridge object for Crosschain Orders
+});
+```
+
+To construct a Crosschain Delta Order it is required to either:
+* provide both `beneficiary` address and `beneficiaryType` value, so that the `Order.bridge` can be constructed automatically by the SDK.
+* construct Bridge object. Refer to [documentation](https://developers.velora.xyz/api/velora-api/velora-delta-api/build-a-delta-order-to-sign#sign-an-order-cross-chain) for how to do that.
+
+This is necessary because Across, the service facilitating crosschain bridging, has [special logic when it comes to transferring ETH and WETH](https://docs.across.to/introduction/technical-faq#what-is-the-behavior-of-eth-weth-in-transfers).
+
+### 5. Wait for Delta Order execution
+
+```ts
+// poll if necessary
+const auction = await deltaSDK.getDeltaOrderById(deltaAuction.id);
+if (auction?.status === 'EXECUTED' && auction.bridgeStatus === "filled") {
+  console.log('Auction was executed');
+}
+```

package/package.json

@@ -0,0 +1,126 @@
+{
+  "name": "@velora-dex/sdk",
+  "version": "8.0.0",
+  "main": "dist/index.js",
+  "module": "dist/sdk.esm.js",
+  "typings": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "src",
+    "docs/DELTA.md"
+  ],
+  "scripts": {
+    "analyze": "size-limit --why",
+    "build": "dts build",
+    "lint": "dts lint",
+    "prepare": "dts build",
+    "size": "size-limit",
+    "start": "dts watch",
+    "test": "dts test",
+    "docs:html": "typedoc --gitRevision \"$(git branch --show-current)\"",
+    "docs:md": "MD=true yarn docs:html",
+    "docs": "yarn docs:html && yarn docs:md"
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "dts lint --fix"
+    }
+  },
+  "prettier": {
+    "printWidth": 80,
+    "semi": true,
+    "singleQuote": true,
+    "trailingComma": "es5"
+  },
+  "jest": {
+    "testEnvironment": "node"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "size-limit": [
+    {
+      "path": "dist/sdk.cjs.production.min.js",
+      "limit": "25 KB"
+    },
+    {
+      "path": "dist/sdk.esm.js",
+      "limit": "25 KB"
+    }
+  ],
+  "devDependencies": {
+    "@size-limit/preset-small-lib": "^11.1.6",
+    "@tsconfig/recommended": "^1.0.8",
+    "axios": "^1.7.7",
+    "bignumber.js": "^9.1.2",
+    "dotenv": "^16.4.5",
+    "dts-cli": "^2.0.5",
+    "ethers": "^6.13.4",
+    "ethersV5": "npm:ethers@5",
+    "hardhat": "^2.22.15",
+    "hardhat-switch-network": "^1.1.1",
+    "husky": "^9.1.6",
+    "isomorphic-unfetch": "^4.0.2",
+    "size-limit": "^11.1.6",
+    "tslib": "^2.8.1",
+    "typedoc": "^0.26.11",
+    "typedoc-plugin-markdown": "^4.2.10",
+    "typedoc-plugin-missing-exports": "^3.0.0",
+    "typedoc-plugin-replace-text": "^4.0.0",
+    "typescript": "^5.6.3",
+    "viem": "^2.21.39",
+    "wagmi": "^2.12.25",
+    "web3": "^4.14.0"
+  },
+  "peerDependencies": {
+    "axios": ">=0.25.0 <2.0.0",
+    "ethers": "^5.5.0 || ^6.0.0",
+    "viem": "^2.21.0",
+    "web3": "^4.14.0"
+  },
+  "peerDependenciesMeta": {
+    "axios": {
+      "optional": true
+    },
+    "ethers": {
+      "optional": true
+    },
+    "web3": {
+      "optional": true
+    },
+    "viem": {
+      "optional": true
+    }
+  },
+  "dependencies": {
+    "@paraswap/core": "2.4.0",
+    "ts-essentials": "^10.0.3"
+  },
+  "author": "Velora",
+  "description": "Velora SDK",
+  "license": "MIT",
+  "keywords": [
+    "web3",
+    "web3js",
+    "ethereum",
+    "crypto",
+    "blockchain",
+    "DEX",
+    "velora",
+    "ether",
+    "eth",
+    "dai",
+    "tokens",
+    "exchange",
+    "erc-20",
+    "erc20"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/VeloraDEX/paraswap-sdk"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "bugs": "https://github.com/VeloraDEX/paraswap-sdk/issues"
+}

package/src/constants.ts

@@ -0,0 +1,16 @@
+import { EnumerateLiteral, APIVersion } from './types';
+
+import type { ContractMethod } from '@paraswap/core';
+
+export {
+  SwapSide,
+  ContractMethod,
+  ContractMethodV5,
+  ContractMethodV6,
+} from '@paraswap/core';
+
+// allows to pass by name instead of importing enum first
+export type ContractMethodByName = EnumerateLiteral<typeof ContractMethod>;
+
+export const API_URL = 'https://api.paraswap.io';
+export const DEFAULT_VERSION = '6.2' satisfies APIVersion;

package/src/examples/customFetcher.ts

@@ -0,0 +1,44 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+import { constructSimpleSDK, FetcherFunction } from '../';
+
+// mock superagent module without adding a dependency
+interface SuperAgentStatic
+  extends Promise<{
+    body: any;
+    ok: boolean;
+    status: number;
+    statusCode: number;
+    error: false | { status: number; textx: string };
+  }> {
+  set(headers: Record<string, string>): this;
+  get(url: string): this;
+  post(url: string): this;
+  send(body: any): this;
+}
+// pretend we do `import superagent from "superagent"
+declare const superagent: SuperAgentStatic;
+
+export const superagentFetcher = (): FetcherFunction =>
+  async function (options) {
+    if (options.method.toLowerCase() === 'post' && 'data' in options) {
+      const response = await superagent
+        .post(options.url)
+        .set(options?.headers || {})
+        .send(options.data);
+
+      return response.body;
+    } else {
+      const response = await superagent
+        .get(options.url)
+        .set(options?.headers || {});
+
+      return response.body;
+    }
+
+    // Add error handling with FetcherError;
+    // handle options.requestParams.signal;
+    // pass any other paramteres in requestParams
+  };
+
+const fetcher: FetcherFunction = superagentFetcher();
+const sdk = constructSimpleSDK({ fetcher, chainId: 1 });

package/src/examples/delta.ts

@@ -0,0 +1,127 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+import axios from 'axios';
+import { ethers, Wallet } from 'ethersV5';
+import {
+  constructPartialSDK,
+  constructEthersContractCaller,
+  constructAxiosFetcher,
+  constructAllDeltaOrdersHandlers,
+} from '..';
+
+const fetcher = constructAxiosFetcher(axios);
+
+const provider = ethers.getDefaultProvider(1);
+const signer = Wallet.createRandom().connect(provider);
+const account = signer.address;
+const contractCaller = constructEthersContractCaller({
+  ethersProviderOrSigner: provider,
+  EthersContract: ethers.Contract,
+});
+
+// type AdaptersFunctions & ApproveTokenFunctions<ethers.ContractTransaction>
+const deltaSDK = constructPartialSDK(
+  {
+    chainId: 1,
+    fetcher,
+    contractCaller,
+  },
+  constructAllDeltaOrdersHandlers
+);
+
+const DAI_TOKEN = '0x6b175474e89094c44da98b954eedeac495271d0f';
+const USDC_TOKEN = '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48';
+
+async function simpleDeltaFlow() {
+  const amount = '1000000000000'; // wei
+
+  const deltaPrice = await deltaSDK.getDeltaPrice({
+    srcToken: DAI_TOKEN,
+    destToken: USDC_TOKEN,
+    amount,
+    userAddress: account,
+    srcDecimals: 18,
+    destDecimals: 18,
+    // partner: "..." // if available
+  });
+
+  const DeltaContract = await deltaSDK.getDeltaContract();
+
+  // or sign a Permit1 or Permit2 TransferFrom for DeltaContract
+  const tx = await deltaSDK.approveTokenForDelta(amount, DAI_TOKEN);
+  await tx.wait();
+
+  const slippagePercent = 0.5;
+  const destAmountAfterSlippage = BigInt(
+    // get rid of exponential notation
+
+    +(+deltaPrice.destAmount * (1 - slippagePercent / 100)).toFixed(0)
+    // get rid of decimals
+  ).toString(10);
+
+  const deltaAuction = await deltaSDK.submitDeltaOrder({
+    deltaPrice,
+    owner: account,
+    // beneficiary: anotherAccount, // if need to send destToken to another account
+    // permit: "0x1234...", // if signed a Permit1 or Permit2 TransferFrom for DeltaContract
+    srcToken: DAI_TOKEN,
+    destToken: USDC_TOKEN,
+    srcAmount: amount,
+    destAmount: destAmountAfterSlippage, // minimum acceptable destAmount
+  });
+
+  // poll if necessary
+  const auction = await deltaSDK.getDeltaOrderById(deltaAuction.id);
+  if (auction?.status === 'EXECUTED') {
+    console.log('Auction was executed');
+  }
+}
+async function manualDeltaFlow() {
+  const amount = '1000000000000'; // wei
+
+  const deltaPrice = await deltaSDK.getDeltaPrice({
+    srcToken: DAI_TOKEN,
+    destToken: USDC_TOKEN,
+    amount,
+    userAddress: account,
+    srcDecimals: 18,
+    destDecimals: 18,
+    // partner: "..." // if available
+  });
+
+  const DeltaContract = await deltaSDK.getDeltaContract();
+
+  // or sign a Permit1 or Permit2 TransferFrom for DeltaContract
+  const tx = await deltaSDK.approveTokenForDelta(amount, DAI_TOKEN);
+  await tx.wait();
+
+  const slippagePercent = 0.5;
+  const destAmountAfterSlippage = (
+    +deltaPrice.destAmount *
+    (1 - slippagePercent / 100)
+  ).toString(10);
+
+  const signableOrderData = await deltaSDK.buildDeltaOrder({
+    deltaPrice,
+    owner: account,
+    // beneficiary: anotherAccount, // if need to send destToken to another account
+    // permit: "0x1234...", // if signed a Permit1 or Permit2 TransferFrom for DeltaContract
+    srcToken: DAI_TOKEN,
+    destToken: USDC_TOKEN,
+    srcAmount: amount,
+    destAmount: destAmountAfterSlippage, // minimum acceptable destAmount
+  });
+
+  const signature = await deltaSDK.signDeltaOrder(signableOrderData);
+
+  const deltaAuction = await deltaSDK.postDeltaOrder({
+    // partner: "..." // if available
+    order: signableOrderData.data,
+    signature,
+  });
+
+  // poll if necessary
+  const auction = await deltaSDK.getDeltaOrderById(deltaAuction.id);
+  if (auction?.status === 'EXECUTED') {
+    console.log('Auction was executed');
+  }
+}