@talismn/chaindata-provider 0.11.0 → 1.0.0

package/dist/declarations/src/chaindata/utils.d.ts

@@ -0,0 +1,362 @@
+import { DotNetwork, Network, NetworkPlatform } from "./networks";
+import { Token, TokenId, TokenIdSpecs, TokenType } from "./tokens";
+export type NetworkOfPlatform<P extends NetworkPlatform> = Extract<Network, {
+    platform: P;
+}>;
+export declare const isNetworkOfPlatform: <P extends NetworkPlatform>(network: Network | null | undefined, platform: P) => network is Extract<Network, {
+    platform: P;
+}>;
+export declare const isNetworkInPlatforms: <P extends NetworkPlatform[]>(network: Network | null | undefined, platforms: P) => network is NetworkOfPlatform<P[number]>;
+export declare const isNetworkDot: (network: Network | null | undefined) => network is {
+    id: string;
+    name: string;
+    nativeTokenId: string;
+    nativeCurrency: {
+        decimals: number;
+        symbol: string;
+        name: string;
+        coingeckoId?: string | undefined;
+        mirrorOf?: string | undefined;
+        logo?: string | undefined;
+    };
+    blockExplorerUrls: string[];
+    genesisHash: `0x${string}`;
+    platform: "polkadot";
+    chainName: string;
+    specName: string;
+    specVersion: number;
+    account: "secp256k1" | "*25519";
+    prefix: number;
+    rpcs: string[];
+    topology: {
+        type: "standalone";
+    } | {
+        type: "relay";
+    } | {
+        type: "parachain";
+        relayId: string;
+        paraId: number;
+    };
+    isTestnet?: boolean | undefined;
+    isDefault?: boolean | undefined;
+    forceScan?: boolean | undefined;
+    logo?: string | undefined;
+    themeColor?: string | undefined;
+    chainspecQrUrl?: string | undefined;
+    latestMetadataQrUrl?: string | undefined;
+    oldPrefix?: number | undefined;
+    registryTypes?: any;
+    signedExtensions?: any;
+    hasCheckMetadataHash?: boolean | undefined;
+    hasExtrinsicSignatureTypePrefix?: boolean | undefined;
+    isUnknownFeeToken?: boolean | undefined;
+    balancesConfig?: {
+        "substrate-native"?: {
+            disable?: boolean | undefined;
+        } | undefined;
+        "substrate-assets"?: undefined;
+        "substrate-psp22"?: undefined;
+        "substrate-tokens"?: {
+            palletId?: string | undefined;
+        } | undefined;
+        "substrate-foreignassets"?: undefined;
+        "substrate-hydration"?: undefined;
+    } | undefined;
+};
+export declare const isNetworkEth: (network: Network | null | undefined) => network is {
+    id: string;
+    name: string;
+    nativeTokenId: string;
+    nativeCurrency: {
+        decimals: number;
+        symbol: string;
+        name: string;
+        coingeckoId?: string | undefined;
+        mirrorOf?: string | undefined;
+        logo?: string | undefined;
+    };
+    blockExplorerUrls: string[];
+    platform: "ethereum";
+    rpcs: string[];
+    isTestnet?: boolean | undefined;
+    isDefault?: boolean | undefined;
+    forceScan?: boolean | undefined;
+    logo?: string | undefined;
+    themeColor?: string | undefined;
+    substrateChainId?: string | undefined;
+    preserveGasEstimate?: boolean | undefined;
+    feeType?: "legacy" | "eip-1559" | undefined;
+    l2FeeType?: {
+        type: "op-stack";
+    } | {
+        type: "scroll";
+        l1GasPriceOracle: `0x${string}`;
+    } | undefined;
+    contracts?: Partial<Record<"Erc20Aggregator" | "Multicall3", `0x${string}`>> | undefined;
+    balancesConfig?: {
+        "evm-native"?: undefined;
+        "evm-erc20"?: undefined;
+        "evm-uniswapv2"?: undefined;
+    } | undefined;
+};
+export declare const getNetworkGenesisHash: <Net extends Network, Res = Net extends DotNetwork ? DotNetwork["genesisHash"] : undefined>(network: Net | null | undefined) => Res;
+export type TokenOfType<T extends TokenType> = Extract<Token, {
+    type: T;
+}>;
+export type TokenOfPlatform<P extends NetworkPlatform> = Extract<Token, {
+    platform: P;
+}>;
+export type DotToken = TokenOfPlatform<"polkadot">;
+export type EthToken = TokenOfPlatform<"ethereum">;
+export declare const isTokenOfPlatform: <P extends NetworkPlatform>(token: Token | null | undefined, platform: P) => token is TokenOfPlatform<P>;
+export declare const isTokenEth: (token: Token | null | undefined) => token is TokenOfPlatform<"ethereum">;
+export declare const isTokenDot: (token: Token | null | undefined) => token is TokenOfPlatform<"polkadot">;
+export declare const isTokenNeedExistentialDeposit: (token: Token) => token is {
+    id: string;
+    networkId: string;
+    decimals: number;
+    symbol: string;
+    type: "substrate-assets";
+    platform: "polkadot";
+    assetId: string;
+    isSufficient: boolean;
+    existentialDeposit: string;
+    isDefault?: boolean | undefined;
+    name?: string | undefined;
+    logo?: string | undefined;
+    coingeckoId?: string | undefined;
+    noDiscovery?: boolean | undefined;
+    mirrorOf?: string | undefined;
+    isFrozen?: boolean | undefined;
+} | {
+    id: string;
+    networkId: string;
+    decimals: number;
+    symbol: string;
+    type: "substrate-foreignassets";
+    platform: "polkadot";
+    onChainId: string;
+    isSufficient: boolean;
+    existentialDeposit: string;
+    isDefault?: boolean | undefined;
+    name?: string | undefined;
+    logo?: string | undefined;
+    coingeckoId?: string | undefined;
+    noDiscovery?: boolean | undefined;
+    mirrorOf?: string | undefined;
+    isFrozen?: boolean | undefined;
+} | {
+    id: string;
+    networkId: string;
+    decimals: number;
+    symbol: string;
+    type: "substrate-native";
+    platform: "polkadot";
+    existentialDeposit: string;
+    isDefault?: boolean | undefined;
+    name?: string | undefined;
+    logo?: string | undefined;
+    coingeckoId?: string | undefined;
+    noDiscovery?: boolean | undefined;
+    mirrorOf?: string | undefined;
+} | {
+    id: string;
+    networkId: string;
+    decimals: number;
+    symbol: string;
+    type: "substrate-tokens";
+    platform: "polkadot";
+    onChainId: string | number;
+    existentialDeposit: string;
+    isDefault?: boolean | undefined;
+    name?: string | undefined;
+    logo?: string | undefined;
+    coingeckoId?: string | undefined;
+    noDiscovery?: boolean | undefined;
+    mirrorOf?: string | undefined;
+} | {
+    id: string;
+    networkId: string;
+    decimals: number;
+    symbol: string;
+    type: "substrate-hydration";
+    platform: "polkadot";
+    onChainId: number;
+    assetType: "Token" | "Erc20" | "External";
+    isSufficient: boolean;
+    existentialDeposit: string;
+    isDefault?: boolean | undefined;
+    name?: string | undefined;
+    logo?: string | undefined;
+    coingeckoId?: string | undefined;
+    noDiscovery?: boolean | undefined;
+    mirrorOf?: string | undefined;
+};
+export declare const isTokenOfType: <T extends TokenType>(token: Token | null | undefined, type: T) => token is TokenOfType<T>;
+export declare const isTokenInTypes: <T extends TokenType[]>(token: Token | null | undefined, types: T) => token is TokenOfType<T[number]>;
+export declare const isTokenSubNative: (token: Token | null | undefined) => token is {
+    id: string;
+    networkId: string;
+    decimals: number;
+    symbol: string;
+    type: "substrate-native";
+    platform: "polkadot";
+    existentialDeposit: string;
+    isDefault?: boolean | undefined;
+    name?: string | undefined;
+    logo?: string | undefined;
+    coingeckoId?: string | undefined;
+    noDiscovery?: boolean | undefined;
+    mirrorOf?: string | undefined;
+};
+export declare const isTokenSubAssets: (token: Token | null | undefined) => token is {
+    id: string;
+    networkId: string;
+    decimals: number;
+    symbol: string;
+    type: "substrate-assets";
+    platform: "polkadot";
+    assetId: string;
+    isSufficient: boolean;
+    existentialDeposit: string;
+    isDefault?: boolean | undefined;
+    name?: string | undefined;
+    logo?: string | undefined;
+    coingeckoId?: string | undefined;
+    noDiscovery?: boolean | undefined;
+    mirrorOf?: string | undefined;
+    isFrozen?: boolean | undefined;
+};
+export declare const isTokenSubForeignAssets: (token: Token | null | undefined) => token is {
+    id: string;
+    networkId: string;
+    decimals: number;
+    symbol: string;
+    type: "substrate-foreignassets";
+    platform: "polkadot";
+    onChainId: string;
+    isSufficient: boolean;
+    existentialDeposit: string;
+    isDefault?: boolean | undefined;
+    name?: string | undefined;
+    logo?: string | undefined;
+    coingeckoId?: string | undefined;
+    noDiscovery?: boolean | undefined;
+    mirrorOf?: string | undefined;
+    isFrozen?: boolean | undefined;
+};
+export declare const isTokenSubPsp22: (token: Token | null | undefined) => token is {
+    id: string;
+    networkId: string;
+    decimals: number;
+    symbol: string;
+    type: "substrate-psp22";
+    platform: "polkadot";
+    contractAddress: string;
+    isDefault?: boolean | undefined;
+    name?: string | undefined;
+    logo?: string | undefined;
+    coingeckoId?: string | undefined;
+    noDiscovery?: boolean | undefined;
+    mirrorOf?: string | undefined;
+};
+export declare const isTokenSubTokens: (token: Token | null | undefined) => token is {
+    id: string;
+    networkId: string;
+    decimals: number;
+    symbol: string;
+    type: "substrate-tokens";
+    platform: "polkadot";
+    onChainId: string | number;
+    existentialDeposit: string;
+    isDefault?: boolean | undefined;
+    name?: string | undefined;
+    logo?: string | undefined;
+    coingeckoId?: string | undefined;
+    noDiscovery?: boolean | undefined;
+    mirrorOf?: string | undefined;
+};
+export declare const isTokenSubHydration: (token: Token | null | undefined) => token is {
+    id: string;
+    networkId: string;
+    decimals: number;
+    symbol: string;
+    type: "substrate-hydration";
+    platform: "polkadot";
+    onChainId: number;
+    assetType: "Token" | "Erc20" | "External";
+    isSufficient: boolean;
+    existentialDeposit: string;
+    isDefault?: boolean | undefined;
+    name?: string | undefined;
+    logo?: string | undefined;
+    coingeckoId?: string | undefined;
+    noDiscovery?: boolean | undefined;
+    mirrorOf?: string | undefined;
+};
+export declare const isTokenEvmNative: (token: Token | null | undefined) => token is {
+    id: string;
+    networkId: string;
+    decimals: number;
+    symbol: string;
+    type: "evm-native";
+    platform: "ethereum";
+    isDefault?: boolean | undefined;
+    name?: string | undefined;
+    logo?: string | undefined;
+    coingeckoId?: string | undefined;
+    noDiscovery?: boolean | undefined;
+    mirrorOf?: string | undefined;
+};
+export declare const isTokenEvmErc20: (token: Token | null | undefined) => token is {
+    id: string;
+    networkId: string;
+    decimals: number;
+    symbol: string;
+    type: "evm-erc20";
+    platform: "ethereum";
+    contractAddress: `0x${string}`;
+    isDefault?: boolean | undefined;
+    name?: string | undefined;
+    logo?: string | undefined;
+    coingeckoId?: string | undefined;
+    noDiscovery?: boolean | undefined;
+    mirrorOf?: string | undefined;
+};
+export declare const isTokenEvmUniswapV2: (token: Token | null | undefined) => token is {
+    id: string;
+    networkId: string;
+    decimals: number;
+    symbol: string;
+    type: "evm-uniswapv2";
+    platform: "ethereum";
+    contractAddress: `0x${string}`;
+    symbol0: string;
+    symbol1: string;
+    decimals0: number;
+    decimals1: number;
+    tokenAddress0: `0x${string}`;
+    tokenAddress1: `0x${string}`;
+    isDefault?: boolean | undefined;
+    name?: string | undefined;
+    logo?: string | undefined;
+    coingeckoId?: string | undefined;
+    noDiscovery?: boolean | undefined;
+    mirrorOf?: string | undefined;
+    isCustom?: boolean | undefined;
+    coingeckoId0?: string | undefined;
+    coingeckoId1?: string | undefined;
+};
+export declare const parseTokenId: <T extends TokenType>(tokenId: TokenId) => TokenIdSpecs<T>;
+export declare const networkIdFromTokenId: (tokenId: TokenId) => Network["id"];
+declare const PLATFORM_NATIVE_TOKENS: {
+    polkadot: "substrate-native";
+    ethereum: "evm-native";
+};
+export type NativeTokenType<P extends NetworkPlatform = NetworkPlatform> = (typeof PLATFORM_NATIVE_TOKENS)[P];
+export type NativeToken<P extends NetworkPlatform = NetworkPlatform> = Extract<Token, {
+    type: NativeTokenType<P>;
+}>;
+export declare const isNativeTokenType: <P extends NetworkPlatform = NetworkPlatform>(type: TokenType, platform?: P) => type is NativeTokenType<P>;
+export declare const isNativeToken: <P extends NetworkPlatform = NetworkPlatform>(token: Token, platform?: P) => token is NativeToken<P>;
+export {};

package/dist/declarations/src/constants.d.ts

@@ -1,26 +1,10 @@
-import { ChainId, EvmNetworkId, TokenId } from "./types";
-export declare const githubApi = "https://api.github.com";
+export declare const MINIMETADATA_VERSION: string;
 export declare const githubCdn = "https://raw.githubusercontent.com";
 export declare const githubChaindataOrg = "TalismanSociety";
 export declare const githubChaindataRepo = "chaindata";
 export declare const githubChaindataBranch = "main";
-export declare const githubChaindataDistDir = "pub/v3";
+export declare const githubChaindataDistDir = "pub/v4";
 export declare const githubChaindataBaseUrl = "https://raw.githubusercontent.com/TalismanSociety/chaindata/main";
-export declare const githubChaindataDistUrl = "https://raw.githubusercontent.com/TalismanSociety/chaindata/main/pub/v3";
+export declare const githubChaindataDistUrl = "https://raw.githubusercontent.com/TalismanSociety/chaindata/main/pub/v4";
 export declare const githubChaindataChainsAssetsDir = "assets/chains";
 export declare const githubChaindataTokensAssetsDir = "assets/tokens";
-export declare const githubChainLogoUrl: (chainId: ChainId) => string;
-export declare const githubEvmNetworkLogoUrl: (networkId: EvmNetworkId) => string;
-export declare const githubTokenLogoUrl: (tokenId: TokenId) => string;
-export declare const githubUnknownChainLogoUrl: string;
-export declare const githubUnknownTokenLogoUrl: string;
-export declare const chaindataChainsAllUrl = "https://raw.githubusercontent.com/TalismanSociety/chaindata/main/pub/v3/chains/all.json";
-export declare const chaindataChainsSummaryUrl = "https://raw.githubusercontent.com/TalismanSociety/chaindata/main/pub/v3/chains/summary.json";
-export declare const chaindataChainByIdUrl: (chainId: string) => string;
-export declare const chaindataChainByGenesisHashUrl: (genesisHash: string) => string;
-export declare const chaindataEvmNetworksAllUrl = "https://raw.githubusercontent.com/TalismanSociety/chaindata/main/pub/v3/evmNetworks/all.json";
-export declare const chaindataEvmNetworksSummaryUrl = "https://raw.githubusercontent.com/TalismanSociety/chaindata/main/pub/v3/evmNetworks/summary.json";
-export declare const chaindataEvmNetworkByIdUrl: (evmNetworkId: string) => string;
-export declare const chaindataTokensAllUrl = "https://raw.githubusercontent.com/TalismanSociety/chaindata/main/pub/v3/tokens/all.json";
-export declare const chaindataTokenByIdUrl: (tokenId: string) => string;
-export declare const chaindataMiniMetadatasAllUrl = "https://raw.githubusercontent.com/TalismanSociety/chaindata/main/pub/v3/miniMetadatas/all.json";

package/dist/declarations/src/index.d.ts

@@ -1,6 +1,6 @@
-export * from "./constants";
-export * from "./init";
-export * from "./net";
-export * from "./types";
+export * from "./chaindata";
+export * from "./provider";
 export * from "./util";
-export * from "./ChaindataProvider";
+export * from "./legacy";
+export { MINIMETADATA_VERSION } from "./constants";
+export { ChaindataFileSchema, CustomChaindataSchema, type Chaindata, type CustomChaindata, } from "./state";

package/dist/declarations/src/{types → legacy}/Chain.d.ts

@@ -1,9 +1,10 @@
-import { EvmNetworkId } from "./EvmNetwork";
-import { TokenId } from "./Token";
-export type ChainList = Record<ChainId, Chain>;
-export type ChainId = string;
-export type Chain = {
-    id: ChainId;
+import { TokenId } from "../chaindata";
+import { LegacyEvmNetworkId } from "./EvmNetwork";
+/** @deprecated use NetworkId */
+export type LegacyChainId = string;
+/** @deprecated use DotNetwork */
+export type LegacyChain = {
+    id: LegacyChainId;
     isTestnet: boolean;
     isDefault: boolean;
     /** @deprecated */
@@ -29,20 +30,21 @@ export type Chain = {
     }> | null;
     account: string | null;
     subscanUrl: string | null;
+    blockExplorerUrls: string[] | null;
     chainspecQrUrl: string | null;
     latestMetadataQrUrl: string | null;
     isUnknownFeeToken: boolean;
     feeToken: string | null;
     rpcs: Array<SubstrateRpc> | null;
     evmNetworks: Array<{
-        id: EvmNetworkId;
+        id: LegacyEvmNetworkId;
     }>;
-    parathreads: Array<Pick<Chain, "id" | "paraId" | "name">> | null;
+    parathreads: Array<Pick<LegacyChain, "id" | "paraId" | "name">> | null;
     paraId: number | null;
-    relay: Pick<Chain, "id"> | null;
-    balancesConfig: Array<BalancesConfig>;
+    relay: Pick<LegacyChain, "id"> | null;
+    balancesConfig: Array<BalancesConfigLegacy>;
     /** @deprecated has its own store now */
-    balancesMetadata: Array<BalancesMetadata>;
+    balancesMetadata: Array<BalancesMetadataLegacy>;
     /** Indicates if the chain has the `CheckMetadataHash` extension, enabling signing with the ledger generic app */
     hasCheckMetadataHash?: boolean;
     /**
@@ -71,17 +73,19 @@ export type Chain = {
     /** Custom signed extensions to be registered in the Metadata object */
     registryTypes?: any;
 };
-export type CustomChain = Chain & {
+/** @deprecated use CustomDotNetwork */
+export type LegacyCustomChain = LegacyChain & {
     isCustom: true;
 };
-export type SubstrateRpc = {
+type SubstrateRpc = {
     url: string;
 };
-export type BalancesConfig = {
+type BalancesConfigLegacy = {
     moduleType: string;
     moduleConfig: unknown;
 };
-export type BalancesMetadata = {
+type BalancesMetadataLegacy = {
     moduleType: string;
     metadata: unknown;
 };
+export {};

package/dist/declarations/src/{types → legacy}/EvmNetwork.d.ts

@@ -1,10 +1,10 @@
-import { BalancesConfig, BalancesMetadata, ChainId } from "./Chain";
-import { TokenId } from "./Token";
-export type EvmNetworkList = Record<EvmNetworkId, EvmNetwork>;
-export type SimpleEvmNetworkList = Record<EvmNetworkId, SimpleEvmNetwork>;
-export type EvmNetworkId = string;
-export type EvmNetwork = {
-    id: EvmNetworkId;
+import { TokenId } from "../chaindata";
+import { LegacyChainId } from "./Chain";
+/** @deprecated */
+export type LegacyEvmNetworkId = string;
+/** @deprecated */
+export type LegacyEvmNetwork = {
+    id: LegacyEvmNetworkId;
     isTestnet: boolean;
     isDefault: boolean;
     forceScan: boolean;
@@ -23,7 +23,7 @@ export type EvmNetwork = {
     explorerUrl: string | null;
     rpcs: Array<EthereumRpc> | null;
     substrateChain: {
-        id: ChainId;
+        id: LegacyChainId;
     } | null;
     /**
      * indicates whether gasEstimates must be used as-is for txs to be valid
@@ -39,17 +39,26 @@ export type EvmNetwork = {
         type: "scroll";
         l1GasPriceOracle: `0x${string}`;
     };
-    balancesConfig: Array<BalancesConfig>;
+    balancesConfig: Array<BalancesConfigLegacy>;
     /** @deprecated has its own store now */
-    balancesMetadata: Array<BalancesMetadata>;
+    balancesMetadata: Array<BalancesMetadataLegacy>;
     erc20aggregator?: `0x${string}`;
 };
-export type CustomEvmNetwork = EvmNetwork & {
+/** @deprecated */
+export type LegacyCustomEvmNetwork = LegacyEvmNetwork & {
     isCustom: true;
     explorerUrls: string[];
     iconUrls: string[];
 };
-export type SimpleEvmNetwork = Omit<EvmNetwork | CustomEvmNetwork, "balancesConfig" | "balancesMetadata">;
-export type EthereumRpc = {
+type EthereumRpc = {
     url: string;
 };
+type BalancesConfigLegacy = {
+    moduleType: string;
+    moduleConfig: unknown;
+};
+type BalancesMetadataLegacy = {
+    moduleType: string;
+    metadata: unknown;
+};
+export {};

package/dist/declarations/src/legacy/TalismanChaindataDatabase.d.ts

@@ -0,0 +1,13 @@
+import { Dexie } from "dexie";
+import { Token, TokenId } from "../chaindata";
+import { LegacyChain, LegacyChainId, LegacyCustomChain } from "./Chain";
+import { LegacyCustomEvmNetwork, LegacyEvmNetwork, LegacyEvmNetworkId } from "./EvmNetwork";
+declare class TalismanChaindataDatabase extends Dexie {
+    chains: Dexie.Table<LegacyChain | LegacyCustomChain, LegacyChainId>;
+    evmNetworks: Dexie.Table<LegacyEvmNetwork | LegacyCustomEvmNetwork, LegacyEvmNetworkId>;
+    tokens: Dexie.Table<Token, TokenId>;
+    constructor();
+}
+/** @deprecated */
+export declare const getChaindataDbV3: () => TalismanChaindataDatabase;
+export {};

package/dist/declarations/src/legacy/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./Chain";
+export * from "./EvmNetwork";
+export * from "./TalismanChaindataDatabase";