@ensdomains/ensjs 3.2.0 → 3.2.1

package/src/contracts/index.ts

@@ -24,12 +24,13 @@ export {
   type WalletWithEns,
 } from './consts.js'
 export {
+  dnsRegistrarErrors,
   dnsRegistrarProveAndClaimSnippet,
   dnsRegistrarProveAndClaimWithResolverSnippet,
 } from './dnsRegistrar.js'
 export {
   dnssecImplAnchorsSnippet,
-  dnssecImplRrDataSnippet,
+  dnssecImplVerifyRrSetSnippet,
 } from './dnssecImpl.js'
 export { erc165SupportsInterfaceSnippet } from './erc165.js'
 export {

package/src/errors/version.ts

@@ -1 +1 @@
-export const version = 'v3.2.0'
+export const version = 'v3.2.1'

package/src/functions/dns/getDnsImportData.ts

@@ -1,16 +1,11 @@
-import type { ProvableAnswer, SignedSet } from '@ensdomains/dnsprovejs'
+import { SignedSet, type ProvableAnswer } from '@ensdomains/dnsprovejs'
 import type * as packet from 'dns-packet'
-import { toType } from 'dns-packet/types.js'
-import { keccak256, toBytes, toHex } from 'viem'
+import { toHex, type Client, type Hex, type Transport } from 'viem'
 import { readContract } from 'viem/actions'
-import type { ClientWithEns } from '../../contracts/consts.js'
-import {
-  dnssecImplAnchorsSnippet,
-  dnssecImplRrDataSnippet,
-} from '../../contracts/dnssecImpl.js'
+import type { ChainWithEns } from '../../contracts/consts.js'
+import { dnssecImplVerifyRrSetSnippet } from '../../contracts/dnssecImpl.js'
 import { getChainContractAddress } from '../../contracts/getChainContractAddress.js'
-import { DnsNewerRecordTypeAvailableError } from '../../errors/dns.js'
-import { packetToBytes } from '../../utils/hexEncodedName.js'
+import { DnsNewerRecordTypeAvailableError } from '../../index.js'
 import type { Endpoint } from './types.js'
 
 export type GetDnsImportDataParameters = {
@@ -21,14 +16,11 @@ export type GetDnsImportDataParameters = {
 }
 
 export type RrSetWithSig = {
-  rrset: Uint8Array
-  sig: Uint8Array
+  rrset: Hex
+  sig: Hex
 }
 
-export type GetDnsImportDataReturnType = {
-  rrsets: RrSetWithSig[]
-  proof: Uint8Array
-}
+export type GetDnsImportDataReturnType = RrSetWithSig[]
 
 // Compares two serial numbers using RFC1982 serial number math.
 const serialNumberGt = (i1: number, i2: number): boolean =>
@@ -38,8 +30,8 @@ const encodeProofs = (
   proofs: SignedSet<packet.Ds | packet.Dnskey | packet.Rtxt>[],
 ): RrSetWithSig[] =>
   proofs.map((proof) => ({
-    rrset: proof.toWire(true),
-    sig: proof.signature.data.signature,
+    rrset: toHex(proof.toWire(true)),
+    sig: toHex(proof.signature.data.signature),
   }))
 
 /**
@@ -63,7 +55,7 @@ const encodeProofs = (
  * })
  */
 const getDnsImportData = async (
-  client: ClientWithEns,
+  client: Client<Transport, ChainWithEns>,
   {
     name,
     endpoint = 'https://cloudflare-dns.com/dns-query',
@@ -81,53 +73,31 @@ const getDnsImportData = async (
     result.proofs as SignedSet<packet.Ds | packet.Dnskey | packet.Rtxt>[]
   ).concat([result.answer])
 
-  const ensDnssecImplAddress = getChainContractAddress({
-    client,
-    contract: 'ensDnssecImpl',
+  const rrsets = encodeProofs(allProofs)
+
+  const [onchainRrData, inception] = await readContract(client, {
+    abi: dnssecImplVerifyRrSetSnippet,
+    address: getChainContractAddress({
+      client,
+      contract: 'ensDnssecImpl',
+    }),
+    functionName: 'verifyRRSet',
+    args: [rrsets],
   })
 
-  for (let i = allProofs.length - 1; i >= 0; i -= 1) {
-    const proof = allProofs[i]
-    const hexEncodedName = toHex(packetToBytes(proof.signature.name))
-    const type = toType(proof.signature.data.typeCovered)
-    // eslint-disable-next-line no-await-in-loop
-    const [inception, expiration, hash] = await readContract(client, {
-      abi: dnssecImplRrDataSnippet,
-      address: ensDnssecImplAddress,
-      functionName: 'rrdata',
-      args: [type, hexEncodedName],
+  const lastProof = allProofs[allProofs.length - 1]
+  if (serialNumberGt(inception, lastProof.signature.data.inception))
+    throw new DnsNewerRecordTypeAvailableError({
+      typeCovered: lastProof.signature.data.typeCovered,
+      signatureName: lastProof.signature.name,
+      onchainInception: inception,
+      dnsInception: lastProof.signature.data.inception,
     })
-    if (serialNumberGt(inception, proof.signature.data.inception))
-      throw new DnsNewerRecordTypeAvailableError({
-        typeCovered: proof.signature.data.typeCovered,
-        signatureName: proof.signature.name,
-        onchainInception: inception,
-        dnsInception: proof.signature.data.inception,
-      })
-    const expired = serialNumberGt(Date.now() / 1000, expiration)
-    const proofHash = keccak256(proof.toWire(false)).slice(0, 42)
-    const isKnownProof = hash === proofHash && !expired
-    if (isKnownProof) {
-      if (i === allProofs.length - 1) {
-        return { rrsets: [], proof: proof.toWire(false) }
-      }
-      return {
-        rrsets: encodeProofs(allProofs.slice(i + 1, allProofs.length)),
-        proof: proof.toWire(false),
-      }
-    }
-  }
 
-  return {
-    rrsets: encodeProofs(allProofs),
-    proof: toBytes(
-      await readContract(client, {
-        abi: dnssecImplAnchorsSnippet,
-        address: ensDnssecImplAddress,
-        functionName: 'anchors',
-      }),
-    ),
-  }
+  if (toHex(lastProof.toWire(false)) !== onchainRrData)
+    throw new Error('Mismatched proof data')
+
+  return rrsets
 }
 
 export default getDnsImportData

package/src/functions/dns/importDnsName.ts

@@ -1,5 +1,4 @@
 import {
-  bytesToHex,
   encodeFunctionData,
   toHex,
   type Account,
@@ -7,6 +6,7 @@ import {
   type Hash,
   type SendTransactionParameters,
   type Transport,
+  type WalletClient,
 } from 'viem'
 import type { ChainWithEns, WalletWithEns } from '../../contracts/consts.js'
 import {
@@ -64,7 +64,7 @@ export const makeFunctionData = <
   TChain extends ChainWithEns,
   TAccount extends Account | undefined,
 >(
-  wallet: WalletWithEns<Transport, TChain, TAccount>,
+  wallet: WalletClient<Transport, TChain, TAccount>,
   {
     name,
     dnsImportData,
@@ -72,10 +72,6 @@ export const makeFunctionData = <
     resolverAddress,
   }: ImportDnsNameDataParameters,
 ): ImportDnsNameDataReturnType => {
-  const data = dnsImportData.rrsets.map((rrset) => ({
-    rrset: bytesToHex(rrset.rrset),
-    sig: bytesToHex(rrset.sig),
-  }))
   const hexEncodedName = toHex(packetToBytes(name))
   const dnsRegistrarAddress = getChainContractAddress({
     client: wallet,
@@ -95,7 +91,7 @@ export const makeFunctionData = <
       data: encodeFunctionData({
         abi: dnsRegistrarProveAndClaimSnippet,
         functionName: 'proveAndClaim',
-        args: [hexEncodedName, data, bytesToHex(dnsImportData.proof)],
+        args: [hexEncodedName, dnsImportData],
       }),
     }
   }
@@ -109,13 +105,7 @@ export const makeFunctionData = <
     data: encodeFunctionData({
       abi: dnsRegistrarProveAndClaimWithResolverSnippet,
       functionName: 'proveAndClaimWithResolver',
-      args: [
-        hexEncodedName,
-        data,
-        bytesToHex(dnsImportData.proof),
-        resolverAddress_,
-        address,
-      ],
+      args: [hexEncodedName, dnsImportData, resolverAddress_, address],
     }),
   }
 }

package/src/functions/public/_getAbi.ts

@@ -19,22 +19,25 @@ import { namehash } from '../../utils/normalise.js'
 export type InternalGetAbiParameters = {
   /** Name to get ABI record for */
   name: string
+  /** Supported content types as bitwise
+   * ID 1: JSON
+   * ID 2: zlib compressed JSON
+   * ID 4: CBOR
+   * ID 8: URI
+   */
+  supportedContentTypes?: bigint
   /** Whether or not to throw decoding errors */
   strict?: boolean
 }
 
 export type InternalGetAbiReturnType = Prettify<DecodedAbi | null>
 
-// Supported content types as bitwise OR
-// ID 1: JSON
-// ID 2: zlib compressed JSON
-// ID 4: CBOR
-// ID 8: URI
-const supportedContentTypes = 0xfn
-
 const encode = (
   _client: ClientWithEns,
-  { name }: Omit<InternalGetAbiParameters, 'strict'>,
+  {
+    name,
+    supportedContentTypes = 0xfn,
+  }: Omit<InternalGetAbiParameters, 'strict'>,
 ): SimpleTransactionRequest => {
   return {
     to: EMPTY_ADDRESS,

package/src/functions/public/getAbiRecord.ts

@@ -26,9 +26,13 @@ export type GetAbiRecordReturnType = Prettify<InternalGetAbiReturnType>
 
 const encode = (
   client: ClientWithEns,
-  { name, gatewayUrls }: Omit<GetAbiRecordParameters, 'strict'>,
+  {
+    name,
+    supportedContentTypes,
+    gatewayUrls,
+  }: Omit<GetAbiRecordParameters, 'strict'>,
 ): SimpleTransactionRequest => {
-  const prData = _getAbi.encode(client, { name })
+  const prData = _getAbi.encode(client, { name, supportedContentTypes })
   return universalWrapper.encode(client, {
     name,
     data: prData.data,

package/src/functions/public/getRecords.ts

@@ -81,20 +81,18 @@ type WithCoinsResult = {
 }
 
 export type GetRecordsReturnType<
-  TTexts extends readonly string[] = readonly [string, ...string[]],
-  TCoins extends readonly (string | number)[] = readonly [
-    string | number,
-    ...(string | number)[],
-  ],
-  TContentHash extends boolean = true,
-  TAbi extends boolean = true,
+  TTexts extends readonly string[] | undefined = readonly string[],
+  TCoins extends readonly (string | number)[] | undefined = readonly (
+    | string
+    | number
+  )[],
+  TContentHash extends boolean | undefined = true,
+  TAbi extends boolean | undefined = true,
 > = Prettify<
   (TContentHash extends true ? WithContentHashResult : {}) &
     (TAbi extends true ? WithAbiResult : {}) &
-    (TTexts extends readonly [string, ...string[]] ? WithTextsResult : {}) &
-    (TCoins extends readonly [string | number, ...(string | number)[]]
-      ? WithCoinsResult
-      : {}) & {
+    (TTexts extends readonly string[] ? WithTextsResult : {}) &
+    (TCoins extends readonly (string | number)[] ? WithCoinsResult : {}) & {
       /** Resolver address used for fetch */
       resolverAddress: Address
     }
@@ -261,8 +259,8 @@ const createEmptyResult = <
   GetRecordsParameters<TTexts, TCoins, TContentHash, TAbi>,
   'texts' | 'coins' | 'abi' | 'contentHash'
 >) => ({
-  ...(texts && texts.length > 0 ? { texts: [] as DecodedText[] } : {}),
-  ...(coins && coins.length > 0 ? { coins: [] as DecodedAddr[] } : {}),
+  ...(texts ? { texts: [] as DecodedText[] } : {}),
+  ...(coins ? { coins: [] as DecodedAddr[] } : {}),
   ...(contentHash ? { contentHash: null } : {}),
   ...(abi ? { abi: null } : {}),
 })
@@ -347,13 +345,13 @@ const createRecordResult = (
 }
 
 const decode = async <
-  const TTexts extends readonly string[] = readonly string[],
-  const TCoins extends readonly (string | number)[] = readonly (
+  const TTexts extends readonly string[] | undefined = readonly string[],
+  const TCoins extends readonly (string | number)[] | undefined = readonly (
     | string
     | number
   )[],
-  const TContentHash extends boolean = true,
-  const TAbi extends boolean = true,
+  const TContentHash extends boolean | undefined = undefined,
+  const TAbi extends boolean | undefined = undefined,
 >(
   client: ClientWithEns,
   data: Hex | BaseError,
@@ -434,13 +432,10 @@ type BatchableFunctionObject = {
   encode: EncoderFunction
   decode: DecoderFunction
   batch: <
-    const TTexts extends readonly string[] = readonly string[],
-    const TCoins extends readonly (string | number)[] = readonly (
-      | string
-      | number
-    )[],
-    const TContentHash extends boolean = true,
-    const TAbi extends boolean = true,
+    const TTexts extends readonly string[] | undefined = undefined,
+    const TCoins extends readonly (string | number)[] | undefined = undefined,
+    const TContentHash extends boolean | undefined = undefined,
+    const TAbi extends boolean | undefined = undefined,
   >(
     args: GetRecordsParameters<TTexts, TCoins, TContentHash, TAbi>,
   ) => {
@@ -477,13 +472,10 @@ type BatchableFunctionObject = {
  * // { texts: [{ key: 'com.twitter', value: 'ensdomains' }, { key: 'com.github', value: 'ensdomains' }], coins: [{ id: 60, name: 'ETH', value: '0xFe89cc7aBB2C4183683ab71653C4cdc9B02D44b7' }], contentHash: { protocolType: 'ipns', decoded: 'k51qzi5uqu5djdczd6zw0grmo23j2vkj9uzvujencg15s5rlkq0ss4ivll8wqw' } }
  */
 const getRecords = generateFunction({ encode, decode }) as (<
-  const TTexts extends readonly string[] = readonly string[],
-  const TCoins extends readonly (string | number)[] = readonly (
-    | string
-    | number
-  )[],
-  const TContentHash extends boolean = true,
-  const TAbi extends boolean = true,
+  const TTexts extends readonly string[] | undefined = undefined,
+  const TCoins extends readonly (string | number)[] | undefined = undefined,
+  const TContentHash extends boolean | undefined = undefined,
+  const TAbi extends boolean | undefined = undefined,
 >(
   client: ClientWithEns,
   {

package/src/types.ts

@@ -11,6 +11,16 @@ export type Prettify<T> = {
   [K in keyof T]: T[K]
 } & {}
 
+type AssignI<T, U> = {
+  [K in keyof T as K extends keyof U
+    ? U[K] extends void
+      ? never
+      : K
+    : K]: K extends keyof U ? U[K] : T[K]
+}
+
+export type Assign<T, U> = AssignI<T, U> & U
+
 export type SimpleTransactionRequest = {
   [P in keyof Pick<TransactionRequest, 'to' | 'data'>]-?: Exclude<
     TransactionRequest[P],

package/src/utils/encoders/encodeAbi.ts

@@ -2,7 +2,7 @@ import { bytesToHex, stringToHex, type Hex } from 'viem'
 import { UnknownContentTypeError } from '../../errors/utils.js'
 import type { Prettify } from '../../types.js'
 
-type AbiEncodeAs = 'json' | 'zlib' | 'cbor' | 'uri'
+export type AbiEncodeAs = 'json' | 'zlib' | 'cbor' | 'uri'
 
 type AbiContentType = 1 | 2 | 4 | 8
 

package/src/utils/generateRecordCallArray.ts

@@ -26,7 +26,7 @@ export type RecordOptions = Prettify<{
   /** Array of coin records */
   coins?: Omit<EncodeSetAddrParameters, 'namehash'>[]
   /** ABI value */
-  abi?: EncodedAbi
+  abi?: EncodedAbi | EncodedAbi[]
 }>
 
 export const generateRecordCallArray = ({
@@ -49,8 +49,11 @@ export const generateRecordCallArray = ({
   }
 
   if (abi !== undefined) {
-    const data = encodeSetAbi({ namehash, ...abi } as EncodeSetAbiParameters)
-    if (data) calls.push(data)
+    const abis = Array.isArray(abi) ? abi : [abi]
+    for (const abi_ of abis) {
+      const data = encodeSetAbi({ namehash, ...abi_ } as EncodeSetAbiParameters)
+      if (data) calls.push(data)
+    }
   }
 
   if (texts && texts.length > 0) {

package/src/utils/generateSupportedContentTypes.test.ts.ts

@@ -0,0 +1,24 @@
+import { generateSupportedContentTypes } from './generateSupportedContentTypes.js'
+
+type FunctionParameters = Parameters<typeof generateSupportedContentTypes>
+type EncodeAsParameter = FunctionParameters[0]
+
+describe('generateSupportedContentTypes', () => {
+  it.each([
+    ['json', 1n],
+    ['zlib', 2n],
+    ['cbor', 4n],
+    ['uri', 8n],
+    ['unknown', 0n],
+    [['json', 'zlib'], 3n],
+    [['zlib', 'cbor'], 6n],
+    [['cbor', 'uri'], 12n],
+    [['json', 'zlib', 'cbor', 'uri'], 15n],
+  ] as [EncodeAsParameter, bigint][])(
+    'should return the correct bitwise value supportedContentTypes %p (%p)',
+    (encodedAs, expected) => {
+      const result = generateSupportedContentTypes(encodedAs)
+      expect(result).toEqual(expected)
+    },
+  )
+})

package/src/utils/generateSupportedContentTypes.ts

@@ -0,0 +1,21 @@
+import type { AbiEncodeAs } from './encoders/encodeAbi.js'
+
+const abiEncodeAsMap: { [key in AbiEncodeAs]: bigint } = {
+  json: 1n,
+  zlib: 2n,
+  cbor: 4n,
+  uri: 8n,
+} as const
+
+export const generateSupportedContentTypes = (
+  encodeAsItemOrList: AbiEncodeAs | AbiEncodeAs[],
+): bigint => {
+  const encodeAsList = Array.isArray(encodeAsItemOrList)
+    ? encodeAsItemOrList
+    : [encodeAsItemOrList]
+  return encodeAsList.reduce<bigint>((result, encodeAs) => {
+    const contentType = abiEncodeAsMap[encodeAs]
+    if (contentType) result |= contentType
+    return result
+  }, 0n)
+}

package/src/utils/index.ts

@@ -133,3 +133,4 @@ export {
   expiryToBigInt,
   wrappedLabelLengthCheck,
 } from './wrapper.js'
+export { generateSupportedContentTypes } from './generateSupportedContentTypes.js'

package/src/utils/registerHelpers.ts

@@ -103,7 +103,7 @@ export const makeCommitmentTuple = ({
     reverseRecord &&
     !coins.find(
       (c) =>
-        c.coin === 'ETH' ||
+        (typeof c.coin === 'string' && c.coin.toLowerCase() === 'eth') ||
         (typeof c.coin === 'string' ? parseInt(c.coin) === 60 : c.coin === 60),
     )
   ) {