@eluvio/elv-client-js 3.2.16 → 3.2.20

package/src/walletClient/Configuration.js

@@ -1,6 +1,7 @@
 let WalletConfiguration = {
   demo: {
     configUrl: "https://demov3.net955210.contentfabric.io/config",
+    stateStoreUrls: ["https://appsvc.svc.eluv.io/dv3"],
     staging: {
       siteId: "iq__2gkNh8CCZqFFnoRpEUmz7P3PaBQG",
       purchaseMode: "develop",
@@ -9,6 +10,7 @@ let WalletConfiguration = {
   },
   main: {
     configUrl: "https://main.net955305.contentfabric.io/config",
+    stateStoreUrls: ["https://appsvc.svc.eluv.io/main"],
     staging: {
       siteId: "iq__inauxD1KLyKWPHargCWjdCh2ayr",
       purchaseMode: "production",
@@ -21,6 +23,7 @@ let WalletConfiguration = {
     }
   },
   __MARKETPLACE_ORDER: [
+    "PREVIEW",
     "dolly-marketplace",
     "oc-marketplace",
     "maskverse-marketplace",

package/src/walletClient/Profile.js

@@ -0,0 +1,182 @@
+const Utils = require("../Utils");
+const UrlJoin = require("url-join");
+
+const StateStorePath = ({network, path}) => {
+  return UrlJoin(network === "main" ? "/main" : "/dv3", path);
+};
+
+const UserProfilePath = ({network, appId, userAddress, key, type, mode}) => {
+  return StateStorePath({network, path: UrlJoin(type === "app" ? "app" : "usr", type === "app" ? appId : "", userAddress, mode === "public" ? "pub" : "pri", key || "")});
+};
+
+/**
+ * Methods related to getting and setting user profile data.
+ *
+ * @module ProfileMethods
+ */
+
+/**
+ * Retrieve user profile metadata for the specified user
+ *
+ * @methodGroup ProfileMetadata
+ * @namedParams
+ * @param {string=} type="app" - Specify `app` or `user` metadata.
+ * @param {string=} mode="public" - Specify `public` or `private` metadata. If private is specified, you may only retrieve metadata for the current user.
+ * @param {string=} appId - Namespace to use for the metadata, if retrieving app metadata. Uses the app ID specified on client initialization by default.
+ * @param {string=} userAddress - User to retrieve metadata for. If not specified, will retrieve metadata for the current user
+ * @param {string=} key - The metadata key to retrieve
+ *
+ * @returns {Promise<Object|String>} - Returns the specified metadata
+ */
+exports.ProfileMetadata = async function({type="app", mode="public", appId, userAddress, key}) {
+  try {
+    const response = await this.stateStoreClient.Request({
+      path: UserProfilePath({
+        network: this.network,
+        appId: appId || this.appId,
+        userAddress: userAddress || this.UserAddress(),
+        type,
+        mode,
+        key
+      }),
+      headers: mode === "private" ?
+        {Authorization: `Bearer ${this.AuthToken()}`} : undefined
+    });
+
+    if(!response.ok) {
+      throw response;
+    }
+
+    return (await Utils.ResponseToJson(response))[key];
+  } catch(error) {
+    if(error.status === 404) {
+      return undefined;
+    }
+
+    throw error;
+  }
+};
+
+/**
+ * Set user profile metadata for the current user
+ *
+ * @methodGroup ProfileMetadata
+ * @namedParams
+ * @param {string=} type="app" - Specify `app` or `user` metadata.
+ * @param {string=} mode="public" - Specify `public` or `private` metadata.
+ * @param {string=} appId - Namespace to use for the metadata, if retrieving app metadata. Uses the app ID specified on client initialization by default.
+ * @param {string} key - The metadata key to set
+ * @param {string} value - The metadata value to set
+ */
+exports.SetProfileMetadata = async function({type="app", mode="public", appId, key, value}) {
+  await this.stateStoreClient.Request({
+    method: "POST",
+    path: UserProfilePath({
+      network: this.network,
+      appId: appId || this.appId,
+      userAddress: this.UserAddress(),
+      type,
+      mode,
+      key
+    }),
+    body: value,
+    bodyType: typeof value === "object" ? "JSON" : "string",
+    headers: {
+      Authorization: `Bearer ${this.AuthToken()}`
+    }
+  });
+};
+
+
+/**
+ * Remove user profile metadata for the current user
+ *
+ * @methodGroup ProfileMetadata
+ * @namedParams
+ * @param {string=} type="app" - Specify `app` or `user` metadata.
+ * @param {string=} mode="public" - Specify `public` or `private` metadata.
+ * @param {string=} appId - Namespace to use for the metadata, if retrieving app metadata.. Uses the app ID specified on client initialization by default.
+ * @param {string} key - The metadata key to set
+ * @param {string} value - The metadata value to set
+ */
+exports.RemoveProfileMetadata = async function({type="app", mode="public", appId, key, value}) {
+  await this.stateStoreClient.Request({
+    method: "DELETE",
+    path: UserProfilePath({
+      network: this.network,
+      appId: appId || this.appId,
+      userAddress: this.UserAddress(),
+      type,
+      mode,
+      key
+    }),
+    body: value,
+    headers: {
+      Authorization: `Bearer ${this.AuthToken()}`
+    }
+  });
+};
+
+/**
+ * Retrieve profile info for the specified user, including address, username and profile image (if set)
+ *
+ * @methodGroup Profile
+ * @param {string=} userAddress - Address of the user
+ * @param {string=} userName - Username of the user
+ *
+ * @returns {Promise<Object>} - Profile info of the specified user
+ */
+exports.Profile = async function({userAddress, userName}) {
+  if(userName) {
+    userAddress = await this.UserNameToAddress({userName});
+  }
+
+  if(!userAddress) {
+    throw Error("Eluvio Wallet Client: Unable to determine profile - user address not specified");
+  }
+
+  if(!userName) {
+    userName = await this.ProfileMetadata({type: "user", userAddress, key: "username"});
+  }
+
+  const imageUrl = await this.ProfileMetadata({type: "user", userAddress, key: "icon_url"});
+
+  return {
+    userAddress: Utils.FormatAddress(userAddress),
+    userName,
+    imageUrl
+  };
+};
+
+exports.UserNameToAddress = async function({userName}) {
+  try {
+    const response = await this.stateStoreClient.Request({
+      method: "GET",
+      path: StateStorePath({network: this.network, path: UrlJoin("usr", "profile_for_username", userName)}),
+    });
+
+    if(!response.ok) {
+      throw response;
+    }
+
+    return (await Utils.ResponseToJson(response)).address;
+  } catch(error) {
+    if(error.status !== 404) {
+      throw error;
+    }
+  }
+
+  return undefined;
+};
+
+
+
+
+
+
+
+
+
+
+
+

package/src/walletClient/Utils.js

@@ -23,6 +23,24 @@ const RarityToPercentage = (rarity) => {
   return percentage;
 };
 
+const LinkTargetHash = function(link) {
+  if(!link) { return; }
+
+  if(link["."] && link["."].source) {
+    return link["."].source;
+  }
+
+  if(link["/"] && link["/"].startsWith("/qfab/")) {
+    return link["/"].split("/").find(segment => segment.startsWith("hq__"));
+  }
+
+  if(link["."] && link["."].container) {
+    return link["."].container;
+  }
+};
+
+exports.LinkTargetHash = LinkTargetHash;
+
 // Format NFT or listing result into consistent format
 const FormatNFTDetails = function(entry) {
   const isListing = !!entry.id;
@@ -70,7 +88,7 @@ const FormatNFTDetails = function(entry) {
 exports.FormatNFTDetails = FormatNFTDetails;
 
 
-const FormatNFTMetadata = function(nft) {
+const FormatNFTMetadata = function(walletClient, nft) {
   nft.formatted = true;
 
   // Surface relevant details to top level
@@ -105,10 +123,13 @@ const FormatNFTMetadata = function(nft) {
 
         let embedUrl = new URL("https://embed.v3.contentfabric.io");
         embedUrl.searchParams.set("p", "");
-        embedUrl.searchParams.set("net", rootStore.network === "demo" ? "demo" : "main");
-        embedUrl.searchParams.set("ath", rootStore.authToken);
+        embedUrl.searchParams.set("net", walletClient.network === "demo" ? "demo" : "main");
 
-        if(mediaType === "video") {
+        if(media.requires_permissions) {
+          embedUrl.searchParams.set("ath", walletClient.AuthToken());
+        }
+
+        if(["video", "audio"].includes(mediaType)) {
           embedUrl.searchParams.set("vid", LinkTargetHash(media.media_link));
           embedUrl.searchParams.set("ct", "h");
           embedUrl.searchParams.set("ap", "");
@@ -123,6 +144,7 @@ const FormatNFTMetadata = function(nft) {
           embed_url: embedUrl.toString()
         };
       } catch(error) {
+        walletClient.Log(error, true);
         return media;
       }
     });
@@ -134,8 +156,7 @@ const FormatNFTMetadata = function(nft) {
       if(nft.metadata.pack_options && nft.metadata.pack_options[key]) {
         let embedUrl = new URL("https://embed.v3.contentfabric.io");
         embedUrl.searchParams.set("p", "");
-        embedUrl.searchParams.set("net", rootStore.network === "demo" ? "demo" : "main");
-        embedUrl.searchParams.set("ath", rootStore.authToken || rootStore.staticToken);
+        embedUrl.searchParams.set("net", walletClient.network === "demo" ? "demo" : "main");
         embedUrl.searchParams.set("vid", LinkTargetHash(nft.metadata.pack_options[key]));
         embedUrl.searchParams.set("ap", "");
 
@@ -155,27 +176,11 @@ const FormatNFTMetadata = function(nft) {
 
 exports.FormatNFTMetadata = FormatNFTMetadata;
 
-exports.FormatNFT = function (item) {
-  return FormatNFTMetadata(FormatNFTDetails(item));
+exports.FormatNFT = function (walletClient, item) {
+  return FormatNFTMetadata(walletClient, FormatNFTDetails(item));
 };
 
 
-exports.LinkTargetHash = function(link) {
-  if(!link) { return; }
-
-  if(link["."] && link["."].source) {
-    return link["."].source;
-  }
-
-  if(link["/"] && link["/"].startsWith("/qfab/")) {
-    return link["/"].split("/").find(segment => segment.startsWith("hq__"));
-  }
-
-  if(link["."] && link["."].container) {
-    return link["."].container;
-  }
-};
-
 // https://stackoverflow.com/questions/4068373/center-a-popup-window-on-screen
 const Popup = ({url, title, w, h}) => {
   // Fixes dual-screen position

package/src/walletClient/index.js

@@ -1,6 +1,7 @@
 const {ElvClient} = require("../ElvClient");
 const Configuration = require("./Configuration");
 const {LinkTargetHash, FormatNFT, ActionPopup} = require("./Utils");
+const HTTPClient = require("../HttpClient");
 const UrlJoin = require("url-join");
 const Utils = require("../Utils");
 const Ethers = require("ethers");
@@ -15,7 +16,9 @@ const embedded = inBrowser && window.top !== window.self;
  * See the Modules section on the sidebar for all client methods unrelated to login and authorization
  */
 class ElvWalletClient {
-  constructor({client, network, mode, marketplaceInfo, storeAuthToken}) {
+  constructor({appId, client, network, mode, marketplaceInfo, previewMarketplaceHash, storeAuthToken}) {
+    this.appId = appId;
+
     this.client = client;
     this.loggedIn = false;
 
@@ -28,11 +31,16 @@ class ElvWalletClient {
     this.storeAuthToken = storeAuthToken;
 
     this.selectedMarketplaceInfo = marketplaceInfo;
+    this.previewMarketplaceId = previewMarketplaceHash ? Utils.DecodeVersionHash(previewMarketplaceHash).objectId : undefined;
+    this.previewMarketplaceHash = previewMarketplaceHash;
 
     this.availableMarketplaces = {};
     this.availableMarketplacesById = {};
     this.marketplaceHashes = {};
 
+    this.stateStoreUrls = Configuration[network].stateStoreUrls;
+    this.stateStoreClient = new HTTPClient({uris: this.stateStoreUrls});
+
     // Caches
     this.cachedMarketplaces = {};
     this.cachedCSS = {};
@@ -60,8 +68,10 @@ class ElvWalletClient {
    *
    * Specify tenantSlug and marketplaceSlug to automatically associate this tenant with a particular marketplace.
    *
+   *
    * @methodGroup Initialization
    * @namedParams
+   * @param {string} appId - A string identifying your app. This is used for namespacing user profile data.
    * @param {string} network=main - Name of the Fabric network to use (`main`, `demo`)
    * @param {string} mode=production - Environment to use (`production`, `staging`)
    * @param {Object=} marketplaceParams - Marketplace parameters
@@ -70,9 +80,11 @@ class ElvWalletClient {
    * @returns {Promise<ElvWalletClient>}
    */
   static async Initialize({
+    appId="general",
     network="main",
     mode="production",
     marketplaceParams,
+    previewMarketplaceId,
     storeAuthToken=true
   }) {
     let { tenantSlug, marketplaceSlug, marketplaceId, marketplaceHash } = (marketplaceParams || {});
@@ -85,7 +97,13 @@ class ElvWalletClient {
 
     const client = await ElvClient.FromNetworkName({networkName: network, assumeV3: true});
 
+    let previewMarketplaceHash = previewMarketplaceId;
+    if(previewMarketplaceHash && !previewMarketplaceHash.startsWith("hq__")) {
+      previewMarketplaceHash = await client.LatestVersionHash({objectId: previewMarketplaceId});
+    }
+
     const walletClient = new ElvWalletClient({
+      appId,
       client,
       network,
       mode,
@@ -95,6 +113,7 @@ class ElvWalletClient {
         marketplaceId: marketplaceHash ? client.utils.DecodeVersionHash(marketplaceHash).objectId : marketplaceId,
         marketplaceHash
       },
+      previewMarketplaceHash,
       storeAuthToken
     });
 
@@ -217,6 +236,9 @@ class ElvWalletClient {
   /**
    * Direct the user to the Eluvio Media Wallet login page.
    *
+   * For redirect login, the authorization token will be included in the URL parameters of the callbackUrl. Simply re-initialize the wallet client and it will authorize with this token,
+   * or you can retrieve the parameter (`elvToken`) yourself and use it in the <a href="#Authenticate">Authenticate</a> method.
+   *
    * <b>NOTE:</b> The domain of the opening window (popup flow) or domain of the `callbackUrl` (redirect flow) MUST be allowed in the metadata of the specified marketplace.
    *
    * @methodGroup Login
@@ -552,14 +574,13 @@ class ElvWalletClient {
 
 
 
-  // If marketplace slug is specified, load only that marketplace. Otherwise load all
   async LoadAvailableMarketplaces(forceReload=false) {
     if(!forceReload && Object.keys(this.availableMarketplaces) > 0) {
       return;
     }
 
     const mainSiteHash = await this.client.LatestVersionHash({objectId: this.mainSiteId});
-    const metadata = await this.client.ContentObjectMetadata({
+    let metadata = await this.client.ContentObjectMetadata({
       versionHash: mainSiteHash,
       metadataSubtree: "public/asset_metadata/tenants",
       resolveLinks: true,
@@ -581,13 +602,74 @@ class ElvWalletClient {
       ]
     });
 
+    // If preview marketplace is specified, load it appropriately
+    if(this.previewMarketplaceId) {
+      let previewTenantSlug = "PREVIEW";
+      let previewMarketplaceSlug, previewMarketplaceMetadata;
+      Object.keys(metadata || {}).forEach(tenantSlug =>
+        Object.keys(metadata[tenantSlug].marketplaces || {}).forEach(marketplaceSlug => {
+          const versionHash = metadata[tenantSlug].marketplaces[marketplaceSlug]["."].source;
+          const objectId = this.utils.DecodeVersionHash(versionHash).objectId;
+
+          if(objectId === this.previewMarketplaceId) {
+            // Marketplace exists in site meta
+            previewTenantSlug = tenantSlug;
+            previewMarketplaceSlug = marketplaceSlug;
+
+            // Deployed marketplace is same as preview marketplace
+            if(versionHash === this.previewMarketplaceHash) {
+              previewMarketplaceMetadata = metadata[tenantSlug].marketplaces[marketplaceSlug];
+            }
+          }
+        })
+      );
+
+      // Marketplace not present in branch, or preview version is different - Load metadata directly
+      if(!previewMarketplaceMetadata) {
+        previewMarketplaceMetadata = await this.client.ContentObjectMetadata({
+          versionHash: this.previewMarketplaceHash,
+          metadataSubtree: "public/asset_metadata",
+          produceLinkUrls: true,
+          authorizationToken: this.publicStaticToken,
+          noAuth: true,
+          select: [
+            "slug",
+            "info/tenant_id",
+            "info/tenant_name",
+            "info/branding",
+          ],
+          remove: [
+            "info/branding/custom_css"
+          ]
+        });
+
+        if(!previewMarketplaceSlug) {
+          previewMarketplaceSlug = previewMarketplaceMetadata.slug;
+        }
+      }
+
+      previewMarketplaceMetadata["."] = {
+        source: this.previewMarketplaceHash
+      };
+
+      previewMarketplaceMetadata.info["."] = {
+        source: this.previewMarketplaceHash
+      };
+
+      previewMarketplaceMetadata.info.branding.preview = true;
+      previewMarketplaceMetadata.info.branding.show = true;
+
+      metadata[previewTenantSlug] = metadata[previewTenantSlug] || {};
+      metadata[previewTenantSlug].marketplaces = metadata[previewTenantSlug].marketplaces || {};
+      metadata[previewTenantSlug].marketplaces[previewMarketplaceSlug] = previewMarketplaceMetadata;
+    }
+
     let availableMarketplaces = { ...(this.availableMarketplaces || {}) };
     let availableMarketplacesById = { ...(this.availableMarketplacesById || {}) };
     Object.keys(metadata || {}).forEach(tenantSlug => {
       try {
-        availableMarketplaces[tenantSlug] = {
-          versionHash: metadata[tenantSlug]["."].source
-        };
+        availableMarketplaces[tenantSlug] = metadata[tenantSlug]["."] ?
+          { versionHash: metadata[tenantSlug]["."].source } : { };
 
         Object.keys(metadata[tenantSlug].marketplaces || {}).forEach(marketplaceSlug => {
           try {
@@ -629,11 +711,17 @@ class ElvWalletClient {
   }
 
   // Get the hash of the currently linked marketplace
-  async LatestMarketplaceHash({tenantSlug, marketplaceSlug}) {
+  async LatestMarketplaceHash({marketplaceParams}) {
+    const marketplaceInfo = await this.MarketplaceInfo({marketplaceParams});
+
+    if(this.previewMarketplaceId && this.previewMarketplaceId === marketplaceInfo.marketplaceId) {
+      return this.availableMarketplaces[marketplaceInfo.tenantSlug][marketplaceInfo.marketplaceSlug]["."].source;
+    }
+
     const mainSiteHash = await this.client.LatestVersionHash({objectId: this.mainSiteId});
     const marketplaceLink = await this.client.ContentObjectMetadata({
       versionHash: mainSiteHash,
-      metadataSubtree: UrlJoin("/public", "asset_metadata", "tenants", tenantSlug, "marketplaces", marketplaceSlug),
+      metadataSubtree: UrlJoin("/public", "asset_metadata", "tenants", marketplaceInfo.tenantSlug, "marketplaces", marketplaceInfo.marketplaceSlug),
       resolveLinks: false
     });
 
@@ -644,7 +732,7 @@ class ElvWalletClient {
     const marketplaceInfo = this.MarketplaceInfo({marketplaceParams});
 
     const marketplaceId = marketplaceInfo.marketplaceId;
-    const marketplaceHash = await this.LatestMarketplaceHash({tenantSlug: marketplaceInfo.tenantSlug, marketplaceSlug: marketplaceInfo.marketplaceSlug});
+    const marketplaceHash = await this.LatestMarketplaceHash({marketplaceParams});
 
     if(this.cachedMarketplaces[marketplaceId] && this.cachedMarketplaces[marketplaceId].versionHash !== marketplaceHash) {
       delete this.cachedMarketplaces[marketplaceId];
@@ -698,6 +786,10 @@ class ElvWalletClient {
       marketplace.marketplaceId = marketplaceId;
       marketplace.versionHash = marketplaceHash;
 
+      if(this.previewMarketplaceId && marketplaceId === this.previewMarketplaceId) {
+        marketplace.branding.preview = true;
+      }
+
       // Generate embed URLs for pack opening animations
       ["purchase_animation", "purchase_animation__mobile", "reveal_animation", "reveal_animation_mobile"].forEach(key => {
         try {
@@ -744,20 +836,29 @@ class ElvWalletClient {
     priceRange,
     tokenIdRange,
     capLimit,
+    userAddress,
     sellerAddress,
     lastNDays=-1,
+    includeCheckoutLocked=false,
     start=0,
     limit=50
   }={}) {
     collectionIndexes = (collectionIndexes || []).map(i => parseInt(i));
 
     let params = {
-      sort_by: sortBy,
-      sort_descending: sortDesc,
       start,
-      limit
+      limit,
+      sort_descending: sortDesc
     };
 
+    if(mode !== "leaderboard") {
+      params.sort_by = sortBy;
+    }
+
+    if(mode.includes("listings") && includeCheckoutLocked) {
+      params.checkout = true;
+    }
+
     let marketplaceInfo, marketplace;
     if(marketplaceParams) {
       marketplaceInfo = await this.MarketplaceInfo({marketplaceParams});
@@ -772,6 +873,8 @@ class ElvWalletClient {
 
       if(sellerAddress) {
         filters.push(`seller:eq:${this.client.utils.FormatAddress(sellerAddress)}`);
+      } else if(userAddress && mode !== "owned") {
+        filters.push(`addr:eq:${this.client.utils.FormatAddress(userAddress)}`);
       }
 
       if(marketplace && collectionIndexes.length >= 0) {
@@ -798,7 +901,7 @@ class ElvWalletClient {
             }
           });
         });
-      } else if(mode !== "owned" && marketplaceInfo || tenantId) {
+      } else if(marketplaceInfo || tenantId) {
         filters.push(`tenant:eq:${marketplaceInfo ? marketplaceInfo.tenantId : tenantId}`);
       }
 
@@ -816,8 +919,7 @@ class ElvWalletClient {
         if(mode.includes("listing")) {
           filters.push(`nft/display_name:eq:${filter}`);
         } else if(mode === "owned") {
-          filters.push(`meta:@>:{"display_name":"${filter}"}`);
-          params.exact = false;
+          filters.push(`meta/display_name:eq:${filter}`);
         } else {
           filters.push(`name:eq:${filter}`);
         }
@@ -880,12 +982,7 @@ class ElvWalletClient {
       let path;
       switch(mode) {
         case "owned":
-          path = UrlJoin("as", "wlt", "nfts");
-
-          if(marketplaceInfo) {
-            path = UrlJoin("as", "wlt", "nfts", marketplaceInfo.tenantId);
-          }
-
+          path = UrlJoin("as", "wlt", userAddress || this.UserAddress());
           break;
 
         case "listings":
@@ -912,6 +1009,10 @@ class ElvWalletClient {
           path = UrlJoin("as", "mkt", "stats", "sold");
           filters.push("seller:co:0x");
           break;
+
+        case "leaderboard":
+          path = UrlJoin("as", "wlt", "leaders");
+          break;
       }
 
       if(filters.length > 0) {
@@ -932,10 +1033,7 @@ class ElvWalletClient {
         await this.client.authClient.MakeAuthServiceRequest({
           path,
           method: "GET",
-          queryParams: params,
-          headers: mode === "owned" ?
-            { Authorization: `Bearer ${this.AuthToken()}` } :
-            {}
+          queryParams: params
         })
       ) || [];
 
@@ -946,7 +1044,7 @@ class ElvWalletClient {
           total: paging.total,
           more: paging.total > start + limit
         },
-        results: (contents || []).map(item => ["owned", "listings"].includes(mode) ? FormatNFT(item) : item)
+        results: (contents || []).map(item => ["owned", "listings"].includes(mode) ? FormatNFT(this, item) : item)
       };
     } catch(error) {
       if(error.status && error.status.toString() === "404") {
@@ -1029,5 +1127,6 @@ class ElvWalletClient {
 }
 
 Object.assign(ElvWalletClient.prototype, require("./ClientMethods"));
+Object.assign(ElvWalletClient.prototype, require("./Profile"));
 
 exports.ElvWalletClient = ElvWalletClient;