@ensnode/datasources 0.28.0 → 0.29.0

package/README.md

@@ -38,7 +38,7 @@ const vitaliksResolverAddress = await publicClient.readContract({
 
 ## Documentation
 
-### getDatasource(namespace: ENSNamespace, datasourceName: DatasourceName)
+### getDatasource(namespaceId: ENSNamespaceId, datasourceName: DatasourceName)
 
 The primary export of `@ensnode/datasources` is `getDatasource` which returns a selected `Datasource` within the selected ENS namespace.
 
@@ -55,7 +55,7 @@ const { chain, contracts } = getDatasource('holesky', 'ensroot');
 const { chain, contracts } = getDatasource('mainnet', 'threedns-base');
 ```
 
-The available `ENSNamespace`s are:
+The available `ENSNamespaceId`s are:
 - `mainnet`
 - `sepolia`
 - `holesky`
@@ -66,11 +66,11 @@ The available `ENSNamespace`s are:
 Each ENS namespace my provide **Datasource** entries for any of the possible **DatasourceName**s:
 
 The available `DatasourceName`s are:
-- `ensroot` — ENS Root Contracts
-- `basenames` — Basenames
-- `lineanames` — Linea Names
-- `threedns-optimism` — 3DNS (on Optimism)
-- `threedns-base` — 3DNS (on Base)
+- `ensroot` — ENS Root Contracts, guaranteed to exist
+- `basenames` — Basenames, optional
+- `lineanames` — Linea Names, optional
+- `threedns-optimism` — 3DNS (on Optimism), optional
+- `threedns-base` — 3DNS (on Base), optional
 
 A `Datasource` will only be available within an ENS namespace if it is defined, and typescript will enforce that a valid DatasourceName is used within `getDatasource(...)`.
 

package/dist/index.d.ts

@@ -4,7 +4,7 @@ import * as viem from 'viem';
 import { Chain, Abi, Address } from 'viem';
 
 /**
- * ENSNamespaces encodes the set of well-known ENS namespaces.
+ * ENSNamespaceIds encodes the set of identifiers for well-known ENS namespaces.
  *
  * Each ENS namespace is a single, unified set of ENS names with a distinct onchain root
  * Registry (the ensroot Datasource) and the capability of spanning from that root Registry across
@@ -29,16 +29,16 @@ import { Chain, Abi, Address } from 'viem';
  * protocol changes, running deterministic test suites, and local development.
  * https://github.com/ensdomains/ens-test-env
  */
-declare const ENSNamespaces: {
+declare const ENSNamespaceIds: {
     readonly Mainnet: "mainnet";
     readonly Sepolia: "sepolia";
     readonly Holesky: "holesky";
     readonly EnsTestEnv: "ens-test-env";
 };
 /**
- * ENSNamespace is the derived string union of possible ENSNamespace values.
+ * ENSNamespaceId is the derived string union of possible ENS namespace identifiers.
  */
-type ENSNamespace = (typeof ENSNamespaces)[keyof typeof ENSNamespaces];
+type ENSNamespaceId = (typeof ENSNamespaceIds)[keyof typeof ENSNamespaceIds];
 /**
  * A Datasource describes a set of contracts on a given chain that interact with the ENS protocol.
  */
@@ -87,14 +87,16 @@ type ContractConfig = {
     readonly startBlock: number;
 };
 /**
- * DatasourceMap encodes the set of known Datasources within an ENS namespace, keyed by DatasourceName.
- * The ENSRoot Datasource is required, and all others are optional.
+ * ENSNamespace encodes a set of known Datasources associated with the same ENS namespace.
+ *
+ * The ENSRoot Datasource is required (this formally defines an ENS namespace). All other Datasources
+ * within the ENSNamespace are optional.
  */
-type DatasourceMap = {
+type ENSNamespace = {
     [DatasourceNames.ENSRoot]: Datasource;
 } & Partial<Record<Exclude<DatasourceName, "ensroot">, Datasource>>;
 
-declare const ENSNamespaceToDatasourceMap: {
+declare const ENSNamespacesById: {
     readonly mainnet: {
         ensroot: {
             chain: {
@@ -35596,23 +35598,23 @@ declare const ENSNamespaceToDatasourceMap: {
     };
 };
 /**
- * Returns the DatasourceMap within the specified namespace.
+ * Returns the ENSNamespace for a specified `namespaceId`.
  *
- * @param namespace - The ENSNamespace identifier (e.g. 'mainnet', 'sepolia', 'holesky', 'ens-test-env')
- * @returns The DatasourceMap for the specified namespace
+ * @param namespaceId - The ENSNamespace identifier (e.g. 'mainnet', 'sepolia', 'holesky', 'ens-test-env')
+ * @returns the ENSNamespace
  */
-declare const getDatasourceMap: <T extends ENSNamespace>(namespace: T) => (typeof ENSNamespaceToDatasourceMap)[T];
+declare const getENSNamespace: <T extends ENSNamespaceId>(namespaceId: T) => (typeof ENSNamespacesById)[T];
 /**
- * Returns the `datasourceName` Datasource within the specified `namespace` namespace.
+ * Returns the `datasourceName` Datasource within the specified `namespaceId` namespace.
  *
  * NOTE: the typescript typechecker _will_ enforce validity. i.e. using an invalid `datasourceName`
- * within the specified `namespace` will be a type error.
+ * within the specified `namespaceId` will be a type error.
  *
- * @param namespace - The ENSNamespace identifier (e.g. 'mainnet', 'sepolia', 'holesky', 'ens-test-env')
+ * @param namespaceId - The ENSNamespace identifier (e.g. 'mainnet', 'sepolia', 'holesky', 'ens-test-env')
  * @param datasourceName - The name of the Datasource to retrieve
  * @returns The Datasource object for the given name within the specified namespace
  */
-declare const getDatasource: <N extends ENSNamespace, D extends keyof ReturnType<typeof getDatasourceMap<N>>>(namespace: N, datasourceName: D) => {
+declare const getDatasource: <N extends ENSNamespaceId, D extends keyof ReturnType<typeof getENSNamespace<N>>>(namespaceId: N, datasourceName: D) => {
     readonly mainnet: {
         ensroot: {
             chain: {
@@ -71118,6 +71120,6 @@ declare const getDatasource: <N extends ENSNamespace, D extends keyof ReturnType
  *
  * @returns the chain ID that hosts the ENS Root
  */
-declare const getENSRootChainId: (namespace: ENSNamespace) => number;
+declare const getENSRootChainId: (namespaceId: ENSNamespaceId) => number;
 
-export { type ContractConfig, type Datasource, type DatasourceMap, type DatasourceName, DatasourceNames, type ENSNamespace, ENSNamespaces, type EventFilter, getDatasource, getDatasourceMap, getENSRootChainId };
+export { type ContractConfig, type Datasource, type DatasourceName, DatasourceNames, type ENSNamespace, type ENSNamespaceId, ENSNamespaceIds, type EventFilter, getDatasource, getENSNamespace, getENSRootChainId };

package/dist/index.js

@@ -1,5 +1,5 @@
 // src/lib/types.ts
-var ENSNamespaces = {
+var ENSNamespaceIds = {
   Mainnet: "mainnet",
   Sepolia: "sepolia",
   Holesky: "holesky",
@@ -4997,7 +4997,7 @@ var deploymentAddresses = getENSTestEnvDeploymentAddresses();
 var EMPTY_ADDRESS = "";
 var ens_test_env_default = {
   /**
-   * Root Datasource
+   * ENSRoot Datasource
    *
    * Addresses and Start Blocks from ens-test-env
    * https://github.com/ensdomains/ens-test-env/
@@ -5053,7 +5053,7 @@ var ens_test_env_default = {
 import { holesky } from "viem/chains";
 var holesky_default = {
   /**
-   * Root Datasource
+   * ENSRoot Datasource
    *
    * Addresses and Start Blocks from ENS Holesky Subgraph Manifest
    * https://ipfs.io/ipfs/Qmd94vseLpkUrSFvJ3GuPubJSyHz8ornhNrwEAt6pjcbex
@@ -9043,7 +9043,7 @@ var ThreeDNSToken = [
 // src/mainnet.ts
 var mainnet_default = {
   /**
-   * Root Datasource
+   * ENSRoot Datasource
    *
    * Addresses and Start Blocks from ENS Mainnet Subgraph Manifest
    * https://ipfs.io/ipfs/Qmd94vseLpkUrSFvJ3GuPubJSyHz8ornhNrwEAt6pjcbex
@@ -9238,7 +9238,7 @@ var mainnet_default = {
 import { baseSepolia, lineaSepolia, sepolia } from "viem/chains";
 var sepolia_default = {
   /**
-   * Root Datasource
+   * ENSRoot Datasource
    *
    * Addresses and Start Blocks from ENS Sepolia Subgraph Manifest
    * https://ipfs.io/ipfs/QmdDtoN9QCRsBUsyoiiUUMQPPmPp5jimUQe81828UyWLtg
@@ -9389,20 +9389,20 @@ var sepolia_default = {
 };
 
 // src/index.ts
-var ENSNamespaceToDatasourceMap = {
+var ENSNamespacesById = {
   mainnet: mainnet_default,
   sepolia: sepolia_default,
   holesky: holesky_default,
   "ens-test-env": ens_test_env_default
 };
-var getDatasourceMap = (namespace) => ENSNamespaceToDatasourceMap[namespace];
-var getDatasource = (namespace, datasourceName) => getDatasourceMap(namespace)[datasourceName];
-var getENSRootChainId = (namespace) => getDatasource(namespace, DatasourceNames.ENSRoot).chain.id;
+var getENSNamespace = (namespaceId) => ENSNamespacesById[namespaceId];
+var getDatasource = (namespaceId, datasourceName) => getENSNamespace(namespaceId)[datasourceName];
+var getENSRootChainId = (namespaceId) => getDatasource(namespaceId, DatasourceNames.ENSRoot).chain.id;
 export {
   DatasourceNames,
-  ENSNamespaces,
+  ENSNamespaceIds,
   getDatasource,
-  getDatasourceMap,
+  getENSNamespace,
   getENSRootChainId
 };
 //# sourceMappingURL=index.js.map