@talismn/chaindata-provider 0.0.0-pr472-20230201082459

package/CHANGELOG.md

@@ -0,0 +1,69 @@
+# @talismn/chaindata-provider
+
+## 0.0.0-pr472-20230201082459
+
+### Patch Changes
+
+- c0da9a1: feat: switched build tool to preconstruct
+
+## 0.2.1
+
+### Patch Changes
+
+- 4aa691d: feat: new balance modules
+
+## 0.2.0
+
+## 0.1.10
+
+### Patch Changes
+
+- fix: a variety of improvements from the wallet integration
+
+## 0.1.9
+
+### Patch Changes
+
+- 8ecb8214: fix: get token logo urls from chaindata-provider
+
+## 0.1.8
+
+## 0.1.7
+
+## 0.1.6
+
+### Patch Changes
+
+- ca50757: feat: implemented token fiat rates in @talismn/balances
+
+## 0.1.5
+
+### Patch Changes
+
+- d66c5bc: fix: evm native tokens
+
+## 0.1.4
+
+## 0.1.3
+
+### Patch Changes
+
+- d5f69f7: fix: migrated orml token code into substrate orml module
+
+## 0.1.2
+
+### Patch Changes
+
+- 5af305c: switched build output from esm to commonjs for ecosystem compatibility
+
+## 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/declarations/src/ChaindataProvider.d.ts

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

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

@@ -0,0 +1,11 @@
+import { ChainId, EvmNetworkId, TokenId } from "./types";
+export declare const githubChaindataBranch = "v3";
+export declare const githubChaindataBaseUrl: string;
+export declare const githubChainsUrl: string;
+export declare const githubTestnetChainsUrl: string;
+export declare const githubEvmNetworksUrl: string;
+export declare const githubTokensUrl: string;
+export declare const githubChainLogoUrl: (chainId: ChainId) => string;
+export declare const githubEvmNetworkLogoUrl: (networkId: EvmNetworkId) => string;
+export declare const githubTokenLogoUrl: (tokenId: TokenId) => string;
+export declare const githubUnknownTokenLogoUrl: string;

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

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

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

@@ -0,0 +1,20 @@
+/**
+ * `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 {};
+declare global {
+    export interface TalismanPluginTokenTypes {
+    }
+}

package/dist/declarations/src/types/Chain.d.ts

@@ -0,0 +1,44 @@
+import { EvmNetworkId } from "./EvmNetwork";
+import { TokenId } from "./Token";
+export type ChainList = Record<ChainId, Chain | CustomChain>;
+export type ChainId = string;
+export type Chain = {
+    id: ChainId;
+    isTestnet: boolean;
+    sortIndex: number | null;
+    genesisHash: string | null;
+    prefix: number | null;
+    name: string | null;
+    logo: 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;
+    balanceMetadata: Array<{
+        moduleType: string;
+        metadata: any;
+    }>;
+};
+export type CustomChain = Chain & {
+    isCustom: true;
+};
+export type SubstrateRpc = {
+    url: string;
+    isHealthy: boolean;
+};

package/dist/declarations/src/types/EvmNetwork.d.ts

@@ -0,0 +1,32 @@
+import { ChainId } from "./Chain";
+import { TokenId } from "./Token";
+export type EvmNetworkList = Record<EvmNetworkId, EvmNetwork | CustomEvmNetwork>;
+export type EvmNetworkId = string;
+export type EvmNetwork = {
+    id: EvmNetworkId;
+    isTestnet: boolean;
+    sortIndex: number | null;
+    name: string | null;
+    logo: 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 type CustomEvmNetwork = EvmNetwork & {
+    isCustom: true;
+    explorerUrls: string[];
+    iconUrls: string[];
+};
+export type EthereumRpc = {
+    url: string;
+    isHealthy: boolean;
+};

package/dist/declarations/src/types/MultiChain.d.ts

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

package/dist/declarations/src/types/Token.d.ts

@@ -0,0 +1,49 @@
+import { ChainId } from "./Chain";
+import { EvmNetworkId } from "./EvmNetwork";
+declare global {
+    export interface TalismanPluginTokenTypes {
+    }
+}
+/**
+ * `TokenTypes` is an automatically determined sub-selection of `PluginTokenTypes`.
+ *
+ * It is the same list, but with any invalid `TokenType` definitions filtered out.
+ */
+export type TokenTypes = {
+    [TokenType in keyof TalismanPluginTokenTypes]: TalismanPluginTokenTypes[TokenType] extends IToken ? TalismanPluginTokenTypes[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 type Token = TokenTypes[keyof TokenTypes] extends never ? IToken : TokenTypes[keyof TokenTypes];
+/** A collection of `Token` objects */
+export type TokenList = Record<TokenId, Token>;
+export type TokenId = string;
+/** `IToken` is a common interface which all tokens must implement. */
+export type IToken = {
+    id: TokenId;
+    type: string;
+    isTestnet: boolean;
+    symbol: string;
+    decimals: number;
+    logo: string;
+    coingeckoId?: string;
+    chain?: {
+        id: ChainId;
+    } | null;
+    evmNetwork?: {
+        id: EvmNetworkId;
+    } | null;
+};
+/** Used by plugins to help define their custom `TokenType` */
+export type NewTokenType<ModuleType extends string, TokenParams extends Record<string, unknown>> = IToken & {
+    type: ModuleType;
+} & TokenParams;

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

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

package/dist/talismn-chaindata-provider.cjs.d.ts

@@ -0,0 +1 @@
+export * from "./declarations/src/index";

package/dist/talismn-chaindata-provider.cjs.dev.js

@@ -0,0 +1,25 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+const githubChaindataBranch = "v3";
+const githubChaindataBaseUrl = `https://raw.githubusercontent.com/TalismanSociety/chaindata/${githubChaindataBranch}`;
+const githubChainsUrl = `${githubChaindataBaseUrl}/chaindata.json`;
+const githubTestnetChainsUrl = `${githubChaindataBaseUrl}/testnets-chaindata.json`;
+const githubEvmNetworksUrl = `${githubChaindataBaseUrl}/evm-networks.json`;
+const githubTokensUrl = `${githubChaindataBaseUrl}/tokens.json`;
+const githubChainLogoUrl = chainId => `${githubChaindataBaseUrl}/assets/chains/${chainId}.svg`;
+const githubEvmNetworkLogoUrl = networkId => `${githubChaindataBaseUrl}/assets/chains/${networkId}.svg`;
+const githubTokenLogoUrl = tokenId => `${githubChaindataBaseUrl}/assets/tokens/${tokenId}.svg`;
+const githubUnknownTokenLogoUrl = githubTokenLogoUrl("unknown");
+
+exports.githubChainLogoUrl = githubChainLogoUrl;
+exports.githubChaindataBaseUrl = githubChaindataBaseUrl;
+exports.githubChaindataBranch = githubChaindataBranch;
+exports.githubChainsUrl = githubChainsUrl;
+exports.githubEvmNetworkLogoUrl = githubEvmNetworkLogoUrl;
+exports.githubEvmNetworksUrl = githubEvmNetworksUrl;
+exports.githubTestnetChainsUrl = githubTestnetChainsUrl;
+exports.githubTokenLogoUrl = githubTokenLogoUrl;
+exports.githubTokensUrl = githubTokensUrl;
+exports.githubUnknownTokenLogoUrl = githubUnknownTokenLogoUrl;

package/dist/talismn-chaindata-provider.cjs.js

@@ -0,0 +1,7 @@
+'use strict';
+
+if (process.env.NODE_ENV === "production") {
+  module.exports = require("./talismn-chaindata-provider.cjs.prod.js");
+} else {
+  module.exports = require("./talismn-chaindata-provider.cjs.dev.js");
+}

package/dist/talismn-chaindata-provider.cjs.prod.js

@@ -0,0 +1,25 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+const githubChaindataBranch = "v3";
+const githubChaindataBaseUrl = `https://raw.githubusercontent.com/TalismanSociety/chaindata/${githubChaindataBranch}`;
+const githubChainsUrl = `${githubChaindataBaseUrl}/chaindata.json`;
+const githubTestnetChainsUrl = `${githubChaindataBaseUrl}/testnets-chaindata.json`;
+const githubEvmNetworksUrl = `${githubChaindataBaseUrl}/evm-networks.json`;
+const githubTokensUrl = `${githubChaindataBaseUrl}/tokens.json`;
+const githubChainLogoUrl = chainId => `${githubChaindataBaseUrl}/assets/chains/${chainId}.svg`;
+const githubEvmNetworkLogoUrl = networkId => `${githubChaindataBaseUrl}/assets/chains/${networkId}.svg`;
+const githubTokenLogoUrl = tokenId => `${githubChaindataBaseUrl}/assets/tokens/${tokenId}.svg`;
+const githubUnknownTokenLogoUrl = githubTokenLogoUrl("unknown");
+
+exports.githubChainLogoUrl = githubChainLogoUrl;
+exports.githubChaindataBaseUrl = githubChaindataBaseUrl;
+exports.githubChaindataBranch = githubChaindataBranch;
+exports.githubChainsUrl = githubChainsUrl;
+exports.githubEvmNetworkLogoUrl = githubEvmNetworkLogoUrl;
+exports.githubEvmNetworksUrl = githubEvmNetworksUrl;
+exports.githubTestnetChainsUrl = githubTestnetChainsUrl;
+exports.githubTokenLogoUrl = githubTokenLogoUrl;
+exports.githubTokensUrl = githubTokensUrl;
+exports.githubUnknownTokenLogoUrl = githubUnknownTokenLogoUrl;

package/dist/talismn-chaindata-provider.esm.js

@@ -0,0 +1,12 @@
+const githubChaindataBranch = "v3";
+const githubChaindataBaseUrl = `https://raw.githubusercontent.com/TalismanSociety/chaindata/${githubChaindataBranch}`;
+const githubChainsUrl = `${githubChaindataBaseUrl}/chaindata.json`;
+const githubTestnetChainsUrl = `${githubChaindataBaseUrl}/testnets-chaindata.json`;
+const githubEvmNetworksUrl = `${githubChaindataBaseUrl}/evm-networks.json`;
+const githubTokensUrl = `${githubChaindataBaseUrl}/tokens.json`;
+const githubChainLogoUrl = chainId => `${githubChaindataBaseUrl}/assets/chains/${chainId}.svg`;
+const githubEvmNetworkLogoUrl = networkId => `${githubChaindataBaseUrl}/assets/chains/${networkId}.svg`;
+const githubTokenLogoUrl = tokenId => `${githubChaindataBaseUrl}/assets/tokens/${tokenId}.svg`;
+const githubUnknownTokenLogoUrl = githubTokenLogoUrl("unknown");
+
+export { githubChainLogoUrl, githubChaindataBaseUrl, githubChaindataBranch, githubChainsUrl, githubEvmNetworkLogoUrl, githubEvmNetworksUrl, githubTestnetChainsUrl, githubTokenLogoUrl, githubTokensUrl, githubUnknownTokenLogoUrl };

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@talismn/chaindata-provider",
+  "version": "0.0.0-pr472-20230201082459",
+  "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/talismn-chaindata-provider.cjs.js",
+  "module": "dist/talismn-chaindata-provider.esm.js",
+  "files": [
+    "/dist",
+    "/plugins"
+  ],
+  "engines": {
+    "node": ">=14"
+  },
+  "scripts": {
+    "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-pr472-20230201082459",
+    "@talismn/tsconfig": "^0.0.0-pr472-20230201082459",
+    "@types/jest": "^27.5.1",
+    "eslint": "^8.4.0",
+    "jest": "^28.1.0",
+    "ts-jest": "^28.0.2",
+    "typescript": "^4.6.4"
+  },
+  "preconstruct": {
+    "entrypoints": [
+      "index.ts",
+      "plugins.ts"
+    ]
+  },
+  "eslintConfig": {
+    "root": true,
+    "extends": [
+      "@talismn/eslint-config/base"
+    ]
+  }
+}

package/plugins/dist/talismn-chaindata-provider-plugins.cjs.d.ts

@@ -0,0 +1 @@
+export * from "../../dist/declarations/src/plugins";

package/plugins/dist/talismn-chaindata-provider-plugins.cjs.dev.js

@@ -0,0 +1,2 @@
+'use strict';
+

package/plugins/dist/talismn-chaindata-provider-plugins.cjs.js

@@ -0,0 +1,7 @@
+'use strict';
+
+if (process.env.NODE_ENV === "production") {
+  module.exports = require("./talismn-chaindata-provider-plugins.cjs.prod.js");
+} else {
+  module.exports = require("./talismn-chaindata-provider-plugins.cjs.dev.js");
+}

package/plugins/dist/talismn-chaindata-provider-plugins.cjs.prod.js

@@ -0,0 +1,2 @@
+'use strict';
+

package/plugins/dist/talismn-chaindata-provider-plugins.esm.js

@@ -0,0 +1 @@
+

package/plugins/package.json

@@ -0,0 +1,5 @@
+{
+  "internal": true,
+  "main": "dist/talismn-chaindata-provider-plugins.cjs.js",
+  "module": "dist/talismn-chaindata-provider-plugins.esm.js"
+}