@ensdomains/ensjs 4.1.2 → 5.0.0-alpha.1

package/src/clients/public.ts

@@ -1,84 +0,0 @@
-import {
-  type Client,
-  type ClientConfig,
-  type PublicRpcSchema,
-  type Transport,
-  createClient,
-} from 'viem'
-import { addEnsContracts } from '../contracts/addEnsContracts.js'
-import type {
-  ChainWithBaseContracts,
-  ChainWithEns,
-} from '../contracts/consts.js'
-import type { Prettify } from '../types.js'
-import { type EnsPublicActions, ensPublicActions } from './decorators/public.js'
-import {
-  type EnsSubgraphActions,
-  ensSubgraphActions,
-} from './decorators/subgraph.js'
-
-export type EnsPublicClientConfig<
-  TTransport extends Transport = Transport,
-  TChain extends ChainWithBaseContracts = ChainWithBaseContracts,
-> = Pick<
-  ClientConfig<TTransport, TChain>,
-  'batch' | 'key' | 'name' | 'pollingInterval' | 'transport'
-> & {
-  chain: TChain
-}
-
-export type EnsPublicClient<
-  TTransport extends Transport = Transport,
-  TChain extends ChainWithEns = ChainWithEns,
-> = Prettify<
-  Client<
-    TTransport,
-    TChain,
-    undefined,
-    PublicRpcSchema,
-    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 ChainWithBaseContracts,
->({
-  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

@@ -1,75 +0,0 @@
-import {
-  type Client,
-  type ClientConfig,
-  type PublicRpcSchema,
-  type Transport,
-  createClient,
-} from 'viem'
-import { addEnsContracts } from '../contracts/addEnsContracts.js'
-import type {
-  ChainWithBaseContracts,
-  ChainWithEns,
-} from '../contracts/consts.js'
-import type { Prettify } from '../types.js'
-import {
-  type EnsSubgraphActions,
-  ensSubgraphActions,
-} from './decorators/subgraph.js'
-
-export type EnsSubgraphClientConfig<
-  TTransport extends Transport = Transport,
-  TChain extends ChainWithBaseContracts = ChainWithBaseContracts,
-> = Pick<
-  ClientConfig<TTransport, TChain>,
-  'batch' | 'key' | 'name' | 'pollingInterval' | 'transport'
-> & {
-  chain: TChain
-}
-
-export type EnsSubgraphClient<
-  TTransport extends Transport = Transport,
-  TChain extends ChainWithEns = ChainWithEns,
-> = Prettify<
-  Client<TTransport, TChain, undefined, PublicRpcSchema, 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 ChainWithBaseContracts,
->({
-  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

@@ -1,96 +0,0 @@
-import {
-  type Account,
-  type Address,
-  type Client,
-  type ClientConfig,
-  type ParseAccount,
-  type Transport,
-  type WalletActions,
-  type WalletRpcSchema,
-  createWalletClient,
-} from 'viem'
-import { addEnsContracts } from '../contracts/addEnsContracts.js'
-import type {
-  ChainWithBaseContracts,
-  ChainWithEns,
-  CheckedChainWithEns,
-} from '../contracts/consts.js'
-import type { Assign, Prettify } from '../types.js'
-import { type EnsWalletActions, ensWalletActions } from './decorators/wallet.js'
-
-export type EnsWalletClientConfig<
-  TTransport extends Transport,
-  TChain extends ChainWithBaseContracts,
-  TAccountOrAddress extends Account | Address | undefined =
-    | Account
-    | Address
-    | undefined,
-> = Assign<
-  Pick<
-    ClientConfig<TTransport, TChain, TAccountOrAddress>,
-    'account' | 'chain' | 'key' | 'name' | 'pollingInterval' | 'transport'
-  >,
-  {
-    chain: TChain
-  }
->
-
-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 ChainWithBaseContracts,
-  TAccountOrAddress extends Account | Address | undefined = undefined,
->({
-  account,
-  chain,
-  key = 'ensWallet',
-  name = 'ENS Wallet Client',
-  transport,
-  pollingInterval,
-}: EnsWalletClientConfig<
-  TTransport,
-  TChain,
-  TAccountOrAddress
->): EnsWalletClient<
-  TTransport,
-  CheckedChainWithEns<TChain>,
-  ParseAccount<TAccountOrAddress>
-> => {
-  return createWalletClient({
-    account,
-    chain: addEnsContracts(chain),
-    key,
-    name,
-    pollingInterval,
-    transport,
-  }).extend(ensWalletActions)
-}

package/src/contracts/consts.ts

@@ -1,236 +0,0 @@
-import type { Account, Address, Chain, Client, Transport } from 'viem'
-import { holesky, mainnet, sepolia } from 'viem/chains'
-import type { Assign, Prettify } from '../types.js'
-
-type ChainContract = {
-  address: Address
-  blockCreated?: number
-}
-
-export const supportedChains = [mainnet.id, sepolia.id, holesky.id] as const
-export const supportedContracts = [
-  'ensBaseRegistrarImplementation',
-  'ensBulkRenewal',
-  'ensDnsRegistrar',
-  'ensDnssecImpl',
-  'ensEthRegistrarController',
-  'ensNameWrapper',
-  'ensPublicResolver',
-  'ensRegistry',
-  'ensReverseRegistrar',
-  'ensUniversalResolver',
-  'legacyEthRegistrarController',
-  'legacyPublicResolver',
-  'ensDefaultReverseRegistrar',
-] as const
-
-export type SupportedChain = (typeof supportedChains)[number]
-export type SupportedContract = (typeof supportedContracts)[number]
-
-export const addresses = {
-  [mainnet.id]: {
-    ensBaseRegistrarImplementation: {
-      address: '0x57f1887a8BF19b14fC0dF6Fd9B2acc9Af147eA85',
-    },
-    ensBulkRenewal: {
-      address: '0xa12159e5131b1eEf6B4857EEE3e1954744b5033A',
-    },
-    ensDnsRegistrar: {
-      address: '0xB32cB5677a7C971689228EC835800432B339bA2B',
-    },
-    ensDnssecImpl: {
-      address: '0x0fc3152971714E5ed7723FAFa650F86A4BaF30C5',
-    },
-    ensEthRegistrarController: {
-      address: '0x253553366Da8546fC250F225fe3d25d0C782303b',
-    },
-    ensNameWrapper: {
-      address: '0xD4416b13d2b3a9aBae7AcD5D6C2BbDBE25686401',
-    },
-    ensPublicResolver: {
-      address: '0x231b0Ee14048e9dCcD1d247744d114a4EB5E8E63',
-    },
-    ensRegistry: {
-      address: '0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e',
-    },
-    ensReverseRegistrar: {
-      address: '0xa58E81fe9b61B5c3fE2AFD33CF304c454AbFc7Cb',
-    },
-    ensUniversalResolver: {
-      address: '0xaBd80E8a13596fEeA40Fd26fD6a24c3fe76F05fB',
-    },
-    legacyEthRegistrarController: {
-      address: '0x283Af0B28c62C092C9727F1Ee09c02CA627EB7F5',
-    },
-    legacyPublicResolver: {
-      address: '0x4976fb03C32e5B8cfe2b6cCB31c09Ba78EBaBa41',
-    },
-    ensDefaultReverseRegistrar: {
-      address: '0x283F227c4Bd38ecE252C4Ae7ECE650B0e913f1f9',
-    },
-  },
-  [holesky.id]: {
-    ensBaseRegistrarImplementation: {
-      address: '0x57f1887a8BF19b14fC0dF6Fd9B2acc9Af147eA85',
-    },
-    ensBulkRenewal: {
-      address: '0xbc4cfB363F948E64Cd73Da6438F64CB37E2e33d1',
-    },
-    ensDnsRegistrar: {
-      address: '0x458d278AEd4cE82BAeC384170f39198b01B8351c',
-    },
-    ensDnssecImpl: {
-      address: '0x283af0b28c62c092c9727f1ee09c02ca627eb7f5',
-    },
-    ensEthRegistrarController: {
-      address: '0xF404D2F84BC1735f7D9948F032D61F5fFfD9D3C3',
-    },
-    ensNameWrapper: {
-      address: '0xab50971078225D365994dc1Edcb9b7FD72Bb4862',
-    },
-    ensPublicResolver: {
-      address: '0x5a692ffe769A9B3D0e61F7446F5cAED650044C36',
-    },
-    ensRegistry: {
-      address: '0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e',
-    },
-    ensReverseRegistrar: {
-      address: '0x65EE0b0B030a76c95a7ff046C0e0c8f7A2d1B004',
-    },
-    ensUniversalResolver: {
-      address: '0xf606bc986635dab91b189aee8f565f45a0336f89',
-    },
-    legacyEthRegistrarController: {
-      address: '0xf13fC748601fDc5afA255e9D9166EB43f603a903',
-    },
-    legacyPublicResolver: {
-      address: '0xc5e43b622b5e6C379a984E9BdB34E9A545564fA5',
-    },
-    ensDefaultReverseRegistrar: {
-      address: '0x0000000000000000000000000000000000000000',
-    },
-  },
-  [sepolia.id]: {
-    ensBaseRegistrarImplementation: {
-      address: '0x57f1887a8BF19b14fC0dF6Fd9B2acc9Af147eA85',
-    },
-    ensBulkRenewal: {
-      address: '0x4EF77b90762Eddb33C8Eba5B5a19558DaE53D7a1',
-    },
-    ensDnsRegistrar: {
-      address: '0x5a07C75Ae469Bf3ee2657B588e8E6ABAC6741b4f',
-    },
-    ensDnssecImpl: {
-      address: '0xe62E4b6cE018Ad6e916fcC24545e20a33b9d8653',
-    },
-    ensEthRegistrarController: {
-      address: '0x4477cAc137F3353Ca35060E01E5aEb777a1Ca01B',
-    },
-    ensNameWrapper: {
-      address: '0x0635513f179D50A207757E05759CbD106d7dFcE8',
-    },
-    ensPublicResolver: {
-      address: '0x8948458626811dd0c23EB25Cc74291247077cC51',
-    },
-    ensRegistry: {
-      address: '0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e',
-    },
-    ensReverseRegistrar: {
-      address: '0xA0a1AbcDAe1a2a4A2EF8e9113Ff0e02DD81DC0C6',
-    },
-    ensUniversalResolver: {
-      address: '0xb7B7DAdF4D42a08B3eC1d3A1079959Dfbc8CFfCC',
-    },
-    legacyEthRegistrarController: {
-      address: '0x7e02892cfc2Bfd53a75275451d73cF620e793fc0',
-    },
-    legacyPublicResolver: {
-      address: '0x0CeEC524b2807841739D3B5E161F5bf1430FFA48',
-    },
-    ensDefaultReverseRegistrar: {
-      address: '0x4F382928805ba0e23B30cFB75fC9E848e82DFD47',
-    },
-  },
-} as const satisfies Record<
-  SupportedChain,
-  Record<SupportedContract, { address: Address }>
->
-
-type Subgraphs = {
-  ens: {
-    url: string
-  }
-}
-
-export const subgraphs = {
-  1: {
-    ens: {
-      url: 'https://api.thegraph.com/subgraphs/name/ensdomains/ens',
-    },
-  },
-  17000: {
-    ens: {
-      url: 'https://api.studio.thegraph.com/query/49574/ensholesky/version/latest',
-    },
-  },
-  11155111: {
-    ens: {
-      url: 'https://api.studio.thegraph.com/query/49574/enssepolia/version/latest',
-    },
-  },
-} as const satisfies Record<SupportedChain, Subgraphs>
-
-type EnsChainContracts = {
-  ensBaseRegistrarImplementation: ChainContract
-  ensDnsRegistrar: ChainContract
-  ensEthRegistrarController: ChainContract
-  ensNameWrapper: ChainContract
-  ensPublicResolver: ChainContract
-  ensRegistry: ChainContract
-  ensReverseRegistrar: ChainContract
-  ensBulkRenewal: ChainContract
-  ensDnssecImpl: ChainContract
-  legacyEthRegistrarController: ChainContract
-  legacyPublicResolver: ChainContract
-}
-
-type BaseChainContracts = {
-  multicall3: ChainContract
-  ensUniversalResolver: ChainContract
-}
-
-export type ChainWithEns<TChain extends Chain = Chain> = Omit<
-  TChain,
-  'contracts'
-> & {
-  contracts: BaseChainContracts & EnsChainContracts
-  subgraphs: Subgraphs
-}
-
-export type ChainWithBaseContracts = Assign<
-  Omit<Chain, 'contracts'>,
-  {
-    contracts: BaseChainContracts
-  }
->
-
-export type CheckedChainWithEns<TChain extends Chain> =
-  TChain['id'] extends SupportedChain
-    ? TChain['contracts'] extends BaseChainContracts
-      ? TChain & {
-          contracts: Prettify<(typeof addresses)[TChain['id']]>
-          subgraphs: (typeof subgraphs)[TChain['id']]
-        }
-      : never
-    : never
-
-export type ClientWithEns<
-  TTransport extends Transport = Transport,
-  TChain extends ChainWithEns = ChainWithEns,
-> = Client<TTransport, TChain>
-
-export type ClientWithAccount<
-  TTransport extends Transport = Transport,
-  TChain extends ChainWithEns = ChainWithEns,
-  TAccount extends Account | undefined = Account | undefined,
-> = Client<TTransport, TChain, TAccount>

package/src/contracts/legacyEthRegistrarController.ts

@@ -1,194 +0,0 @@
-export const legacyEthRegistrarControllerAvailableSnippet = [
-  {
-    constant: true,
-    inputs: [{ internalType: 'string', name: 'name', type: 'string' }],
-    name: 'available',
-    outputs: [{ internalType: 'bool', name: '', type: 'bool' }],
-    payable: false,
-    stateMutability: 'view',
-    type: 'function',
-  },
-] as const
-
-export const legacyEthRegistrarControllerCommitSnippet = [
-  {
-    constant: false,
-    inputs: [{ internalType: 'bytes32', name: 'commitment', type: 'bytes32' }],
-    name: 'commit',
-    outputs: [],
-    payable: false,
-    stateMutability: 'nonpayable',
-    type: 'function',
-  },
-] as const
-
-export const legacyEthRegistrarControllerCommitmentsSnippet = [
-  {
-    constant: true,
-    inputs: [{ internalType: 'bytes32', name: '', type: 'bytes32' }],
-    name: 'commitments',
-    outputs: [{ internalType: 'uint256', name: '', type: 'uint256' }],
-    payable: false,
-    stateMutability: 'view',
-    type: 'function',
-  },
-] as const
-
-export const legacyEthRegistrarControllerMakeCommitmentSnippet = [
-  {
-    constant: true,
-    inputs: [
-      { internalType: 'string', name: 'name', type: 'string' },
-      { internalType: 'address', name: 'owner', type: 'address' },
-      { internalType: 'bytes32', name: 'secret', type: 'bytes32' },
-    ],
-    name: 'makeCommitment',
-    outputs: [{ internalType: 'bytes32', name: '', type: 'bytes32' }],
-    payable: false,
-    stateMutability: 'pure',
-    type: 'function',
-  },
-] as const
-
-export const legacyEthRegistrarControllerMakeCommitmentWithConfigSnippet = [
-  {
-    constant: true,
-    inputs: [
-      { internalType: 'string', name: 'name', type: 'string' },
-      { internalType: 'address', name: 'owner', type: 'address' },
-      { internalType: 'bytes32', name: 'secret', type: 'bytes32' },
-      { internalType: 'address', name: 'resolver', type: 'address' },
-      { internalType: 'address', name: 'addr', type: 'address' },
-    ],
-    name: 'makeCommitmentWithConfig',
-    outputs: [{ internalType: 'bytes32', name: '', type: 'bytes32' }],
-    payable: false,
-    stateMutability: 'pure',
-    type: 'function',
-  },
-] as const
-
-export const legacyEthRegistrarControllerRegisterSnippet = [
-  {
-    constant: false,
-    inputs: [
-      { internalType: 'string', name: 'name', type: 'string' },
-      { internalType: 'address', name: 'owner', type: 'address' },
-      { internalType: 'uint256', name: 'duration', type: 'uint256' },
-      { internalType: 'bytes32', name: 'secret', type: 'bytes32' },
-    ],
-    name: 'register',
-    outputs: [],
-    payable: true,
-    stateMutability: 'payable',
-    type: 'function',
-  },
-] as const
-
-export const legacyEthRegistrarControllerRegisterWithConfigSnippet = [
-  {
-    constant: false,
-    inputs: [
-      { internalType: 'string', name: 'name', type: 'string' },
-      { internalType: 'address', name: 'owner', type: 'address' },
-      { internalType: 'uint256', name: 'duration', type: 'uint256' },
-      { internalType: 'bytes32', name: 'secret', type: 'bytes32' },
-      { internalType: 'address', name: 'resolver', type: 'address' },
-      { internalType: 'address', name: 'addr', type: 'address' },
-    ],
-    name: 'registerWithConfig',
-    outputs: [],
-    payable: true,
-    stateMutability: 'payable',
-    type: 'function',
-  },
-] as const
-
-export const legacyEthRegistrarControllerRenewSnippet = [
-  {
-    constant: false,
-    inputs: [
-      { internalType: 'string', name: 'name', type: 'string' },
-      { internalType: 'uint256', name: 'duration', type: 'uint256' },
-    ],
-    name: 'renew',
-    outputs: [],
-    payable: true,
-    stateMutability: 'payable',
-    type: 'function',
-  },
-] as const
-
-export const legacyEthRegistrarControllerRentPriceSnippet = [
-  {
-    constant: true,
-    inputs: [
-      { internalType: 'string', name: 'name', type: 'string' },
-      { internalType: 'uint256', name: 'duration', type: 'uint256' },
-    ],
-    name: 'rentPrice',
-    outputs: [{ internalType: 'uint256', name: '', type: 'uint256' }],
-    payable: false,
-    stateMutability: 'view',
-    type: 'function',
-  },
-] as const
-
-export const legacyEthRegistrarControllerSupportsInterfaceSnippet = [
-  {
-    constant: true,
-    inputs: [{ internalType: 'bytes4', name: 'interfaceID', type: 'bytes4' }],
-    name: 'supportsInterface',
-    outputs: [{ internalType: 'bool', name: '', type: 'bool' }],
-    payable: false,
-    stateMutability: 'pure',
-    type: 'function',
-  },
-] as const
-
-export const legacyEthRegistrarControllerTransferOwnershipSnippet = [
-  {
-    constant: false,
-    inputs: [{ internalType: 'address', name: 'newOwner', type: 'address' }],
-    name: 'transferOwnership',
-    outputs: [],
-    payable: false,
-    stateMutability: 'nonpayable',
-    type: 'function',
-  },
-] as const
-
-export const legacyEthRegistrarControllerNameRegisteredEventSnippet = [
-  {
-    anonymous: false,
-    inputs: [
-      { indexed: false, internalType: 'string', name: 'name', type: 'string' },
-      {
-        indexed: true,
-        internalType: 'bytes32',
-        name: 'label',
-        type: 'bytes32',
-      },
-      {
-        indexed: true,
-        internalType: 'address',
-        name: 'owner',
-        type: 'address',
-      },
-      {
-        indexed: false,
-        internalType: 'uint256',
-        name: 'cost',
-        type: 'uint256',
-      },
-      {
-        indexed: false,
-        internalType: 'uint256',
-        name: 'expires',
-        type: 'uint256',
-      },
-    ],
-    name: 'NameRegistered',
-    type: 'event',
-  },
-] as const

package/src/errors/register.ts

@@ -1,22 +0,0 @@
-import type { Address } from 'viem'
-import { EMPTY_ADDRESS } from '../utils/consts.js'
-import { BaseError } from './base.js'
-
-export class LegacyRegistrationInvalidConfigError extends BaseError {
-  override name = 'LegacyRegistrationInvalidConfigError'
-
-  constructor({
-    resolverAddress,
-    address,
-  }: {
-    resolverAddress?: Address
-    address?: Address
-  }) {
-    super('Resolver address is required when setting an address', {
-      metaMessages: [
-        `- resolverAddress: ${resolverAddress || EMPTY_ADDRESS}`,
-        `- addr: ${address || EMPTY_ADDRESS}`,
-      ],
-    })
-  }
-}