samo-bas-ran/lib/api/shared/meta.d.ts

Rango Exchange Types

import { Asset, SwapperType } from './common';
import { TransactionType } from './transactions';
export type MetaInfoType = 'CosmosMetaInfo' | 'EvmMetaInfo' | 'StarkNetMetaInfo' | 'TronMetaInfo';
/**
 * ChainInfoBase
 * Base type for all chains info type
 *
 * @property {MetaInfoType} infoType - Type of chain info
 *
 */
export type ChainInfoBase = {
    infoType: MetaInfoType;
};
/**
 * EVM Chain Info
 *
 * @property {MetaInfoType} infoType - equals to EvmMetaInfo for EvmChainInfo
 * @property {string} chainName - Chain name, e.g. Polygon Mainnet
 * @property {name: string, symbol: string, decimals: number} nativeCurrency
 * @property {string[]} rpcUrls - e.g. "https://polygon-rpc.com"
 * @property {string[]} blockExplorerUrls - e.g. "https://polygonscan.com"
 * @property {string} addressUrl - Explorer address base url for this blockchain,
 * e.g. "https://bscscan.com/address/{wallet}"
 * @property {string} transactionUrl - Explorer transaction base url for this blockchain,
 * e.g. "https://bscscan.com/tx/{txHash}"
 *
 */
export interface EVMChainInfo extends ChainInfoBase {
    infoType: 'EvmMetaInfo';
    chainName: string;
    nativeCurrency: {
        name: string;
        symbol: string;
        decimals: number;
    };
    rpcUrls: string[];
    blockExplorerUrls: string[];
    addressUrl: string;
    transactionUrl: string;
}
/**
 * StarkNet Chain Info
 *
 * @property {MetaInfoType} infoType - equals to StarkNetMetaInfo for StarkNetChainInfo
 * @property {string} chainName - Chain name
 * @property {name: string, symbol: string, decimals: number} nativeCurrency
 * @property {string[]} blockExplorerUrls
 * @property {string} addressUrl - Explorer address base url for this blockchain
 * @property {string} transactionUrl - Explorer transaction base url for this blockchain
 *
 */
export interface StarkNetChainInfo extends ChainInfoBase {
    infoType: 'StarkNetMetaInfo';
    chainName: string;
    nativeCurrency: {
        name: string;
        symbol: string;
        decimals: number;
    };
    blockExplorerUrls: string[];
    addressUrl: string;
    transactionUrl: string;
}
/**
 * Tron Chain Info
 *
 * @property {MetaInfoType} infoType - equals to TronMetaInfo  for TronChainInfo
 * @property {string} chainName - Chain name
 * @property {name: string, symbol: string, decimals: number} nativeCurrency
 * @property {string[]} blockExplorerUrls
 * @property {string} addressUrl - Explorer address base url for this blockchain
 * @property {string} transactionUrl - Explorer transaction base url for this blockchain
 *
 */
export interface TronChainInfo extends ChainInfoBase {
    infoType: 'TronMetaInfo';
    chainName: string;
    nativeCurrency: {
        name: string;
        symbol: string;
        decimals: number;
    };
    blockExplorerUrls: string[];
    addressUrl: string;
    transactionUrl: string;
}
/**
 * Cosmos Chain Info - Used for adding experimental chains to keplr if needed
 *
 * @see https://github.com/osmosis-labs/osmosis-frontend/blob/0b88e39740cb087be576f464bfcd6cc2971ed2fd/packages/web/config/chain-infos.ts
 *
 */
export interface CosmosChainInfo extends ChainInfoBase {
    infoType: 'CosmosMetaInfo';
    experimental: boolean;
    rpc: string;
    rest: string;
    cosmostationLcdUrl?: string | null;
    cosmostationApiUrl?: string | null;
    cosmostationDenomTracePath?: string | null;
    mintScanName?: string | null;
    chainName: string;
    stakeCurrency: {
        coinDenom: string;
        coinMinimalDenom: string;
        coinDecimals: number;
        coinGeckoId: string;
        coinImageUrl: string;
    };
    bip44: {
        coinType: number;
    };
    bech32Config: {
        bech32PrefixAccAddr: string;
        bech32PrefixAccPub: string;
        bech32PrefixValAddr: string;
        bech32PrefixValPub: string;
        bech32PrefixConsAddr: string;
        bech32PrefixConsPub: string;
    };
    currencies: {
        coinDenom: string;
        coinMinimalDenom: string;
        coinDecimals: number;
        coinGeckoId: string;
        coinImageUrl: string;
    }[];
    feeCurrencies: {
        coinDenom: string;
        coinMinimalDenom: string;
        coinDecimals: number;
        coinGeckoId: string;
        coinImageUrl: string;
    }[];
    features: string[];
    explorerUrlToTx: string;
    gasPriceStep?: {
        low: number;
        average: number;
        high: number;
    } | null;
}
/**
 * Metadata of Swapper
 *
 * @property {string} id - Unique identifier for the swapper
 * @property {string} title - Display name for the swapper
 * @property {string} logo - Icon logo for the swapper
 * @property {string} swapperGroup - Group name for swapper
 * @property {SwapperType[]} types - Type of the transaction supported by the swapper
 *
 */
export type SwapperMeta = {
    id: string;
    title: string;
    logo: string;
    swapperGroup: string;
    types: SwapperType[];
};
/**
 * Metadata of Swapper
 * @deprecated use SwapperMeta istead
 *
 */
export type SwapperMetaDto = SwapperMeta;
/**
 * Blockchain Meta Information
 *
 * @property {TransactionType} type - Type of the blockchain
 * @property {string} name - Unique name of blockchain, this field is used in all endpoints as the identifier
 * @property {number} defaultDecimals - The default decimals of blockchain, do not use it in computations, use Token.decimals instead
 * @property {Asset[]} feeAssets - List of assets that can be used as fee in this blockchain
 * @property {string[]} addressPatterns - List of all regex patterns for wallet addresses of this blockchain, can be
 * used for input validation, example: [ "^(0x)[0-9A-Fa-f]{40}$" ]
 * @property {string} logo - Logo of the blockchain
 * @property {string} displayName - Display name for the blockchain
 * @property {string} shortName - Short name for the blockchain
 * @property {string} color - Suggested color for the blockchain
 * @property {number} sort - Suggested sort for the blockchain
 * @property {boolean} enabled - Is blockchain enabled or not in Rango
 * @property {string | null} chainId - e.g. "0xa86a" for Avax, "osmosis-1" for Osmosis, etc.
 * @property {EVMChainInfo | CosmosChainInfo | null} info - Chain specific information
 *
 */
export type BlockchainMetaBase = {
    type: TransactionType;
    name: string;
    shortName: string;
    displayName: string;
    defaultDecimals: number;
    feeAssets: Asset[];
    addressPatterns: string[];
    logo: string;
    color: string;
    sort: number;
    enabled: boolean;
    chainId: string | null;
    info: EVMChainInfo | CosmosChainInfo | StarkNetChainInfo | TronChainInfo | null;
};
export interface EvmBlockchainMeta extends BlockchainMetaBase {
    type: TransactionType.EVM;
    chainId: string;
    info: EVMChainInfo;
}
export interface CosmosBlockchainMeta extends BlockchainMetaBase {
    type: TransactionType.COSMOS;
    chainId: string | null;
    info: CosmosChainInfo | null;
}
export interface TransferBlockchainMeta extends BlockchainMetaBase {
    type: TransactionType.TRANSFER;
    chainId: null;
    info: null;
}
export interface SolanaBlockchainMeta extends BlockchainMetaBase {
    type: TransactionType.SOLANA;
    chainId: string;
    info: null;
}
export interface StarkNetBlockchainMeta extends BlockchainMetaBase {
    type: TransactionType.STARKNET;
    chainId: string;
    info: StarkNetChainInfo;
}
export interface TronBlockchainMeta extends BlockchainMetaBase {
    type: TransactionType.TRON;
    chainId: string;
    info: TronChainInfo;
}
export interface TonBlockchainMeta extends BlockchainMetaBase {
    type: TransactionType.TON;
    chainId: string;
    info: null;
}
export type BlockchainMeta = EvmBlockchainMeta | CosmosBlockchainMeta | TransferBlockchainMeta | SolanaBlockchainMeta | StarkNetBlockchainMeta | TronBlockchainMeta | TonBlockchainMeta;
/**
 * MessagingProtocol
 *
 * @property {string} id - The unique identifier for the messaging protocol.
 *
 */
export type MessagingProtocol = {
    id: string;
};
/**
 * Metadata info for all supported messaging protcols
 *
 * @property {MessagingProtocol[]} protocols - List of all supported messaging protocols, e.g. AXELAR, ...
 *
 */
export type MessagingProtocolsResponse = {
    protocols: MessagingProtocol[];
};
//# sourceMappingURL=meta.d.ts.map