refactor: remove the allowCrosschainSuckerExtension flag, modify th…

…e `metadata.metadata` packing to use the least significant bits instead of the most significant bits
Bananapus · Oct 16, 2024 · c365bae · c365bae
1 parent 88c3060
commit c365bae
Show file tree

Hide file tree

Showing 10 changed files with 38 additions and 30 deletions.
diff --git a/lib/forge-std b/lib/forge-std
diff --git a/lib/sphinx b/lib/sphinx
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@bananapus/721-hook",
-  "version": "0.0.24",
+  "version": "0.0.25",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -18,12 +18,12 @@
   },
   "dependencies": {
     "@bananapus/address-registry": "^0.0.7",
-    "@bananapus/core": "^0.0.32",
+    "@bananapus/core": "^0.0.35",
     "@bananapus/ownable": "^0.0.7",
-    "@bananapus/permission-ids": "^0.0.12",
+    "@bananapus/permission-ids": "^0.0.15",
     "@openzeppelin/contracts": "^5.0.2",
     "@prb/math": "^4.0.3",
-    "solady": "^0.0.248"
+    "solady": "^0.0.256"
   },
   "devDependencies": {
     "@sphinx-labs/plugins": "^0.33.0"

diff --git a/src/JB721TiersHookProjectDeployer.sol b/src/JB721TiersHookProjectDeployer.sol
@@ -240,7 +240,6 @@ contract JB721TiersHookProjectDeployer is JBPermissioned, IJB721TiersHookProject
                     allowSetController: payDataRulesetConfig.metadata.allowSetController,
                     allowAddAccountingContext: payDataRulesetConfig.metadata.allowAddAccountingContext,
                     allowAddPriceFeed: payDataRulesetConfig.metadata.allowAddPriceFeed,
-                    allowCrosschainSuckerExtension: payDataRulesetConfig.metadata.allowCrosschainSuckerExtension,
                     ownerMustSendPayouts: payDataRulesetConfig.metadata.ownerMustSendPayouts,
                     holdFees: payDataRulesetConfig.metadata.holdFees,
                     useTotalSurplusForRedemptions: payDataRulesetConfig.metadata.useTotalSurplusForRedemptions,
@@ -311,7 +310,6 @@ contract JB721TiersHookProjectDeployer is JBPermissioned, IJB721TiersHookProject
                     allowSetController: payDataRulesetConfig.metadata.allowSetController,
                     allowAddAccountingContext: payDataRulesetConfig.metadata.allowAddAccountingContext,
                     allowAddPriceFeed: payDataRulesetConfig.metadata.allowAddPriceFeed,
-                    allowCrosschainSuckerExtension: payDataRulesetConfig.metadata.allowCrosschainSuckerExtension,
                     ownerMustSendPayouts: payDataRulesetConfig.metadata.ownerMustSendPayouts,
                     holdFees: payDataRulesetConfig.metadata.holdFees,
                     useTotalSurplusForRedemptions: payDataRulesetConfig.metadata.useTotalSurplusForRedemptions,
@@ -380,7 +378,6 @@ contract JB721TiersHookProjectDeployer is JBPermissioned, IJB721TiersHookProject
                     allowSetController: payDataRulesetConfig.metadata.allowSetController,
                     allowAddAccountingContext: payDataRulesetConfig.metadata.allowAddAccountingContext,
                     allowAddPriceFeed: payDataRulesetConfig.metadata.allowAddPriceFeed,
-                    allowCrosschainSuckerExtension: payDataRulesetConfig.metadata.allowCrosschainSuckerExtension,
                     ownerMustSendPayouts: payDataRulesetConfig.metadata.ownerMustSendPayouts,
                     holdFees: payDataRulesetConfig.metadata.holdFees,
                     useTotalSurplusForRedemptions: payDataRulesetConfig.metadata.useTotalSurplusForRedemptions,

diff --git a/src/structs/JBPayDataHookRulesetMetadata.sol b/src/structs/JBPayDataHookRulesetMetadata.sol
@@ -19,8 +19,6 @@ pragma solidity ^0.8.0;
 /// terminals to use.
 /// @custom:member allowAddPriceFeed A flag indicating if a project can add new price feeds to calculate exchange rates
 /// between its tokens.
-/// @custom:member allowCrosschainSuckerExtension A flag indicating if the crosschain sucker extension should be
-/// allowed during this ruleset.
 /// @custom:member holdFees A flag indicating if fees should be held during this ruleset.
 /// @custom:member useTotalSurplusForRedemptions A flag indicating if redemptions should use the project's balance held
 /// in all terminals instead of the project's local terminal balance from which the redemption is being fulfilled.
@@ -39,7 +37,6 @@ struct JBPayDataHookRulesetMetadata {
     bool allowSetController;
     bool allowAddAccountingContext;
     bool allowAddPriceFeed;
-    bool allowCrosschainSuckerExtension;
     bool ownerMustSendPayouts;
     bool holdFees;
     bool useTotalSurplusForRedemptions;

diff --git a/test/E2E/Pay_Mint_Redeem_E2E.t.sol b/test/E2E/Pay_Mint_Redeem_E2E.t.sol
@@ -778,7 +778,6 @@ contract Test_TiersHook_E2E is TestBaseWorkflow {
             ownerMustSendPayouts: false,
             allowAddAccountingContext: false,
             allowAddPriceFeed: false,
-            allowCrosschainSuckerExtension: false,
             holdFees: false,
             useTotalSurplusForRedemptions: false,
             useDataHookForRedeem: true,
@@ -872,7 +871,6 @@ contract Test_TiersHook_E2E is TestBaseWorkflow {
             ownerMustSendPayouts: false,
             allowAddAccountingContext: false,
             allowAddPriceFeed: false,
-            allowCrosschainSuckerExtension: false,
             holdFees: false,
             useTotalSurplusForRedemptions: false,
             useDataHookForRedeem: true,

diff --git a/test/unit/mintFor_mintReservesFor_Unit.t.sol b/test/unit/mintFor_mintReservesFor_Unit.t.sol
@@ -153,14 +153,13 @@ contract Test_mintFor_mintReservesFor_Unit is UnitTestSetup {
                             allowSetController: false,
                             allowAddAccountingContext: false,
                             allowAddPriceFeed: false,
-                            allowCrosschainSuckerExtension: false,
                             ownerMustSendPayouts: false,
                             holdFees: false,
                             useTotalSurplusForRedemptions: false,
                             useDataHookForPay: true,
                             useDataHookForRedeem: true,
                             dataHook: address(0),
-                            metadata: 16 // the first 3 bits are discarded, so this is 0100.
+                            metadata: 2
                         })
                     )
                 })

diff --git a/test/unit/pay_Unit.t.sol b/test/unit/pay_Unit.t.sol
@@ -1299,14 +1299,13 @@ contract Test_afterPayRecorded_Unit is UnitTestSetup {
                             allowSetController: false,
                             allowAddAccountingContext: false,
                             allowAddPriceFeed: false,
-                            allowCrosschainSuckerExtension: false,
                             ownerMustSendPayouts: false,
                             holdFees: false,
                             useTotalSurplusForRedemptions: false,
                             useDataHookForPay: true,
                             useDataHookForRedeem: true,
                             dataHook: address(hook),
-                            metadata: 8 // the first 3 bits are discarded, so this is 0001.
+                            metadata: 1
                         })
                     )
                 })

diff --git a/test/utils/UnitTestSetup.sol b/test/utils/UnitTestSetup.sol
@@ -197,7 +197,6 @@ contract UnitTestSetup is Test {
                             allowSetController: false,
                             allowAddAccountingContext: false,
                             allowAddPriceFeed: false,
-                            allowCrosschainSuckerExtension: false,
                             ownerMustSendPayouts: false,
                             holdFees: false,
                             useTotalSurplusForRedemptions: false,
@@ -723,7 +722,6 @@ contract UnitTestSetup is Test {
             ownerMustSendPayouts: false,
             allowAddAccountingContext: false,
             allowAddPriceFeed: false,
-            allowCrosschainSuckerExtension: false,
             holdFees: false,
             useTotalSurplusForRedemptions: false,
             useDataHookForRedeem: false,