@tatumio/tatum/dist/src/dto/shared.dto.d.ts

Tatum JS SDK

import { TokenType, TokenTypeWithNative } from '../api/api.dto';
export interface IdDto {
    id: string;
}
export interface TokenAddress {
    /**
     * Token contract address
     */
    tokenAddress: string;
}
export interface TokenIdContractAddress extends TokenAddress {
    /**
     * Token ID
     */
    tokenId: string;
}
interface Pagination {
    /**
     * Optional page size. If not specified, the default page size is used, which is 10.
     */
    pageSize?: number;
    /**
     * Optional page number. If not specified, the first page is returned.
     */
    page?: number;
}
export interface AddressBalanceFilters extends Pagination {
    /**
     * List of addresses to check.
     */
    addresses: string[];
    /**
     * Optional filter for token types. If not specified, all token types are returned.
     * Allowed values are `native`, `fungible`, `nft` and `multitoken`.
     */
    tokenTypes?: TokenTypeWithNative[];
}
export interface AddressBalanceFiltersTron {
    /**
     * Address to check.
     */
    address: string;
}
export interface AddressBalanceFiltersTezos extends Pagination {
    /**
     * Address to check.
     */
    address: string;
    /**
     * Optional filter for token types. If not specified, all token types are returned.
     * Allowed values are `fungible`, `nft` and `multitoken`.
     */
    tokenTypes?: TokenType[];
}
export interface TokenDetails {
    /**
     * Name of the token
     */
    name?: string;
    /**
     * Symbol of the token
     */
    symbol?: string;
    /**
     * Type of the token
     */
    tokenType: TokenType;
    /**
     * Decimals of the token. Available only for `fungible` tokens
     */
    decimals?: number;
    /**
     * Supply of the token.
     */
    supply?: string;
    /**
     * Total hard cap of the token, if present.
     */
    cap?: string;
}
export type QueryValue = string | number | boolean | string[] | number[] | boolean[];
export type QueryParams = Partial<Record<string, QueryValue>>;
export {};