@ensdomains/ensjs 3.0.0-alpha.1 → 3.0.0-alpha.12

package/README.md

@@ -9,6 +9,8 @@ We also use undeployed contracts under the hood, so this **will not** work on an
 
 Given the current development status, we're actively seeking feedback so feel free to create an issue or PR if you notice something!
 
+If you are looking for documentation for **version 2**, it an be found [here](https://github.com/ensdomains/ensjs#readme).
+
 ## Features
 
 - Dynamically load **everything**

package/dist/cjs/GqlManager.d.ts

@@ -1,3 +1,6 @@
+export declare const enter: (node: any) => any;
+export declare const requestMiddleware: (visit: any, parse: any) => (request: any) => any;
+export declare const responseMiddleware: (traverse: any) => (response: any) => any;
 export default class GqlManager {
     gql: any;
     client?: any | null;

package/dist/cjs/GqlManager.js

@@ -23,13 +23,73 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.responseMiddleware = exports.requestMiddleware = exports.enter = void 0;
+// @ts-nocheck
+const normalise_1 = require("./utils/normalise");
+const generateSelection = (selection) => ({
+    kind: 'Field',
+    name: {
+        kind: 'Name',
+        value: selection,
+    },
+    arguments: [],
+    directives: [],
+    alias: undefined,
+    selectionSet: undefined,
+});
+const enter = (node) => {
+    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');
+        if (!id && name) {
+            node.selections = [...node.selections, generateSelection('id')];
+            return node;
+        }
+    }
+};
+exports.enter = enter;
+const requestMiddleware = (visit, parse) => (request) => {
+    const requestBody = JSON.parse(request.body);
+    const rawQuery = requestBody.query;
+    const parsedQuery = parse(rawQuery);
+    const updatedQuery = visit(parsedQuery, { enter: exports.enter });
+    const updatedBody = { ...requestBody, query: updatedQuery.loc.source.body };
+    return {
+        ...request,
+        body: JSON.stringify(updatedBody),
+    };
+};
+exports.requestMiddleware = requestMiddleware;
+const responseMiddleware = (traverse) => (response) => {
+    traverse(response).forEach(function (responseItem) {
+        if (responseItem instanceof Object && responseItem.name) {
+            //Name already in hashed form
+            if (responseItem.name && responseItem.name.includes('[')) {
+                return;
+            }
+            const hashedName = (0, normalise_1.namehash)(responseItem.name);
+            if (responseItem.id !== hashedName) {
+                this.update({ ...responseItem, name: hashedName, invalidName: true });
+            }
+        }
+    });
+    return response;
+};
+exports.responseMiddleware = responseMiddleware;
 class GqlManager {
     gql = () => null;
     client = null;
     setUrl = async (url) => {
         if (url) {
-            const imported = await Promise.resolve().then(() => __importStar(require('graphql-request')));
-            this.client = new imported.GraphQLClient(url);
+            const [imported, traverse, { visit, parse }] = await Promise.all([
+                Promise.resolve().then(() => __importStar(require('graphql-request'))),
+                Promise.resolve().then(() => __importStar(require('traverse'))),
+                Promise.resolve().then(() => __importStar(require('graphql/language'))),
+            ]);
+            this.client = new imported.GraphQLClient(url, {
+                requestMiddleware: (0, exports.requestMiddleware)(visit, parse),
+                responseMiddleware: (0, exports.responseMiddleware)(traverse.default),
+            });
             this.gql = imported.gql;
         }
         else {

package/dist/cjs/contracts/baseRegistrar.d.ts

@@ -1,3 +1,3 @@
 import { ethers } from 'ethers';
-declare const _default: (provider: ethers.providers.JsonRpcProvider, address: string) => import("../generated/BaseRegistrarImplementation").BaseRegistrarImplementation;
+declare const _default: (provider: ethers.providers.JsonRpcProvider, address: string) => import("../generated").BaseRegistrarImplementation;
 export default _default;

package/dist/cjs/contracts/index.d.ts

@@ -7,10 +7,10 @@ export default class ContractManager {
     private generateContractGetter;
     getPublicResolver: (passedProvider?: any, address?: string | undefined) => Promise<import("../generated").PublicResolver>;
     getUniversalResolver: (passedProvider?: any, address?: string | undefined) => Promise<import("../generated").UniversalResolver>;
-    getRegistry: (passedProvider?: any, address?: string | undefined) => Promise<import("../generated/ENSRegistry").ENSRegistry>;
+    getRegistry: (passedProvider?: any, address?: string | undefined) => Promise<import("../generated").ENSRegistry>;
     getReverseRegistrar: (passedProvider?: any, address?: string | undefined) => Promise<import("../generated").ReverseRegistrar>;
     getNameWrapper: (passedProvider?: any, address?: string | undefined) => Promise<import("../generated").NameWrapper>;
-    getBaseRegistrar: (passedProvider?: any, address?: string | undefined) => Promise<import("../generated/BaseRegistrarImplementation").BaseRegistrarImplementation>;
+    getBaseRegistrar: (passedProvider?: any, address?: string | undefined) => Promise<import("../generated").BaseRegistrarImplementation>;
     getEthRegistrarController: (passedProvider?: any, address?: string | undefined) => Promise<import("../generated").ETHRegistrarController>;
-    getMulticall: (passedProvider?: any, address?: string | undefined) => Promise<import("../generated/Multicall").Multicall>;
+    getMulticall: (passedProvider?: any, address?: string | undefined) => Promise<import("../generated").Multicall>;
 }

package/dist/cjs/contracts/multicall.d.ts

@@ -1,3 +1,3 @@
 import { ethers } from 'ethers';
-declare const _default: (provider: ethers.providers.JsonRpcProvider, address: string) => import("../generated/Multicall").Multicall;
+declare const _default: (provider: ethers.providers.JsonRpcProvider, address: string) => import("../generated").Multicall;
 export default _default;

package/dist/cjs/contracts/registry.d.ts

@@ -1,3 +1,3 @@
 import { ethers } from 'ethers';
-declare const _default: (provider: ethers.providers.JsonRpcProvider, address: string) => import("../generated/ENSRegistry").ENSRegistry;
+declare const _default: (provider: ethers.providers.JsonRpcProvider, address: string) => import("../generated").ENSRegistry;
 export default _default;

package/dist/cjs/functions/burnFuses.d.ts

@@ -1,4 +1,5 @@
-import { ethers } from 'ethers';
 import { ENSArgs } from '..';
 import { FuseOptions } from '../@types/FuseOptions';
-export default function ({ contracts, provider }: ENSArgs<'contracts' | 'provider'>, name: string, fusesToBurn: FuseOptions): Promise<ethers.ContractTransaction>;
+export default function ({ contracts, signer }: ENSArgs<'contracts' | 'signer'>, name: string, { fusesToBurn, }: {
+    fusesToBurn: FuseOptions;
+}): Promise<import("ethers").PopulatedTransaction>;

package/dist/cjs/functions/burnFuses.js

@@ -3,16 +3,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const ethers_1 = require("ethers");
 const generateFuseInput_1 = __importDefault(require("../utils/generateFuseInput"));
-async function default_1({ contracts, provider }, name, fusesToBurn) {
-    const signer = provider?.getSigner();
-    if (!signer) {
-        throw new Error('No signer found');
-    }
+const normalise_1 = require("../utils/normalise");
+async function default_1({ contracts, signer }, name, { fusesToBurn, }) {
     const nameWrapper = (await contracts?.getNameWrapper()).connect(signer);
-    const namehash = ethers_1.ethers.utils.namehash(name);
+    const hash = (0, normalise_1.namehash)(name);
     const encodedFuses = (0, generateFuseInput_1.default)(fusesToBurn);
-    return nameWrapper.burnFuses(namehash, encodedFuses);
+    return nameWrapper.populateTransaction.setFuses(hash, encodedFuses);
 }
 exports.default = default_1;

package/dist/cjs/functions/createSubname.d.ts

@@ -1,19 +1,17 @@
 import { ethers } from 'ethers';
 import { ENSArgs } from '..';
 import { FuseOptions } from '../@types/FuseOptions';
+import { Expiry } from '../utils/wrapperExpiry';
 declare type BaseArgs = {
-    name: string;
     owner: string;
     resolverAddress?: string;
     contract: 'registry' | 'nameWrapper';
-    options?: {
-        addressOrIndex?: string | number;
-    };
 };
 declare type NameWrapperArgs = {
     contract: 'nameWrapper';
     fuses?: FuseOptions;
+    expiry?: Expiry;
 } & BaseArgs;
 declare type Args = BaseArgs | NameWrapperArgs;
-export default function ({ contracts, provider }: ENSArgs<'contracts' | 'provider'>, { name, owner, resolverAddress, contract, options, ...wrapperArgs }: Args): Promise<ethers.ContractTransaction>;
+export default function ({ contracts, signer, getExpiry, }: ENSArgs<'contracts' | 'signer' | 'getExpiry'>, name: string, { owner, resolverAddress, contract, ...wrapperArgs }: Args): Promise<ethers.PopulatedTransaction>;
 export {};

package/dist/cjs/functions/createSubname.js

@@ -5,11 +5,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const ethers_1 = require("ethers");
 const generateFuseInput_1 = __importDefault(require("../utils/generateFuseInput"));
-async function default_1({ contracts, provider }, { name, owner, resolverAddress, contract, options, ...wrapperArgs }) {
-    const signer = provider?.getSigner(options?.addressOrIndex);
-    if (!signer) {
-        throw new Error('No signer found');
-    }
+const normalise_1 = require("../utils/normalise");
+const wrapperExpiry_1 = require("../utils/wrapperExpiry");
+async function default_1({ contracts, signer, getExpiry, }, name, { owner, resolverAddress, contract, ...wrapperArgs }) {
     const labels = name.split('.');
     if (labels.length === 1) {
         throw new Error('Subnames in ENS.js can only be created for 2LDs, not TLDs');
@@ -22,18 +20,19 @@ async function default_1({ contracts, provider }, { name, owner, resolverAddress
     }
     const label = labels.shift();
     const labelhash = ethers_1.ethers.utils.solidityKeccak256(['string'], [label]);
-    const parentNodehash = ethers_1.ethers.utils.namehash(labels.join('.'));
+    const parentNodehash = (0, normalise_1.namehash)(labels.join('.'));
     switch (contract) {
         case 'registry': {
             const registry = (await contracts?.getRegistry()).connect(signer);
-            return registry.setSubnodeRecord(parentNodehash, labelhash, owner, resolverAddress, 0);
+            return registry.populateTransaction.setSubnodeRecord(parentNodehash, labelhash, owner, resolverAddress, 0);
         }
         case 'nameWrapper': {
             const nameWrapper = (await contracts?.getNameWrapper()).connect(signer);
+            const expiry = await (0, wrapperExpiry_1.makeExpiry)({ getExpiry }, name, 'expiry' in wrapperArgs ? wrapperArgs.expiry : undefined);
             const generatedFuses = 'fuses' in wrapperArgs && wrapperArgs.fuses
                 ? (0, generateFuseInput_1.default)(wrapperArgs.fuses)
                 : '0';
-            return nameWrapper.setSubnodeRecord(parentNodehash, label, owner, resolverAddress, 0, generatedFuses);
+            return nameWrapper.populateTransaction.setSubnodeRecord(parentNodehash, label, owner, resolverAddress, 0, generatedFuses, expiry);
         }
         default: {
             throw new Error(`Unknown contract: ${contract}`);

package/dist/cjs/functions/deleteSubname.d.ts

@@ -1,4 +1,4 @@
 import { ENSArgs } from '..';
-export default function ({ contracts, provider, transferSubname, }: ENSArgs<'contracts' | 'provider' | 'transferSubname'>, name: string, contract: 'registry' | 'nameWrapper', options?: {
-    addressOrIndex?: string | number;
-}): Promise<import("ethers").ContractTransaction>;
+export default function ({ transferSubname, signer }: ENSArgs<'transferSubname' | 'signer'>, name: string, { contract, }: {
+    contract: 'registry' | 'nameWrapper';
+}): Promise<import("ethers").PopulatedTransaction>;

package/dist/cjs/functions/deleteSubname.js

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-async function default_1({ contracts, provider, transferSubname, }, name, contract, options) {
-    return transferSubname(name, contract, '0x0000000000000000000000000000000000000000', options);
+async function default_1({ transferSubname, signer }, name, { contract, }) {
+    return transferSubname.populateTransaction(name, {
+        contract,
+        owner: '0x0000000000000000000000000000000000000000',
+        signer,
+    });
 }
 exports.default = default_1;

package/dist/cjs/functions/getDNSOwner.d.ts

@@ -0,0 +1,7 @@
+import * as packet from 'dns-packet';
+export declare function encodeURLParams(p: {
+    [key: string]: string;
+}): string;
+export declare const getDNS: (q: packet.Packet) => Promise<packet.Packet>;
+export declare const dnsQuery: (qtype: string, qname: string) => Promise<packet.Packet>;
+export default function (_: any, dnsName: string): Promise<any>;

package/dist/cjs/functions/getDNSOwner.js

@@ -0,0 +1,81 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.dnsQuery = exports.getDNS = exports.encodeURLParams = void 0;
+const packet = __importStar(require("dns-packet"));
+function encodeURLParams(p) {
+    return Object.entries(p)
+        .map((kv) => kv.map(encodeURIComponent).join('='))
+        .join('&');
+}
+exports.encodeURLParams = encodeURLParams;
+const getDNS = async (q) => {
+    const response = await global.fetch(`https://cloudflare-dns.com/dns-query?${encodeURLParams({
+        ct: 'application/dns-udpwireformat',
+        dns: packet.encode(q)?.toString('base64'),
+        ts: Date.now().toString(),
+    })}`);
+    const arrayBuffer = await response.arrayBuffer();
+    // @ts-ignore:next-line
+    const fromArrayBuffer = Buffer.from(arrayBuffer);
+    return packet.decode(fromArrayBuffer);
+};
+exports.getDNS = getDNS;
+const dnsQuery = async (qtype, qname) => {
+    const query = {
+        type: 'query',
+        id: 1,
+        flags: packet.RECURSION_DESIRED,
+        questions: [
+            {
+                type: qtype,
+                class: 'IN',
+                name: qname,
+            },
+        ],
+        additionals: [
+            {
+                type: 'OPT',
+                class: 'IN',
+                name: '.',
+                udpPayloadSize: 4096,
+                flags: packet.DNSSEC_OK,
+            },
+        ],
+        answers: [],
+    };
+    const response = await (0, exports.getDNS)(query);
+    if (response.rcode !== 'NOERROR') {
+        throw new Error(`DNS query failed: ${response.rcode}`);
+    }
+    return response;
+};
+exports.dnsQuery = dnsQuery;
+async function default_1(_, dnsName) {
+    const result = await (0, exports.dnsQuery)('TXT', `_ens.${dnsName}`);
+    const address = result?.answers?.[0]?.data?.[0]?.toString()?.split('=')?.[1];
+    return address;
+}
+exports.default = default_1;

package/dist/cjs/functions/getExpiry.d.ts

@@ -1,10 +1,17 @@
 import { ENSArgs } from '..';
+declare type ContractOption = 'registrar' | 'nameWrapper';
+declare type Args = {
+    contract?: ContractOption;
+};
 declare const _default: {
-    raw: ({ contracts, multicallWrapper }: ENSArgs<"contracts" | "multicallWrapper">, name: string) => Promise<{
+    raw: (ensArgs: ENSArgs<"contracts" | "multicallWrapper">, name: string, { contract }?: Args) => Promise<{
         to: string;
         data: string;
     }>;
-    decode: ({ contracts, multicallWrapper }: ENSArgs<"contracts" | "multicallWrapper">, data: string) => Promise<{
+    decode: (ensArgs: ENSArgs<"contracts" | "multicallWrapper">, data: string, name: string, { contract }?: Args) => Promise<{
+        expiry: Date;
+        gracePeriod: null;
+    } | {
         expiry: Date | null;
         gracePeriod: number;
     } | undefined>;

package/dist/cjs/functions/getExpiry.js

@@ -1,12 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("ethers/lib/utils");
-const raw = async ({ contracts, multicallWrapper }, name) => {
-    const baseRegistrar = await contracts?.getBaseRegistrar();
-    const labels = name.split('.');
+const normalise_1 = require("../utils/normalise");
+const getRegistrarExpiry = async ({ contracts, multicallWrapper }, labels) => {
     if (labels.length > 2 || labels[1] !== 'eth') {
-        throw new Error('Only .eth names have expiry dates');
+        throw new Error('Only .eth names have expiry dates on the registrar');
     }
+    const baseRegistrar = await contracts?.getBaseRegistrar();
     const expiryCall = baseRegistrar.interface.encodeFunctionData('nameExpires', [
         (0, utils_1.solidityKeccak256)(['string'], [labels[0]]),
     ]);
@@ -22,9 +22,32 @@ const raw = async ({ contracts, multicallWrapper }, name) => {
         },
     ]);
 };
-const decode = async ({ contracts, multicallWrapper }, data) => {
-    if (data === null)
-        return;
+const getWrapperExpiry = async ({ contracts }, labels) => {
+    const nameWrapper = await contracts?.getNameWrapper();
+    const expiryCall = nameWrapper.interface.encodeFunctionData('getData', [
+        (0, normalise_1.namehash)(labels.join('.')),
+    ]);
+    return {
+        to: nameWrapper.address,
+        data: expiryCall,
+    };
+};
+const getContractToUse = (contract, labels) => {
+    if (contract)
+        return contract;
+    if (labels.length === 2 && labels[1] === 'eth') {
+        return 'registrar';
+    }
+    return 'nameWrapper';
+};
+const raw = async (ensArgs, name, { contract } = {}) => {
+    const labels = name.split('.');
+    const contractToUse = getContractToUse(contract, labels);
+    return contractToUse === 'nameWrapper'
+        ? getWrapperExpiry(ensArgs, labels)
+        : getRegistrarExpiry(ensArgs, labels);
+};
+const decodeRegistrarExpiry = async ({ contracts, multicallWrapper }, data) => {
     const result = await multicallWrapper.decode(data);
     const baseRegistrar = await contracts?.getBaseRegistrar();
     try {
@@ -39,6 +62,28 @@ const decode = async ({ contracts, multicallWrapper }, data) => {
         return;
     }
 };
+const decodeWrapperExpiry = async ({ contracts }, data) => {
+    const nameWrapper = await contracts?.getNameWrapper();
+    try {
+        const [_owner, _fuses, expiry] = nameWrapper.interface.decodeFunctionResult('getData', data);
+        return {
+            expiry: new Date(expiry * 1000),
+            gracePeriod: null,
+        };
+    }
+    catch {
+        return;
+    }
+};
+const decode = async (ensArgs, data, name, { contract } = {}) => {
+    if (data === null)
+        return;
+    const labels = name.split('.');
+    const contractToUse = getContractToUse(contract, labels);
+    return contractToUse === 'nameWrapper'
+        ? decodeWrapperExpiry(ensArgs, data)
+        : decodeRegistrarExpiry(ensArgs, data);
+};
 exports.default = {
     raw,
     decode,

package/dist/cjs/functions/getFuses.d.ts

@@ -7,10 +7,9 @@ declare const _default: {
     }>;
     decode: ({ contracts }: ENSArgs<"contracts">, data: string, name: string) => Promise<{
         fuseObj: {
-            [k: string]: any;
+            [k: string]: boolean;
         };
-        vulnerability: any;
-        vulnerableNode: null;
+        expiryDate: Date;
         rawFuses: BigNumber;
     } | undefined>;
 };

package/dist/cjs/functions/getFuses.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const ethers_1 = require("ethers");
 const fuses_1 = require("../utils/fuses");
+const normalise_1 = require("../utils/normalise");
 const NameSafety = [
     'Safe',
     'RegistrantNotWrapped',
@@ -14,14 +15,15 @@ const raw = async ({ contracts }, name) => {
     return {
         to: nameWrapper.address,
         data: nameWrapper.interface.encodeFunctionData('getFuses', [
-            ethers_1.ethers.utils.namehash(name),
+            (0, normalise_1.namehash)(name),
         ]),
     };
 };
 const decode = async ({ contracts }, data, name) => {
     const nameWrapper = await contracts?.getNameWrapper();
     try {
-        const [fuses, vulnerability, vulnerableNode] = nameWrapper.interface.decodeFunctionResult('getFuses', data);
+        const [_fuses, expiry] = nameWrapper.interface.decodeFunctionResult('getFuses', data);
+        const fuses = ethers_1.BigNumber.from(_fuses);
         const fuseObj = Object.fromEntries(Object.keys(fuses_1.testable).map((fuseEnum) => [
             fuseEnum
                 .toLowerCase()
@@ -34,20 +36,10 @@ const decode = async ({ contracts }, data, name) => {
         else {
             fuseObj.canDoEverything = false;
         }
-        let returnVulnerableNode = null;
-        if (ethers_1.utils.hexStripZeros(vulnerableNode) !== '0x') {
-            name.split('.').forEach((label, index, arr) => {
-                const node = arr.slice(index).join('.');
-                const nodehash = ethers_1.utils.namehash(node);
-                if (nodehash === vulnerableNode) {
-                    returnVulnerableNode = node;
-                }
-            });
-        }
+        const expiryDate = new Date(expiry * 1000);
         return {
             fuseObj,
-            vulnerability: NameSafety[vulnerability] || vulnerability,
-            vulnerableNode: returnVulnerableNode,
+            expiryDate,
             rawFuses: fuses,
         };
     }

package/dist/cjs/functions/getHistory.d.ts

@@ -22,33 +22,3 @@ export declare function getHistory({ gqlInstance }: ENSArgs<'gqlInstance'>, name
         data: Record<string, any>;
     }[];
 } | undefined>;
-export declare function getHistoryWithDetail({ contracts, gqlInstance, provider, }: ENSArgs<'contracts' | 'gqlInstance' | 'provider'>, name: string): Promise<{
-    domain: {
-        type: any;
-        blockNumber: any;
-        transactionHash: any;
-        id: any;
-        data: Record<string, any>;
-    }[];
-    registration: {
-        type: any;
-        blockNumber: any;
-        transactionHash: any;
-        id: any;
-        data: Record<string, any>;
-    }[];
-    resolver: {
-        type: any;
-        blockNumber: any;
-        transactionHash: any;
-        id: any;
-        data: Record<string, any>;
-    }[];
-} | undefined>;
-export declare function getHistoryDetailForTransactionHash({ contracts, provider }: ENSArgs<'contracts' | 'provider'>, hash: string, indexInTransaction?: number): Promise<({
-    key: any;
-    value: any;
-} | undefined)[] | {
-    key: any;
-    value: any;
-} | undefined>;