@dzapio/sdk 2.0.7 → 2.0.8

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

@@ -1,489 +0,0 @@
-import { Signer } from 'ethers';
-import { Prettify, TypedDataDomain, WalletClient } from 'viem';
-import { DZapAbis, GaslessTxType, OtherAbis, QuoteFilters, Services, STATUS, STATUS_RESPONSE } from './../constants';
-import { ApprovalModes } from './../constants/approval';
-import { PermitTypes } from './../constants/permit';
-import { AppEnv, ContractVersion, StatusCodes, TxnStatus } from './../enums';
-import { PsbtInput, PsbtOutput } from './btc';
-import { GaslessBridgeParams, GaslessSwapParams } from './permit';
-export type HexString = `0x${string}`;
-export type ChainData = {
-    [key in number]: Chain;
-};
-export type NativeTokenInfo = {
-    contract: string;
-    symbol: string;
-    decimals: number;
-    name: string;
-    balance: string;
-    price?: string;
-    logo: string;
-};
-export declare const contractErrorActions: {
-    readonly TRY_ANOTHER_ROUTE: "TRY_ANOTHER_ROUTE";
-    readonly INCREASE_SLIPPAGE: "INCREASE_SLIPPAGE";
-    readonly INCREASE_ALLOWANCE: "INCREASE_ALLOWANCE";
-};
-export type ContractErrorResponse = {
-    status: string;
-    txId: string;
-    code: number;
-    message: string;
-    error: unknown;
-    action: keyof typeof contractErrorActions;
-    details?: unknown;
-};
-export type CalculatePointsRequest = {
-    srcTokens: {
-        amount: string;
-        address: string;
-        decimals: number;
-    }[];
-    destTokens: {
-        amount: string;
-        address: string;
-        decimals: number;
-    }[];
-    providers: string[];
-    chainId: number;
-    account: string;
-    txType: 'swap' | 'bridge';
-};
-export type DisabledPermitTokens = {
-    eip2612: string[];
-};
-export type Chain = {
-    coinKey: string;
-    chainId: number;
-    chainType: string;
-    name: string;
-    coin: string;
-    dcaContract: string;
-    swapBridgeContract: string;
-    logo: string;
-    tokenlistUrl?: string;
-    multicallAddress?: HexString;
-    blockExplorerUrl: string;
-    nativeToken: NativeTokenInfo;
-    rpcProviders: ApiRpcResponse[];
-    pricingAvailable: boolean;
-    balanceAvailable: boolean;
-    supportedAs: {
-        source: boolean;
-        destination: boolean;
-    };
-    contracts?: Partial<{
-        router: string;
-        dca: string;
-        zap: string;
-    }>;
-    coingecko?: {
-        chainKey: string;
-        nativeTokenKey: string;
-    };
-    defiLlama?: {
-        chainKey: string;
-        nativeTokenKey: string;
-    };
-    disableMultiTxn: boolean;
-    isEnabled: boolean;
-    mainnet: boolean;
-    tags?: Tag[];
-    version?: ContractVersion;
-};
-export type ApiRpcResponse = {
-    url: string;
-    keyRequired: boolean;
-    keyType?: 'ALCHEMY_KEY' | 'BLASTAPI_KEY';
-};
-export type ProviderDetails = {
-    id: string;
-    name: string;
-    icon: string;
-};
-export type FeeDetails = {
-    address: string;
-    decimals: number;
-    chainId: number;
-    symbol: string;
-    logo?: string;
-    amount: string;
-    amountUSD: string;
-    included: boolean;
-};
-export type Fee = {
-    gasFee: FeeDetails[];
-    protocolFee: FeeDetails[];
-    providerFee: FeeDetails[];
-};
-export type QuoteFilter = keyof typeof QuoteFilters;
-export type TradeQuotesRequest = {
-    fromChain: number;
-    gasless?: boolean;
-    data: TradeQuotesRequestData[];
-    disableEstimation?: boolean;
-    account?: string;
-    allowedProtocols?: string[];
-    filter?: QuoteFilter;
-    timingStrategy?: Partial<{
-        minWaitTimeMs: number;
-        maxWaitTimeMs: number;
-        subsequentDelayMs: number;
-        preferredResultCount: number;
-    }>;
-};
-export type TradeQuotesRequestData = {
-    amount: string;
-    srcToken: string;
-    srcDecimals?: number;
-    destToken: string;
-    destDecimals?: number;
-    toChain: number;
-    slippage: number;
-    selectedSource?: string;
-};
-export type TradeStep = {
-    type: string;
-    exchange: {
-        logo: string;
-        name: string;
-    };
-};
-export type TradePath = {
-    type: string;
-    exchange: ProviderDetails;
-    srcToken: Token;
-    srcAmount: string;
-    srcAmountUSD: string;
-    destToken: Token;
-    destAmount: string;
-    destAmountUSD: string;
-    fee: Fee;
-};
-export type Tag = {
-    title: string;
-    link?: string;
-    message?: string;
-};
-export type TradeQuote = {
-    bridgeDetails?: ProviderDetails;
-    providerDetails: ProviderDetails;
-    srcAmount: string;
-    srcAmountUSD: string;
-    destAmount: string;
-    destAmountUSD: string;
-    minDestAmount: string;
-    swapPerUnit: string;
-    srcToken: Token;
-    destToken: Token;
-    fee: Fee;
-    priceImpactPercent: string;
-    duration: string;
-    gasless: boolean;
-    steps: TradeStep[];
-    path: TradePath[];
-    tags?: Tag[];
-    additionalInfo?: AdditionalInfo;
-};
-export type TradeQuotesByProviderId = {
-    [providerAndBridge: string]: TradeQuote;
-};
-export type TradeQuotesResponse = {
-    [pair: string]: {
-        status?: string;
-        message?: string;
-        recommendedSource: string;
-        fastestSource?: string;
-        bestReturnSource: string;
-        questSource?: string;
-        quoteRates?: TradeQuotesByProviderId;
-        tokensWithoutPrice: Record<number, string[]>;
-    };
-};
-export type AdditionalInfo = {
-    [key: string]: unknown;
-};
-export type Token = {
-    address: HexString;
-    decimals: number;
-    chainId: number;
-    logo: string;
-    symbol: string;
-    price?: string;
-};
-export type TokenPermitData = {
-    eip2612: {
-        supported: boolean;
-        data?: {
-            domain?: TypedDataDomain;
-        };
-    };
-    permit2: {
-        supported: boolean;
-    };
-};
-export type TokenInfo = Prettify<NativeTokenInfo & {
-    chainId: number;
-    balanceInUsd?: number | null;
-    isDisabledOnSwapBridge?: {
-        source: boolean;
-        destination: boolean;
-    };
-    isDisabledOnZap?: {
-        source: boolean;
-        destination: boolean;
-    };
-    permit?: TokenPermitData;
-}>;
-export type TokenResponse = {
-    [key: string]: TokenInfo;
-};
-export type TradeBuildTxnRequest = {
-    sender: HexString;
-    refundee: HexString;
-    fromChain: number;
-    gasless: boolean;
-    disableEstimation?: boolean;
-    data: TradeBuildTxnRequestData[];
-    hasPermit2ApprovalForAllTokens?: boolean;
-    publicKey?: string;
-};
-export type TradeBuildTxnRequestData = {
-    amount: string;
-    srcToken: string;
-    srcDecimals?: number;
-    destToken: string;
-    destDecimals?: number;
-    toChain: number;
-    protocol: string;
-    recipient: string;
-    slippage: number;
-    additionalInfo?: AdditionalInfo;
-    permitData?: string;
-    permit?: TokenPermitData;
-};
-export type ParamQuotes = {
-    additionalInfo?: Record<string, unknown>;
-    destAmount: string;
-    provider: string;
-    minDestAmount: string;
-};
-export type EvmTxData = {
-    from: HexString;
-    data: HexString;
-    to: HexString;
-    value: string;
-    gasLimit: string;
-};
-export type SvmTxData = {
-    from: string;
-    data: string;
-    blockhash?: string;
-    lastValidBlockHeight?: number;
-};
-export type BtcTxData = {
-    from: string;
-    data: string;
-    inputs: PsbtInput[];
-    outputs: PsbtOutput[];
-    feeRate: number;
-};
-export type TxData = EvmTxData | SvmTxData | BtcTxData;
-export type TxRequestData<T> = {
-    status: typeof STATUS.success;
-    txId: string;
-    chainId: number;
-    transaction: T;
-};
-export type TradeGasBuildTxnResponse<T = TxData> = TxRequestData<T> & {
-    quotes: Record<string, ParamQuotes>;
-    gasless: false;
-};
-export type TradeBuildTxnResponse = TradeGasBuildTxnResponse & {
-    data: string;
-    from: string;
-    to?: string;
-    value?: string;
-    gasLimit?: string;
-    svmTxData?: {
-        blockhash: string;
-        lastValidBlockHeight: number;
-    };
-    btcTxData?: {
-        inputs: PsbtInput[];
-        outputs: PsbtOutput[];
-        feeRate: number;
-    };
-    additionalInfo: Record<string, Record<string, unknown>>;
-    updatedQuotes: Record<string, string>;
-};
-export type GaslessTxTypes = keyof typeof GaslessTxType;
-type BridgeGaslessTxData = {
-    executorFeesHash: HexString;
-    swapDataHash?: HexString;
-    adapterDataHash: HexString;
-    txType: typeof GaslessTxType.bridge;
-    value: string;
-};
-type SwapGaslessTxData = {
-    executorFeesHash: HexString;
-    swapDataHash: HexString;
-    txType: typeof GaslessTxType.swap;
-    value: string;
-};
-export type GaslessTradeBuildTxnResponse = {
-    status: 'success';
-    txId: HexString;
-    transaction: BridgeGaslessTxData | SwapGaslessTxData;
-    quotes: Record<string, ParamQuotes>;
-    gasless: true;
-    onlySwapData: false;
-};
-export type AvailableDZapServices = (typeof Services)[keyof typeof Services];
-export type DZapAvailableAbis = (typeof DZapAbis)[keyof typeof DZapAbis];
-export type OtherAvailableAbis = (typeof OtherAbis)[keyof typeof OtherAbis];
-export type AppEnvType = `${AppEnv}`;
-export type DZapTransactionResponse = {
-    status: TxnStatus;
-    errorMsg?: string;
-    code: StatusCodes | number;
-    action?: keyof typeof contractErrorActions;
-    txnHash?: HexString;
-    error?: unknown;
-    additionalInfo?: Record<string, unknown>;
-    updatedQuotes?: Record<string, string>;
-};
-export type SwapInfo = {
-    dex: string;
-    fromToken: string;
-    fromAmount: bigint;
-    toToken: string;
-    returnToAmount: bigint;
-};
-export type PartialStatusData = {
-    receiveToken?: string;
-    receiveAmount?: string;
-    receiveAmountUSD?: string;
-};
-export type RefundStatusData = {
-    refundTxHash?: string;
-    refundToken?: string;
-    refundAmount?: string;
-    refundAmountUSD?: string;
-    refundTimeStamp?: string;
-};
-export type TradeStatusResponseData = PartialStatusData & RefundStatusData & {
-    srcChainId: number;
-    srcToken: string;
-    srcAmount: string;
-    srcAmountUSD: string;
-    srcTxHash: string;
-    destChainId: number;
-    destToken: string;
-    destAmount: string;
-    destAmountUSD: string;
-    destTxHash: string;
-    account: string;
-    recipient: string;
-    provider: string;
-    allowUserTxOnDestChain: boolean;
-    status: keyof typeof STATUS_RESPONSE;
-    outputToken?: string;
-    refundTxHash?: string;
-};
-export type TradeStatusResponse = {
-    [pair: string]: TradeStatusResponseData;
-};
-export type EIP2612GaslessExecuteTxParams = {
-    permitData: {
-        token: HexString;
-        amount: string;
-        permit: HexString;
-    }[];
-    gaslessIntentSignature: HexString;
-    gaslessIntentDeadline: string;
-    gaslessIntentNonce: string;
-};
-export type BatchGaslessExecuteTxParams = {
-    batchPermitData: HexString;
-};
-export type GaslessExecuteTxParams = {
-    chainId: number;
-    txId: HexString;
-    permit: EIP2612GaslessExecuteTxParams | BatchGaslessExecuteTxParams;
-};
-export type PermitMode = keyof typeof PermitTypes;
-export type ApprovalMode = Exclude<keyof typeof ApprovalModes, 'EIP2612Permit'>;
-export type SinglePermitCallbackParams = {
-    permitData: HexString;
-    srcToken: HexString;
-    amount: string;
-    permitType: Exclude<PermitMode, keyof typeof PermitTypes.PermitBatchWitnessTransferFrom>;
-};
-export type BatchPermitCallbackParams = {
-    batchPermitData: HexString;
-    tokens: {
-        address: HexString;
-        amount: string;
-    }[];
-    permitType: typeof PermitTypes.PermitBatchWitnessTransferFrom;
-};
-export type SignatureCallbackParams = SinglePermitCallbackParams | BatchPermitCallbackParams;
-export type SignatureParamsBase = {
-    chainId: number;
-    sender: HexString;
-    signer: WalletClient | Signer;
-    tokens: {
-        address: HexString;
-        permitData?: HexString;
-        amount: string;
-        permit?: TokenPermitData;
-    }[];
-    spender: HexString;
-    rpcUrls: string[];
-    permitType: PermitMode;
-    isBatchPermitAllowed?: boolean;
-    signatureCallback?: (params: SignatureCallbackParams) => Promise<void>;
-    service: AvailableDZapServices;
-    contractVersion: ContractVersion;
-};
-export type GasSignatureParams = SignatureParamsBase & {
-    gasless: false;
-};
-export type GaslessSignatureParams = ((SignatureParamsBase & GaslessBridgeParams) | (SignatureParamsBase & GaslessSwapParams)) & {
-    gasless: true;
-};
-export type SignatureParams = GasSignatureParams | GaslessSignatureParams;
-export type SignPermitResponse = {
-    status: TxnStatus.success;
-    code: StatusCodes;
-    tokens: {
-        address: HexString;
-        permitData?: HexString;
-        amount: string;
-    }[];
-    permitType: PermitMode;
-} | {
-    status: TxnStatus.success;
-    code: StatusCodes;
-    batchPermitData: HexString;
-    permitType: typeof PermitTypes.PermitBatchWitnessTransferFrom;
-} | {
-    status: Exclude<TxnStatus, typeof TxnStatus.success>;
-    code: StatusCodes;
-    permitType: PermitMode;
-};
-export type BroadcastTxData = string;
-export type BroadcastTxParams = {
-    txId: string;
-    chainId: number;
-    txData: BroadcastTxData;
-};
-export type BroadcastTxResponse = {
-    status: TxnStatus.success;
-    txnHash: string;
-} | {
-    status: Exclude<TxnStatus, typeof TxnStatus.success>;
-    message: string;
-};
-export {};

package/dist/src/types/index.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.contractErrorActions = void 0;
-exports.contractErrorActions = {
-    TRY_ANOTHER_ROUTE: 'TRY_ANOTHER_ROUTE',
-    INCREASE_SLIPPAGE: 'INCREASE_SLIPPAGE',
-    INCREASE_ALLOWANCE: 'INCREASE_ALLOWANCE',
-};

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

@@ -1,191 +0,0 @@
-import { Signer, TypedDataField } from 'ethers';
-import { HexString, PermitMode, StatusCodes, TxnStatus } from '..';
-import { GaslessTxType } from '../constants';
-import { permit2PrimaryType } from '../constants/permit';
-import { ContractVersion } from '../enums';
-import { Address, TypedDataDomain, WalletClient } from 'viem';
-import { AvailableDZapServices, TokenPermitData } from '.';
-export declare const defaultWitnessType: {
-    typeName: string;
-    type: {
-        DZapTransferWitness: {
-            name: string;
-            type: string;
-        }[];
-    };
-};
-export declare const swapGaslessWitnessType: {
-    typeName: string;
-    type: {
-        DZapSwapWitness: {
-            name: string;
-            type: string;
-        }[];
-    };
-};
-export declare const bridgeGaslessWitnessType: {
-    typeName: string;
-    type: {
-        DZapBridgeWitness: {
-            name: string;
-            type: string;
-        }[];
-    };
-};
-export declare const BatchPermitAbiParams: readonly [{
-    readonly name: "permit";
-    readonly type: "tuple";
-    readonly components: readonly [{
-        readonly name: "permitted";
-        readonly type: "tuple[]";
-        readonly components: readonly [{
-            readonly name: "token";
-            readonly type: "address";
-        }, {
-            readonly name: "amount";
-            readonly type: "uint256";
-        }];
-    }, {
-        readonly name: "nonce";
-        readonly type: "uint256";
-    }, {
-        readonly name: "deadline";
-        readonly type: "uint256";
-    }];
-}, {
-    readonly name: "permitSignature";
-    readonly type: "bytes";
-}];
-type BaseToken = {
-    address: HexString;
-    amount: string;
-};
-export type TokenWithIndex = {
-    index: number;
-} & BaseToken;
-type TokenPermissions = {
-    token: Address;
-    amount: bigint;
-};
-export type TokenWithPermitData = {
-    index: number;
-    address: HexString;
-    amount: string;
-    permit?: TokenPermitData;
-};
-export type Permit2PrimaryType = (typeof permit2PrimaryType)[keyof typeof permit2PrimaryType];
-type GaslessBaseParams = {
-    gasless: true;
-    txId: HexString;
-    executorFeesHash: HexString;
-};
-export type GaslessSwapParams = {
-    txType: typeof GaslessTxType.swap;
-    swapDataHash: HexString;
-} & GaslessBaseParams;
-export type GaslessBridgeParams = {
-    txType: typeof GaslessTxType.bridge;
-    adapterDataHash: HexString;
-    swapDataHash?: HexString;
-} & GaslessBaseParams;
-export type BasePermitParams = {
-    chainId: number;
-    account: HexString;
-    spender: HexString;
-    rpcUrls?: string[];
-    deadline?: bigint;
-    signer: WalletClient | Signer;
-    contractVersion: ContractVersion;
-    service: AvailableDZapServices;
-};
-type Permit2612BaseParams = {
-    token: TokenWithPermitData;
-    version: string;
-    sigDeadline?: bigint;
-    name: string;
-    nonce: bigint;
-} & BasePermitParams;
-export type DefaultPermit2612Params = {
-    gasless: false;
-} & Permit2612BaseParams;
-type GaslessSwapPermit2612Params = BasePermitParams & GaslessSwapParams;
-type GaslessBridgePermit2612Params = BasePermitParams & GaslessBridgeParams;
-export type Gasless2612PermitParams = GaslessSwapPermit2612Params | GaslessBridgePermit2612Params;
-export type CustomTypedDataParams = {
-    account: HexString;
-    signer: WalletClient | Signer;
-    domain: TypedDataDomain;
-    types: Record<string, Array<TypedDataField>>;
-    message: Record<string, any>;
-    primaryType: string;
-};
-export type Permit2612Params = DefaultPermit2612Params | Gasless2612PermitParams;
-export type BasePermit2Params = {
-    tokens: TokenWithPermitData[];
-    expiration?: bigint;
-    permitType: Permit2PrimaryType;
-    firstTokenNonce?: bigint;
-} & BasePermitParams;
-type DefaultPermit2Params = {
-    gasless: false;
-} & BasePermit2Params;
-type GaslessSwapPermit2Params = BasePermit2Params & GaslessSwapParams;
-type GaslessBridgePermit2Params = BasePermit2Params & GaslessBridgeParams;
-export type Permit2Params = DefaultPermit2Params | GaslessSwapPermit2Params | GaslessBridgePermit2Params;
-export type PermitParams = Permit2612Params | Permit2Params;
-export type BasePermitResponse = {
-    status: TxnStatus;
-    code: StatusCodes;
-    permitData?: HexString;
-    nonce?: bigint;
-};
-export type PermitResponse = {
-    permitType: PermitMode;
-} & BasePermitResponse;
-export type BatchPermitResponse = {
-    permitType: typeof permit2PrimaryType.PermitBatchWitnessTransferFrom;
-} & BasePermitResponse;
-type BaseWitnessStructure<T, N extends string, TType> = {
-    witness: T;
-    witnessTypeName: N;
-    witnessType: TType;
-};
-type GaslessWitnessData = {
-    txId: HexString;
-    user: HexString;
-    executorFeesHash: HexString;
-    swapDataHash: HexString;
-};
-type BridgeWitnessData = {
-    adapterDataHash: HexString;
-} & GaslessWitnessData;
-export type DefaultWitnessData = BaseWitnessStructure<{
-    owner: HexString;
-    recipient: HexString;
-}, typeof defaultWitnessType.typeName, typeof defaultWitnessType.type>;
-export type SwapGaslessWitnessData = BaseWitnessStructure<GaslessWitnessData, typeof swapGaslessWitnessType.typeName, typeof swapGaslessWitnessType.type>;
-export type BridgeGaslessWitnessData = BaseWitnessStructure<BridgeWitnessData, typeof bridgeGaslessWitnessType.typeName, typeof bridgeGaslessWitnessType.type>;
-export type WitnessData = DefaultWitnessData | SwapGaslessWitnessData | BridgeGaslessWitnessData;
-export type PermitSingleValues = {
-    details: {
-        token: Address;
-        amount: bigint;
-        expiration: bigint;
-        nonce: number;
-    };
-    spender: Address;
-    sigDeadline: bigint;
-};
-export type PermitTransferFromValues = {
-    permitted: TokenPermissions;
-    spender: Address;
-    nonce: bigint;
-    deadline: bigint;
-};
-export type PermitBatchTransferFromValues = {
-    permitted: TokenPermissions[];
-    spender: Address;
-    nonce: bigint;
-    deadline: bigint;
-};
-export {};