@talismn/on-chain-id 0.1.0 → 0.1.1

package/README.md

@@ -5,7 +5,6 @@
 [![license](https://img.shields.io/github/license/talismansociety/talisman?style=flat-square)](https://github.com/TalismanSociety/talisman/blob/dev/LICENSE)
 [![npm-version](https://img.shields.io/npm/v/@talismn/on-chain-id?style=flat-square)](https://www.npmjs.com/package/@talismn/on-chain-id)
 [![npm-downloads](https://img.shields.io/npm/dw/@talismn/on-chain-id?style=flat-square)](https://www.npmjs.com/package/@talismn/on-chain-id)
-[![discord-link](https://img.shields.io/discord/858891448271634473?logo=discord&logoColor=white&style=flat-square)](https://discord.gg/talisman)
 
 **@talismn/on-chain-id** is used to query on-chain identifiers for account addresses in Ethereum and Polkadot.
 

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

@@ -1,35 +1,14 @@
-import { TypeRegistry } from "@polkadot/types";
-import { ChainConnectors } from "@talismn/balances";
-export * from "./helpers";
-export type OnChainIds = Map<string, string | null>;
+import { OptionalConfig } from "./util/types";
+export type { Config as OnChainIdConfig, NsLookupType, OnChainIds, ResolvedNames, } from "./util/types";
+export * from "./util/isPotentialAzns";
+export * from "./util/isPotentialEns";
 export declare class OnChainId {
-    private polkadotRegistry;
-    private chainConnectors;
-    private chainIdPolkadot;
-    private networkIdEthereum;
-    constructor(polkadotRegistry: TypeRegistry, chainConnectors: ChainConnectors, chainIdPolkadot?: string, networkIdEthereum?: string);
-    /**
-     * Looks up the addresses for some ENS domains.
-     */
-    resolveNames(names: string[]): Promise<Map<string, string | null>>;
-    /**
-     * Looks up the on-chain identifiers for some addresses.
-     *
-     * Prefers ENS, then falls back to Polkadot identities.
-     *
-     * Requires a TypeRegistry which has been instantiated on the Polkadot relay chain.
-     * Talisman Wallet developers can build one by using `/apps/extension/src/core/util/getTypeRegistry.ts`.
-     */
-    lookupAddresses(addresses: string[]): Promise<OnChainIds>;
-    /**
-     * Looks up the on-chain Polkadot identities for some addresses.
-     *
-     * Requires a TypeRegistry which has been instantiated on the Polkadot relay chain.
-     * Talisman Wallet developers can build one by using `/apps/extension/src/core/util/getTypeRegistry.ts`.
-     */
-    lookupPolkadotAddresses(addresses: string[]): Promise<OnChainIds>;
-    /**
-     * Looks up the on-chain ENS domains for some addresses.
-     */
-    lookupEnsAddresses(addresses: string[]): Promise<OnChainIds>;
+    #private;
+    constructor(config: OptionalConfig);
+    resolveNames: (names: string[]) => Promise<import("./util/types").ResolvedNames>;
+    resolveEnsNames: (names: string[]) => Promise<import("./util/types").ResolvedNames>;
+    resolveAznsNames: (names: string[]) => Promise<import("./util/types").ResolvedNames>;
+    lookupAddresses: (addresses: string[]) => Promise<import("./util/types").OnChainIds>;
+    lookupAznsAddresses: (addresses: string[]) => Promise<import("./util/types").OnChainIds>;
+    lookupEnsAddresses: (addresses: string[]) => Promise<import("./util/types").OnChainIds>;
 }

package/dist/declarations/src/util/addressesToNames.d.ts

@@ -0,0 +1,14 @@
+import { Config, OnChainIds } from "./types";
+/**
+ * Looks up the on-chain identifiers for some addresses.
+ * Supports ENS and AZNS.
+ */
+export declare const lookupAddresses: (config: Config, addresses: string[]) => Promise<OnChainIds>;
+/**
+ * Looks up the on-chain AZNS domains for some addresses.
+ */
+export declare const lookupAznsAddresses: (config: Config, addresses: string[]) => Promise<OnChainIds>;
+/**
+ * Looks up the on-chain ENS domains for some addresses.
+ */
+export declare const lookupEnsAddresses: (config: Config, addresses: string[]) => Promise<OnChainIds>;

package/dist/declarations/src/util/aznsRouter.d.ts

@@ -0,0 +1,10 @@
+import { ProviderInterface } from "@polkadot/rpc-provider/types";
+import { TypeRegistry } from "@polkadot/types";
+type ProviderOptions = {
+    chainId: string;
+    provider: ProviderInterface;
+    registry: TypeRegistry;
+};
+export declare const resolveDomainToAddress: (domain: string, { provider, registry, chainId }: ProviderOptions) => Promise<string>;
+export declare const resolveAddressToDomain: (address: string, { provider, registry, chainId }: ProviderOptions) => Promise<string>;
+export {};

package/dist/declarations/src/util/isPotentialAzns.d.ts

@@ -0,0 +1,2 @@
+/** dot separated string with `azero` or `tzero` suffix e.g. `fontbois.tzero` or `talisman.tzero` */
+export declare const isPotentialAzns: (name?: string) => boolean;

package/dist/declarations/src/util/isPotentialEns.d.ts

@@ -0,0 +1,2 @@
+/** dot separated string e.g. `ens.eth` or `hello.lol`, but not ending with `.azero` nor `.tzero` */
+export declare const isPotentialEns: (name?: string) => boolean;

package/dist/declarations/src/util/namesToAddresses.d.ts

@@ -0,0 +1,10 @@
+import { Config, ResolvedNames } from "./types";
+export declare const resolveNames: (config: Config, names: string[]) => Promise<ResolvedNames>;
+/**
+ * Looks up the addresses for some azns (azero.id) domains.
+ */
+export declare const resolveAznsNames: (config: Config, names: string[]) => Promise<ResolvedNames>;
+/**
+ * Looks up the addresses for some ens (ens.domains) domains.
+ */
+export declare const resolveEnsNames: (config: Config, names: string[]) => Promise<ResolvedNames>;

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

@@ -0,0 +1,31 @@
+import { SupportedChainId } from "@azns/resolver-core";
+import { TypeRegistry } from "@polkadot/types";
+import { ChainConnectors } from "@talismn/balances";
+/** A map of addresses to their on-chain ids. */
+export type OnChainIds = Map<string, string | null>;
+/** A map of lookup names to their resolved addresses. */
+export type ResolvedNames = Map<string, [string, NsLookupType] | null>;
+/** These are the supported name lookup types. */
+export type NsLookupType = "ens" | "azns";
+/**
+ * Used as the first parameter to all `namesToAddresses`/`addressesToNames` functions.
+ */
+export type Config = {
+    registryAlephZero: TypeRegistry;
+    chainConnectors: ChainConnectors;
+    /** Used for azns lookups */
+    chainIdAlephZero: string;
+    /** Used for azns lookups */
+    aznsSupportedChainIdAlephZero: `${SupportedChainId}`;
+    /** Used for ens lookups */
+    networkIdEthereum: string;
+};
+export type OptionalConfigParams = "chainIdAlephZero" | "aznsSupportedChainIdAlephZero" | "networkIdEthereum";
+export type OptionalConfig = Omit<Config, OptionalConfigParams> & Partial<Pick<Config, OptionalConfigParams>>;
+/**
+ * Removes the first argument from a tuple type.
+ *
+ *     type AllParams = ["one", "two", "three"]
+ *     type DropFirstParams = DropFirst<AllParams> // evaluates to ["two", "three"]
+ */
+export type DropFirst<T extends unknown[]> = T extends [unknown, ...infer U] ? U : never;