@eluvio/elv-client-js 3.2.44 → 4.0.0

package/dist/src/walletClient/index.js

@@ -1246,7 +1246,7 @@ var ElvWalletClient = /*#__PURE__*/function () {
                 return this.client.ContentObjectMetadata({
                   versionHash: marketplaceHash,
                   metadataSubtree: "public/asset_metadata/info",
-                  linkDepthLimit: 2,
+                  linkDepthLimit: 1,
                   resolveLinks: true,
                   resolveIgnoreErrors: true,
                   resolveIncludeSource: true,
@@ -1432,7 +1432,11 @@ var ElvWalletClient = /*#__PURE__*/function () {
                   start: start,
                   limit: limit,
                   sort_descending: sortDesc
-                };
+                }; // Created isn't a valid sort mode for owned
+
+                if (mode === "owned" && sortBy === "created") {
+                  sortBy = "default";
+                }
 
                 if (mode !== "leaderboard") {
                   params.sort_by = sortBy;
@@ -1443,33 +1447,33 @@ var ElvWalletClient = /*#__PURE__*/function () {
                 }
 
                 if (!marketplaceParams) {
-                  _context16.next = 13;
+                  _context16.next = 14;
                   break;
                 }
 
-                _context16.next = 8;
+                _context16.next = 9;
                 return this.MarketplaceInfo({
                   marketplaceParams: marketplaceParams
                 });
 
-              case 8:
+              case 9:
                 marketplaceInfo = _context16.sent;
 
                 if (!(collectionIndexes.length > 0)) {
-                  _context16.next = 13;
+                  _context16.next = 14;
                   break;
                 }
 
-                _context16.next = 12;
+                _context16.next = 13;
                 return this.Marketplace({
                   marketplaceParams: marketplaceParams
                 });
 
-              case 12:
+              case 13:
                 marketplace = _context16.sent;
 
-              case 13:
-                _context16.prev = 13;
+              case 14:
+                _context16.prev = 14;
                 filters = [];
 
                 if (sellerAddress) {
@@ -1584,87 +1588,87 @@ var ElvWalletClient = /*#__PURE__*/function () {
                 }
 
                 _context16.t0 = mode;
-                _context16.next = _context16.t0 === "owned" ? 28 : _context16.t0 === "listings" ? 30 : _context16.t0 === "transfers" ? 32 : _context16.t0 === "sales" ? 36 : _context16.t0 === "listing-stats" ? 40 : _context16.t0 === "sales-stats" ? 42 : _context16.t0 === "leaderboard" ? 45 : 47;
+                _context16.next = _context16.t0 === "owned" ? 29 : _context16.t0 === "listings" ? 31 : _context16.t0 === "transfers" ? 33 : _context16.t0 === "sales" ? 37 : _context16.t0 === "listing-stats" ? 41 : _context16.t0 === "sales-stats" ? 43 : _context16.t0 === "leaderboard" ? 46 : 48;
                 break;
 
-              case 28:
+              case 29:
                 path = UrlJoin("as", "wlt", userAddress || this.UserAddress());
-                return _context16.abrupt("break", 47);
+                return _context16.abrupt("break", 48);
 
-              case 30:
+              case 31:
                 path = UrlJoin("as", "mkt", "f");
-                return _context16.abrupt("break", 47);
+                return _context16.abrupt("break", 48);
 
-              case 32:
+              case 33:
                 path = UrlJoin("as", "mkt", "hst", "f");
                 filters.push("action:eq:TRANSFERRED");
                 filters.push("action:eq:SOLD");
-                return _context16.abrupt("break", 47);
+                return _context16.abrupt("break", 48);
 
-              case 36:
+              case 37:
                 path = UrlJoin("as", "mkt", "hst", "f");
                 filters.push("action:eq:SOLD");
                 filters.push("seller:co:0x");
-                return _context16.abrupt("break", 47);
+                return _context16.abrupt("break", 48);
 
-              case 40:
+              case 41:
                 path = UrlJoin("as", "mkt", "stats", "listed");
-                return _context16.abrupt("break", 47);
+                return _context16.abrupt("break", 48);
 
-              case 42:
+              case 43:
                 path = UrlJoin("as", "mkt", "stats", "sold");
                 filters.push("seller:co:0x");
-                return _context16.abrupt("break", 47);
+                return _context16.abrupt("break", 48);
 
-              case 45:
+              case 46:
                 path = UrlJoin("as", "wlt", "leaders");
-                return _context16.abrupt("break", 47);
+                return _context16.abrupt("break", 48);
 
-              case 47:
+              case 48:
                 if (filters.length > 0) {
                   params.filter = filters;
                 }
 
                 if (!mode.includes("stats")) {
-                  _context16.next = 52;
+                  _context16.next = 53;
                   break;
                 }
 
-                _context16.next = 51;
+                _context16.next = 52;
                 return Utils.ResponseToJson(this.client.authClient.MakeAuthServiceRequest({
                   path: path,
                   method: "GET",
                   queryParams: params
                 }));
 
-              case 51:
+              case 52:
                 return _context16.abrupt("return", _context16.sent);
 
-              case 52:
+              case 53:
                 _context16.t2 = Utils;
-                _context16.next = 55;
+                _context16.next = 56;
                 return this.client.authClient.MakeAuthServiceRequest({
                   path: path,
                   method: "GET",
                   queryParams: params
                 });
 
-              case 55:
+              case 56:
                 _context16.t3 = _context16.sent;
-                _context16.next = 58;
+                _context16.next = 59;
                 return _context16.t2.ResponseToJson.call(_context16.t2, _context16.t3);
 
-              case 58:
+              case 59:
                 _context16.t1 = _context16.sent;
 
                 if (_context16.t1) {
-                  _context16.next = 61;
+                  _context16.next = 62;
                   break;
                 }
 
                 _context16.t1 = [];
 
-              case 61:
+              case 62:
                 _ref16 = _context16.t1;
                 contents = _ref16.contents;
                 paging = _ref16.paging;
@@ -1680,12 +1684,12 @@ var ElvWalletClient = /*#__PURE__*/function () {
                   })
                 });
 
-              case 67:
-                _context16.prev = 67;
-                _context16.t4 = _context16["catch"](13);
+              case 68:
+                _context16.prev = 68;
+                _context16.t4 = _context16["catch"](14);
 
                 if (!(_context16.t4.status && _context16.t4.status.toString() === "404")) {
-                  _context16.next = 71;
+                  _context16.next = 72;
                   break;
                 }
 
@@ -1699,15 +1703,15 @@ var ElvWalletClient = /*#__PURE__*/function () {
                   results: []
                 });
 
-              case 71:
+              case 72:
                 throw _context16.t4;
 
-              case 72:
+              case 73:
               case "end":
                 return _context16.stop();
             }
           }
-        }, _callee16, this, [[13, 67]]);
+        }, _callee16, this, [[14, 68]]);
       }));
 
       function FilteredQuery() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eluvio/elv-client-js",
-  "version": "3.2.44",
+  "version": "4.0.0",
   "description": "Javascript client for the Eluvio Content Fabric",
   "main": "src/index.js",
   "author": "Kevin Talmadge",
@@ -74,7 +74,7 @@
     "crocks": "^0.12.4",
     "deep-equal": "^1.0.1",
     "ellipsize": "^0.1.0",
-    "ethers": "^4.0.26",
+    "ethers": "^5.7.2",
     "fraction.js": "^4.0.12",
     "hash.js": "^1.1.7",
     "image-type": "^4.1.0",

package/src/AuthorizationClient.js

@@ -204,7 +204,7 @@ class AuthorizationClient {
       addr: Utils.FormatAddress(((this.client.signer && this.client.signer.address) || ""))
     };
 
-    if(!(this.noAuth || noAuth)) {
+    if(update) {
       const { transactionHash } =  await this.MakeAccessRequest({
         libraryId,
         objectId,
@@ -344,8 +344,8 @@ class AuthorizationClient {
 
           // Save request ID if present
           accessRequest.logs.some(log => {
-            if(log.values && (log.values.requestID || log.values.requestNonce)) {
-              this.requestIds[address] = (log.values.requestID || log.values.requestNonce || "").toString().replace(/^0x/, "");
+            if(log.args && (log.args.requestID || log.args.requestNonce)) {
+              this.requestIds[address] = (log.args.requestID || log.args.requestNonce || "").toString().replace(/^0x/, "");
               return true;
             }
           });
@@ -653,12 +653,12 @@ class AuthorizationClient {
       if(!isV3) {
         if(args && args.length > 0) {
           // Inject public key of requester
-          args[1] = this.client.signer.signingKey ? this.client.signer.signingKey.publicKey : "";
+          args[1] = this.client.signer._signingKey ? this.client.signer._signingKey().publicKey : "";
         } else {
           // Set default args
           args = [
             0, // Access level
-            this.client.signer.signingKey ? this.client.signer.signingKey.publicKey : "", // Public key of requester
+            this.client.signer._signingKey ? this.client.signer._signingKey().publicKey : "", // Public key of requester
             publicKey, //cap.public_key,
             [], // Custom values
             [] // Stakeholders
@@ -803,7 +803,7 @@ class AuthorizationClient {
     return await Ethers.utils.joinSignature(
       this.client.signer.signDigest ?
         await this.client.signer.signDigest(message) :
-        await this.client.signer.signingKey.signDigest(message)
+        await this.client.signer._signingKey().signDigest(message)
     );
   }
 

package/src/ElvClient.js

@@ -998,7 +998,7 @@ class ElvClient {
 
     ValidatePresence("message", message);
 
-    return await this.Crypto.EncryptConk(message, publicKey || this.signer.signingKey.keyPair.publicKey);
+    return await this.Crypto.EncryptConk(message, publicKey || this.signer._signingKey().publicKey);
   }
 
   /**
@@ -1016,7 +1016,7 @@ class ElvClient {
 
     ValidatePresence("message", message);
 
-    return await this.Crypto.DecryptCap(message, this.signer.signingKey.privateKey);
+    return await this.Crypto.DecryptCap(message, this.signer._signingKey().privateKey);
   }
 
   /**
@@ -1061,6 +1061,7 @@ class ElvClient {
       "GenerateWallet",
       "InitializeClients",
       "Log",
+      "PersonalSign",
       "SetRemoteSigner",
       "SetSigner",
       "SetSignerFromWeb3Provider",

package/src/ElvWallet.js

@@ -7,8 +7,6 @@ class ElvWallet {
    * NOTE: It is recommended to initialize wallets from the ElvClient, not using this constructor
    *
    * @see ElvClient#GenerateWallet()
-   *
-   * @param {string} providerUrl - URL of blockchain provider
    */
   constructor(provider) {
     this.provider = provider;
@@ -21,7 +19,7 @@ class ElvWallet {
    * @returns {string} - Space-separated list of random words
    */
   GenerateMnemonic() {
-    return Ethers.utils.HDNode.entropyToMnemonic(Ethers.utils.randomBytes(16));
+    return Ethers.Wallet.createRandom().mnemonic.phrase;
   }
 
   /**

package/src/EthClient.js

@@ -39,7 +39,7 @@ class EthClient {
     // HTTP client for making misc calls to elv-master
     this.HttpClient = new HttpClient({uris: this.ethereumURIs, debug: this.debug});
 
-    Ethers.errors.setLogLevel("error");
+    //Ethers.errors.setLogLevel("error");
   }
 
   SetEthereumURIs(uris) {
@@ -234,7 +234,7 @@ class EthClient {
 
     contract = contract || this.Contract({contractAddress, abi, cacheContract, overrideCachedContract});
 
-    abi = contract.interface.abi;
+    abi = contract.interface.fragments;
 
     // Automatically format contract arguments
     if(formatArguments) {
@@ -262,7 +262,7 @@ class EthClient {
         Args: [${methodArgs.join(", ")}]`
     );
 
-    const methodAbi = contract.interface.abi.find(method => method.name === methodName);
+    const methodAbi = contract.interface.fragments.find(method => method.name === methodName);
 
     // Lock if performing a transaction
     if(!methodAbi || !methodAbi.constant) {
@@ -278,7 +278,7 @@ class EthClient {
       let success = false;
       while(!success) {
         try {
-          result = await contract.functions[methodName](...methodArgs, overrides);
+          result = await contract[methodName](...methodArgs, overrides);
           success = true;
         } catch(error) {
           if(error.code === -32000 || error.code === "REPLACEMENT_UNDERPRICED") {
@@ -343,9 +343,15 @@ class EthClient {
 
       if(methodEvent) {
         methodEvent.logs = methodEvent.logs.map(log => {
+          let parsedLogs = {};
+          try {
+            parsedLogs = contract.interface.parseLog(log);
+          // eslint-disable-next-line no-empty
+          } catch(error) {}
+
           return {
             ...log,
-            ...(contract.interface.parseLog(log))
+            ...parsedLogs
           };
         });
 
@@ -378,10 +384,13 @@ class EthClient {
     const contractInterface = new Ethers.utils.Interface(abi);
     // Loop through logs to find the desired log
     for(const log of event.logs) {
-      const parsedLog = contractInterface.parseLog(log);
-      if(parsedLog && parsedLog.name === eventName) {
-        return parsedLog;
-      }
+      try {
+        const parsedLog = contractInterface.parseLog(log);
+        if(parsedLog && parsedLog.name === eventName) {
+          return parsedLog;
+        }
+      // eslint-disable-next-line no-empty
+      } catch(error) {}
     }
   }
 
@@ -400,7 +409,7 @@ class EthClient {
       throw Error(`${methodName} failed - Log not present in transaction`);
     }
 
-    const newContractAddress = eventLog.values[eventValue];
+    const newContractAddress = eventLog.args[eventValue];
 
     return {
       contractAddress: Utils.FormatAddress(newContractAddress),

package/src/FrameClient.js

@@ -243,7 +243,7 @@ class FrameClient {
       "DeleteUserMetadata",
       "MergeUserMetadata",
       "ReplaceUserMetadata",
-      "UserMetadata"
+      "UserMetadata",
     ];
   }
 
@@ -268,6 +268,13 @@ class FrameClient {
     ];
   }
 
+  // List of methods that are defined separately in FrameClient
+  OverriddenMethods() {
+    return [
+      "UploadFiles"
+    ];
+  }
+
   // List of allowed methods available to frames
   // This should match ElvClient.FrameAvailableMethods()
   // ElvClient will also reject any disallowed methods
@@ -334,6 +341,7 @@ class FrameClient {
       "CreateContentObject",
       "CreateContentType",
       "CreateEncryptionConk",
+      "CreateFabricToken",
       "CreateFileDirectories",
       "CreateFileUploadJob",
       "CreateLinks",
@@ -377,6 +385,7 @@ class FrameClient {
       "FinalizeUploadJob",
       "FormatContractArguments",
       "GenerateStateChannelToken",
+      "GenerateSignedLinkToken",
       "GetBalance",
       "InitializeAuthPolicy",
       "IssueNTPCode",
@@ -440,7 +449,6 @@ class FrameClient {
       "UpdateContentObjectGraph",
       "UpdateNTPInstance",
       "UploadFileData",
-      /*"UploadFiles",*/ //Override
       "UploadFilesFromS3",
       "UploadJobStatus",
       "UploadPart",

package/src/HttpClient.js

@@ -22,8 +22,8 @@ class HttpClient {
     return Fetch(url, params);
   }
 
-  RecordWriteToken(writeToken) {
-    this.draftURIs[writeToken] = this.BaseURI();
+  RecordWriteToken(writeToken, nodeUrlStr) {
+    this.draftURIs[writeToken] = nodeUrlStr ? new URI(nodeUrlStr) : this.BaseURI();
   }
 
   RequestHeaders(bodyType, headers={}) {
@@ -54,7 +54,7 @@ class HttpClient {
     let baseURI = this.BaseURI();
 
     // If URL contains a write token, it must go to the correct server and can not fail over
-    const writeTokenMatch = path.replace(/^\//, "").match(/(qlibs\/ilib[a-zA-Z0-9]+|q|qid)\/(tqw_[a-zA-Z0-9]+)/);
+    const writeTokenMatch = path.replace(/^\//, "").match(/(qlibs\/ilib[a-zA-Z0-9]+|q|qid)\/(tqw__[a-zA-Z0-9]+)/);
     const writeToken = writeTokenMatch ? writeTokenMatch[2] : undefined;
 
     if(writeToken) {

package/src/client/ABRPublishing.js

@@ -34,6 +34,8 @@ const {
  * @param {boolean=} encrypt=true - (Local or copied files only) - Unless `false` is passed in explicitly, any uploaded/copied files will be stored encrypted
  * @param {boolean=} copy=false - (S3) If specified, files will be copied from S3
  * @param {function=} callback - Progress callback for file upload (See UploadFiles/UploadFilesFromS3 method)
+ * @param {("warn"|"info"|"debug")=} respLogLevel=warn - The level of logging to return in http response
+ * @param {("none"|"error"|"warn"|"info"|"debug")=} structLogLevel=none - The level of logging to save to object metadata
  * @param {Array<Object>=} access=[] - Array of cloud credentials, along with path matching regex strings - Required if any files in the masters are cloud references (currently only AWS S3 is supported)
  * - If this parameter is non-empty, all items in fileInfo are assumed to be items in cloud storage
  * - Format: [
@@ -76,7 +78,9 @@ exports.CreateProductionMaster = async function({
   encrypt=true,
   access=[],
   copy=false,
-  callback
+  callback,
+  respLogLevel = "warn",
+  structLogLevel="none"
 }) {
   ValidateLibrary(libraryId);
 
@@ -174,6 +178,10 @@ exports.CreateProductionMaster = async function({
     objectId: id,
     writeToken: write_token,
     method: UrlJoin("media", "production_master", "init"),
+    queryParams: {
+      response_log_level: respLogLevel,
+      struct_log_level: structLogLevel
+    },
     body: {
       access
     },
@@ -215,20 +223,25 @@ exports.CreateProductionMaster = async function({
 };
 
 /**
- * Create a mezzanine of the given master content object
+ * Create (or edit) a mezzanine offering based on the a given master content object version and variant key
  *
  * @methodGroup ABR Publishing
  * @namedParams
+ * @param {Object=} abrProfile - Custom ABR profile. If not specified, the profile of the mezzanine library will be used
+ * @param {Object=} addlOfferingSpecs - Specs for additional offerings to create by patching the offering being created/edited
+ * @param {string=} description - Description for mezzanine content object
+ * @param {boolean=} keepOtherStreams=false - If objectId is specified, whether to preserve existing streams with keys other than the ones specified in production master
  * @param {string} libraryId - ID of the mezzanine library
+ * @param {string} masterVersionHash - The version hash of the production master content object
+ * @param {Object=} metadata - Additional metadata for mezzanine content object
+ * @param {string} name - Name for mezzanine content object
  * @param {string=} objectId - ID of existing object (if not specified, new object will be created)
+ * @param {string=} offeringKey=default - The key of the offering to create
+ * @param {("warn"|"info"|"debug")=} respLogLevel=warn - The level of logging to return in http response
+ * @param {("none"|"error"|"warn"|"info"|"debug")=} structLogLevel=none - The level of logging to save to object metadata
+ * @param {Array<string>} streamKeys - List of stream keys from variant to include. If not supplied all streams will be included.
  * @param {string=} type - ID or version hash of the content type for the mezzanine
- * @param {string} name - Name for mezzanine content object
- * @param {string=} description - Description for mezzanine content object
- * @param {Object=} metadata - Additional metadata for mezzanine content object
- * @param {string} masterVersionHash - The version hash of the production master content object
  * @param {string=} variant=default - What variant of the master content object to use
- * @param {string=} offeringKey=default - The key of the offering to create
- * @param {Object=} abrProfile - Custom ABR profile. If not specified, the profile of the mezzanine library will be used
  *
  * @return {Object} - The finalize response for the object, as well as logs, warnings and errors from the mezzanine initialization
  */
@@ -241,8 +254,13 @@ exports.CreateABRMezzanine = async function({
   metadata,
   masterVersionHash,
   abrProfile,
+  addlOfferingSpecs,
   variant="default",
-  offeringKey="default"
+  offeringKey="default",
+  keepOtherStreams= false,
+  respLogLevel = "warn",
+  structLogLevel="none",
+  streamKeys
 }) {
   ValidateLibrary(libraryId);
   ValidateVersion(masterVersionHash);
@@ -251,6 +269,14 @@ exports.CreateABRMezzanine = async function({
     throw Error("Master version hash not specified");
   }
 
+  if(!objectId && (keepOtherStreams)) {
+    throw Error("Existing mezzanine object ID required in order to use 'keepOtherStreams'");
+  }
+
+  if(addlOfferingSpecs && !abrProfile) {
+    throw Error("abrProfile required when using addlOfferingSpecs");
+  }
+
   const existingMez = !!objectId;
 
   let options = type ? { type } : {};
@@ -295,9 +321,12 @@ exports.CreateABRMezzanine = async function({
   };
 
   const body = {
+    additional_offering_specs: addlOfferingSpecs,
     offering_key: offeringKey,
-    variant_key: variant,
-    prod_master_hash: masterVersionHash
+    keep_other_streams: keepOtherStreams,
+    prod_master_hash: masterVersionHash,
+    stream_keys: streamKeys,
+    variant_key: variant
   };
 
   let storeClear = false;
@@ -327,6 +356,10 @@ exports.CreateABRMezzanine = async function({
     objectId: id,
     writeToken: write_token,
     method: UrlJoin("media", "abr_mezzanine", "init"),
+    queryParams: {
+      response_log_level: respLogLevel,
+      struct_log_level: structLogLevel
+    },
     headers,
     body,
     constant: false
@@ -551,26 +584,14 @@ exports.LROStatus = async function({libraryId, objectId, offeringKey="default"})
     }
   }
 
-  let error, result;
-  const fabricURIs = this.fabricURIs;
-  try {
-    this.SetNodes({fabricURIs: [lroDraft.node, ...fabricURIs]});
-
-    result = await this.ContentObjectMetadata({
-      libraryId,
-      objectId,
-      writeToken: lroDraft.write_token,
-      metadataSubtree: "lro_status"
-    });
-  } catch(err) {
-    error = err;
-  } finally {
-    this.SetNodes({fabricURIs});
-  }
+  this.HttpClient.RecordWriteToken(lroDraft.write_token, lroDraft.node);
 
-  if(error) { throw error; }
-
-  return result;
+  return await this.ContentObjectMetadata({
+    libraryId,
+    objectId,
+    writeToken: lroDraft.write_token,
+    metadataSubtree: "lro_status"
+  });
 };
 
 /**
@@ -582,10 +603,12 @@ exports.LROStatus = async function({libraryId, objectId, offeringKey="default"})
  * @param {string} objectId - ID of the mezzanine object
  * @param {string} writeToken - Write token for the mezzanine object
  * @param {string=} offeringKey=default - The offering to process
+ * @param {function=} preFinalizeFn - A function to call before finalizing changes, to allow further modifications to offering. The function will be invoked with {elvClient, nodeUrl, writeToken} to allow access to the draft and MUST NOT finalize the draft.
+ * @param {boolean=} preFinalizeThrow - If set to `true` then any error thrown by preFinalizeFn will not be caught. Otherwise, any exception will be appended to the `warnings` array returned after finalization.
  *
  * @return {Promise<Object>} - The finalize response for the mezzanine object, as well as any logs, warnings and errors from the finalization
  */
-exports.FinalizeABRMezzanine = async function({libraryId, objectId, offeringKey="default"}) {
+exports.FinalizeABRMezzanine = async function({libraryId, objectId, offeringKey="default", preFinalizeFn, preFinalizeThrow}) {
   ValidateParameters({libraryId, objectId});
 
   const lroDraft = await this.ContentObjectMetadata({
@@ -632,6 +655,22 @@ exports.FinalizeABRMezzanine = async function({libraryId, objectId, offeringKey=
       constant: false
     });
 
+    let preFinalizeWarnings = [];
+    if(preFinalizeFn) {
+      const params = {
+        elvClient: this,
+        nodeUrl: lroDraft.node,
+        writeToken: lroDraft.write_token
+      };
+      if(preFinalizeThrow){
+        await preFinalizeFn(params);
+      } else try {
+        await preFinalizeFn(params);
+      } catch(e) {
+        preFinalizeWarnings = `Error trying to set video stream codec descriptors: ${e}`;
+      }
+    }
+
     const finalizeResponse = await this.FinalizeContentObject({
       libraryId,
       objectId: objectId,
@@ -643,7 +682,7 @@ exports.FinalizeABRMezzanine = async function({libraryId, objectId, offeringKey=
     result = {
       data,
       logs: logs || [],
-      warnings: warnings || [],
+      warnings: (warnings || []).concat(preFinalizeWarnings),
       errors: errors || [],
       ...finalizeResponse
     };