chains: Core types

import { requireChain, getChain } from "@eco-incorp/sauce/chains";

export interface NativeErc20 {
    address: `0x${string}`;
    decimals: number;
}

export interface ChainDeployment {
    chainId: number;
    chainName: string;
    addresses: Record<string, Address>;
}

export interface ProtocolInfo {
    name: string;
    slug: string;
    description: string;
    website: string;
    github?: string;
    npm?: string;
    category: ProtocolCategory;
    chains: ChainDeployment[];
    audited: boolean;
    tvl?: string;
    deprecated?: boolean;
}

export type ProtocolCategory = "dex" | "lending" | "bridge" | "yield" | "derivatives" | "staking" | "oracle" | "cdp" | "insurance" | "launchpad" | "nft-marketplace" | "liquid-staking" | "restaking" | "rwa" | "payments" | "privacy" | "governance" | "options" | "perpetuals" | "synthetics" | "aggregator" | "cross-chain" | "infrastructure";

export interface ContractABI {
    contractName: string;
    abi: readonly object[];
    address?: Address;
}

export interface SauceFunction {
    name: string;
    description: string;
    params: SauceParam[];
    returns?: string;
    sauceScript: string;
}

export interface SauceParam {
    name: string;
    type: "Address" | "Uint256" | "Bytes" | "Bytes32" | "Bool";
    description: string;
}

export interface Chain {
    id: number;
    name: string;
    nativeCurrency: {
        name: string;
        symbol: string;
        decimals: number;
        erc20?: NativeErc20;
    };
    blockExplorerUrls: string[];
    testnet: boolean;
    minBaseFeePerGas?: bigint;
}