@ensdomains/ensjs 4.1.2 → 5.0.0-alpha.1

package/src/actions/wallet/setFuses.ts

@@ -0,0 +1,127 @@
+import type {
+  Account,
+  Chain,
+  GetChainContractAddressErrorType,
+  Hash,
+  WriteContractParameters,
+} from 'viem'
+import { type NamehashErrorType, namehash } from 'viem'
+import { writeContract } from 'viem/actions'
+import { getAction } from 'viem/utils'
+import {
+  type ChainWithContracts,
+  getChainContractAddress,
+  type RequireClientContracts,
+} from '../../clients/chain.js'
+import { nameWrapperSetFusesSnippet } from '../../contracts/nameWrapper.js'
+import type { Prettify, WriteTransactionParameters } from '../../types/index.js'
+import { ASSERT_NO_TYPE_ERROR } from '../../types/internal.js'
+import {
+  type EncodeChildFusesInputObject,
+  type EncodeFusesErrorType,
+  encodeFuses,
+} from '../../utils/fuses.js'
+
+export type SetFusesWriteParametersParameters = {
+  /** Name to set fuses for */
+  name: string
+  /** Fuse object to set to */
+  fuses: EncodeChildFusesInputObject
+}
+
+export type SetFusesWriteParametersReturnType = ReturnType<
+  typeof setFusesWriteParameters
+>
+
+export type SetFusesWriteParametersErrorType =
+  | EncodeFusesErrorType
+  | GetChainContractAddressErrorType
+  | NamehashErrorType
+
+export const setFusesWriteParameters = <
+  chain extends Chain,
+  account extends Account,
+>(
+  client: RequireClientContracts<chain, 'ensNameWrapper', account>,
+  { name, fuses }: SetFusesWriteParametersParameters,
+) => {
+  ASSERT_NO_TYPE_ERROR(client)
+
+  const encodedFuses = encodeFuses({ restriction: 'child', input: fuses })
+  return {
+    address: getChainContractAddress({
+      chain: client.chain,
+      contract: 'ensNameWrapper',
+    }),
+    abi: nameWrapperSetFusesSnippet,
+    functionName: 'setFuses',
+    args: [namehash(name), encodedFuses],
+    chain: client.chain,
+    account: client.account,
+  } as const satisfies WriteContractParameters<
+    typeof nameWrapperSetFusesSnippet
+  >
+}
+
+// ================================
+// Action
+// ================================
+
+export type SetFusesParameters<
+  chain extends Chain,
+  account extends Account,
+  chainOverride extends ChainWithContracts<'ensNameWrapper'>,
+> = Prettify<
+  SetFusesWriteParametersParameters &
+    WriteTransactionParameters<chain, account, chainOverride>
+>
+
+export type SetFusesReturnType = Hash
+
+export type SetFusesErrorType = Error
+
+/**
+ * Sets the fuses for a name.
+ * @param client - {@link Client}
+ * @param options - {@link SetFusesParameters}
+ * @returns Transaction hash. {@link SetFusesReturnType}
+ *
+ * @example
+ * import { createWalletClient, custom } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { setFuses } from '@ensdomains/ensjs/wallet'
+ *
+ * const wallet = createWalletClient({
+ *   chain: addEnsContracts(mainnet),
+ *   transport: custom(window.ethereum),
+ * })
+ * const hash = await setFuses(wallet, {
+ *   name: 'sub.ens.eth',
+ *   fuses: {
+ *     named: ['CANNOT_TRANSFER'],
+ *   },
+ * })
+ * // 0x...
+ */
+export async function setFuses<
+  chain extends Chain,
+  account extends Account,
+  chainOverride extends ChainWithContracts<'ensNameWrapper'>,
+>(
+  client: RequireClientContracts<chain, 'ensNameWrapper', account>,
+  { name, fuses, ...txArgs }: SetFusesParameters<chain, account, chainOverride>,
+): Promise<SetFusesReturnType> {
+  ASSERT_NO_TYPE_ERROR(client)
+
+  const data = setFusesWriteParameters<chain, account>(client, {
+    name,
+    fuses,
+  })
+
+  const writeContractAction = getAction(client, writeContract, 'writeContract')
+  return writeContractAction({
+    ...data,
+    ...txArgs,
+  } as WriteContractParameters)
+}

package/src/actions/wallet/setPrimaryName.ts

@@ -0,0 +1,189 @@
+import type {
+  Account,
+  Address,
+  Chain,
+  GetChainContractAddressErrorType,
+  Hash,
+  WriteContractErrorType,
+  WriteContractParameters,
+} from 'viem'
+import { writeContract } from 'viem/actions'
+import { getAction } from 'viem/utils'
+import {
+  type ChainWithContracts,
+  getChainContractAddress,
+  type RequireClientContracts,
+} from '../../clients/chain.js'
+import {
+  reverseRegistrarSetNameForAddrSnippet,
+  reverseRegistrarSetNameSnippet,
+} from '../../contracts/reverseRegistrar.js'
+import type { Prettify, WriteTransactionParameters } from '../../types/index.js'
+import {
+  ASSERT_NO_TYPE_ERROR,
+  EXCLUDE_TYPE_ERROR,
+} from '../../types/internal.js'
+import { clientWithOverrides } from '../../utils/clientWithOverrides.js'
+
+// ================================
+// Write parameters
+// ================================
+
+type BaseSetPrimaryNameDataParameters = {
+  /** The name to set as primary */
+  name: string
+  /** The address to set the primary name for */
+  address?: Address
+  /** The resolver address to use */
+  resolverAddress?: Address
+}
+
+type SelfSetPrimaryNameDataParameters = {
+  address?: never
+  resolverAddress?: never
+}
+
+type OtherSetPrimaryNameDataParameters = {
+  address: Address
+  resolverAddress?: Address
+}
+
+export type SetPrimaryNameWriteParametersParameters =
+  BaseSetPrimaryNameDataParameters &
+    (SelfSetPrimaryNameDataParameters | OtherSetPrimaryNameDataParameters)
+
+export type SetPrimaryNameWriteParametersReturnType = ReturnType<
+  typeof setPrimaryNameWriteParameters
+>
+
+export type SetPrimaryNameWriteParametersErrorType =
+  GetChainContractAddressErrorType
+
+export const setPrimaryNameWriteParameters = <
+  chain extends Chain,
+  account extends Account,
+>(
+  client: RequireClientContracts<
+    chain,
+    'ensPublicResolver' | 'ensReverseRegistrar',
+    account
+  >,
+  {
+    name,
+    address,
+    resolverAddress = getChainContractAddress({
+      chain: EXCLUDE_TYPE_ERROR(client).chain,
+      contract: 'ensPublicResolver',
+    }),
+  }: SetPrimaryNameWriteParametersParameters,
+) => {
+  ASSERT_NO_TYPE_ERROR(client)
+
+  const reverseRegistrarAddress = getChainContractAddress({
+    chain: client.chain,
+    contract: 'ensReverseRegistrar',
+  })
+
+  const baseParams = {
+    address: reverseRegistrarAddress,
+    account: client.account,
+    chain: client.chain,
+  } as const
+
+  if (address)
+    return {
+      ...baseParams,
+      abi: reverseRegistrarSetNameForAddrSnippet,
+      functionName: 'setNameForAddr',
+      args: [address, client.account.address, resolverAddress, name],
+    } as const satisfies WriteContractParameters<
+      typeof reverseRegistrarSetNameForAddrSnippet
+    >
+
+  return {
+    ...baseParams,
+    abi: reverseRegistrarSetNameSnippet,
+    functionName: 'setName',
+    args: [name],
+  } as const satisfies WriteContractParameters<
+    typeof reverseRegistrarSetNameSnippet
+  >
+}
+
+// ================================
+// Action
+// ================================
+
+export type SetPrimaryNameParameters<
+  chain extends Chain,
+  account extends Account,
+  chainOverride extends ChainWithContracts<
+    'ensPublicResolver' | 'ensReverseRegistrar'
+  >,
+> = Prettify<
+  SetPrimaryNameWriteParametersParameters &
+    WriteTransactionParameters<chain, account, chainOverride>
+>
+
+export type SetPrimaryNameReturnType = Hash
+
+export type SetPrimaryNameErrorType =
+  | SetPrimaryNameWriteParametersErrorType
+  | WriteContractErrorType
+
+/**
+ * Sets a primary name for an address.
+ * @param client - {@link Client}
+ * @param options - {@link SetPrimaryNameOptions}
+ * @returns Transaction hash. {@link SetPrimaryNameReturnType}
+ *
+ * @example
+ * import { createWalletClient, custom } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { setPrimaryName } from '@ensdomains/ensjs/wallet'
+ *
+ * const wallet = createWalletClient({
+ *   chain: addEnsContracts(mainnet),
+ *   transport: custom(window.ethereum),
+ * })
+ * const hash = await setPrimaryName(wallet, {
+ *   name: 'ens.eth',
+ * })
+ * // 0x...
+ */
+export async function setPrimaryName<
+  chain extends Chain,
+  account extends Account,
+  chainOverride extends ChainWithContracts<
+    'ensPublicResolver' | 'ensReverseRegistrar'
+  >,
+>(
+  client: RequireClientContracts<
+    chain,
+    'ensPublicResolver' | 'ensReverseRegistrar',
+    account
+  >,
+  {
+    name,
+    address,
+    resolverAddress,
+    ...txArgs
+  }: SetPrimaryNameParameters<chain, account, chainOverride>,
+): Promise<SetPrimaryNameReturnType> {
+  ASSERT_NO_TYPE_ERROR(client)
+
+  const writeParameters = setPrimaryNameWriteParameters(
+    clientWithOverrides(client, txArgs),
+    {
+      name,
+      address,
+      resolverAddress,
+    } as SetPrimaryNameWriteParametersParameters,
+  )
+  const writeContractAction = getAction(client, writeContract, 'writeContract')
+  return writeContractAction({
+    ...writeParameters,
+    ...txArgs,
+  } as WriteContractParameters)
+}

package/src/actions/wallet/setRecords.ts

@@ -0,0 +1,174 @@
+import {
+  type Account,
+  type Address,
+  type Chain,
+  type Client,
+  type EncodeFunctionDataErrorType,
+  type EncodeFunctionDataParameters,
+  encodeFunctionData,
+  type NamehashErrorType,
+  namehash,
+  type Transport,
+  type WriteContractErrorType,
+  type WriteContractParameters,
+  type WriteContractReturnType,
+} from 'viem'
+import { writeContract } from 'viem/actions'
+import { getAction } from 'viem/utils'
+import type {
+  ChainWithContracts,
+  RequireClientContracts,
+} from '../../clients/chain.js'
+import { publicResolverMulticallSnippet } from '../../contracts/publicResolver.js'
+import { NoRecordsSpecifiedError } from '../../errors/public.js'
+import type { Prettify, WriteTransactionParameters } from '../../types/index.js'
+import { ASSERT_NO_TYPE_ERROR } from '../../types/internal.js'
+import { clientWithOverrides } from '../../utils/clientWithOverrides.js'
+import {
+  type RecordOptions,
+  resolverMulticallParameters,
+} from '../../utils/coders/resolverMulticallParameters.js'
+
+// ================================
+// Write parameters
+// ================================
+
+export type SetRecordsWriteParametersParameters = {
+  /** The name to set records for */
+  name: string
+  /** The resolver address to set records on */
+  resolverAddress: Address
+} & RecordOptions
+
+export type SetRecordsWriteParametersReturnType = ReturnType<
+  typeof setRecordsWriteParameters
+>
+
+export type SetRecordsWriteParametersErrorType =
+  | NoRecordsSpecifiedError
+  | NamehashErrorType
+  | EncodeFunctionDataErrorType
+
+export const setRecordsWriteParameters = async <
+  chain extends Chain,
+  account extends Account,
+>(
+  client: Client<Transport, chain, account>,
+  { name, resolverAddress, ...records }: SetRecordsWriteParametersParameters,
+) => {
+  const callArray = await resolverMulticallParameters({
+    namehash: namehash(name),
+    ...records,
+  })
+  if (callArray.length === 0) throw new NoRecordsSpecifiedError()
+
+  const baseParams = {
+    address: resolverAddress,
+    account: client.account,
+    chain: client.chain,
+  } as const
+
+  if (callArray.length === 1)
+    return {
+      ...baseParams,
+      ...callArray[0],
+    } as const satisfies WriteContractParameters
+  return {
+    ...baseParams,
+    abi: publicResolverMulticallSnippet,
+    functionName: 'multicall',
+    args: [
+      callArray.map((call) =>
+        encodeFunctionData(call as EncodeFunctionDataParameters),
+      ),
+    ],
+  } as const satisfies WriteContractParameters<
+    typeof publicResolverMulticallSnippet
+  >
+}
+
+// ================================
+// Action
+// ================================
+
+export type SetRecordsParameters<
+  chain extends Chain,
+  account extends Account,
+  chainOverride extends ChainWithContracts<'ensPublicResolver'>,
+> = Prettify<
+  SetRecordsWriteParametersParameters &
+    WriteTransactionParameters<chain, account, chainOverride>
+>
+
+export type SetRecordsReturnType = WriteContractReturnType
+
+export type SetRecordsErrorType =
+  | SetRecordsWriteParametersErrorType
+  | WriteContractErrorType
+
+/**
+ * Sets multiple records for a name on a resolver.
+ * @param client - {@link Client}
+ * @param options - {@link SetRecordsOptions}
+ * @returns Transaction hash. {@link SetRecordsReturnType}
+ *
+ * @example
+ * import { createWalletClient, custom } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { setRecords } from '@ensdomains/ensjs/wallet'
+ *
+ * const wallet = createWalletClient({
+ *   chain: addEnsContracts(mainnet),
+ *   transport: custom(window.ethereum),
+ * })
+ * const hash = await setRecords(wallet, {
+ *   name: 'ens.eth',
+ *   coins: [
+ *     {
+ *       coin: 'ETH',
+ *       value: '0xFe89cc7aBB2C4183683ab71653C4cdc9B02D44b7',
+ *     },
+ *   ],
+ *   texts: [{ key: 'foo', value: 'bar' }],
+ *   resolverAddress: '0x4976fb03C32e5B8cfe2b6cCB31c09Ba78EBaBa41',
+ * })
+ * // 0x...
+ */
+export async function setRecords<
+  chain extends Chain,
+  account extends Account,
+  chainOverride extends ChainWithContracts<'ensPublicResolver'>,
+>(
+  client: RequireClientContracts<chain, 'ensPublicResolver', account>,
+  {
+    name,
+    resolverAddress,
+    clearRecords,
+    contentHash,
+    texts,
+    coins,
+    abi,
+    ...txArgs
+  }: SetRecordsParameters<chain, account, chainOverride>,
+): Promise<SetRecordsReturnType> {
+  ASSERT_NO_TYPE_ERROR(client)
+
+  const writeParameters = await setRecordsWriteParameters(
+    clientWithOverrides(client, txArgs),
+    {
+      name,
+      resolverAddress,
+      clearRecords,
+      contentHash,
+      texts,
+      coins,
+      abi,
+    },
+  )
+  const writeContractAction = getAction(client, writeContract, 'writeContract')
+  return writeContractAction({
+    ...writeParameters,
+    ...txArgs,
+  } as WriteContractParameters)
+}

package/src/actions/wallet/setResolver.ts

@@ -0,0 +1,173 @@
+import type {
+  Account,
+  Address,
+  Chain,
+  GetChainContractAddressErrorType,
+  WriteContractErrorType,
+  WriteContractParameters,
+  WriteContractReturnType,
+} from 'viem'
+import { type NamehashErrorType, namehash } from 'viem'
+import { writeContract } from 'viem/actions'
+import { getAction } from 'viem/utils'
+import {
+  type ChainWithContracts,
+  getChainContractAddress,
+  type RequireClientContracts,
+} from '../../clients/chain.js'
+import { nameWrapperSetResolverSnippet } from '../../contracts/nameWrapper.js'
+import { registrySetResolverSnippet } from '../../contracts/registry.js'
+import type { ErrorType } from '../../errors/utils.js'
+import type { Prettify, WriteTransactionParameters } from '../../types/index.js'
+import { ASSERT_NO_TYPE_ERROR } from '../../types/internal.js'
+import {
+  type ClientWithOverridesErrorType,
+  clientWithOverrides,
+} from '../../utils/clientWithOverrides.js'
+
+export type SetResolverWriteParametersParameters = {
+  /** Name to set resolver for */
+  name: string
+  /** Contract to set resolver on */
+  contract: 'registry' | 'nameWrapper'
+  /** Resolver address to set */
+  resolverAddress: Address
+}
+
+export type SetResolverWriteParametersReturnType = ReturnType<
+  typeof setResolverWriteParameters
+>
+
+export type SetResolverWriteParametersErrorType =
+  | ErrorType
+  | GetChainContractAddressErrorType
+  | NamehashErrorType
+
+// ================================
+// Write parameters
+// ================================
+
+export const setResolverWriteParameters = <
+  chain extends Chain,
+  account extends Account,
+>(
+  client: RequireClientContracts<
+    chain,
+    'ensNameWrapper' | 'ensRegistry',
+    account
+  >,
+  { name, contract, resolverAddress }: SetResolverWriteParametersParameters,
+) => {
+  ASSERT_NO_TYPE_ERROR(client)
+
+  if (contract !== 'registry' && contract !== 'nameWrapper')
+    throw new Error(`Unknown contract: ${contract}`)
+
+  const address = getChainContractAddress({
+    chain: client.chain,
+    contract: contract === 'nameWrapper' ? 'ensNameWrapper' : 'ensRegistry',
+  })
+
+  const args = [namehash(name), resolverAddress] as const
+  const functionName = 'setResolver'
+
+  const baseParams = {
+    address,
+    functionName,
+    args,
+    chain: client.chain,
+    account: client.account,
+  } as const
+
+  if (contract === 'nameWrapper')
+    return {
+      ...baseParams,
+      abi: nameWrapperSetResolverSnippet,
+    } as const satisfies WriteContractParameters<
+      typeof nameWrapperSetResolverSnippet
+    >
+
+  return {
+    ...baseParams,
+    abi: registrySetResolverSnippet,
+  } as const satisfies WriteContractParameters<
+    typeof registrySetResolverSnippet
+  >
+}
+
+// ================================
+// Action
+// ================================
+
+export type SetResolverParameters<
+  chain extends Chain,
+  account extends Account,
+  chainOverride extends ChainWithContracts<'ensNameWrapper' | 'ensRegistry'>,
+> = Prettify<
+  SetResolverWriteParametersParameters &
+    WriteTransactionParameters<chain, account, chainOverride>
+>
+
+export type SetResolverReturnType = WriteContractReturnType
+
+export type SetResolverErrorType =
+  | SetResolverWriteParametersErrorType
+  | ClientWithOverridesErrorType
+  | WriteContractErrorType
+
+/**
+ * Sets a resolver for a name.
+ * @param client - {@link Client}
+ * @param options - {@link SetResolverOptions}
+ * @returns Transaction hash. {@link SetResolverReturnType}
+ *
+ * @example
+ * import { createWalletClient, custom } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { setResolver } from '@ensdomains/ensjs/wallet'
+ *
+ * const wallet = createWalletClient({
+ *   chain: addEnsContracts(mainnet),
+ *   transport: custom(window.ethereum),
+ * })
+ * const hash = await setResolver(wallet, {
+ *   name: 'ens.eth',
+ *   contract: 'registry',
+ *   resolverAddress: '0x4976fb03C32e5B8cfe2b6cCB31c09Ba78EBaBa41',
+ * })
+ * // 0x...
+ */
+export async function setResolver<
+  chain extends Chain,
+  account extends Account,
+  chainOverride extends ChainWithContracts<'ensNameWrapper' | 'ensRegistry'>,
+>(
+  client: RequireClientContracts<
+    chain,
+    'ensNameWrapper' | 'ensRegistry',
+    account
+  >,
+  {
+    name,
+    contract,
+    resolverAddress,
+    ...txArgs
+  }: SetResolverParameters<chain, account, chainOverride>,
+): Promise<SetResolverReturnType> {
+  ASSERT_NO_TYPE_ERROR(client)
+
+  const writeParameters = setResolverWriteParameters(
+    clientWithOverrides(client, txArgs),
+    {
+      name,
+      contract,
+      resolverAddress,
+    },
+  )
+  const writeContractAction = getAction(client, writeContract, 'writeContract')
+  return writeContractAction({
+    ...writeParameters,
+    ...txArgs,
+  } as WriteContractParameters)
+}