@dzapio/sdk 2.0.6 → 2.0.7

package/dist/src/types/permit.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BatchPermitAbiParams = exports.bridgeGaslessWitnessType = exports.swapGaslessWitnessType = exports.defaultWitnessType = void 0;
+exports.defaultWitnessType = {
+    typeName: 'DZapTransferWitness',
+    type: {
+        DZapTransferWitness: [
+            { name: 'owner', type: 'address' },
+            { name: 'recipient', type: 'address' },
+        ],
+    },
+};
+exports.swapGaslessWitnessType = {
+    typeName: 'DZapSwapWitness',
+    type: {
+        DZapSwapWitness: [
+            { name: 'txId', type: 'bytes32' },
+            { name: 'user', type: 'address' },
+            { name: 'executorFeesHash', type: 'bytes32' },
+            { name: 'swapDataHash', type: 'bytes32' },
+        ],
+    },
+};
+exports.bridgeGaslessWitnessType = {
+    typeName: 'DZapBridgeWitness',
+    type: {
+        DZapBridgeWitness: [
+            { name: 'txId', type: 'bytes32' },
+            { name: 'user', type: 'address' },
+            { name: 'executorFeesHash', type: 'bytes32' },
+            { name: 'swapDataHash', type: 'bytes32' },
+            { name: 'adapterDataHash', type: 'bytes32' },
+        ],
+    },
+};
+exports.BatchPermitAbiParams = [
+    {
+        name: 'permit',
+        type: 'tuple',
+        components: [
+            {
+                name: 'permitted',
+                type: 'tuple[]',
+                components: [
+                    { name: 'token', type: 'address' },
+                    { name: 'amount', type: 'uint256' },
+                ],
+            },
+            { name: 'nonce', type: 'uint256' },
+            { name: 'deadline', type: 'uint256' },
+        ],
+    },
+    { name: 'permitSignature', type: 'bytes' },
+];

package/dist/src/types/wallet.d.ts

@@ -0,0 +1,2 @@
+import { type WalletCallReceipt as _WalletCallReceipt } from 'viem';
+export type WalletCallReceipt = _WalletCallReceipt<bigint, 'success' | 'reverted'>;

package/dist/src/types/wallet.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/types/zap/build.d.ts

@@ -0,0 +1,44 @@
+import { HexString } from '..';
+import { ZapPath } from './path';
+import { ZapStep } from './step';
+export type ZapRouteRequestPositionDetails = {
+    nftId: string;
+};
+export type ZapRouteRequestPoolDetails = {
+    lowerTick: number;
+    upperTick: number;
+    metadata?: unknown;
+};
+export type ZapIntegratorConfig = {
+    id: string;
+    feeBps: number;
+    wallet: string;
+};
+export type ZapBuildTxnResponse = {
+    amountOut: string;
+    approvalData: {
+        callTo: HexString;
+        approveTo: HexString;
+        amount: string;
+    } | null;
+    steps: ZapStep[];
+    path: ZapPath[];
+};
+export type ZapBuildTxnRequest = {
+    srcToken: string;
+    srcChainId: number;
+    destToken: string;
+    destChainId: number;
+    recipient: string;
+    refundee: string;
+    slippage: number;
+    account: string;
+    integrator?: ZapIntegratorConfig;
+    permitData?: string;
+    amount?: string;
+    estimateGas?: boolean;
+    positionDetails?: ZapRouteRequestPositionDetails;
+    poolDetails?: ZapRouteRequestPoolDetails;
+    allowedBridges?: string[];
+    allowedDexes?: string[];
+};

package/dist/src/types/zap/build.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/types/zap/index.d.ts

@@ -0,0 +1,34 @@
+import { HexString, ProviderDetails } from '../';
+import { ZapPathAsset } from './path';
+export type ZapProviders = Record<string, ProviderDetails>;
+export type ZapChains = {
+    [key: string]: {
+        name: string;
+        supportedProviders: string[];
+    };
+};
+export type ZapFee = {
+    amount: string;
+    amountUSD: string;
+    asset: ZapPathAsset;
+    included: boolean;
+};
+export type ZapUnderlyingToken = {
+    chainId: number;
+    address: HexString;
+    name?: string;
+    symbol: string;
+    decimals: number;
+    logo?: string | null;
+};
+export type ZapUnderlyingTokenWithAmount = ZapUnderlyingToken & {
+    amount: string;
+    amountUSD: string;
+};
+export * from './build';
+export * from './path';
+export * from './pool';
+export * from './position';
+export * from './quote';
+export * from './status';
+export * from './step';

package/dist/src/types/zap/index.js

@@ -0,0 +1,23 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./build"), exports);
+__exportStar(require("./path"), exports);
+__exportStar(require("./pool"), exports);
+__exportStar(require("./position"), exports);
+__exportStar(require("./quote"), exports);
+__exportStar(require("./status"), exports);
+__exportStar(require("./step"), exports);

package/dist/src/types/zap/path.d.ts

@@ -0,0 +1,33 @@
+import { ZapFee, ZapUnderlyingToken } from '.';
+import { HexString, ProviderDetails } from '../..';
+import { zapPathAction } from '../../zap/constants/path';
+export type ZapPathAction = keyof typeof zapPathAction;
+export type ZapPathAsset = {
+    chainId: number;
+    address: HexString;
+    symbol: string;
+    logo: string;
+    decimals: number;
+    price: string;
+    type: string;
+    name: string;
+    provider?: ProviderDetails;
+    underlyingTokens?: ZapUnderlyingToken[];
+};
+export type ZapPath = {
+    action: ZapPathAction;
+    protocol: ProviderDetails;
+    fee: ZapFee[];
+    estimatedDuration: number;
+    input: {
+        asset: ZapPathAsset;
+        amount: string;
+        amountUSD: string;
+    }[];
+    output: {
+        asset: ZapPathAsset;
+        amount: string;
+        amountUSD: string;
+        dust?: boolean;
+    }[];
+};

package/dist/src/types/zap/path.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/types/zap/pool.d.ts

@@ -0,0 +1,39 @@
+import { ZapUnderlyingToken } from '.';
+import { HexString } from '..';
+export type ZapPoolDetailsRequest = {
+    address: HexString;
+    chainId: number;
+    provider: string;
+};
+export type ZapPoolsRequest = {
+    chainId: number;
+    provider: string;
+    limit?: number;
+    offset?: number;
+};
+export type ZapPoolsResponse = {
+    pools: ZapPool[];
+    pages: number;
+    limit: number;
+    offset: number;
+};
+export type ZapPool = {
+    address: string;
+    chainId: number;
+    name: string;
+    provider: string;
+    underlyingAssets: ZapUnderlyingToken[];
+    tvl: string;
+    apr: number;
+    metadata?: unknown;
+    symbol: string;
+    decimals: number;
+};
+export type ZapPoolDetails = {
+    address: string;
+    slot0: {
+        sqrtPriceX96: string;
+        tick: number;
+        tickSpacing: number;
+    };
+};

package/dist/src/types/zap/pool.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/types/zap/position.d.ts

@@ -0,0 +1,27 @@
+import { ZapUnderlyingTokenWithAmount } from '.';
+import { HexString } from '..';
+export type ZapPositionsRequest = {
+    account: HexString;
+    chainId: number;
+    provider: string;
+};
+export type ZapPosition = {
+    underlyingAssets: ZapUnderlyingTokenWithAmount[];
+    address: string;
+    apr: number;
+    name: string;
+    chainId: number;
+    provider: string;
+    amount: string;
+    amountUSD: string;
+    nftDetails?: {
+        id: string;
+        manager: HexString;
+    };
+    metadata?: unknown;
+    decimals: number;
+};
+export type ZapPositionsResponse = {
+    positions: ZapPosition[];
+    count: number;
+};

package/dist/src/types/zap/position.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/types/zap/quote.d.ts

@@ -0,0 +1,7 @@
+import { ZapBuildTxnResponse, ZapBuildTxnRequest } from './build';
+export type ZapQuoteResponse = Omit<ZapBuildTxnResponse, 'steps'>;
+export type ZapQuoteRequest = Omit<ZapBuildTxnRequest, 'refundee' | 'recipient' | 'account'> & Partial<{
+    refundee: string;
+    recipient: string;
+    account: string;
+}>;

package/dist/src/types/zap/quote.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/types/zap/status.d.ts

@@ -0,0 +1,28 @@
+import { ProviderDetails } from '..';
+import { ZapPathAsset } from './path';
+export type ZapStatus = 'PENDING' | 'COMPLETED' | 'FAILED';
+export type ZapStatusAsset = {
+    asset: ZapPathAsset;
+    amount: string;
+    amountUSD: string;
+};
+export type ZapStatusStep = {
+    chainId: number;
+    hash?: string;
+    status: ZapStatus;
+    action: string;
+    protocol: ProviderDetails;
+    input: ZapStatusAsset[];
+    output: ZapStatusAsset[];
+};
+export type ZapStatusResponse = {
+    status: ZapStatus;
+    steps: ZapStatusStep[];
+    recipient: string;
+    timestamp: number;
+    completedAt: number;
+};
+export type ZapStatusRequest = {
+    chainId: number;
+    txnHash: string;
+};

package/dist/src/types/zap/status.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/types/zap/step.d.ts

@@ -0,0 +1,23 @@
+import { HexString } from '..';
+import { chainTypes } from '../../constants/chains';
+import { zapStepAction } from '../../zap/constants/step';
+export type StepAction = keyof typeof zapStepAction;
+export type ZapEvmTxnDetails = {
+    type: typeof chainTypes.evm;
+    txnId: HexString;
+    callData: HexString;
+    callTo: HexString;
+    value: string;
+    estimatedGas: string;
+};
+export type ZapBvmTxnDetails = {
+    type: typeof chainTypes.bvm;
+    txnId: HexString;
+    data: string;
+};
+export type ZapTxnDetails = ZapEvmTxnDetails | ZapBvmTxnDetails;
+export type ZapTransactionStep<T extends ZapTxnDetails = ZapTxnDetails> = {
+    action: StepAction;
+    data: T;
+};
+export type ZapStep = ZapTransactionStep;

package/dist/src/types/zap/step.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/utils/amount.d.ts

@@ -0,0 +1,82 @@
+import { Fee, TradeQuote } from '../types';
+export declare const calculateAmountUSD: (amountInWei: string, decimals: number, price: string) => string;
+export declare const calculateNetGasFeeUsd: (item: TradeQuote) => string;
+export declare const calculateNetAmountUsd: (item: TradeQuote) => string;
+export declare const calculateNetGasFee: (item: TradeQuote) => bigint;
+export declare const updateFee: (fee: Fee, tokensPrice: Record<number, Record<string, string | null>>) => {
+    isUpdated: boolean;
+    fee: {
+        gasFee: {
+            amountUSD: string;
+            address: string;
+            decimals: number;
+            chainId: number;
+            symbol: string;
+            logo?: string;
+            amount: string;
+            included: boolean;
+        }[];
+        providerFee: {
+            amountUSD: string;
+            address: string;
+            decimals: number;
+            chainId: number;
+            symbol: string;
+            logo?: string;
+            amount: string;
+            included: boolean;
+        }[];
+        protocolFee: {
+            amountUSD: string;
+            address: string;
+            decimals: number;
+            chainId: number;
+            symbol: string;
+            logo?: string;
+            amount: string;
+            included: boolean;
+        }[];
+    };
+};
+export declare const updatePath: (data: TradeQuote, tokensPrice: Record<number, Record<string, string | null>>) => {
+    fee: {
+        gasFee: {
+            amountUSD: string;
+            address: string;
+            decimals: number;
+            chainId: number;
+            symbol: string;
+            logo?: string;
+            amount: string;
+            included: boolean;
+        }[];
+        providerFee: {
+            amountUSD: string;
+            address: string;
+            decimals: number;
+            chainId: number;
+            symbol: string;
+            logo?: string;
+            amount: string;
+            included: boolean;
+        }[];
+        protocolFee: {
+            amountUSD: string;
+            address: string;
+            decimals: number;
+            chainId: number;
+            symbol: string;
+            logo?: string;
+            amount: string;
+            included: boolean;
+        }[];
+    };
+    srcAmountUSD: string;
+    destAmountUSD: string;
+    type: string;
+    exchange: import("../types").ProviderDetails;
+    srcToken: import("../types").Token;
+    srcAmount: string;
+    destToken: import("../types").Token;
+    destAmount: string;
+}[];

package/dist/src/utils/amount.js

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updatePath = exports.updateFee = exports.calculateNetGasFee = exports.calculateNetAmountUsd = exports.calculateNetGasFeeUsd = exports.calculateAmountUSD = void 0;
+const decimal_js_1 = require("decimal.js");
+const viem_1 = require("viem");
+const calculateAmountUSD = (amountInWei, decimals, price) => {
+    return decimals ? new decimal_js_1.default((0, viem_1.formatUnits)(BigInt(amountInWei), decimals)).mul(price || 0).toFixed(5) : '0';
+};
+exports.calculateAmountUSD = calculateAmountUSD;
+const calculateNetGasFeeUsd = (item) => {
+    const totalGas = item.fee.gasFee.reduce((acc, fee) => {
+        if (!fee.included) {
+            const feeAmount = fee.amountUSD || '0';
+            return acc.plus(feeAmount);
+        }
+        return acc;
+    }, new decimal_js_1.default(0));
+    return totalGas.toFixed(5);
+};
+exports.calculateNetGasFeeUsd = calculateNetGasFeeUsd;
+const calculateNetAmountUsd = (item) => {
+    let feeUSD = new decimal_js_1.default((0, exports.calculateNetGasFeeUsd)(item));
+    item.fee.providerFee.forEach((fee) => {
+        if (!fee.included) {
+            feeUSD = feeUSD.plus(new decimal_js_1.default(fee.amountUSD || '0'));
+        }
+    });
+    return new decimal_js_1.default(item.destAmountUSD || '0').minus(feeUSD).toFixed(5);
+};
+exports.calculateNetAmountUsd = calculateNetAmountUsd;
+const calculateNetGasFee = (item) => {
+    const totalGas = item.fee.gasFee.reduce((acc, fee) => {
+        if (!fee.included) {
+            const feeAmount = BigInt(fee.amount || '0');
+            return acc + feeAmount;
+        }
+        return acc;
+    }, BigInt(0));
+    return totalGas;
+};
+exports.calculateNetGasFee = calculateNetGasFee;
+const updateFee = (fee, tokensPrice) => {
+    let isUpdated = false;
+    const updateAmountUSD = (feeItem, chainId, address, amount, decimals) => {
+        var _a;
+        const price = ((_a = tokensPrice[chainId]) === null || _a === void 0 ? void 0 : _a[address]) || '0';
+        if (!feeItem.amountUSD || parseFloat(feeItem.amountUSD) === 0) {
+            isUpdated = feeItem.included === false;
+            return (0, exports.calculateAmountUSD)(amount, decimals, price);
+        }
+        return feeItem.amountUSD;
+    };
+    const updateFeeItems = (feeItems) => feeItems.map((feeItem) => (Object.assign(Object.assign({}, feeItem), { amountUSD: updateAmountUSD(feeItem, feeItem.chainId, feeItem.address, feeItem.amount, feeItem.decimals) })));
+    const updateFees = {
+        gasFee: updateFeeItems(fee.gasFee),
+        providerFee: updateFeeItems(fee.providerFee),
+        protocolFee: updateFeeItems(fee.protocolFee),
+    };
+    return {
+        isUpdated: isUpdated,
+        fee: updateFees,
+    };
+};
+exports.updateFee = updateFee;
+const updatePath = (data, tokensPrice) => {
+    return data.path.map((path) => {
+        const { fee } = (0, exports.updateFee)(path.fee, tokensPrice);
+        return Object.assign(Object.assign({}, path), { fee, srcAmountUSD: data.srcAmountUSD, destAmountUSD: data.destAmountUSD });
+    });
+};
+exports.updatePath = updatePath;

package/dist/src/utils/axios.d.ts

@@ -0,0 +1,13 @@
+import { CancelToken, Method } from 'axios';
+import AxiosClient from '../axios';
+type Invoke = {
+    endpoint: string;
+    data?: any;
+    method?: Method;
+    cancelToken?: CancelToken;
+    shouldRetry?: boolean;
+    baseClient?: AxiosClient;
+};
+export declare const invoke: ({ endpoint, data, method, cancelToken, shouldRetry }: Invoke) => Promise<any>;
+export declare const invokeZap: ({ endpoint, data, method, cancelToken, shouldRetry }: Invoke) => Promise<any>;
+export {};

package/dist/src/utils/axios.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.invokeZap = exports.invoke = void 0;
+const baseClient_1 = require("../axios/baseClient");
+const httpMethods_1 = require("../constants/httpMethods");
+const config_1 = require("../config");
+const invoke = async ({ endpoint, data, method = httpMethods_1.POST, cancelToken, shouldRetry = false }) => {
+    const apiKey = config_1.config.getApiKey();
+    const axiosConfig = {
+        method,
+        url: endpoint,
+        data: method === httpMethods_1.GET ? undefined : data,
+        params: method === httpMethods_1.GET ? data : undefined,
+        headers: Object.assign({ 'Content-Type': 'application/json' }, (apiKey ? { 'x-api-key': apiKey } : {})),
+        cancelToken,
+        shouldRetry,
+    };
+    return (0, baseClient_1.baseApiClient)(axiosConfig)
+        .then((res) => res.data)
+        .catch((error) => {
+        return Promise.reject(error);
+    });
+};
+exports.invoke = invoke;
+const invokeZap = async ({ endpoint, data, method = httpMethods_1.POST, cancelToken, shouldRetry = false }) => {
+    const apiKey = config_1.config.getApiKey();
+    const axiosConfig = {
+        method,
+        url: endpoint,
+        data: method === httpMethods_1.GET ? undefined : data,
+        params: method === httpMethods_1.GET ? data : undefined,
+        headers: Object.assign({ 'Content-Type': 'application/json' }, (apiKey ? { 'x-api-key': apiKey } : {})),
+        cancelToken,
+        shouldRetry,
+    };
+    return (0, baseClient_1.baseZapApiClient)(axiosConfig)
+        .then((res) => res.data)
+        .catch((error) => {
+        return Promise.reject(error);
+    });
+};
+exports.invokeZap = invokeZap;

package/dist/src/utils/date.d.ts

@@ -0,0 +1 @@
+export declare const generateDeadline: (expiryInSecs: number) => bigint;

package/dist/src/utils/date.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateDeadline = void 0;
+const generateDeadline = (expiryInSecs) => {
+    const currentTime = Math.floor(Date.now() / 1000);
+    return BigInt(currentTime + expiryInSecs);
+};
+exports.generateDeadline = generateDeadline;