@ensdomains/ensjs 4.1.1 → 5.0.0-alpha.0

package/src/actions/wallet/setAbiRecord.ts

@@ -0,0 +1,176 @@
+import type {
+  Account,
+  Address,
+  Chain,
+  Client,
+  Transport,
+  WriteContractErrorType,
+  WriteContractParameters,
+  WriteContractReturnType,
+} from 'viem'
+import { type NamehashErrorType, namehash } from 'viem'
+import { writeContract } from 'viem/actions'
+import { getAction } from 'viem/utils'
+import type { Prettify, WriteTransactionParameters } from '../../types/index.js'
+import {
+  type ClientWithOverridesErrorType,
+  clientWithOverrides,
+} from '../../utils/clientWithOverrides.js'
+import type { AbiEncodeAs } from '../../utils/coders/encodeAbi.js'
+import {
+  type SetAbiParameters,
+  type SetAbiParametersErrorType,
+  type SetAbiParametersReturnType,
+  setAbiParameters,
+} from '../../utils/coders/setAbi.js'
+
+// export type SetAbiRecordParameters<encodeAs extends AbiEncodeAs = AbiEncodeAs> =
+// 	Prettify<
+// 		EncodeAbiParameters<encodeAs> & {
+// 			/** Name to set ABI for */
+// 			name: string;
+// 			/** Resolver address to set ABI on */
+// 			resolverAddress: Address;
+// 		}
+// 	>;
+
+// export type SetAbiRecordOptions<
+// 	encodeAs extends AbiEncodeAs,
+// 	chain extends Chain | undefined,
+// 	account extends Account | undefined,
+// 	chainOverride extends Chain | undefined,
+// > = Prettify<
+// 	SetAbiRecordParameters<encodeAs> &
+// 		WriteTransactionParameters<chain, account, chainOverride>
+// >;
+
+// export type SetAbiRecordReturnType = WriteContractReturnType;
+
+// export type SetAbiRecordErrorType = Error;
+
+// ================================
+// Write parameters
+// ================================
+
+export type SetAbiRecordWriteParametersParameters<
+  encodeAs extends AbiEncodeAs,
+> = Prettify<
+  SetAbiParameters<encodeAs> & {
+    /** Name to set ABI for */
+    name: string
+    /** Resolver address to set ABI on */
+    resolverAddress: Address
+  }
+>
+
+export type SetAbiRecordWriteParametersReturnType = ReturnType<
+  typeof setAbiRecordWriteParameters
+>
+
+export type SetAbiRecordWriteParametersErrorType =
+  | SetAbiParametersErrorType
+  | NamehashErrorType
+
+export const setAbiRecordWriteParameters = async <
+  encodeAs extends AbiEncodeAs,
+  chain extends Chain,
+  account extends Account,
+>(
+  client: Client<Transport, chain, account>,
+  {
+    name,
+    data,
+    encodeAs,
+    resolverAddress,
+  }: SetAbiRecordWriteParametersParameters<encodeAs>,
+) => {
+  return {
+    address: resolverAddress,
+    chain: client.chain,
+    account: client.account,
+    ...(await setAbiParameters({
+      namehash: namehash(name),
+      data,
+      encodeAs,
+    } as SetAbiParameters<encodeAs>)),
+  } as const satisfies WriteContractParameters<
+    SetAbiParametersReturnType['abi']
+  >
+}
+
+// ================================
+// Action
+// ================================
+
+export type SetAbiRecordParameters<
+  encodeAs extends AbiEncodeAs,
+  chain extends Chain | undefined,
+  account extends Account | undefined,
+  chainOverride extends Chain | undefined,
+> = SetAbiRecordWriteParametersParameters<encodeAs> &
+  WriteTransactionParameters<chain, account, chainOverride>
+
+export type SetAbiRecordReturnType = WriteContractReturnType
+
+export type SetAbiRecordErrorType =
+  | SetAbiRecordWriteParametersErrorType
+  | ClientWithOverridesErrorType
+  | WriteContractErrorType
+
+/**
+ * Sets the ABI for a name on a resolver.
+ * @param client - {@link Client}
+ * @param options - {@link SetAbiRecordParameters}
+ * @returns Transaction hash. {@link SetAbiRecordReturnType}
+ *
+ * @example
+ * import abi from './abi.json'
+ * import { createWalletClient, custom } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { encodeAbi } from '@ensdomains/ensjs/utils'
+ * import { setAbiRecord } from '@ensdomains/ensjs/wallet'
+ *
+ * const wallet = createWalletClient({
+ *   chain: addEnsContracts(mainnet),
+ *   transport: custom(window.ethereum),
+ * })
+ *
+ * const encodedAbi = await encodeAbi({ encodeAs: 'json', abi })
+ * const hash = await setAbiRecord(wallet, {
+ *   name: 'ens.eth',
+ *   encodedAbi,
+ *   resolverAddress: '0x4976fb03C32e5B8cfe2b6cCB31c09Ba78EBaBa41',
+ * })
+ * // 0x...
+ */
+export async function setAbiRecord<
+  encodeAs extends AbiEncodeAs,
+  chain extends Chain | undefined,
+  account extends Account | undefined,
+  chainOverride extends Chain | undefined,
+>(
+  client: Client<Transport, chain, account>,
+  {
+    name,
+    data,
+    encodeAs,
+    resolverAddress,
+    ...txArgs
+  }: SetAbiRecordParameters<encodeAs, chain, account, chainOverride>,
+): Promise<SetAbiRecordReturnType> {
+  const writeParameters = await setAbiRecordWriteParameters(
+    clientWithOverrides(client, txArgs),
+    {
+      name,
+      data,
+      encodeAs,
+      resolverAddress,
+    } as SetAbiRecordWriteParametersParameters<encodeAs>,
+  )
+  const writeContractAction = getAction(client, writeContract, 'writeContract')
+  return writeContractAction({
+    ...writeParameters,
+    ...txArgs,
+  } as WriteContractParameters)
+}

package/src/actions/wallet/setAddressRecord.ts

@@ -0,0 +1,174 @@
+import type {
+  Account,
+  Address,
+  Chain,
+  Client,
+  Transport,
+  WriteContractErrorType,
+  WriteContractParameters,
+  WriteContractReturnType,
+} from 'viem'
+import { type NamehashErrorType, namehash } from 'viem'
+import { writeContract } from 'viem/actions'
+import { getAction } from 'viem/utils'
+import type { Prettify, WriteTransactionParameters } from '../../types/index.js'
+import {
+  type ClientWithOverridesErrorType,
+  clientWithOverrides,
+} from '../../utils/clientWithOverrides.js'
+import {
+  type SetAddrParametersErrorType,
+  type SetAddrParametersReturnType,
+  setAddrParameters,
+} from '../../utils/coders/setAddr.js'
+
+// export type SetAddressRecordParameters = {
+// 	/** Name to set address record for */
+// 	name: string;
+// 	/** Coin ticker or ID to set */
+// 	coin: string | number;
+// 	/** Value to set, null if deleting */
+// 	value: Address | string | null;
+// 	/** Resolver address to set address record on */
+// 	resolverAddress: Address;
+// };
+
+// export type SetAddressRecordOptions<
+// 	chain extends Chain | undefined,
+// 	account extends Account | undefined,
+// 	chainOverride extends Chain | undefined,
+// > = Prettify<
+// 	SetAddressRecordParameters &
+// 		WriteTransactionParameters<chain, account, chainOverride>
+// >;
+
+// export type SetAddressRecordReturnType = WriteContractReturnType;
+
+// export type SetAddressRecordErrorType = Error;
+
+// ================================
+// Write parameters
+// ================================
+
+export type SetAddressRecordWriteParametersParameters = {
+  /** Name to set address record for */
+  name?: string
+  /** Coin ticker or ID to set */
+  coin: string | number
+  /** Value to set, null if deleting */
+  value: Address | string | null
+  /** Resolver address to set address record on */
+  resolverAddress: Address
+}
+
+export type SetAddressRecordWriteParametersReturnType = ReturnType<
+  typeof setAddressRecordWriteParameters
+>
+
+export type SetAddressRecordWriteParametersErrorType =
+  | SetAddrParametersErrorType
+  | NamehashErrorType
+
+export const setAddressRecordWriteParameters = <
+  chain extends Chain,
+  account extends Account,
+>(
+  client: Client<Transport, chain, account>,
+  {
+    name,
+    coin,
+    value,
+    resolverAddress,
+  }: SetAddressRecordWriteParametersParameters,
+) => {
+  return {
+    address: resolverAddress,
+    chain: client.chain,
+    account: client.account,
+    ...setAddrParameters(
+      name
+        ? {
+            namehash: namehash(name),
+            coin,
+            value,
+          }
+        : { coin, value },
+    ),
+  } as const satisfies WriteContractParameters<
+    SetAddrParametersReturnType['abi']
+  >
+}
+
+// ================================
+// Action
+// ================================
+
+export type SetAddressRecordParameters<
+  chain extends Chain | undefined,
+  account extends Account | undefined,
+  chainOverride extends Chain | undefined,
+> = Prettify<
+  SetAddressRecordWriteParametersParameters &
+    WriteTransactionParameters<chain, account, chainOverride>
+>
+
+export type SetAddressRecordReturnType = WriteContractReturnType
+
+export type SetAddressRecordErrorType =
+  | SetAddressRecordWriteParametersErrorType
+  | ClientWithOverridesErrorType
+  | WriteContractErrorType
+
+/**
+ * Sets an address record for a name on a resolver.
+ * @param client - {@link Client}
+ * @param options - {@link SetAddressRecordParameters}
+ * @returns Transaction hash. {@link SetAddressRecordReturnType}
+ *
+ * @example
+ * import { createWalletClient, custom } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { setAddressRecord } from '@ensdomains/ensjs/wallet'
+ *
+ * const wallet = createWalletClient({
+ *   chain: addEnsContracts(mainnet),
+ *   transport: custom(window.ethereum),
+ * })
+ * const hash = await setAddressRecord(wallet, {
+ *   name: 'ens.eth',
+ *   coin: 'ETH',
+ *   value: '0xFe89cc7aBB2C4183683ab71653C4cdc9B02D44b7',
+ *   resolverAddress: '0x4976fb03C32e5B8cfe2b6cCB31c09Ba78EBaBa41',
+ * })
+ * // 0x...
+ */
+export async function setAddressRecord<
+  chain extends Chain | undefined,
+  account extends Account | undefined,
+  chainOverride extends Chain | undefined,
+>(
+  client: Client<Transport, chain, account>,
+  {
+    name,
+    coin,
+    value,
+    resolverAddress,
+    ...txArgs
+  }: SetAddressRecordParameters<chain, account, chainOverride>,
+): Promise<SetAddressRecordReturnType> {
+  const data = setAddressRecordWriteParameters(
+    clientWithOverrides(client, txArgs),
+    {
+      name,
+      coin,
+      value,
+      resolverAddress,
+    },
+  )
+  const writeContractAction = getAction(client, writeContract, 'writeContract')
+  return writeContractAction({
+    ...data,
+    ...txArgs,
+  } as WriteContractParameters)
+}

package/src/actions/wallet/setChildFuses.ts

@@ -0,0 +1,152 @@
+import type {
+  Account,
+  Chain,
+  GetChainContractAddressErrorType,
+  LabelhashErrorType,
+  WriteContractErrorType,
+  WriteContractParameters,
+  WriteContractReturnType,
+} from 'viem'
+import { type NamehashErrorType, namehash } from 'viem'
+import { writeContract } from 'viem/actions'
+import { labelhash } from 'viem/ens'
+import { getAction } from 'viem/utils'
+import {
+  getChainContractAddress,
+  type RequireClientContracts,
+} from '../../clients/chain.js'
+import { nameWrapperSetChildFusesSnippet } from '../../contracts/nameWrapper.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'
+import {
+  type EncodeFusesErrorType,
+  type EncodeFusesInputObject,
+  encodeFuses,
+} from '../../utils/fuses.js'
+
+// ================================
+// Write parameters
+// ================================
+
+export type SetChildFusesWriteParametersParameters = {
+  /** Name to set child fuses for */
+  name: string
+  /** Fuse object or number value to set to */
+  fuses: EncodeFusesInputObject
+  /** Expiry to set for fuses */
+  expiry?: number | bigint
+}
+
+export type SetChildFusesWriteParametersReturnType = ReturnType<
+  typeof setChildFusesWriteParameters
+>
+
+export type SetChildFusesWriteParametersErrorType =
+  | EncodeFusesErrorType
+  | LabelhashErrorType
+  | NamehashErrorType
+  | GetChainContractAddressErrorType
+
+export const setChildFusesWriteParameters = <
+  chain extends Chain,
+  account extends Account,
+>(
+  client: RequireClientContracts<chain, 'ensNameWrapper', account>,
+  { name, fuses, expiry }: SetChildFusesWriteParametersParameters,
+) => {
+  ASSERT_NO_TYPE_ERROR(client)
+
+  const encodedFuses = encodeFuses({ input: fuses })
+  const labels = name.split('.')
+  const labelHash = labelhash(labels.shift()!)
+  const parentNode = namehash(labels.join('.'))
+
+  return {
+    address: getChainContractAddress({
+      chain: client.chain,
+      contract: 'ensNameWrapper',
+    }),
+    abi: nameWrapperSetChildFusesSnippet,
+    functionName: 'setChildFuses',
+    args: [parentNode, labelHash, encodedFuses, BigInt(expiry ?? 0)],
+    chain: client.chain,
+    account: client.account,
+  } as const satisfies WriteContractParameters<
+    typeof nameWrapperSetChildFusesSnippet
+  >
+}
+
+// ================================
+// Action
+// ================================
+
+export type SetChildFusesParameters<
+  chain extends Chain | undefined,
+  account extends Account | undefined,
+  chainOverride extends Chain | undefined,
+> = Prettify<
+  SetChildFusesWriteParametersParameters &
+    WriteTransactionParameters<chain, account, chainOverride>
+>
+
+export type SetChildFusesReturnType = WriteContractReturnType
+
+export type SetChildFusesErrorType =
+  | SetChildFusesWriteParametersErrorType
+  | ClientWithOverridesErrorType
+  | WriteContractErrorType
+/**
+ * Sets the fuses for a name as the parent.
+ * @param client - {@link Client}
+ * @param options - {@link SetChildFusesOptions}
+ * @returns Transaction hash. {@link SetChildFusesReturnType}
+ *
+ * @example
+ * import { createWalletClient, custom } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { setChildFuses } from '@ensdomains/ensjs/wallet'
+ *
+ * const wallet = createWalletClient({
+ *   chain: addEnsContracts(mainnet),
+ *   transport: custom(window.ethereum),
+ * })
+ * const hash = await setChildFuses(wallet, {
+ *   name: 'sub.ens.eth',
+ *   fuses: {
+ *     parent: {
+ *       named: ['PARENT_CANNOT_CONTROL'],
+ *     },
+ *   },
+ * })
+ * // 0x...
+ */
+export async function setChildFuses<
+  chain extends Chain,
+  account extends Account,
+  chainOverride extends Chain | undefined,
+>(
+  client: RequireClientContracts<chain, 'ensNameWrapper', account>,
+  {
+    name,
+    fuses,
+    expiry,
+    ...txArgs
+  }: SetChildFusesParameters<chain, account, chainOverride>,
+): Promise<SetChildFusesReturnType> {
+  ASSERT_NO_TYPE_ERROR(client)
+
+  const data = setChildFusesWriteParameters(
+    clientWithOverrides(client, txArgs),
+    { name, fuses, expiry },
+  )
+  const writeContractAction = getAction(client, writeContract, 'writeContract')
+  return writeContractAction({
+    ...data,
+    ...txArgs,
+  } as WriteContractParameters)
+}

package/src/actions/wallet/setContentHashRecord.ts

@@ -0,0 +1,134 @@
+import type {
+  Account,
+  Address,
+  Chain,
+  Client,
+  Hash,
+  Transport,
+  WriteContractErrorType,
+  WriteContractParameters,
+} from 'viem'
+import { type NamehashErrorType, namehash } from 'viem'
+import { writeContract } from 'viem/actions'
+import { getAction } from 'viem/utils'
+import type { Prettify, WriteTransactionParameters } from '../../types/index.js'
+import {
+  type ClientWithOverridesErrorType,
+  clientWithOverrides,
+} from '../../utils/clientWithOverrides.js'
+import {
+  type SetContentHashParametersErrorType,
+  type SetContentHashParametersReturnType,
+  setContentHashParameters,
+} from '../../utils/coders/setContentHash.js'
+
+// ================================
+// Write Parameters
+// ================================
+
+export type SetContentHashRecordWriteParametersParameters = {
+  /** Name to set content hash for */
+  name?: string
+  /** Content hash value */
+  contentHash: string | null
+  /** The resolver address to use */
+  resolverAddress: Address
+}
+
+export type SetContentHashRecordWriteParametersErrorType =
+  | SetContentHashParametersErrorType
+  | NamehashErrorType
+
+export const setContentHashRecordWriteParameters = <
+  chain extends Chain,
+  account extends Account,
+>(
+  client: Client<Transport, chain, account>,
+  {
+    name,
+    contentHash,
+    resolverAddress,
+  }: SetContentHashRecordWriteParametersParameters,
+) => {
+  return {
+    address: resolverAddress,
+    chain: client.chain,
+    account: client.account,
+    ...setContentHashParameters(
+      typeof name === 'string'
+        ? { namehash: namehash(name), contentHash }
+        : { contentHash },
+    ),
+  } as const satisfies WriteContractParameters<
+    SetContentHashParametersReturnType['abi']
+  >
+}
+
+// ================================
+// Action
+// ================================
+
+export type SetContentHashRecordParameters<
+  chain extends Chain | undefined,
+  account extends Account | undefined,
+  chainOverride extends Chain | undefined,
+> = Prettify<
+  SetContentHashRecordWriteParametersParameters &
+    WriteTransactionParameters<chain, account, chainOverride>
+>
+
+export type SetContentHashRecordReturnType = Hash
+
+export type SetContentHashRecordErrorType =
+  | SetContentHashRecordWriteParametersErrorType
+  | ClientWithOverridesErrorType
+  | WriteContractErrorType
+/**
+ * Sets the content hash record for a name on a resolver.
+ * @param client - {@link Client}
+ * @param options - {@link SetContentHashRecordOptions}
+ * @returns Transaction hash. {@link SetContentHashRecordReturnType}
+ *
+ * @example
+ * import { createWalletClient, custom } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { setContentHashRecord } from '@ensdomains/ensjs/wallet'
+ *
+ * const wallet = createWalletClient({
+ *   chain: addEnsContracts(mainnet),
+ *   transport: custom(window.ethereum),
+ * })
+ * const hash = await setContentHashRecord(wallet, {
+ *   name: 'ens.eth',
+ *   contentHash: 'ipns://k51qzi5uqu5djdczd6zw0grmo23j2vkj9uzvujencg15s5rlkq0ss4ivll8wqw',
+ * })
+ * // 0x...
+ */
+export async function setContentHashRecord<
+  chain extends Chain | undefined,
+  account extends Account | undefined,
+  chainOverride extends Chain | undefined,
+>(
+  client: Client<Transport, chain, account>,
+  {
+    name,
+    contentHash,
+    resolverAddress,
+    ...txArgs
+  }: SetContentHashRecordParameters<chain, account, chainOverride>,
+): Promise<SetContentHashRecordReturnType> {
+  const data = setContentHashRecordWriteParameters(
+    clientWithOverrides(client, txArgs),
+    {
+      name,
+      contentHash,
+      resolverAddress,
+    },
+  )
+  const writeContractAction = getAction(client, writeContract, 'writeContract')
+  return writeContractAction({
+    ...data,
+    ...txArgs,
+  } as WriteContractParameters)
+}