@talismn/chaindata-provider 0.1.1

package/CHANGELOG.md

@@ -0,0 +1,13 @@
+# @talismn/chaindata-provider
+
+## 0.1.1
+
+### Patch Changes
+
+- Fixed publish config
+
+## 0.1.0
+
+### Minor Changes
+
+- 43c1a3a: Initial release

package/README.md

@@ -0,0 +1 @@
+# @talismn/chaindata-provider

package/dist/ChaindataProvider.d.ts

@@ -0,0 +1,18 @@
+import { Chain, ChainId, ChainList, EvmNetwork, EvmNetworkId, EvmNetworkList, Token, TokenId, TokenList } from "./types";
+export interface ChaindataChainProvider {
+    chainIds(): Promise<ChainId[]>;
+    chains(): Promise<ChainList>;
+    getChain(chainId: ChainId): Promise<Chain | null>;
+}
+export interface ChaindataEvmNetworkProvider {
+    evmNetworkIds(): Promise<EvmNetworkId[]>;
+    evmNetworks(): Promise<EvmNetworkList>;
+    getEvmNetwork(evmNetworkId: EvmNetworkId): Promise<EvmNetwork | null>;
+}
+export interface ChaindataTokenProvider {
+    tokenIds(): Promise<TokenId[]>;
+    tokens(): Promise<TokenList>;
+    getToken(tokenId: TokenId): Promise<Token | null>;
+}
+export interface ChaindataProvider extends ChaindataChainProvider, ChaindataEvmNetworkProvider, ChaindataTokenProvider {
+}

package/dist/ChaindataProvider.js

@@ -0,0 +1 @@
+export {};

package/dist/index.d.ts

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

package/dist/index.js

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

package/dist/plugins.d.ts

@@ -0,0 +1,17 @@
+/**
+ * `PluginTokenTypes` is a collection of plugin-provided token definitions.
+ *
+ * By hacking declaration merging (typescript magic) we can add variants to this type from within other modules.
+ *
+ * For more details on this process, see:
+ * - https://www.typescriptlang.org/docs/handbook/declaration-merging.html
+ * - https://stackoverflow.com/a/58261244/3926156
+ * - https://stackoverflow.com/a/56099769/3926156
+ * - https://stackoverflow.com/a/56516998/3926156
+ * - https://pqina.nl/blog/typescript-interface-merging-and-extending-modules/
+ *
+ * As a result, consumers of this api will have type information for the `Token` type
+ * based on the selection of plugins they are using in their app.
+ */
+export interface PluginTokenTypes {
+}

package/dist/plugins.js

@@ -0,0 +1 @@
+export {};

package/dist/types/Chain.d.ts

@@ -0,0 +1,39 @@
+import { EvmNetworkId } from "./EvmNetwork";
+import { TokenId } from "./Token";
+export declare type ChainList = Record<ChainId, Chain>;
+export declare type ChainId = string;
+export declare type Chain = {
+    id: ChainId;
+    isTestnet: boolean;
+    sortIndex: number | null;
+    genesisHash: string | null;
+    prefix: number | null;
+    name: string | null;
+    chainName: string;
+    implName: string | null;
+    specName: string | null;
+    specVersion: string | null;
+    nativeToken: {
+        id: TokenId;
+    } | null;
+    tokens: Array<{
+        id: TokenId;
+    }> | null;
+    account: string | null;
+    subscanUrl: string | null;
+    rpcs: Array<SubstrateRpc> | null;
+    isHealthy: boolean;
+    evmNetworks: Array<{
+        id: EvmNetworkId;
+    }>;
+    parathreads?: Chain[];
+    paraId: number | null;
+    relay?: Chain;
+};
+export declare type CustomChain = Chain & {
+    isCustom: true;
+};
+export declare type SubstrateRpc = {
+    url: string;
+    isHealthy: boolean;
+};

package/dist/types/Chain.js

@@ -0,0 +1 @@
+export {};

package/dist/types/EvmNetwork.d.ts

@@ -0,0 +1,32 @@
+import { ChainId } from "./Chain";
+import { TokenId } from "./Token";
+export declare type EvmNetworkList = Record<EvmNetworkId, EvmNetwork | CustomEvmNetwork>;
+/** TODO: Refactor to string */
+export declare type EvmNetworkId = number;
+export declare type EvmNetwork = {
+    id: EvmNetworkId;
+    isTestnet: boolean;
+    sortIndex: number | null;
+    name: string | null;
+    nativeToken: {
+        id: TokenId;
+    } | null;
+    tokens: Array<{
+        id: TokenId;
+    }> | null;
+    explorerUrl: string | null;
+    rpcs: Array<EthereumRpc> | null;
+    isHealthy: boolean;
+    substrateChain: {
+        id: ChainId;
+    } | null;
+};
+export declare type CustomEvmNetwork = EvmNetwork & {
+    isCustom: true;
+    explorerUrls: string[];
+    iconUrls: string[];
+};
+export declare type EthereumRpc = {
+    url: string;
+    isHealthy: boolean;
+};

package/dist/types/EvmNetwork.js

@@ -0,0 +1 @@
+export {};

package/dist/types/MultiChain.d.ts

@@ -0,0 +1,9 @@
+import { ChainId } from "./Chain";
+import { EvmNetworkId } from "./EvmNetwork";
+export declare type MultiChainId = SubChainId | EvmChainId;
+export declare type SubChainId = {
+    subChainId: ChainId;
+};
+export declare type EvmChainId = {
+    evmChainId: EvmNetworkId;
+};

package/dist/types/MultiChain.js

@@ -0,0 +1 @@
+export {};

package/dist/types/Token.d.ts

@@ -0,0 +1,74 @@
+import { PluginTokenTypes } from "../plugins";
+import { ChainId } from "./Chain";
+import { EvmNetworkId } from "./EvmNetwork";
+/**
+ * `TokenTypes` is an automatically determined sub-selection of `PluginTokenTypes`.
+ *
+ * It is the same list, but with any invalid `TokenType` definitions filtered out.
+ */
+export declare type TokenTypes = {
+    [TokenType in keyof PluginTokenTypes]: PluginTokenTypes[TokenType] extends IToken ? PluginTokenTypes[TokenType] : never;
+};
+/**
+ * The `Token` sum type, which is a union of all of the possible `TokenTypes`.
+ *
+ * Each variant comes from a plugin in use by the consuming app.
+ *
+ * For example, in an app with the `substrate-native`, `evm-native`, `substrate-orml` and `evm-erc20` plugins:
+ *
+ *     type Token = SubNativeToken | EvmNativeToken | SubOrmlToken | EvmErc20Token
+ *
+ * If `TokenTypes` is empty then `Token` will fall back to the common `IToken` interface, which every token must implement.
+ */
+export declare type Token = TokenTypes[keyof TokenTypes] extends never ? IToken : TokenTypes[keyof TokenTypes];
+/** A collection of `Token` objects */
+export declare type TokenList = Record<TokenId, Token>;
+export declare type TokenId = string;
+/** `IToken` is a common interface which all tokens must implement. */
+export declare type IToken = {
+    id: TokenId;
+    type: string;
+    isTestnet: boolean;
+    symbol: string;
+    decimals: number;
+    coingeckoId?: string;
+    chain?: {
+        id: ChainId;
+    } | null;
+    evmNetwork?: {
+        id: EvmNetworkId;
+    } | null;
+    rates?: TokenRates;
+};
+/** Used by plugins to help define their custom `TokenType` */
+export declare type NewTokenType<ModuleType extends string, TokenParams extends Record<string, unknown>> = IToken & {
+    type: ModuleType;
+} & TokenParams;
+export declare type TokenRates = {
+    /** us dollar rate */
+    usd: number | null;
+    /** australian dollar rate */
+    aud: number | null;
+    /** new zealand dollar rate */
+    nzd: number | null;
+    /** canadian dollar rate */
+    cud: number | null;
+    /** hong kong dollar rate */
+    hkd: number | null;
+    /** euro rate */
+    eur: number | null;
+    /** british pound sterling rate */
+    gbp: number | null;
+    /** japanese yen rate */
+    jpy: number | null;
+    /** south korean won rate */
+    krw: number | null;
+    /** chinese yuan rate */
+    cny: number | null;
+    /** btc rate */
+    btc: number | null;
+    /** eth rate */
+    eth: number | null;
+    /** dot rate */
+    dot: number | null;
+};

package/dist/types/Token.js

@@ -0,0 +1 @@
+export {};

package/dist/types/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./Chain";
+export * from "./EvmNetwork";
+export * from "./MultiChain";
+export * from "./Token";

package/dist/types/index.js

@@ -0,0 +1,15 @@
+//
+// NOTE: Do not export `./plugins` from here!
+// Doing so will introduce a circular dependency!
+// It is a separate entrypoint meant to be used like this:
+//
+//     import { PluginTokenTypes } from '@talismn/chaindata-provider/plugins'
+//
+// Not this:
+//
+//     import { PluginTokenTypes } from '@talismn/chaindata-provider'
+//
+export * from "./Chain";
+export * from "./EvmNetwork";
+export * from "./MultiChain";
+export * from "./Token";

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@talismn/chaindata-provider",
+  "version": "0.1.1",
+  "author": "Talisman",
+  "homepage": "https://talisman.xyz",
+  "license": "UNLICENSED",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "directory": "packages/chaindata-provider",
+    "type": "git",
+    "url": "https://github.com/talismansociety/talisman.git"
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "/dist",
+    "/plugins"
+  ],
+  "engines": {
+    "node": ">=14"
+  },
+  "scripts": {
+    "dev": "tsc --watch --declarationMap",
+    "build": "tsc --declarationMap",
+    "build:packages:prod": "rm -rf dist && tsc",
+    "prepack": "yarn build:packages:prod",
+    "test": "jest",
+    "lint": "eslint . --max-warnings 0",
+    "clean": "rm -rf dist && rm -rf .turbo rm -rf node_modules"
+  },
+  "devDependencies": {
+    "@talismn/eslint-config": "^0.0.0",
+    "@talismn/tsconfig": "^0.0.0",
+    "@types/jest": "^27.5.1",
+    "eslint": "^8.4.0",
+    "jest": "^28.1.0",
+    "ts-jest": "^28.0.2",
+    "typescript": "^4.6.4"
+  },
+  "eslintConfig": {
+    "root": true,
+    "extends": [
+      "@talismn/eslint-config"
+    ]
+  }
+}

package/plugins/package.json

@@ -0,0 +1,5 @@
+{
+  "internal": true,
+  "main": "../dist/plugins.js",
+  "types": "../dist/plugins.d.ts"
+}