@eluvio/elv-client-js 3.2.5 → 3.2.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eluvio/elv-client-js",
-  "version": "3.2.5",
+  "version": "3.2.8",
   "description": "Javascript client for the Eluvio Content Fabric",
   "main": "src/index.js",
   "author": "Kevin Talmadge",

package/src/ElvClient.js

@@ -609,7 +609,7 @@ class ElvClient {
       idToken,
       authToken,
       tenantId,
-      provider: this.ethClient.provider,
+      provider: await this.ethClient.Provider(),
       extraData,
       unsignedPublicAuth
     });

package/src/walletClient/ClientMethods.js

@@ -24,6 +24,7 @@ exports.UserInfo = function() {
   if(!this.loggedIn) { return; }
 
   return {
+    name: this.__authorization.email || this.UserAddress(),
     address: this.UserAddress() ,
     email: this.__authorization.email,
     walletType: this.__authorization.walletType,
@@ -127,20 +128,18 @@ exports.UserWalletBalance = async function(checkOnboard=false) {
 
 
 /**
- * <b><i>Requires login</i></b>
- *
- * Returns basic contract info about the items the current user owns, organized by contract address + token ID
+ * Returns basic contract info about the items the specified/current user owns, organized by contract address + token ID
  *
  * This method is significantly faster than <a href="#.UserItems">UserItems</a>, but does not include any NFT metadata.
  *
  * @methodGroup User
+ * @namedParams
+ * @param {string=} userAddress - Address of the user to query for. If unspecified, will use the currently logged in user.
  *
  * @returns {Promise<Object>} - Basic info about all owned items.
  */
-exports.UserItemInfo = async function () {
-  if(!this.loggedIn) { return {}; }
-
-  const accountId = `iusr${Utils.AddressToHash(this.UserAddress())}`;
+exports.UserItemInfo = async function ({userAddress}={}) {
+  const accountId = `iusr${Utils.AddressToHash(userAddress || this.UserAddress())}`;
   this.profileData = await this.client.ethClient.MakeProviderCall({
     methodName: "send",
     args: [
@@ -263,6 +262,35 @@ exports.UserSales = async function({sortBy="created", sortDesc=false, contractAd
   ).results;
 };
 
+/**
+ * Return all transfers and sales for the current user. Not paginated.
+ *
+ * @methodGroup User
+ * @namedParams
+ * @param {string=} sortBy="created" - Sort order. Options: `created`, `price`, `name`
+ * @param {boolean=} sortDesc=false - Sort results descending instead of ascending
+ * @param {Object=} marketplaceParams - Filter results by marketplace
+ * @param {string=} contractAddress - Filter results by the address of the NFT contract
+ * @param {string=} tokenId - Filter by token ID (if filtering by contract address)
+ * @param {integer=} lastNDays - Filter by results listed in the past N days
+ *
+ * @returns {Promise<Array<Object>>} - List of current user's sales
+ */
+exports.UserTransfers = async function({sortBy="created", sortDesc=false, contractAddress, tokenId, marketplaceParams}={}) {
+  return (
+    await this.FilteredQuery({
+      mode: "transfers",
+      start: 0,
+      limit: 10000,
+      sortBy,
+      sortDesc,
+      sellerAddress: this.UserAddress(),
+      marketplaceParams,
+      contractAddress,
+      tokenId
+    })
+  ).results;
+};
 
 /* TENANT */
 
@@ -431,10 +459,28 @@ exports.Marketplace = async function ({marketplaceParams}) {
 
 /* NFTS */
 
+/**
+ * Return info about the specified NFT contract, including the cap, current total supply, and total minted and burned.
+ *
+ * @methodGroup NFTs
+ * @namedParams
+ * @param {string} contractAddress - The contract address of the NFT
+ *
+ * @returns {Promise<Object>} - Information about the specified contract
+ */
+exports.NFTContractStats = async function({contractAddress}) {
+  return await Utils.ResponseToJson(
+    this.client.authClient.MakeAuthServiceRequest({
+      path: UrlJoin("as", "nft", "info", contractAddress),
+      method: "GET"
+    })
+  );
+};
+
 /**
  * Load full info for the specified NFT
  *
- * @methodGroup Items
+ * @methodGroup NFTs
  * @namedParams
  * @param {string} contractAddress - The contract address of the NFT
  * @param {string} tokenId - The token ID of the NFT
@@ -470,7 +516,7 @@ exports.NFT = async function({tokenId, contractAddress}) {
  *
  * Transfer the specified NFT owned by the current user to the specified address
  *
- * @methodGroup NFT
+ * @methodGroup NFTs
  * @namedParams
  * @param {string} contractAddress - The contract address of the NFT
  * @param {string} tokenId - The token ID of the NFT
@@ -650,6 +696,41 @@ exports.Sales = async function() {
   return this.FilteredQuery({mode: "sales", ...(arguments[0] || {})});
 };
 
+/**
+ * Retrieve sales and transfers matching the specified parameters.
+ *
+ * @methodGroup Listings
+ * @namedParams
+ * @param {integer=} start=0 - PAGINATION: Index from which the results should start
+ * @param {integer=} limit=50 - PAGINATION: Maximum number of results to return
+ * @param {string=} sortBy="created" - Sort order. Options: `created`, `price`, `name`
+ * @param {boolean=} sortDesc=false - Sort results descending instead of ascending
+ * @param {string=} filter - Filter results by item name.
+ *  <br /><br />
+ *  NOTE: This string must be an <b>exact match</b> on the item name.
+ * You can retrieve all available item names from the <a href="#.ListingNames">ListingNames method</a>.
+ *  @param {string=} editionFilter - Filter results by item edition.
+ *  <br /><br />
+ *  NOTE: This string must be an <b>exact match</b> on the edition name.
+ * You can retrieve all available item edition names from the <a href="#.ListingEditionNames">ListingEditionNames method</a>.
+ *  @param {Array<Object>} attributeFilters - Filter results by item attributes. Each entry should include name and value (e.g. `[{name: "attribute-name", value: "attribute-value"}]`)
+ *  <br /><br />
+ *  NOTE: These filters must be an <b>exact match</b> on the attribute name and value.
+ * You can retrieve all available item attributes from the <a href="#.ListingAttributes">ListingAttributes method</a>.
+ * @param {string=} sellerAddress - Filter by a specific seller
+ * @param {string=} contractAddress - Filter results by the address of the NFT contract
+ * @param {string=} tokenId - Filter by token ID (if filtering by contract address)
+ * @param {string=} currency - Filter results by purchase currency. Available options: `usdc`
+ * @param {Object=} marketplaceParams - Filter results by marketplace
+ * @param {integer=} collectionIndex - If filtering by marketplace, filter by collection. The index refers to the index in the array `marketplace.collections`
+ * @param {integer=} lastNDays - Filter by results listed in the past N days
+ *
+ * @returns {Promise<Object>} - Results of the query and pagination info
+ */
+exports.Transfers = async function() {
+  return this.FilteredQuery({mode: "transfers", ...(arguments[0] || {})});
+};
+
 /**
  * Retrieve stats for listings matching the specified parameters.
  *

package/src/walletClient/README.md

@@ -6,6 +6,12 @@ For information about the embedded wallet app frame client, see [here](https://e
 
 ## Initializing the Client
 
+Import the client using the following path:
+
+```javascript
+import {ElvWalletClient} from "@eluvio/elv-client-js/src/walletClient/index";
+```
+
 Initializing the client is as simple as calling the static Initialize method with the network (main or demo) and the mode (production or staging) the client should operate upon, as well as (optionally) the marketplace to associate the client with.
 
 ```javascript

package/src/walletClient/index.js

@@ -3,6 +3,7 @@ const Configuration = require("./Configuration");
 const {LinkTargetHash, FormatNFT, ActionPopup} = require("./Utils");
 const UrlJoin = require("url-join");
 const Utils = require("../Utils");
+const Ethers = require("ethers");
 
 
 /**
@@ -117,6 +118,89 @@ class ElvWalletClient {
 
   /* Login and authorization */
 
+  /**
+   * Check if this client can sign without opening a popup.
+   *
+   * Generally, Eluvio custodial wallet users will require a popup prompt, while Metamask and custom OAuth users will not.
+   *
+   * @methodGroup Signatures
+   * @returns {boolean} - Whether or not this client can sign a message without a popup.
+   */
+  CanSign() {
+    if(!this.loggedIn) { return false; }
+
+    return !!this.__authorization.clusterToken ||
+      !!(this.UserInfo().walletName.toLowerCase() === "metamask" && window.ethereum && window.ethereum.isMetaMask && window.ethereum.chainId);
+  }
+
+  /**
+   * <b><i>Requires login</i></b>
+   *
+   * Request the current user sign the specified message.
+   *
+   * If this client is not able to perform the signature (Eluvio custodial OAuth users), a popup will be opened and the user will be prompted to sign.
+   *
+   * To check if the signature can be done without a popup, use the <a href="#CanSign">CanSign</a> method.
+   *
+   * @methodGroup Signatures
+   * @namedParams
+   * @param {string} message - The message to sign
+   *
+   * @throws - If the user rejects the signature or closes the popup, an error will be thrown.
+   *
+   * @returns {Promise<string>} - The signature of the message
+   */
+  async PersonalSign({message}) {
+    if(!this.loggedIn) { throw Error("ElvWalletClient: Unable to perform signature - Not logged in"); }
+
+    // Able to sign locally with either cluster token or metamask
+    if(this.CanSign()) {
+      if(this.__authorization.clusterToken) {
+        // Custodial wallet sign
+
+        message = typeof message === "object" ? JSON.stringify(message) : message;
+        message = Ethers.utils.keccak256(Buffer.from(`\x19Ethereum Signed Message:\n${message.length}${message}`, "utf-8"));
+
+        return await this.client.authClient.Sign(message);
+      } else if(this.UserInfo().walletName.toLowerCase() === "metamask") {
+        return this.SignMetamask({message, address: this.UserAddress()});
+      } else {
+        throw Error("ElvWalletClient: Unable to sign");
+      }
+    }
+
+    const parameters = {
+      action: "personal-sign",
+      message,
+      logIn: true
+    };
+
+    let url = new URL(this.appUrl);
+    url.hash = UrlJoin("/action", "sign", Utils.B58(JSON.stringify(parameters)));
+    url.searchParams.set("origin", window.location.origin);
+
+    return await new Promise(async (resolve, reject) => {
+      await ActionPopup({
+        mode: "tab",
+        url: url.toString(),
+        onCancel: () => reject("User cancelled sign"),
+        onMessage: async (event, Close) => {
+          if(!event || !event.data || event.data.type !== "FlowResponse") {
+            return;
+          }
+
+          try {
+            resolve(event.data.response);
+          } catch(error) {
+            reject(error);
+          } finally {
+            Close();
+          }
+        }
+      });
+    });
+  }
+
   /**
    * Direct the user to the Eluvio Media Wallet login page.
    *
@@ -246,12 +330,12 @@ class ElvWalletClient {
       throw Error("ElvWalletClient: Provided authorization token has expired");
     }
 
-    this.client.SetStaticToken({token: decodedToken.fabricToken});
-
     if(decodedToken.clusterToken) {
-      this.client.SetRemoteSigner({authToken: decodedToken.clusterToken});
+      await this.client.SetRemoteSigner({authToken: decodedToken.clusterToken});
     }
 
+    this.client.SetStaticToken({token: decodedToken.fabricToken});
+
     return this.SetAuthorization(decodedToken);
   }
 
@@ -415,11 +499,16 @@ class ElvWalletClient {
       throw Error("ElvWalletClient: Unable to initialize - Metamask not available");
     }
 
-    await window.ethereum.request({method: "eth_requestAccounts"});
-    const from = address || window.ethereum.selectedAddress;
+    address = address || this.UserAddress();
+
+    const accounts = await window.ethereum.request({method: "eth_requestAccounts"});
+    if(address && !Utils.EqualAddress(accounts[0], address)) {
+      throw Error(`ElvWalletClient: Incorrect MetaMask account selected. Expected ${address}, got ${accounts[0]}`);
+    }
+
     return await window.ethereum.request({
       method: "personal_sign",
-      params: [message, from, ""],
+      params: [message, address, ""],
     });
   }
 
@@ -750,6 +839,10 @@ class ElvWalletClient {
           path = UrlJoin("as", "mkt", "f");
           break;
 
+        case "transfers":
+          path = UrlJoin("as", "mkt", "hst", "f");
+          break;
+
         case "sales":
           path = UrlJoin("as", "mkt", "hst", "f");
           filters.push("action:eq:SOLD");