rango-types/lib/api/basic/meta.d.ts

Rango Exchange Types

import { EVMChainInfo, CosmosChainInfo, SwapperMetaDto, SwapperMeta, SwapperMetaExtended, BlockchainMetaBase, EvmBlockchainMeta, CosmosBlockchainMeta, TransferBlockchainMeta, BlockchainMeta, MessagingProtocol, MessagingProtocolsResponse } from '../shared/index.js';
export { EVMChainInfo, CosmosChainInfo, SwapperMetaDto, SwapperMeta, SwapperMetaExtended, BlockchainMetaBase, EvmBlockchainMeta, CosmosBlockchainMeta, TransferBlockchainMeta, BlockchainMeta, MessagingProtocol, MessagingProtocolsResponse, };
/**
 * All metadata info for a token, unique by (blockchain, symbol, address) tuple
 *
 * @property {string} blockchain - The blockchain which this token belongs to
 * @property {string | null} chainId - The chainId which this token belongs to, e.g. 1 for ETH, 56 for BSC and ...
 * @property {string | null} address - Smart contract address of token, null for native tokens
 * @property {string} symbol - The token symbol, e.g: ADA
 * @property {string | null} name - The token name, e.g: Binance Pegged ETH
 * @property {number} decimals - Decimals of token in blockchain, example: 18
 * @property {string} image - Url of its image, example: https://api.rango.exchange/tokens/ETH/ETH.png
 * @property {string} blockchainImage - Url of the blockchain image
 * @property {number | null} usdPrice - The token unit price
 * @property {boolean} isPopular - If true, means that the token is popular
 * @property {string[]} supportedSwappers - Supported Swappers for this token
 */
export type Token = {
    blockchain: string;
    chainId: string | null;
    address: string | null;
    symbol: string;
    name: string | null;
    decimals: number;
    image: string;
    blockchainImage: string;
    usdPrice: number | null;
    isPopular: boolean;
    supportedSwappers: string[];
};
/**
 * Metadata info for all blockchains and tokens supported
 *
 * @property {BlockchainMeta[]} blockchains - List of all supported blockchains
 * @property {Token[]} tokens - List of all tokens
 * @property {SwapperMeta[]} swappers - List of all DEXes & Bridges
 *
 */
export type MetaResponse = {
    blockchains: BlockchainMeta[];
    tokens: Token[];
    swappers: SwapperMeta[];
};
/**
 * Custom token request
 *
 * @property {string} blockchain - The blockchain that token belong to
 * @property {string} address - The contract address for the desired token
 *
 */
export type CustomTokenRequest = {
    blockchain: string;
    address: string;
};
/**
 * The custom token response which includes:
 * Token details for user desired token that is not available on Rango official list.
 * Currently supports Solana and EVM based blockchains.
 *
 * @property {Token} token - The destination asset
 * @property {string | null} error - Error message
 * @property {number | null} errorCode - Error code
 * @property {number | null} traceId - Trace Id, for debug purpose
 */
export type CustomTokenResponse = {
    token: Token;
    error: string | null;
    errorCode: number | null;
    traceId: number | null;
};
//# sourceMappingURL=meta.d.ts.map