@superfluid-finance/ethereum-contracts 1.2.1 → 1.2.2-dev.153bcd3.0

package/scripts/gov-create-new-app-registration-key.js

@@ -6,6 +6,8 @@ const {
     sendGovernanceAction,
 } = require("./libs/common");
 
+const ZERO_ADDRESS = "0x0000000000000000000000000000000000000000";
+
 /**
  * @dev Create a new super app registration key.
  * @param {Array} argv Overriding command line arguments
@@ -14,7 +16,13 @@ const {
  * @param {Address} options.from Address to deploy contracts from
  * @param {boolean} options.protocolReleaseVersion Specify the protocol release version to be used
  *
- * Usage: npx truffle exec scripts/create-new-app-registration-key.js : {DEPLOYER} {REGISTRATION_KEY}
+ * Note: the key itself doesn't have much meaning, it could be "stolen" from a broadcast tx anyway.
+ * But since it's bound to a deployer address, that doesn't really matter.
+ *
+ * Usage: npx truffle exec scripts/create-new-app-registration-key.js : {DEPLOYER} {REGISTRATION_KEY} [EXPIRATION_TS]
+ *        EXPIRATION_TS is a Unix timestamp in seconds for when the key should expire.
+ *        If not set, we default to 90 days in the future.
+ *        Hint: you may use https://www.unixtimestamp.com/ to calculate a timestamp
  */
 module.exports = eval(`(${S.toString()})({
     doNotPrintColonArgs: true
@@ -22,9 +30,20 @@ module.exports = eval(`(${S.toString()})({
     console.log("======== Creating new app registration key ========");
     let {protocolReleaseVersion} = options;
 
-    if (args.length !== 2) {
+    if (args.length > 3 || args.length < 2) {
         throw new Error("Wrong number of arguments");
     }
+
+    let expirationTs = Math.floor(Date.now() / 1000) + 3600 * 24 * 90; // 90 days from now
+    if (args.length === 3) {
+        const expTsStr = args.pop();
+        const parsedExpTs = parseInt(expTsStr);
+        if (parsedExpTs.toString() !== expTsStr) {
+            throw new Error("EXPIRATON_TS not an integer");
+        }
+        expirationTs = parsedExpTs;
+        console.log("Expiration timestamp", expirationTs);
+    }
     const registrationkey = args.pop();
     const deployer = args.pop();
     console.log("Deployer", deployer);
@@ -54,8 +73,12 @@ module.exports = eval(`(${S.toString()})({
         )
     );
     console.log("App key", appKey);
+    console.log("Expiration date", new Date(expirationTs * 1000)); // print human readable
 
+    // Note that we are NOT using gov.whiteListNewApp here, because it doesn't support setting
+    // an expiration date and will eventually be deprecated.
+    // Instead we use the lower level setConfig directly.
     await sendGovernanceAction(sf, (gov) =>
-        gov.whiteListNewApp(sf.host.address, appKey)
+        gov.setConfig(sf.host.address, ZERO_ADDRESS, appKey, expirationTs)
     );
 });