Add functionality to zNS SDK to support zNA resolution

src/api/dataStoreApi/actions/getDomainResourceAssociations.ts

@@ -0,0 +1,20 @@
+import { Maybe } from "../../../types";
+import { ResourceAssociation } from "../types";
+import { makeApiCall } from "../../helpers";
+
+export const getDomainResourceAssociations = async (
+  apiUri: string,
+  domainId: string
+): Promise<ResourceAssociation[]> => {
+  let response: Maybe<ResourceAssociation[]>;
+  try {
+    response = await makeApiCall<ResourceAssociation[]>(
+      `${apiUri}v1/domains/resource/${domainId}`,
+      "GET"
+    );
+  } catch (e) {
+    throw Error(`Failed to get domain resource associations: ${domainId}`);
+  }
+
+  return response;
+};

src/api/dataStoreApi/actions/getResourceRegistry.ts

@@ -0,0 +1,20 @@
+import { Maybe } from "../../../types";
+import { ResourceRegistry } from "../types";
+import { makeApiCall } from "../../helpers";
+
+export const getResourceRegistry = async (
+  apiUri: string,
+  resourceType: string
+): Promise<Maybe<ResourceRegistry>> => {
+  let response: Maybe<ResourceRegistry>;
+  try {
+    response = await makeApiCall<ResourceRegistry>(
+      `${apiUri}v1/resource-registry/get/${resourceType}`,
+      "GET"
+    );
+  } catch (e) {
+    throw Error(`Failed to get resource registry: ${resourceType}`);
+  }
+
+  return response;
+};

src/api/dataStoreApi/actions/index.ts

@@ -3,3 +3,5 @@ export * from "./getMostRecentSubdomainsById";
 export * from "./getDomainsByOwner";
 export * from "./getDomainById";
 export * from "./getSubdomainsByIdDeep";
+export * from "./getDomainResourceAssociations";
+export * from "./getResourceRegistry";

src/api/dataStoreApi/client.ts

@@ -1,7 +1,11 @@
 import { Domain, Maybe } from "../../types";
 import * as actions from "./actions";
 import { getLogger } from "../../utilities";
-import { DomainSortOptions } from "./types";
+import {
+  DomainSortOptions,
+  ResourceAssociation,
+  ResourceRegistry
+} from "./types";
 
 const logger = getLogger("api:client");
 
@@ -32,6 +36,12 @@ export interface DataStoreApiClient {
     limit: number,
     skip: number
   ) => Promise<Domain[]>;
+  getDomainResourceAssociations: (
+    domainId: string
+  ) => Promise<ResourceAssociation[]>;
+  getResourceRegistry: (
+    resourceType: string
+  ) => Promise<Maybe<ResourceRegistry>>;
 }
 
 export const createDataStoreApiClient = (
@@ -115,6 +125,26 @@ export const createDataStoreApiClient = (
 
       return domains;
     },
+
+    getDomainResourceAssociations: async (
+      domainId: string
+    ): Promise<ResourceAssociation[]> => {
+      logger.debug("Calling to getDomainResourceAssociations");
+      const resourceAssociations: ResourceAssociation[] =
+        await actions.getDomainResourceAssociations(apiUri, domainId);
+
+      return resourceAssociations;
+    },
+
+    getResourceRegistry: async (
+      resourceType: string
+    ): Promise<Maybe<ResourceRegistry>> => {
+      logger.debug("Calling to getResourceRegistry");
+      const resourceRegistry: Maybe<ResourceRegistry> =
+        await actions.getResourceRegistry(apiUri, resourceType);
+
+      return resourceRegistry;
+    },
   };
 
   return apiClient;

src/api/dataStoreApi/helpers/datastoreDomainToDomain.ts

@@ -22,6 +22,7 @@ export function datastoreDomainToDomain(d: DataStoreDomain): Domain {
     contract: d.registrar.toLowerCase(),
     isRoot: d.isRoot,
     buyNow: buyNow,
+    resources: d.resources,
   };
   return domain;
 }

src/api/dataStoreApi/types.ts

@@ -37,6 +37,7 @@ export interface DataStoreDomain {
   buyNow: BuyNow;
   locked: boolean; // Older domains may not have these properties
   lockedBy: string;
+  resources: ResourceAssociations;
 }
 
 export interface BuyNowPriceListing {
@@ -50,6 +51,19 @@ export interface BuyNow {
   isActive: boolean;
 }
 
+export interface ResourceRegistry {
+  resourceType: string;
+  resourceRegistry: string;
+}
+
+export interface ResourceAssociation extends ResourceRegistry {
+  resourceId: string;
+}
+
+export interface ResourceAssociations {
+  [resourceType: string]: ResourceAssociation;
+}
+
 type Show = 1;
 type Hide = 0;
 type OptionsValue = Show | Hide;

src/index.ts

@@ -46,7 +46,11 @@ import {
   DomainPurchaserConfig,
   NetworkDomainMintableConfig,
 } from "./actions/minting/types";
-import { DomainSortOptions } from "./api/dataStoreApi/types";
+import {
+  DomainSortOptions,
+  ResourceAssociation,
+  ResourceRegistry,
+} from "./api/dataStoreApi/types";
 
 export * from "./types";
 export { configuration };
@@ -189,6 +193,16 @@ export const createInstance = (config: Config): Instance => {
     getAllDomains: subgraphClient.getAllDomains,
     getDomainMetrics: async (domainIds: string[]) =>
       getDomainMetrics(config.metricsUri, domainIds),
+    getDomainResourceAssociations: async (
+      domainId: string
+    ): Promise<ResourceAssociation[]> => {
+      return await dataStoreApiClient.getDomainResourceAssociations(domainId);
+    },
+    getResourceRegistry: async (
+      resourceType: string
+    ): Promise<Maybe<ResourceRegistry>> => {
+      return await dataStoreApiClient.getResourceRegistry(resourceType);
+    },
     mintSubdomain: async (
       params: SubdomainParams,
       signer: ethers.Signer,

src/types.ts

@@ -4,6 +4,9 @@ import { Bid, BuyNowListing } from "./zAuction";
 import {
   BuyNowPriceListing,
   DomainSortOptions,
+  ResourceAssociation,
+  ResourceAssociations,
+  ResourceRegistry,
 } from "./api/dataStoreApi/types";
 
 export type DexSubgraphUris = Map<string>;
@@ -244,6 +247,20 @@ export interface Instance {
    */
   getDomainMetrics(domainIds: string[]): Promise<DomainMetricsCollection>;
 
+  /**
+   * Gets all the resource associations for a domain
+   * @param domainId Domain id to get resource associations for
+   */
+  getDomainResourceAssociations(
+    domainId: string
+  ): Promise<ResourceAssociation[]>;
+
+  /**
+   * Get resource registry information for a resource type
+   * @param resourceType Resource type to get resource registry for
+   */
+  getResourceRegistry(resourceType: string): Promise<Maybe<ResourceRegistry>>;
+
   /**
    * Mints a new subdomain
    * @param params The subdomain parameters
@@ -800,6 +817,7 @@ export interface Domain {
   created?: Created;
   isRoot?: boolean;
   buyNow?: BuyNowPriceListing;
+  resources?: ResourceAssociations;
 }
 
 export interface DomainMetadata {

test/e2e.test.ts

@@ -62,11 +62,14 @@ describe("SDK test", () => {
     const info = await sdk.zauction.getPaymentTokenInfo(tokenOnUniNotCG);
     expect(info.symbol).to.eq("SHKOOBYSHNAX");
   });
-  it("Reaches out to Sushiswap for a coin that's not on Uniswap", async () => {
+
+  // Sushiswap subgraph no longer exists, so these tests are disabled until a new backup for token info is found.
+  // See https://wilderworld.atlassian.net/browse/MUD-210
+  xit("Reaches out to Sushiswap for a coin that's not on Uniswap", async () => {
     const info = await sdk.zauction.getPaymentTokenInfo(tokenOnSushiNotUni);
     expect(info.symbol).to.eq("KING");
   });
-  it("Fails when token is not found", async () => {
+  xit("Fails when token is not found", async () => {
     return await sdk.zauction.getPaymentTokenInfo(randomToken)
       .catch(error => {
         const expectedMessage = `Token info with address ${randomToken} could not be found`;