@ensdomains/ensjs 2.0.1 → 3.0.0-alpha.10

package/dist/esm/functions/getHistory.js

@@ -0,0 +1,273 @@
+import { formatsByCoinType } from '@ensdomains/address-encoder';
+import { ethers } from 'ethers';
+import { decodeContenthash } from '../utils/contentHash';
+import { makeOtherIndexes } from '../utils/makeHashIndexes';
+const eventFormat = {
+    Domain: {
+        NewOwner: (args) => ({ owner: args.owner.id }),
+        NewResolver: (args) => ({ resolver: args.resolver.id.split('-')[0] }),
+        Transfer: (args) => ({ owner: args.owner.id }),
+        NewTTL: (args) => ({ ttl: args.ttl }),
+    },
+    Registration: {
+        NameRegistered: (args) => ({
+            registrant: args.registrant.id,
+            expiryDate: args.expiryDate,
+        }),
+        NameRenewed: (args) => ({ expiryDate: args.expiryDate }),
+        NameTransferred: (args) => ({ owner: args.newOwner.id }),
+    },
+    Resolver: {
+        AddrChanged: (args) => ({ addr: args.addr.id }),
+        MulticoinAddrChanged: (args) => {
+            const format = formatsByCoinType[parseInt(args.coinType)];
+            if (!format) {
+                return {
+                    coinType: args.coinType,
+                    rawAddr: args.multiaddr,
+                };
+            }
+            if (ethers.utils.hexStripZeros(args.multiaddr) === '0x') {
+                return {
+                    coinType: args.coinType,
+                    coinName: format.name,
+                    rawAddr: '0x',
+                };
+            }
+            return {
+                coinType: args.coinType,
+                coinName: format.name,
+                addr: format.encoder(Buffer.from(args.multiaddr.slice(2), 'hex')),
+            };
+        },
+        NameChanged: (args) => ({ name: args.name }),
+        AbiChanged: (args) => ({ contentType: args.contentType }),
+        PubkeyChanged: (args) => ({ x: args.x, y: args.y }),
+        TextChanged: (args) => ({ key: args.key }),
+        ContenthashChanged: (args) => ({ hash: decodeContenthash(args.hash) }),
+        InterfaceChanged: (args) => ({
+            interfaceId: args.interfaceId,
+            implementer: args.implementer,
+        }),
+        AuthorisationChanged: (args) => ({
+            owner: args.owner,
+            target: args.target,
+            isAuthorized: args.isAuthorized,
+        }),
+    },
+};
+const mapEvents = (eventArray, type) => eventArray.map((event) => ({
+    type: event.__typename,
+    blockNumber: event.blockNumber,
+    transactionHash: event.transactionID,
+    id: event.id,
+    data: eventFormat[type][event.__typename](event),
+}));
+const mapResultDetailDecode = (publicResolver) => (result) => {
+    const hashIndexes = makeOtherIndexes(result.input, '10f13a8c');
+    const abiLengths = hashIndexes.map((x) => ({
+        index: x,
+        length: x === 0
+            ? ethers.utils.hexDataLength(result.input)
+            : parseInt(ethers.utils.hexDataSlice(result.input, x - 32, x), 16),
+    }));
+    const ABIs = abiLengths.map(({ index, length }) => ethers.utils.hexDataSlice(result.input, index, index + length));
+    return ABIs.map((abi) => {
+        try {
+            return publicResolver.interface.decodeFunctionData('setText(bytes32,string,string)', abi);
+        }
+        catch {
+            return;
+        }
+    });
+};
+const expandDecode = (prev, curr) => {
+    if (!curr)
+        return [...prev, { value: null }];
+    if (!curr.length)
+        return [...prev, curr];
+    return [...prev, ...curr];
+};
+export async function getHistory({ gqlInstance }, name) {
+    const client = gqlInstance.client;
+    const query = gqlInstance.gql `
+      query getHistory($name: String!, $label: String!) {
+        domains(where: { name: $name }) {
+          events {
+            id
+            blockNumber
+            transactionID
+            __typename
+            ...on Transfer {
+              owner {
+                id
+              }
+            }
+            ...on NewOwner {
+              owner {
+                id
+              }
+            }
+            ...on NewResolver {
+              resolver {
+                id
+              }
+            }
+            ...on NewTTL {
+              ttl
+            }
+          }
+          owner {
+            registrations (where: { labelName: $label }) {
+              events {
+                id
+                blockNumber
+                transactionID
+                __typename
+                ...on NameRegistered {
+                  registrant {
+                    id
+                  }
+                  expiryDate
+                }
+                ...on NameRenewed {
+                  expiryDate
+                }
+                ...on NameTransferred {
+                  newOwner {
+                    id
+                  }
+                }
+              }
+            }
+          }
+          resolver {
+            events {
+              id
+              blockNumber
+              transactionID
+              __typename
+              ...on AddrChanged {
+                addr {
+                  id
+                }
+              }
+              ...on MulticoinAddrChanged {
+                coinType
+                multiaddr: addr
+              }
+              ...on NameChanged {
+                name
+              }
+              ...on AbiChanged {
+                contentType
+              }
+              ...on PubkeyChanged {
+                x
+                y
+              }
+              ...on TextChanged {
+                key
+              }
+              ...on ContenthashChanged {
+                hash
+              }
+              ...on InterfaceChanged {
+                interfaceID
+                implementer
+              }
+              ...on AuthorisationChanged {
+                owner
+                target
+                isAuthorized
+              }
+            }
+          }
+        }
+      }
+      `;
+    const label = name.split('.')[0];
+    const { domains } = await client.request(query, { name, label });
+    if (!domains || domains.length === 0)
+        return;
+    const [{ events: domainEvents, owner: { registrations: [{ events: registrationEvents }], }, resolver: { events: resolverEvents }, },] = domains;
+    const domainHistory = mapEvents(domainEvents, 'Domain');
+    const registrationHistory = mapEvents(registrationEvents, 'Registration');
+    let resolverHistory = mapEvents(
+    // remove duplicate events for ETH cointype
+    resolverEvents.filter((event) => !event.coinType || event.coinType !== '60'), 'Resolver');
+    return {
+        domain: domainHistory,
+        registration: registrationHistory,
+        resolver: resolverHistory,
+    };
+}
+export async function getHistoryWithDetail({ contracts, gqlInstance, provider, }, name) {
+    const historyRes = await getHistory({ gqlInstance }, name);
+    if (!historyRes)
+        return;
+    const { domain, registration, resolver: resolverHistory } = historyRes;
+    const textEvents = resolverHistory.filter((event) => event.type === 'TextChanged');
+    const transactions = textEvents.reduce((prev, curr) => {
+        if (prev.includes(curr.transactionHash)) {
+            return prev;
+        }
+        return [...prev, curr.transactionHash];
+    }, []);
+    const publicResolver = await contracts?.getPublicResolver();
+    const fetchResult = (await ethers.utils.fetchJson(provider.connection, JSON.stringify(transactions.map((tx, i) => ({
+        jsonrpc: '2.0',
+        id: i,
+        method: 'eth_getTransactionByHash',
+        params: [tx],
+    })))))
+        .map((result) => result.result)
+        .map(mapResultDetailDecode(publicResolver))
+        .reduce(expandDecode, []);
+    const detailedResolverHistory = resolverHistory.map((event) => {
+        if (event.type !== 'TextChanged')
+            return event;
+        const { id } = event;
+        const matchedTextInx = textEvents.findIndex((x) => x.id === id);
+        return {
+            ...event,
+            data: {
+                ...event.data,
+                value: fetchResult[matchedTextInx] && fetchResult[matchedTextInx].value,
+            },
+        };
+    });
+    return {
+        domain,
+        registration,
+        resolver: detailedResolverHistory,
+    };
+}
+export async function getHistoryDetailForTransactionHash({ contracts, provider }, hash, indexInTransaction) {
+    const publicResolver = await contracts?.getPublicResolver();
+    const transaction = await provider.getTransaction(hash);
+    if (!transaction)
+        return;
+    const result = mapResultDetailDecode(publicResolver)({
+        input: transaction.data,
+    });
+    if (!result || !result.length)
+        return;
+    if (typeof indexInTransaction === 'number') {
+        if (indexInTransaction + 1 > result.length)
+            return;
+        const resultItem = result[indexInTransaction];
+        if (!resultItem ||
+            !resultItem.key ||
+            (!resultItem.value && resultItem.value !== ''))
+            return;
+        return { key: resultItem.key, value: resultItem.value };
+    }
+    return result.map((item) => {
+        if (!item.key)
+            return;
+        if (!item.value && item.value !== '')
+            return { key: item.key, value: null };
+        return { key: item.key, value: item.value };
+    });
+}

package/dist/esm/functions/getName.d.ts

@@ -0,0 +1,19 @@
+import { ENSArgs } from '..';
+declare const _default: {
+    raw: ({ contracts }: ENSArgs<"contracts">, address: string) => Promise<{
+        to: string;
+        data: string;
+    }>;
+    decode: ({ contracts }: ENSArgs<"contracts">, data: string, address: string) => Promise<{
+        name: any;
+        match: boolean;
+        reverseResolverAddress: any;
+        resolverAddress: any;
+    } | {
+        name: null;
+        match: boolean;
+        reverseResolverAddress?: undefined;
+        resolverAddress?: undefined;
+    } | undefined>;
+};
+export default _default;

package/dist/esm/functions/getName.js

@@ -0,0 +1,32 @@
+import { hexEncodeName } from '../utils/hexEncodedName';
+const raw = async ({ contracts }, address) => {
+    const universalResolver = await contracts?.getUniversalResolver();
+    const reverseNode = address.toLowerCase().substring(2) + '.addr.reverse';
+    return {
+        to: universalResolver.address,
+        data: universalResolver.interface.encodeFunctionData('reverse', [
+            hexEncodeName(reverseNode),
+        ]),
+    };
+};
+const decode = async ({ contracts }, data, address) => {
+    if (data === null)
+        return;
+    const universalResolver = await contracts?.getUniversalResolver();
+    try {
+        const result = universalResolver.interface.decodeFunctionResult('reverse', data);
+        return {
+            name: result['0'],
+            match: result['1'].toLowerCase() === address.toLowerCase(),
+            reverseResolverAddress: result['2'],
+            resolverAddress: result['3'],
+        };
+    }
+    catch {
+        return { name: null, match: false };
+    }
+};
+export default {
+    raw,
+    decode,
+};

package/dist/esm/functions/getNames.d.ts

@@ -0,0 +1,40 @@
+import { ENSArgs } from '..';
+export declare type Name = {
+    id: string;
+    labelName: string | null;
+    truncatedName?: string;
+    labelhash: string;
+    isMigrated: boolean;
+    name: string;
+    parent: {
+        name: string;
+    };
+    createdAt?: Date;
+    registrationDate?: Date;
+    expiryDate?: Date;
+    type: 'domain' | 'registration';
+};
+declare type BaseParams = {
+    address: string;
+    type: 'registrant' | 'owner' | 'all';
+    page?: number;
+    pageSize?: number;
+    orderDirection?: 'asc' | 'desc';
+};
+declare type RegistrantParams = {
+    type: 'registrant';
+    orderBy?: 'registrationDate' | 'expiryDate' | 'labelName';
+};
+declare type OwnerParams = {
+    type: 'owner';
+    orderBy?: 'createdAt' | 'labelName';
+};
+declare type AllParams = {
+    type: 'all';
+    orderBy?: 'labelName' | 'creationDate';
+    page?: never;
+    pageSize?: never;
+};
+declare type Params = BaseParams & (RegistrantParams | OwnerParams | AllParams);
+declare const getNames: ({ gqlInstance }: ENSArgs<'gqlInstance'>, { address: _address, type, page, pageSize, orderDirection, orderBy, }: Params) => Promise<Name[]>;
+export default getNames;

package/dist/esm/functions/getNames.js

@@ -0,0 +1,220 @@
+import { truncateFormat } from '../utils/format';
+import { decryptName } from '../utils/labels';
+const mapDomain = (domain) => {
+    const decrypted = decryptName(domain.name);
+    return {
+        ...domain,
+        name: decrypted,
+        truncatedName: truncateFormat(decrypted),
+        createdAt: new Date(parseInt(domain.createdAt) * 1000),
+        type: 'domain',
+    };
+};
+const mapRegistration = (registration) => {
+    const decrypted = decryptName(registration.domain.name);
+    return {
+        expiryDate: new Date(parseInt(registration.expiryDate) * 1000),
+        registrationDate: new Date(parseInt(registration.registrationDate) * 1000),
+        ...registration.domain,
+        name: decrypted,
+        truncatedName: truncateFormat(decrypted),
+        type: 'registration',
+    };
+};
+const getNames = async ({ gqlInstance }, { address: _address, type, page, pageSize = 10, orderDirection, orderBy, }) => {
+    const address = _address.toLowerCase();
+    const client = gqlInstance.client;
+    const domainQueryData = `
+    id
+    labelName
+    labelhash
+    name
+    isMigrated
+    parent {
+        name
+    }
+  `;
+    let queryVars = {};
+    let finalQuery = '';
+    if (type === 'all') {
+        finalQuery = gqlInstance.gql `
+      query getNames(
+        $id: ID!
+        $expiryDate: Int
+      ) {
+        account(id: $id) {
+          registrations(
+            first: 1000
+            where: { expiryDate_gt: $expiryDate }
+          ) {
+            registrationDate
+            expiryDate
+            domain {
+              ${domainQueryData}
+            }
+          }
+          domains(first: 1000) {
+            ${domainQueryData}
+            createdAt
+          }
+        }
+      }
+    `;
+        queryVars = {
+            id: address,
+            expiryDate: Math.floor(Date.now() / 1000) - 90 * 24 * 60 * 60,
+        };
+    }
+    else if (type === 'owner') {
+        if (typeof page !== 'number') {
+            finalQuery = gqlInstance.gql `
+        query getNames(
+          $id: ID! 
+          $orderBy: Domain_orderBy 
+          $orderDirection: OrderDirection
+        ) {
+          account(id: $id) {
+            domains(orderBy: $orderBy, orderDirection: $orderDirection) {
+              ${domainQueryData}
+              createdAt
+            }
+          }
+        }
+      `;
+            queryVars = {
+                id: address,
+                orderBy,
+                orderDirection,
+            };
+        }
+        else {
+            finalQuery = gqlInstance.gql `
+        query getNames(
+          $id: ID!
+          $first: Int
+          $skip: Int
+          $orderBy: Domain_orderBy
+          $orderDirection: OrderDirection
+        ) {
+          account(id: $id) {
+            domains(
+              first: $first
+              skip: $skip
+              orderBy: $orderBy
+              orderDirection: $orderDirection
+            ) {
+              ${domainQueryData}
+              createdAt
+            }
+          }
+        }
+      `;
+            queryVars = {
+                id: address,
+                first: pageSize,
+                skip: (page || 0) * pageSize,
+                orderBy,
+                orderDirection,
+            };
+        }
+    }
+    else {
+        if (typeof page !== 'number') {
+            finalQuery = gqlInstance.gql `
+        query getNames(
+          $id: ID!
+          $orderBy: Registration_orderBy
+          $orderDirection: OrderDirection
+          $expiryDate: Int
+        ) {
+          account(id: $id) {
+            registrations(
+              orderBy: $orderBy
+              orderDirection: $orderDirection
+              where: { expiryDate_gt: $expiryDate }
+            ) {
+              registrationDate
+              expiryDate
+              domain {
+                ${domainQueryData}
+              }
+            }
+          }
+        }
+      `;
+            queryVars = {
+                id: address,
+                orderBy,
+                orderDirection,
+                expiryDate: Math.floor(Date.now() / 1000) - 90 * 24 * 60 * 60,
+            };
+        }
+        else {
+            finalQuery = gqlInstance.gql `
+        query getNames(
+          $id: ID!
+          $first: Int
+          $skip: Int
+          $orderBy: Registration_orderBy
+          $orderDirection: OrderDirection
+          $expiryDate: Int
+        ) {
+          account(id: $id) {
+            registrations(
+              first: $first
+              skip: $skip
+              orderBy: $orderBy
+              orderDirection: $orderDirection
+              where: { expiryDate_gt: $expiryDate }
+            ) {
+              registrationDate
+              expiryDate
+              domain {
+                ${domainQueryData}
+              }
+            }
+          }
+        }
+      `;
+            queryVars = {
+                id: address,
+                first: pageSize,
+                skip: (page || 0) * pageSize,
+                orderBy: orderBy,
+                orderDirection: orderDirection,
+                expiryDate: Math.floor(Date.now() / 1000) - 90 * 24 * 60 * 60,
+            };
+        }
+    }
+    const { account } = await client.request(finalQuery, queryVars);
+    if (type === 'all') {
+        return [
+            ...account.domains.map(mapDomain),
+            ...account.registrations.map(mapRegistration),
+        ].sort((a, b) => {
+            if (orderDirection === 'desc') {
+                if (orderBy === 'labelName') {
+                    return b.name.localeCompare(a.name);
+                }
+                else {
+                    return b.createdAt.getTime() - a.createdAt.getTime();
+                }
+            }
+            else {
+                if (orderBy === 'labelName') {
+                    return a.name.localeCompare(b.name);
+                }
+                else if (orderBy === 'creationDate') {
+                    return a.createdAt.getTime() - b.createdAt.getTime();
+                }
+            }
+        });
+    }
+    else if (type === 'owner') {
+        return account.domains.map(mapDomain);
+    }
+    else {
+        return account.registrations.map(mapRegistration);
+    }
+};
+export default getNames;

package/dist/esm/functions/getOwner.d.ts

@@ -0,0 +1,14 @@
+import { ENSArgs } from '..';
+declare type Owner = {
+    registrant?: string;
+    owner?: string;
+    ownershipLevel: 'nameWrapper' | 'registry' | 'registrar';
+};
+declare const _default: {
+    raw: ({ contracts, multicallWrapper }: ENSArgs<"contracts" | "multicallWrapper">, name: string, contract?: "nameWrapper" | "registrar" | "registry" | undefined) => Promise<{
+        to: string;
+        data: string;
+    }>;
+    decode: ({ contracts, multicallWrapper }: ENSArgs<"contracts" | "multicallWrapper">, data: string, name: string, contract?: "nameWrapper" | "registrar" | "registry" | undefined) => Promise<Owner | undefined>;
+};
+export default _default;