@ensdomains/ensjs 3.0.0-alpha.6 → 3.0.0-alpha.7

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/utils/normalise.d.ts

@@ -1,2 +1,2 @@
 export declare const normalise: (name: string) => any;
-export declare const namehash: (inputName: string) => string;
+export declare const namehash: (name: string) => string;

package/dist/cjs/utils/normalise.js

@@ -6,17 +6,24 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.namehash = exports.normalise = void 0;
 const utils_1 = require("ethers/lib/utils");
 const uts46bundle_js_1 = __importDefault(require("idna-uts46-hx/uts46bundle.js"));
+const labels_1 = require("./labels");
 const zeros = new Uint8Array(32);
 zeros.fill(0);
 const normalise = (name) => name ? uts46bundle_js_1.default.toUnicode(name, { useStd3ASCII: true }) : name;
 exports.normalise = normalise;
-const namehash = (inputName) => {
+const namehash = (name) => {
     let result = zeros;
-    const name = (0, exports.normalise)(inputName);
     if (name) {
         const labels = name.split('.');
         for (var i = labels.length - 1; i >= 0; i--) {
-            const labelSha = (0, utils_1.keccak256)((0, utils_1.toUtf8Bytes)(labels[i]));
+            let labelSha;
+            if ((0, labels_1.isEncodedLabelhash)(labels[i])) {
+                labelSha = (0, labels_1.decodeLabelhash)(labels[i]);
+            }
+            else {
+                const normalised = (0, exports.normalise)(labels[i]);
+                labelSha = (0, utils_1.keccak256)((0, utils_1.toUtf8Bytes)(normalised));
+            }
             result = (0, utils_1.keccak256)((0, utils_1.concat)([result, labelSha]));
         }
     }

package/dist/esm/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/esm/GqlManager.js

@@ -1,11 +1,67 @@
+// @ts-nocheck
+import { namehash } from './utils/normalise';
+const generateSelection = (selection) => ({
+    kind: 'Field',
+    name: {
+        kind: 'Name',
+        value: selection,
+    },
+    arguments: [],
+    directives: [],
+    alias: undefined,
+    selectionSet: undefined,
+});
+export 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;
+        }
+    }
+};
+export const requestMiddleware = (visit, parse) => (request) => {
+    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 };
+    return {
+        ...request,
+        body: JSON.stringify(updatedBody),
+    };
+};
+export 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 = namehash(responseItem.name);
+            if (responseItem.id !== hashedName) {
+                this.update({ ...responseItem, name: hashedName, invalidName: true });
+            }
+        }
+    });
+    return response;
+};
 export default class GqlManager {
     constructor() {
         this.gql = () => null;
         this.client = null;
         this.setUrl = async (url) => {
             if (url) {
-                const imported = await import('graphql-request');
-                this.client = new imported.GraphQLClient(url);
+                const [imported, traverse, { visit, parse }] = await Promise.all([
+                    import('graphql-request'),
+                    import('traverse'),
+                    import('graphql/language'),
+                ]);
+                this.client = new imported.GraphQLClient(url, {
+                    requestMiddleware: requestMiddleware(visit, parse),
+                    responseMiddleware: responseMiddleware(traverse.default),
+                });
                 this.gql = imported.gql;
             }
             else {

package/dist/esm/utils/normalise.d.ts

@@ -1,2 +1,2 @@
 export declare const normalise: (name: string) => any;
-export declare const namehash: (inputName: string) => string;
+export declare const namehash: (name: string) => string;

package/dist/esm/utils/normalise.js

@@ -1,15 +1,22 @@
 import { concat, hexlify, keccak256, toUtf8Bytes } from 'ethers/lib/utils';
 import uts46 from 'idna-uts46-hx/uts46bundle.js';
+import { decodeLabelhash, isEncodedLabelhash } from './labels';
 const zeros = new Uint8Array(32);
 zeros.fill(0);
 export const normalise = (name) => name ? uts46.toUnicode(name, { useStd3ASCII: true }) : name;
-export const namehash = (inputName) => {
+export const namehash = (name) => {
     let result = zeros;
-    const name = normalise(inputName);
     if (name) {
         const labels = name.split('.');
         for (var i = labels.length - 1; i >= 0; i--) {
-            const labelSha = keccak256(toUtf8Bytes(labels[i]));
+            let labelSha;
+            if (isEncodedLabelhash(labels[i])) {
+                labelSha = decodeLabelhash(labels[i]);
+            }
+            else {
+                const normalised = normalise(labels[i]);
+                labelSha = keccak256(toUtf8Bytes(normalised));
+            }
             result = keccak256(concat([result, labelSha]));
         }
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ensdomains/ensjs",
-  "version": "3.0.0-alpha.6",
+  "version": "3.0.0-alpha.7",
   "description": "ENS javascript library for contract interaction",
   "main": "./dist/cjs/index.js",
   "types": "./dist/cjs/index.d.ts",
@@ -46,8 +46,9 @@
     "dns-packet": "^5.3.1",
     "ethers": "^5.6.1",
     "graphql": "^16.3.0",
-    "graphql-request": "^4.1.0",
-    "idna-uts46-hx": "3.4.0"
+    "graphql-request": "next",
+    "idna-uts46-hx": "3.4.0",
+    "traverse": "^0.6.6"
   },
   "devDependencies": {
     "@ensdomains/buffer": "^0.0.13",
@@ -61,6 +62,7 @@
     "@typechain/ethers-v5": "^10.0.0",
     "@types/bn.js": "^5.1.0",
     "@types/jest": "^27.4.1",
+    "@types/traverse": "^0.6.32",
     "dotenv": "^16.0.0",
     "ens-contracts": "github:ensdomains/ens-contracts#head=master&commit=3ecc56b14beb4aae8296f8a94f7c0d095e62fd93",
     "hardhat": "^2.9.3",
@@ -81,5 +83,5 @@
   "peerDependencies": {
     "ethers": "*"
   },
-  "stableVersion": "3.0.0-alpha.5"
+  "stableVersion": "3.0.0-alpha.6"
 }

package/src/GqlManager.test.ts

@@ -0,0 +1,170 @@
+import traverse from 'traverse'
+import { visit, parse } from 'graphql'
+
+import { requestMiddleware, responseMiddleware, enter } from './GqlManager'
+import { namehash } from './utils/normalise'
+
+describe('GqlManager', () => {
+  const queryWithoutId = `
+query getNames($id: ID!, $expiryDate: Int) {
+    account(id: $id) {
+      registrations(first: 1000, where: { expiryDate_gt: $expiryDate }) {
+        registrationDate
+        expiryDate
+        domain {
+          labelName
+          labelhash
+          name
+          isMigrated
+          parent {
+            name
+          }
+        }
+      }
+      domains(first: 1000) {
+        labelName
+        labelhash
+        name
+        isMigrated
+        parent {
+          name
+        }
+        createdAt
+      }
+    }
+  }
+`
+
+  const mockRequest = {
+    method: 'POST',
+    headers: {
+      'Content-Type': 'application/json',
+    },
+    body: JSON.stringify({ query: queryWithoutId }),
+  }
+
+  const mockResponse = {
+    data: {
+      account: {
+        registrations: [
+          {
+            registrationDate: '1659245504',
+            expiryDate: '1690781504',
+            domain: {
+              id: '0xb1ccf7f6bb648f39ba48bf80f4a8a4522f474ee7d1edd6ea65f7fa51fe8b1612',
+              labelName: 'randydandy',
+              labelhash:
+                '0x63fd5bfdd0b1eb9f4c33c209b7c3e7dcb87a761d926a65e267f7cb99ee313ddd',
+              name: '0xde2551f43e950a2a4d4e6052f25edc450c48a5338faa27f09d1ee99ca9dc04fd',
+              isMigrated: true,
+              parent: {
+                name: '0x93cdeb708b7545dc668eb9280176169d1c33cfd8ed6f04690a0bcc88a93fc4ae',
+                invalidName: true,
+              },
+              invalidName: true,
+            },
+          },
+          {
+            registrationDate: '1635284756',
+            expiryDate: '1666841708',
+            domain: {
+              id: '0xde2551f43e950a2a4d4e6052f25edc450c48a5338faa27f09d1ee99ca9dc04fd',
+              labelName: 'randydandy',
+              labelhash:
+                '0x6a877a8d92ad83c8d044d0c5b69aa0da3050f4d653dcc149fca952d6439e4105',
+              name: 'randydandy.eth',
+              isMigrated: true,
+              parent: {
+                name: '0x93cdeb708b7545dc668eb9280176169d1c33cfd8ed6f04690a0bcc88a93fc4ae',
+                invalidName: true,
+              },
+            },
+          },
+          {
+            registrationDate: '1659250465',
+            expiryDate: '1690786465',
+            domain: {
+              id: '0xaf119e72f050e5acad6b2d97826a7afb45afe9407376a2ab8240b62173b2d7c2',
+              labelName: 'nullbyte',
+              labelhash:
+                '0xc8985f8323b3dc707003a6ef5b379d9e8a058b6d6bcc2cfb307c61ca36920e27',
+              name: '0xb54c7c79c89d571f1fbf4c67f524e336a04441eeee4d76f156e835da99a46ddb',
+              isMigrated: true,
+              parent: {
+                name: '0x93cdeb708b7545dc668eb9280176169d1c33cfd8ed6f04690a0bcc88a93fc4ae',
+                invalidName: true,
+              },
+              invalidName: true,
+            },
+          },
+        ],
+        domains: [
+          {
+            id: '0xaf119e72f050e5acad6b2d97826a7afb45afe9407376a2ab8240b62173b2d7c2',
+            labelName: 'nullbyte',
+            labelhash:
+              '0xc8985f8323b3dc707003a6ef5b379d9e8a058b6d6bcc2cfb307c61ca36920e27',
+            name: '0xb54c7c79c89d571f1fbf4c67f524e336a04441eeee4d76f156e835da99a46ddb',
+            isMigrated: true,
+            parent: {
+              name: '0x93cdeb708b7545dc668eb9280176169d1c33cfd8ed6f04690a0bcc88a93fc4ae',
+              invalidName: true,
+            },
+            createdAt: '1659250465',
+            invalidName: true,
+          },
+          {
+            id: '0xb1ccf7f6bb648f39ba48bf80f4a8a4522f474ee7d1edd6ea65f7fa51fe8b1612',
+            labelName: 'randydandy',
+            labelhash:
+              '0x63fd5bfdd0b1eb9f4c33c209b7c3e7dcb87a761d926a65e267f7cb99ee313ddd',
+            name: '0xde2551f43e950a2a4d4e6052f25edc450c48a5338faa27f09d1ee99ca9dc04fd',
+            isMigrated: true,
+            parent: {
+              name: '0x93cdeb708b7545dc668eb9280176169d1c33cfd8ed6f04690a0bcc88a93fc4ae',
+              invalidName: true,
+            },
+            createdAt: '1659245504',
+            invalidName: true,
+          },
+          {
+            id: '0xde2551f43e950a2a4d4e6052f25edc450c48a5338faa27f09d1ee99ca9dc04fd',
+            labelName: 'randydandy',
+            labelhash:
+              '0x6a877a8d92ad83c8d044d0c5b69aa0da3050f4d653dcc149fca952d6439e4105',
+            name: 'randydandy.eth',
+            isMigrated: true,
+            parent: {
+              name: '0x93cdeb708b7545dc668eb9280176169d1c33cfd8ed6f04690a0bcc88a93fc4ae',
+              invalidName: true,
+            },
+            createdAt: '1635284756',
+          },
+        ],
+      },
+    },
+    headers: {
+      map: {
+        'content-type': 'application/json',
+      },
+    },
+    status: 200,
+  }
+
+  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)
+    })
+  })
+  describe('responseMiddleware', () => {
+    it('should replace name with the namehash when there is an invalid name and id combo', () => {
+      const result = responseMiddleware(traverse)(mockResponse)
+      expect(result.data.account.domains[0].name).toBe(
+        namehash(
+          '0xb54c7c79c89d571f1fbf4c67f524e336a04441eeee4d76f156e835da99a46ddb',
+        ),
+      )
+    })
+  })
+})

package/src/GqlManager.ts

@@ -1,11 +1,76 @@
+// @ts-nocheck
+import { namehash } from './utils/normalise'
+
+const generateSelection = (selection: any) => ({
+  kind: 'Field',
+  name: {
+    kind: 'Name',
+    value: selection,
+  },
+  arguments: [],
+  directives: [],
+  alias: undefined,
+  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')
+
+    if (!id && name) {
+      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 }
+
+  return {
+    ...request,
+    body: JSON.stringify(updatedBody),
+  }
+}
+
+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
+      }
+
+      const hashedName = namehash(responseItem.name)
+      if (responseItem.id !== hashedName) {
+        this.update({ ...responseItem, name: hashedName, invalidName: true })
+      }
+    }
+  })
+  return response
+}
+
 export default class GqlManager {
   public gql: any = () => null
   public client?: any | null = null
 
   public setUrl = async (url: string | null) => {
     if (url) {
-      const imported = await import('graphql-request')
-      this.client = new imported.GraphQLClient(url)
+      const [imported, traverse, { visit, parse }] = await Promise.all([
+        import('graphql-request'),
+        import('traverse'),
+        import('graphql/language'),
+      ])
+
+      this.client = new imported.GraphQLClient(url, {
+        requestMiddleware: requestMiddleware(visit, parse),
+        responseMiddleware: responseMiddleware(traverse.default),
+      })
       this.gql = imported.gql
     } else {
       this.client = null

package/src/utils/normalise.ts

@@ -1,5 +1,6 @@
 import { concat, hexlify, keccak256, toUtf8Bytes } from 'ethers/lib/utils'
 import uts46 from 'idna-uts46-hx/uts46bundle.js'
+import { decodeLabelhash, isEncodedLabelhash } from './labels'
 
 const zeros = new Uint8Array(32)
 zeros.fill(0)
@@ -7,16 +8,21 @@ zeros.fill(0)
 export const normalise = (name: string) =>
   name ? uts46.toUnicode(name, { useStd3ASCII: true }) : name
 
-export const namehash = (inputName: string): string => {
+export const namehash = (name: string): string => {
   let result: string | Uint8Array = zeros
 
-  const name = normalise(inputName)
-
   if (name) {
     const labels = name.split('.')
 
     for (var i = labels.length - 1; i >= 0; i--) {
-      const labelSha = keccak256(toUtf8Bytes(labels[i]))
+      let labelSha: string
+      if (isEncodedLabelhash(labels[i])) {
+        labelSha = decodeLabelhash(labels[i])
+      } else {
+        const normalised = normalise(labels[i])
+        labelSha = keccak256(toUtf8Bytes(normalised))
+      }
+
       result = keccak256(concat([result, labelSha]))
     }
   } else {