@talismn/chaindata-provider 0.11.1 → 1.0.0

package/dist/declarations/src/provider/ChaindataProvider.d.ts

@@ -0,0 +1,502 @@
+import { Observable } from "rxjs";
+import { IChaindataProvider } from ".";
+import { DotNetwork, Network, NetworkId, NetworkOfPlatform, NetworkPlatform, Token, TokenId, TokenOfType, TokenType } from "../chaindata";
+import { CustomChaindata } from "../state";
+export type ChaindataProviderOptions = {
+    customChaindata$?: Observable<CustomChaindata> | CustomChaindata;
+};
+export declare class ChaindataProvider implements IChaindataProvider {
+    #private;
+    constructor(options?: ChaindataProviderOptions);
+    /**
+     * Mini metadatas
+     */
+    get miniMetadatas$(): Observable<{
+        id: string;
+        source: string;
+        chainId: string;
+        specVersion: number;
+        version: string;
+        data: `0x${string}` | null;
+        extra: any;
+    }[]>;
+    getMiniMetadatas(): Promise<{
+        id: string;
+        source: string;
+        chainId: string;
+        specVersion: number;
+        version: string;
+        data: `0x${string}` | null;
+        extra: any;
+    }[]>;
+    get miniMetadatasMapById$(): Observable<Record<string, {
+        id: string;
+        source: string;
+        chainId: string;
+        specVersion: number;
+        version: string;
+        data: `0x${string}` | null;
+        extra: any;
+    }>>;
+    getMiniMetadatasMapById(): Promise<Record<string, {
+        id: string;
+        source: string;
+        chainId: string;
+        specVersion: number;
+        version: string;
+        data: `0x${string}` | null;
+        extra: any;
+    }>>;
+    getMiniMetadataById$(id: string): Observable<{
+        id: string;
+        source: string;
+        chainId: string;
+        specVersion: number;
+        version: string;
+        data: `0x${string}` | null;
+        extra: any;
+    }>;
+    miniMetadataById(id: string): Promise<{
+        id: string;
+        source: string;
+        chainId: string;
+        specVersion: number;
+        version: string;
+        data: `0x${string}` | null;
+        extra: any;
+    }>;
+    /**
+     * Tokens
+     */
+    get tokens$(): Observable<({
+        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;
+    } | {
+        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;
+    } | {
+        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;
+    } | {
+        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-psp22";
+        platform: "polkadot";
+        contractAddress: 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;
+    })[]>;
+    getTokens$<T extends TokenType | undefined, R extends T extends TokenType ? TokenOfType<T> : Token>(type?: T): Observable<R[]>;
+    getTokens<T extends TokenType | undefined, R extends T extends TokenType ? TokenOfType<T> : Token>(type?: T): Promise<R[]>;
+    getTokenIds$(type?: TokenType): Observable<string[]>;
+    getTokenIds(type?: TokenType): Promise<string[]>;
+    getTokensMapById$<T extends TokenType | undefined, R extends T extends TokenType ? TokenOfType<T> : Token>(type?: T): Observable<Record<TokenId, R>>;
+    getTokensMapById<T extends TokenType | undefined, R extends T extends TokenType ? TokenOfType<T> : Token>(type?: T): Promise<Record<TokenId, R>>;
+    getTokenById$<T extends TokenType | undefined, R extends T extends TokenType ? TokenOfType<T> : Token>(id: TokenId, type?: T): Observable<R | null>;
+    getTokenById<T extends TokenType | undefined, R extends T extends TokenType ? TokenOfType<T> : Token>(id: TokenId, type?: T): Promise<R | null>;
+    /**
+     * Networks
+     */
+    get networks$(): Observable<({
+        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;
+    } | {
+        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;
+    })[]>;
+    getNetworks$<P extends NetworkPlatform | undefined, R = P extends NetworkPlatform ? NetworkOfPlatform<P> : Network>(platform?: P): Observable<R[]>;
+    getNetworks<P extends NetworkPlatform | undefined, R = P extends NetworkPlatform ? NetworkOfPlatform<P> : Network>(platform?: P): Promise<R[]>;
+    getNetworkIds$(platform?: NetworkPlatform): Observable<string[]>;
+    getNetworkIds(platform?: NetworkPlatform): Promise<string[]>;
+    getNetworksMapById$<P extends NetworkPlatform | undefined, R = P extends NetworkPlatform ? NetworkOfPlatform<P> : Network>(platform?: P): Observable<Record<NetworkId, R>>;
+    getNetworksMapById<P extends NetworkPlatform | undefined, R = P extends NetworkPlatform ? NetworkOfPlatform<P> : Network>(platform?: P): Promise<Record<NetworkId, R>>;
+    getNetworksMapByGenesisHash$(): Observable<Record<`0x${string}`, DotNetwork>>;
+    getNetworksMapByGenesisHash(): Promise<Record<`0x${string}`, {
+        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;
+    }>>;
+    getNetworkById$<P extends NetworkPlatform | undefined, R = P extends NetworkPlatform ? NetworkOfPlatform<P> : Network>(networkId: NetworkId, platform?: P): Observable<R | null>;
+    getNetworkById<P extends NetworkPlatform | undefined, R = P extends NetworkPlatform ? NetworkOfPlatform<P> : Network>(networkId: NetworkId, platform?: P): Promise<R | null>;
+    getNetworkByGenesisHash$(genesisHash: `0x${string}`): Observable<{
+        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;
+    }>;
+    getNetworkByGenesisHash(genesisHash: `0x${string}`): Promise<{
+        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 isNetworkCustom: (network: Network) => boolean;
+export declare const isNetworkKnown: (network: Network) => boolean;
+export declare const isTokenCustom: (token: Token) => boolean;
+export declare const isTokenKnown: (token: Token) => boolean;
+export declare const isTokenTestnet: (token: Token) => boolean;
+export declare const getCleanNetwork: (network: Network) => Network;
+export declare const getCleanToken: (token: Token) => Token;

package/dist/declarations/src/provider/ChaindataProviderInterface.d.ts

@@ -0,0 +1,30 @@
+import { Observable } from "rxjs";
+import { DotNetwork, Network, NetworkId, NetworkOfPlatform, NetworkPlatform, Token, TokenId, TokenOfType, TokenType } from "../chaindata";
+export interface IChaindataNetworkProvider {
+    networks$: Observable<Network[]>;
+    getNetworks$<P extends NetworkPlatform | undefined, R = P extends NetworkPlatform ? NetworkOfPlatform<P> : Network>(platform?: P): Observable<R[]>;
+    getNetworks<P extends NetworkPlatform | undefined, R = P extends NetworkPlatform ? NetworkOfPlatform<P> : Network>(platform?: P): Promise<R[]>;
+    getNetworkIds$(platform?: NetworkPlatform): Observable<NetworkId[]>;
+    getNetworkIds(platform?: NetworkPlatform): Promise<NetworkId[]>;
+    getNetworksMapById$<P extends NetworkPlatform | undefined, R = P extends NetworkPlatform ? NetworkOfPlatform<P> : Network>(platform?: P): Observable<Record<NetworkId, R>>;
+    getNetworksMapById<P extends NetworkPlatform | undefined, R = P extends NetworkPlatform ? NetworkOfPlatform<P> : Network>(platform?: P): Promise<Record<NetworkId, R>>;
+    getNetworksMapByGenesisHash$(): Observable<Record<`0x${string}`, DotNetwork>>;
+    getNetworksMapByGenesisHash(): Promise<Record<`0x${string}`, DotNetwork>>;
+    getNetworkById$<P extends NetworkPlatform | undefined, R = P extends NetworkPlatform ? NetworkOfPlatform<P> : Network>(networkId: NetworkId, platform?: P): Observable<R | null>;
+    getNetworkById<P extends NetworkPlatform | undefined, R = P extends NetworkPlatform ? NetworkOfPlatform<P> : Network>(networkId: NetworkId, platform?: P): Promise<R | null>;
+    getNetworkByGenesisHash$(genesisHash: `0x${string}`): Observable<DotNetwork | null>;
+    getNetworkByGenesisHash(genesisHash: `0x${string}`): Promise<DotNetwork | null>;
+}
+export interface IChaindataTokenProvider {
+    tokens$: Observable<Token[]>;
+    getTokens$<T extends TokenType | undefined, R extends T extends TokenType ? TokenOfType<T> : Token>(type?: T): Observable<R[]>;
+    getTokens<T extends TokenType | undefined, R extends T extends TokenType ? TokenOfType<T> : Token>(type?: T): Promise<R[]>;
+    getTokenIds$(type?: TokenType): Observable<TokenId[]>;
+    getTokenIds(type?: TokenType): Promise<TokenId[]>;
+    getTokensMapById$<T extends TokenType | undefined, R extends T extends TokenType ? TokenOfType<T> : Token>(type?: T): Observable<Record<TokenId, R>>;
+    getTokensMapById<T extends TokenType | undefined, R extends T extends TokenType ? TokenOfType<T> : Token>(type?: T): Promise<Record<TokenId, R>>;
+    getTokenById$<T extends TokenType | undefined, R extends T extends TokenType ? TokenOfType<T> : Token>(tokenId: TokenId, type?: T): Observable<R | null>;
+    getTokenById<T extends TokenType | undefined, R extends T extends TokenType ? TokenOfType<T> : Token>(tokenId: TokenId, type?: T): Promise<R | null>;
+}
+export interface IChaindataProvider extends IChaindataNetworkProvider, IChaindataTokenProvider {
+}

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

@@ -0,0 +1,2 @@
+export * from "./ChaindataProviderInterface";
+export * from "./ChaindataProvider";

package/dist/declarations/src/state/db.d.ts

@@ -0,0 +1,11 @@
+import { Dexie } from "dexie";
+import { AnyMiniMetadata } from "../chaindata";
+import { Network, NetworkId } from "../chaindata/networks";
+import { Token, TokenId } from "../chaindata/tokens";
+export declare class ChaindataDb extends Dexie {
+    tokens: Dexie.Table<Token, TokenId>;
+    networks: Dexie.Table<Network, NetworkId>;
+    miniMetadatas: Dexie.Table<AnyMiniMetadata, string>;
+    constructor();
+}
+export declare const chaindataDb: ChaindataDb;