@ballkidz/defifa 0.0.7 → 0.0.9

package/src/interfaces/IDefifaGovernor.sol

@@ -1,9 +1,10 @@
 // SPDX-License-Identifier: MIT
-pragma solidity 0.8.26;
+pragma solidity ^0.8.0;
+
+import {IJBController} from "@bananapus/core-v6/src/interfaces/IJBController.sol";
 
 import {DefifaScorecardState} from "../enums/DefifaScorecardState.sol";
 import {DefifaTierCashOutWeight} from "../structs/DefifaTierCashOutWeight.sol";
-import {IJBController} from "@bananapus/core-v6/src/interfaces/IJBController.sol";
 
 /// @notice Manages the ratification of Defifa scorecards through attestation-based governance.
 interface IDefifaGovernor {
@@ -11,6 +12,10 @@ interface IDefifaGovernor {
         uint256 indexed gameId, uint256 attestationStartTime, uint256 attestationGracePeriod, address caller
     );
 
+    event ScorecardAttested(uint256 indexed gameId, uint256 indexed scorecardId, uint256 weight, address caller);
+
+    event ScorecardRatified(uint256 indexed gameId, uint256 indexed scorecardId, address caller);
+
     event ScorecardSubmitted(
         uint256 indexed gameId,
         uint256 indexed scorecardId,
@@ -19,42 +24,31 @@ interface IDefifaGovernor {
         address caller
     );
 
-    event ScorecardAttested(uint256 indexed gameId, uint256 indexed scorecardId, uint256 weight, address caller);
-
-    event ScorecardRatified(uint256 indexed gameId, uint256 indexed scorecardId, address caller);
+    /// @notice The number of attestations for a scorecard.
+    /// @param gameId The ID of the game.
+    /// @param scorecardId The ID of the scorecard.
+    /// @return The attestation count.
+    function attestationCountOf(uint256 gameId, uint256 scorecardId) external view returns (uint256);
 
-    event FulfillmentFailed(uint256 indexed gameId, bytes reason);
+    /// @notice The grace period after attestation starts during which attestation is still allowed.
+    /// @param gameId The ID of the game.
+    /// @return The grace period in seconds.
+    function attestationGracePeriodOf(uint256 gameId) external view returns (uint256);
 
-    /// @notice The maximum tier ID that contributes attestation power.
-    /// @return The maximum attestation power tier.
-    function MAX_ATTESTATION_POWER_TIER() external view returns (uint256);
+    /// @notice The timestamp when attestation begins for a game.
+    /// @param gameId The ID of the game.
+    /// @return The attestation start time.
+    function attestationStartTimeOf(uint256 gameId) external view returns (uint256);
 
     /// @notice The Juicebox controller used to manage projects.
     /// @return The controller contract.
-    function controller() external view returns (IJBController);
+    function CONTROLLER() external view returns (IJBController);
 
     /// @notice The scorecard proposal submitted by the default attestation delegate for a game.
     /// @param gameId The ID of the game.
     /// @return The scorecard ID.
     function defaultAttestationDelegateProposalOf(uint256 gameId) external view returns (uint256);
 
-    /// @notice The ID of the ratified scorecard for a game.
-    /// @param gameId The ID of the game.
-    /// @return The ratified scorecard ID, or 0 if none.
-    function ratifiedScorecardIdOf(uint256 gameId) external view returns (uint256);
-
-    /// @notice Compute the scorecard ID for a given hook and tier weights.
-    /// @param gameHook The game hook address.
-    /// @param tierWeights The tier cash out weights.
-    /// @return The scorecard ID.
-    function scorecardIdOf(address gameHook, DefifaTierCashOutWeight[] calldata tierWeights) external returns (uint256);
-
-    /// @notice The state of a scorecard.
-    /// @param gameId The ID of the game.
-    /// @param scorecardId The ID of the scorecard.
-    /// @return The scorecard state.
-    function stateOf(uint256 gameId, uint256 scorecardId) external view returns (DefifaScorecardState);
-
     /// @notice Get the attestation weight for an account at a specific timestamp.
     /// @param gameId The ID of the game.
     /// @param account The account to check.
@@ -69,12 +63,6 @@ interface IDefifaGovernor {
         view
         returns (uint256 attestationPower);
 
-    /// @notice The number of attestations for a scorecard.
-    /// @param gameId The ID of the game.
-    /// @param scorecardId The ID of the scorecard.
-    /// @return The attestation count.
-    function attestationCountOf(uint256 gameId, uint256 scorecardId) external view returns (uint256);
-
     /// @notice Whether an account has attested to a specific scorecard.
     /// @param gameId The ID of the game.
     /// @param scorecardId The ID of the scorecard.
@@ -82,37 +70,31 @@ interface IDefifaGovernor {
     /// @return True if the account has attested.
     function hasAttestedTo(uint256 gameId, uint256 scorecardId, address account) external view returns (bool);
 
-    /// @notice The timestamp when attestation begins for a game.
-    /// @param gameId The ID of the game.
-    /// @return The attestation start time.
-    function attestationStartTimeOf(uint256 gameId) external view returns (uint256);
-
-    /// @notice The grace period after attestation starts during which attestation is still allowed.
-    /// @param gameId The ID of the game.
-    /// @return The grace period in seconds.
-    function attestationGracePeriodOf(uint256 gameId) external view returns (uint256);
+    /// @notice The maximum tier ID that contributes attestation power.
+    /// @return The maximum attestation power tier.
+    function MAX_ATTESTATION_POWER_TIER() external view returns (uint256);
 
     /// @notice The quorum required to ratify a scorecard.
     /// @param gameId The ID of the game.
     /// @return The quorum threshold.
     function quorum(uint256 gameId) external view returns (uint256);
 
-    /// @notice Initialize a game's governance parameters.
+    /// @notice The ID of the ratified scorecard for a game.
     /// @param gameId The ID of the game.
-    /// @param attestationStartTime The timestamp when attestation begins.
-    /// @param attestationGracePeriod The grace period duration in seconds.
-    function initializeGame(uint256 gameId, uint256 attestationStartTime, uint256 attestationGracePeriod) external;
+    /// @return The ratified scorecard ID, or 0 if none.
+    function ratifiedScorecardIdOf(uint256 gameId) external view returns (uint256);
 
-    /// @notice Submit a scorecard for attestation.
-    /// @param gameId The ID of the game.
+    /// @notice Compute the scorecard ID for a given hook and tier weights.
+    /// @param gameHook The game hook address.
     /// @param tierWeights The tier cash out weights.
     /// @return The scorecard ID.
-    function submitScorecardFor(
-        uint256 gameId,
-        DefifaTierCashOutWeight[] calldata tierWeights
-    )
-        external
-        returns (uint256);
+    function scorecardIdOf(address gameHook, DefifaTierCashOutWeight[] calldata tierWeights) external returns (uint256);
+
+    /// @notice The state of a scorecard.
+    /// @param gameId The ID of the game.
+    /// @param scorecardId The ID of the scorecard.
+    /// @return The scorecard state.
+    function stateOf(uint256 gameId, uint256 scorecardId) external view returns (DefifaScorecardState);
 
     /// @notice Attest to a submitted scorecard.
     /// @param gameId The ID of the game.
@@ -120,6 +102,12 @@ interface IDefifaGovernor {
     /// @return weight The attestation weight applied.
     function attestToScorecardFrom(uint256 gameId, uint256 scorecardId) external returns (uint256 weight);
 
+    /// @notice Initialize a game's governance parameters.
+    /// @param gameId The ID of the game.
+    /// @param attestationStartTime The timestamp when attestation begins.
+    /// @param attestationGracePeriod The grace period duration in seconds.
+    function initializeGame(uint256 gameId, uint256 attestationStartTime, uint256 attestationGracePeriod) external;
+
     /// @notice Ratify a scorecard that has reached quorum.
     /// @param gameId The ID of the game.
     /// @param tierWeights The tier cash out weights (must match the scorecard).
@@ -130,4 +118,15 @@ interface IDefifaGovernor {
     )
         external
         returns (uint256);
+
+    /// @notice Submit a scorecard for attestation.
+    /// @param gameId The ID of the game.
+    /// @param tierWeights The tier cash out weights.
+    /// @return The scorecard ID.
+    function submitScorecardFor(
+        uint256 gameId,
+        DefifaTierCashOutWeight[] calldata tierWeights
+    )
+        external
+        returns (uint256);
 }

package/src/interfaces/IDefifaHook.sol

@@ -1,15 +1,16 @@
 // SPDX-License-Identifier: MIT
-pragma solidity 0.8.26;
+pragma solidity ^0.8.0;
 
-import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
-import {IJBRulesets} from "@bananapus/core-v6/src/interfaces/IJBRulesets.sol";
 import {IJB721Hook} from "@bananapus/721-hook-v6/src/interfaces/IJB721Hook.sol";
 import {IJB721TiersHookStore} from "@bananapus/721-hook-v6/src/interfaces/IJB721TiersHookStore.sol";
 import {IJB721TokenUriResolver} from "@bananapus/721-hook-v6/src/interfaces/IJB721TokenUriResolver.sol";
-import {JB721TiersMintReservesConfig} from "@bananapus/721-hook-v6/src/structs/JB721TiersMintReservesConfig.sol";
 import {JB721TierConfig} from "@bananapus/721-hook-v6/src/structs/JB721TierConfig.sol";
-import {DefifaTierCashOutWeight} from "./../structs/DefifaTierCashOutWeight.sol";
-import {DefifaDelegation} from "./../structs/DefifaDelegation.sol";
+import {JB721TiersMintReservesConfig} from "@bananapus/721-hook-v6/src/structs/JB721TiersMintReservesConfig.sol";
+import {IJBRulesets} from "@bananapus/core-v6/src/interfaces/IJBRulesets.sol";
+import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
+
+import {DefifaDelegation} from "../structs/DefifaDelegation.sol";
+import {DefifaTierCashOutWeight} from "../structs/DefifaTierCashOutWeight.sol";
 import {IDefifaGamePhaseReporter} from "./IDefifaGamePhaseReporter.sol";
 import {IDefifaGamePotReporter} from "./IDefifaGamePotReporter.sol";
 
@@ -40,47 +41,52 @@ interface IDefifaHook is IJB721Hook {
 
     event TierCashOutWeightsSet(DefifaTierCashOutWeight[] tierWeights, address caller);
 
-    /// @notice The total cash out weight used to normalize tier cash out weights.
-    /// @return The total cash out weight.
-    function TOTAL_CASHOUT_WEIGHT() external view returns (uint256);
-
-    /// @notice The Defifa project token used for token allocations.
-    /// @return The Defifa ERC-20 token.
-    function defifaToken() external view returns (IERC20);
+    /// @notice The total amount redeemed from this game (refunds not counted).
+    /// @return The total redeemed amount.
+    function amountRedeemed() external view returns (uint256);
 
     /// @notice The base protocol token used for token allocations.
     /// @return The base protocol ERC-20 token.
-    function baseProtocolToken() external view returns (IERC20);
+    function BASE_PROTOCOL_TOKEN() external view returns (IERC20);
+
+    /// @notice The base URI for token metadata.
+    /// @return The base URI string.
+    function baseURI() external view returns (string memory);
+
+    /// @notice Whether the cash out weights have been set by the game's governor.
+    /// @return True if cash out weights are set.
+    function cashOutWeightIsSet() external view returns (bool);
 
     /// @notice The cash out weight of a specific token based on its tier's scorecard weight.
     /// @param tokenId The token ID to look up.
     /// @return The cash out weight.
     function cashOutWeightOf(uint256 tokenId) external view returns (uint256);
 
-    /// @notice The cash out weights for all tiers (up to 128).
-    /// @return The array of tier cash out weights.
-    function tierCashOutWeights() external view returns (uint256[128] memory);
-
     /// @notice The address of the code origin contract used as an implementation for clones.
     /// @return The code origin address.
-    function codeOrigin() external view returns (address);
+    function CODE_ORIGIN() external view returns (address);
 
-    /// @notice Whether the cash out weights have been set by the game's governor.
-    /// @return True if cash out weights are set.
-    function cashOutWeightIsSet() external view returns (bool);
+    /// @notice The contract-level metadata URI.
+    /// @return The contract URI string.
+    function contractURI() external view returns (string memory);
 
     /// @notice The current supply of a specific tier.
     /// @param tierId The ID of the tier.
     /// @return The current supply.
     function currentSupplyOfTier(uint256 tierId) external view returns (uint256);
 
-    /// @notice The 721 tiers hook store used by this hook.
-    /// @return The store contract.
-    function store() external view returns (IJB721TiersHookStore);
+    /// @notice The default attestation delegate for new token holders.
+    /// @return The default delegate address.
+    function defaultAttestationDelegate() external view returns (address);
 
-    /// @notice The rulesets contract used by this hook.
-    /// @return The rulesets contract.
-    function rulesets() external view returns (IJBRulesets);
+    /// @notice The Defifa project token used for token allocations.
+    /// @return The Defifa ERC-20 token.
+    function DEFIFA_TOKEN() external view returns (IERC20);
+
+    /// @notice The first owner of a given token ID.
+    /// @param tokenId The token ID.
+    /// @return The address of the first owner.
+    function firstOwnerOf(uint256 tokenId) external view returns (address);
 
     /// @notice The game phase reporter for this hook.
     /// @return The game phase reporter contract.
@@ -90,57 +96,6 @@ interface IDefifaHook is IJB721Hook {
     /// @return The game pot reporter contract.
     function gamePotReporter() external view returns (IDefifaGamePotReporter);
 
-    /// @notice The total amount redeemed from this game (refunds not counted).
-    /// @return The total redeemed amount.
-    function amountRedeemed() external view returns (uint256);
-
-    /// @notice The token allocations (Defifa token amount, base protocol token amount).
-    /// @return The Defifa token allocation and the base protocol token allocation.
-    function tokenAllocations() external view returns (uint256, uint256);
-
-    /// @notice The name of a specific tier.
-    /// @param tierId The ID of the tier.
-    /// @return The tier name.
-    function tierNameOf(uint256 tierId) external view returns (string memory);
-
-    /// @notice The number of tokens redeemed from a specific tier.
-    /// @param tierId The tier ID.
-    /// @return The number of tokens redeemed.
-    function tokensRedeemedFrom(uint256 tierId) external view returns (uint256);
-
-    /// @notice The pricing currency used by this hook.
-    /// @return The currency identifier.
-    function pricingCurrency() external view returns (uint256);
-
-    /// @notice The first owner of a given token ID.
-    /// @param tokenId The token ID.
-    /// @return The address of the first owner.
-    function firstOwnerOf(uint256 tokenId) external view returns (address);
-
-    /// @notice The base URI for token metadata.
-    /// @return The base URI string.
-    function baseURI() external view returns (string memory);
-
-    /// @notice The contract-level metadata URI.
-    /// @return The contract URI string.
-    function contractURI() external view returns (string memory);
-
-    /// @notice The default attestation delegate for new token holders.
-    /// @return The default delegate address.
-    function defaultAttestationDelegate() external view returns (address);
-
-    /// @notice Get the delegate for a specific account and tier.
-    /// @param account The account to look up.
-    /// @param tier The tier ID.
-    /// @return The delegate address.
-    function getTierDelegateOf(address account, uint256 tier) external view returns (address);
-
-    /// @notice Get the attestation units for a specific account and tier.
-    /// @param account The account to look up.
-    /// @param tier The tier ID.
-    /// @return The number of attestation units.
-    function getTierAttestationUnitsOf(address account, uint256 tier) external view returns (uint256);
-
     /// @notice Get the attestation units for a specific account and tier at a past timestamp.
     /// @param account The account to look up.
     /// @param tier The tier ID.
@@ -155,43 +110,67 @@ interface IDefifaHook is IJB721Hook {
         view
         returns (uint256);
 
-    /// @notice Get the total attestation units for a specific tier.
-    /// @param tier The tier ID.
-    /// @return The total attestation units.
-    function getTierTotalAttestationUnitsOf(uint256 tier) external view returns (uint256);
-
     /// @notice Get the total attestation units for a tier at a past timestamp.
     /// @param tier The tier ID.
     /// @param timestamp The historical timestamp.
     /// @return The total attestation units at that time.
     function getPastTierTotalAttestationUnitsOf(uint256 tier, uint48 timestamp) external view returns (uint256);
 
+    /// @notice Get the attestation units for a specific account and tier.
+    /// @param account The account to look up.
+    /// @param tier The tier ID.
+    /// @return The number of attestation units.
+    function getTierAttestationUnitsOf(address account, uint256 tier) external view returns (uint256);
+
+    /// @notice Get the delegate for a specific account and tier.
+    /// @param account The account to look up.
+    /// @param tier The tier ID.
+    /// @return The delegate address.
+    function getTierDelegateOf(address account, uint256 tier) external view returns (address);
+
+    /// @notice Get the total attestation units for a specific tier.
+    /// @param tier The tier ID.
+    /// @return The total attestation units.
+    function getTierTotalAttestationUnitsOf(uint256 tier) external view returns (uint256);
+
+    /// @notice The pricing currency used by this hook.
+    /// @return The currency identifier.
+    function pricingCurrency() external view returns (uint256);
+
+    /// @notice The rulesets contract used by this hook.
+    /// @return The rulesets contract.
+    function rulesets() external view returns (IJBRulesets);
+
+    /// @notice The 721 tiers hook store used by this hook.
+    /// @return The store contract.
+    function store() external view returns (IJB721TiersHookStore);
+
+    /// @notice The cash out weights for all tiers (up to 128).
+    /// @return The array of tier cash out weights.
+    function tierCashOutWeights() external view returns (uint256[128] memory);
+
+    /// @notice The name of a specific tier.
+    /// @param tierId The ID of the tier.
+    /// @return The tier name.
+    function tierNameOf(uint256 tierId) external view returns (string memory);
+
+    /// @notice The token allocations (Defifa token amount, base protocol token amount).
+    /// @return The Defifa token allocation and the base protocol token allocation.
+    function tokenAllocations() external view returns (uint256, uint256);
+
     /// @notice Get the claimable Defifa and base protocol tokens for a set of token IDs.
     /// @param tokenIds The token IDs to check.
     /// @return The claimable Defifa token amount and base protocol token amount.
     function tokensClaimableFor(uint256[] memory tokenIds) external view returns (uint256, uint256);
 
-    /// @notice Set the attestation delegate for a specific tier.
-    /// @param delegatee The address to delegate to.
+    /// @notice The number of tokens redeemed from a specific tier.
     /// @param tierId The tier ID.
-    function setTierDelegateTo(address delegatee, uint256 tierId) external;
-
-    /// @notice Set attestation delegates for multiple tiers at once.
-    /// @param delegations The delegation assignments.
-    function setTierDelegatesTo(DefifaDelegation[] memory delegations) external;
-
-    /// @notice Set the cash out weights for tiers. Only callable by the game's governor (owner).
-    /// @param tierWeights The tier cash out weights to set.
-    function setTierCashOutWeightsTo(DefifaTierCashOutWeight[] memory tierWeights) external;
-
-    /// @notice Mint reserved tokens for multiple tiers.
-    /// @param mintReservesForTiersData The configuration for which tiers to mint reserves for.
-    function mintReservesFor(JB721TiersMintReservesConfig[] memory mintReservesForTiersData) external;
+    /// @return The number of tokens redeemed.
+    function tokensRedeemedFrom(uint256 tierId) external view returns (uint256);
 
-    /// @notice Mint reserved tokens for a specific tier.
-    /// @param tierId The tier ID to mint reserves for.
-    /// @param count The number of reserved tokens to mint.
-    function mintReservesFor(uint256 tierId, uint256 count) external;
+    /// @notice The total cash out weight used to normalize tier cash out weights.
+    /// @return The total cash out weight.
+    function TOTAL_CASHOUT_WEIGHT() external view returns (uint256);
 
     /// @notice Initialize the hook with game-specific configuration.
     /// @param gameId The ID of the game.
@@ -225,4 +204,26 @@ interface IDefifaHook is IJB721Hook {
         string[] memory tierNames
     )
         external;
+
+    /// @notice Mint reserved tokens for multiple tiers.
+    /// @param mintReservesForTiersData The configuration for which tiers to mint reserves for.
+    function mintReservesFor(JB721TiersMintReservesConfig[] memory mintReservesForTiersData) external;
+
+    /// @notice Mint reserved tokens for a specific tier.
+    /// @param tierId The tier ID to mint reserves for.
+    /// @param count The number of reserved tokens to mint.
+    function mintReservesFor(uint256 tierId, uint256 count) external;
+
+    /// @notice Set the cash out weights for tiers. Only callable by the game's governor (owner).
+    /// @param tierWeights The tier cash out weights to set.
+    function setTierCashOutWeightsTo(DefifaTierCashOutWeight[] memory tierWeights) external;
+
+    /// @notice Set the attestation delegate for a specific tier.
+    /// @param delegatee The address to delegate to.
+    /// @param tierId The tier ID.
+    function setTierDelegateTo(address delegatee, uint256 tierId) external;
+
+    /// @notice Set attestation delegates for multiple tiers at once.
+    /// @param delegations The delegation assignments.
+    function setTierDelegatesTo(DefifaDelegation[] memory delegations) external;
 }

package/src/interfaces/IDefifaTokenUriResolver.sol

@@ -1,8 +1,8 @@
 // SPDX-License-Identifier: MIT
-pragma solidity 0.8.26;
+pragma solidity ^0.8.0;
 
 import {ITypeface} from "lib/typeface/contracts/interfaces/ITypeface.sol";
 
 interface IDefifaTokenUriResolver {
-    function typeface() external view returns (ITypeface);
+    function TYPEFACE() external view returns (ITypeface);
 }

package/src/libraries/DefifaFontImporter.sol

@@ -1,19 +1,21 @@
 // SPDX-License-Identifier: MIT
-pragma solidity 0.8.26;
+pragma solidity ^0.8.17;
 
 import {ITypeface, Font} from "lib/typeface/contracts/interfaces/ITypeface.sol";
 
 /// @notice Summon fonts.
 library DefifaFontImporter {
-    // @notice Gets the Base64 encoded Capsules-500.otf typeface
-    /// @return The Base64 encoded font file
-    function getSkinnyFontSource(ITypeface _typeface) internal view returns (bytes memory) {
-        return _typeface.sourceOf(Font(500, "normal")); // Capsules font source
+    /// @notice Gets the Base64 encoded Capsules-500.otf typeface.
+    /// @param typeface The typeface contract to query.
+    /// @return The Base64 encoded font file.
+    function getSkinnyFontSource(ITypeface typeface) internal view returns (bytes memory) {
+        return typeface.sourceOf(Font({weight: 500, style: "normal"})); // Capsules font source
     }
 
-    // @notice Gets the Base64 encoded Capsules-500.otf typeface
-    /// @return The Base64 encoded font file
-    function getBeefyFontSource(ITypeface _typeface) internal view returns (bytes memory) {
-        return _typeface.sourceOf(Font(700, "normal")); // Capsules font source
+    /// @notice Gets the Base64 encoded Capsules-700.otf typeface.
+    /// @param typeface The typeface contract to query.
+    /// @return The Base64 encoded font file.
+    function getBeefyFontSource(ITypeface typeface) internal view returns (bytes memory) {
+        return typeface.sourceOf(Font({weight: 700, style: "normal"})); // Capsules font source
     }
 }