Merge pull request #1323 from JoinColony/feat/streaming-payments-duration

StreamingPayments starttime=0 behaviour change

Author: area

contracts/extensions/StreamingPayments.sol

@@ -116,7 +116,7 @@ contract StreamingPayments is ColonyExtensionMeta {
   /// @notice Returns the version of the extension
   /// @return _version The extension's version number
   function version() public pure override returns (uint256 _version) {
-    return 6;
+    return 7;
   }
 
   /// @notice Called when upgrading the extension
@@ -137,7 +137,8 @@ contract StreamingPayments is ColonyExtensionMeta {
   /// @param _adminChildSkillIndex The index linking the adminPermissionDomainId to the domainId
   /// @param _domainId The domain out of which the streaming payment will be paid
   /// @param _startTime The time at which the payment begins paying out
-  /// @param _endTime The time at which the payment ends paying out
+  /// @param _endTimeOrDuration The time at which the payment ends paying out. If _startTime is 0, then this is
+  /// the duration of the payment from the current time
   /// @param _interval The period of time over which _amounts are paid out
   /// @param _recipient The recipient of the streaming payment
   /// @param _token The token to be paid out
@@ -149,7 +150,7 @@ contract StreamingPayments is ColonyExtensionMeta {
     uint256 _adminChildSkillIndex,
     uint256 _domainId,
     uint256 _startTime,
-    uint256 _endTime,
+    uint256 _endTimeOrDuration,
     uint256 _interval,
     address payable _recipient,
     address _token,
@@ -160,23 +161,37 @@ contract StreamingPayments is ColonyExtensionMeta {
     validateFundingPermission(_fundingPermissionDomainId, _fundingChildSkillIndex, _domainId)
     validateAdministrationPermission(_adminPermissionDomainId, _adminChildSkillIndex, _domainId)
   {
-    uint256 startTime = (_startTime == 0) ? block.timestamp : _startTime;
-
-    require(startTime <= _endTime, "streaming-payments-bad-end-time");
-    require(_interval > 0, "streaming-payments-bad-interval");
-
     numStreamingPayments++;
     streamingPayments[numStreamingPayments] = StreamingPayment(
       _recipient,
       _domainId,
-      startTime,
-      _endTime,
+      _startTime,
+      _endTimeOrDuration,
       _interval,
       _token,
       _amount,
       0
     );
 
+    StreamingPayment storage streamingPayment = streamingPayments[numStreamingPayments];
+
+    require(
+      streamingPayment.startTime <= streamingPayment.endTime,
+      "streaming-payments-bad-end-time"
+    );
+    require(streamingPayment.interval > 0, "streaming-payments-bad-interval");
+
+    if (_startTime == 0) {
+      // If _startTime was 0, then we set the startTime to now
+      streamingPayments[numStreamingPayments].startTime = block.timestamp;
+      // If _startTime was 0, then we interpret _endTime as a duration from now, not an absolute time, if possible
+      if (streamingPayments[numStreamingPayments].endTime < 2 ** 256 - 1 - block.timestamp) {
+        streamingPayments[numStreamingPayments].endTime += block.timestamp;
+      } else {
+        streamingPayments[numStreamingPayments].endTime = 2 ** 256 - 1;
+      }
+    }
+
     if (getAmountClaimableLifetime(numStreamingPayments) > 0) {
       nUnresolvedStreamingPayments += 1;
     }

docs/interfaces/extensions/streamingpayments.md

@@ -65,7 +65,7 @@ Claim a streaming payment
 |_id|uint256|The id of the streaming payment
 
 
-### ▸ `create(uint256 _fundingPermissionDomainId, uint256 _fundingChildSkillIndex, uint256 _adminPermissionDomainId, uint256 _adminChildSkillIndex, uint256 _domainId, uint256 _startTime, uint256 _endTime, uint256 _interval, address _recipient, address _token, uint256 _amount)`
+### ▸ `create(uint256 _fundingPermissionDomainId, uint256 _fundingChildSkillIndex, uint256 _adminPermissionDomainId, uint256 _adminChildSkillIndex, uint256 _domainId, uint256 _startTime, uint256 _endTimeOrDuration, uint256 _interval, address _recipient, address _token, uint256 _amount)`
 
 Creates a new streaming payment
 
@@ -80,7 +80,7 @@ Creates a new streaming payment
 |_adminChildSkillIndex|uint256|The index linking the adminPermissionDomainId to the domainId
 |_domainId|uint256|The domain out of which the streaming payment will be paid
 |_startTime|uint256|The time at which the payment begins paying out
-|_endTime|uint256|The time at which the payment ends paying out
+|_endTimeOrDuration|uint256|The time at which the payment ends paying out. If _startTime is 0, then this is the duration of the payment from the current time
 |_interval|uint256|The period of time over which _amounts are paid out
 |_recipient|address|The recipient of the streaming payment
 |_token|address|The token to be paid out

test/extensions/streaming-payments.js

@@ -118,6 +118,16 @@ contract("Streaming Payments", (accounts) => {
       expect(streamingPaymentCount).to.eq.BN(1);
     });
 
+    it("when creating a streaming payment, if start time is 0, endTime is treated as a duration", async () => {
+      const tx = await streamingPayments.create(1, UINT256_MAX, 1, UINT256_MAX, 1, 0, SECONDS_PER_DAY, SECONDS_PER_DAY, USER1, token.address, WAD);
+      const streamingPaymentId = await streamingPayments.getNumStreamingPayments();
+      const streamingPayment = await streamingPayments.getStreamingPayment(streamingPaymentId);
+
+      const blockTime = await getBlockTime(tx.receipt.blockNumber);
+      expect(streamingPayment.startTime).to.eq.BN(blockTime);
+      expect(streamingPayment.endTime).to.eq.BN(blockTime + SECONDS_PER_DAY);
+    });
+
     it("cannot create a streaming payment without relevant permissions", async () => {
       await checkErrorRevert(
         streamingPayments.create(1, UINT256_MAX, 1, UINT256_MAX, 1, 0, UINT256_MAX, SECONDS_PER_DAY, USER1, token.address, WAD, { from: USER1 }),
@@ -218,18 +228,19 @@ contract("Streaming Payments", (accounts) => {
     });
 
     it("can update the end time", async () => {
-      const blockTime = await getBlockTime();
+      let tx = await streamingPayments.create(1, UINT256_MAX, 1, UINT256_MAX, 1, 0, SECONDS_PER_DAY, SECONDS_PER_DAY, USER1, token.address, WAD);
+
+      const blockTime = await getBlockTime(tx.receipt.blockNumber);
       const endTime = blockTime + SECONDS_PER_DAY;
       const newEndTime = endTime + SECONDS_PER_DAY;
 
-      await streamingPayments.create(1, UINT256_MAX, 1, UINT256_MAX, 1, 0, endTime, SECONDS_PER_DAY, USER1, token.address, WAD);
       const streamingPaymentId = await streamingPayments.getNumStreamingPayments();
 
       let streamingPayment;
       streamingPayment = await streamingPayments.getStreamingPayment(streamingPaymentId);
       expect(streamingPayment.endTime).to.eq.BN(endTime);
 
-      const tx = await streamingPayments.setEndTime(1, UINT256_MAX, streamingPaymentId, newEndTime);
+      tx = await streamingPayments.setEndTime(1, UINT256_MAX, streamingPaymentId, newEndTime);
       streamingPayment = await streamingPayments.getStreamingPayment(streamingPaymentId);
       expect(streamingPayment.endTime).to.eq.BN(newEndTime);