feat: adding dust bin to deployment script (#111)

Author: sakulstra

.changeset/sixty-clubs-serve.md

@@ -0,0 +1,5 @@
+---
+"@aave-dao/aave-v3-origin": patch
+---
+
+In order to separate "dust", that is initially deposited on asset listing, from the treasury income a new "dustBin" contract was introduced. It does not hold any functionality, besides being upgradable by the DAO.

src/contracts/misc/EmptyImplementation.sol

@@ -0,0 +1,8 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.0;
+
+/**
+ * @notice This contract is an intentionally empty implementation.
+ * It's to be used for proxies that should be initialized with zero functionality.
+ */
+contract EmptyImplementation {}

src/deployments/contracts/procedures/AaveV3TreasuryProcedure.sol

@@ -3,12 +3,15 @@ pragma solidity ^0.8.0;
 
 import {TransparentUpgradeableProxy} from 'openzeppelin-contracts/contracts/proxy/transparent/TransparentUpgradeableProxy.sol';
 import {Collector} from '../../../contracts/treasury/Collector.sol';
+import {EmptyImplementation} from '../../../contracts/misc/EmptyImplementation.sol';
 import '../../interfaces/IMarketReportTypes.sol';
 
 contract AaveV3TreasuryProcedure {
   struct TreasuryReport {
     address treasuryImplementation;
     address treasury;
+    address emptyImplementation;
+    address dustBin;
   }
 
   function _deployAaveV3Treasury(
@@ -29,6 +32,14 @@ contract AaveV3TreasuryProcedure {
           abi.encodeWithSelector(treasuryImplementation.initialize.selector, 100_000, poolAdmin)
         )
       );
+      treasuryReport.emptyImplementation = address(new EmptyImplementation{salt: salt}());
+      treasuryReport.dustBin = address(
+        new TransparentUpgradeableProxy{salt: salt}(
+          treasuryReport.emptyImplementation,
+          poolAdmin,
+          ''
+        )
+      );
     } else {
       Collector treasuryImplementation = new Collector();
       treasuryReport.treasuryImplementation = address(treasuryImplementation);
@@ -40,6 +51,10 @@ contract AaveV3TreasuryProcedure {
           abi.encodeWithSelector(treasuryImplementation.initialize.selector, 100_000, poolAdmin)
         )
       );
+      treasuryReport.emptyImplementation = address(new EmptyImplementation());
+      treasuryReport.dustBin = address(
+        new TransparentUpgradeableProxy(treasuryReport.emptyImplementation, poolAdmin, '')
+      );
     }
 
     return treasuryReport;

src/deployments/contracts/utilities/MetadataReporter.sol

@@ -38,11 +38,13 @@ contract MetadataReporter is IMetadataReporter {
     );
     vm.serializeAddress(jsonReport, 'aaveOracle', report.aaveOracle);
     vm.serializeAddress(jsonReport, 'treasury', report.treasury);
+    vm.serializeAddress(jsonReport, 'dustBin', report.dustBin);
     vm.serializeAddress(jsonReport, 'wrappedTokenGateway', report.wrappedTokenGateway);
     vm.serializeAddress(jsonReport, 'walletBalanceProvider', report.walletBalanceProvider);
     vm.serializeAddress(jsonReport, 'uiIncentiveDataProvider', report.uiIncentiveDataProvider);
     vm.serializeAddress(jsonReport, 'uiPoolDataProvider', report.uiPoolDataProvider);
     vm.serializeAddress(jsonReport, 'treasuryImplementation', report.treasuryImplementation);
+    vm.serializeAddress(jsonReport, 'emptyImplementation', report.emptyImplementation);
     vm.serializeAddress(jsonReport, 'l2Encoder', report.l2Encoder);
     vm.serializeAddress(jsonReport, 'aToken', report.aToken);
     vm.serializeAddress(jsonReport, 'variableDebtToken', report.variableDebtToken);

src/deployments/interfaces/IMarketReportTypes.sol

@@ -84,6 +84,8 @@ struct MarketReport {
   address staticATokenFactoryProxy;
   address staticATokenImplementation;
   address revenueSplitter;
+  address dustBin;
+  address emptyImplementation;
 }
 
 struct LibrariesReport {
@@ -173,6 +175,8 @@ struct PeripheryReport {
   address emissionManager;
   address rewardsControllerImplementation;
   address revenueSplitter;
+  address emptyImplementation;
+  address dustBin;
 }
 
 struct ParaswapReport {

src/deployments/projects/aave-v3-batched/AaveV3BatchOrchestration.sol

@@ -314,6 +314,8 @@ library AaveV3BatchOrchestration {
     report.paraSwapWithdrawSwapAdapter = paraswapReport.paraSwapWithdrawSwapAdapter;
     report.treasuryImplementation = peripheryReport.treasuryImplementation;
     report.treasury = peripheryReport.treasury;
+    report.dustBin = peripheryReport.dustBin;
+    report.emptyImplementation = peripheryReport.emptyImplementation;
     report.poolProxy = setupReport.poolProxy;
     report.poolConfiguratorProxy = setupReport.poolConfiguratorProxy;
     report.rewardsControllerProxy = setupReport.rewardsControllerProxy;

src/deployments/projects/aave-v3-batched/batches/AaveV3PeripheryBatch.sol

@@ -30,6 +30,9 @@ contract AaveV3PeripheryBatch is
 
       _report.treasury = treasuryReport.treasury;
       _report.treasuryImplementation = treasuryReport.treasuryImplementation;
+      // bin and treasury are shared per network, so skipping based on treasury not being zero is fine
+      _report.dustBin = treasuryReport.dustBin;
+      _report.emptyImplementation = treasuryReport.emptyImplementation;
     } else {
       _report.treasury = config.treasury;
     }