@transak/transak-sdk/lib/index.d.cts

Transak SDK that allows you to easily integrate fiat on/off ramp

declare enum Environments {
    DEVELOPMENT = "DEVELOPMENT",
    STAGING = "STAGING",
    PRODUCTION = "PRODUCTION"
}

type User = {
  firstName: string;
  lastName: string;
  email: string;
  mobileNumber: string;
  dob: string;
  address: {
    addressLine1: string;
    addressLine2: string;
    city: string;
    state: string;
    postCode: string;
    countryCode: string;
  };
};

type WalletAddresses = {
  networks?: Record<string, { address: string; addressAdditionalData?: string }>;
  coins?: Record<string, { address: string; addressAdditionalData?: string }>;
};

type NFT = {
  tokenID: string[];
  collectionAddress: string;
  price: number[];
  quantity: number;
  nftType: string;
  nftName?: string;
  imageURL?: string;
};

type ColorMode = 'LIGHT' | 'DARK';

type SourceTokenData = {
  sourceTokenCode: string;
  sourceTokenAmount: number;
};

type CryptoCurrencyData = {
  cryptoCurrencyCode: string;
  cryptoCurrencyName: string;
  cryptoCurrencyImageURL: string;
};

type TokenData = {
  tokenID: string[];
  collectionAddress: string;
  marketplace: string;
  normalizeRoyalties: boolean;
  nftName?: string;
  imageURL?: string;
};

type QueryParams = {
  apiKey: string;
  exchangeScreenTitle?: string;
  productsAvailed?: string | string[];
  defaultFiatCurrency?: string;
  fiatCurrency?: string;
  countryCode?: string;
  excludeFiatCurrencies?: string | string[];
  defaultNetwork?: string;
  network?: string;
  networks?: string | string[];
  defaultPaymentMethod?: string;
  paymentMethod?: string;
  disablePaymentMethods?: string | string[];
  defaultCryptoAmount?: number;
  defaultCryptoCurrency?: string;
  cryptoCurrencyCode?: string;
  cryptoCurrencyList?: string | string[];
  isFeeCalculationHidden?: boolean;
  hideExchangeScreen?: boolean;
  email?: string;
  userData?: User;
  isAutoFillUserData?: boolean;
  themeColor?: string;
  hideMenu?: boolean;
  redirectURL?: string;
  partnerOrderId?: string;
  partnerCustomerId?: string;
  defaultFiatAmount?: number;
  fiatAmount?: number;
  walletAddress?: string;
  walletAddressesData?: WalletAddresses;
  disableWalletAddressForm?: boolean;
  isNFT?: boolean;
  tokenId?: number;
  tradeType?: string;
  contractAddress?: string;
  calldata?: string;
  smartContractAddress?: string;
  nftData?: NFT[];
  estimatedGasLimit?: number;
  cryptoAmount?: number;
  walletRedirection?: boolean;
  referrerDomain?: string;
  colorMode?: ColorMode;
  backgroundColors?: string | string[];
  textColors?: string | string[];
  borderColors?: string | string[];
  isTransakOne?: boolean;
  sourceTokenData?: SourceTokenData[];
  cryptoCurrencyData?: CryptoCurrencyData[];
  contractId?: string;
  tokenData?: TokenData[];
  isTransakStreamOffRamp?: boolean;
};

type TransakConfig = {
  environment: Environments.STAGING | Environments.PRODUCTION;
  widgetWidth?: string;
  widgetHeight?: string;
  containerId?: string;
} & QueryParams;

declare enum Events {
    TRANSAK_WIDGET_INITIALISED = "TRANSAK_WIDGET_INITIALISED",
    TRANSAK_ORDER_CREATED = "TRANSAK_ORDER_CREATED",
    TRANSAK_ORDER_SUCCESSFUL = "TRANSAK_ORDER_SUCCESSFUL",
    TRANSAK_ORDER_CANCELLED = "TRANSAK_ORDER_CANCELLED",
    TRANSAK_ORDER_FAILED = "TRANSAK_ORDER_FAILED",
    TRANSAK_WALLET_REDIRECTION = "TRANSAK_WALLET_REDIRECTION",
    TRANSAK_WIDGET_CLOSE_REQUEST = "TRANSAK_WIDGET_CLOSE_REQUEST",
    TRANSAK_WIDGET_CLOSE = "TRANSAK_WIDGET_CLOSE",
    TRANSAK_USER_INFO_RECEIVED = "TRANSAK_USER_INFO_RECEIVED",
    TRANSAK_GET_USER_REQUEST = "TRANSAK_GET_USER_REQUEST",
    TRANSAK_LOGOUT_USER_REQUEST = "TRANSAK_LOGOUT_USER_REQUEST"
}

declare class Transak {
    #private;
    static readonly ENVIRONMENTS: typeof Environments;
    static readonly EVENTS: typeof Events;
    constructor(transakConfig: TransakConfig);
    static on: (type: "*" | keyof typeof Events, cb: (data: unknown) => void) => void;
    init: () => void;
    cleanup: () => void;
    close: () => void;
    getUser: () => void;
    logoutUser: () => void;
}

export { Transak, type TransakConfig };