@ensdomains/ensjs 3.0.0-beta.1 → 3.0.0-beta.3

package/dist/esm/functions/subgraph/getNamesForAddress.js

@@ -1,9 +1,68 @@
+/* eslint-disable @typescript-eslint/naming-convention */
 import { gql } from 'graphql-request';
 import { FilterKeyRequiredError, InvalidFilterKeyError, InvalidOrderByError, } from '../../errors/subgraph.js';
-import { GRACE_PERIOD_SECONDS } from '../../utils/consts.js';
+import { EMPTY_ADDRESS, GRACE_PERIOD_SECONDS } from '../../utils/consts.js';
 import { createSubgraphClient } from './client.js';
 import { domainDetailsFragment, registrationDetailsFragment, wrappedDomainDetailsFragment, } from './fragments.js';
 import { makeNameObject } from './utils.js';
+const supportedOwnerFilters = [
+    'owner',
+    'registrant',
+    'wrappedOwner',
+    'resolvedAddress',
+];
+const getOrderByFilter = ({ orderBy, orderDirection, previousPage, }) => {
+    const lastDomain = previousPage[previousPage.length - 1];
+    const operator = orderDirection === 'asc' ? 'gt' : 'lt';
+    switch (orderBy) {
+        case 'expiryDate': {
+            let lastExpiryDate = lastDomain.expiryDate?.value
+                ? lastDomain.expiryDate.value / 1000
+                : 0;
+            if (lastDomain.parentName === 'eth') {
+                lastExpiryDate += GRACE_PERIOD_SECONDS;
+            }
+            if (orderDirection === 'asc' && lastExpiryDate === 0) {
+                return {
+                    and: [{ expiryDate: null }, { [`id_${operator}`]: lastDomain.id }],
+                };
+            }
+            if (orderDirection === 'desc' && lastExpiryDate !== 0) {
+                return {
+                    [`expiryDate_${operator}`]: `${lastExpiryDate}`,
+                };
+            }
+            return {
+                or: [
+                    {
+                        [`expiryDate_${operator}`]: `${lastExpiryDate}`,
+                    },
+                    { expiryDate: null },
+                ],
+            };
+        }
+        case 'name': {
+            return {
+                [`name_${operator}`]: lastDomain.name ?? '',
+            };
+        }
+        case 'labelName': {
+            return {
+                [`labelName_${operator}`]: lastDomain.labelName ?? '',
+            };
+        }
+        case 'createdAt': {
+            return {
+                [`createdAt_${operator}`]: `${lastDomain.createdAt.value / 1000}`,
+            };
+        }
+        default:
+            throw new InvalidOrderByError({
+                orderBy: orderBy || '<no orderBy provided>',
+                supportedOrderBys: ['expiryDate', 'name', 'labelName', 'createdAt'],
+            });
+    }
+};
 /**
  * Gets the names for an address from the subgraph.
  * @param client - {@link ClientWithEns}
@@ -27,215 +86,117 @@ const getNamesForAddress = async (client, { address, filter = {
     resolvedAddress: true,
     wrappedOwner: true,
     allowExpired: false,
+    allowDeleted: false,
     allowReverseRecord: false,
 }, orderBy = 'name', orderDirection = 'asc', pageSize = 100, previousPage, }) => {
     const subgraphClient = createSubgraphClient({ client });
-    let ownerWhereFilter = `
-    or: [
-  `;
-    let hasFilterApplied = false;
-    const { allowExpired, allowReverseRecord, ...filters } = filter;
-    for (const [key, value] of Object.entries(filters)) {
+    const { allowExpired, allowDeleted, allowReverseRecord, ...filters } = filter;
+    const ownerWhereFilters = Object.entries(filters).reduce((prev, [key, value]) => {
         if (value) {
-            hasFilterApplied = true;
-            switch (key) {
-                case 'owner': {
-                    ownerWhereFilter += `
-            { owner: $address }
-          `;
-                    break;
-                }
-                case 'registrant': {
-                    ownerWhereFilter += `
-            { registrant: $address }
-          `;
-                    break;
-                }
-                case 'wrappedOwner': {
-                    ownerWhereFilter += `
-            { wrappedOwner: $address }
-          `;
-                    break;
-                }
-                case 'resolvedAddress': {
-                    ownerWhereFilter += `
-            { resolvedAddress: $address }
-          `;
-                    break;
-                }
-                default:
-                    throw new InvalidFilterKeyError({
-                        filterKey: key,
-                        supportedFilterKeys: [
-                            'owner',
-                            'registrant',
-                            'wrappedOwner',
-                            'resolvedAddress',
-                        ],
-                    });
-            }
+            if (!supportedOwnerFilters.includes(key))
+                throw new InvalidFilterKeyError({
+                    filterKey: key,
+                    supportedFilterKeys: supportedOwnerFilters,
+                });
+            return [
+                ...prev,
+                {
+                    [key]: address.toLowerCase(),
+                },
+            ];
         }
-    }
+        return prev;
+    }, []);
+    const hasFilterApplied = ownerWhereFilters.length > 0;
     if (!hasFilterApplied)
         throw new FilterKeyRequiredError({
-            supportedFilterKeys: [
-                'owner',
-                'registrant',
-                'wrappedOwner',
-                'resolvedAddress',
-            ],
+            supportedFilterKeys: supportedOwnerFilters,
             details: 'At least one ownership filter must be enabled',
         });
-    ownerWhereFilter += `
-    ]
-  `;
+    const ownerWhereFilter = ownerWhereFilters.length > 1
+        ? { or: ownerWhereFilters }
+        : ownerWhereFilters[0];
     const whereFilters = [ownerWhereFilter];
-    let orderByFilter = '';
-    let orderByStringVar = '';
-    if (previousPage && previousPage.length > 0) {
-        const lastDomain = previousPage[previousPage.length - 1];
-        const operator = orderDirection === 'asc' ? 'gt' : 'lt';
-        switch (orderBy) {
-            case 'expiryDate': {
-                let lastExpiryDate = lastDomain.expiryDate?.value
-                    ? lastDomain.expiryDate.value / 1000
-                    : 0;
-                if (lastDomain.parentName === 'eth') {
-                    lastExpiryDate += GRACE_PERIOD_SECONDS;
-                }
-                if (orderDirection === 'asc' && lastExpiryDate === 0) {
-                    orderByFilter = `
-              {
-                and: [
-                  { expiryDate: null }
-                  { id_${operator}: "${lastDomain.id}" }
-                ]
-              }
-            `;
-                }
-                else if (orderDirection === 'desc' && lastExpiryDate !== 0) {
-                    orderByFilter = `
-            {
-              expiryDate_${operator}: ${lastExpiryDate}
-            }
-          `;
-                }
-                else {
-                    orderByFilter = `
-            {
-              or: [
-                {
-                  expiryDate_${operator}: ${lastExpiryDate}
-                }
-                { expiryDate: null }
-              ]
-            }
-          `;
-                }
-                break;
-            }
-            case 'name': {
-                orderByFilter = `
-          {
-            name_${operator}: $orderByStringVar
-          }
-        `;
-                orderByStringVar = lastDomain.name ?? '';
-                break;
-            }
-            case 'labelName': {
-                orderByFilter = `
-          {
-            labelName_${operator}: $orderByStringVar
-          }
-        `;
-                orderByStringVar = lastDomain.labelName ?? '';
-                break;
-            }
-            case 'createdAt': {
-                orderByFilter = `
-          {
-            createdAt_${operator}: ${lastDomain.createdAt.value / 1000}
-          }
-        `;
-                break;
-            }
-            default:
-                throw new InvalidOrderByError({
-                    orderBy,
-                    supportedOrderBys: ['expiryDate', 'name', 'labelName', 'createdAt'],
-                });
-        }
-        whereFilters.push(orderByFilter);
+    if (previousPage?.length) {
+        whereFilters.push(getOrderByFilter({
+            orderBy,
+            orderDirection,
+            previousPage,
+        }));
     }
     if (!allowReverseRecord) {
         // Exclude domains with parent addr.reverse
         // namehash of addr.reverse = 0x91d1777781884d03a6757a803996e38de2a42967fb37eeaca72729271025a9e2
-        whereFilters.push(`
-      {
-        parent_not: "0x91d1777781884d03a6757a803996e38de2a42967fb37eeaca72729271025a9e2"
-      }
-    `);
+        whereFilters.push({
+            parent_not: '0x91d1777781884d03a6757a803996e38de2a42967fb37eeaca72729271025a9e2',
+        });
     }
     if (!allowExpired) {
         // Exclude domains that are expired
         // if expiryDate is null, there is no expiry on the domain (registration or wrapped)
-        whereFilters.push(`
-      {
-        or: [
-          { expiryDate_gt: $expiryDate }
-          { expiryDate: null }
-        ]
-      }
-    `);
+        whereFilters.push({
+            or: [
+                { expiryDate_gt: `${Math.floor(Date.now() / 1000)}` },
+                { expiryDate: null },
+            ],
+        });
     }
-    const whereFilter = whereFilters.length > 1
-        ? `
-    and: [
-      {
-        ${whereFilters.shift()}
-      }
-      ${whereFilters.join('\n')}
-    ]
-  `
-        : whereFilters[0];
+    if (!allowDeleted) {
+        // exclude "deleted" domains
+        // when owner/resolver/registrant = null
+        whereFilters.push({
+            or: [
+                {
+                    owner_not: EMPTY_ADDRESS,
+                },
+                {
+                    resolver_not: null,
+                },
+                {
+                    and: [
+                        {
+                            registrant_not: EMPTY_ADDRESS,
+                        },
+                        {
+                            registrant_not: null,
+                        },
+                    ],
+                },
+            ],
+        });
+    }
+    const whereFilter = whereFilters.length > 1 ? { and: whereFilters } : whereFilters[0];
     const query = gql `
-      query getNamesForAddress(
-        $address: String!
-        $orderBy: Domain_orderBy
-        $orderDirection: OrderDirection
-        $first: Int
-        $expiryDate: Int
-        $orderByStringVar: String
+    query getNamesForAddress(
+      $orderBy: Domain_orderBy
+      $orderDirection: OrderDirection
+      $first: Int
+      $whereFilter: Domain_filter
+    ) {
+      domains(
+        orderBy: $orderBy
+        orderDirection: $orderDirection
+        first: $first
+        where: $whereFilter
       ) {
-        domains(
-          orderBy: $orderBy
-          orderDirection: $orderDirection
-          first: $first
-          where: {
-            ${whereFilter}
-          }
-        ) {
-          ...DomainDetails
-          registration {
-            ...RegistrationDetails
-          }
-          wrappedDomain {
-            ...WrappedDomainDetails
-          }
+        ...DomainDetails
+        registration {
+          ...RegistrationDetails
+        }
+        wrappedDomain {
+          ...WrappedDomainDetails
         }
       }
-      ${domainDetailsFragment}
-      ${registrationDetailsFragment}
-      ${wrappedDomainDetailsFragment}
-    `;
+    }
+    ${domainDetailsFragment}
+    ${registrationDetailsFragment}
+    ${wrappedDomainDetailsFragment}
+  `;
     const result = await subgraphClient.request(query, {
-        address: address.toLowerCase(),
         orderBy,
         orderDirection,
         first: pageSize,
-        expiryDate: Math.floor(Date.now() / 1000),
-        orderByStringVar,
+        whereFilter,
     });
     if (!result)
         return [];

package/dist/esm/functions/subgraph/getNamesForAddress.js.map

@@ -1 +1 @@
-{"version":3,"file":"getNamesForAddress.js","sourceRoot":"","sources":["../../../../src/functions/subgraph/getNamesForAddress.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAA;AAGrC,OAAO,EACL,sBAAsB,EACtB,qBAAqB,EACrB,mBAAmB,GACpB,MAAM,0BAA0B,CAAA;AACjC,OAAO,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAA;AAC5D,OAAO,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAA;AAClD,OAAO,EACL,qBAAqB,EACrB,2BAA2B,EAC3B,4BAA4B,GAE7B,MAAM,gBAAgB,CAAA;AACvB,OAAO,EAAE,cAAc,EAAa,MAAM,YAAY,CAAA;AAmDtD;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,kBAAkB,GAAG,KAAK,EAC9B,MAAqB,EACrB,EACE,OAAO,EACP,MAAM,GAAG;IACP,KAAK,EAAE,IAAI;IACX,UAAU,EAAE,IAAI;IAChB,eAAe,EAAE,IAAI;IACrB,YAAY,EAAE,IAAI;IAClB,YAAY,EAAE,KAAK;IACnB,kBAAkB,EAAE,KAAK;CAC1B,EACD,OAAO,GAAG,MAAM,EAChB,cAAc,GAAG,KAAK,EACtB,QAAQ,GAAG,GAAG,EACd,YAAY,GACiB,EACQ,EAAE;IACzC,MAAM,cAAc,GAAG,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC,CAAA;IAEvD,IAAI,gBAAgB,GAAG;;GAEtB,CAAA;IACD,IAAI,gBAAgB,GAAG,KAAK,CAAA;IAC5B,MAAM,EAAE,YAAY,EAAE,kBAAkB,EAAE,GAAG,OAAO,EAAE,GAAG,MAAM,CAAA;IAC/D,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;QAClD,IAAI,KAAK,EAAE;YACT,gBAAgB,GAAG,IAAI,CAAA;YACvB,QAAQ,GAAG,EAAE;gBACX,KAAK,OAAO,CAAC,CAAC;oBACZ,gBAAgB,IAAI;;WAEnB,CAAA;oBACD,MAAK;iBACN;gBACD,KAAK,YAAY,CAAC,CAAC;oBACjB,gBAAgB,IAAI;;WAEnB,CAAA;oBACD,MAAK;iBACN;gBACD,KAAK,cAAc,CAAC,CAAC;oBACnB,gBAAgB,IAAI;;WAEnB,CAAA;oBACD,MAAK;iBACN;gBACD,KAAK,iBAAiB,CAAC,CAAC;oBACtB,gBAAgB,IAAI;;WAEnB,CAAA;oBACD,MAAK;iBACN;gBACD;oBACE,MAAM,IAAI,qBAAqB,CAAC;wBAC9B,SAAS,EAAE,GAAG;wBACd,mBAAmB,EAAE;4BACnB,OAAO;4BACP,YAAY;4BACZ,cAAc;4BACd,iBAAiB;yBAClB;qBACF,CAAC,CAAA;aACL;SACF;KACF;IAED,IAAI,CAAC,gBAAgB;QACnB,MAAM,IAAI,sBAAsB,CAAC;YAC/B,mBAAmB,EAAE;gBACnB,OAAO;gBACP,YAAY;gBACZ,cAAc;gBACd,iBAAiB;aAClB;YACD,OAAO,EAAE,+CAA+C;SACzD,CAAC,CAAA;IAEJ,gBAAgB,IAAI;;GAEnB,CAAA;IAED,MAAM,YAAY,GAAG,CAAC,gBAAgB,CAAC,CAAA;IAEvC,IAAI,aAAa,GAAG,EAAE,CAAA;IACtB,IAAI,gBAAgB,GAAG,EAAE,CAAA;IAEzB,IAAI,YAAY,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE;QAC3C,MAAM,UAAU,GAAG,YAAY,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QACxD,MAAM,QAAQ,GAAG,cAAc,KAAK,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAA;QACvD,QAAQ,OAAO,EAAE;YACf,KAAK,YAAY,CAAC,CAAC;gBACjB,IAAI,cAAc,GAAG,UAAU,CAAC,UAAU,EAAE,KAAK;oBAC/C,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC,KAAK,GAAG,IAAI;oBACpC,CAAC,CAAC,CAAC,CAAA;gBACL,IAAI,UAAU,CAAC,UAAU,KAAK,KAAK,EAAE;oBACnC,cAAc,IAAI,oBAAoB,CAAA;iBACvC;gBACD,IAAI,cAAc,KAAK,KAAK,IAAI,cAAc,KAAK,CAAC,EAAE;oBACpD,aAAa,GAAG;;;;yBAID,QAAQ,MAAM,UAAU,CAAC,EAAE;;;aAGvC,CAAA;iBACJ;qBAAM,IAAI,cAAc,KAAK,MAAM,IAAI,cAAc,KAAK,CAAC,EAAE;oBAC5D,aAAa,GAAG;;2BAEC,QAAQ,KAAK,cAAc;;WAE3C,CAAA;iBACF;qBAAM;oBACL,aAAa,GAAG;;;;+BAIK,QAAQ,KAAK,cAAc;;;;;WAK/C,CAAA;iBACF;gBACD,MAAK;aACN;YACD,KAAK,MAAM,CAAC,CAAC;gBACX,aAAa,GAAG;;mBAEL,QAAQ;;SAElB,CAAA;gBACD,gBAAgB,GAAG,UAAU,CAAC,IAAI,IAAI,EAAE,CAAA;gBACxC,MAAK;aACN;YACD,KAAK,WAAW,CAAC,CAAC;gBAChB,aAAa,GAAG;;wBAEA,QAAQ;;SAEvB,CAAA;gBACD,gBAAgB,GAAG,UAAU,CAAC,SAAS,IAAI,EAAE,CAAA;gBAC7C,MAAK;aACN;YACD,KAAK,WAAW,CAAC,CAAC;gBAChB,aAAa,GAAG;;wBAEA,QAAQ,KAAK,UAAU,CAAC,SAAS,CAAC,KAAK,GAAG,IAAI;;SAE7D,CAAA;gBACD,MAAK;aACN;YACD;gBACE,MAAM,IAAI,mBAAmB,CAAC;oBAC5B,OAAO;oBACP,iBAAiB,EAAE,CAAC,YAAY,EAAE,MAAM,EAAE,WAAW,EAAE,WAAW,CAAC;iBACpE,CAAC,CAAA;SACL;QACD,YAAY,CAAC,IAAI,CAAC,aAAa,CAAC,CAAA;KACjC;IAED,IAAI,CAAC,kBAAkB,EAAE;QACvB,2CAA2C;QAC3C,gGAAgG;QAChG,YAAY,CAAC,IAAI,CAAC;;;;KAIjB,CAAC,CAAA;KACH;IAED,IAAI,CAAC,YAAY,EAAE;QACjB,mCAAmC;QACnC,oFAAoF;QACpF,YAAY,CAAC,IAAI,CAAC;;;;;;;KAOjB,CAAC,CAAA;KACH;IAED,MAAM,WAAW,GACf,YAAY,CAAC,MAAM,GAAG,CAAC;QACrB,CAAC,CAAC;;;UAGE,YAAY,CAAC,KAAK,EAAE;;QAEtB,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC;;GAE5B;QACG,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAA;IAErB,MAAM,KAAK,GAAG,GAAG,CAAA;;;;;;;;;;;;;;cAcL,WAAW;;;;;;;;;;;;QAYjB,qBAAqB;QACrB,2BAA2B;QAC3B,4BAA4B;KAC/B,CAAA;IAEH,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,OAAO,CAUzC,KAAK,EAAE;QACP,OAAO,EAAE,OAAO,CAAC,WAAW,EAAE;QAC9B,OAAO;QACP,cAAc;QACd,KAAK,EAAE,QAAQ;QACf,UAAU,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC;QACzC,gBAAgB;KACjB,CAAC,CAAA;IAEF,IAAI,CAAC,MAAM;QAAE,OAAO,EAAE,CAAA;IAEtB,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;QAC1C,MAAM,QAAQ,GAA+B,EAAE,CAAA;QAE/C,IAAI,MAAM,CAAC,KAAK,EAAE;YAChB,QAAQ,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,EAAE,KAAK,OAAO,CAAC,WAAW,EAAE,CAAA;SAC3D;QACD,IAAI,MAAM,CAAC,UAAU,EAAE;YACrB,QAAQ,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC,EAAE,KAAK,OAAO,CAAC,WAAW,EAAE,CAAA;SACrE;QACD,IAAI,MAAM,CAAC,YAAY,EAAE;YACvB,QAAQ,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC,EAAE,KAAK,OAAO,CAAC,WAAW,EAAE,CAAA;SACzE;QACD,IAAI,MAAM,CAAC,eAAe,EAAE;YAC1B,QAAQ,CAAC,eAAe;gBACtB,MAAM,CAAC,eAAe,CAAC,EAAE,KAAK,OAAO,CAAC,WAAW,EAAE,CAAA;SACtD;QAED,OAAO;YACL,GAAG,cAAc,CAAC,MAAM,CAAC;YACzB,QAAQ;SACT,CAAA;IACH,CAAC,CAAC,CAAA;IAEF,OAAO,KAAK,CAAA;AACd,CAAC,CAAA;AAED,eAAe,kBAAkB,CAAA"}
+{"version":3,"file":"getNamesForAddress.js","sourceRoot":"","sources":["../../../../src/functions/subgraph/getNamesForAddress.ts"],"names":[],"mappings":"AAAA,yDAAyD;AACzD,OAAO,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAA;AAGrC,OAAO,EACL,sBAAsB,EACtB,qBAAqB,EACrB,mBAAmB,GACpB,MAAM,0BAA0B,CAAA;AACjC,OAAO,EAAE,aAAa,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAA;AAC3E,OAAO,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAA;AAElD,OAAO,EACL,qBAAqB,EACrB,2BAA2B,EAC3B,4BAA4B,GAE7B,MAAM,gBAAgB,CAAA;AACvB,OAAO,EAAE,cAAc,EAAa,MAAM,YAAY,CAAA;AAEtD,MAAM,qBAAqB,GAAG;IAC5B,OAAO;IACP,YAAY;IACZ,cAAc;IACd,iBAAiB;CACT,CAAA;AAqDV,MAAM,gBAAgB,GAAG,CAAC,EACxB,OAAO,EACP,cAAc,EACd,YAAY,GAMb,EAAgB,EAAE;IACjB,MAAM,UAAU,GAAG,YAAY,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;IACxD,MAAM,QAAQ,GAAG,cAAc,KAAK,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAA;IAEvD,QAAQ,OAAO,EAAE;QACf,KAAK,YAAY,CAAC,CAAC;YACjB,IAAI,cAAc,GAAG,UAAU,CAAC,UAAU,EAAE,KAAK;gBAC/C,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC,KAAK,GAAG,IAAI;gBACpC,CAAC,CAAC,CAAC,CAAA;YACL,IAAI,UAAU,CAAC,UAAU,KAAK,KAAK,EAAE;gBACnC,cAAc,IAAI,oBAAoB,CAAA;aACvC;YAED,IAAI,cAAc,KAAK,KAAK,IAAI,cAAc,KAAK,CAAC,EAAE;gBACpD,OAAO;oBACL,GAAG,EAAE,CAAC,EAAE,UAAU,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,MAAM,QAAQ,EAAE,CAAC,EAAE,UAAU,CAAC,EAAE,EAAE,CAAC;iBACnE,CAAA;aACF;YACD,IAAI,cAAc,KAAK,MAAM,IAAI,cAAc,KAAK,CAAC,EAAE;gBACrD,OAAO;oBACL,CAAC,cAAc,QAAQ,EAAE,CAAC,EAAE,GAAG,cAAc,EAAE;iBAChD,CAAA;aACF;YACD,OAAO;gBACL,EAAE,EAAE;oBACF;wBACE,CAAC,cAAc,QAAQ,EAAE,CAAC,EAAE,GAAG,cAAc,EAAE;qBAChD;oBACD,EAAE,UAAU,EAAE,IAAI,EAAE;iBACrB;aACF,CAAA;SACF;QACD,KAAK,MAAM,CAAC,CAAC;YACX,OAAO;gBACL,CAAC,QAAQ,QAAQ,EAAE,CAAC,EAAE,UAAU,CAAC,IAAI,IAAI,EAAE;aAC5C,CAAA;SACF;QACD,KAAK,WAAW,CAAC,CAAC;YAChB,OAAO;gBACL,CAAC,aAAa,QAAQ,EAAE,CAAC,EAAE,UAAU,CAAC,SAAS,IAAI,EAAE;aACtD,CAAA;SACF;QACD,KAAK,WAAW,CAAC,CAAC;YAChB,OAAO;gBACL,CAAC,aAAa,QAAQ,EAAE,CAAC,EAAE,GAAG,UAAU,CAAC,SAAS,CAAC,KAAK,GAAG,IAAI,EAAE;aAClE,CAAA;SACF;QACD;YACE,MAAM,IAAI,mBAAmB,CAAC;gBAC5B,OAAO,EAAE,OAAO,IAAI,uBAAuB;gBAC3C,iBAAiB,EAAE,CAAC,YAAY,EAAE,MAAM,EAAE,WAAW,EAAE,WAAW,CAAC;aACpE,CAAC,CAAA;KACL;AACH,CAAC,CAAA;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,kBAAkB,GAAG,KAAK,EAC9B,MAAqB,EACrB,EACE,OAAO,EACP,MAAM,GAAG;IACP,KAAK,EAAE,IAAI;IACX,UAAU,EAAE,IAAI;IAChB,eAAe,EAAE,IAAI;IACrB,YAAY,EAAE,IAAI;IAClB,YAAY,EAAE,KAAK;IACnB,YAAY,EAAE,KAAK;IACnB,kBAAkB,EAAE,KAAK;CAC1B,EACD,OAAO,GAAG,MAAM,EAChB,cAAc,GAAG,KAAK,EACtB,QAAQ,GAAG,GAAG,EACd,YAAY,GACiB,EACQ,EAAE;IACzC,MAAM,cAAc,GAAG,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC,CAAA;IAEvD,MAAM,EAAE,YAAY,EAAE,YAAY,EAAE,kBAAkB,EAAE,GAAG,OAAO,EAAE,GAAG,MAAM,CAAA;IAC7E,MAAM,iBAAiB,GAAmB,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,CACtE,CAAC,IAAI,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QACrB,IAAI,KAAK,EAAE;YACT,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,GAAU,CAAC;gBAC7C,MAAM,IAAI,qBAAqB,CAAC;oBAC9B,SAAS,EAAE,GAAG;oBACd,mBAAmB,EAAE,qBAAqB;iBAC3C,CAAC,CAAA;YACJ,OAAO;gBACL,GAAG,IAAI;gBACP;oBACE,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,WAAW,EAAE;iBAC7B;aACF,CAAA;SACF;QACD,OAAO,IAAI,CAAA;IACb,CAAC,EACD,EAAoB,CACrB,CAAA;IAED,MAAM,gBAAgB,GAAG,iBAAiB,CAAC,MAAM,GAAG,CAAC,CAAA;IAErD,IAAI,CAAC,gBAAgB;QACnB,MAAM,IAAI,sBAAsB,CAAC;YAC/B,mBAAmB,EAAE,qBAAqB;YAC1C,OAAO,EAAE,+CAA+C;SACzD,CAAC,CAAA;IAEJ,MAAM,gBAAgB,GACpB,iBAAiB,CAAC,MAAM,GAAG,CAAC;QAC1B,CAAC,CAAC,EAAE,EAAE,EAAE,iBAAiB,EAAE;QAC3B,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAA;IAC1B,MAAM,YAAY,GAAmB,CAAC,gBAAgB,CAAC,CAAA;IAEvD,IAAI,YAAY,EAAE,MAAM,EAAE;QACxB,YAAY,CAAC,IAAI,CACf,gBAAgB,CAAC;YACf,OAAO;YACP,cAAc;YACd,YAAY;SACb,CAAC,CACH,CAAA;KACF;IAED,IAAI,CAAC,kBAAkB,EAAE;QACvB,2CAA2C;QAC3C,gGAAgG;QAChG,YAAY,CAAC,IAAI,CAAC;YAChB,UAAU,EACR,oEAAoE;SACvE,CAAC,CAAA;KACH;IAED,IAAI,CAAC,YAAY,EAAE;QACjB,mCAAmC;QACnC,oFAAoF;QACpF,YAAY,CAAC,IAAI,CAAC;YAChB,EAAE,EAAE;gBACF,EAAE,aAAa,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,EAAE,EAAE;gBACrD,EAAE,UAAU,EAAE,IAAI,EAAE;aACrB;SACF,CAAC,CAAA;KACH;IAED,IAAI,CAAC,YAAY,EAAE;QACjB,4BAA4B;QAC5B,wCAAwC;QACxC,YAAY,CAAC,IAAI,CAAC;YAChB,EAAE,EAAE;gBACF;oBACE,SAAS,EAAE,aAAa;iBACzB;gBACD;oBACE,YAAY,EAAE,IAAI;iBACnB;gBACD;oBACE,GAAG,EAAE;wBACH;4BACE,cAAc,EAAE,aAAa;yBAC9B;wBACD;4BACE,cAAc,EAAE,IAAI;yBACrB;qBACF;iBACF;aACF;SACF,CAAC,CAAA;KACH;IAED,MAAM,WAAW,GACf,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,YAAY,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAA;IAEnE,MAAM,KAAK,GAAG,GAAG,CAAA;;;;;;;;;;;;;;;;;;;;;;MAsBb,qBAAqB;MACrB,2BAA2B;MAC3B,4BAA4B;GAC/B,CAAA;IAED,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,OAAO,CAQzC,KAAK,EAAE;QACP,OAAO;QACP,cAAc;QACd,KAAK,EAAE,QAAQ;QACf,WAAW;KACZ,CAAC,CAAA;IAEF,IAAI,CAAC,MAAM;QAAE,OAAO,EAAE,CAAA;IAEtB,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;QAC1C,MAAM,QAAQ,GAA+B,EAAE,CAAA;QAE/C,IAAI,MAAM,CAAC,KAAK,EAAE;YAChB,QAAQ,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,EAAE,KAAK,OAAO,CAAC,WAAW,EAAE,CAAA;SAC3D;QACD,IAAI,MAAM,CAAC,UAAU,EAAE;YACrB,QAAQ,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC,EAAE,KAAK,OAAO,CAAC,WAAW,EAAE,CAAA;SACrE;QACD,IAAI,MAAM,CAAC,YAAY,EAAE;YACvB,QAAQ,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC,EAAE,KAAK,OAAO,CAAC,WAAW,EAAE,CAAA;SACzE;QACD,IAAI,MAAM,CAAC,eAAe,EAAE;YAC1B,QAAQ,CAAC,eAAe;gBACtB,MAAM,CAAC,eAAe,CAAC,EAAE,KAAK,OAAO,CAAC,WAAW,EAAE,CAAA;SACtD;QAED,OAAO;YACL,GAAG,cAAc,CAAC,MAAM,CAAC;YACzB,QAAQ;SACT,CAAA;IACH,CAAC,CAAC,CAAA;IAEF,OAAO,KAAK,CAAA;AACd,CAAC,CAAA;AAED,eAAe,kBAAkB,CAAA"}

package/dist/esm/functions/subgraph/getSubnames.js

@@ -1,10 +1,63 @@
+/* eslint-disable @typescript-eslint/naming-convention */
 import { gql } from 'graphql-request';
 import { InvalidOrderByError } from '../../errors/subgraph.js';
-import { GRACE_PERIOD_SECONDS } from '../../utils/consts.js';
+import { EMPTY_ADDRESS, GRACE_PERIOD_SECONDS } from '../../utils/consts.js';
 import { namehash } from '../../utils/normalise.js';
 import { createSubgraphClient } from './client.js';
 import { domainDetailsWithoutParentFragment, registrationDetailsFragment, wrappedDomainDetailsFragment, } from './fragments.js';
 import { makeNameObject } from './utils.js';
+const getOrderByFilter = ({ name, orderBy, orderDirection, previousPage, }) => {
+    const lastDomain = previousPage[previousPage.length - 1];
+    const operator = orderDirection === 'asc' ? 'gt' : 'lt';
+    switch (orderBy) {
+        case 'expiryDate': {
+            let lastExpiryDate = lastDomain.expiryDate?.value
+                ? lastDomain.expiryDate.value / 1000
+                : 0;
+            if (name === 'eth' && lastExpiryDate) {
+                lastExpiryDate += GRACE_PERIOD_SECONDS;
+            }
+            if (orderDirection === 'asc' && lastExpiryDate === 0) {
+                return {
+                    and: [{ expiryDate: null }, { [`id_${operator}`]: lastDomain.id }],
+                };
+            }
+            if (orderDirection === 'desc' && lastExpiryDate !== 0) {
+                return {
+                    [`expiryDate_${operator}`]: `${lastExpiryDate}`,
+                };
+            }
+            return {
+                or: [
+                    {
+                        [`expiryDate_${operator}`]: `${lastExpiryDate}`,
+                    },
+                    { expiryDate: null },
+                ],
+            };
+        }
+        case 'name': {
+            return {
+                [`name_${operator}`]: lastDomain.name ?? '',
+            };
+        }
+        case 'labelName': {
+            return {
+                [`labelName_${operator}`]: lastDomain.labelName ?? '',
+            };
+        }
+        case 'createdAt': {
+            return {
+                [`createdAt_${operator}`]: `${lastDomain.createdAt.value / 1000}`,
+            };
+        }
+        default:
+            throw new InvalidOrderByError({
+                orderBy: orderBy || '<no orderBy provided>',
+                supportedOrderBys: ['expiryDate', 'name', 'labelName', 'createdAt'],
+            });
+    }
+};
 /**
  * Gets the subnames for a name from the subgraph.
  * @param client - {@link ClientWithEns}
@@ -22,140 +75,79 @@ import { makeNameObject } from './utils.js';
  * })
  * const result = await getSubnames(client, { name: 'ens.eth' })
  */
-const getSubnames = async (client, { name, searchString, allowExpired = false, orderBy = 'name', orderDirection = 'asc', pageSize = 100, previousPage, }) => {
+const getSubnames = async (client, { name, searchString, allowExpired = false, allowDeleted = false, orderBy = 'name', orderDirection = 'asc', pageSize = 100, previousPage, }) => {
     const subgraphClient = createSubgraphClient({ client });
     const whereFilters = [];
-    let orderByFilter = '';
-    let orderByStringVar = '';
-    if (previousPage && previousPage.length > 0) {
-        const lastDomain = previousPage[previousPage.length - 1];
-        const operator = orderDirection === 'asc' ? 'gt' : 'lt';
-        switch (orderBy) {
-            case 'expiryDate': {
-                let lastExpiryDate = lastDomain.expiryDate?.value
-                    ? lastDomain.expiryDate.value / 1000
-                    : 0;
-                if (name === 'eth' && lastExpiryDate) {
-                    lastExpiryDate += GRACE_PERIOD_SECONDS;
-                }
-                if (orderDirection === 'asc' && lastExpiryDate === 0) {
-                    orderByFilter = `
-              {
-                and: [
-                  { expiryDate: null }
-                  { id_${operator}: "${lastDomain.id}" }
-                ]
-              }
-            `;
-                }
-                else if (orderDirection === 'desc' && lastExpiryDate !== 0) {
-                    orderByFilter = `
-            {
-              expiryDate_${operator}: ${lastExpiryDate}
-            }
-          `;
-                }
-                else {
-                    orderByFilter = `
-            {
-              or: [
-                {
-                  expiryDate_${operator}: ${lastExpiryDate}
-                }
-                { expiryDate: null }
-              ]
-            }
-          `;
-                }
-                break;
-            }
-            case 'name': {
-                orderByFilter = `
-          {
-            name_${operator}: $orderByStringVar
-          }
-        `;
-                orderByStringVar = lastDomain.name ?? '';
-                break;
-            }
-            case 'labelName': {
-                orderByFilter = `
-          {
-            labelName_${operator}: $orderByStringVar
-          }
-        `;
-                orderByStringVar = lastDomain.labelName ?? '';
-                break;
-            }
-            case 'createdAt': {
-                orderByFilter = `
-          {
-            createdAt_${operator}: ${lastDomain.createdAt.value / 1000}
-          }
-        `;
-                break;
-            }
-            default:
-                throw new InvalidOrderByError({
-                    orderBy,
-                    supportedOrderBys: ['expiryDate', 'name', 'labelName', 'createdAt'],
-                });
-        }
-        whereFilters.push(orderByFilter);
+    if (previousPage?.length) {
+        whereFilters.push(getOrderByFilter({
+            name,
+            orderBy,
+            orderDirection,
+            previousPage,
+        }));
     }
     if (!allowExpired) {
         // Exclude domains that are expired
         // if expiryDate is null, there is no expiry on the domain (registration or wrapped)
-        whereFilters.push(`
-      {
-        or: [
-          { expiryDate_gt: $expiryDate }
-          { expiryDate: null }
-        ]
-      }
-    `);
+        whereFilters.push({
+            or: [
+                { expiryDate_gt: `${Math.floor(Date.now() / 1000)}` },
+                { expiryDate: null },
+            ],
+        });
+    }
+    if (!allowDeleted) {
+        // exclude "deleted" domains
+        // when owner/resolver/registrant = null
+        whereFilters.push({
+            or: [
+                {
+                    owner_not: EMPTY_ADDRESS,
+                },
+                {
+                    resolver_not: null,
+                },
+                ...(name.toLowerCase() === 'eth'
+                    ? [
+                        {
+                            registrant_not: EMPTY_ADDRESS,
+                        },
+                    ]
+                    : []),
+            ],
+        });
     }
     if (searchString) {
         // using labelName_contains instead of name_contains because name_contains
         // includes the parent name
-        whereFilters.push(`
-      {
-        labelName_contains: $searchString
-      }
-    `);
+        whereFilters.push({
+            labelName_contains: searchString,
+        });
     }
-    let whereFilter = '';
+    let whereFilter = {};
     if (whereFilters.length > 1) {
-        whereFilter = `
-      and: [
-        ${whereFilters.join('\n')}
-      ]
-    `;
+        whereFilter = {
+            and: whereFilters,
+        };
     }
     else if (whereFilters.length === 1) {
-        whereFilter = whereFilters[0].replace(/{(.*)}/gs, '$1');
+        ;
+        [whereFilter] = whereFilters;
     }
     const query = gql `
     query getSubnames(
       $id: String!
       $orderBy: Domain_orderBy
       $orderDirection: OrderDirection
+      $whereFilter: Domain_filter
       $first: Int
-      $expiryDate: Int
-      $searchString: String
-      $orderByStringVar: String
     ) {
       domain(id: $id) {
         subdomains(
           orderBy: $orderBy
           orderDirection: $orderDirection
           first: $first
-          ${whereFilter &&
-        `
-          where: {
-            ${whereFilter}
-          }
-          `}
+          where: $whereFilter
         ) {
           ...DomainDetailsWithoutParent
           registration {
@@ -176,9 +168,7 @@ const getSubnames = async (client, { name, searchString, allowExpired = false, o
         orderBy,
         orderDirection,
         first: pageSize,
-        expiryDate: Math.floor(Date.now() / 1000),
-        searchString,
-        orderByStringVar,
+        whereFilter,
     };
     const result = await subgraphClient.request(query, queryVars);
     if (!result.domain)