@ensdomains/ensjs 3.0.0-alpha.2 → 3.0.0-alpha.20

package/dist/cjs/utils/validation.js

@@ -1,73 +1,86 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseInputType = exports.validateTLD = exports.validateName = void 0;
-const utils_1 = require("ethers/lib/utils");
-const labels_1 = require("./labels");
-const normalise_1 = require("./normalise");
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var validation_exports = {};
+__export(validation_exports, {
+  parseInputType: () => parseInputType,
+  validateName: () => validateName,
+  validateTLD: () => validateTLD
+});
+module.exports = __toCommonJS(validation_exports);
+var import_utils = require("ethers/lib/utils");
+var import_labels = require("./labels");
+var import_normalise = require("./normalise");
 const validateName = (name) => {
-    const nameArray = name.split('.');
-    const hasEmptyLabels = nameArray.some((label) => label.length == 0);
-    if (hasEmptyLabels)
-        throw new Error('Name cannot have empty labels');
-    const normalizedArray = nameArray.map((label) => {
-        if (label === '[root]') {
-            return label;
-        }
-        else {
-            return (0, labels_1.isEncodedLabelhash)(label) ? label : (0, normalise_1.normalise)(label);
-        }
-    });
-    const normalizedName = normalizedArray.join('.');
-    (0, labels_1.saveName)(normalizedName);
-    return normalizedName;
+  const nameArray = name.split(".");
+  const hasEmptyLabels = nameArray.some((label) => label.length === 0);
+  if (hasEmptyLabels)
+    throw new Error("Name cannot have empty labels");
+  const normalizedArray = nameArray.map((label) => {
+    if (label === "[root]") {
+      return label;
+    }
+    return (0, import_labels.isEncodedLabelhash)(label) ? label : (0, import_normalise.normalise)(label);
+  });
+  const normalizedName = normalizedArray.join(".");
+  (0, import_labels.saveName)(normalizedName);
+  return normalizedName;
 };
-exports.validateName = validateName;
 const validateTLD = (name) => {
-    const labels = name.split('.');
-    return (0, exports.validateName)(labels[labels.length - 1]);
+  const labels = name.split(".");
+  return validateName(labels[labels.length - 1]);
 };
-exports.validateTLD = validateTLD;
 const parseInputType = (input) => {
-    const validTLD = (0, exports.validateTLD)(input);
-    let regex = /[^.]+$/;
-    try {
-        (0, exports.validateName)(input);
-    }
-    catch (e) {
-        return {
-            type: 'unknown',
-        };
-    }
-    if (input.indexOf('.') !== -1) {
-        const termArray = input.split('.');
-        const tld = input.match(regex) ? input.match(regex)[0] : '';
-        if (validTLD) {
-            if (tld === 'eth' && [...termArray[termArray.length - 2]].length < 3) {
-                // code-point length
-                return {
-                    type: 'name',
-                    info: 'short',
-                };
-            }
-            return {
-                type: 'name',
-                info: 'supported',
-            };
-        }
-        return {
-            type: 'name',
-            info: 'unsupported',
-        };
-    }
-    else if ((0, utils_1.isAddress)(input)) {
-        return {
-            type: 'address',
-        };
-    }
-    else {
+  const validTLD = validateTLD(input);
+  const regex = /[^.]+$/;
+  try {
+    validateName(input);
+  } catch (e) {
+    return {
+      type: "unknown"
+    };
+  }
+  if (input.indexOf(".") !== -1) {
+    const termArray = input.split(".");
+    const tld = input.match(regex) ? input.match(regex)[0] : "";
+    if (validTLD) {
+      if (tld === "eth" && [...termArray[termArray.length - 2]].length < 3) {
         return {
-            type: 'label',
+          type: "name",
+          info: "short"
         };
+      }
+      return {
+        type: "name",
+        info: "supported"
+      };
     }
+    return {
+      type: "name",
+      info: "unsupported"
+    };
+  }
+  if ((0, import_utils.isAddress)(input)) {
+    return {
+      type: "address"
+    };
+  }
+  return {
+    type: "label"
+  };
 };
-exports.parseInputType = parseInputType;

package/dist/cjs/utils/wrapperExpiry.js

@@ -0,0 +1,44 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var wrapperExpiry_exports = {};
+__export(wrapperExpiry_exports, {
+  MAX_EXPIRY: () => MAX_EXPIRY,
+  makeExpiry: () => makeExpiry
+});
+module.exports = __toCommonJS(wrapperExpiry_exports);
+var import_ethers = require("ethers");
+const MAX_EXPIRY = import_ethers.BigNumber.from(2).pow(64).sub(1);
+const makeExpiry = async ({ getExpiry }, name, expiry) => {
+  if (expiry) {
+    if (expiry instanceof Date) {
+      return import_ethers.BigNumber.from(expiry.getTime() / 1e3);
+    }
+    if (expiry instanceof import_ethers.BigNumber) {
+      return expiry;
+    }
+    return import_ethers.BigNumber.from(expiry);
+  }
+  if (name.endsWith(".eth")) {
+    const expResponse = await getExpiry(name);
+    if (!expResponse?.expiry)
+      throw new Error("Couldn't get expiry for name, please provide one.");
+    return import_ethers.BigNumber.from(expResponse.expiry.getTime() / 1e3);
+  }
+  return MAX_EXPIRY;
+};

package/dist/cjs/utils/writeTx.js

@@ -0,0 +1,25 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var writeTx_exports = {};
+__export(writeTx_exports, {
+  default: () => writeTx_default
+});
+module.exports = __toCommonJS(writeTx_exports);
+const withCustomData = (tx, customData) => customData ? { ...tx, customData } : tx;
+var writeTx_default = (signer, populate) => ({ customData, ...tx }) => populate ? withCustomData(tx, customData) : signer.sendTransaction(tx).then((r) => withCustomData(r, customData));

package/dist/esm/GqlManager.mjs

@@ -0,0 +1,85 @@
+// src/GqlManager.ts
+import { namehash } from "./utils/normalise.mjs";
+var generateSelection = (selection) => ({
+  kind: "Field",
+  name: {
+    kind: "Name",
+    value: selection
+  },
+  arguments: [],
+  directives: [],
+  alias: void 0,
+  selectionSet: void 0
+});
+var enter = (node) => {
+  let hasName = false;
+  let hasId = false;
+  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) {
+    node.selections = [...node.selections, generateSelection("id")];
+    return node;
+  }
+};
+var requestMiddleware = (visit, parse, print) => (request) => {
+  const requestBody = JSON.parse(request.body);
+  const rawQuery = requestBody.query;
+  const parsedQuery = parse(rawQuery);
+  const updatedQuery = visit(parsedQuery, {
+    SelectionSet: {
+      enter
+    }
+  });
+  return {
+    ...request,
+    body: JSON.stringify({ ...requestBody, query: print(updatedQuery) })
+  };
+};
+var responseMiddleware = (traverse) => (response) => {
+  traverse(response).forEach(function(responseItem) {
+    if (responseItem instanceof Object && responseItem.name) {
+      if (responseItem.name && responseItem.name.includes("[")) {
+        return;
+      }
+      const hashedName = namehash(responseItem.name);
+      if (responseItem.id !== hashedName) {
+        this.update({ ...responseItem, name: hashedName, invalidName: true });
+      }
+    }
+  });
+  return response;
+};
+var GqlManager = class {
+  gql = () => null;
+  client = null;
+  setUrl = async (url) => {
+    if (url) {
+      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, print),
+        responseMiddleware: responseMiddleware(traverse.default)
+      });
+      this.gql = imported.gql;
+    } else {
+      this.client = null;
+      this.gql = () => null;
+    }
+  };
+  request = (...arg) => this.client ? this.client.request(...arg) : null;
+};
+export {
+  GqlManager as default,
+  enter,
+  requestMiddleware,
+  responseMiddleware
+};

package/dist/esm/contracts/baseRegistrar.mjs

@@ -0,0 +1,6 @@
+// src/contracts/baseRegistrar.ts
+import { BaseRegistrarImplementation__factory } from "../generated/factories/BaseRegistrarImplementation__factory.mjs";
+var baseRegistrar_default = (provider, address) => BaseRegistrarImplementation__factory.connect(address, provider);
+export {
+  baseRegistrar_default as default
+};

package/dist/esm/contracts/ethRegistrarController.mjs

@@ -0,0 +1,6 @@
+// src/contracts/ethRegistrarController.ts
+import { ETHRegistrarController__factory } from "../generated/factories/ETHRegistrarController__factory.mjs";
+var ethRegistrarController_default = (provider, address) => ETHRegistrarController__factory.connect(address, provider);
+export {
+  ethRegistrarController_default as default
+};

package/dist/esm/contracts/getContractAddress.mjs

@@ -0,0 +1,45 @@
+// src/contracts/getContractAddress.ts
+var addresses = {
+  BaseRegistrarImplementation: {
+    "1": "0x57f1887a8bf19b14fc0df6fd9b2acc9af147ea85",
+    "3": "0x57f1887a8bf19b14fc0df6fd9b2acc9af147ea85",
+    "4": "0x57f1887a8bf19b14fc0df6fd9b2acc9af147ea85",
+    "5": "0x57f1887a8bf19b14fc0df6fd9b2acc9af147ea85"
+  },
+  ETHRegistrarController: {
+    "1": "0x283af0b28c62c092c9727f1ee09c02ca627eb7f5",
+    "3": "0x283af0b28c62c092c9727f1ee09c02ca627eb7f5",
+    "4": "0x283af0b28c62c092c9727f1ee09c02ca627eb7f5",
+    "5": "0x283af0b28c62c092c9727f1ee09c02ca627eb7f5"
+  },
+  Multicall: "0xcA11bde05977b3631167028862bE2a173976CA11",
+  NameWrapper: "0x0000000000000000000000000000000000000000",
+  PublicResolver: {
+    "1": "0x4976fb03C32e5B8cfe2b6cCB31c09Ba78EBaBa41"
+  },
+  ENSRegistryWithFallback: {
+    "1": "0x00000000000c2e074ec69a0dfb2997ba6c7d2e1e",
+    "3": "0x00000000000c2e074ec69a0dfb2997ba6c7d2e1e",
+    "4": "0x00000000000c2e074ec69a0dfb2997ba6c7d2e1e",
+    "5": "0x00000000000c2e074ec69a0dfb2997ba6c7d2e1e"
+  },
+  ReverseRegistrar: {
+    "1": "0x084b1c3C81545d370f3634392De611CaaBFf8148"
+  },
+  UniversalResolver: {
+    "1": "0x580AF46E06DaaD47eb5940526FD64d95b815Cb70",
+    "4": "0x74e20bd2a1fe0cdbe45b9a1d89cb7e0a45b36376"
+  }
+};
+var getContractAddress = (networkId) => (contractName) => {
+  try {
+    return typeof addresses[contractName] === "string" ? addresses[contractName] : addresses[contractName][networkId];
+  } catch {
+    throw new Error(
+      `No address for contract ${contractName} on network ${networkId}`
+    );
+  }
+};
+export {
+  getContractAddress
+};

package/dist/esm/contracts/index.mjs

@@ -0,0 +1,56 @@
+// src/contracts/index.ts
+import getBaseRegistrar from "./baseRegistrar.mjs";
+import getEthRegistrarController from "./ethRegistrarController.mjs";
+import getMulticall from "./multicall.mjs";
+import getNameWrapper from "./nameWrapper.mjs";
+import getPublicResolver from "./publicResolver.mjs";
+import getRegistry from "./registry.mjs";
+import getReverseRegistrar from "./reverseRegistrar.mjs";
+import getUniversalResolver from "./universalResolver.mjs";
+var ContractManager = class {
+  provider;
+  fetchAddress;
+  constructor(provider, fetchAddress) {
+    this.provider = provider;
+    this.fetchAddress = fetchAddress;
+  }
+  generateContractGetter = (name, func) => {
+    return async (passedProvider, address) => {
+      const inputAddress = address || this.fetchAddress(name);
+      const provider = passedProvider || this.provider;
+      return func(provider, inputAddress);
+    };
+  };
+  getPublicResolver = this.generateContractGetter(
+    "PublicResolver",
+    getPublicResolver
+  );
+  getUniversalResolver = this.generateContractGetter(
+    "UniversalResolver",
+    getUniversalResolver
+  );
+  getRegistry = this.generateContractGetter(
+    "ENSRegistryWithFallback",
+    getRegistry
+  );
+  getReverseRegistrar = this.generateContractGetter(
+    "ReverseRegistrar",
+    getReverseRegistrar
+  );
+  getNameWrapper = this.generateContractGetter(
+    "NameWrapper",
+    getNameWrapper
+  );
+  getBaseRegistrar = this.generateContractGetter(
+    "BaseRegistrarImplementation",
+    getBaseRegistrar
+  );
+  getEthRegistrarController = this.generateContractGetter(
+    "ETHRegistrarController",
+    getEthRegistrarController
+  );
+  getMulticall = this.generateContractGetter("Multicall", getMulticall);
+};
+export {
+  ContractManager as default
+};

package/dist/esm/contracts/multicall.mjs

@@ -0,0 +1,6 @@
+// src/contracts/multicall.ts
+import { Multicall__factory } from "../generated/factories/Multicall__factory.mjs";
+var multicall_default = (provider, address) => Multicall__factory.connect(address, provider);
+export {
+  multicall_default as default
+};

package/dist/esm/contracts/nameWrapper.mjs

@@ -0,0 +1,6 @@
+// src/contracts/nameWrapper.ts
+import { NameWrapper__factory } from "../generated/factories/NameWrapper__factory.mjs";
+var nameWrapper_default = (provider, address) => NameWrapper__factory.connect(address, provider);
+export {
+  nameWrapper_default as default
+};

package/dist/esm/contracts/publicResolver.mjs

@@ -0,0 +1,6 @@
+// src/contracts/publicResolver.ts
+import { PublicResolver__factory } from "../generated/factories/PublicResolver__factory.mjs";
+var publicResolver_default = (provider, address) => PublicResolver__factory.connect(address, provider);
+export {
+  publicResolver_default as default
+};

package/dist/esm/contracts/registry.mjs

@@ -0,0 +1,6 @@
+// src/contracts/registry.ts
+import { ENSRegistry__factory } from "../generated/factories/ENSRegistry__factory.mjs";
+var registry_default = (provider, address) => ENSRegistry__factory.connect(address, provider);
+export {
+  registry_default as default
+};

package/dist/esm/contracts/reverseRegistrar.mjs

@@ -0,0 +1,6 @@
+// src/contracts/reverseRegistrar.ts
+import { ReverseRegistrar__factory } from "../generated/factories/ReverseRegistrar__factory.mjs";
+var reverseRegistrar_default = (provider, address) => ReverseRegistrar__factory.connect(address, provider);
+export {
+  reverseRegistrar_default as default
+};

package/dist/esm/contracts/universalResolver.mjs

@@ -0,0 +1,6 @@
+// src/contracts/universalResolver.ts
+import { UniversalResolver__factory } from "../generated/factories/UniversalResolver__factory.mjs";
+var universalResolver_default = (provider, address) => UniversalResolver__factory.connect(address, provider);
+export {
+  universalResolver_default as default
+};

package/dist/esm/functions/batch.mjs

@@ -0,0 +1,29 @@
+// src/functions/batch.ts
+var raw = async ({ multicallWrapper }, ...items) => {
+  const rawDataArr = await Promise.all(
+    items.map(({ args, raw: rawRef }, i) => {
+      if (!rawRef) {
+        throw new Error(`Function ${i} is not batchable`);
+      }
+      return rawRef(...args);
+    })
+  );
+  return multicallWrapper.raw(rawDataArr);
+};
+var decode = async ({ multicallWrapper }, data, ...items) => {
+  const response = await multicallWrapper.decode(data);
+  if (!response)
+    return;
+  return Promise.all(
+    response.map(
+      (ret, i) => items[i].decode(ret.returnData, ...items[i].args)
+    )
+  );
+};
+var batch_default = {
+  raw,
+  decode
+};
+export {
+  batch_default as default
+};

package/dist/esm/functions/batchWrappers.mjs

@@ -0,0 +1,82 @@
+// src/functions/batchWrappers.ts
+import { hexEncodeName } from "../utils/hexEncodedName.mjs";
+var universalWrapper = {
+  raw: async ({ contracts }, name, data) => {
+    const universalResolver = await contracts?.getUniversalResolver();
+    return {
+      to: universalResolver.address,
+      data: universalResolver.interface.encodeFunctionData("resolve", [
+        hexEncodeName(name),
+        data
+      ])
+    };
+  },
+  decode: async ({ contracts }, data) => {
+    const universalResolver = await contracts?.getUniversalResolver();
+    const response = universalResolver.interface.decodeFunctionResult(
+      "resolve",
+      data
+    );
+    if (!response || !response[0]) {
+      return;
+    }
+    return { data: response[0], resolver: response[1] };
+  }
+};
+var resolverMulticallWrapper = {
+  raw: async ({ contracts }, data) => {
+    const publicResolver = await contracts?.getPublicResolver();
+    const formattedDataArr = data.map((item) => item.data);
+    return {
+      to: publicResolver.address,
+      data: publicResolver.interface.encodeFunctionData("multicall", [
+        formattedDataArr
+      ])
+    };
+  },
+  decode: async ({ contracts }, data) => {
+    const publicResolver = await contracts?.getPublicResolver();
+    const response = publicResolver.interface.decodeFunctionResult(
+      "multicall",
+      data
+    );
+    if (!response) {
+      return;
+    }
+    return response;
+  }
+};
+var multicallWrapper = {
+  async raw({ contracts }, transactions, requireSuccess = false) {
+    const multicall = await contracts?.getMulticall();
+    return {
+      to: multicall.address,
+      data: multicall.interface.encodeFunctionData("tryAggregate", [
+        requireSuccess,
+        transactions.map((tx) => ({
+          target: tx.to,
+          callData: tx.data
+        }))
+      ])
+    };
+  },
+  async decode({ contracts }, data) {
+    if (!data)
+      return;
+    const multicall = await contracts?.getMulticall();
+    try {
+      const [result] = multicall.interface.decodeFunctionResult(
+        "tryAggregate",
+        data
+      );
+      return result;
+    } catch {
+      return;
+    }
+  }
+};
+export {
+  multicallWrapper,
+  resolverMulticallWrapper,
+  universalWrapper
+};

package/dist/esm/functions/burnFuses.mjs

@@ -0,0 +1,52 @@
+// src/functions/burnFuses.ts
+import {
+  fuseEnum,
+  unnamedFuses
+} from "../utils/fuses.mjs";
+import { namehash } from "../utils/normalise.mjs";
+async function burnFuses_default({ contracts, signer }, name, props) {
+  const isNumber = "fuseNumberToBurn" in props;
+  const hasNamedArray = "namedFusesToBurn" in props;
+  const hasUnnamedArray = "unnamedFusesToBurn" in props;
+  let encodedFuses = 0;
+  if (isNumber) {
+    if (props.fuseNumberToBurn > 2 ** 32 || props.fuseNumberToBurn < 1) {
+      throw new Error(
+        `Fuse number must be limited to uint32, ${props.fuseNumberToBurn} was too ${props.fuseNumberToBurn < 1 ? "low" : "high"}.`
+      );
+    } else if (props.fuseNumberToBurn % 1 !== 0) {
+      throw new Error(
+        `Fuse number must be an integer, ${props.fuseNumberToBurn} was not.`
+      );
+    }
+    encodedFuses = props.fuseNumberToBurn;
+  } else {
+    if (!hasNamedArray && !hasUnnamedArray) {
+      throw new Error("Please provide fuses to burn");
+    }
+    if (hasNamedArray) {
+      for (const fuse of props.namedFusesToBurn) {
+        if (!(fuse in fuseEnum)) {
+          throw new Error(`${fuse} is not a valid named fuse.`);
+        }
+        encodedFuses |= fuseEnum[fuse];
+      }
+    }
+    if (hasUnnamedArray) {
+      for (const fuse of props.unnamedFusesToBurn) {
+        if (!unnamedFuses.includes(fuse)) {
+          throw new Error(
+            `${fuse} is not a valid unnamed fuse. If you are trying to burn a named fuse, use the namedFusesToBurn property.`
+          );
+        }
+        encodedFuses |= fuse;
+      }
+    }
+  }
+  const nameWrapper = (await contracts.getNameWrapper()).connect(signer);
+  const hash = namehash(name);
+  return nameWrapper.populateTransaction.setFuses(hash, encodedFuses);
+}
+export {
+  burnFuses_default as default
+};

package/dist/esm/functions/commitName.mjs

@@ -0,0 +1,28 @@
+// src/functions/commitName.ts
+import { makeCommitment } from "../utils/registerHelpers.mjs";
+async function commitName_default({ contracts }, name, { resolverAddress, ...params }) {
+  const labels = name.split(".");
+  if (labels.length !== 2 || labels[1] !== "eth")
+    throw new Error("Currently only .eth TLD registrations are supported");
+  const controller = await contracts.getEthRegistrarController();
+  const resolver = await contracts.getPublicResolver(
+    void 0,
+    resolverAddress
+  );
+  const { secret, commitment, wrapperExpiry } = makeCommitment({
+    name,
+    resolver,
+    ...params
+  });
+  return {
+    ...await controller.populateTransaction.commit(commitment),
+    customData: {
+      secret,
+      commitment,
+      wrapperExpiry
+    }
+  };
+}
+export {
+  commitName_default as default
+};