@ensdomains/ensjs 4.0.3-alpha.12 → 4.1.1

package/dist/functions/subgraph/getNamesForAddress.js

@@ -0,0 +1,214 @@
+/* eslint-disable @typescript-eslint/naming-convention */
+import { gql } from 'graphql-request';
+import { FilterKeyRequiredError, InvalidFilterKeyError, InvalidOrderByError, } from '../../errors/subgraph.js';
+import { EMPTY_ADDRESS } from '../../utils/consts.js';
+import { createSubgraphClient } from './client.js';
+import { getCreatedAtOrderFilter, getExpiryDateOrderFilter, } from './filters.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': {
+            return getExpiryDateOrderFilter({
+                orderDirection,
+                lastDomain,
+            });
+        }
+        case 'name': {
+            return {
+                [`name_${operator}`]: lastDomain.name ?? '',
+            };
+        }
+        case 'labelName': {
+            return {
+                [`labelName_${operator}`]: lastDomain.labelName ?? '',
+            };
+        }
+        case 'createdAt': {
+            return getCreatedAtOrderFilter({ lastDomain, orderDirection });
+        }
+        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}
+ * @param parameters - {@link GetNamesForAddressParameters}
+ * @returns Name array. {@link GetNamesForAddressReturnType}
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { getNamesForAddress } from '@ensdomains/ensjs/subgraph'
+ *
+ * const client = createPublicClient({
+ *   chain: addEnsContracts(mainnet),
+ *   transport: http(),
+ * })
+ * const result = await getNamesForAddress(client, { address: '0xFe89cc7aBB2C4183683ab71653C4cdc9B02D44b7' })
+ */
+const getNamesForAddress = async (client, { address, filter: _filter, orderBy = 'name', orderDirection = 'asc', pageSize = 100, previousPage, }) => {
+    const filter = {
+        owner: true,
+        registrant: true,
+        resolvedAddress: true,
+        wrappedOwner: true,
+        allowExpired: false,
+        allowDeleted: false,
+        allowReverseRecord: false,
+        searchType: 'labelName',
+        ..._filter,
+    };
+    const subgraphClient = createSubgraphClient({ client });
+    const { allowExpired, allowDeleted, allowReverseRecord, searchString, searchType, ...filters } = filter;
+    const ownerWhereFilters = Object.entries(filters).reduce((prev, [key, value]) => {
+        if (value) {
+            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: supportedOwnerFilters,
+            details: 'At least one ownership filter must be enabled',
+        });
+    const ownerWhereFilter = ownerWhereFilters.length > 1
+        ? { or: ownerWhereFilters }
+        : ownerWhereFilters[0];
+    const whereFilters = [ownerWhereFilter];
+    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',
+        });
+    }
+    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: `${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,
+                },
+                {
+                    and: [
+                        {
+                            registrant_not: EMPTY_ADDRESS,
+                        },
+                        {
+                            registrant_not: null,
+                        },
+                    ],
+                },
+            ],
+        });
+    }
+    if (searchString) {
+        whereFilters.push({
+            [`${searchType}_contains`]: searchString,
+        });
+    }
+    const whereFilter = whereFilters.length > 1 ? { and: whereFilters } : whereFilters[0];
+    const query = gql `
+    query getNamesForAddress(
+      $orderBy: Domain_orderBy
+      $orderDirection: OrderDirection
+      $first: Int
+      $whereFilter: Domain_filter
+    ) {
+      domains(
+        orderBy: $orderBy
+        orderDirection: $orderDirection
+        first: $first
+        where: $whereFilter
+      ) {
+        ...DomainDetails
+        registration {
+          ...RegistrationDetails
+        }
+        wrappedDomain {
+          ...WrappedDomainDetails
+        }
+      }
+    }
+    ${domainDetailsFragment}
+    ${registrationDetailsFragment}
+    ${wrappedDomainDetailsFragment}
+  `;
+    const result = await subgraphClient.request(query, {
+        orderBy,
+        orderDirection,
+        first: pageSize,
+        whereFilter,
+    });
+    if (!result)
+        return [];
+    const names = result.domains.map((domain) => {
+        const relation = {};
+        if (domain.owner) {
+            relation.owner = domain.owner.id === address.toLowerCase();
+        }
+        if (domain.registrant) {
+            relation.registrant = domain.registrant.id === address.toLowerCase();
+        }
+        if (domain.wrappedOwner) {
+            relation.wrappedOwner = domain.wrappedOwner.id === address.toLowerCase();
+        }
+        if (domain.resolvedAddress) {
+            relation.resolvedAddress =
+                domain.resolvedAddress.id === address.toLowerCase();
+        }
+        return {
+            ...makeNameObject(domain),
+            relation,
+        };
+    });
+    return names;
+};
+export default getNamesForAddress;
+//# sourceMappingURL=getNamesForAddress.js.map

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

@@ -0,0 +1 @@
+{"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,MAAM,uBAAuB,CAAA;AACrD,OAAO,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAA;AAClD,OAAO,EAEL,uBAAuB,EACvB,wBAAwB,GACzB,MAAM,cAAc,CAAA;AACrB,OAAO,EAEL,qBAAqB,EACrB,2BAA2B,EAC3B,4BAA4B,GAC7B,MAAM,gBAAgB,CAAA;AACvB,OAAO,EAAa,cAAc,EAAE,MAAM,YAAY,CAAA;AAEtD,MAAM,qBAAqB,GAAG;IAC5B,OAAO;IACP,YAAY;IACZ,cAAc;IACd,iBAAiB;CACT,CAAA;AAyDV,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;IACvD,QAAQ,OAAO,EAAE,CAAC;QAChB,KAAK,YAAY,CAAC,CAAC,CAAC;YAClB,OAAO,wBAAwB,CAAC;gBAC9B,cAAc;gBACd,UAAU;aACX,CAAC,CAAA;QACJ,CAAC;QACD,KAAK,MAAM,CAAC,CAAC,CAAC;YACZ,OAAO;gBACL,CAAC,QAAQ,QAAQ,EAAE,CAAC,EAAE,UAAU,CAAC,IAAI,IAAI,EAAE;aAC5C,CAAA;QACH,CAAC;QACD,KAAK,WAAW,CAAC,CAAC,CAAC;YACjB,OAAO;gBACL,CAAC,aAAa,QAAQ,EAAE,CAAC,EAAE,UAAU,CAAC,SAAS,IAAI,EAAE;aACtD,CAAA;QACH,CAAC;QACD,KAAK,WAAW,CAAC,CAAC,CAAC;YACjB,OAAO,uBAAuB,CAAC,EAAE,UAAU,EAAE,cAAc,EAAE,CAAC,CAAA;QAChE,CAAC;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;IACN,CAAC;AACH,CAAC,CAAA;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,kBAAkB,GAAG,KAAK,EAC9B,MAAqB,EACrB,EACE,OAAO,EACP,MAAM,EAAE,OAAO,EACf,OAAO,GAAG,MAAM,EAChB,cAAc,GAAG,KAAK,EACtB,QAAQ,GAAG,GAAG,EACd,YAAY,GACiB,EACQ,EAAE;IACzC,MAAM,MAAM,GAAG;QACb,KAAK,EAAE,IAAI;QACX,UAAU,EAAE,IAAI;QAChB,eAAe,EAAE,IAAI;QACrB,YAAY,EAAE,IAAI;QAClB,YAAY,EAAE,KAAK;QACnB,YAAY,EAAE,KAAK;QACnB,kBAAkB,EAAE,KAAK;QACzB,UAAU,EAAE,WAAW;QACvB,GAAG,OAAO;KACF,CAAA;IAEV,MAAM,cAAc,GAAG,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC,CAAA;IAEvD,MAAM,EACJ,YAAY,EACZ,YAAY,EACZ,kBAAkB,EAClB,YAAY,EACZ,UAAU,EACV,GAAG,OAAO,EACX,GAAG,MAAM,CAAA;IAEV,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,CAAC;YACV,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;QACH,CAAC;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,CAAC;QACzB,YAAY,CAAC,IAAI,CACf,gBAAgB,CAAC;YACf,OAAO;YACP,cAAc;YACd,YAAY;SACb,CAAC,CACH,CAAA;IACH,CAAC;IAED,IAAI,CAAC,kBAAkB,EAAE,CAAC;QACxB,2CAA2C;QAC3C,gGAAgG;QAChG,YAAY,CAAC,IAAI,CAAC;YAChB,UAAU,EACR,oEAAoE;SACvE,CAAC,CAAA;IACJ,CAAC;IAED,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,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;IACJ,CAAC;IAED,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,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;IACJ,CAAC;IAED,IAAI,YAAY,EAAE,CAAC;QACjB,YAAY,CAAC,IAAI,CAAC;YAChB,CAAC,GAAG,UAAU,WAAW,CAAC,EAAE,YAAY;SACzC,CAAC,CAAA;IACJ,CAAC;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,CAAC;YACjB,QAAQ,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,EAAE,KAAK,OAAO,CAAC,WAAW,EAAE,CAAA;QAC5D,CAAC;QACD,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC;YACtB,QAAQ,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC,EAAE,KAAK,OAAO,CAAC,WAAW,EAAE,CAAA;QACtE,CAAC;QACD,IAAI,MAAM,CAAC,YAAY,EAAE,CAAC;YACxB,QAAQ,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC,EAAE,KAAK,OAAO,CAAC,WAAW,EAAE,CAAA;QAC1E,CAAC;QACD,IAAI,MAAM,CAAC,eAAe,EAAE,CAAC;YAC3B,QAAQ,CAAC,eAAe;gBACtB,MAAM,CAAC,eAAe,CAAC,EAAE,KAAK,OAAO,CAAC,WAAW,EAAE,CAAA;QACvD,CAAC;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/functions/subgraph/getSubgraphRecords.d.ts

@@ -0,0 +1,45 @@
+import type { Address } from 'viem';
+import type { ClientWithEns } from '../../contracts/consts.js';
+import type { DateWithValue } from '../../types.js';
+export type GetSubgraphRecordsParameters = {
+    /** Name to get records for */
+    name: string;
+    /** Resolver address to use */
+    resolverAddress?: Address;
+};
+export type GetSubgraphRecordsReturnType = {
+    /** Name migration status from old ENS registry */
+    isMigrated: boolean;
+    /** Initial name creation time */
+    createdAt: DateWithValue<number>;
+    /** Array of text record keys */
+    texts: string[];
+    /** Array of coin ids */
+    coins: string[];
+} | null;
+/**
+ * Gets the records for a name from the subgraph
+ * @param client - {@link ClientWithEns}
+ * @param parameters - {@link GetSubgraphRecordsParameters}
+ * @returns Record object, or null if name was not found. {@link GetSubgraphRecordsReturnType}
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { getSubgraphRecords } from '@ensdomains/ensjs/subgraph'
+ *
+ * const client = createPublicClient({
+ *   chain: addEnsContracts(mainnet),
+ *   transport: http(),
+ * })
+ * const result = await getSubgraphRecords(client, { name: 'ens.eth' })
+ * // {
+ * //   isMigrated: true,
+ * //   createdAt: { date: 2019-08-26T05:09:01.000Z, value: 1566796141000 },
+ * //   texts: [ 'snapshot', 'url', 'avatar', 'com.twitter', 'com.github' ],
+ * //   coins: [ '60' ]
+ * // }
+ */
+declare const getSubgraphRecords: (client: ClientWithEns, { name, resolverAddress }: GetSubgraphRecordsParameters) => Promise<GetSubgraphRecordsReturnType>;
+export default getSubgraphRecords;

package/dist/functions/subgraph/getSubgraphRecords.js

@@ -0,0 +1,103 @@
+import { gql } from 'graphql-request';
+import { namehash } from '../../utils/normalise.js';
+import { createSubgraphClient } from './client.js';
+const inheritedResolverQuery = gql `
+  query getSubgraphRecords($id: String!) {
+    domain(id: $id) {
+      name
+      isMigrated
+      createdAt
+      resolver {
+        texts
+        coinTypes
+      }
+    }
+  }
+`;
+const customResolverQuery = gql `
+  query getSubgraphRecords($id: String!, $resolverId: String!) {
+    domain(id: $id) {
+      name
+      isMigrated
+      createdAt
+    }
+    resolver(id: $resolverId) {
+      texts
+      coinTypes
+    }
+  }
+`;
+const getCustomResolverResult = async (subgraphClient, { id, resolverAddress, }) => {
+    const resolverId = `${resolverAddress.toLowerCase()}-${id}`;
+    const response = await subgraphClient.request(customResolverQuery, {
+        id,
+        resolverId,
+    });
+    if (!response || !response.domain)
+        return null;
+    return {
+        domain: response.domain,
+        resolver: response.resolver,
+    };
+};
+const getInheritedResolverResult = async (subgraphClient, { id, }) => {
+    const response = await subgraphClient.request(inheritedResolverQuery, {
+        id,
+    });
+    if (!response || !response.domain)
+        return null;
+    const { resolver, ...domain } = response.domain;
+    return {
+        domain,
+        resolver,
+    };
+};
+/**
+ * Gets the records for a name from the subgraph
+ * @param client - {@link ClientWithEns}
+ * @param parameters - {@link GetSubgraphRecordsParameters}
+ * @returns Record object, or null if name was not found. {@link GetSubgraphRecordsReturnType}
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { getSubgraphRecords } from '@ensdomains/ensjs/subgraph'
+ *
+ * const client = createPublicClient({
+ *   chain: addEnsContracts(mainnet),
+ *   transport: http(),
+ * })
+ * const result = await getSubgraphRecords(client, { name: 'ens.eth' })
+ * // {
+ * //   isMigrated: true,
+ * //   createdAt: { date: 2019-08-26T05:09:01.000Z, value: 1566796141000 },
+ * //   texts: [ 'snapshot', 'url', 'avatar', 'com.twitter', 'com.github' ],
+ * //   coins: [ '60' ]
+ * // }
+ */
+const getSubgraphRecords = async (client, { name, resolverAddress }) => {
+    const subgraphClient = createSubgraphClient({ client });
+    const id = namehash(name);
+    const result = resolverAddress
+        ? await getCustomResolverResult(subgraphClient, { id, resolverAddress })
+        : await getInheritedResolverResult(subgraphClient, { id });
+    if (!result)
+        return null;
+    const { domain, resolver } = result;
+    const { isMigrated, createdAt: stringCreatedAt } = domain;
+    const intCreatedAt = Number.parseInt(stringCreatedAt) * 1000;
+    const texts = resolver?.texts || [];
+    const coins = resolver?.coinTypes || [];
+    return {
+        isMigrated,
+        createdAt: {
+            date: new Date(intCreatedAt),
+            value: intCreatedAt,
+        },
+        texts,
+        coins,
+    };
+};
+export default getSubgraphRecords;
+//# sourceMappingURL=getSubgraphRecords.js.map

package/dist/functions/subgraph/getSubgraphRecords.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getSubgraphRecords.js","sourceRoot":"","sources":["../../../src/functions/subgraph/getSubgraphRecords.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAA;AAIrC,OAAO,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAA;AACnD,OAAO,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAA;AAoBlD,MAAM,sBAAsB,GAAG,GAAG,CAAA;;;;;;;;;;;;CAYjC,CAAA;AAED,MAAM,mBAAmB,GAAG,GAAG,CAAA;;;;;;;;;;;;CAY9B,CAAA;AA6BD,MAAM,uBAAuB,GAAG,KAAK,EACnC,cAA6B,EAC7B,EACE,EAAE,EACF,eAAe,GAIhB,EACqC,EAAE;IACxC,MAAM,UAAU,GAAG,GAAG,eAAe,CAAC,WAAW,EAAE,IAAI,EAAE,EAAE,CAAA;IAC3D,MAAM,QAAQ,GAAG,MAAM,cAAc,CAAC,OAAO,CAC3C,mBAAmB,EACnB;QACE,EAAE;QACF,UAAU;KACX,CACF,CAAA;IACD,IAAI,CAAC,QAAQ,IAAI,CAAC,QAAQ,CAAC,MAAM;QAAE,OAAO,IAAI,CAAA;IAC9C,OAAO;QACL,MAAM,EAAE,QAAQ,CAAC,MAAM;QACvB,QAAQ,EAAE,QAAQ,CAAC,QAAQ;KAC5B,CAAA;AACH,CAAC,CAAA;AAED,MAAM,0BAA0B,GAAG,KAAK,EACtC,cAA6B,EAC7B,EACE,EAAE,GAGH,EACqC,EAAE;IACxC,MAAM,QAAQ,GACZ,MAAM,cAAc,CAAC,OAAO,CAC1B,sBAAsB,EACtB;QACE,EAAE;KACH,CACF,CAAA;IACH,IAAI,CAAC,QAAQ,IAAI,CAAC,QAAQ,CAAC,MAAM;QAAE,OAAO,IAAI,CAAA;IAC9C,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,EAAE,GAAG,QAAQ,CAAC,MAAM,CAAA;IAC/C,OAAO;QACL,MAAM;QACN,QAAQ;KACT,CAAA;AACH,CAAC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,kBAAkB,GAAG,KAAK,EAC9B,MAAqB,EACrB,EAAE,IAAI,EAAE,eAAe,EAAgC,EAChB,EAAE;IACzC,MAAM,cAAc,GAAG,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC,CAAA;IACvD,MAAM,EAAE,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAA;IAEzB,MAAM,MAAM,GAAG,eAAe;QAC5B,CAAC,CAAC,MAAM,uBAAuB,CAAC,cAAc,EAAE,EAAE,EAAE,EAAE,eAAe,EAAE,CAAC;QACxE,CAAC,CAAC,MAAM,0BAA0B,CAAC,cAAc,EAAE,EAAE,EAAE,EAAE,CAAC,CAAA;IAC5D,IAAI,CAAC,MAAM;QAAE,OAAO,IAAI,CAAA;IACxB,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAA;IAEnC,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,eAAe,EAAE,GAAG,MAAM,CAAA;IACzD,MAAM,YAAY,GAAG,MAAM,CAAC,QAAQ,CAAC,eAAe,CAAC,GAAG,IAAI,CAAA;IAC5D,MAAM,KAAK,GAAG,QAAQ,EAAE,KAAK,IAAI,EAAE,CAAA;IACnC,MAAM,KAAK,GAAG,QAAQ,EAAE,SAAS,IAAI,EAAE,CAAA;IAEvC,OAAO;QACL,UAAU;QACV,SAAS,EAAE;YACT,IAAI,EAAE,IAAI,IAAI,CAAC,YAAY,CAAC;YAC5B,KAAK,EAAE,YAAY;SACpB;QACD,KAAK;QACL,KAAK;KACN,CAAA;AACH,CAAC,CAAA;AAED,eAAe,kBAAkB,CAAA"}

package/dist/functions/subgraph/getSubgraphRegistrant.d.ts

@@ -0,0 +1,28 @@
+import { type Address } from 'viem';
+import type { ClientWithEns } from '../../contracts/consts.js';
+export type GetSubgraphRegistrantParameters = {
+    /** Name to get registrant for */
+    name: string;
+};
+export type GetSubgraphRegistrantReturnType = Address | null;
+/**
+ * Gets the name registrant from the subgraph.
+ * @param client - {@link ClientWithEns}
+ * @param parameters - {@link GetSubgraphRegistrantParameters}
+ * @returns Registrant address, or null if name was not found. {@link GetSubgraphRegistrantReturnType}
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { getSubgraphRegistrant } from '@ensdomains/ensjs/subgraph'
+ *
+ * const client = createPublicClient({
+ *   chain: addEnsContracts(mainnet),
+ *   transport: http(),
+ * })
+ * const result = await getSubgraphRegistrant(client, { name: 'ens.eth' })
+ * // 0xb6E040C9ECAaE172a89bD561c5F73e1C48d28cd9
+ */
+declare const getSubgraphRegistrant: (client: ClientWithEns, { name }: GetSubgraphRegistrantParameters) => Promise<GetSubgraphRegistrantReturnType>;
+export default getSubgraphRegistrant;

package/dist/functions/subgraph/getSubgraphRegistrant.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getSubgraphRegistrant.js","sourceRoot":"","sources":["../../../src/functions/subgraph/getSubgraphRegistrant.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAA;AACrC,OAAO,EAAgB,UAAU,EAAE,SAAS,EAAE,MAAM,MAAM,CAAA;AAE1D,OAAO,EAAE,wBAAwB,EAAE,MAAM,yBAAyB,CAAA;AAClE,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAA;AACxD,OAAO,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAA;AASlD,MAAM,KAAK,GAAG,GAAG,CAAA;;;;;;;;CAQhB,CAAA;AAUD;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,qBAAqB,GAAG,KAAK,EACjC,MAAqB,EACrB,EAAE,IAAI,EAAmC,EACC,EAAE;IAC5C,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IAC9B,MAAM,QAAQ,GAAG,WAAW,CAAC,IAAI,CAAC,CAAA;IAClC,IAAI,QAAQ,KAAK,SAAS;QACxB,MAAM,IAAI,wBAAwB,CAAC;YACjC,QAAQ;YACR,kBAAkB,EAAE,CAAC,SAAS,CAAC;YAC/B,OAAO,EAAE,kDAAkD;SAC5D,CAAC,CAAA;IAEJ,MAAM,cAAc,GAAG,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC,CAAA;IAEvD,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,OAAO,CAAiB,KAAK,EAAE;QACjE,EAAE,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;KACzB,CAAC,CAAA;IAEF,IAAI,MAAM,EAAE,YAAY,EAAE,UAAU,EAAE,EAAE;QACtC,OAAO,UAAU,CAAC,MAAM,CAAC,YAAY,CAAC,UAAU,CAAC,EAAE,CAAC,CAAA;IACtD,OAAO,IAAI,CAAA;AACb,CAAC,CAAA;AAED,eAAe,qBAAqB,CAAA"}

package/dist/functions/subgraph/getSubnames.d.ts

@@ -0,0 +1,42 @@
+import type { ClientWithEns } from '../../contracts/consts.js';
+import { type Name } from './utils.js';
+type GetSubnamesOrderBy = 'expiryDate' | 'name' | 'labelName' | 'createdAt';
+export type GetSubnamesParameters = {
+    /** Name to get subnames for */
+    name: string;
+    /** Search string filter for subname label */
+    searchString?: string;
+    /** Allows expired names to be included (default: false) */
+    allowExpired?: boolean;
+    /** Allows deleted names to be included (default: false) */
+    allowDeleted?: boolean;
+    /** Parameter to order names by (default: name) */
+    orderBy?: GetSubnamesOrderBy;
+    /** Direction to order names in (default: asc) */
+    orderDirection?: 'asc' | 'desc';
+    /** Previous page of subnames, used for pagination */
+    previousPage?: Name[];
+    /** Page size (default: 100) */
+    pageSize?: number;
+};
+export type GetSubnamesReturnType = Name[];
+/**
+ * Gets the subnames for a name from the subgraph.
+ * @param client - {@link ClientWithEns}
+ * @param parameters - {@link GetSubnamesParameters}
+ * @returns Subname array. {@link GetSubnamesReturnType}
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { getSubnames } from '@ensdomains/ensjs/subgraph'
+ *
+ * const client = createPublicClient({
+ *   chain: addEnsContracts(mainnet),
+ *   transport: http(),
+ * })
+ * const result = await getSubnames(client, { name: 'ens.eth' })
+ */
+declare const getSubnames: (client: ClientWithEns, { name, searchString, allowExpired, allowDeleted, orderBy, orderDirection, pageSize, previousPage, }: GetSubnamesParameters) => Promise<GetSubnamesReturnType>;
+export default getSubnames;

package/dist/functions/subgraph/getSubnames.js

@@ -0,0 +1,159 @@
+/* eslint-disable @typescript-eslint/naming-convention */
+import { gql } from 'graphql-request';
+import { InvalidOrderByError } from '../../errors/subgraph.js';
+import { EMPTY_ADDRESS } from '../../utils/consts.js';
+import { namehash } from '../../utils/normalise.js';
+import { createSubgraphClient } from './client.js';
+import { getCreatedAtOrderFilter, getExpiryDateOrderFilter, } from './filters.js';
+import { domainDetailsWithoutParentFragment, registrationDetailsFragment, wrappedDomainDetailsFragment, } from './fragments.js';
+import { makeNameObject } from './utils.js';
+const getOrderByFilter = ({ orderBy, orderDirection, previousPage, }) => {
+    const lastDomain = previousPage[previousPage.length - 1];
+    const operator = orderDirection === 'asc' ? 'gt' : 'lt';
+    switch (orderBy) {
+        case 'expiryDate': {
+            return getExpiryDateOrderFilter({
+                lastDomain,
+                orderDirection,
+            });
+        }
+        case 'name': {
+            return {
+                [`name_${operator}`]: lastDomain.name ?? '',
+            };
+        }
+        case 'labelName': {
+            return {
+                [`labelName_${operator}`]: lastDomain.labelName ?? '',
+            };
+        }
+        case 'createdAt': {
+            return getCreatedAtOrderFilter({ lastDomain, orderDirection });
+        }
+        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}
+ * @param parameters - {@link GetSubnamesParameters}
+ * @returns Subname array. {@link GetSubnamesReturnType}
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { getSubnames } from '@ensdomains/ensjs/subgraph'
+ *
+ * const client = createPublicClient({
+ *   chain: addEnsContracts(mainnet),
+ *   transport: http(),
+ * })
+ * const result = await getSubnames(client, { name: 'ens.eth' })
+ */
+const getSubnames = async (client, { name, searchString, allowExpired = false, allowDeleted = false, orderBy = 'name', orderDirection = 'asc', pageSize = 100, previousPage, }) => {
+    const subgraphClient = createSubgraphClient({ client });
+    const whereFilters = [];
+    if (previousPage?.length) {
+        whereFilters.push(getOrderByFilter({
+            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: `${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,
+        });
+    }
+    let whereFilter = {};
+    if (whereFilters.length > 1) {
+        whereFilter = {
+            and: whereFilters,
+        };
+    }
+    else if (whereFilters.length === 1) {
+        ;
+        [whereFilter] = whereFilters;
+    }
+    const query = gql `
+    query getSubnames(
+      $id: String!
+      $orderBy: Domain_orderBy
+      $orderDirection: OrderDirection
+      $whereFilter: Domain_filter
+      $first: Int
+    ) {
+      domain(id: $id) {
+        subdomains(
+          orderBy: $orderBy
+          orderDirection: $orderDirection
+          first: $first
+          where: $whereFilter
+        ) {
+          ...DomainDetailsWithoutParent
+          registration {
+            ...RegistrationDetails
+          }
+          wrappedDomain {
+            ...WrappedDomainDetails
+          }
+        }
+      }
+    }
+    ${domainDetailsWithoutParentFragment}
+    ${registrationDetailsFragment}
+    ${wrappedDomainDetailsFragment}
+  `;
+    const queryVars = {
+        id: namehash(name),
+        orderBy,
+        orderDirection,
+        first: pageSize,
+        whereFilter,
+    };
+    const result = await subgraphClient.request(query, queryVars);
+    if (!result.domain)
+        return [];
+    const names = result.domain.subdomains.map((domain) => makeNameObject({ ...domain, parent: { name } }));
+    return names;
+};
+export default getSubnames;
+//# sourceMappingURL=getSubnames.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"getSubnames.js","sourceRoot":"","sources":["../../../src/functions/subgraph/getSubnames.ts"],"names":[],"mappings":"AAAA,yDAAyD;AACzD,OAAO,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAA;AAErC,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AAC9D,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAA;AACrD,OAAO,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAA;AACnD,OAAO,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAA;AAClD,OAAO,EAEL,uBAAuB,EACvB,wBAAwB,GACzB,MAAM,cAAc,CAAA;AACrB,OAAO,EAEL,kCAAkC,EAClC,2BAA2B,EAC3B,4BAA4B,GAC7B,MAAM,gBAAgB,CAAA;AACvB,OAAO,EAAa,cAAc,EAAE,MAAM,YAAY,CAAA;AA+BtD,MAAM,gBAAgB,GAAG,CAAC,EACxB,OAAO,EACP,cAAc,EACd,YAAY,GAGb,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,CAAC;QAChB,KAAK,YAAY,CAAC,CAAC,CAAC;YAClB,OAAO,wBAAwB,CAAC;gBAC9B,UAAU;gBACV,cAAc;aACf,CAAC,CAAA;QACJ,CAAC;QACD,KAAK,MAAM,CAAC,CAAC,CAAC;YACZ,OAAO;gBACL,CAAC,QAAQ,QAAQ,EAAE,CAAC,EAAE,UAAU,CAAC,IAAI,IAAI,EAAE;aAC5C,CAAA;QACH,CAAC;QACD,KAAK,WAAW,CAAC,CAAC,CAAC;YACjB,OAAO;gBACL,CAAC,aAAa,QAAQ,EAAE,CAAC,EAAE,UAAU,CAAC,SAAS,IAAI,EAAE;aACtD,CAAA;QACH,CAAC;QACD,KAAK,WAAW,CAAC,CAAC,CAAC;YACjB,OAAO,uBAAuB,CAAC,EAAE,UAAU,EAAE,cAAc,EAAE,CAAC,CAAA;QAChE,CAAC;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;IACN,CAAC;AACH,CAAC,CAAA;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,WAAW,GAAG,KAAK,EACvB,MAAqB,EACrB,EACE,IAAI,EACJ,YAAY,EACZ,YAAY,GAAG,KAAK,EACpB,YAAY,GAAG,KAAK,EACpB,OAAO,GAAG,MAAM,EAChB,cAAc,GAAG,KAAK,EACtB,QAAQ,GAAG,GAAG,EACd,YAAY,GACU,EACQ,EAAE;IAClC,MAAM,cAAc,GAAG,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC,CAAA;IAEvD,MAAM,YAAY,GAAmB,EAAE,CAAA;IAEvC,IAAI,YAAY,EAAE,MAAM,EAAE,CAAC;QACzB,YAAY,CAAC,IAAI,CACf,gBAAgB,CAAC;YACf,OAAO;YACP,cAAc;YACd,YAAY;SACb,CAAC,CACH,CAAA;IACH,CAAC;IAED,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,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;IACJ,CAAC;IAED,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,4BAA4B;QAC5B,wCAAwC;QACxC,YAAY,CAAC,IAAI,CAAC;YAChB,EAAE,EAAE;gBACF;oBACE,SAAS,EAAE,aAAa;iBACzB;gBACD;oBACE,YAAY,EAAE,IAAI;iBACnB;gBACD,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,KAAK;oBAC9B,CAAC,CAAC;wBACE;4BACE,cAAc,EAAE,aAAa;yBAC9B;qBACF;oBACH,CAAC,CAAC,EAAE,CAAC;aACR;SACF,CAAC,CAAA;IACJ,CAAC;IAED,IAAI,YAAY,EAAE,CAAC;QACjB,0EAA0E;QAC1E,2BAA2B;QAC3B,YAAY,CAAC,IAAI,CAAC;YAChB,kBAAkB,EAAE,YAAY;SACjC,CAAC,CAAA;IACJ,CAAC;IAED,IAAI,WAAW,GAAiB,EAAE,CAAA;IAElC,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC5B,WAAW,GAAG;YACZ,GAAG,EAAE,YAAY;SAClB,CAAA;IACH,CAAC;SAAM,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACrC,CAAC;QAAA,CAAC,WAAW,CAAC,GAAG,YAAY,CAAA;IAC/B,CAAC;IAED,MAAM,KAAK,GAAG,GAAG,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;MAyBb,kCAAkC;MAClC,2BAA2B;MAC3B,4BAA4B;GAC/B,CAAA;IAED,MAAM,SAAS,GAAG;QAChB,EAAE,EAAE,QAAQ,CAAC,IAAI,CAAC;QAClB,OAAO;QACP,cAAc;QACd,KAAK,EAAE,QAAQ;QACf,WAAW;KACZ,CAAA;IAED,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,OAAO,CACzC,KAAK,EACL,SAAS,CACV,CAAA;IAED,IAAI,CAAC,MAAM,CAAC,MAAM;QAAE,OAAO,EAAE,CAAA;IAE7B,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CACpD,cAAc,CAAC,EAAE,GAAG,MAAM,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,CAAC,CAChD,CAAA;IAED,OAAO,KAAK,CAAA;AACd,CAAC,CAAA;AAED,eAAe,WAAW,CAAA"}

package/dist/functions/subgraph/types.d.ts

@@ -0,0 +1,12 @@
+import type { Hex } from 'viem';
+export type InputMaybe<T> = T | null;
+/** All built-in and custom scalars, mapped to their actual values */
+export type Scalars = {
+    ID: string;
+    String: string;
+    Boolean: boolean;
+    Int: number;
+    Float: number;
+    Bytes: Hex;
+    BigInt: string;
+};

package/dist/functions/subgraph/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/functions/subgraph/types.ts"],"names":[],"mappings":""}