Merge pull request #246 from matiu/feat/reject-backoff-time

add a reject / creation backoff time

lib/server.js

@@ -49,6 +49,22 @@ function WalletService() {
   this.notifyTicker = 0;
 };
 
+
+// Time after which a Tx proposal can be erased by any copayer. in seconds
+WalletService.deleteLockTime = 24 * 3600;
+
+// Allowed consecutive txp rejections before backoff is applied.
+WalletService.backoffOffset = 3;
+
+// Time a copayer need to wait to create a new TX after her tx previous proposal we rejected. (incremental). in Minutes.
+WalletService.backoffTimeMinutes = 2;
+
+// Fund scanning parameters
+WalletService.scanConfig = {
+  SCAN_WINDOW: 20,
+  DERIVATION_DELAY: 10, // in milliseconds
+};
+
 /**
  * Initializes global settings for all instances.
  * @param {Object} opts
@@ -731,6 +747,37 @@ WalletService.prototype._selectTxInputs = function(txp, cb) {
   });
 };
 
+
+WalletService.prototype._canCreateTx = function(copayerId, cb) {
+  var self = this;
+  self.storage.fetchLastTxs(self.walletId, copayerId, 5 + WalletService.backoffOffset, function(err, txs) {
+    if (err) return cb(err);
+
+    if (!txs.length)
+      return cb(null, true);
+
+    var lastRejections = _.takeWhile(txs, {
+      status: 'rejected'
+    });
+
+    var exceededRejections = lastRejections.length - WalletService.backoffOffset;
+    if (exceededRejections <= 0)
+      return cb(null, true);
+
+
+    var lastTxTs = txs[0].createdOn;
+    var now = Math.floor(Date.now() / 1000);
+    var timeSinceLastRejection = now - lastTxTs;
+    var backoffTime = 60 * Math.pow(WalletService.backoffTimeMinutes, exceededRejections);
+
+    if (timeSinceLastRejection <= backoffTime)
+      log.debug('Not allowing to create TX: timeSinceLastRejection/backoffTime', timeSinceLastRejection, backoffTime);
+
+    return cb(null, timeSinceLastRejection > backoffTime);
+  });
+};
+
+
 /**
  * Creates a new transaction proposal.
  * @param {Object} opts
@@ -750,7 +797,13 @@ WalletService.prototype.createTx = function(opts, cb) {
   self._runLocked(cb, function(cb) {
     self.getWallet({}, function(err, wallet) {
       if (err) return cb(err);
-      if (!wallet.isComplete()) return cb(new ClientError('Wallet is not complete'));
+      if (!wallet.isComplete())
+        return cb(new ClientError('Wallet is not complete'));
+
+      self._canCreateTx(self.copayerId, function(err, canCreate) {
+        if (err) return cb(err);
+        if (!canCreate)
+          return cb(new ClientError('NOTALLOWEDTOCREATETX', 'Cannot create TX proposal during backoff time'));
 
         var copayer = wallet.getCopayer(self.copayerId);
         var hash = WalletUtils.getProposalHash(opts.toAddress, opts.amount, opts.message, opts.payProUrl);
@@ -809,6 +862,7 @@ WalletService.prototype.createTx = function(opts, cb) {
         });
       });
     });
+  });
 };
 
 /**
@@ -1339,13 +1393,6 @@ WalletService.prototype.getTxHistory = function(opts, cb) {
   });
 };
 
-// in seconds 
-WalletService.deleteLockTime = 24 * 3600;
-
-WalletService.scanConfig = {
-  SCAN_WINDOW: 20,
-  DERIVATION_DELAY: 10, // in milliseconds
-};
 
 /**
  * Scan the blockchain looking for addresses having some activity

lib/storage.js

@@ -171,6 +171,29 @@ Storage.prototype.fetchTx = function(walletId, txProposalId, cb) {
 };
 
 
+
+Storage.prototype.fetchLastTxs = function(walletId, creatorId, limit, cb) {
+  var self = this;
+
+  this.db.collection(collections.TXS).find({
+    walletId: walletId,
+    creatorId: creatorId,
+  }, {
+    limit: limit || 5
+  }).sort({
+    createdOn: -1
+  }).toArray(function(err, result) {
+    if (err) return cb(err);
+    if (!result) return cb();
+    var txs = _.map(result, function(tx) {
+      return Model.TxProposal.fromObj(tx);
+    });
+    return cb(null, txs);
+  });
+};
+
+
+
 Storage.prototype.fetchPendingTxs = function(walletId, cb) {
   var self = this;
 

test/integration/server.js

@@ -1674,6 +1674,169 @@ describe('Wallet service', function() {
     });
   });
 
+  describe('#createTx backoff time', function() {
+    var server, wallet;
+
+    beforeEach(function(done) {
+      helpers.createAndJoinWallet(2, 2, function(s, w) {
+        server = s;
+        wallet = w;
+        done();
+      });
+    });
+
+    it('should allow to create inmediatly after a 3 rejections', function(done) {
+      async.series([
+
+        function(next) {
+          async.each([0, 1, 2], function(i, a_next) {
+            helpers.stubUtxos(server, wallet, _.range(1, 9), function() {
+              var txOpts = helpers.createProposalOpts('18PzpUFkFZE8zKWUPvfykkTxmB9oMR8qP7', 10, null, TestData.copayers[0].privKey_1H_0);
+              server.createTx(txOpts, function(err, tx) {
+                should.not.exist(err);
+                server.rejectTx({
+                  txProposalId: tx.id,
+                  reason: 'some reason',
+                }, function(err) {
+                  should.not.exist(err);
+                  a_next();
+                });
+              });
+            });
+          }, next);
+        },
+        function(next) {
+          helpers.stubUtxos(server, wallet, _.range(1, 9), function() {
+            var txOpts = helpers.createProposalOpts('18PzpUFkFZE8zKWUPvfykkTxmB9oMR8qP7', 10, null, TestData.copayers[0].privKey_1H_0);
+            server.createTx(txOpts, function(err, tx) {
+              should.not.exist(err);
+              next();
+            });
+          });
+        }
+      ], done);
+    });
+
+    it('should NOT allow to create inmediatly after a 4 rejections', function(done) {
+      async.series([
+
+        function(next) {
+          async.each([0, 1, 2, 3], function(i, a_next) {
+            helpers.stubUtxos(server, wallet, _.range(1, 9), function() {
+              var txOpts = helpers.createProposalOpts('18PzpUFkFZE8zKWUPvfykkTxmB9oMR8qP7', 10, null, TestData.copayers[0].privKey_1H_0);
+              server.createTx(txOpts, function(err, tx) {
+                should.not.exist(err);
+                server.rejectTx({
+                  txProposalId: tx.id,
+                  reason: 'some reason',
+                }, function(err) {
+                  should.not.exist(err);
+                  a_next();
+                });
+              });
+            });
+          }, next);
+        },
+        function(next) {
+          helpers.stubUtxos(server, wallet, _.range(1, 9), function() {
+            var txOpts = helpers.createProposalOpts('18PzpUFkFZE8zKWUPvfykkTxmB9oMR8qP7', 10, null, TestData.copayers[0].privKey_1H_0);
+            server.createTx(txOpts, function(err, tx) {
+              err.code.should.equal('NOTALLOWEDTOCREATETX');
+              next();
+            });
+          });
+        }
+      ], done);
+    });
+
+    it('should  allow to create inmediatly after a 4 rejections after backofftime', function(done) {
+      async.series([
+
+        function(next) {
+          async.each([0, 1, 2, 3], function(i, a_next) {
+            helpers.stubUtxos(server, wallet, _.range(1, 9), function() {
+              var txOpts = helpers.createProposalOpts('18PzpUFkFZE8zKWUPvfykkTxmB9oMR8qP7', 10, null, TestData.copayers[0].privKey_1H_0);
+              server.createTx(txOpts, function(err, tx) {
+                should.not.exist(err);
+                server.rejectTx({
+                  txProposalId: tx.id,
+                  reason: 'some reason',
+                }, function(err) {
+                  should.not.exist(err);
+                  a_next();
+                });
+              });
+            });
+          }, next);
+        },
+        function(next) {
+          helpers.stubUtxos(server, wallet, _.range(1, 9), function() {
+            var txOpts = helpers.createProposalOpts('18PzpUFkFZE8zKWUPvfykkTxmB9oMR8qP7', 10, null, TestData.copayers[0].privKey_1H_0);
+            server.createTx(txOpts, function(err, tx) {
+              err.code.should.equal('NOTALLOWEDTOCREATETX');
+              next();
+            });
+          });
+        },
+        function(next) {
+          helpers.stubUtxos(server, wallet, _.range(1, 9), function() {
+            var txOpts = helpers.createProposalOpts('18PzpUFkFZE8zKWUPvfykkTxmB9oMR8qP7', 10, null, TestData.copayers[0].privKey_1H_0);
+            var clock = sinon.useFakeTimers(Date.now() + WalletService.backoffTimeMinutes * 60 * 1000 + 2000);
+            server.createTx(txOpts, function(err, tx) {
+              clock.restore();
+              should.not.exist(err);
+              next();
+            });
+          });
+        },
+      ], done);
+    });
+
+
+    it('should NOT allow to create after a 5 rejections after backofftime', function(done) {
+      async.series([
+
+        function(next) {
+          async.each([0, 1, 2, 3, 4], function(i, a_next) {
+            helpers.stubUtxos(server, wallet, _.range(1, 9), function() {
+              var txOpts = helpers.createProposalOpts('18PzpUFkFZE8zKWUPvfykkTxmB9oMR8qP7', 10, null, TestData.copayers[0].privKey_1H_0);
+              server.createTx(txOpts, function(err, tx) {
+                should.not.exist(err);
+                server.rejectTx({
+                  txProposalId: tx.id,
+                  reason: 'some reason',
+                }, function(err) {
+                  should.not.exist(err);
+                  a_next();
+                });
+              });
+            });
+          }, next);
+        },
+        function(next) {
+          helpers.stubUtxos(server, wallet, _.range(1, 9), function() {
+            var txOpts = helpers.createProposalOpts('18PzpUFkFZE8zKWUPvfykkTxmB9oMR8qP7', 10, null, TestData.copayers[0].privKey_1H_0);
+            server.createTx(txOpts, function(err, tx) {
+              next();
+            });
+          });
+        },
+        function(next) {
+          helpers.stubUtxos(server, wallet, _.range(1, 9), function() {
+            var txOpts = helpers.createProposalOpts('18PzpUFkFZE8zKWUPvfykkTxmB9oMR8qP7', 10, null, TestData.copayers[0].privKey_1H_0);
+            var clock = sinon.useFakeTimers(Date.now() + WalletService.backoffTimeMinutes * 60 * 1000 + 2000);
+            server.createTx(txOpts, function(err, tx) {
+              clock.restore();
+              err.code.should.equal('NOTALLOWEDTOCREATETX');
+              next();
+            });
+          });
+        },
+      ], done);
+    });
+  });
+
+
   describe('#signTx', function() {
     var server, wallet, txid;
 
@@ -2294,6 +2457,7 @@ describe('Wallet service', function() {
               next();
             });
           }, function(err) {
+            clock.restore();
             return done(err);
           });
         });
@@ -2808,7 +2972,7 @@ describe('Wallet service', function() {
 
           server.getPendingTxs({}, function(err, txs) {
             should.not.exist(err);
-            txs[0].deleteLockTime.should.be.above(WalletService.deleteLockTime-10);
+            txs[0].deleteLockTime.should.be.above(WalletService.deleteLockTime - 10);
 
             var clock = sinon.useFakeTimers(Date.now() + 1 + 24 * 3600 * 1000);
             server.removePendingTx({
@@ -2833,7 +2997,7 @@ describe('Wallet service', function() {
         }, function(err) {
           should.not.exist(err);
 
-          var clock = sinon.useFakeTimers(Date.now() + 1 + 24 * 3600 * 1000);
+          var clock = sinon.useFakeTimers(Date.now() + 2000 + WalletService.deleteLockTime * 1000);
           server2.removePendingTx({
             txProposalId: txp.id
           }, function(err) {