@ensdomains/ensjs 3.0.0-alpha.15 → 3.0.0-alpha.18

package/dist/esm/utils/writeTx.mjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/utils/writeTx.ts"],
+  "sourcesContent": ["import type { JsonRpcSigner } from '@ethersproject/providers'\nimport type { PopulatedTransaction } from 'ethers'\n\ntype CustomData = Record<string, any>\n\nconst withCustomData = <T extends object>(\n  tx: T,\n  customData: CustomData | undefined,\n): (T & { customData: CustomData }) | T =>\n  customData ? { ...tx, customData } : tx\n\nexport default (signer: JsonRpcSigner, populate: boolean) =>\n  ({ customData, ...tx }: PopulatedTransaction) =>\n    populate\n      ? withCustomData(tx, customData)\n      : signer.sendTransaction(tx).then((r) => withCustomData(r, customData))\n"],
+  "mappings": ";AAKA,IAAM,iBAAiB,CACrB,IACA,eAEA,aAAa,EAAE,GAAG,IAAI,WAAW,IAAI;AAEvC,IAAO,kBAAQ,CAAC,QAAuB,aACrC,CAAC,EAAE,eAAe,GAAG,MACnB,WACI,eAAe,IAAI,UAAU,IAC7B,OAAO,gBAAgB,EAAE,EAAE,KAAK,CAAC,MAAM,eAAe,GAAG,UAAU,CAAC;",
+  "names": []
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ensdomains/ensjs",
-  "version": "3.0.0-alpha.15",
+  "version": "3.0.0-alpha.18",
   "description": "ENS javascript library for contract interaction",
   "main": "./dist/cjs/index.js",
   "types": "./dist/cjs/index.d.ts",
@@ -10,6 +10,16 @@
       "require": "./dist/cjs/index.js",
       "default": "./dist/esm/index.js"
     },
+    "./utils/*": {
+      "import": "./dist/esm/utils/*",
+      "require": "./dist/cjs/utils/*",
+      "default": "./dist/esm/utils/*"
+    },
+    "./functions/*": {
+      "import": "./dist/esm/functions/*",
+      "require": "./dist/cjs/functions/*",
+      "default": "./dist/esm/functions/*"
+    },
     "./*": {
       "default": "./*"
     }
@@ -47,7 +57,10 @@
     "@types/jest": "^27.4.1",
     "@types/traverse": "^0.6.32",
     "dotenv": "^16.0.0",
+    "esbuild": "^0.15.6",
+    "eslint-plugin-jest": "^27.0.1",
     "ganache": "^7.4.0",
+    "glob": "^8.0.3",
     "hardhat": "^2.10.1",
     "hardhat-abi-exporter": "^2.8.0",
     "hardhat-deploy": "^0.11.12",
@@ -61,7 +74,7 @@
     "ts-jest": "^27.1.4",
     "ts-node": "^10.7.0",
     "typechain": "^8.1.0",
-    "typescript": "^4.6.2",
+    "typescript": "^4.7.4",
     "wait-on": "^6.0.1"
   },
   "peerDependencies": {
@@ -69,6 +82,7 @@
   },
   "scripts": {
     "tenv": "ens-test-env -a",
+    "denv": "pnpm tenv start -ns -nb",
     "generate-types": "ts-node scripts/runTypechain.ts",
     "generate-abis": "hardhat export-abi",
     "start": "ts-node --files src/index.test.ts",
@@ -76,9 +90,9 @@
     "test:watch": "jest --watch --run-in-band",
     "test:specific": "ts-node --files ",
     "clean": "rm -rf ./dist ./README.md ./LICENSE",
-    "build:esm": "tsc --project tsconfig.esm.json",
-    "build:cjs": "tsc --project tsconfig.cjs.json",
-    "build": "pnpm clean && pnpm build:esm && pnpm build:cjs",
+    "lint": "eslint ./src/* --no-error-on-unmatched-pattern",
+    "build:types": "tsc --emitDeclarationOnly --project tsconfig.cjs.json && tsc --emitDeclarationOnly --project tsconfig.esm.json",
+    "build": "pnpm clean && pnpm lint && pnpm build:types && pnpm node esbuild.js",
     "prepublish": "pnpm build && cp ../../README.md ../../LICENSE ./",
     "enode": "ganache --wallet.mnemonic=\"test test test test test test test test test test test junk\" --chain.chainId 1337 --chain.networkId 1337 --chain.time 1659500634000",
     "ver": "pnpm version --no-workspaces-update"

package/src/@types/@ensdomains/ens-contracts.d.ts

@@ -1 +1 @@
-declare module "@ensdomains/ens-contracts"
+declare module '@ensdomains/ens-contracts'

package/src/@types/dns-packet/index.d.ts

@@ -1,114 +1,114 @@
+/* eslint-disable @typescript-eslint/naming-convention */
 declare module 'dns-packet' {
-    const AUTHORITATIVE_ANSWER: number
-    const TRUNCATED_RESPONSE: number
-    const RECURSION_DESIRED: number
-    const RECURSION_AVAILABLE: number
-    const AUTHENTIC_DATA: number
-    const CHECKING_DISABLED: number
-    const DNSSEC_OK: number
-     
-   interface decoder<T> {
-     (buf: Buffer, offset?: number): T
-     bytes: number;
-   }
- 
-   const decode: decoder<Packet>;
- 
-   interface encoder<T> {
-     (packet: T, buf?: Buffer, offset?: number): Buffer
-     bytes: number;
-   }
- 
-   const encode: encoder<Packet>;
- 
-   interface Packet {
-     id?: number
-     type: 'query' | 'response'
-     flags?: number
-     rcode?: string
-     questions: Question[]
-     answers?: Answer[]
-     authorities?: Answer[]
-     additionals?: Answer[]
-   }
-     
-   interface Question {
-     type: string
-     class: string
-     name: string
-   }
- 
-   interface AnswerBase {
-     type: string
-     class: string
-     name: string
-     ttl?: number
-   }
- 
-   interface A extends AnswerBase {
-     type: 'A'
-     data: string
-   }
- 
-   interface Dnskey extends AnswerBase {
-     type: 'DNSKEY'
-     data: {
-       flags: number
-       algorithm: number
-       key: Buffer
-     }
-   }
- 
-   interface Ds extends AnswerBase {
-     type: 'DS'
-     data: {
-       keyTag: number
-       algorithm: number
-       digestType: number
-       digest: Buffer
-     }
-   }
- 
-   interface Opt extends AnswerBase {
-     type: 'OPT'
-     udpPayloadSize?: number
-     extendedRcode?: number
-     ednsVersion?: number
-     flags?: number
-     data?: any
-   }
- 
-   interface Rrsig extends AnswerBase {
-     type: 'RRSIG'
-     data: {
-       typeCovered: string
-       algorithm: number
-       labels: number
-       originalTTL: number
-       expiration: number
-       inception: number
-       keyTag: number
-       signersName: string
-       signature: Buffer
-     }
-   }
- 
-   interface Rtxt extends AnswerBase {
-     type: 'TXT'
-     data: Buffer[]
-   }
- 
-   type Answer = A|Dnskey|Ds|Opt|Rrsig|Rtxt
- 
-   interface Encodable<T> {
-     decode: decoder<T>
-     encode: encoder<T>
-   }
- 
-   const record: (type: string) => Encodable<Answer>
-   const answer: Encodable<Answer>
-   const dnskey: Encodable<Dnskey['data']>
-   const name: Encodable<string>
-   const rrsig: Encodable<Rrsig['data']>
- }
- 
+  const AUTHORITATIVE_ANSWER: number
+  const TRUNCATED_RESPONSE: number
+  const RECURSION_DESIRED: number
+  const RECURSION_AVAILABLE: number
+  const AUTHENTIC_DATA: number
+  const CHECKING_DISABLED: number
+  const DNSSEC_OK: number
+
+  interface decoder<T> {
+    (buf: Buffer, offset?: number): T
+    bytes: number
+  }
+
+  const decode: decoder<Packet>
+
+  interface encoder<T> {
+    (packet: T, buf?: Buffer, offset?: number): Buffer
+    bytes: number
+  }
+
+  const encode: encoder<Packet>
+
+  interface Packet {
+    id?: number
+    type: 'query' | 'response'
+    flags?: number
+    rcode?: string
+    questions: Question[]
+    answers?: Answer[]
+    authorities?: Answer[]
+    additionals?: Answer[]
+  }
+
+  interface Question {
+    type: string
+    class: string
+    name: string
+  }
+
+  interface AnswerBase {
+    type: string
+    class: string
+    name: string
+    ttl?: number
+  }
+
+  interface A extends AnswerBase {
+    type: 'A'
+    data: string
+  }
+
+  interface Dnskey extends AnswerBase {
+    type: 'DNSKEY'
+    data: {
+      flags: number
+      algorithm: number
+      key: Buffer
+    }
+  }
+
+  interface Ds extends AnswerBase {
+    type: 'DS'
+    data: {
+      keyTag: number
+      algorithm: number
+      digestType: number
+      digest: Buffer
+    }
+  }
+
+  interface Opt extends AnswerBase {
+    type: 'OPT'
+    udpPayloadSize?: number
+    extendedRcode?: number
+    ednsVersion?: number
+    flags?: number
+    data?: any
+  }
+
+  interface Rrsig extends AnswerBase {
+    type: 'RRSIG'
+    data: {
+      typeCovered: string
+      algorithm: number
+      labels: number
+      originalTTL: number
+      expiration: number
+      inception: number
+      keyTag: number
+      signersName: string
+      signature: Buffer
+    }
+  }
+
+  interface Rtxt extends AnswerBase {
+    type: 'TXT'
+    data: Buffer[]
+  }
+
+  type Answer = A | Dnskey | Ds | Opt | Rrsig | Rtxt
+
+  interface Encodable<T> {
+    decode: decoder<T>
+    encode: encoder<T>
+  }
+
+  const record: (type: string) => Encodable<Answer>
+  const answer: Encodable<Answer>
+  const dnskey: Encodable<Dnskey['data']>
+  const name: Encodable<string>
+  const rrsig: Encodable<Rrsig['data']>
+}

package/src/GqlManager.test.ts

@@ -1,7 +1,7 @@
+import { parse, print, visit } from 'graphql'
 import traverse from 'traverse'
-import { visit, parse } from 'graphql'
 
-import { requestMiddleware, responseMiddleware, enter } from './GqlManager'
+import { requestMiddleware, responseMiddleware } from './GqlManager'
 import { namehash } from './utils/normalise'
 
 describe('GqlManager', () => {
@@ -38,6 +38,7 @@ query getNames($id: ID!, $expiryDate: Int) {
   const mockRequest = {
     method: 'POST',
     headers: {
+      // eslint-disable-next-line @typescript-eslint/naming-convention
       'Content-Type': 'application/json',
     },
     body: JSON.stringify({ query: queryWithoutId }),
@@ -145,7 +146,8 @@ query getNames($id: ID!, $expiryDate: Int) {
     },
     headers: {
       map: {
-        'content-type': 'application/json',
+        // eslint-disable-next-line @typescript-eslint/naming-convention
+        'Content-Type': 'application/json',
       },
     },
     status: 200,
@@ -153,8 +155,9 @@ query getNames($id: ID!, $expiryDate: Int) {
 
   describe('requestMiddleware', () => {
     it('should add id to a SelectionSet if name is present and id is not', () => {
-      const result = requestMiddleware(visit, parse)(mockRequest)
-      expect(result.body.includes('id')).toBe(true)
+      const result = requestMiddleware(visit, parse, print)(mockRequest)
+      const body = result.body as string
+      expect(body.match(/domain.*id.*id.*domains.*id.*id/)?.length).toBe(1)
     })
   })
   describe('responseMiddleware', () => {

package/src/GqlManager.ts

@@ -1,10 +1,17 @@
-// @ts-nocheck
+import type {
+  Kind,
+  parse as Parse,
+  print as Print,
+  SelectionSetNode,
+  visit as Visit,
+} from 'graphql'
+import type Traverse from 'traverse'
 import { namehash } from './utils/normalise'
 
 const generateSelection = (selection: any) => ({
-  kind: 'Field',
+  kind: 'Field' as Kind.FIELD,
   name: {
-    kind: 'Name',
+    kind: 'Name' as Kind.NAME,
     value: selection,
   },
   arguments: [],
@@ -13,62 +20,78 @@ const generateSelection = (selection: any) => ({
   selectionSet: undefined,
 })
 
-export const enter = (node: any) => {
-  if (node.kind === 'SelectionSet') {
-    const id = node.selections.find((x) => x.name && x.name.value === 'id')
-    const name = node.selections.find((x) => x.name && x.name.value === 'name')
+export const enter = (node: SelectionSetNode) => {
+  let hasName = false
+  let hasId = false
 
-    if (!id && name) {
-      node.selections = [...node.selections, generateSelection('id')]
-      return node
+  for (const selection of node.selections) {
+    if ('name' in selection) {
+      if (selection.name.value === 'name') hasName = true
+      else if (selection.name.value === 'id') hasId = true
     }
   }
+
+  if (hasName && !hasId) {
+    // eslint-disable-next-line no-param-reassign
+    node.selections = [...node.selections, generateSelection('id')]
+    return node
+  }
 }
 
-export const requestMiddleware = (visit, parse) => (request: any) => {
-  const requestBody = JSON.parse(request.body)
-  const rawQuery = requestBody.query
-  const parsedQuery = parse(rawQuery)
-  const updatedQuery = visit(parsedQuery, { enter })
-  const updatedBody = { ...requestBody, query: updatedQuery.loc.source.body }
+export const requestMiddleware =
+  (visit: typeof Visit, parse: typeof Parse, print: typeof Print) =>
+  (request: any) => {
+    const requestBody = JSON.parse(request.body)
+    const rawQuery = requestBody.query
+    const parsedQuery = parse(rawQuery)
+    const updatedQuery = visit(parsedQuery, {
+      // eslint-disable-next-line @typescript-eslint/naming-convention
+      SelectionSet: {
+        enter,
+      },
+    })
 
-  return {
-    ...request,
-    body: JSON.stringify(updatedBody),
+    return {
+      ...request,
+      body: JSON.stringify({ ...requestBody, query: print(updatedQuery) }),
+    }
   }
-}
 
-export const responseMiddleware = (traverse) => (response: any) => {
-  traverse(response).forEach(function (responseItem: any) {
-    if (responseItem instanceof Object && responseItem.name) {
-      //Name already in hashed form
-      if (responseItem.name && responseItem.name.includes('[')) {
-        return
-      }
+export const responseMiddleware =
+  (traverse: typeof Traverse) => (response: any) => {
+    // eslint-disable-next-line func-names
+    traverse(response).forEach(function (responseItem: any) {
+      if (responseItem instanceof Object && responseItem.name) {
+        // Name already in hashed form
+        if (responseItem.name && responseItem.name.includes('[')) {
+          return
+        }
 
-      const hashedName = namehash(responseItem.name)
-      if (responseItem.id !== hashedName) {
-        this.update({ ...responseItem, name: hashedName, invalidName: true })
+        const hashedName = namehash(responseItem.name)
+        if (responseItem.id !== hashedName) {
+          this.update({ ...responseItem, name: hashedName, invalidName: true })
+        }
       }
-    }
-  })
-  return response
-}
+    })
+    return response
+  }
 
 export default class GqlManager {
+  // eslint-disable-next-line class-methods-use-this
   public gql: any = () => null
+
   public client?: any | null = null
 
   public setUrl = async (url: string | null) => {
     if (url) {
-      const [imported, traverse, { visit, parse }] = await Promise.all([
+      const [imported, traverse, { visit, parse, print }] = await Promise.all([
         import('graphql-request'),
         import('traverse'),
         import('graphql/language'),
       ])
 
       this.client = new imported.GraphQLClient(url, {
-        requestMiddleware: requestMiddleware(visit, parse),
+        requestMiddleware: requestMiddleware(visit, parse, print),
         responseMiddleware: responseMiddleware(traverse.default),
       })
       this.gql = imported.gql

package/src/contracts/getContractAddress.ts

@@ -4,6 +4,7 @@ const addresses: Record<
   ContractName,
   Partial<Record<SupportedNetworkId, string>> | string
 > = {
+  /* eslint-disable @typescript-eslint/naming-convention */
   BaseRegistrarImplementation: {
     '1': '0x57f1887a8bf19b14fc0df6fd9b2acc9af147ea85',
     '3': '0x57f1887a8bf19b14fc0df6fd9b2acc9af147ea85',
@@ -34,6 +35,7 @@ const addresses: Record<
     '1': '0x580AF46E06DaaD47eb5940526FD64d95b815Cb70',
     '4': '0x74e20bd2a1fe0cdbe45b9a1d89cb7e0a45b36376',
   },
+  /* eslint-enable @typescript-eslint/naming-convention */
 }
 
 export type ContractAddressFetch = (contractName: ContractName) => string

package/src/contracts/index.ts

@@ -12,6 +12,7 @@ import getUniversalResolver from './universalResolver'
 
 export default class ContractManager {
   private provider: ethers.providers.Provider
+
   private fetchAddress: ContractAddressFetch
 
   constructor(
@@ -40,29 +41,36 @@ export default class ContractManager {
     'PublicResolver',
     getPublicResolver,
   )
+
   public getUniversalResolver = this.generateContractGetter(
     'UniversalResolver',
     getUniversalResolver,
   )
+
   public getRegistry = this.generateContractGetter(
     'ENSRegistryWithFallback',
     getRegistry,
   )
+
   public getReverseRegistrar = this.generateContractGetter(
     'ReverseRegistrar',
     getReverseRegistrar,
   )
+
   public getNameWrapper = this.generateContractGetter(
     'NameWrapper',
     getNameWrapper,
   )
+
   public getBaseRegistrar = this.generateContractGetter(
     'BaseRegistrarImplementation',
     getBaseRegistrar,
   )
+
   public getEthRegistrarController = this.generateContractGetter(
     'ETHRegistrarController',
     getEthRegistrarController,
   )
+
   public getMulticall = this.generateContractGetter('Multicall', getMulticall)
 }

package/src/contracts/multicall.ts

@@ -1,24 +1,5 @@
 import { ethers } from 'ethers'
 import { Multicall__factory } from '../generated/factories/Multicall__factory'
 
-const ABI = [
-  'function aggregate(tuple(address target, bytes callData)[] calls) payable returns (uint256 blockNumber, bytes[] returnData)',
-  'function aggregate3(tuple(address target, bool allowFailure, bytes callData)[] calls) payable returns (tuple(bool success, bytes returnData)[] returnData)',
-  'function aggregate3Value(tuple(address target, bool allowFailure, uint256 value, bytes callData)[] calls) payable returns (tuple(bool success, bytes returnData)[] returnData)',
-  'function blockAndAggregate(tuple(address target, bytes callData)[] calls) payable returns (uint256 blockNumber, bytes32 blockHash, tuple(bool success, bytes returnData)[] returnData)',
-  'function getBasefee() view returns (uint256 basefee)',
-  'function getBlockHash(uint256 blockNumber) view returns (bytes32 blockHash)',
-  'function getBlockNumber() view returns (uint256 blockNumber)',
-  'function getChainId() view returns (uint256 chainid)',
-  'function getCurrentBlockCoinbase() view returns (address coinbase)',
-  'function getCurrentBlockDifficulty() view returns (uint256 difficulty)',
-  'function getCurrentBlockGasLimit() view returns (uint256 gaslimit)',
-  'function getCurrentBlockTimestamp() view returns (uint256 timestamp)',
-  'function getEthBalance(address addr) view returns (uint256 balance)',
-  'function getLastBlockHash() view returns (bytes32 blockHash)',
-  'function tryAggregate(bool requireSuccess, tuple(address target, bytes callData)[] calls) payable returns (tuple(bool success, bytes returnData)[] returnData)',
-  'function tryBlockAndAggregate(bool requireSuccess, tuple(address target, bytes callData)[] calls) payable returns (uint256 blockNumber, bytes32 blockHash, tuple(bool success, bytes returnData)[] returnData)',
-]
-
 export default (provider: ethers.providers.JsonRpcProvider, address: string) =>
   Multicall__factory.connect(address, provider)

package/src/functions/batch.test.ts

@@ -1,18 +1,18 @@
 import { ENS } from '..'
 import setup from '../tests/setup'
 
-let ENSInstance: ENS
+let ensInstance: ENS
 
 beforeAll(async () => {
-  ;({ ENSInstance } = await setup())
+  ;({ ensInstance } = await setup())
 })
 
 describe('batch', () => {
   it('should batch calls together', async () => {
-    const result = await ENSInstance.batch(
-      ENSInstance.getText.batch('with-profile.eth', 'description'),
-      ENSInstance.getAddr.batch('with-profile.eth'),
-      ENSInstance.getName.batch('0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC'),
+    const result = await ensInstance.batch(
+      ensInstance.getText.batch('with-profile.eth', 'description'),
+      ensInstance.getAddr.batch('with-profile.eth'),
+      ensInstance.getName.batch('0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC'),
     )
     expect(result).toBeTruthy()
     if (result) {
@@ -25,8 +25,8 @@ describe('batch', () => {
     }
   })
   it('should batch a single call', async () => {
-    const result = await ENSInstance.batch(
-      ENSInstance.getText.batch('with-profile.eth', 'description'),
+    const result = await ensInstance.batch(
+      ensInstance.getText.batch('with-profile.eth', 'description'),
     )
     expect(result).toBeTruthy()
     if (result) {

package/src/functions/batch.ts

@@ -5,11 +5,11 @@ const raw = async (
   ...items: BatchFunctionResult<RawFunction>[]
 ) => {
   const rawDataArr: { to: string; data: string }[] = await Promise.all(
-    items.map(({ args, raw }, i: number) => {
-      if (!raw) {
+    items.map(({ args, raw: rawRef }, i: number) => {
+      if (!rawRef) {
         throw new Error(`Function ${i} is not batchable`)
       }
-      return raw(...args)
+      return rawRef(...args)
     }),
   )
   return multicallWrapper.raw(rawDataArr)

package/src/functions/batchWrappers.test.ts

@@ -1,29 +1,29 @@
 import { ENS } from '..'
 import setup from '../tests/setup'
 
-let ENSInstance: ENS
+let ensInstance: ENS
 
 beforeAll(async () => {
-  ;({ ENSInstance } = await setup())
+  ;({ ensInstance } = await setup())
 })
 
 describe('batchWrappers', () => {
   it('should batch calls together', async () => {
-    const batch = await ENSInstance.resolverMulticallWrapper.raw([
-      await ENSInstance._getText.raw('with-profile.eth', 'description'),
-      await ENSInstance._getText.raw('with-profile.eth', 'url'),
-      await ENSInstance._getAddr.raw('with-profile.eth'),
+    const batch = await ensInstance.resolverMulticallWrapper.raw([
+      await ensInstance._getText.raw('with-profile.eth', 'description'),
+      await ensInstance._getText.raw('with-profile.eth', 'url'),
+      await ensInstance._getAddr.raw('with-profile.eth'),
     ])
-    const universalResponse = await ENSInstance.universalWrapper(
+    const universalResponse = await ensInstance.universalWrapper(
       'with-profile.eth',
       batch.data,
     )
-    const [batchDecoded] = await ENSInstance.resolverMulticallWrapper.decode(
+    const [batchDecoded] = await ensInstance.resolverMulticallWrapper.decode(
       universalResponse?.data,
     )
-    const decoded1 = await ENSInstance._getText.decode(batchDecoded[0])
-    const decoded2 = await ENSInstance._getText.decode(batchDecoded[1])
-    const decoded3 = await ENSInstance._getAddr.decode(batchDecoded[2])
+    const decoded1 = await ensInstance._getText.decode(batchDecoded[0])
+    const decoded2 = await ensInstance._getText.decode(batchDecoded[1])
+    const decoded3 = await ensInstance._getAddr.decode(batchDecoded[2])
     expect(decoded1).toBe('Hello2')
     expect(decoded2).toBe('twitter.com')
     expect(decoded3).toBe('0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC')