@dzapio/sdk/dist/types/index.d.ts

A TypeScript/JavaScript SDK for interacting with the DZap protocol, providing utilities for DeFi operations including Swaps, Bridges, and Zaps.

import { DZapAbis, OtherAbis, QuoteFilters, Services, STATUS_RESPONSE } from 'src/constants';
import { AppEnv, StatusCodes, TxnStatus } from 'src/enums';
import { PsbtInput, PsbtOutput } from './btc';
import { PermitTypes } from 'src/constants/permit';
import { ApprovalModes } from 'src/constants/approval';
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;
};
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: string;
    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[];
    permitDisabledTokens?: DisabledPermitTokens;
};
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 = {
    integratorId: string;
    fromChain: number;
    data: TradeQuotesRequestData[];
    disableEstimation?: boolean;
    account?: string;
    allowedSources?: string[];
    filter?: QuoteFilter;
};
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;
    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 TokenInfo = NativeTokenInfo & {
    chainId: number;
    balanceInUsd?: number | null;
    isDisabledOnSwapBridge?: {
        source: boolean;
        destination: boolean;
    };
    isDisabledOnZap?: {
        source: boolean;
        destination: boolean;
    };
};
export type TokenResponse = {
    [key: string]: TokenInfo;
};
export type TradeBuildTxnRequest = {
    sender: HexString;
    refundee: HexString;
    integratorId: string;
    fromChain: number;
    disableEstimation?: boolean;
    data: TradeBuildTxnRequestData[];
    publicKey?: string;
};
export type TradeBuildTxnRequestData = {
    amount: string;
    srcToken: string;
    srcDecimals: number;
    destToken: string;
    destDecimals: number;
    toChain: number;
    selectedRoute: string;
    recipient: string;
    slippage: number;
    additionalInfo?: AdditionalInfo;
    permitData?: string;
};
export type ExecuteTxnData = {
    data: HexString;
    to: HexString;
    from: HexString;
    chainId: number;
    value: string;
    gasLimit: string;
};
export type TradeBuildTxnResponse = ExecuteTxnData & {
    additionalInfo?: AdditionalInfo;
    btcTxData?: {
        inputs: PsbtInput[];
        outputs: PsbtOutput[];
        feeRate: number;
    };
    svmTxData?: {
        blockhash: string;
        lastValidBlockHeight: number;
    };
    updatedQuotes: Record<string, string>;
};
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 PermitMode = keyof typeof PermitTypes;
export type ApprovalMode = Exclude<keyof typeof ApprovalModes, 'EIP2612Permit'>;