@bananapus/721-hook-v6 0.0.42 → 0.0.43

package/test/utils/ForTest_JB721TiersHook.sol

@@ -0,0 +1,246 @@
+// SPDX-License-Identifier: MIT
+pragma solidity 0.8.28;
+
+// forge-lint: disable-next-line(unaliased-plain-import)
+import "../../src/interfaces/IJB721TiersHook.sol";
+import {JB721TierFlags} from "../../src/structs/JB721TierFlags.sol";
+
+// forge-lint: disable-next-line(unaliased-plain-import)
+import "../../src/JB721TiersHook.sol";
+// forge-lint: disable-next-line(unaliased-plain-import)
+import "../../src/JB721TiersHookStore.sol";
+
+import {JB721CheckpointsDeployer} from "../../src/JB721CheckpointsDeployer.sol";
+import {IJB721CheckpointsDeployer} from "../../src/interfaces/IJB721CheckpointsDeployer.sol";
+
+// forge-lint: disable-next-line(unaliased-plain-import)
+import "../../src/structs/JBBitmapWord.sol";
+
+// forge-lint: disable-next-line(unaliased-plain-import)
+import "@bananapus/core-v6/src/structs/JBRulesetMetadata.sol";
+// forge-lint: disable-next-line(unaliased-plain-import)
+import "@bananapus/core-v6/src/interfaces/IJBPermissioned.sol";
+import {MetadataResolverHelper} from "@bananapus/core-v6/test/helpers/MetadataResolverHelper.sol";
+
+// forge-lint: disable-next-line(unaliased-plain-import)
+import "@bananapus/core-v6/src/libraries/JBConstants.sol";
+
+// forge-lint: disable-next-line(unaliased-plain-import)
+import "./UnitTestSetup.sol"; // Only used to get the `PAY_HOOK_ID` and `CASH_OUT_HOOK_ID` constants.
+
+interface IJB721TiersHookStore_ForTest is IJB721TiersHookStore {
+    // forge-lint: disable-next-line(mixed-case-function)
+    function ForTest_dumpTiersList(address nft) external view returns (JB721Tier[] memory tiers);
+    // forge-lint: disable-next-line(mixed-case-function)
+    function ForTest_setTier(address hook, uint256 index, JBStored721Tier calldata newTier) external;
+    // forge-lint: disable-next-line(mixed-case-function)
+    function ForTest_setTierVotingUnits(address hook, uint256 tierId, uint32 votingUnits) external;
+    // forge-lint: disable-next-line(mixed-case-function)
+    function ForTest_setBalanceOf(address hook, address holder, uint256 tier, uint256 balance) external;
+    // forge-lint: disable-next-line(mixed-case-function)
+    function ForTest_setReservesMintedFor(address hook, uint256 tier, uint256 amount) external;
+    // forge-lint: disable-next-line(mixed-case-function)
+    function ForTest_setIsTierRemoved(address hook, uint256 tokenId) external;
+    // forge-lint: disable-next-line(mixed-case-function)
+    function ForTest_packBools(
+        bool allowOwnerMint,
+        bool transfersPausable,
+        bool useVotingUnits,
+        bool cantBeRemoved,
+        bool cantIncreaseDiscountPercent,
+        bool cantBuyWithCredits
+    )
+        external
+        returns (uint8);
+}
+
+// A customized 721 tiers hook for testing purposes.
+contract ForTest_JB721TiersHook is JB721TiersHook {
+    // forge-lint: disable-next-line(mixed-case-variable)
+    IJB721TiersHookStore_ForTest public test_store;
+    MetadataResolverHelper metadataHelper;
+
+    uint256 constant SURPLUS = 10e18;
+    uint256 constant CASH_OUT_TAX_RATE = JBConstants.MAX_CASH_OUT_TAX_RATE; // 40%
+    address _trustedForwarder = address(123_456);
+
+    /// @dev Bundles ForTest_JB721TiersHook constructor args to avoid stack-too-deep.
+    struct ForTestInitConfig {
+        uint256 projectId;
+        string name;
+        string symbol;
+        string baseUri;
+        IJB721TokenUriResolver tokenUriResolver;
+        string contractUri;
+        JB721TierConfig[] tiers;
+        JB721TiersHookFlags flags;
+    }
+
+    constructor(
+        ForTestInitConfig memory config,
+        IJBDirectory directory,
+        IJBPrices prices,
+        IJBRulesets rulesets,
+        IJB721TiersHookStore store,
+        IJBSplits splits
+    )
+        // The directory is also `IJBPermissioned`.
+        JB721TiersHook(
+            directory,
+            IJBPermissioned(address(directory)).PERMISSIONS(),
+            prices,
+            rulesets,
+            store,
+            splits,
+            IJB721CheckpointsDeployer(address(new JB721CheckpointsDeployer(store))),
+            _trustedForwarder
+        )
+    {
+        // Reset the _initialized flag set by the parent constructor so this test contract can initialize itself.
+        _initialized = false;
+        JB721TiersHook.initialize(
+            config.projectId,
+            config.name,
+            config.symbol,
+            config.baseUri,
+            config.tokenUriResolver,
+            config.contractUri,
+            JB721InitTiersConfig({
+                tiers: config.tiers, currency: uint32(uint160(JBConstants.NATIVE_TOKEN)), decimals: 18
+            }),
+            config.flags
+        );
+        test_store = IJB721TiersHookStore_ForTest(address(store));
+
+        metadataHelper = new MetadataResolverHelper();
+    }
+
+    // forge-lint: disable-next-line(mixed-case-function)
+    function ForTest_setOwnerOf(uint256 tokenId, address owner) public {
+        _owners[tokenId] = owner;
+    }
+
+    function burn(uint256[] memory tokenIds) public {
+        for (uint256 i; i < tokenIds.length; i++) {
+            _burn(tokenIds[i]);
+        }
+        STORE.recordBurn(tokenIds);
+    }
+}
+
+// A customized 721 tiers hook store for testing purposes.
+contract ForTest_JB721TiersHookStore is JB721TiersHookStore, IJB721TiersHookStore_ForTest {
+    using JBBitmap for mapping(uint256 => uint256);
+    using JBBitmap for JBBitmapWord;
+
+    // forge-lint: disable-next-line(mixed-case-function)
+    function ForTest_dumpTiersList(address nft) public view override returns (JB721Tier[] memory tiers) {
+        // Keep a reference to the max tier ID.
+        uint256 maxTierId = maxTierIdOf[nft];
+        // Initialize an array with the appropriate length.
+        tiers = new JB721Tier[](maxTierId);
+        // Count the number of included tiers.
+        uint256 numberOfIncludedTiers;
+        // Get a reference to the sorted index being iterated on, starting with the first one.
+        uint256 currentSortIndex = _firstSortedTierIdOf(nft, 0);
+        // Keep a reference to the tier being iterated on.
+        JBStored721Tier memory storedTier;
+        // Make the sorted array.
+        while (currentSortIndex != 0 && numberOfIncludedTiers < maxTierId) {
+            storedTier = _storedTierOf[nft][currentSortIndex];
+
+            // Unpack stored tier.
+            (bool allowOwnerMint, bool transfersPausable,,,,) = _unpackBools(storedTier.packedBools);
+
+            // Add the tier to the array being returned.
+            tiers[numberOfIncludedTiers++] = JB721Tier({
+                // forge-lint: disable-next-line(unsafe-typecast)
+                id: uint32(currentSortIndex),
+                price: storedTier.price,
+                remainingSupply: storedTier.remainingSupply,
+                initialSupply: storedTier.initialSupply,
+                votingUnits: storedTier.price,
+                reserveFrequency: storedTier.reserveFrequency,
+                reserveBeneficiary: reserveBeneficiaryOf(nft, currentSortIndex),
+                encodedIPFSUri: encodedIPFSUriOf[nft][currentSortIndex],
+                category: storedTier.category,
+                discountPercent: storedTier.discountPercent,
+                flags: JB721TierFlags({
+                    allowOwnerMint: allowOwnerMint,
+                    transfersPausable: transfersPausable,
+                    cantBeRemoved: false,
+                    cantIncreaseDiscountPercent: false,
+                    cantBuyWithCredits: false
+                }),
+                splitPercent: storedTier.splitPercent,
+                resolvedUri: ""
+            });
+            // Set the next sort index.
+            currentSortIndex = _nextSortedTierIdOf(nft, currentSortIndex, maxTierId);
+        }
+        // Drop the empty tiers at the end of the array.
+        // The array's size is based on `maxTierIdOf`, which *might* exceed the actual number of tiers.
+        for (uint256 i = tiers.length - 1; i >= 0; i--) {
+            if (tiers[i].id == 0) {
+                assembly ("memory-safe") {
+                    mstore(tiers, sub(mload(tiers), 1))
+                }
+            } else {
+                break;
+            }
+        }
+    }
+
+    // forge-lint: disable-next-line(mixed-case-function)
+    function ForTest_setTier(address hook, uint256 index, JBStored721Tier calldata newTier) public override {
+        _storedTierOf[address(hook)][index] = newTier;
+    }
+
+    // forge-lint: disable-next-line(mixed-case-function)
+    function ForTest_setTierVotingUnits(address hook, uint256 tierId, uint32 votingUnits) public override {
+        _tierVotingUnitsOf[address(hook)][tierId] = votingUnits;
+    }
+
+    // forge-lint: disable-next-line(mixed-case-function)
+    function ForTest_setBalanceOf(address hook, address holder, uint256 tier, uint256 balance) public override {
+        tierBalanceOf[address(hook)][holder][tier] = balance;
+    }
+
+    // forge-lint: disable-next-line(mixed-case-function)
+    function ForTest_setReservesMintedFor(address hook, uint256 tier, uint256 amount) public override {
+        numberOfReservesMintedFor[address(hook)][tier] = amount;
+    }
+
+    // forge-lint: disable-next-line(mixed-case-function)
+    function ForTest_setIsTierRemoved(address hook, uint256 tokenId) public override {
+        _removedTiersBitmapWordOf[hook].removeTier(tokenId);
+    }
+
+    // forge-lint: disable-next-line(mixed-case-function)
+    function ForTest_packBools(
+        bool allowOwnerMint,
+        bool transfersPausable,
+        bool useVotingUnits,
+        bool cantBeRemoved,
+        bool cantIncreaseDiscountPercent,
+        bool cantBuyWithCredits
+    )
+        public
+        pure
+        returns (uint8)
+    {
+        return _packBools(
+            allowOwnerMint,
+            transfersPausable,
+            useVotingUnits,
+            cantBeRemoved,
+            cantIncreaseDiscountPercent,
+            cantBuyWithCredits
+        );
+    }
+
+    // forge-lint: disable-next-line(mixed-case-function)
+    function ForTest_unpackBools(uint8 packed) public pure returns (bool, bool, bool, bool, bool, bool) {
+        return _unpackBools(packed);
+    }
+}

package/test/utils/TestBaseWorkflow.sol

@@ -0,0 +1,213 @@
+// SPDX-License-Identifier: MIT
+pragma solidity 0.8.28;
+
+// forge-lint: disable-next-line(unaliased-plain-import)
+import "@bananapus/core-v6/src/JBController.sol";
+// forge-lint: disable-next-line(unaliased-plain-import)
+import "@bananapus/core-v6/src/JBDirectory.sol";
+// forge-lint: disable-next-line(unaliased-plain-import)
+import "@bananapus/core-v6/src/JBMultiTerminal.sol";
+// forge-lint: disable-next-line(unaliased-plain-import)
+import "@bananapus/core-v6/src/JBFundAccessLimits.sol";
+// forge-lint: disable-next-line(unaliased-plain-import)
+import "@bananapus/core-v6/src/JBFeelessAddresses.sol";
+// forge-lint: disable-next-line(unaliased-plain-import)
+import "@bananapus/core-v6/src/JBTerminalStore.sol";
+// forge-lint: disable-next-line(unaliased-plain-import)
+import "@bananapus/core-v6/src/JBRulesets.sol";
+// forge-lint: disable-next-line(unaliased-plain-import)
+import "@bananapus/core-v6/src/JBPermissions.sol";
+// forge-lint: disable-next-line(unaliased-plain-import)
+import "@bananapus/core-v6/src/JBPrices.sol";
+import {JBProjects} from "@bananapus/core-v6/src/JBProjects.sol";
+// forge-lint: disable-next-line(unaliased-plain-import)
+import "@bananapus/core-v6/src/JBSplits.sol";
+// forge-lint: disable-next-line(unaliased-plain-import)
+import "@bananapus/core-v6/src/JBERC20.sol";
+// forge-lint: disable-next-line(unaliased-plain-import)
+import "@bananapus/core-v6/src/JBTokens.sol";
+
+// forge-lint: disable-next-line(unaliased-plain-import)
+import "@bananapus/core-v6/src/structs/JBAfterPayRecordedContext.sol";
+// forge-lint: disable-next-line(unaliased-plain-import)
+import "@bananapus/core-v6/src/structs/JBAfterCashOutRecordedContext.sol";
+// forge-lint: disable-next-line(unaliased-plain-import)
+import "@bananapus/core-v6/src/structs/JBFee.sol";
+// forge-lint: disable-next-line(unaliased-plain-import)
+import "@bananapus/core-v6/src/structs/JBFundAccessLimitGroup.sol";
+// forge-lint: disable-next-line(unaliased-plain-import)
+import "@bananapus/core-v6/src/structs/JBRuleset.sol";
+// forge-lint: disable-next-line(unaliased-plain-import)
+import "@bananapus/core-v6/src/structs/JBRulesetConfig.sol";
+// forge-lint: disable-next-line(unaliased-plain-import)
+import "@bananapus/core-v6/src/structs/JBRulesetMetadata.sol";
+// forge-lint: disable-next-line(unaliased-plain-import)
+import "@bananapus/core-v6/src/structs/JBPermissionsData.sol";
+// forge-lint: disable-next-line(unaliased-plain-import)
+import "@bananapus/core-v6/src/structs/JBBeforePayRecordedContext.sol";
+// forge-lint: disable-next-line(unaliased-plain-import)
+import "@bananapus/core-v6/src/structs/JBBeforeCashOutRecordedContext.sol";
+// forge-lint: disable-next-line(unaliased-plain-import)
+import "@bananapus/core-v6/src/structs/JBSplit.sol";
+
+// forge-lint: disable-next-line(unaliased-plain-import)
+import "@bananapus/core-v6/src/interfaces/IJBTerminal.sol";
+// forge-lint: disable-next-line(unaliased-plain-import)
+import "@bananapus/core-v6/src/interfaces/IJBToken.sol";
+
+// forge-lint: disable-next-line(unaliased-plain-import)
+import "@bananapus/permission-ids-v6/src/JBPermissionIds.sol";
+// forge-lint: disable-next-line(unaliased-plain-import)
+import "@bananapus/core-v6/src/libraries/JBRulesetMetadataResolver.sol";
+
+// forge-lint: disable-next-line(unused-import)
+import {mulDiv} from "@prb/math/src/Common.sol";
+
+// forge-lint: disable-next-line(unaliased-plain-import)
+import "forge-std/Test.sol";
+
+// forge-lint: disable-next-line(unaliased-plain-import)
+import "./AccessJBLib.sol";
+
+// forge-lint: disable-next-line(unaliased-plain-import)
+import "../../src/structs/JBPayDataHookRulesetConfig.sol";
+// forge-lint: disable-next-line(unaliased-plain-import)
+import "../../src/structs/JBPayDataHookRulesetMetadata.sol";
+
+/// @notice Base contract for Juicebox system tests.
+/// @dev Provides common functionality, such as deploying contracts on test setup.
+contract TestBaseWorkflow is Test {
+    //*********************************************************************//
+    // --------------------- internal stored properties ------------------- //
+    //*********************************************************************//
+
+    address internal projectOwner = address(123);
+    address internal beneficiary = address(69_420);
+    address internal caller = address(696_969);
+
+    JBPermissions internal jbPermissions;
+    JBProjects internal jbProjects;
+    JBPrices internal jbPrices;
+    JBDirectory internal jbDirectory;
+    JBRulesets internal jbRulesets;
+    JBTokens internal jbTokens;
+    JBFundAccessLimits internal jbFundAccessLimits;
+    JBFeelessAddresses internal jbFeelessAddresses;
+    JBSplits internal jbSplits;
+    JBController internal jbController;
+    JBTerminalStore internal jbTerminalStore;
+    JBMultiTerminal internal jbMultiTerminal;
+    string internal projectUri;
+    IJBToken internal tokenV2;
+
+    // forge-lint: disable-next-line(mixed-case-variable)
+    AccessJBLib internal accessJBLib;
+
+    //*********************************************************************//
+    // --------------------------- test setup ---------------------------- //
+    //*********************************************************************//
+
+    // Deploys and initializes contracts for testing.
+    function setUp() public virtual {
+        // ---- Set up project ---- //
+        jbPermissions = new JBPermissions(address(0));
+        vm.label(address(jbPermissions), "JBPermissions");
+
+        jbProjects = new JBProjects(projectOwner, address(0), address(0));
+        vm.label(address(jbProjects), "JBProjects");
+
+        jbDirectory = new JBDirectory(jbPermissions, jbProjects, projectOwner);
+        vm.label(address(jbDirectory), "JBDirectory");
+
+        jbPrices = new JBPrices(jbDirectory, jbPermissions, jbProjects, projectOwner, address(0));
+        vm.label(address(jbPrices), "JBPrices");
+
+        jbRulesets = new JBRulesets(jbDirectory);
+        vm.label(address(jbRulesets), "JBRulesets");
+
+        jbFundAccessLimits = new JBFundAccessLimits(jbDirectory);
+        vm.label(address(jbFundAccessLimits), "JBFundAccessLimits");
+
+        jbFeelessAddresses = new JBFeelessAddresses(address(69));
+        vm.label(address(jbFeelessAddresses), "JBFeelessAddresses");
+
+        jbTokens = new JBTokens(jbDirectory, new JBERC20(jbPermissions, jbProjects));
+        vm.label(address(jbTokens), "JBTokens");
+
+        jbSplits = new JBSplits(jbDirectory);
+        vm.label(address(jbSplits), "JBSplits");
+
+        jbController = new JBController(
+            jbDirectory,
+            jbFundAccessLimits,
+            jbPermissions,
+            jbPrices,
+            jbProjects,
+            jbRulesets,
+            jbSplits,
+            jbTokens,
+            address(0),
+            address(0)
+        );
+        vm.label(address(jbController), "JBController");
+
+        vm.prank(projectOwner);
+        jbDirectory.setIsAllowedToSetFirstController(address(jbController), true);
+
+        jbTerminalStore = new JBTerminalStore(jbDirectory, jbPrices, jbRulesets);
+        vm.label(address(jbTerminalStore), "JBTerminalStore");
+
+        accessJBLib = new AccessJBLib();
+
+        jbMultiTerminal = new JBMultiTerminal(
+            jbFeelessAddresses,
+            jbPermissions,
+            jbProjects,
+            jbSplits,
+            jbTerminalStore,
+            jbTokens,
+            IPermit2(address(0)),
+            address(0)
+        );
+        vm.label(address(jbMultiTerminal), "JBMultiTerminal");
+
+        projectUri = "myIPFSHash";
+
+        // ---- general setup ---- //
+        vm.deal(beneficiary, 100 ether);
+        vm.deal(projectOwner, 100 ether);
+        vm.deal(caller, 100 ether);
+
+        vm.label(projectOwner, "projectOwner");
+        vm.label(beneficiary, "beneficiary");
+        vm.label(caller, "caller");
+    }
+
+    //https://ethereum.stackexchange.com/questions/24248/how-to-calculate-an-ethereum-contracts-address-during-its-creation-using-the-so
+    function addressFrom(address origin, uint256 nonce) internal pure returns (address addr) {
+        bytes memory data;
+        if (nonce == 0x00) {
+            data = abi.encodePacked(bytes1(0xd6), bytes1(0x94), origin, bytes1(0x80));
+        } else if (nonce <= 0x7f) {
+            // forge-lint: disable-next-line(unsafe-typecast)
+            data = abi.encodePacked(bytes1(0xd6), bytes1(0x94), origin, uint8(nonce));
+        } else if (nonce <= 0xff) {
+            // forge-lint: disable-next-line(unsafe-typecast)
+            data = abi.encodePacked(bytes1(0xd7), bytes1(0x94), origin, bytes1(0x81), uint8(nonce));
+        } else if (nonce <= 0xffff) {
+            // forge-lint: disable-next-line(unsafe-typecast)
+            data = abi.encodePacked(bytes1(0xd8), bytes1(0x94), origin, bytes1(0x82), uint16(nonce));
+        } else if (nonce <= 0xffffff) {
+            // forge-lint: disable-next-line(unsafe-typecast)
+            data = abi.encodePacked(bytes1(0xd9), bytes1(0x94), origin, bytes1(0x83), uint24(nonce));
+        } else {
+            // forge-lint: disable-next-line(unsafe-typecast)
+            data = abi.encodePacked(bytes1(0xda), bytes1(0x94), origin, bytes1(0x84), uint32(nonce));
+        }
+        bytes32 hash = keccak256(data);
+        assembly ("memory-safe") {
+            mstore(0, hash)
+            addr := mload(0)
+        }
+    }
+}