graz 0.0.43 → 0.0.44-alpha.2

package/dist/index.d.ts

@@ -1039,4 +1039,588 @@ declare const useGrazEvents: () => null;
  */
 declare const GrazEvents: FC;
 
-export { AccountData, ChainInfoWithPath, ConfigureGrazArgs, ConnectArgs, ConnectResult, Connector, CreateClientArgs, CreateQueryClient, CreateSigningClientArgs, Dictionary, ExecuteContractArgs, ExecuteContractMutationArgs, GetWalletConnectParams, GrazAdapter, GrazChain, GrazEvents, GrazProvider, GrazProviderProps, InstantiateContractArgs, InstantiateContractMutationArgs, Maybe, ReconnectArgs, SendIbcTokensArgs, SendTokensArgs, SuggestChainAndConnectArgs, UseAccountArgs, UseConnectChainArgs, UseExecuteContractArgs, UseInstantiateContractArgs, UseQueryClient, UseSuggestChainAndConnectArgs, UseSuggestChainArgs, WALLET_TYPES, Wallet, WalletType, checkWallet, clearRecentChain, configureGraz, connect, createClients, createQueryClient, createSigningClients, defineChain, defineChainInfo, defineChains, disconnect, executeContract, getActiveChainCurrency, getAvailableWallets, getBalanceStaked, getBalances, getCosmostation, getKeplr, getLeap, getQueryRaw, getQuerySmart, getRecentChain, getWCCosmostation, getWCKeplr, getWCLeap, getWallet, getWalletConnect, instantiateContract, mainnetChains, mainnetChainsArray, reconnect, sendIbcTokens, sendTokens, suggestChain, suggestChainAndConnect, testnetChains, testnetChainsArray, useAccount, useActiveChain, useActiveChainCurrency, useActiveChainValidators, useActiveWalletType, useBalance, useBalanceStaked, useBalances, useCheckWallet, useClients, useConnect, useDisconnect, useExecuteContract, useGrazEvents, useInstantiateContract, useOfflineSigners, useQueryClient, useQueryRaw, useQuerySmart, useRecentChain, useSendIbcTokens, useSendTokens, useSigners, useSigningClients, useSuggestChain, useSuggestChainAndConnect };
+/**
+ * Asset lists are a similar mechanism to allow frontends and other UIs to fetch metadata
+ * associated with Cosmos SDK denoms, especially for assets sent over IBC.
+ */
+interface AssetList {
+    $schema?: string;
+    assets: Asset[];
+    chain_name: string;
+}
+interface Asset {
+    /**
+     * [OPTIONAL] The address of the asset. Only required for type_asset : cw20, snip20
+     */
+    address?: string;
+    /**
+     * The base unit of the asset. Must be in denom_units.
+     */
+    base: string;
+    /**
+     * [OPTIONAL] The coingecko id to fetch asset data from coingecko v3 api. See
+     * https://api.coingecko.com/api/v3/coins/list
+     */
+    coingecko_id?: string;
+    denom_units: DenomUnit[];
+    /**
+     * [OPTIONAL] A short description of the asset
+     */
+    description?: string;
+    /**
+     * The human friendly unit of the asset. Must be in denom_units.
+     */
+    display: string;
+    /**
+     * [OPTIONAL] IBC Channel between src and dst between chain
+     */
+    ibc?: Ibc;
+    images?: AssetImage[];
+    keywords?: string[];
+    logo_URIs?: AssetLogoURIs;
+    /**
+     * The project name of the asset. For example Bitcoin.
+     */
+    name: string;
+    /**
+     * The symbol of an asset. For example BTC.
+     */
+    symbol: string;
+    /**
+     * The origin of the asset, starting with the index, and capturing all transitions in form
+     * and location.
+     */
+    traces?: Trace[];
+    /**
+     * [OPTIONAL] The potential options for type of asset. By default, assumes sdk.coin
+     */
+    type_asset?: TypeAsset;
+}
+interface DenomUnit {
+    aliases?: string[];
+    denom: string;
+    exponent: number;
+}
+/**
+ * [OPTIONAL] IBC Channel between src and dst between chain
+ */
+interface Ibc {
+    dst_channel: string;
+    source_channel: string;
+    source_denom: string;
+}
+interface AssetImage {
+    png?: string;
+    svg?: string;
+    theme?: Theme;
+}
+interface Theme {
+    primary_color_hex?: string;
+}
+interface AssetLogoURIs {
+    png?: string;
+    svg?: string;
+}
+interface Trace {
+    chain?: TraceChain;
+    counterparty: Counterparty;
+    /**
+     * The entity offering the service. E.g., 'Gravity Bridge' [Network] or 'Tether' [Company].
+     */
+    provider?: string;
+    type: TraceType;
+}
+interface TraceChain {
+    /**
+     * The chain's IBC transfer channel(, e.g., 'channel-1').
+     */
+    channel_id?: string;
+    /**
+     * The contract address where the transition takes place, where applicable. E.g., The
+     * Ethereum contract that locks up the asset while it's minted on another chain.
+     */
+    contract?: string;
+    /**
+     * The port/channel/denom input string that generates the 'ibc/...' denom.
+     */
+    path?: string;
+    /**
+     * The port used to transfer IBC assets; often 'transfer', but sometimes varies, e.g., for
+     * outgoing cw20 transfers.
+     */
+    port?: string;
+}
+interface Counterparty {
+    /**
+     * The base unit of the asset on its source platform. E.g., when describing ATOM from Cosmos
+     * Hub, specify 'uatom', NOT 'atom' nor 'ATOM'; base units are unique per platform.
+     */
+    base_denom: string;
+    /**
+     * The name of the counterparty chain. (must match exactly the chain name used in the Chain
+     * Registry)
+     *
+     * The chain or platform from which the asset originates. E.g., 'cosmoshub', 'ethereum',
+     * 'forex', or 'nasdaq'
+     */
+    chain_name: string;
+    /**
+     * The counterparty IBC transfer channel(, e.g., 'channel-1').
+     */
+    channel_id?: string;
+    /**
+     * The contract address where the transition takes place, where applicable. E.g., The
+     * Ethereum contract that locks up the asset while it's minted on another chain.
+     */
+    contract?: string;
+    /**
+     * The port used to transfer IBC assets; often 'transfer', but sometimes varies, e.g., for
+     * outgoing cw20 transfers.
+     */
+    port?: string;
+}
+declare enum TraceType {
+    Bridge = "bridge",
+    Ibc = "ibc",
+    IbcCw20 = "ibc-cw20",
+    LiquidStake = "liquid-stake",
+    Synthetic = "synthetic",
+    Wrapped = "wrapped"
+}
+/**
+ * [OPTIONAL] The potential options for type of asset. By default, assumes sdk.coin
+ */
+declare enum TypeAsset {
+    Cw20 = "cw20",
+    Erc20 = "erc20",
+    Ics20 = "ics20",
+    SDKCoin = "sdk.coin",
+    Snip20 = "snip20",
+    Snip25 = "snip25"
+}
+/**
+ * Cosmos Chain.json is a metadata file that contains information about a cosmos sdk based
+ * chain.
+ */
+interface Chain {
+    $schema?: string;
+    alternative_slip44s?: number[];
+    apis?: Apis;
+    /**
+     * Used to override the bech32_prefix for specific uses.
+     */
+    bech32_config?: Bech32Config;
+    /**
+     * The default prefix for the human-readable part of addresses that identifies the coin
+     * type. Must be registered with SLIP-0173. E.g., 'cosmos'
+     */
+    bech32_prefix: string;
+    chain_id: string;
+    chain_name: string;
+    codebase?: Codebase;
+    daemon_name?: string;
+    explorers?: Explorer[];
+    extra_codecs?: ExtraCodec[];
+    fees?: Fees;
+    images?: ChainImage[];
+    key_algos?: KeyAlgo[];
+    keywords?: string[];
+    logo_URIs?: ChainLogoURIs;
+    network_type?: NetworkType;
+    node_home?: string;
+    peers?: Peers;
+    pretty_name?: string;
+    slip44?: number;
+    staking?: Staking;
+    status?: Status;
+    update_link?: string;
+    website?: string;
+}
+interface Apis {
+    "evm-http-jsonrpc"?: Api[];
+    grpc?: Api[];
+    "grpc-web"?: Api[];
+    rest?: Api[];
+    rpc?: Api[];
+    wss?: Api[];
+}
+interface Api {
+    address: string;
+    archive?: boolean;
+    provider?: string;
+}
+/**
+ * Used to override the bech32_prefix for specific uses.
+ */
+interface Bech32Config {
+    /**
+     * e.g., 'cosmos'
+     */
+    bech32PrefixAccAddr?: string;
+    /**
+     * e.g., 'cosmospub'
+     */
+    bech32PrefixAccPub?: string;
+    /**
+     * e.g., 'cosmosvalcons'
+     */
+    bech32PrefixConsAddr?: string;
+    /**
+     * e.g., 'cosmosvalconspub'
+     */
+    bech32PrefixConsPub?: string;
+    /**
+     * e.g., 'cosmosvaloper'
+     */
+    bech32PrefixValAddr?: string;
+    /**
+     * e.g., 'cosmosvaloperpub'
+     */
+    bech32PrefixValPub?: string;
+}
+interface Codebase {
+    binaries?: CodebaseBinaries;
+    compatible_versions?: string[];
+    consensus?: CodebaseConsensus;
+    cosmos_sdk_version?: string;
+    cosmwasm_enabled?: boolean;
+    /**
+     * Relative path to the cosmwasm directory. ex. $HOME/.juno/data/wasm
+     */
+    cosmwasm_path?: string;
+    cosmwasm_version?: string;
+    genesis?: Genesis;
+    git_repo?: string;
+    ibc_go_version?: string;
+    /**
+     * List of IBC apps (usually corresponding to a ICS standard) which have been enabled on the
+     * network.
+     */
+    ics_enabled?: ICSEnabled[];
+    recommended_version?: string;
+    versions?: Version[];
+}
+interface CodebaseBinaries {
+    "darwin/amd64"?: string;
+    "darwin/arm64"?: string;
+    "linux/amd64"?: string;
+    "linux/arm64"?: string;
+    "windows/amd64"?: string;
+}
+interface CodebaseConsensus {
+    type: ConsensusType;
+    version?: string;
+}
+declare enum ConsensusType {
+    Cometbft = "cometbft",
+    Tendermint = "tendermint"
+}
+interface Genesis {
+    genesis_url: string;
+    name?: string;
+}
+/**
+ * IBC app or ICS standard.
+ */
+declare enum ICSEnabled {
+    Ics201 = "ics20-1",
+    Ics271 = "ics27-1",
+    Mauth = "mauth"
+}
+interface Version {
+    binaries?: VersionBinaries;
+    compatible_versions?: string[];
+    consensus?: VersionConsensus;
+    cosmos_sdk_version?: string;
+    cosmwasm_enabled?: boolean;
+    /**
+     * Relative path to the cosmwasm directory. ex. $HOME/.juno/data/wasm
+     */
+    cosmwasm_path?: string;
+    cosmwasm_version?: string;
+    /**
+     * Block Height
+     */
+    height?: number;
+    ibc_go_version?: string;
+    /**
+     * List of IBC apps (usually corresponding to a ICS standard) which have been enabled on the
+     * network.
+     */
+    ics_enabled?: ICSEnabled[];
+    /**
+     * Official Upgrade Name
+     */
+    name: string;
+    /**
+     * [Optional] Name of the following version
+     */
+    next_version_name?: string;
+    /**
+     * Proposal that will officially signal community acceptance of the upgrade.
+     */
+    proposal?: number;
+    recommended_version?: string;
+    /**
+     * Git Upgrade Tag
+     */
+    tag?: string;
+}
+interface VersionBinaries {
+    "darwin/amd64"?: string;
+    "darwin/arm64"?: string;
+    "linux/amd64"?: string;
+    "linux/arm64"?: string;
+    "windows/amd64"?: string;
+}
+interface VersionConsensus {
+    type: ConsensusType;
+    version?: string;
+}
+interface Explorer {
+    account_page?: string;
+    kind?: string;
+    tx_page?: string;
+    url?: string;
+}
+declare enum ExtraCodec {
+    Ethermint = "ethermint",
+    Injective = "injective"
+}
+interface Fees {
+    fee_tokens: FeeToken[];
+}
+interface FeeToken {
+    average_gas_price?: number;
+    denom: string;
+    fixed_min_gas_price?: number;
+    gas_costs?: GasCosts;
+    high_gas_price?: number;
+    low_gas_price?: number;
+}
+interface GasCosts {
+    cosmos_send?: number;
+    ibc_transfer?: number;
+}
+interface ChainImage {
+    png?: string;
+    svg?: string;
+    theme?: Theme;
+}
+declare enum KeyAlgo {
+    Ed25519 = "ed25519",
+    Ethsecp256K1 = "ethsecp256k1",
+    Secp256K1 = "secp256k1",
+    Sr25519 = "sr25519"
+}
+interface ChainLogoURIs {
+    png?: string;
+    svg?: string;
+}
+declare enum NetworkType {
+    Devnet = "devnet",
+    Mainnet = "mainnet",
+    Testnet = "testnet"
+}
+interface Peers {
+    persistent_peers?: PersistentPeer[];
+    seeds?: PersistentPeer[];
+}
+interface PersistentPeer {
+    address: string;
+    id: string;
+    provider?: string;
+}
+interface Staking {
+    lock_duration?: LockDuration;
+    staking_tokens: StakingToken[];
+}
+interface LockDuration {
+    /**
+     * The number of blocks for which the staked tokens are locked.
+     */
+    blocks?: number;
+    /**
+     * The approximate time for which the staked tokens are locked.
+     */
+    time?: string;
+}
+interface StakingToken {
+    denom: string;
+}
+declare enum Status {
+    Killed = "killed",
+    Live = "live",
+    Upcoming = "upcoming"
+}
+interface IbcDataSchema {
+    $schema?: string;
+    chain_1: IbcDataSchemaChain;
+    chain_2: IbcDataSchemaChain;
+    channels: Channel[];
+}
+/**
+ * Top level IBC data pertaining to the chain. `chain_1` and `chain_2` should be in
+ * alphabetical order.
+ */
+interface IbcDataSchemaChain {
+    chain_name: string;
+    /**
+     * The client ID on the corresponding chain representing the other chain's light client.
+     */
+    client_id: string;
+    /**
+     * The connection ID on the corresponding chain representing a connection to the other chain.
+     */
+    connection_id: string;
+}
+interface Channel {
+    chain_1: ChannelChain;
+    chain_2: ChannelChain;
+    /**
+     * Human readable description of the channel.
+     */
+    description?: string;
+    /**
+     * Determines if packets from a sending module must be 'ordered' or 'unordered'.
+     */
+    ordering: Ordering;
+    /**
+     * Human readable key:value pairs that help describe and distinguish channels.
+     */
+    tags?: Tags;
+    /**
+     * IBC Version
+     */
+    version: string;
+}
+interface ChannelChain {
+    /**
+     * The channel ID on the corresponding chain's connection representing a channel on the
+     * other chain.
+     */
+    channel_id: string;
+    /**
+     * The IBC port ID which a relevant module binds to on the corresponding chain.
+     */
+    port_id: string;
+}
+/**
+ * Determines if packets from a sending module must be 'ordered' or 'unordered'.
+ */
+declare enum Ordering {
+    Ordered = "ordered",
+    Unordered = "unordered"
+}
+/**
+ * Human readable key:value pairs that help describe and distinguish channels.
+ */
+interface Tags {
+    dex?: string;
+    preferred?: boolean;
+    /**
+     * String that helps describe non-dex use cases ex: interchain accounts(ICA).
+     */
+    properties?: string;
+    status?: Status;
+    [property: string]: any;
+}
+interface MemoKeysSchema {
+    $schema?: string;
+    memo_keys: MemoKey[];
+}
+interface MemoKey {
+    description: string;
+    git_repo: string;
+    key: string;
+    memo: Record<string, any>;
+    [property: string]: any;
+}
+
+/**
+ * Helper function to define chain.
+ *
+ * This function does not do anything special else than providing type safety
+ * when defining chain information.
+ *
+ * @example
+ * ```ts
+ * import { defineAsset } from "graz";
+ *
+ * const atom = defineAsset({
+ *   base: "uatom",
+ *   display: "atom",
+ *   symbol: "ATOM",
+ *   ...
+ * });
+ * ```
+ */
+declare const defineAsset: <T extends Asset>(asset: T) => T;
+/**
+ * Helper function to define chains asset list.
+ *
+ * This function does not do anything special else than providing type safety
+ * when defining chain information.
+ *
+ * @example
+ * ```ts
+ * import { defineAssetList } from "graz";
+ *
+ * const assetlist = defineAssetList({
+ *   chain_name: "cosmoshub",
+ *   assets: [...]
+ * });
+ * ```
+ */
+declare const defineAssetList: <T extends AssetList>(assetlist: T) => T;
+/**
+ * Helper function to define chain with registry compliant type.
+ *
+ * This function does not do anything special else than providing type safety
+ * when defining chain information.
+ *
+ * @example
+ * ```ts
+ * import { defineRegistryChain } from "graz";
+ *
+ * const cosmoshub = defineRegistryChain({
+ *   chain_name: "cosmoshub",
+ *   chain_id: "cosmoshub-4",
+ *   ...
+ * });
+ * ```
+ */
+declare const defineRegistryChain: <T extends Chain>(chain: T) => T;
+
+/**
+ * Function to convert chain object from registry to Keplr's {@link ChainInfo} object.
+ *
+ * Note that every chain generated in `graz/chains` already has {@link ChainInfo}.
+ * (e.g. `import chainInfo from "graz/chains/cosmoshub"`).
+ *
+ * @example
+ * ```ts
+ * import { registryToChainInfo } from "graz";
+ *
+ * import chain from "graz/chains/cosmoshub/chain";
+ * import assetlist from "graz/chains/cosmoshub/assetlist";
+ *
+ * const chainInfo = registryToChainInfo({ chain, assetlist });
+ * const chainInfoFromAsset = registryToChainInfo({ chain, assets: assetlist.assets });
+ * ```
+ *
+ */
+declare const registryToChainInfo: (args: RegistryToChainInfoArgs) => ChainInfo;
+type MapEndpointGetters<T extends string> = Record<`get${Capitalize<T>}Endpoint`, (chain: Chain) => string>;
+type RegistryToChainInfoArgs = Partial<MapEndpointGetters<"rpc" | "rest">> & ({
+    chain: Chain;
+    assetlists: AssetList[];
+} | {
+    chain: Chain;
+    assetlist: AssetList;
+} | {
+    chain: Chain;
+    assets: Asset[];
+});
+
+export { AccountData, Api, Apis, Asset, AssetImage, AssetList, AssetLogoURIs, Bech32Config, Chain, ChainImage, ChainInfoWithPath, ChainLogoURIs, Channel, ChannelChain, Codebase, CodebaseBinaries, CodebaseConsensus, ConfigureGrazArgs, ConnectArgs, ConnectResult, Connector, ConsensusType, Counterparty, CreateClientArgs, CreateQueryClient, CreateSigningClientArgs, DenomUnit, Dictionary, ExecuteContractArgs, ExecuteContractMutationArgs, Explorer, ExtraCodec, FeeToken, Fees, GasCosts, Genesis, GetWalletConnectParams, GrazAdapter, GrazChain, GrazEvents, GrazProvider, GrazProviderProps, ICSEnabled, Ibc, IbcDataSchema, IbcDataSchemaChain, InstantiateContractArgs, InstantiateContractMutationArgs, KeyAlgo, LockDuration, Maybe, MemoKey, MemoKeysSchema, NetworkType, Ordering, Peers, PersistentPeer, ReconnectArgs, SendIbcTokensArgs, SendTokensArgs, Staking, StakingToken, Status, SuggestChainAndConnectArgs, Tags, Theme, Trace, TraceChain, TraceType, TypeAsset, UseAccountArgs, UseConnectChainArgs, UseExecuteContractArgs, UseInstantiateContractArgs, UseQueryClient, UseSuggestChainAndConnectArgs, UseSuggestChainArgs, Version, VersionBinaries, VersionConsensus, WALLET_TYPES, Wallet, WalletType, checkWallet, clearRecentChain, configureGraz, connect, createClients, createQueryClient, createSigningClients, defineAsset, defineAssetList, defineChain, defineChainInfo, defineChains, defineRegistryChain, disconnect, executeContract, getActiveChainCurrency, getAvailableWallets, getBalanceStaked, getBalances, getCosmostation, getKeplr, getLeap, getQueryRaw, getQuerySmart, getRecentChain, getWCCosmostation, getWCKeplr, getWCLeap, getWallet, getWalletConnect, instantiateContract, mainnetChains, mainnetChainsArray, reconnect, registryToChainInfo, sendIbcTokens, sendTokens, suggestChain, suggestChainAndConnect, testnetChains, testnetChainsArray, useAccount, useActiveChain, useActiveChainCurrency, useActiveChainValidators, useActiveWalletType, useBalance, useBalanceStaked, useBalances, useCheckWallet, useClients, useConnect, useDisconnect, useExecuteContract, useGrazEvents, useInstantiateContract, useOfflineSigners, useQueryClient, useQueryRaw, useQuerySmart, useRecentChain, useSendIbcTokens, useSendTokens, useSigners, useSigningClients, useSuggestChain, useSuggestChainAndConnect };