@ensdomains/ensjs 3.0.0-alpha.9 → 3.0.0-beta.2

package/src/clients/public.ts

@@ -0,0 +1,81 @@
+import {
+  createClient,
+  type Chain,
+  type Client,
+  type ClientConfig,
+  type Transport,
+} from 'viem'
+import { addEnsContracts } from '../contracts/addEnsContracts.js'
+import type { ChainWithEns } from '../contracts/consts.js'
+import type { Prettify } from '../types.js'
+import { ensPublicActions, type EnsPublicActions } from './decorators/public.js'
+import {
+  ensSubgraphActions,
+  type EnsSubgraphActions,
+} from './decorators/subgraph.js'
+
+export type EnsPublicClientConfig<
+  TTransport extends Transport = Transport,
+  TChain extends Chain = Chain,
+> = Pick<
+  ClientConfig<TTransport, TChain>,
+  'batch' | 'key' | 'name' | 'pollingInterval' | 'transport'
+> & {
+  chain: Exclude<ClientConfig<TTransport, TChain>['chain'], undefined>
+}
+
+export type EnsPublicClient<
+  TTransport extends Transport = Transport,
+  TChain extends ChainWithEns = ChainWithEns,
+> = Prettify<
+  Client<
+    TTransport,
+    TChain,
+    undefined,
+    undefined,
+    EnsPublicActions & EnsSubgraphActions
+  >
+>
+
+/**
+ * Creates a ENS Public Client with a given [Transport](https://viem.sh/docs/clients/intro.html) configured for a [Chain](https://viem.sh/docs/clients/chains.html).
+ *
+ * @param config - {@link EnsPublicClientConfig}
+ * @returns An ENS Public Client. {@link EnsPublicClient}
+ *
+ * @example
+ * import { http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { createEnsPublicClient } from '@ensdomains/ensjs'
+ *
+ * const client = createEnsPublicClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ */
+export const createEnsPublicClient = <
+  TTransport extends Transport,
+  TChain extends Chain,
+>({
+  batch,
+  chain,
+  key = 'ensPublic',
+  name = 'ENS Public Client',
+  transport,
+  pollingInterval,
+}: EnsPublicClientConfig<TTransport, TChain>): EnsPublicClient<
+  TTransport,
+  ChainWithEns<TChain>
+> => {
+  return createClient({
+    batch,
+    chain: addEnsContracts(chain),
+    key,
+    name,
+    pollingInterval,
+    transport,
+    type: 'ensPublicClient',
+  })
+    .extend(ensPublicActions)
+    .extend(ensSubgraphActions)
+}

package/src/clients/subgraph.ts

@@ -0,0 +1,72 @@
+import {
+  createClient,
+  type Chain,
+  type Client,
+  type ClientConfig,
+  type Transport,
+} from 'viem'
+import { addEnsContracts } from '../contracts/addEnsContracts.js'
+import type { ChainWithEns } from '../contracts/consts.js'
+import type { Prettify } from '../types.js'
+import {
+  ensSubgraphActions,
+  type EnsSubgraphActions,
+} from './decorators/subgraph.js'
+
+export type EnsSubgraphClientConfig<
+  TTransport extends Transport = Transport,
+  TChain extends Chain = Chain,
+> = Pick<
+  ClientConfig<TTransport, TChain>,
+  'batch' | 'key' | 'name' | 'pollingInterval' | 'transport'
+> & {
+  chain: Exclude<ClientConfig<TTransport, TChain>['chain'], undefined>
+}
+
+export type EnsSubgraphClient<
+  TTransport extends Transport = Transport,
+  TChain extends ChainWithEns = ChainWithEns,
+> = Prettify<
+  Client<TTransport, TChain, undefined, undefined, EnsSubgraphActions>
+>
+
+/**
+ * Creates a ENS Subgraph Client with a given [Transport](https://viem.sh/docs/clients/intro.html) configured for a [Chain](https://viem.sh/docs/clients/chains.html).
+ *
+ * @param config - {@link EnsSubgraphClientConfig}
+ * @returns An ENS Subgraph Client. {@link EnsSubgraphClient}
+ *
+ * @example
+ * import { http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { createEnsSubgraphClient } from '@ensdomains/ensjs'
+ *
+ * const client = createEnsSubgraphClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ */
+export const createEnsSubgraphClient = <
+  TTransport extends Transport,
+  TChain extends Chain,
+>({
+  batch,
+  chain,
+  key = 'ensSubgraph',
+  name = 'ENS Subgraph Client',
+  transport,
+  pollingInterval,
+}: EnsSubgraphClientConfig<TTransport, TChain>): EnsSubgraphClient<
+  TTransport,
+  ChainWithEns<TChain>
+> => {
+  return createClient({
+    batch,
+    chain: addEnsContracts(chain),
+    key,
+    name,
+    pollingInterval,
+    transport,
+    type: 'ensSubgraphClient',
+  }).extend(ensSubgraphActions)
+}

package/src/clients/wallet.ts

@@ -0,0 +1,90 @@
+import {
+  createWalletClient,
+  type Account,
+  type Address,
+  type Chain,
+  type Client,
+  type ClientConfig,
+  type ParseAccount,
+  type Transport,
+  type WalletActions,
+  type WalletRpcSchema,
+} from 'viem'
+import { addEnsContracts } from '../contracts/addEnsContracts.js'
+import type { ChainWithEns } from '../contracts/consts.js'
+import type { Prettify } from '../types.js'
+import { ensWalletActions, type EnsWalletActions } from './decorators/wallet.js'
+
+export type EnsWalletClientConfig<
+  TTransport extends Transport,
+  TChain extends Chain,
+  TAccountOrAddress extends Account | Address | undefined =
+    | Account
+    | Address
+    | undefined,
+> = Pick<
+  ClientConfig<TTransport, TChain, TAccountOrAddress>,
+  'account' | 'chain' | 'key' | 'name' | 'pollingInterval' | 'transport'
+> & {
+  chain: Exclude<ClientConfig<TTransport, TChain>['chain'], undefined>
+}
+
+export type EnsWalletClient<
+  TTransport extends Transport = Transport,
+  TChain extends ChainWithEns = ChainWithEns,
+  TAccount extends Account | undefined = Account | undefined,
+> = Prettify<
+  Client<
+    TTransport,
+    TChain,
+    TAccount,
+    WalletRpcSchema,
+    WalletActions<TChain, TAccount> & EnsWalletActions<TChain, TAccount>
+  >
+>
+
+/**
+ * Creates an ENS Wallet Client with a given [Transport](https://viem.sh/docs/clients/intro.html) configured for a [Chain](https://viem.sh/docs/clients/chains.html).
+ *
+ * @param config - {@link EnsWalletClientConfig}
+ * @returns An ENS Wallet Client. {@link EnsWalletClient}
+ *
+ * @example
+ * import { custom } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { createEnsWalletClient } from '@ensdomains/ensjs'
+ *
+ * const client = createEnsWalletClient({
+ *   chain: mainnet,
+ *   transport: custom(window.ethereum),
+ * })
+ */
+export const createEnsWalletClient = <
+  TTransport extends Transport,
+  TChain extends Chain,
+  TAccountOrAddress extends Account | Address | undefined = undefined,
+>({
+  account,
+  chain,
+  key = 'ensWallet',
+  name = 'ENS Wallet Client',
+  transport,
+  pollingInterval,
+}: EnsWalletClientConfig<
+  TTransport,
+  TChain,
+  TAccountOrAddress
+>): EnsWalletClient<
+  TTransport,
+  ChainWithEns<TChain>,
+  ParseAccount<TAccountOrAddress>
+> => {
+  return createWalletClient({
+    account,
+    chain: addEnsContracts<TChain>(chain),
+    key,
+    name,
+    pollingInterval,
+    transport,
+  }).extend(ensWalletActions)
+}

package/src/contracts/addEnsContracts.ts

@@ -0,0 +1,42 @@
+import type { Chain } from 'viem'
+import { NoChainError, UnsupportedNetworkError } from '../errors/contracts.js'
+import {
+  addresses,
+  subgraphs,
+  supportedChains,
+  type ChainWithEns,
+  type SupportedChain,
+} from './consts.js'
+
+/**
+ * Adds ENS contract addresses to the viem chain
+ * @param chain - The viem {@link Chain} object to add the ENS contracts to
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ *
+ * const clientWithEns = createPublicClient({
+ *   chain: addEnsContracts(mainnet),
+ *   transport: http(),
+ * })
+ */
+export const addEnsContracts = <TChain extends Chain>(chain: TChain) => {
+  if (!chain) throw new NoChainError()
+  if (!supportedChains.includes(chain.network as SupportedChain))
+    throw new UnsupportedNetworkError({
+      network: chain.network,
+      supportedNetworks: supportedChains,
+    })
+  return {
+    ...chain,
+    contracts: {
+      ...chain.contracts,
+      ...addresses[chain.network as SupportedChain],
+    },
+    subgraphs: {
+      ...subgraphs[chain.network as SupportedChain],
+    },
+  } as ChainWithEns<TChain>
+}

package/src/contracts/baseRegistrar.ts

@@ -1,5 +1,89 @@
-import { ethers } from 'ethers'
-import { BaseRegistrarImplementation__factory } from '../generated/factories/BaseRegistrarImplementation__factory'
+import {
+  erc721OwnerOfSnippet,
+  erc721SafeTransferFromSnippet,
+  erc721SafeTransferFromWithDataSnippet,
+} from './erc721.js'
 
-export default (provider: ethers.providers.JsonRpcProvider, address: string) =>
-  BaseRegistrarImplementation__factory.connect(address, provider)
+export const baseRegistrarAvailableSnippet = [
+  {
+    inputs: [
+      {
+        name: 'id',
+        type: 'uint256',
+      },
+    ],
+    name: 'available',
+    outputs: [
+      {
+        name: 'available',
+        type: 'bool',
+      },
+    ],
+    stateMutability: 'view',
+    type: 'function',
+  },
+] as const
+
+export const baseRegistrarNameExpiresSnippet = [
+  {
+    inputs: [
+      {
+        name: 'id',
+        type: 'uint256',
+      },
+    ],
+    name: 'nameExpires',
+    outputs: [
+      {
+        name: '',
+        type: 'uint256',
+      },
+    ],
+    stateMutability: 'view',
+    type: 'function',
+  },
+] as const
+
+export const baseRegistrarGracePeriodSnippet = [
+  {
+    inputs: [],
+    name: 'GRACE_PERIOD',
+    outputs: [
+      {
+        name: '',
+        type: 'uint256',
+      },
+    ],
+    stateMutability: 'view',
+    type: 'function',
+  },
+] as const
+
+export const baseRegistrarReclaimSnippet = [
+  {
+    inputs: [
+      {
+        name: 'id',
+        type: 'uint256',
+      },
+      {
+        name: 'owner',
+        type: 'address',
+      },
+    ],
+    name: 'reclaim',
+    outputs: [],
+    stateMutability: 'nonpayable',
+    type: 'function',
+  },
+] as const
+
+export const baseRegistrarSafeTransferFromSnippet = [
+  ...erc721SafeTransferFromSnippet,
+] as const
+
+export const baseRegistrarSafeTransferFromWithDataSnippet = [
+  ...erc721SafeTransferFromWithDataSnippet,
+] as const
+
+export const baseRegistrarOwnerOfSnippet = [...erc721OwnerOfSnippet] as const

package/src/contracts/bulkRenewal.ts

@@ -0,0 +1,42 @@
+export const bulkRenewalRentPriceSnippet = [
+  {
+    inputs: [
+      {
+        name: 'names',
+        type: 'string[]',
+      },
+      {
+        name: 'duration',
+        type: 'uint256',
+      },
+    ],
+    name: 'rentPrice',
+    outputs: [
+      {
+        name: 'total',
+        type: 'uint256',
+      },
+    ],
+    stateMutability: 'view',
+    type: 'function',
+  },
+] as const
+
+export const bulkRenewalRenewAllSnippet = [
+  {
+    inputs: [
+      {
+        name: 'names',
+        type: 'string[]',
+      },
+      {
+        name: 'duration',
+        type: 'uint256',
+      },
+    ],
+    name: 'renewAll',
+    outputs: [],
+    stateMutability: 'payable',
+    type: 'function',
+  },
+] as const

package/src/contracts/consts.ts

@@ -0,0 +1,158 @@
+import type {
+  Account,
+  Address,
+  Chain,
+  Client,
+  Transport,
+  WalletClient,
+} from 'viem'
+
+type ChainContract = {
+  address: Address
+  blockCreated?: number
+}
+
+export const supportedChains = ['homestead', 'goerli'] as const
+export const supportedContracts = [
+  'ensBaseRegistrarImplementation',
+  'ensDnsRegistrar',
+  'ensEthRegistrarController',
+  'ensNameWrapper',
+  'ensPublicResolver',
+  'ensReverseRegistrar',
+  'ensBulkRenewal',
+  'ensDnssecImpl',
+] as const
+
+export type SupportedChain = (typeof supportedChains)[number]
+export type SupportedContract = (typeof supportedContracts)[number]
+
+export const addresses = {
+  homestead: {
+    ensBaseRegistrarImplementation: {
+      address: '0x57f1887a8bf19b14fc0df6fd9b2acc9af147ea85',
+    },
+    ensDnsRegistrar: {
+      address: '0x58774Bb8acD458A640aF0B88238369A167546ef2',
+    },
+    ensEthRegistrarController: {
+      address: '0x253553366Da8546fC250F225fe3d25d0C782303b',
+    },
+    ensNameWrapper: {
+      address: '0xD4416b13d2b3a9aBae7AcD5D6C2BbDBE25686401',
+    },
+    ensPublicResolver: {
+      address: '0x231b0Ee14048e9dCcD1d247744d114a4EB5E8E63',
+    },
+    ensReverseRegistrar: {
+      address: '0xa58E81fe9b61B5c3fE2AFD33CF304c454AbFc7Cb',
+    },
+    ensBulkRenewal: {
+      address: '0xa12159e5131b1eEf6B4857EEE3e1954744b5033A',
+    },
+    ensDnssecImpl: {
+      address: '0x21745FF62108968fBf5aB1E07961CC0FCBeB2364',
+    },
+    ensUniversalResolver: {
+      address: '0x9380F1974D2B7064eA0c0EC251968D8c69f0Ae31',
+    },
+  },
+  goerli: {
+    ensBaseRegistrarImplementation: {
+      address: '0x57f1887a8bf19b14fc0df6fd9b2acc9af147ea85',
+    },
+    ensDnsRegistrar: {
+      address: '0x8edc487D26F6c8Fa76e032066A3D4F87E273515d',
+    },
+    ensEthRegistrarController: {
+      address: '0xCc5e7dB10E65EED1BBD105359e7268aa660f6734',
+    },
+    ensNameWrapper: {
+      address: '0x114D4603199df73e7D157787f8778E21fCd13066',
+    },
+    ensPublicResolver: {
+      address: '0xd7a4F6473f32aC2Af804B3686AE8F19E48B8fF5f',
+    },
+    ensReverseRegistrar: {
+      address: '0x6d9F26FfBcF1c6f0bAe9F2C1f7fBe8eE6B1d8d4d',
+    },
+    ensBulkRenewal: {
+      address: '0x6d9F26FfBcF1c6f0bAe9F2C1f7fBe8eE6B1d8d4d',
+    },
+    ensDnssecImpl: {
+      address: '0xF427c4AdED8B6dfde604865c1a7E953B160C26f0',
+    },
+    ensUniversalResolver: {
+      address: '0x3952Be0b2186f8B113193a84b69bD71ad3fc1ae3',
+    },
+  },
+} as const
+
+// add when this is resolved: https://github.com/kulshekhar/ts-jest/issues/4100
+// } as const satisfies Record<
+//   SupportedChain,
+//   Record<SupportedContract, { address: Address }>
+// >
+
+type Subgraphs = {
+  ens: {
+    url: string
+  }
+}
+
+export const subgraphs = {
+  homestead: {
+    ens: {
+      url: 'https://api.thegraph.com/subgraphs/name/ensdomains/ens',
+    },
+  },
+  goerli: {
+    ens: {
+      url: 'https://api.thegraph.com/subgraphs/name/ensdomains/ensgoerli',
+    },
+  },
+} as const
+
+// add when this is resolved: https://github.com/kulshekhar/ts-jest/issues/4100
+// } as const satisfies Record<SupportedChain, Subgraphs>
+
+type EnsChainContracts = {
+  ensBaseRegistrarImplementation: ChainContract
+  ensDnsRegistrar: ChainContract
+  ensEthRegistrarController: ChainContract
+  ensNameWrapper: ChainContract
+  ensPublicResolver: ChainContract
+  ensReverseRegistrar: ChainContract
+  ensBulkRenewal: ChainContract
+  ensDnssecImpl: ChainContract
+}
+
+type BaseChainContracts = {
+  multicall3: ChainContract
+  ensUniversalResolver: ChainContract
+  ensRegistry: ChainContract
+}
+
+export type ChainWithEns<TChain extends Chain = Chain> = TChain & {
+  contracts: BaseChainContracts & EnsChainContracts
+  subgraphs: Subgraphs
+}
+
+export type CheckedChainWithEns<TChain extends Chain> =
+  TChain['network'] extends SupportedChain
+    ? TChain & {
+        contracts: (typeof addresses)[TChain['network']]
+        subgraphs: (typeof subgraphs)[TChain['network']]
+      }
+    : never
+
+export type ClientWithEns<
+  TTransport extends Transport = Transport,
+  TChain extends ChainWithEns = ChainWithEns,
+> = Client<TTransport, TChain>
+
+export type WalletWithEns<
+  TTransport extends Transport = Transport,
+  TChain extends ChainWithEns = ChainWithEns,
+  TAccount extends Account | undefined = Account | undefined,
+> = WalletClient<TTransport, TChain, TAccount>

package/src/contracts/dnsRegistrar.ts

@@ -0,0 +1,73 @@
+export const dnsRegistrarProveAndClaimSnippet = [
+  {
+    inputs: [
+      {
+        name: 'name',
+        type: 'bytes',
+      },
+      {
+        components: [
+          {
+            name: 'rrset',
+            type: 'bytes',
+          },
+          {
+            name: 'sig',
+            type: 'bytes',
+          },
+        ],
+        name: 'input',
+        type: 'tuple[]',
+      },
+      {
+        name: 'proof',
+        type: 'bytes',
+      },
+    ],
+    name: 'proveAndClaim',
+    outputs: [],
+    stateMutability: 'nonpayable',
+    type: 'function',
+  },
+] as const
+
+export const dnsRegistrarProveAndClaimWithResolverSnippet = [
+  {
+    inputs: [
+      {
+        name: 'name',
+        type: 'bytes',
+      },
+      {
+        components: [
+          {
+            name: 'rrset',
+            type: 'bytes',
+          },
+          {
+            name: 'sig',
+            type: 'bytes',
+          },
+        ],
+        name: 'input',
+        type: 'tuple[]',
+      },
+      {
+        name: 'proof',
+        type: 'bytes',
+      },
+      {
+        name: 'resolver',
+        type: 'address',
+      },
+      {
+        name: 'addr',
+        type: 'address',
+      },
+    ],
+    name: 'proveAndClaimWithResolver',
+    outputs: [],
+    stateMutability: 'nonpayable',
+    type: 'function',
+  },
+] as const

package/src/contracts/dnssecImpl.ts

@@ -0,0 +1,46 @@
+export const dnssecImplRrDataSnippet = [
+  {
+    inputs: [
+      {
+        name: 'dnstype',
+        type: 'uint16',
+      },
+      {
+        name: 'name',
+        type: 'bytes',
+      },
+    ],
+    name: 'rrdata',
+    outputs: [
+      {
+        name: '',
+        type: 'uint32',
+      },
+      {
+        name: '',
+        type: 'uint32',
+      },
+      {
+        name: '',
+        type: 'bytes20',
+      },
+    ],
+    stateMutability: 'view',
+    type: 'function',
+  },
+] as const
+
+export const dnssecImplAnchorsSnippet = [
+  {
+    inputs: [],
+    name: 'anchors',
+    outputs: [
+      {
+        name: '',
+        type: 'bytes',
+      },
+    ],
+    stateMutability: 'view',
+    type: 'function',
+  },
+] as const