@ensdomains/ensjs 3.0.0-alpha.16 → 3.0.0-alpha.19

package/dist/{esm → types}/index.d.ts

@@ -1,14 +1,14 @@
-import { JsonRpcSigner } from '@ethersproject/providers';
+import type { JsonRpcSigner } from '@ethersproject/providers';
 import { ContractTransaction, ethers, PopulatedTransaction } from 'ethers';
-import ContractManager from './contracts';
 import { getContractAddress as _getContractAddress } from './contracts/getContractAddress';
+import ContractManager from './contracts/index';
 import { SupportedNetworkId } from './contracts/types';
 import type burnFuses from './functions/burnFuses';
 import type commitName from './functions/commitName';
 import type createSubname from './functions/createSubname';
 import type deleteSubname from './functions/deleteSubname';
-import registerName from './functions/registerName';
-import renewName from './functions/renewName';
+import type registerName from './functions/registerName';
+import type renewName from './functions/renewName';
 import type setName from './functions/setName';
 import type setRecord from './functions/setRecord';
 import type setRecords from './functions/setRecords';
@@ -18,6 +18,7 @@ import type transferSubname from './functions/transferSubname';
 import type unwrapName from './functions/unwrapName';
 import type wrapName from './functions/wrapName';
 import GqlManager from './GqlManager';
+export type { Fuse, FuseArrayPossibilities, FuseObj, NamedFusesToBurn, UnnamedFuseType, UnnamedFuseValues, } from './utils/fuses';
 declare type ENSOptions = {
     graphURI?: string | null;
     getContractAddress?: typeof _getContractAddress;
@@ -75,16 +76,6 @@ export declare class ENS {
     contracts?: ContractManager;
     getContractAddress: (networkId: SupportedNetworkId) => import("./contracts/getContractAddress").ContractAddressFetch;
     gqlInstance: GqlManager;
-    fuses: {
-        CAN_DO_EVERYTHING: number;
-        CANNOT_UNWRAP: 1;
-        CANNOT_BURN_FUSES: 2;
-        CANNOT_TRANSFER: 4;
-        CANNOT_SET_RESOLVER: 8;
-        CANNOT_SET_TTL: 16;
-        CANNOT_CREATE_SUBDOMAIN: 32;
-        PARENT_CANNOT_CONTROL: 64;
-    };
     constructor(options?: ENSOptions);
     /**
      * Checks for an initial provider and if it exists, sets it as the provider
@@ -250,25 +241,25 @@ export declare class ENS {
     }>;
     getHistory: (name: string) => Promise<{
         domain: {
-            type: any;
-            blockNumber: any;
-            transactionHash: any;
-            id: any;
-            data: Record<string, any>;
+            type: "Transfer" | "NewOwner" | "NewResolver" | "NewTTL";
+            blockNumber: number;
+            transactionHash: string;
+            id: string;
+            data: object;
         }[];
         registration: {
-            type: any;
-            blockNumber: any;
-            transactionHash: any;
-            id: any;
-            data: Record<string, any>;
+            type: "NameRegistered" | "NameRenewed" | "NameTransferred";
+            blockNumber: number;
+            transactionHash: string;
+            id: string;
+            data: object;
         }[];
         resolver: {
-            type: any;
-            blockNumber: any;
-            transactionHash: any;
-            id: any;
-            data: Record<string, any>;
+            type: "AddrChanged" | "ContenthashChanged" | "InterfaceChanged" | "NameChanged" | "PubkeyChanged" | "TextChanged" | "MulticoinAddrChanged" | "AbiChanged" | "AuthorisationChanged";
+            blockNumber: number;
+            transactionHash: string;
+            id: string;
+            data: object;
         }[];
     } | undefined>;
     getContentHash: GeneratedRawFunction<{
@@ -443,11 +434,11 @@ export declare class ENS {
         decode: ({ contracts }: ENSArgs<"contracts">, data: string) => Promise<ethers.utils.Result | undefined>;
     }>;
     multicallWrapper: GeneratedRawFunction<{
-        raw: ({ contracts }: ENSArgs<"contracts">, transactions: ethers.providers.TransactionRequest[], requireSuccess?: boolean) => Promise<{
+        raw({ contracts }: ENSArgs<"contracts">, transactions: ethers.providers.TransactionRequest[], requireSuccess?: boolean): Promise<{
             to: string;
             data: string;
         }>;
-        decode: ({ contracts }: ENSArgs<"contracts">, data: string) => Promise<any>;
+        decode({ contracts }: ENSArgs<"contracts">, data: string): Promise<any>;
     }>;
     setName: WriteFunction<typeof setName>;
     setRecords: WriteFunction<typeof setRecords>;
@@ -464,4 +455,3 @@ export declare class ENS {
     registerName: WriteFunction<typeof registerName>;
     renewName: WriteFunction<typeof renewName>;
 }
-export {};

package/dist/types/utils/fuses.d.ts

@@ -0,0 +1,40 @@
+export declare const fuseEnum: {
+    readonly CANNOT_UNWRAP: 1;
+    readonly CANNOT_BURN_FUSES: 2;
+    readonly CANNOT_TRANSFER: 4;
+    readonly CANNOT_SET_RESOLVER: 8;
+    readonly CANNOT_SET_TTL: 16;
+    readonly CANNOT_CREATE_SUBDOMAIN: 32;
+    readonly PARENT_CANNOT_CONTROL: 64;
+};
+export declare const unnamedFuses: readonly [128, 256, 512, 1024, 2048, 4096, 8192, 16384, 32768, 65536, 131072, 262144, 524288, 1048576, 2097152, 4194304, 8388608, 16777216, 33554432, 67108864, 134217728, 268435456, 536870912, 1073741824, 2147483648, 4294967296];
+declare const fullFuseEnum: {
+    CAN_DO_EVERYTHING: number;
+    CANNOT_UNWRAP: 1;
+    CANNOT_BURN_FUSES: 2;
+    CANNOT_TRANSFER: 4;
+    CANNOT_SET_RESOLVER: 8;
+    CANNOT_SET_TTL: 16;
+    CANNOT_CREATE_SUBDOMAIN: 32;
+    PARENT_CANNOT_CONTROL: 64;
+};
+export declare type FuseObj = typeof fuseEnum;
+export declare type UnnamedFuseType = typeof unnamedFuses;
+export declare type Fuse = keyof FuseObj;
+export declare type UnnamedFuseValues = UnnamedFuseType[number];
+export declare type FuseArrayPossibilities = [Fuse] | [Fuse, Fuse] | [Fuse, Fuse, Fuse] | [Fuse, Fuse, Fuse, Fuse] | [Fuse, Fuse, Fuse, Fuse, Fuse] | [Fuse, Fuse, Fuse, Fuse, Fuse, Fuse] | [Fuse, Fuse, Fuse, Fuse, Fuse, Fuse, Fuse];
+/**
+ * This type creates a type error if there are any duplicate fuses.
+ * It effectively works like a reduce function, starting with 0 included types, adding a type each time, and then checking for duplicates.
+ *
+ * @template A The array to check for duplicates.
+ * @template B The union of all checked existing types.
+ */
+declare type FusesWithoutDuplicates<A, B = never> = A extends FuseArrayPossibilities ? A extends [infer Head, ...infer Tail] ? Head extends B ? [
+] : [
+    Head,
+    ...FusesWithoutDuplicates<Tail, Head | B>
+] : A : [
+];
+export declare type NamedFusesToBurn = FusesWithoutDuplicates<FuseArrayPossibilities>;
+export default fullFuseEnum;

package/dist/{cjs → types}/utils/registerHelpers.d.ts

@@ -46,9 +46,9 @@ export declare const makeCommitmentData: ({ name, owner, duration, resolver, rec
     secret: string;
 }) => CommitmentTuple;
 export declare const makeRegistrationData: (params: RegistrationParams) => RegistrationTuple;
+export declare const _makeCommitment: (params: CommitmentTuple) => string;
 export declare const makeCommitment: ({ secret, ...inputParams }: CommitmentParams) => {
     secret: string;
     commitment: string;
     wrapperExpiry: number;
 };
-export declare const _makeCommitment: (params: CommitmentTuple) => string;

package/dist/{cjs → types}/utils/writeTx.d.ts

@@ -1,4 +1,4 @@
-import { JsonRpcSigner } from '@ethersproject/providers';
+import type { JsonRpcSigner } from '@ethersproject/providers';
 import type { PopulatedTransaction } from 'ethers';
 declare type CustomData = Record<string, any>;
 declare const _default: (signer: JsonRpcSigner, populate: boolean) => ({ customData, ...tx }: PopulatedTransaction) => {

package/package.json

@@ -1,17 +1,43 @@
 {
   "name": "@ensdomains/ensjs",
-  "version": "3.0.0-alpha.16",
+  "version": "3.0.0-alpha.19",
   "description": "ENS javascript library for contract interaction",
   "main": "./dist/cjs/index.js",
-  "types": "./dist/cjs/index.d.ts",
+  "module": "./dist/esm/index.mjs",
+  "types": "./dist/types/index.d.ts",
   "exports": {
     ".": {
-      "import": "./dist/esm/index.js",
+      "import": "./dist/esm/index.mjs",
       "require": "./dist/cjs/index.js",
-      "default": "./dist/esm/index.js"
+      "default": "./dist/esm/index.mjs"
+    },
+    "./*.js": {
+      "import": "./dist/esm/*.mjs",
+      "require": "./dist/cjs/*.js",
+      "default": "./dist/esm/*.mjs"
+    },
+    "./*.mjs": {
+      "import": "./dist/esm/*.mjs",
+      "require": "./dist/cjs/*.js",
+      "default": "./dist/esm/*.mjs"
     },
     "./*": {
-      "default": "./*"
+      "import": "./dist/esm/*.mjs",
+      "require": "./dist/cjs/*.js",
+      "default": "./dist/esm/*.mjs"
+    }
+  },
+  "typesVersions": {
+    "*": {
+      "contracts/*": [
+        "./dist/types/contracts/*"
+      ],
+      "functions/*": [
+        "./dist/types/functions/*"
+      ],
+      "utils/*": [
+        "./dist/types/utils/*"
+      ]
     }
   },
   "files": [
@@ -35,7 +61,7 @@
   "devDependencies": {
     "@ensdomains/buffer": "^0.0.13",
     "@ensdomains/ens-contracts": "^0.0.12",
-    "@ensdomains/ens-test-env": "0.2.2",
+    "@ensdomains/ens-test-env": "0.2.3",
     "@ethersproject/abi": "^5.6.0",
     "@ethersproject/providers": "^5.6.2",
     "@nomiclabs/hardhat-ethers": "npm:hardhat-deploy-ethers",
@@ -47,7 +73,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 +90,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 +98,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 +106,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.build.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

@@ -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,

package/src/GqlManager.ts

@@ -32,6 +32,7 @@ export const enter = (node: SelectionSetNode) => {
   }
 
   if (hasName && !hasId) {
+    // eslint-disable-next-line no-param-reassign
     node.selections = [...node.selections, generateSelection('id')]
     return node
   }
@@ -44,6 +45,7 @@ export const requestMiddleware =
     const rawQuery = requestBody.query
     const parsedQuery = parse(rawQuery)
     const updatedQuery = visit(parsedQuery, {
+      // eslint-disable-next-line @typescript-eslint/naming-convention
       SelectionSet: {
         enter,
       },
@@ -57,9 +59,10 @@ export const requestMiddleware =
 
 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
+        // Name already in hashed form
         if (responseItem.name && responseItem.name.includes('[')) {
           return
         }
@@ -74,7 +77,9 @@ export const responseMiddleware =
   }
 
 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) => {

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)
 }