@dzapio/sdk 2.0.25 → 2.0.27

package/README.md

@@ -245,9 +245,11 @@ const dZapWithCustomRpc = DZapClient.getInstance(customRpcUrls);
   - `service`: AvailableDZapServices
   - `mode?`: ApprovalMode (defaults to `ApprovalModes.AutoPermit`)
 - **Output:**
-  - `{ status, code, data: { tokenAllowances, noOfApprovalsRequired, noOfSignaturesRequired } }`
+  - `{ status, code, data} }`
 - **Description:**
-  Returns the current allowance for each token and indicates how many approvals/signatures are needed.
+  - `data` is a map **token address → `{ allowance: bigint, type }`**
+  - `type` is an allowance route (`AllowanceTypes`): e.g. direct DZap contract (`dzap`), Permit2 (`permit2`), or EIP-2612 (`eip2612`).
+    Use the returned `allowance` vs your required `amount` per token to see if an `approve` or `sign` step is still needed; combine with `type` to choose the right follow-up (`approve`, `sign`, etc.).
 
 #### `approve({ chainId, signer, sender, rpcUrls, tokens, service, mode, approvalTxnCallback })`
 

package/dist/index.d.mts

@@ -144,6 +144,13 @@ type PsbtOutput = {
     value: number;
 };
 
+declare const AllowanceTypes: {
+    readonly eip2612: "eip2612";
+    readonly permit2: "permit2";
+    readonly dzap: "dzap";
+};
+type AllowanceType = (typeof AllowanceTypes)[keyof typeof AllowanceTypes];
+
 type HexString = `0x${string}`;
 type StatusResponse = keyof typeof STATUS_RESPONSE;
 type ChainData = {
@@ -708,12 +715,17 @@ type ZapIntegratorConfig = {
     wallet: string;
 };
 type ZapBuildTxnResponse = {
-    amountOut: string;
     approvalData: {
         callTo: HexString;
         approveTo: HexString;
         amount: string;
-    } | null;
+    }[];
+    output: {
+        address: string;
+        amount: string;
+        chainId: number;
+        minAmount: string;
+    }[];
     steps: ZapStep[];
     path: ZapPath[];
 };
@@ -1845,8 +1857,7 @@ declare class DZapClient {
         data: {
             [key: string]: {
                 allowance: bigint;
-                approvalNeeded: boolean;
-                signatureNeeded: boolean;
+                type: AllowanceType;
             };
         };
     }>;
@@ -1949,4 +1960,4 @@ declare const checkEIP2612PermitSupport: ({ address, chainId, rpcUrls, owner, pe
 
 declare const formatToken: <T extends HexString | string = string>(token: T, nativeTokenAddress?: T) => T;
 
-export { type ApiRpcResponse, type ApprovalMode, ApprovalModes, type BatchPermitCallbackParams, type BtcTxData, type Chain, type ChainData, type ContractErrorResponse, DZapClient, DZapPermitMode, type DZapTransactionResponse, type EvmTxData, type Fee, type FeeDetails, type GaslessTradeBuildTxnResponse, type HexString, OtherAbis, type ParamQuotes, type PermitMode, PermitTypes, type ProviderDetails, type PsbtInput, type PsbtOutput, type QuoteFilter, QuoteFilters, STATUS, type SVMTxnDetails, Services, type SignPermitResponse, type SignatureCallbackParams, SignatureExpiryInSecs, type SinglePermitCallbackParams, StatusCodes, type StepAction, type SvmTxData, type SwapInfo, SwapInputDataDecoder, type Token, type TokenInfo, type TokenPermitData, type TokenResponse, type TradeBuildTxnRequest, type TradeBuildTxnRequestData, type TradeBuildTxnResponse, type TradeGasBuildTxnResponse, type TradePath, type TradeQuotesRequest, type TradeQuotesRequestData, type TradeQuotesResponse, type TradeStatusResponse, type TradeStep, TxnStatus, type ZapBuildTxnRequest, type ZapBuildTxnResponse, type ZapBundleAction, type ZapBundleRequest, type ZapBundleSrcToken, type ZapBvmTxnDetails, type ZapChains, type ZapEvmTxnDetails, type ZapFee, type ZapIntegratorConfig, type ZapPath, type ZapPathAction, type ZapPathAsset, type ZapPool, type ZapPoolDetails, type ZapPoolDetailsRequest, type ZapPoolsRequest, type ZapPoolsResponse, type ZapPosition, type ZapPositionsRequest, type ZapPositionsResponse, type ZapProviders, type ZapQuoteRequest, type ZapQuoteResponse, type ZapRouteRequestPoolDetails, type ZapRouteRequestPositionDetails, type ZapStatus, type ZapStatusAsset, type ZapStatusRequest, type ZapStatusResponse, type ZapStatusStep, type ZapStep, type ZapTransactionStep, type ZapTxnDetails, type ZapUnderlyingToken, type ZapUnderlyingTokenWithAmount, checkEIP2612PermitSupport, contractErrorActions, erc20Functions, formatToken, getTokensPairKey, zapPathAction, zapStepAction };
+export { type AllowanceType, AllowanceTypes, type ApiRpcResponse, type ApprovalMode, ApprovalModes, type BatchPermitCallbackParams, type BtcTxData, type Chain, type ChainData, type ContractErrorResponse, DZapClient, DZapPermitMode, type DZapTransactionResponse, type EvmTxData, type Fee, type FeeDetails, type GaslessTradeBuildTxnResponse, type HexString, OtherAbis, type ParamQuotes, type PermitMode, PermitTypes, type ProviderDetails, type PsbtInput, type PsbtOutput, type QuoteFilter, QuoteFilters, STATUS, type SVMTxnDetails, Services, type SignPermitResponse, type SignatureCallbackParams, SignatureExpiryInSecs, type SinglePermitCallbackParams, StatusCodes, type StepAction, type SvmTxData, type SwapInfo, SwapInputDataDecoder, type Token, type TokenInfo, type TokenPermitData, type TokenResponse, type TradeBuildTxnRequest, type TradeBuildTxnRequestData, type TradeBuildTxnResponse, type TradeGasBuildTxnResponse, type TradePath, type TradeQuotesRequest, type TradeQuotesRequestData, type TradeQuotesResponse, type TradeStatusResponse, type TradeStep, TxnStatus, type ZapBuildTxnRequest, type ZapBuildTxnResponse, type ZapBundleAction, type ZapBundleRequest, type ZapBundleSrcToken, type ZapBvmTxnDetails, type ZapChains, type ZapEvmTxnDetails, type ZapFee, type ZapIntegratorConfig, type ZapPath, type ZapPathAction, type ZapPathAsset, type ZapPool, type ZapPoolDetails, type ZapPoolDetailsRequest, type ZapPoolsRequest, type ZapPoolsResponse, type ZapPosition, type ZapPositionsRequest, type ZapPositionsResponse, type ZapProviders, type ZapQuoteRequest, type ZapQuoteResponse, type ZapRouteRequestPoolDetails, type ZapRouteRequestPositionDetails, type ZapStatus, type ZapStatusAsset, type ZapStatusRequest, type ZapStatusResponse, type ZapStatusStep, type ZapStep, type ZapTransactionStep, type ZapTxnDetails, type ZapUnderlyingToken, type ZapUnderlyingTokenWithAmount, checkEIP2612PermitSupport, contractErrorActions, erc20Functions, formatToken, getTokensPairKey, zapPathAction, zapStepAction };

package/dist/index.d.ts

@@ -144,6 +144,13 @@ type PsbtOutput = {
     value: number;
 };
 
+declare const AllowanceTypes: {
+    readonly eip2612: "eip2612";
+    readonly permit2: "permit2";
+    readonly dzap: "dzap";
+};
+type AllowanceType = (typeof AllowanceTypes)[keyof typeof AllowanceTypes];
+
 type HexString = `0x${string}`;
 type StatusResponse = keyof typeof STATUS_RESPONSE;
 type ChainData = {
@@ -708,12 +715,17 @@ type ZapIntegratorConfig = {
     wallet: string;
 };
 type ZapBuildTxnResponse = {
-    amountOut: string;
     approvalData: {
         callTo: HexString;
         approveTo: HexString;
         amount: string;
-    } | null;
+    }[];
+    output: {
+        address: string;
+        amount: string;
+        chainId: number;
+        minAmount: string;
+    }[];
     steps: ZapStep[];
     path: ZapPath[];
 };
@@ -1845,8 +1857,7 @@ declare class DZapClient {
         data: {
             [key: string]: {
                 allowance: bigint;
-                approvalNeeded: boolean;
-                signatureNeeded: boolean;
+                type: AllowanceType;
             };
         };
     }>;
@@ -1949,4 +1960,4 @@ declare const checkEIP2612PermitSupport: ({ address, chainId, rpcUrls, owner, pe
 
 declare const formatToken: <T extends HexString | string = string>(token: T, nativeTokenAddress?: T) => T;
 
-export { type ApiRpcResponse, type ApprovalMode, ApprovalModes, type BatchPermitCallbackParams, type BtcTxData, type Chain, type ChainData, type ContractErrorResponse, DZapClient, DZapPermitMode, type DZapTransactionResponse, type EvmTxData, type Fee, type FeeDetails, type GaslessTradeBuildTxnResponse, type HexString, OtherAbis, type ParamQuotes, type PermitMode, PermitTypes, type ProviderDetails, type PsbtInput, type PsbtOutput, type QuoteFilter, QuoteFilters, STATUS, type SVMTxnDetails, Services, type SignPermitResponse, type SignatureCallbackParams, SignatureExpiryInSecs, type SinglePermitCallbackParams, StatusCodes, type StepAction, type SvmTxData, type SwapInfo, SwapInputDataDecoder, type Token, type TokenInfo, type TokenPermitData, type TokenResponse, type TradeBuildTxnRequest, type TradeBuildTxnRequestData, type TradeBuildTxnResponse, type TradeGasBuildTxnResponse, type TradePath, type TradeQuotesRequest, type TradeQuotesRequestData, type TradeQuotesResponse, type TradeStatusResponse, type TradeStep, TxnStatus, type ZapBuildTxnRequest, type ZapBuildTxnResponse, type ZapBundleAction, type ZapBundleRequest, type ZapBundleSrcToken, type ZapBvmTxnDetails, type ZapChains, type ZapEvmTxnDetails, type ZapFee, type ZapIntegratorConfig, type ZapPath, type ZapPathAction, type ZapPathAsset, type ZapPool, type ZapPoolDetails, type ZapPoolDetailsRequest, type ZapPoolsRequest, type ZapPoolsResponse, type ZapPosition, type ZapPositionsRequest, type ZapPositionsResponse, type ZapProviders, type ZapQuoteRequest, type ZapQuoteResponse, type ZapRouteRequestPoolDetails, type ZapRouteRequestPositionDetails, type ZapStatus, type ZapStatusAsset, type ZapStatusRequest, type ZapStatusResponse, type ZapStatusStep, type ZapStep, type ZapTransactionStep, type ZapTxnDetails, type ZapUnderlyingToken, type ZapUnderlyingTokenWithAmount, checkEIP2612PermitSupport, contractErrorActions, erc20Functions, formatToken, getTokensPairKey, zapPathAction, zapStepAction };
+export { type AllowanceType, AllowanceTypes, type ApiRpcResponse, type ApprovalMode, ApprovalModes, type BatchPermitCallbackParams, type BtcTxData, type Chain, type ChainData, type ContractErrorResponse, DZapClient, DZapPermitMode, type DZapTransactionResponse, type EvmTxData, type Fee, type FeeDetails, type GaslessTradeBuildTxnResponse, type HexString, OtherAbis, type ParamQuotes, type PermitMode, PermitTypes, type ProviderDetails, type PsbtInput, type PsbtOutput, type QuoteFilter, QuoteFilters, STATUS, type SVMTxnDetails, Services, type SignPermitResponse, type SignatureCallbackParams, SignatureExpiryInSecs, type SinglePermitCallbackParams, StatusCodes, type StepAction, type SvmTxData, type SwapInfo, SwapInputDataDecoder, type Token, type TokenInfo, type TokenPermitData, type TokenResponse, type TradeBuildTxnRequest, type TradeBuildTxnRequestData, type TradeBuildTxnResponse, type TradeGasBuildTxnResponse, type TradePath, type TradeQuotesRequest, type TradeQuotesRequestData, type TradeQuotesResponse, type TradeStatusResponse, type TradeStep, TxnStatus, type ZapBuildTxnRequest, type ZapBuildTxnResponse, type ZapBundleAction, type ZapBundleRequest, type ZapBundleSrcToken, type ZapBvmTxnDetails, type ZapChains, type ZapEvmTxnDetails, type ZapFee, type ZapIntegratorConfig, type ZapPath, type ZapPathAction, type ZapPathAsset, type ZapPool, type ZapPoolDetails, type ZapPoolDetailsRequest, type ZapPoolsRequest, type ZapPoolsResponse, type ZapPosition, type ZapPositionsRequest, type ZapPositionsResponse, type ZapProviders, type ZapQuoteRequest, type ZapQuoteResponse, type ZapRouteRequestPoolDetails, type ZapRouteRequestPositionDetails, type ZapStatus, type ZapStatusAsset, type ZapStatusRequest, type ZapStatusResponse, type ZapStatusStep, type ZapStep, type ZapTransactionStep, type ZapTxnDetails, type ZapUnderlyingToken, type ZapUnderlyingTokenWithAmount, checkEIP2612PermitSupport, contractErrorActions, erc20Functions, formatToken, getTokensPairKey, zapPathAction, zapStepAction };

package/dist/index.js

@@ -12919,6 +12919,11 @@ var BatchPermitAbiParams = [
   },
   { name: "permitSignature", type: "bytes" }
 ];
+var AllowanceTypes = {
+  eip2612: "eip2612",
+  permit2: "permit2",
+  dzap: "dzap"
+};
 
 // src/utils/permit2/domain.ts
 var PERMIT2_DOMAIN_NAME = "Permit2";
@@ -14536,7 +14541,7 @@ var getAllowance = async ({ chainId, sender, tokens, rpcUrls, multicallAddress,
   const nativeTokens2 = tokens.filter(({ address }) => isDZapNativeToken(address));
   const erc20Tokens = tokens.filter(({ address }) => !isDZapNativeToken(address));
   const approvalData = await Promise.all(
-    erc20Tokens.map(async ({ address, amount, permit }) => {
+    erc20Tokens.map(async ({ address, permit }) => {
       if (mode === ApprovalModes.AutoPermit) {
         const eip2612PermitData = await checkEIP2612PermitSupport({
           address,
@@ -14545,30 +14550,26 @@ var getAllowance = async ({ chainId, sender, tokens, rpcUrls, multicallAddress,
           owner: sender,
           permit
         });
+        const allowanceType = eip2612PermitData.supportsPermit ? AllowanceTypes.eip2612 : AllowanceTypes.permit2;
         return {
           token: address,
           spender: eip2612PermitData.supportsPermit ? spender : getPermit2Address(chainId),
-          // @dev: not needed, but added for consistency
-          amount,
-          isEIP2612PermitSupported: eip2612PermitData.supportsPermit,
-          isDefaultApprovalMode: false
+          allowanceType
         };
       } else if (mode === ApprovalModes.Default) {
         return {
           token: address,
           spender,
-          amount,
-          isEIP2612PermitSupported: false,
-          isDefaultApprovalMode: true
+          allowanceType: AllowanceTypes.dzap
         };
       } else {
         const permit2Address = getPermit2Address(chainId);
-        return { token: address, spender: permit2Address, amount, isEIP2612PermitSupported: false, isDefaultApprovalMode: false };
+        return { token: address, spender: permit2Address, allowanceType: AllowanceTypes.permit2 };
       }
     })
   );
   for (const { address } of nativeTokens2) {
-    data[address] = { allowance: viem.maxUint256, approvalNeeded: false, signatureNeeded: false };
+    data[address] = { allowance: viem.maxUint256, type: AllowanceTypes.dzap };
   }
   if (erc20Tokens.length === 0) {
     return { status: "success" /* success */, code: 200 /* Success */, data };
@@ -14582,11 +14583,9 @@ var getAllowance = async ({ chainId, sender, tokens, rpcUrls, multicallAddress,
       rpcUrls
     });
     for (let i = 0; i < approvalData.length; i++) {
-      const { token, amount, isEIP2612PermitSupported, isDefaultApprovalMode } = approvalData[i];
-      const allowance = isEIP2612PermitSupported ? viem.maxUint256 : allowances[token];
-      const approvalNeeded = isEIP2612PermitSupported ? false : allowance < BigInt(amount);
-      const signatureNeeded = isDefaultApprovalMode ? false : true;
-      data[token] = { allowance, approvalNeeded, signatureNeeded };
+      const { token, allowanceType } = approvalData[i];
+      const allowance = allowanceType === AllowanceTypes.eip2612 ? viem.maxUint256 : allowances[token];
+      data[token] = { allowance, type: allowanceType };
     }
     return { status: "success" /* success */, code: 200 /* Success */, data };
   } catch (error) {
@@ -14637,8 +14636,9 @@ async function generateApprovalBatchCalls({
     rpcUrls
   });
   const tokensNeedingApproval = tokensToCheck.filter((token) => {
-    var _a;
-    return (_a = allowanceData[token.address]) == null ? void 0 : _a.approvalNeeded;
+    const { allowance, type } = allowanceData[token.address] ?? {};
+    if (type === AllowanceTypes.eip2612) return false;
+    return allowance === void 0 || allowance < BigInt(token.amount);
   });
   return tokensNeedingApproval.map((token) => ({
     to: token.address,
@@ -15848,17 +15848,8 @@ var _DZapClient = class _DZapClient {
    *
    * @example
    * ```typescript
-   * const allowanceInfo = await client.getAllowance({
-   *   chainId: 1,
-   *   sender: '0x...',
-   *   tokens: [
-   *     { address: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48', amount: '1000000' }
-   *   ],
-   *   service: 'swap',
-   *   mode: ApprovalModes.Permit2
-   * });
-   *
-   * console.log('Approvals needed:', allowanceInfo.data.noOfApprovalsRequired);
+   * const { status, data } = await client.getAllowance({ chainId, sender, tokens, service });
+   * const { allowance, type } = data[token]!;
    * ```
    */
   async getAllowance({
@@ -16391,6 +16382,7 @@ var zapPathAction = {
   harvest: "harvest"
 };
 
+exports.AllowanceTypes = AllowanceTypes;
 exports.ApprovalModes = ApprovalModes;
 exports.DZapClient = dZapClient_default;
 exports.DZapPermitMode = DZapPermitMode;

package/dist/index.mjs

@@ -12894,6 +12894,11 @@ var BatchPermitAbiParams = [
   },
   { name: "permitSignature", type: "bytes" }
 ];
+var AllowanceTypes = {
+  eip2612: "eip2612",
+  permit2: "permit2",
+  dzap: "dzap"
+};
 
 // src/utils/permit2/domain.ts
 var PERMIT2_DOMAIN_NAME = "Permit2";
@@ -14511,7 +14516,7 @@ var getAllowance = async ({ chainId, sender, tokens, rpcUrls, multicallAddress,
   const nativeTokens2 = tokens.filter(({ address }) => isDZapNativeToken(address));
   const erc20Tokens = tokens.filter(({ address }) => !isDZapNativeToken(address));
   const approvalData = await Promise.all(
-    erc20Tokens.map(async ({ address, amount, permit }) => {
+    erc20Tokens.map(async ({ address, permit }) => {
       if (mode === ApprovalModes.AutoPermit) {
         const eip2612PermitData = await checkEIP2612PermitSupport({
           address,
@@ -14520,30 +14525,26 @@ var getAllowance = async ({ chainId, sender, tokens, rpcUrls, multicallAddress,
           owner: sender,
           permit
         });
+        const allowanceType = eip2612PermitData.supportsPermit ? AllowanceTypes.eip2612 : AllowanceTypes.permit2;
         return {
           token: address,
           spender: eip2612PermitData.supportsPermit ? spender : getPermit2Address(chainId),
-          // @dev: not needed, but added for consistency
-          amount,
-          isEIP2612PermitSupported: eip2612PermitData.supportsPermit,
-          isDefaultApprovalMode: false
+          allowanceType
         };
       } else if (mode === ApprovalModes.Default) {
         return {
           token: address,
           spender,
-          amount,
-          isEIP2612PermitSupported: false,
-          isDefaultApprovalMode: true
+          allowanceType: AllowanceTypes.dzap
         };
       } else {
         const permit2Address = getPermit2Address(chainId);
-        return { token: address, spender: permit2Address, amount, isEIP2612PermitSupported: false, isDefaultApprovalMode: false };
+        return { token: address, spender: permit2Address, allowanceType: AllowanceTypes.permit2 };
       }
     })
   );
   for (const { address } of nativeTokens2) {
-    data[address] = { allowance: maxUint256, approvalNeeded: false, signatureNeeded: false };
+    data[address] = { allowance: maxUint256, type: AllowanceTypes.dzap };
   }
   if (erc20Tokens.length === 0) {
     return { status: "success" /* success */, code: 200 /* Success */, data };
@@ -14557,11 +14558,9 @@ var getAllowance = async ({ chainId, sender, tokens, rpcUrls, multicallAddress,
       rpcUrls
     });
     for (let i = 0; i < approvalData.length; i++) {
-      const { token, amount, isEIP2612PermitSupported, isDefaultApprovalMode } = approvalData[i];
-      const allowance = isEIP2612PermitSupported ? maxUint256 : allowances[token];
-      const approvalNeeded = isEIP2612PermitSupported ? false : allowance < BigInt(amount);
-      const signatureNeeded = isDefaultApprovalMode ? false : true;
-      data[token] = { allowance, approvalNeeded, signatureNeeded };
+      const { token, allowanceType } = approvalData[i];
+      const allowance = allowanceType === AllowanceTypes.eip2612 ? maxUint256 : allowances[token];
+      data[token] = { allowance, type: allowanceType };
     }
     return { status: "success" /* success */, code: 200 /* Success */, data };
   } catch (error) {
@@ -14612,8 +14611,9 @@ async function generateApprovalBatchCalls({
     rpcUrls
   });
   const tokensNeedingApproval = tokensToCheck.filter((token) => {
-    var _a;
-    return (_a = allowanceData[token.address]) == null ? void 0 : _a.approvalNeeded;
+    const { allowance, type } = allowanceData[token.address] ?? {};
+    if (type === AllowanceTypes.eip2612) return false;
+    return allowance === void 0 || allowance < BigInt(token.amount);
   });
   return tokensNeedingApproval.map((token) => ({
     to: token.address,
@@ -15823,17 +15823,8 @@ var _DZapClient = class _DZapClient {
    *
    * @example
    * ```typescript
-   * const allowanceInfo = await client.getAllowance({
-   *   chainId: 1,
-   *   sender: '0x...',
-   *   tokens: [
-   *     { address: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48', amount: '1000000' }
-   *   ],
-   *   service: 'swap',
-   *   mode: ApprovalModes.Permit2
-   * });
-   *
-   * console.log('Approvals needed:', allowanceInfo.data.noOfApprovalsRequired);
+   * const { status, data } = await client.getAllowance({ chainId, sender, tokens, service });
+   * const { allowance, type } = data[token]!;
    * ```
    */
   async getAllowance({
@@ -16366,4 +16357,4 @@ var zapPathAction = {
   harvest: "harvest"
 };
 
-export { ApprovalModes, dZapClient_default as DZapClient, DZapPermitMode, OtherAbis, PermitTypes, QuoteFilters, STATUS, Services, SignatureExpiryInSecs, StatusCodes, SwapInputDataDecoder, TxnStatus, checkEIP2612PermitSupport, contractErrorActions, erc20Functions, formatToken, getTokensPairKey, zapPathAction, zapStepAction };
+export { AllowanceTypes, ApprovalModes, dZapClient_default as DZapClient, DZapPermitMode, OtherAbis, PermitTypes, QuoteFilters, STATUS, Services, SignatureExpiryInSecs, StatusCodes, SwapInputDataDecoder, TxnStatus, checkEIP2612PermitSupport, contractErrorActions, erc20Functions, formatToken, getTokensPairKey, zapPathAction, zapStepAction };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dzapio/sdk",
-  "version": "2.0.25",
+  "version": "2.0.27",
   "description": "A TypeScript/JavaScript SDK for interacting with the DZap protocol, providing utilities for DeFi operations including Swaps, Bridges, and Zaps.",
   "main": "dist/index.js",
   "source": "src/index.ts",