@eluvio/elv-client-js 3.1.94 → 3.1.97

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eluvio/elv-client-js",
-  "version": "3.1.94",
+  "version": "3.1.97",
   "description": "Javascript client for the Eluvio Content Fabric",
   "main": "src/ElvClient.js",
   "author": "Kevin Talmadge",
@@ -57,7 +57,7 @@
   "dependencies": {
     "@babel/runtime": "^7.8.4",
     "@eluvio/crypto": ">=1.0.8",
-    "@eluvio/elv-abr-profile": "^0.2.0",
+    "@eluvio/elv-abr-profile": "^1.0.0",
     "@sindresorhus/slugify": "^1.1.0",
     "babel-loader": "^8.0.6",
     "bignumber.js": "^8.0.2",

package/src/AuthorizationClient.js

@@ -204,7 +204,7 @@ class AuthorizationClient {
       addr: Utils.FormatAddress(((this.client.signer && this.client.signer.address) || ""))
     };
 
-    if(!(this.noAuth || noAuth) && !this.client.signer.remoteSigner) {
+    if(!(this.noAuth || noAuth)) {
       const { transactionHash } =  await this.MakeAccessRequest({
         libraryId,
         objectId,

package/src/ElvClient.js

@@ -694,6 +694,67 @@ class ElvClient {
     return this.utils.FormatAddress(this.signer.address);
   }
 
+  /*
+    TOKEN                  211b  PREFIX + BODY | aplsjcJf1HYcDDUuCdXcSZtU86nYK162YmYJeuqwMczEBJVkD5D5EvsBvVwYDRsf4hzDvBWMoe9piBpqx...
+    PREFIX                   6b  aplsjc | apl=plain s=ES256K jc=json-compressed
+    BODY                   205b  base58(SIGNATURE + PAYLOAD)
+    SIGNATURE + PAYLOAD    151b  151b * 138 / 100 + 1 = 209b (>= 205b)
+    SIGNATURE               66b  ES256K_Di9Lu83mz4wMoehCEeQhKpJJ7ApmDZLumAa2Cge48F6EHYnbn8msATGGpjucScwimei1TWGd7aeyQY45AdXd5tT1Z
+    PAYLOAD                 85b  json-compressed
+    json                    79b  {"adr":"VVf4DQU357tDnZGYQeDrntRJ5rs=","spc":"ispc3ANoVSzNA3P6t7abLR69ho5YPPZU"}
+   */
+
+  /**
+   * Create a signed authorization token that can be used to authorize against the fabric
+   *
+   * @methodGroup Authorization
+   * @namedParams
+   * @param {number} duration=86400000 - Time until the token expires, in milliseconds (1 hour = 60 * 60 * 1000 = 3600000). Default is 24 hours.
+   * @param {Object=} spec - Additional attributes for this token
+   * @param {string=} address - Address of the signing account - if not specified, the current signer address will be used.
+   * @param {function=} Sign - If specified, this function will be used to produce the signature instead of the client's current signer
+   * @param {boolean=} addEthereumPrefix=true - If specified, the 'Ethereum Signed Message' prefixed hash format will be performed. Disable this if the provided Sign method already does this (e.g. Metamask)
+   */
+  async CreateFabricToken({
+    duration=24 * 60 * 60 * 1000,
+    spec={},
+    address,
+    Sign,
+    addEthereumPrefix=true,
+  }={}) {
+    address = address || this.CurrentAccountAddress();
+
+    let token = {
+      ...spec,
+      sub:`iusr${Utils.AddressToHash(address)}`,
+      adr: Buffer.from(address.replace(/^0x/, ""), "hex").toString("base64"),
+      spc: await this.ContentSpaceId(),
+      iat: Date.now(),
+      exp: Date.now() + duration,
+    };
+
+    if(!Sign) {
+      Sign = async message => this.authClient.Sign(message);
+    }
+
+    let message = `Eluvio Content Fabric Access Token 1.0\n${JSON.stringify(token)}`;
+
+    if(addEthereumPrefix) {
+      message = Ethers.utils.keccak256(Buffer.from(`\x19Ethereum Signed Message:\n${message.length}${message}`, "utf-8"));
+    }
+
+    const signature = await Sign(message);
+
+    const compressedToken = Pako.deflateRaw(Buffer.from(JSON.stringify(token), "utf-8"));
+    return `acspjc${this.utils.B58(
+      Buffer.concat([
+        Buffer.from(signature.replace(/^0x/, ""), "hex"),
+        Buffer.from(compressedToken)
+      ])
+    )}`;
+  }
+
+
   /**
    * Issue a self-signed authorization token
    *
@@ -705,7 +766,7 @@ class ElvClient {
    * @param {string=} policyId - The object ID of the policy for this token
    * @param {string=} subject - The subject of the token
    * @param {string} grantType=read - Permissions to grant for this token. Options: "access", "read", "create", "update", "read-crypt"
-   * @param {number} duration - Time until the token expires, in milliseconds (1 hour = 60 * 60 * 1000)
+   * @param {number} duration - Time until the token expires, in milliseconds (1 hour = 60 * 60 * 1000 = 3600000)
    * @param {boolean} allowDecryption=false - If specified, the re-encryption key will be included in the token,
    * enabling the user of this token to download encrypted content from the specified object
    * @param {Object=} context - Additional JSON context

package/src/RemoteSigner.js

@@ -85,24 +85,28 @@ class RemoteSigner extends Ethers.Signer {
    */
   async signDigest(digest) {
     if(!this.signatureCache[digest]) {
-      this.signatureCache[digest] = new Promise(async resolve => {
-        let signature = await Utils.ResponseToJson(
-          this.HttpClient.Request({
-            method: "POST",
-            path: UrlJoin("as", "wlt", "sign", "eth", this.id),
-            headers: {
-              Authorization: `Bearer ${this.authToken}`
-            },
-            body: {
-              hash: digest
-            }
-          })
-        );
-
-        signature.v = parseInt(signature.v, 16);
-        signature.recoveryParam = signature.v - 27;
-
-        resolve(signature);
+      this.signatureCache[digest] = new Promise(async (resolve, reject) => {
+        try {
+          let signature = await Utils.ResponseToJson(
+            this.HttpClient.Request({
+              method: "POST",
+              path: UrlJoin("as", "wlt", "sign", "eth", this.id),
+              headers: {
+                Authorization: `Bearer ${this.authToken}`
+              },
+              body: {
+                hash: digest
+              }
+            })
+          );
+
+          signature.v = parseInt(signature.v, 16);
+          signature.recoveryParam = signature.v - 27;
+
+          resolve(signature);
+        } catch(error) {
+          reject(error);
+        }
       });
     }
 

package/src/Utils.js

@@ -4,6 +4,7 @@ const bs58 = require("bs58");
 const BigNumber = require("bignumber.js").default;
 const VarInt = require("varint");
 const URI = require("urijs");
+const Pako = require("pako");
 
 const {
   keccak256,
@@ -150,6 +151,27 @@ const Utils = {
     };
   },
 
+
+  /**
+   * Decode the specified signed token into its component parts
+   *
+   * @param {string} token - The token to decode
+   *
+   * @return {Object} - Components of the signed token
+   */
+  DecodeSignedToken: (token) => {
+    const decodedToken = Utils.FromB58(token.slice(6));
+    const signature = `0x${decodedToken.slice(0, 65).toString("hex")}`;
+
+    let payload = JSON.parse(Buffer.from(Pako.inflateRaw(decodedToken.slice(65))).toString("utf-8"));
+    payload.adr = Utils.FormatAddress(`0x${Buffer.from(payload.adr, "base64").toString("hex")}`);
+
+    return {
+      payload,
+      signature
+    };
+  },
+
   /**
    * Decode the specified write token into its component parts
    *

package/src/client/ContentAccess.js

@@ -2332,6 +2332,10 @@ exports.LinkData = async function({libraryId, objectId, versionHash, writeToken,
 /* Encryption */
 
 exports.CreateEncryptionConk = async function({libraryId, objectId, versionHash, writeToken, createKMSConk=true}) {
+  if(this.signer.remoteSigner) {
+    return;
+  }
+
   ValidateParameters({libraryId, objectId, versionHash});
   ValidateWriteToken(writeToken);
 

package/testScripts/Test.js

@@ -13,25 +13,6 @@ const Test = async () => {
     });
 
     client.SetSigner({signer});
-
-
-    const ethUrl = "https://host-216-66-40-19.contentfabric.io/eth";
-    const asUrl = "https://host-66-220-3-86.contentfabric.io";
-
-    client.SetNodes({
-      ethereumURIs: [
-        ethUrl
-      ],
-      authServiceURIs: [
-        asUrl
-      ]
-    });
-
-    console.log(
-      await client.ContentObjectTenantId({
-        objectId: "iq__3PXRZX5NCzPQsfTEquCctB2K3KJh"
-      })
-    )
   } catch(error) {
     console.error(error);
     console.error(JSON.stringify(error, null, 2));

package/utilities/ObjectSetPermission.js

@@ -9,7 +9,7 @@ const Logger = require("./lib/concerns/Logger");
 
 const permissionTypes = ["owner", "editable", "viewable", "listable", "public"];
 
-class ObjectAddGroupPerms extends Utility {
+class ObjectSetPermission extends Utility {
   blueprint() {
     return {
       concerns: [Logger, ArgObjectId, Client],
@@ -55,7 +55,7 @@ class ObjectAddGroupPerms extends Utility {
 }
 
 if(require.main === module) {
-  Utility.cmdLineInvoke(ObjectAddGroupPerms);
+  Utility.cmdLineInvoke(ObjectSetPermission);
 } else {
-  module.exports = ObjectAddGroupPerms;
-}
+  module.exports = ObjectSetPermission;
+}

package/utilities/SimpleIngest.js

@@ -53,6 +53,10 @@ class SimpleIngest extends Utility {
     const libABRProfile = R.path(["metadata", "abr", "default_profile"], libInfo);
     if(R.isNil(libABRProfile)) throw Error("Library does not specify ABR profile for simple ingests");
 
+    const libMezManageGroups = R.path(["metadata", "abr", "mez_manage_groups"], libInfo);
+
+    const libMezPermission = R.path(["metadata", "abr", "mez_permission_level"], libInfo);
+
     const {drm, libraryId, title} = this.args;
     const encrypt = true;
 
@@ -91,6 +95,7 @@ class SimpleIngest extends Utility {
 
     if(!R.isNil(createMasterResponse.errors) && !R.isEmpty(createMasterResponse.errors)) throw Error(`Error(s) encountered while inspecting uploaded files: ${createMasterResponse.errors.join("\n")}`);
 
+    // TODO: replace with a 'waitForNewObject' call (Finalize.waitForPublish throws exception for brand new object not yet visible)
     await seconds(2);
 
     await this.concerns.Finalize.waitForPublish({
@@ -218,6 +223,42 @@ class SimpleIngest extends Utility {
     const finalizeErrors = finalizeAbrResponse.errors;
     if(!R.isNil(finalizeErrors) && !R.isEmpty(finalizeErrors)) throw Error(`Error(s) encountered while finalizing object: ${finalizeErrors.join("\n")}`);
 
+    if(libMezManageGroups && libMezManageGroups.length > 0){
+      for(const groupAddress of libMezManageGroups){
+        logger.log("Setting access permissions for managers");
+        await client.AddContentObjectGroupPermission({
+          objectId: id,
+          groupAddress,
+          permission: "manage"
+        });
+
+      }
+    }
+
+    if(libMezPermission) {
+      if(!["owner", "editable", "viewable", "listable", "public"].includes(libMezPermission)) {
+        logger.warn(`Bad value for mez_permission_level: '${libMezPermission}', skipping permission setting`);
+      } else {
+        logger.log(`Setting object permission to '${libMezPermission}'`);
+        const prevHash = await client.LatestVersionHash({objectId: id});
+
+        await client.SetPermission({
+          objectId: id,
+          permission: libMezPermission
+        });
+
+        const newHash = await client.LatestVersionHash({objectId: id});
+
+        if(prevHash === newHash) {
+          logger.log("Version hash unchanged: " + newHash );
+        } else {
+          logger.log("Previous version hash: " + prevHash );
+          logger.log("New version hash: " + newHash );
+        }
+        logger.data("version_hash", newHash);
+      }
+    }
+
     logger.logList(
       "",
       "Playable media object created:",

package/utilities/example_files/simple_ingest_library_metadata.json

@@ -0,0 +1,180 @@
+{
+  "abr": {
+    "comments": [
+      "For movies/TV - snapAR is set to true, this profile will attempt to conform aspect ratio to nearby standard",
+      "also specifies 'store encrypted', offers both clear and drm playout formats"
+    ],
+    "mez_content_type": "YOUR_TITLE_(MEZ)_CONTENT_TYPE_ID",
+    "mez_manage_groups": [
+      "ADDRESS_FOR_YOUR_CONTENT_ADMINS_GROUP"
+    ],
+    "mez_permission_level": "ONE_OF_THE_FOLLOWING: owner, editable, viewable, listable, public",
+    "default_profile": {
+      "drm_optional": true,
+      "store_clear": false,
+      "video_parametric_ladder": {
+        "baseAspectRatio": "16/9",
+        "baseFrameRate": "30",
+        "rungSpecs": [
+          {
+            "dim": 2160,
+            "bitrate": 14000000
+          },
+          {
+            "dim": 1440,
+            "bitrate": 11500000
+          },
+          {
+            "dim": 1080,
+            "bitrate": 9500000
+          },
+          {
+            "dim": 720,
+            "bitrate": 4500000
+          },
+          {
+            "dim": 480,
+            "bitrate": 1750000
+          },
+          {
+            "dim": 360,
+            "bitrate": 810000
+          },
+          {
+            "dim": 240,
+            "bitrate": 500000
+          }
+        ],
+        "options": {
+          "upscale": false,
+          "snapAR": true,
+          "maxARSnap": 0.06,
+          "minDimStepdown": 0.12,
+          "frameRateScaleFactor": 0.5
+        },
+        "limits": {
+          "aspectRatioMax": "3",
+          "aspectRatioMin": "1/3",
+          "avgBitrateMax": 100000000,
+          "avgBitrateMin": 100000,
+          "fileSizeMax": 100000000,
+          "fileSizeMin": 10000,
+          "durationMax": 14400,
+          "durationMin": 1,
+          "finalBitrateMax": 30000000,
+          "frameRateMax": "60",
+          "frameRateMin": "15",
+          "heightMax": 5000,
+          "heightMin": 100,
+          "sampleAspectRatioMax": "3/2",
+          "sampleAspectRatioMin": "2/3",
+          "widthMax": 5000,
+          "widthMin": 100
+        }
+      },
+      "ladder_specs": {
+        "{\"media_type\":\"audio\",\"channels\":1}": {
+          "rung_specs": [
+            {
+              "bit_rate": 128000,
+              "media_type": "audio",
+              "pregenerate": true
+            }
+          ]
+        },
+        "{\"media_type\":\"audio\",\"channels\":2}": {
+          "rung_specs": [
+            {
+              "bit_rate": 192000,
+              "media_type": "audio",
+              "pregenerate": true
+            }
+          ]
+        },
+        "{\"media_type\":\"audio\",\"channels\":6}": {
+          "rung_specs": [
+            {
+              "bit_rate": 384000,
+              "media_type": "audio",
+              "pregenerate": true
+            }
+          ]
+        }
+      },
+      "playout_formats": {
+        "dash-widevine": {
+          "drm": {
+            "content_id": "",
+            "enc_scheme_name": "cenc",
+            "license_servers": [],
+            "type": "DrmWidevine"
+          },
+          "protocol": {
+            "min_buffer_length": 2,
+            "type": "ProtoDash"
+          }
+        },
+        "hls-aes128": {
+          "drm": {
+            "enc_scheme_name": "aes-128",
+            "type": "DrmAes128"
+          },
+          "protocol": {
+            "type": "ProtoHls"
+          }
+        },
+        "hls-fairplay": {
+          "drm": {
+            "enc_scheme_name": "cbcs",
+            "license_servers": [],
+            "type": "DrmFairplay"
+          },
+          "protocol": {
+            "type": "ProtoHls"
+          }
+        },
+        "hls-sample-aes": {
+          "drm": {
+            "enc_scheme_name": "cbcs",
+            "type": "DrmSampleAes"
+          },
+          "protocol": {
+            "type": "ProtoHls"
+          }
+        },
+        "dash-clear": {
+          "drm": null,
+          "protocol": {
+            "min_buffer_length": 2,
+            "type": "ProtoDash"
+          }
+        },
+        "hls-clear": {
+          "drm": null,
+          "protocol": {
+            "type": "ProtoHls"
+          }
+        }
+      },
+      "segment_specs": {
+        "audio": {
+          "segs_per_chunk": 15,
+          "target_dur": 2
+        },
+        "video": {
+          "segs_per_chunk": 15,
+          "target_dur": 2
+        }
+      }
+    }
+  },
+  "elv": {
+    "media": {
+      "drm": {
+        "fps": {
+          "cert": "MIIExzCCA6+gAwIBAgIIHyfkXhxLHC4wDQYJKoZIhvcNAQEFBQAwfzELMAkGA1UEBhMCVVMxEzARBgNVBAoMCkFwcGxlIEluYy4xJjAkBgNVBAsMHUFwcGxlIENlcnRpZmljYXRpb24gQXV0aG9yaXR5MTMwMQYDVQQDDCpBcHBsZSBLZXkgU2VydmljZXMgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkwHhcNMjAwOTEyMDMzMjI0WhcNMjIwOTEzMDMzMjI0WjBgMQswCQYDVQQGEwJVUzETMBEGA1UECgwKRWx1dmlvIEluYzETMBEGA1UECwwKMktIOEtDM01NWDEnMCUGA1UEAwweRmFpclBsYXkgU3RyZWFtaW5nOiBFbHV2aW8gSW5jMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDslbBURB6gj07g7VrS7Ojixe7FNZOupomcZt+mtMvyavjg7X7/T4RccmKUQxOoMLKCJcQ6WrdHhIpN8+bciq7lr0mNzaN467zREiUNYOpkVPi13sJLieY2m2MEPOQTbIl52Cu1YyH+4/g1dKPmeguSnzZRo36jsCGHlJBjHq0jkQIDAQABo4IB6DCCAeQwDAYDVR0TAQH/BAIwADAfBgNVHSMEGDAWgBRj5EdUy4VxWUYsg6zMRDFkZwMsvjCB4gYDVR0gBIHaMIHXMIHUBgkqhkiG92NkBQEwgcYwgcMGCCsGAQUFBwICMIG2DIGzUmVsaWFuY2Ugb24gdGhpcyBjZXJ0aWZpY2F0ZSBieSBhbnkgcGFydHkgYXNzdW1lcyBhY2NlcHRhbmNlIG9mIHRoZSB0aGVuIGFwcGxpY2FibGUgc3RhbmRhcmQgdGVybXMgYW5kIGNvbmRpdGlvbnMgb2YgdXNlLCBjZXJ0aWZpY2F0ZSBwb2xpY3kgYW5kIGNlcnRpZmljYXRpb24gcHJhY3RpY2Ugc3RhdGVtZW50cy4wNQYDVR0fBC4wLDAqoCigJoYkaHR0cDovL2NybC5hcHBsZS5jb20va2V5c2VydmljZXMuY3JsMB0GA1UdDgQWBBR4jerseBHEUDC7mU+NQuIzZqHRFDAOBgNVHQ8BAf8EBAMCBSAwOAYLKoZIhvdjZAYNAQMBAf8EJgFuNnNkbHQ2OXFuc3l6eXp5bWFzdmdudGthbWd2bGE1Y212YzdpMC4GCyqGSIb3Y2QGDQEEAQH/BBwBd252bHhlbGV1Y3Vpb2JyZW4yeHZlZmV6N2Y5MA0GCSqGSIb3DQEBBQUAA4IBAQBM17YYquw0soDPAadr1aIM6iC6BQ/kOGYu3y/6AlrwYgAQNFy8DjsQUoqlQWFuA0sigp57bTUymkXEBf9yhUmXXiPafGjbxzsPF5SPFLIciolWbxRCB153L1a/Vh2wg3rhf4IvAZuJpnml6SSg5SjD19bN+gD7zrtp3yWKBKuarLSjDvVIB1SoxEToBs3glAEqoBiA2eZjikBA0aBlbvjUF2gqOmZjZJ7dmG1Tos2Zd4SdGL6ltSpKUeSGSxyv41aqF83vNpymNJmey2t2kPPtC7mt0LM32Ift3AkAl8Za9JbV/pOnc95oAfPhVTOGOI+u2BuB2qaKWjqHwkfqCz4A"
+        }
+      }
+    }
+  }
+}

package/utilities/example_files/simple_ingest_library_metadata_animation_NFTs.json

@@ -0,0 +1,133 @@
+{
+  "abr": {
+    "comments": [
+      "For animation NFTs that are not movie/TV clips - snapAR is set to false",
+      "also specifies 'store clear', only offers clear playout formats (no drm)",
+      "and object permission 'listable'.",
+      "does not include DRM cert @ /elv/media/drm/fps/cert"
+    ],
+    "mez_content_type": "YOUR_TITLE_(NFT)_CONTENT_TYPE_ID",
+    "mez_manage_groups": [
+      "ADDRESS_FOR_YOUR_CONTENT_ADMINS_GROUP"
+    ],
+    "mez_permission_level": "listable",
+    "default_profile": {
+      "drm_optional": true,
+      "store_clear": true,
+      "video_parametric_ladder": {
+        "baseAspectRatio": "16/9",
+        "baseFrameRate": "30",
+        "rungSpecs": [
+          {
+            "dim": 2160,
+            "bitrate": 14000000
+          },
+          {
+            "dim": 1440,
+            "bitrate": 11500000
+          },
+          {
+            "dim": 1080,
+            "bitrate": 9500000
+          },
+          {
+            "dim": 720,
+            "bitrate": 4500000
+          },
+          {
+            "dim": 480,
+            "bitrate": 1750000
+          },
+          {
+            "dim": 360,
+            "bitrate": 810000
+          },
+          {
+            "dim": 240,
+            "bitrate": 500000
+          }
+        ],
+        "options": {
+          "upscale": false,
+          "snapAR": false,
+          "maxARSnap": 0.06,
+          "minDimStepdown": 0.12,
+          "frameRateScaleFactor": 0.5
+        },
+        "limits": {
+          "aspectRatioMax": "3",
+          "aspectRatioMin": "1/3",
+          "avgBitrateMax": 100000000,
+          "avgBitrateMin": 100000,
+          "fileSizeMax": 100000000,
+          "fileSizeMin": 10000,
+          "durationMax": 14400,
+          "durationMin": 1,
+          "finalBitrateMax": 30000000,
+          "frameRateMax": "60",
+          "frameRateMin": "15",
+          "heightMax": 5000,
+          "heightMin": 100,
+          "sampleAspectRatioMax": "3/2",
+          "sampleAspectRatioMin": "2/3",
+          "widthMax": 5000,
+          "widthMin": 100
+        }
+      },
+      "ladder_specs": {
+        "{\"media_type\":\"audio\",\"channels\":1}": {
+          "rung_specs": [
+            {
+              "bit_rate": 128000,
+              "media_type": "audio",
+              "pregenerate": true
+            }
+          ]
+        },
+        "{\"media_type\":\"audio\",\"channels\":2}": {
+          "rung_specs": [
+            {
+              "bit_rate": 192000,
+              "media_type": "audio",
+              "pregenerate": true
+            }
+          ]
+        },
+        "{\"media_type\":\"audio\",\"channels\":6}": {
+          "rung_specs": [
+            {
+              "bit_rate": 384000,
+              "media_type": "audio",
+              "pregenerate": true
+            }
+          ]
+        }
+      },
+      "playout_formats": {
+        "dash-clear": {
+          "drm": null,
+          "protocol": {
+            "min_buffer_length": 2,
+            "type": "ProtoDash"
+          }
+        },
+        "hls-clear": {
+          "drm": null,
+          "protocol": {
+            "type": "ProtoHls"
+          }
+        }
+      },
+      "segment_specs": {
+        "audio": {
+          "segs_per_chunk": 15,
+          "target_dur": 2
+        },
+        "video": {
+          "segs_per_chunk": 15,
+          "target_dur": 2
+        }
+      }
+    }
+  }
+}