@ballkidz/defifa 0.0.6 → 0.0.7

package/STYLE_GUIDE.md

@@ -253,9 +253,12 @@ uint256 public constant MAX_RESERVED_PERCENT = 10_000;
 
 ## Function Calls
 
-Use named parameters for readability when calling functions with 3+ arguments:
+Use named arguments for all function calls with 2 or more arguments — in both `src/` and `script/`:
 
 ```solidity
+// Good — named arguments
+token.mint({account: beneficiary, amount: count});
+_transferOwnership({newOwner: address(0), projectId: 0});
 PERMISSIONS.hasPermission({
     operator: sender,
     account: account,
@@ -264,8 +267,18 @@ PERMISSIONS.hasPermission({
     includeRoot: true,
     includeWildcardProjectId: true
 });
+
+// Bad — positional arguments with 2+ args
+token.mint(beneficiary, count);
+_transferOwnership(address(0), 0);
 ```
 
+Single-argument calls use positional style: `_burn(amount)`.
+
+This also applies to constructor calls, struct literals, and inherited/library calls (e.g., OZ `_mint`, `_safeMint`, `safeTransfer`, `allowance`, `Clones.cloneDeterministic`).
+
+Named argument keys must use **camelCase** — never underscores. If a function's parameter names use underscores, rename them to camelCase first.
+
 ## Multiline Signatures
 
 ```solidity

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ballkidz/defifa",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "license": "MIT",
   "engines": {
     "node": ">=20.0.0"
@@ -13,12 +13,14 @@
     "url": "https://github.com/BallKidz/defifa-collection-deployer"
   },
   "dependencies": {
-    "@bananapus/721-hook-v6": "^0.0.14",
-    "@bananapus/address-registry-v6": "^0.0.8",
-    "@bananapus/core-v6": "^0.0.15",
-    "@bananapus/permission-ids-v6": "^0.0.8",
+    "@bananapus/721-hook-v6": "^0.0.16",
+    "@bananapus/address-registry-v6": "^0.0.9",
+    "@bananapus/core-v6": "^0.0.16",
+    "@bananapus/permission-ids-v6": "^0.0.9",
+    "@croptop/core-v6": "^0.0.15",
     "@openzeppelin/contracts": "^5.6.1",
     "@prb/math": "^4.1.1",
+    "@rev-net/core-v6": "^0.0.12",
     "scripty.sol": "^2.1.1"
   },
   "devDependencies": {

package/script/Deploy.s.sol

@@ -91,18 +91,20 @@ contract DeployMainnet is Script, Sphinx {
     }
 
     function deploy() public sphinx {
-        DefifaHook hook = new DefifaHook{salt: _salt}(core.directory, defifaToken, baseProtocolToken);
+        DefifaHook hook = new DefifaHook{salt: _salt}({
+            _directory: core.directory, _defifaToken: defifaToken, _baseProtocolToken: baseProtocolToken
+        });
         DefifaTokenUriResolver tokenUriResolver = new DefifaTokenUriResolver{salt: _salt}(_typeface);
-        DefifaGovernor governor = new DefifaGovernor{salt: _salt}(core.controller, safeAddress());
-        DefifaDeployer deployer = new DefifaDeployer{salt: _salt}(
-            address(hook),
-            tokenUriResolver,
-            governor,
-            core.controller,
-            registry.registry,
-            _defifaProjectId,
-            _baseProtocolProjectId
-        );
+        DefifaGovernor governor = new DefifaGovernor{salt: _salt}({_controller: core.controller, _owner: safeAddress()});
+        DefifaDeployer deployer = new DefifaDeployer{salt: _salt}({
+            _hookCodeOrigin: address(hook),
+            _tokenUriResolver: tokenUriResolver,
+            _governor: governor,
+            _controller: core.controller,
+            _registry: registry.registry,
+            _defifaProjectId: _defifaProjectId,
+            _baseProtocolProjectId: _baseProtocolProjectId
+        });
 
         governor.transferOwnership(address(deployer));
     }

package/script/helpers/DefifaDeploymentLib.sol

@@ -34,7 +34,7 @@ library DefifaDeploymentLib {
 
         for (uint256 _i; _i < networks.length; _i++) {
             if (networks[_i].chainId == chainId) {
-                return getDeployment(path, networks[_i].name);
+                return getDeployment({path: path, network_name: networks[_i].name});
             }
         }
 
@@ -49,14 +49,32 @@ library DefifaDeploymentLib {
         view
         returns (DefifaDeployment memory deployment)
     {
-        deployment.hook = DefifaHook(_getDeploymentAddress(path, PROJECT_NAME, network_name, "DefifaHook"));
+        deployment.hook = DefifaHook(
+            _getDeploymentAddress({
+                path: path, project_name: PROJECT_NAME, network_name: network_name, contractName: "DefifaHook"
+            })
+        );
 
-        deployment.deployer = DefifaDeployer(_getDeploymentAddress(path, PROJECT_NAME, network_name, "DefifaDeployer"));
+        deployment.deployer = DefifaDeployer(
+            _getDeploymentAddress({
+                path: path, project_name: PROJECT_NAME, network_name: network_name, contractName: "DefifaDeployer"
+            })
+        );
 
-        deployment.governor = DefifaGovernor(_getDeploymentAddress(path, PROJECT_NAME, network_name, "DefifaGovernor"));
+        deployment.governor = DefifaGovernor(
+            _getDeploymentAddress({
+                path: path, project_name: PROJECT_NAME, network_name: network_name, contractName: "DefifaGovernor"
+            })
+        );
 
-        deployment.tokenUriResolver =
-            DefifaTokenUriResolver(_getDeploymentAddress(path, PROJECT_NAME, network_name, "DefifaTokenUriResolver"));
+        deployment.tokenUriResolver = DefifaTokenUriResolver(
+            _getDeploymentAddress({
+                path: path,
+                project_name: PROJECT_NAME,
+                network_name: network_name,
+                contractName: "DefifaTokenUriResolver"
+            })
+        );
     }
 
     /// @notice Get the address of a contract that was deployed by the Deploy script.
@@ -78,6 +96,6 @@ library DefifaDeploymentLib {
     {
         string memory deploymentJson =
             vm.readFile(string.concat(path, project_name, "/", network_name, "/", contractName, ".json"));
-        return stdJson.readAddress(deploymentJson, ".address");
+        return stdJson.readAddress({json: deploymentJson, key: ".address"});
     }
 }

package/src/DefifaDeployer.sol

@@ -323,7 +323,8 @@ contract DefifaDeployer is IDefifaDeployer, IDefifaGamePhaseReporter, IDefifaGam
         if (_pot == 0) revert DefifaDeployer_NothingToFulfill();
 
         // Compute the fee amount based on the total absolute split percent stored at game creation.
-        uint256 _feeAmount = mulDiv(_pot, _commitmentPercentOf[gameId], JBConstants.SPLITS_TOTAL_PERCENT);
+        uint256 _feeAmount =
+            mulDiv({x: _pot, y: _commitmentPercentOf[gameId], denominator: JBConstants.SPLITS_TOTAL_PERCENT});
 
         // Store the actual fee amount for accurate currentGamePotOf reporting.
         // Use max(feeAmount, 1) to preserve the reentrancy guard when pot is 0.
@@ -523,7 +524,9 @@ contract DefifaDeployer is IDefifaDeployer, IDefifaGamePhaseReporter, IDefifaGam
         // cloneDeterministic with msg.sender in the salt prevents this since a different
         // caller produces a different address.
         DefifaHook _hook = DefifaHook(
-            Clones.cloneDeterministic(hookCodeOrigin, keccak256(abi.encodePacked(msg.sender, _currentNonce)))
+            Clones.cloneDeterministic({
+                implementation: hookCodeOrigin, salt: keccak256(abi.encodePacked(msg.sender, _currentNonce))
+            })
         );
 
         // Use the default uri resolver if provided, else use the hardcoded generic default.
@@ -857,14 +860,20 @@ contract DefifaDeployer is IDefifaDeployer, IDefifaGamePhaseReporter, IDefifaGam
         uint256 _normalizedTotal;
         for (uint256 _i; _i < _numberOfUserSplits; _i++) {
             _splits[_i] = _initialSplits[_i];
-            _splits[_i].percent =
-                uint32(mulDiv(_initialSplits[_i].percent, JBConstants.SPLITS_TOTAL_PERCENT, _totalAbsolutePercent));
+            _splits[_i].percent = uint32(
+                mulDiv({
+                    x: _initialSplits[_i].percent,
+                    y: JBConstants.SPLITS_TOTAL_PERCENT,
+                    denominator: _totalAbsolutePercent
+                })
+            );
             _normalizedTotal += _splits[_i].percent;
         }
 
         // Add Defifa fee split (normalized).
-        uint256 _defifaNormalized =
-            mulDiv(_defifaAbsolutePercent, JBConstants.SPLITS_TOTAL_PERCENT, _totalAbsolutePercent);
+        uint256 _defifaNormalized = mulDiv({
+            x: _defifaAbsolutePercent, y: JBConstants.SPLITS_TOTAL_PERCENT, denominator: _totalAbsolutePercent
+        });
         _splits[_numberOfUserSplits] = JBSplit({
             preferAddToBalance: false,
             percent: uint32(_defifaNormalized),

package/src/DefifaGovernor.sol

@@ -182,12 +182,12 @@ contract DefifaGovernor is Ownable, IDefifaGovernor {
             // e.g. holding 3 of 10 tokens → 3/10 * MAX_ATTESTATION_POWER_TIER attestation power from this tier.
             unchecked {
                 if (_tierAttestationUnitsForAccount != 0) {
-                    attestationPower += mulDiv(
-                        MAX_ATTESTATION_POWER_TIER,
-                        _tierAttestationUnitsForAccount,
-                        IDefifaHook(_metadata.dataHook)
+                    attestationPower += mulDiv({
+                        x: MAX_ATTESTATION_POWER_TIER,
+                        y: _tierAttestationUnitsForAccount,
+                        denominator: IDefifaHook(_metadata.dataHook)
                             .getPastTierTotalAttestationUnitsOf({tier: _tierId, timestamp: _timestamp})
-                    );
+                    });
                 }
             }
         }

package/src/DefifaHook.sol

@@ -266,8 +266,9 @@ contract DefifaHook is JB721Hook, Ownable, IDefifaHook {
         if (context.cashOutCount > 0) revert JB721Hook_UnexpectedTokenCashedOut();
 
         // Fetch the cash out hook metadata using the corresponding metadata ID.
-        (bool metadataExists, bytes memory metadata) =
-            JBMetadataResolver.getDataFor(JBMetadataResolver.getId("cashOut", codeOrigin), context.metadata);
+        (bool metadataExists, bytes memory metadata) = JBMetadataResolver.getDataFor({
+            id: JBMetadataResolver.getId({purpose: "cashOut", target: codeOrigin}), metadata: context.metadata
+        });
 
         uint256[] memory decodedTokenIds;
 
@@ -283,7 +284,8 @@ contract DefifaHook is JB721Hook, Ownable, IDefifaHook {
 
         // Use this contract as the only cash out hook.
         hookSpecifications = new JBCashOutHookSpecification[](1);
-        hookSpecifications[0] = JBCashOutHookSpecification(this, 0, abi.encode(_cumulativeMintPrice));
+        hookSpecifications[0] =
+            JBCashOutHookSpecification({hook: this, amount: 0, metadata: abi.encode(_cumulativeMintPrice)});
 
         // Compute the cash out count based on the game phase.
         cashOutCount = DefifaHookLib.computeCashOutCount({
@@ -573,7 +575,7 @@ contract DefifaHook is JB721Hook, Ownable, IDefifaHook {
             _tokenId = _tokenIds[_i];
 
             // Mint the token.
-            _mint(_reservedTokenBeneficiary, _tokenId);
+            _mint({to: _reservedTokenBeneficiary, tokenId: _tokenId});
 
             emit MintReservedToken(_tokenId, tierId, _reservedTokenBeneficiary, msg.sender);
 
@@ -614,9 +616,10 @@ contract DefifaHook is JB721Hook, Ownable, IDefifaHook {
         ) revert JB721Hook_InvalidCashOut();
 
         // Fetch the cash out hook metadata using the corresponding metadata ID.
-        (bool metadataExists, bytes memory metadata) = JBMetadataResolver.getDataFor(
-            JBMetadataResolver.getId("cashOut", METADATA_ID_TARGET), context.cashOutMetadata
-        );
+        (bool metadataExists, bytes memory metadata) = JBMetadataResolver.getDataFor({
+            id: JBMetadataResolver.getId({purpose: "cashOut", target: METADATA_ID_TARGET}),
+            metadata: context.cashOutMetadata
+        });
 
         if (!metadataExists) {
             revert();
@@ -865,7 +868,7 @@ contract DefifaHook is JB721Hook, Ownable, IDefifaHook {
             _tokenId = _tokenIds[_i];
 
             // Mint the tokens.
-            _mint(_beneficiary, _tokenId);
+            _mint({to: _beneficiary, tokenId: _tokenId});
 
             emit Mint(_tokenId, _mintTierIds[_i], _beneficiary, _amount, msg.sender);
 
@@ -889,8 +892,9 @@ contract DefifaHook is JB721Hook, Ownable, IDefifaHook {
             // Get the current amount for the sending delegate.
             uint208 _current = _delegateTierCheckpoints[_from][_tierId].latest();
             // Set the new amount for the sending delegate.
-            (uint256 _oldValue, uint256 _newValue) =
-                _delegateTierCheckpoints[_from][_tierId].push(uint48(block.timestamp), _current - uint208(_amount));
+            (uint256 _oldValue, uint256 _newValue) = _delegateTierCheckpoints[_from][_tierId].push({
+                key: uint48(block.timestamp), value: _current - uint208(_amount)
+            });
             emit TierDelegateAttestationsChanged(_from, _tierId, _oldValue, _newValue, msg.sender);
         }
 
@@ -899,8 +903,9 @@ contract DefifaHook is JB721Hook, Ownable, IDefifaHook {
             // Get the current amount for the receiving delegate.
             uint208 _current = _delegateTierCheckpoints[_to][_tierId].latest();
             // Set the new amount for the receiving delegate.
-            (uint256 _oldValue, uint256 _newValue) =
-                _delegateTierCheckpoints[_to][_tierId].push(uint48(block.timestamp), _current + uint208(_amount));
+            (uint256 _oldValue, uint256 _newValue) = _delegateTierCheckpoints[_to][_tierId].push({
+                key: uint48(block.timestamp), value: _current + uint208(_amount)
+            });
             emit TierDelegateAttestationsChanged(_to, _tierId, _oldValue, _newValue, msg.sender);
         }
     }
@@ -912,8 +917,9 @@ contract DefifaHook is JB721Hook, Ownable, IDefifaHook {
         if (context.amount.currency != pricingCurrency) revert DefifaHook_WrongCurrency();
 
         // Resolve the metadata.
-        (bool found, bytes memory metadata) =
-            JBMetadataResolver.getDataFor(JBMetadataResolver.getId("pay", codeOrigin), context.payerMetadata);
+        (bool found, bytes memory metadata) = JBMetadataResolver.getDataFor({
+            id: JBMetadataResolver.getId({purpose: "pay", target: codeOrigin}), metadata: context.payerMetadata
+        });
 
         if (!found) revert DefifaHook_NothingToMint();
 
@@ -987,13 +993,13 @@ contract DefifaHook is JB721Hook, Ownable, IDefifaHook {
             // If minting, add to the total tier checkpoints.
             if (_from == address(0)) {
                 // slither-disable-next-line unused-return
-                _totalTierCheckpoints[_tierId].push(uint48(block.timestamp), _current + uint208(_amount));
+                _totalTierCheckpoints[_tierId].push({key: uint48(block.timestamp), value: _current + uint208(_amount)});
             }
 
             // If burning, subtract from the total tier checkpoints.
             if (_to == address(0)) {
                 // slither-disable-next-line unused-return
-                _totalTierCheckpoints[_tierId].push(uint48(block.timestamp), _current - uint208(_amount));
+                _totalTierCheckpoints[_tierId].push({key: uint48(block.timestamp), value: _current - uint208(_amount)});
             }
         }
 

package/src/DefifaTokenUriResolver.sol

@@ -160,8 +160,9 @@ contract DefifaTokenUriResolver is IDefifaTokenUriResolver, IJB721TokenUriResolv
                 }
 
                 if (_gamePhase == DefifaGamePhase.SCORING || _gamePhase == DefifaGamePhase.COMPLETE) {
-                    uint256 _potPortion =
-                        mulDiv(_gamePot, _hook.cashOutWeightOf(_tokenId), _hook.TOTAL_CASHOUT_WEIGHT());
+                    uint256 _potPortion = mulDiv({
+                        x: _gamePot, y: _hook.cashOutWeightOf(_tokenId), denominator: _hook.TOTAL_CASHOUT_WEIGHT()
+                    });
                     _valueText = !_hook.cashOutWeightIsSet()
                         ? "Awaiting scorecard..."
                         : _formatBalance({

package/src/libraries/DefifaHookLib.sol

@@ -248,7 +248,9 @@ library DefifaHookLib {
             cashOutCount = cumulativeMintPrice;
         } else {
             // If the game is in its scoring or complete phase, reclaim amount is based on the tier weights.
-            cashOutCount = mulDiv(surplusValue + _amountRedeemed, cumulativeCashOutWeight, TOTAL_CASHOUT_WEIGHT);
+            cashOutCount = mulDiv({
+                x: surplusValue + _amountRedeemed, y: cumulativeCashOutWeight, denominator: TOTAL_CASHOUT_WEIGHT
+            });
         }
     }
 
@@ -348,8 +350,8 @@ library DefifaHookLib {
         uint256 defifaAmount = _defifaToken.balanceOf(address(this)) * shareToBeneficiary / outOfTotal;
 
         // If there is an amount we should send, send it.
-        if (defifaAmount != 0) _defifaToken.safeTransfer(_beneficiary, defifaAmount);
-        if (baseProtocolAmount != 0) _baseProtocolToken.safeTransfer(_beneficiary, baseProtocolAmount);
+        if (defifaAmount != 0) _defifaToken.safeTransfer({to: _beneficiary, value: defifaAmount});
+        if (baseProtocolAmount != 0) _baseProtocolToken.safeTransfer({to: _beneficiary, value: baseProtocolAmount});
 
         emit ClaimedTokens(_beneficiary, defifaAmount, baseProtocolAmount, msg.sender);