@eluvio/elv-client-js 4.0.17 → 4.0.19

package/src/walletClient/ClientMethods.js

@@ -1310,8 +1310,22 @@ exports.DropStatus = async function({marketplace, eventId, dropId}) {
 
 
 /* OFFERS */
-// TODO: Document
 
+/**
+ * Retrieve offers for the specified parameters
+ *
+ * @methodGroup Offers
+ * @namedParams
+ * @param {string=} contractAddress - The address of an NFT contract
+ * @param {string=} tokenId - The token ID of an NFT
+ * @param {string=} buyerAddress - The address of the offerrer
+ * @param {string=} sellerAddress - The address of the offerree
+ * @param {Array<String>=} statuses - Status to filter results by. Allowed values: "ACTIVE", "ACCEPTED", "CANCELLED", "DECLINED", "INVALID"
+ * @param {number} start=0 - The index to start from
+ * @param {number=} limit=10 - The maximum number of results to return
+ *
+ * @returns {Promise<Array<Object>>} - Offers matching the specified filters
+ */
 exports.MarketplaceOffers = async function({contractAddress, tokenId, buyerAddress, sellerAddress, statuses, start=0, limit=10}) {
   let path = UrlJoin("as", "mkt", "offers", "ls");
   if(buyerAddress) {
@@ -1354,6 +1368,21 @@ exports.MarketplaceOffers = async function({contractAddress, tokenId, buyerAddre
     }));
 };
 
+/**
+ * <b><i>Requires login</i></b>
+ *
+ * Create or update an offer on the specified NFT
+ *
+ * @methodGroup Offers
+ * @namedParams
+ * @param {string} contractAddress - The contract address of the NFT
+ * @param {string} tokenId - The token ID of the NFT
+ * @param {string=} offerId - IF modifying an existing offer, the ID of the offer
+ * @param {number} price - The amount to offer
+ * @param {number=} expiresAt - The time (in epoch ms) the offer will expire
+ *
+ * @returns {Promise<Object>} - Info about the created/updated offer
+ */
 exports.CreateMarketplaceOffer = async function({contractAddress, tokenId, offerId, price, expiresAt}) {
   let response;
   if(offerId) {
@@ -1391,6 +1420,15 @@ exports.CreateMarketplaceOffer = async function({contractAddress, tokenId, offer
   return response.offer_id;
 };
 
+/**
+ * <b><i>Requires login</i></b>
+ *
+ * Cancel the specified offer
+ *
+ * @methodGroup Offers
+ * @namedParams
+ * @param {string} offerId - The ID of the offer
+ */
 exports.RemoveMarketplaceOffer = async function({offerId}) {
   return await this.client.authClient.MakeAuthServiceRequest({
     path: UrlJoin("as", "wlt", "mkt", "offers", offerId),
@@ -1401,7 +1439,15 @@ exports.RemoveMarketplaceOffer = async function({offerId}) {
   });
 };
 
-
+/**
+ * <b><i>Requires login</i></b>
+ *
+ * Accept the specified offer
+ *
+ * @methodGroup Offers
+ * @namedParams
+ * @param {string} offerId - The ID of the offer
+ */
 exports.AcceptMarketplaceOffer = async function({offerId}) {
   return await this.client.authClient.MakeAuthServiceRequest({
     path: UrlJoin("as", "wlt", "mkt", "offers", "accept", offerId),
@@ -1412,6 +1458,15 @@ exports.AcceptMarketplaceOffer = async function({offerId}) {
   });
 };
 
+/**
+ * <b><i>Requires login</i></b>
+ *
+ * Reject the specified offer
+ *
+ * @methodGroup Offers
+ * @namedParams
+ * @param {string} offerId - The ID of the offer
+ */
 exports.RejectMarketplaceOffer = async function({offerId}) {
   return await this.client.authClient.MakeAuthServiceRequest({
     path: UrlJoin("as", "wlt", "mkt", "offers", "decline", offerId),
@@ -1421,3 +1476,77 @@ exports.RejectMarketplaceOffer = async function({offerId}) {
     }
   });
 };
+
+
+/* Voting */
+
+/**
+ * Retrieve the current status of the specified voting event
+ *
+ * @methodGroup Voting
+ * @namedParams
+ * @param {string} tenantId - The tenant ID of the marketplace in which the voting event is specified
+ * @param {string} votingEventId - The ID of the voting event
+ *
+ * @returns {Promise<Object>} - Info about the voting event, including the current user's votes and the current total voting tally
+ */
+exports.VoteStatus = async function ({tenantId, votingEventId}) {
+  return await Utils.ResponseToJson(
+    this.client.authClient.MakeAuthServiceRequest({
+      path: UrlJoin("as", "votes", tenantId, votingEventId),
+      headers: {
+        Authorization: `Bearer ${this.AuthToken()}`
+      }
+    })
+  );
+};
+
+/**
+ * <b><i>Requires login</i></b>
+ *
+ * Cast a vote for the specified item in the specified voting event
+ *
+ * @methodGroup Voting
+ * @namedParams
+ * @param {string} tenantId - The tenant ID of the marketplace in which the voting event is specified
+ * @param {string} votingEventId - The ID of the voting event
+ * @param {string} sku - The SKU of the item to vote for
+ *
+ * @returns {Promise<Object>} - Info about the voting event, including the current user's votes and the current total voting tally
+ */
+exports.CastVote = async function ({tenantId, votingEventId, sku}) {
+  return await Utils.ResponseToJson(
+    this.client.authClient.MakeAuthServiceRequest({
+      path: UrlJoin("as", "votes", tenantId, votingEventId, sku),
+      method: "POST",
+      headers: {
+        Authorization: `Bearer ${this.AuthToken()}`
+      }
+    })
+  );
+};
+
+/**
+ * <b><i>Requires login</i></b>
+ *
+ * Revoke a previously cast vote for the specified item in the specified voting event
+ *
+ * @methodGroup Voting
+ * @namedParams
+ * @param {string} tenantId - The tenant ID of the marketplace in which the voting event is specified
+ * @param {string} votingEventId - The ID of the voting event
+ * @param {string} sku - The SKU of the item to vote for
+ *
+ * @returns {Promise<Object>} - Info about the voting event, including the current user's votes and the current total voting tally
+ */
+exports.RevokeVote = async function ({tenantId, votingEventId, sku}) {
+  return await Utils.ResponseToJson(
+    this.client.authClient.MakeAuthServiceRequest({
+      path: UrlJoin("as", "votes", tenantId, votingEventId, sku),
+      method: "DELETE",
+      headers: {
+        Authorization: `Bearer ${this.AuthToken()}`
+      }
+    })
+  );
+};

package/src/walletClient/Configuration.js

@@ -2,6 +2,7 @@ let WalletConfiguration = {
   demo: {
     configUrl: "https://demov3.net955210.contentfabric.io/config",
     stateStoreUrls: ["https://appsvc.svc.eluv.io/dv3"],
+    badgerAddress: "0x39e9d567137217e8f7dae73bf168db28d242bb31",
     staging: {
       siteLibraryId: "ilib36Wi5fJDLXix8ckL7ZfaAJwJXWGD",
       siteId: "iq__2gkNh8CCZqFFnoRpEUmz7P3PaBQG",
@@ -12,6 +13,7 @@ let WalletConfiguration = {
   main: {
     configUrl: "https://main.net955305.contentfabric.io/config",
     stateStoreUrls: ["https://appsvc.svc.eluv.io/main"],
+    badgerAddress: "0xa042a585bbbac4419ba39c397f35ab749fc470f0",
     staging: {
       siteLibraryId: "ilib2GdaYEFxB7HyLPhSDPKMyPLhV8x9",
       siteId: "iq__inauxD1KLyKWPHargCWjdCh2ayr",

package/src/walletClient/Profile.js

@@ -116,7 +116,7 @@ exports.RemoveProfileMetadata = async function({type="app", mode="public", appId
 };
 
 /**
- * Retrieve profile info for the specified user, including address, username and profile image (if set)
+ * Retrieve profile info for the specified user, including address, username, profile image (if set) and badges (if any)
  *
  * @methodGroup Profile
  * @param {string=} userAddress - Address of the user
@@ -139,10 +139,33 @@ exports.Profile = async function({userAddress, userName}) {
 
   const imageUrl = await this.ProfileMetadata({type: "user", userAddress, key: "icon_url"});
 
+  let badgeData = await this.ProfileMetadata({
+    type: "app",
+    mode: "public",
+    appId: "elv-badge-srv",
+    userAddress: this.badgerAddress,
+    key: `badges_${Utils.FormatAddress(userAddress)}`
+  });
+
+  let badges = [];
+  if(badgeData) {
+    try {
+      badgeData = (JSON.parse(badgeData)).badges;
+      badges = Object.keys(badgeData).map(badgeName => ({
+        ...badgeData[badgeName],
+        name: badgeName
+      }));
+    } catch(error) {
+      this.Log(`Failed to load badge info for ${userName || userAddress}`, true);
+      this.Log(error, true);
+    }
+  }
+
   return {
     userAddress: Utils.FormatAddress(userAddress),
     userName,
-    imageUrl
+    imageUrl,
+    badges
   };
 };
 

package/src/walletClient/index.js

@@ -51,6 +51,7 @@ class ElvWalletClient {
 
     this.stateStoreUrls = Configuration[network].stateStoreUrls;
     this.stateStoreClient = new HTTPClient({uris: this.stateStoreUrls});
+    this.badgerAddress = Configuration[network].badgerAddress;
 
     // Caches
     this.cachedMarketplaces = {};