Delayed transactions v1 #68

iulianpascalau · 2024-10-01T08:04:18Z

Question: do you think it will be better that, instead of using default values here, we should error as to prevent as much as we can bad values?
Valid also for aggregateThreshold

iulianpascalau · 2024-10-01T08:24:57Z

Do you think it will be better to work with block.timestamp instead of block.number, or, at least keep also the timestamp when the deposit was made just to simplify the logic of time computing when we decide we can execute a transaction?

iulianpascalau · 2024-10-01T08:30:41Z

useless else? :)

iulianpascalau · 2024-10-01T08:31:04Z

useless else?

iulianpascalau · 2024-10-01T08:37:27Z

I guess this will consume a lot of gas. And the user y will actually pay for executing the deposit operations for user x, and so on. Thinking of a way to improve this and do the computation only when trying to assemble the current batch (I do not have a good idea now)

This method also has the disadvantage that, if a transaction is placed in a bucket, it won't be executed until a new deposit will be made. Which, if it will happen in 3 days, that will be the moment when it will actually be placed in a batch.

-Original file line number
+Diff line change
@@ Expand Up / @@ -43,3 +43,13 @@ struct MvxTransaction { @@
         uint256 depositNonce;
         bytes callData;
     }
+    struct DelayedTransaction {
+        uint256 amount;
+        address tokenAddress;
+        address sender;
+        bytes32 recipientAddress;
+        uint256 blockAdded;
+        bool isLarge;
+        bytes callData;
+    }

-Original file line number
+Diff line change
@@ Expand Up / @@ -28,7 +28,7 @@ describe("Bridge", async function () { @@
         genericErc20 = await deployContract(adminWallet, "GenericERC20", ["TSC", "TSC", 6]);
         await genericErc20.mint(adminWallet.address, 1000);
         await genericErc20.approve(erc20Safe.address, 1000);
-        await erc20Safe.whitelistToken(genericErc20.address, 0, 100, false, true, 0, 0, 0);
+        await erc20Safe.whitelistToken(genericErc20.address, 0, 100, false, true, 0, 0, 0, 0, 0);
         await erc20Safe.unpause();
       }
@@ Expand Down @@

-Original file line number
+Diff line change
@@ Expand Up / @@ -29,9 +29,9 @@ describe("BridgeExecutor", function () { @@
       async function setupErc20Token() {
         genericErc20 = await deployContract(adminWallet, "GenericERC20", ["TSC", "TSC", 6]);
-        await genericErc20.mint(adminWallet.address, 1000);
-        await genericErc20.approve(erc20Safe.address, 1000);
-        await erc20Safe.whitelistToken(genericErc20.address, 0, 1000, false, true, 0, 0, 0);
+        await genericErc20.mint(adminWallet.address, 2000);
+        await genericErc20.approve(erc20Safe.address, 2000);
+        await erc20Safe.whitelistToken(genericErc20.address, 0, 10000, false, true, 1000, 0, 0, 0, 0);
         await erc20Safe.unpause();
       }
@@ Expand Down @@

-Original file line number
+Diff line change
@@ Expand Up @@
       async function setupErc20Token() {
         mintBurnErc20 = await deployUpgradableContract(adminWallet, "MintBurnERC20", ["Test Token", "TST", 6]);
-        await erc20Safe.whitelistToken(mintBurnErc20.address, 0, 100, true, false, 0, 0, 0);
+        await erc20Safe.whitelistToken(mintBurnErc20.address, 0, 100, true, false, 0, 0, 0, 0, 0);
         await erc20Safe.unpause();
       }
@@ Expand Down @@

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Delayed transactions v1 #68

Uh oh!

Diff view

Diff view

There are no files selected for viewing

iulianpascalau Oct 1, 2024

Uh oh!

iulianpascalau Oct 1, 2024

Uh oh!

iulianpascalau Oct 1, 2024

Uh oh!

iulianpascalau Oct 1, 2024

Uh oh!

iulianpascalau Oct 1, 2024

Uh oh!

Uh oh!

-Original file line number
+Diff line change
@@ Expand Up / @@ -38,10 +38,16 @@ contract ERC20Safe is Initializable, BridgeRole, Pausable { @@
         uint16 private constant maxBatchSize = 100;
         uint8 public batchBlockLimit;
         uint8 public batchSettleLimit;
+        uint256 public numBuckets;
+        uint256 public blocksInBucket;
+        uint256 public defaultSingleTransactionThreshold;
+        uint256 public defaultAggregateValueThreshold;
         // Reserved storage slots for future upgrades
         uint256[10] private __gap;
+        mapping(uint256 => uint256) public bucketLastUpdatedNonce;
+        mapping(uint256 => mapping(address => uint256)) public aggregatedValue;
         mapping(uint256 => Batch) public batches;
         mapping(address => bool) public whitelistedTokens;
         mapping(address => bool) public mintBurnTokens;
@@ Expand All / @@ -52,9 +58,29 @@ contract ERC20Safe is Initializable, BridgeRole, Pausable { @@
         mapping(address => uint256) public mintBalances;
         mapping(address => uint256) public burnBalances;
         mapping(uint256 => Deposit[]) public batchDeposits;
+        mapping(address => uint256) public singleTransactionThreshold;
+        mapping(address => uint256) public aggregateValueThreshold;
         event ERC20Deposit(uint112 batchId, uint112 depositNonce);
         event ERC20SCDeposit(uint112 indexed batchId, uint112 depositNonce, bytes callData);
+        event TransactionDelayed(
+            address indexed sender,
+            address indexed tokenAddress,
+            uint256 amount,
+            bytes32 recipientAddress,
+            bool isLarge
+        );
+        //optional
+        event DelayedTransactionProcessed(
+            address indexed sender,
+            address indexed tokenAddress,
+            uint256 amount,
+            bytes32 recipientAddress,
+            bool isLarge
+        );
+        DelayedTransaction[] public delayedTransactions;
         function initialize() public initializer {
             __BridgeRole_init();
@@ Expand All / @@ -66,6 +92,10 @@ contract ERC20Safe is Initializable, BridgeRole, Pausable { @@
             batchSize = 10;
             batchBlockLimit = 40;
             batchSettleLimit = 40;
+            numBuckets = 24;
+            blocksInBucket = 300; // 300 blocks = 3600 seconds/12 seconds per block
+            defaultSingleTransactionThreshold = 1000; //to be set correctly
+            defaultAggregateValueThreshold = 10000; //to be set correctly
         }
         /**
@@ Expand All / @@ -83,7 +113,9 @@ contract ERC20Safe is Initializable, BridgeRole, Pausable { @@
             bool native,
             uint256 totalBalance,
             uint256 mintBalance,
-            uint256 burnBalance
+            uint256 burnBalance,
+            uint256 singleTxThreshold,
+            uint256 aggregateThreshold
         ) external onlyAdmin {
             if (!mintBurn) {
                 require(native, "Only native tokens can be stored!");
@@ Expand All @@
                 require(burnBalance == 0, "Stored tokens must have 0 burn balance!");
                 initSupply(token, totalBalance);
             }
+            if (singleTxThreshold == 0) {
+                singleTransactionThreshold[token] = defaultSingleTransactionThreshold;
+            } else {
+                singleTransactionThreshold[token] = singleTxThreshold;
+            }
+            if (aggregateThreshold == 0) {
+                aggregateValueThreshold[token] = defaultAggregateValueThreshold;
+            } else {
+                aggregateValueThreshold[token] = aggregateThreshold;
+            }
         }
         /**
@@ Expand Down Expand Up / @@ -186,8 +230,7 @@ contract ERC20Safe is Initializable, BridgeRole, Pausable { @@
         function deposit(address tokenAddress, uint256 amount, bytes32 recipientAddress) public whenNotPaused {
             uint112 batchNonce;
             uint112 depositNonce;
-            (batchNonce, depositNonce) = _deposit_common(tokenAddress, amount, recipientAddress);
-            emit ERC20Deposit(depositNonce, batchNonce);
+            (batchNonce, depositNonce) = _deposit_common(tokenAddress, amount, recipientAddress, "");
         }
         /*
@@ Expand All @@
          *        0x + endpoint_name_length (4 bytes) + endpoint_name + gas_limit (8 bytes) +
          *        00 (ArgumentsPresentProtocolMarker)
          */
-        function depositWithSCExecution(address tokenAddress, uint256 amount, bytes32 recipientAddress, bytes calldata callData) public whenNotPaused {
+        function depositWithSCExecution(
+            address tokenAddress,
+            uint256 amount,
+            bytes32 recipientAddress,
+            bytes memory callData
+        ) public whenNotPaused {
             uint112 batchNonce;
             uint112 depositNonce;
-            (batchNonce, depositNonce) = _deposit_common(tokenAddress, amount, recipientAddress);
-            emit ERC20SCDeposit(batchNonce, depositNonce, callData);
+            (batchNonce, depositNonce) = _deposit_common(tokenAddress, amount, recipientAddress, callData);
         }
-        function _deposit_common(address tokenAddress, uint256 amount, bytes32 recipientAddress) internal returns (uint112 batchNonce, uint112 depositNonce) {
+        function _deposit_common(
+            address tokenAddress,
+            uint256 amount,
+            bytes32 recipientAddress,
+            bytes memory callData
+        ) internal returns (uint112 batchNonce, uint112 depositNonce) {
             require(whitelistedTokens[tokenAddress], "Unsupported token");
             require(amount >= tokenMinLimits[tokenAddress], "Tried to deposit an amount below the minimum specified limit");
             require(amount <= tokenMaxLimits[tokenAddress], "Tried to deposit an amount above the maximum specified limit");
+            _processDelayedTransactions(tokenAddress);
+            uint256 currentBlock = block.number;
+            uint256 bucketId = (currentBlock / blocksInBucket) % numBuckets;
+            _resetBucketIfNeeded(bucketId, tokenAddress, currentBlock);
+            if (amount >= singleTransactionThreshold[tokenAddress]) {
+                _addDelayedTransaction(tokenAddress, amount, recipientAddress, true, callData);
+                emit TransactionDelayed(msg.sender, tokenAddress, amount, recipientAddress, true);
+                return (0, 0);
+            } else {
+                uint256 totalAggregatedValue = _getTotalAggregatedValue(tokenAddress, currentBlock);
+                if (totalAggregatedValue + amount <= aggregateValueThreshold[tokenAddress]) {
+                    aggregatedValue[bucketId][tokenAddress] += amount;
+                    (batchNonce, depositNonce) = _processDeposit(tokenAddress, amount, recipientAddress, callData);
+                    return (batchNonce, depositNonce);
+                } else {
+                    _addDelayedTransaction(tokenAddress, amount, recipientAddress, false, callData);
+                    emit TransactionDelayed(msg.sender, tokenAddress, amount, recipientAddress, false);
+                    return (0, 0);
+                }
+            }
+        }
+        function _addDelayedTransaction(
+            address tokenAddress,
+            uint256 amount,
+            bytes32 recipientAddress,
+            bool isLarge,
+            bytes memory callData
+        ) internal {
+            DelayedTransaction memory dt = DelayedTransaction({
+                amount: amount,
+                tokenAddress: tokenAddress,
+                sender: msg.sender,
+                recipientAddress: recipientAddress,
+                blockAdded: block.number,
+                isLarge: isLarge,
+                callData: callData
+            });
+            delayedTransactions.push(dt);
+        }
+        function _processDelayedTransactions(address tokenAddress) internal {
+            uint256 i = 0;
+            while (i < delayedTransactions.length) {
+                DelayedTransaction storage dt = delayedTransactions[i];
+                if (dt.tokenAddress != tokenAddress) {
+                    i++;
+                    continue;
+                }
+                if (_canProcessDelayedTransaction(dt)) {
+                    _processDeposit(dt.tokenAddress, dt.amount, dt.recipientAddress, dt.callData);
+                    delayedTransactions[i] = delayedTransactions[delayedTransactions.length - 1];
+                    delayedTransactions.pop();
+                    emit DelayedTransactionProcessed(
+                        dt.sender,
+                        dt.tokenAddress,
+                        dt.amount,
+                        dt.recipientAddress,
+                        dt.isLarge
+                    );
+                } else {
+                    i++;
+                }
+            }
+        }
+        function _canProcessDelayedTransaction(DelayedTransaction storage dt) internal returns (bool) {
+            uint256 currentBlock = block.number;
+            uint256 averageBlockTime = 12;
+            if (dt.isLarge) {
+                uint256 blocksIn24Hours = (24 * 60 * 60) / averageBlockTime;
+                return currentBlock >= dt.blockAdded + blocksIn24Hours;
+            } else {
+                uint256 bucketId = (currentBlock / blocksInBucket) % numBuckets;
+                _resetBucketIfNeeded(bucketId, dt.tokenAddress, currentBlock);
+                uint256 totalAggregatedValue = _getTotalAggregatedValue(dt.tokenAddress, currentBlock);
+                uint256 threshold = aggregateValueThreshold[dt.tokenAddress];
+                if (totalAggregatedValue + dt.amount <= threshold) {
+                    aggregatedValue[bucketId][dt.tokenAddress] += dt.amount;
+                    return true;
+                } else if (currentBlock >= dt.blockAdded + ((24 * 60 * 60) / averageBlockTime)) {
+                    return true;
+                } else {
+                    return false;
+                }
+            }
+        }
+        function _processDeposit(
+            address tokenAddress,
+            uint256 amount,
+            bytes32 recipientAddress,
+            bytes memory callData
+        ) internal returns (uint112 batchNonce, uint112 depositNonce) {
             uint64 currentBlockNumber = uint64(block.number);
             Batch storage batch;
@@ Expand All / @@ -230,7 +386,7 @@ contract ERC20Safe is Initializable, BridgeRole, Pausable { @@
                 batch = batches[batchesCount - 1];
             }
-            uint112 depositNonce = depositsCount + 1;
+            depositNonce = depositsCount + 1;
             batchDeposits[batchesCount - 1].push(
                 Deposit(depositNonce, tokenAddress, amount, msg.sender, recipientAddress, DepositStatus.Pending)
             );
@@ Expand All @@
                 totalBalances[tokenAddress] += amount;
                 erc20.safeTransferFrom(msg.sender, address(this), amount);
             }
-            return (batch.nonce, depositNonce);
+            batchNonce = batch.nonce;
+            if (callData.length > 0) {
+                emit ERC20SCDeposit(batchNonce, depositNonce, callData);
+            } else {
+                emit ERC20Deposit(batchNonce, depositNonce);
+            }
+            return (batchNonce, depositNonce);
+        }
+        function _getTotalAggregatedValue(
+            address tokenAddress,
+            uint256 currentBlock
+        ) internal returns (uint256 totalAggregatedValue) {
+            totalAggregatedValue = 0;
+            for (uint256 i = 0; i < numBuckets; i++) {
+                _resetBucketIfNeeded(i, tokenAddress, currentBlock);
+                totalAggregatedValue += aggregatedValue[i][tokenAddress];
+            }
+        }
+        /**
+         @notice Updates the threshold for a particular token
+         @param token Address of the ERC20 token
+         @param amount New threshold for the aggregated value
+        */
+        function setThreshold(address token, uint256 amount) external onlyAdmin {
+            aggregateValueThreshold[token] = amount;
+        }
+        function getThreshold(address tokenAddress) public view returns (uint256) {
+            return aggregateValueThreshold[tokenAddress];
+        }
+        /**
+         @notice Updates the single transaction threshold for a particular token
+         @param token Address of the ERC20 token
+         @param amount New threshold for the aggregated value
+        */
+        function setSingleTxThreshold(address token, uint256 amount) external onlyAdmin {
+            singleTransactionThreshold[token] = amount;
+        }
+        function getSingleTxThreshold(address tokenAddress) public view returns (uint256) {
+            return singleTransactionThreshold[tokenAddress];
+        }
+        /**
+         @notice Process a delayed transaction immediately
+         @param index Index of the delayed transaction
+        */
+        function processDelayedTransactionImmediately(uint256 index) external onlyAdmin {
+            require(index < delayedTransactions.length, "Invalid index");
+            DelayedTransaction storage dt = delayedTransactions[index];
+            _processDeposit(dt.tokenAddress, dt.amount, dt.recipientAddress, dt.callData);
+            delayedTransactions[index] = delayedTransactions[delayedTransactions.length - 1];
+            delayedTransactions.pop();
+            emit DelayedTransactionProcessed(dt.sender, dt.tokenAddress, dt.amount, dt.recipientAddress, dt.isLarge);
         }
         /**
@@ Expand Down Expand Up @@
         function _isTokenMintBurn(address token) internal view returns (bool) {
             return mintBurnTokens[token];
         }
+        function _resetBucketIfNeeded(uint256 bucketId, address tokenAddress, uint256 currentBlock) internal {
+            if (currentBlock - bucketLastUpdatedNonce[bucketId] > blocksInBucket) {
+                aggregatedValue[bucketId][tokenAddress] = 0;
+                bucketLastUpdatedNonce[bucketId] = currentBlock;
+            }
+        }
     }

Delayed transactions v1 #68

Are you sure you want to change the base?

Uh oh!

Delayed transactions v1 #68

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

iulianpascalau Oct 1, 2024

Choose a reason for hiding this comment

Uh oh!

iulianpascalau Oct 1, 2024

Choose a reason for hiding this comment

Uh oh!

iulianpascalau Oct 1, 2024

Choose a reason for hiding this comment

Uh oh!

iulianpascalau Oct 1, 2024

Choose a reason for hiding this comment

Uh oh!

iulianpascalau Oct 1, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!