@ballkidz/defifa 0.0.1

package/foundry.lock

@@ -0,0 +1,17 @@
+{
+  "lib/base64": {
+    "branch": {
+      "name": "v1.1.0",
+      "rev": "dcbf852ba545b3d15de0ac0ef88dce934c090c8e"
+    }
+  },
+  "lib/capsules": {
+    "rev": "7432ba95ac69ba4902076660b0dc9a90aeb26706"
+  },
+  "lib/forge-std": {
+    "rev": "8bbcf6e3f8f62f419e5429a0bd89331c85c37824"
+  },
+  "lib/typeface": {
+    "rev": "edd52e2f7c8adc44e75b207bd279710f9b72f5e9"
+  }
+}

package/foundry.toml

@@ -0,0 +1,35 @@
+[profile.default]
+solc = '0.8.26'
+evm_version = 'paris'
+src = 'src'
+out = 'out'
+test = 'test'
+libs = ["node_modules", "lib"]
+optimizer_runs = 200
+via-ir = true
+build_info = true
+extra_output = ['storageLayout']
+fs_permissions = [{ access = "read-write", path = "./"}]
+
+[rpc_endpoints]
+ethereum = "${RPC_ETHEREUM_MAINNET}"
+optimism = "${RPC_OPTIMISM_MAINNET}"
+arbitrum = "${RPC_ARBITRUM_MAINNET}"
+base = "${RPC_BASE_MAINNET}"
+arbitrum_sepolia = "${RPC_ARBITRUM_SEPOLIA}"
+ethereum_sepolia = "${RPC_ETHEREUM_SEPOLIA}"
+optimism_sepolia = "${RPC_OPTIMISM_SEPOLIA}"
+base_sepolia = "${RPC_BASE_SEPOLIA}"
+
+[invariant]
+runs = 256
+depth = 50
+fail_on_revert = false
+
+[lint]
+lint_on_build = false
+
+[fmt]
+number_underscore = "thousands"
+multiline_func_header = "all"
+wrap_comments = true

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@ballkidz/defifa",
+  "version": "0.0.1",
+  "license": "MIT",
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "bugs": {
+    "url": "https://github.com/BallKidz/defifa-collection-deployer/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/BallKidz/defifa-collection-deployer"
+  },
+  "dependencies": {
+    "@bananapus/721-hook-v6": "^0.0.8",
+    "@bananapus/address-registry-v6": "^0.0.3",
+    "@bananapus/core-v6": "^0.0.6",
+    "@bananapus/permission-ids-v6": "^0.0.3",
+    "@openzeppelin/contracts": "5.2.0",
+    "@prb/math": "^4.1.1",
+    "scripty.sol": "^2.1.1"
+  },
+  "devDependencies": {
+    "@sphinx-labs/plugins": "^0.33.1"
+  },
+  "scripts": {
+    "test": "forge test",
+    "coverage": "forge coverage",
+    "deploy:mainnets": "source ./.env && npx sphinx propose ./script/Deploy.s.sol --networks mainnets",
+    "deploy:testnets": "source ./.env && npx sphinx propose ./script/Deploy.s.sol --networks testnets"
+  }
+}

package/remappings.txt

@@ -0,0 +1,6 @@
+@openzeppelin/=node_modules/@openzeppelin/
+@prb/math/=node_modules/@prb/math/
+@bananapus/=node_modules/@bananapus/
+@sphinx-labs/contracts/=node_modules/@sphinx-labs/contracts/contracts/foundry/
+forge-std/=lib/forge-std/src/
+scripty.sol/=node_modules/scripty.sol/

package/script/Deploy.s.sol

@@ -0,0 +1,109 @@
+// SPDX-License-Identifier: MIT
+pragma solidity 0.8.26;
+
+import {Script} from "forge-std/Script.sol";
+import {ITypeface} from "lib/typeface/contracts/interfaces/ITypeface.sol";
+import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
+import {DefifaHook} from "../src/DefifaHook.sol";
+import {DefifaDeployer} from "../src/DefifaDeployer.sol";
+import {DefifaGovernor} from "../src/DefifaGovernor.sol";
+import {DefifaProjectOwner} from "../src/DefifaProjectOwner.sol";
+import {DefifaTokenUriResolver} from "../src/DefifaTokenUriResolver.sol";
+import {Sphinx} from "@sphinx-labs/contracts/SphinxPlugin.sol";
+
+import {CoreDeployment, CoreDeploymentLib} from "@bananapus/core-v6/script/helpers/CoreDeploymentLib.sol";
+import {
+    AddressRegistryDeployment,
+    AddressRegistryDeploymentLib
+} from "@bananapus/address-registry-v6/script/helpers/AddressRegistryDeploymentLib.sol";
+
+contract DeployMainnet is Script, Sphinx {
+    /// @notice tracks the deployment of the core contracts for the chain we are deploying to.
+    CoreDeployment core;
+    /// @notice tracks the deployment of the address registry for the chain we are deploying to.
+    AddressRegistryDeployment registry;
+
+    // NOTE: This id is revnet, this is temporary until we have a defifa revnet.
+    uint256 _defifaProjectId = 3;
+    uint256 _baseProtocolProjectId = 1;
+
+    bytes32 _salt = bytes32(keccak256("0.0.2"));
+
+    ITypeface _typeface = ITypeface(0xA77b7D93E79f1E6B4f77FaB29d9ef85733A3D44A);
+
+    IERC20 defifaToken;
+    IERC20 baseProtocolToken;
+
+    function configureSphinx() public override {
+        sphinxConfig.projectName = "defifa-v5";
+        sphinxConfig.mainnets = ["ethereum", "optimism", "base", "arbitrum"];
+        sphinxConfig.testnets = ["ethereum_sepolia", "optimism_sepolia", "base_sepolia", "arbitrum_sepolia"];
+    }
+
+    function run() external {
+        // Get the deployment addresses for the nana CORE for this chain.
+        // We want to do this outside of the `sphinx` modifier.
+        core = CoreDeploymentLib.getDeployment(
+            vm.envOr("NANA_CORE_DEPLOYMENT_PATH", string("node_modules/@bananapus/core-v6/deployments/"))
+        );
+
+        registry = AddressRegistryDeploymentLib.getDeployment(
+            vm.envOr(
+                "NANA_ADDRESS_REGISTRY_DEPLOYMENT_PATH",
+                string("node_modules/@bananapus/address-registry-v6/deployments/")
+            )
+        );
+
+        defifaToken = IERC20(address(core.tokens.tokenOf(_defifaProjectId)));
+        baseProtocolToken = IERC20(address(core.tokens.tokenOf(_baseProtocolProjectId)));
+
+        if (defifaToken == IERC20(address(0))) {
+            revert("Defifa token is invalid, does this project id exist?");
+        }
+
+        if (baseProtocolToken == IERC20(address(0))) {
+            revert("Base protocol token is invalid, does this project id exist?");
+        }
+
+        // Sepolia.
+        if (block.chainid == 11_155_111) {
+            _typeface = ITypeface(0x8C420d3388C882F40d263714d7A6e2c8DB93905F);
+
+            // Optimism sepolia.
+        } else if (block.chainid == 11_155_420) {
+            _typeface = ITypeface(0xe160e47928907894F97a0DC025c61D64E862fEAa);
+
+            // Base sepolia.
+        } else if (block.chainid == 84_532) {
+            _typeface = ITypeface(0xEb269d9F0850CEf5e3aB0F9718fb79c466720784);
+
+            // Arb sepolia.
+        } else if (block.chainid == 421_614) {
+            _typeface = ITypeface(0x431C35e9fA5152A906A38390910d0Cfcba0Fb43b);
+        }
+
+        // Check that the typeface is set and that the address contains code.
+        require(address(_typeface) != address(0), "Typeface address is not configured for this chain");
+        require(address(_typeface).code.length > 0, "Typeface address is not deployed to this address for this chain");
+
+        // Perform the deployment transactions.
+        deploy();
+    }
+
+    function deploy() public sphinx {
+        DefifaHook hook = new DefifaHook{salt: _salt}(core.directory, defifaToken, 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
+        );
+
+        governor.transferOwnership(address(deployer));
+    }
+}

package/script/helpers/DefifaDeploymentLib.sol

@@ -0,0 +1,83 @@
+// SPDX-License-Identifier: MIT
+pragma solidity 0.8.26;
+
+import {stdJson} from "forge-std/Script.sol";
+import {Vm} from "forge-std/Vm.sol";
+
+import {DefifaHook} from "../../src/DefifaHook.sol";
+import {DefifaDeployer} from "../../src/DefifaDeployer.sol";
+import {DefifaGovernor} from "../../src/DefifaGovernor.sol";
+import {DefifaTokenUriResolver} from "../../src/DefifaTokenUriResolver.sol";
+
+import {SphinxConstants, NetworkInfo} from "@sphinx-labs/contracts/SphinxConstants.sol";
+
+struct DefifaDeployment {
+    DefifaHook hook;
+    DefifaDeployer deployer;
+    DefifaGovernor governor;
+    DefifaTokenUriResolver tokenUriResolver;
+}
+
+library DefifaDeploymentLib {
+    // Cheat code address, 0x7109709ECfa91a80626fF3989D68f67F5b1DD12D.
+    address internal constant VM_ADDRESS = address(uint160(uint256(keccak256("hevm cheat code"))));
+    Vm internal constant vm = Vm(VM_ADDRESS);
+    string constant PROJECT_NAME = "defifa-v5";
+
+    function getDeployment(string memory path) internal returns (DefifaDeployment memory deployment) {
+        // Get chainId for which we need to get the deployment.
+        uint256 chainId = block.chainid;
+
+        // Deploy to get the constants.
+        SphinxConstants sphinxConstants = new SphinxConstants();
+        NetworkInfo[] memory networks = sphinxConstants.getNetworkInfoArray();
+
+        for (uint256 _i; _i < networks.length; _i++) {
+            if (networks[_i].chainId == chainId) {
+                return getDeployment(path, networks[_i].name);
+            }
+        }
+
+        revert("ChainID is not (currently) supported by Sphinx.");
+    }
+
+    function getDeployment(
+        string memory path,
+        string memory network_name
+    )
+        internal
+        view
+        returns (DefifaDeployment memory deployment)
+    {
+        deployment.hook = DefifaHook(_getDeploymentAddress(path, PROJECT_NAME, network_name, "DefifaHook"));
+
+        deployment.deployer = DefifaDeployer(_getDeploymentAddress(path, PROJECT_NAME, network_name, "DefifaDeployer"));
+
+        deployment.governor = DefifaGovernor(_getDeploymentAddress(path, PROJECT_NAME, network_name, "DefifaGovernor"));
+
+        deployment.tokenUriResolver =
+            DefifaTokenUriResolver(_getDeploymentAddress(path, PROJECT_NAME, network_name, "DefifaTokenUriResolver"));
+    }
+
+    /// @notice Get the address of a contract that was deployed by the Deploy script.
+    /// @dev Reverts if the contract was not found.
+    /// @param path The path to the deployment file.
+    /// @param project_name The name of the project.
+    /// @param network_name The name of the network.
+    /// @param contractName The name of the contract to get the address of.
+    /// @return The address of the contract.
+    function _getDeploymentAddress(
+        string memory path,
+        string memory project_name,
+        string memory network_name,
+        string memory contractName
+    )
+        internal
+        view
+        returns (address)
+    {
+        string memory deploymentJson =
+            vm.readFile(string.concat(path, project_name, "/", network_name, "/", contractName, ".json"));
+        return stdJson.readAddress(deploymentJson, ".address");
+    }
+}

package/slither-ci.config.json

@@ -0,0 +1,10 @@
+{
+  "detectors_to_exclude": "timestamp,uninitialized-local,naming-convention,solc-version,shadowing-local",
+  "exclude_informational": true,
+  "exclude_low": false,
+  "exclude_medium": false,
+  "exclude_high": false,
+  "disable_color": false,
+  "filter_paths": "(mocks/|test/|node_modules/|lib/)",
+  "legacy_ast": false
+}