use prettier formatter

.prettierignore

@@ -0,0 +1,7 @@
+# Ignore artifacts:
+lib
+out
+broadcast
+cache
+
+src/interfaces/external

.prettierrc

@@ -0,0 +1,16 @@
+{
+    "printWidth": 100,
+    "tabWidth": 4,
+    "singleQuote": true,
+    "overrides": [
+        {
+            "files": "*.sol",
+            "options": {
+                "semi": false,
+                "printWidth": 120,
+                "tabWidth": 4,
+                "singleQuote": false
+            }
+        }
+    ]
+}

foundry.toml

@@ -12,4 +12,17 @@ mainnet = "${ALCHEMY_ETH_API_URL}"
 goerli = "${GOERLI_RPC_URL}" 
 sepolia = "${SEPOLIA_RPC_URL}" 
 
-# See more config options https://github.com/foundry-rs/foundry/tree/master/config
+# See more config options https://github.com/foundry-rs/foundry/tree/master/config
+
+# NOTE Project is using prettier formatting, as opposed to forge.
+# See more format options https://book.getfoundry.sh/reference/config/formatter
+# [fmt]
+# line_length = 120
+# tab_width = 4
+# bracket_spacing = false
+# int_types = "long"
+# # If function parameters are multiline then always put the function attributes on separate lines
+# func_attrs_with_params_multiline = false
+# multiline_func_header = "params_first"
+# quote_style = "double"
+# number_underscore = "thousands"

src/Bookkeeper.sol

@@ -46,14 +46,14 @@ contract Bookkeeper is Tractor, ReentrancyGuard {
     event LiquidationKicked(address liquidator, address position);
 
     constructor() Tractor(PROTOCOL_NAME, PROTOCOL_VERSION) {}
+
     // receive() external {}
     // fallback() external {}
 
-    function fillOrder(Fill calldata fill, SignedBlueprint calldata orderBlueprint)
-        external
-        nonReentrant
-        verifySignature(orderBlueprint)
-    {
+    function fillOrder(
+        Fill calldata fill,
+        SignedBlueprint calldata orderBlueprint
+    ) external nonReentrant verifySignature(orderBlueprint) {
         // decode order blueprint data and ensure blueprint metadata is valid pairing with embedded data
         (bytes1 blueprintDataType, bytes memory blueprintData) = unpackDataField(orderBlueprint.blueprint.data);
         require(uint8(blueprintDataType) == uint8(BlueprintDataType.ORDER), "BKDTMM");
@@ -78,24 +78,28 @@ contract Bookkeeper is Tractor, ReentrancyGuard {
 
         Agreement memory agreement = _agreementFromOrder(fill, order);
 
-        uint256 loanValue =
-            IOracle(agreement.loanOracle.addr).getResistantValue(agreement.loanAmount, agreement.loanOracle.parameters);
+        uint256 loanValue = IOracle(agreement.loanOracle.addr).getResistantValue(
+            agreement.loanAmount,
+            agreement.loanOracle.parameters
+        );
         uint256 collateralValue;
 
         if (order.isOffer) {
             agreement.lenderAccount = order.account;
             agreement.borrowerAccount = fill.account;
-            collateralValue = loanValue * fill.borrowerConfig.initCollateralRatio / C.RATIO_FACTOR;
+            collateralValue = (loanValue * fill.borrowerConfig.initCollateralRatio) / C.RATIO_FACTOR;
             agreement.position.parameters = fill.borrowerConfig.positionParameters;
         } else {
             agreement.lenderAccount = fill.account;
             agreement.borrowerAccount = order.account;
-            collateralValue = loanValue * order.borrowerConfig.initCollateralRatio / C.RATIO_FACTOR;
+            collateralValue = (loanValue * order.borrowerConfig.initCollateralRatio) / C.RATIO_FACTOR;
             agreement.position.parameters = order.borrowerConfig.positionParameters;
         }
         console.log("agreement coll value: %s", collateralValue);
-        agreement.collAmount =
-            IOracle(agreement.collOracle.addr).getResistantAmount(collateralValue, agreement.collOracle.parameters);
+        agreement.collAmount = IOracle(agreement.collOracle.addr).getResistantAmount(
+            collateralValue,
+            agreement.collOracle.parameters
+        );
         console.log("agreement coll amount: %s", agreement.collAmount);
         // Set Position data that cannot be computed off chain by caller.
         agreement.deploymentTime = block.timestamp;
@@ -113,15 +117,13 @@ contract Bookkeeper is Tractor, ReentrancyGuard {
     }
 
     // NOTE CEI?
-    function exitPosition(SignedBlueprint calldata agreementBlueprint)
-        external
-        payable
-        nonReentrant
-        verifySignature(agreementBlueprint)
-    {
+    function exitPosition(
+        SignedBlueprint calldata agreementBlueprint
+    ) external payable nonReentrant verifySignature(agreementBlueprint) {
         (bytes1 blueprintDataType, bytes memory blueprintData) = unpackDataField(agreementBlueprint.blueprint.data);
         require(
-            blueprintDataType == bytes1(uint8(BlueprintDataType.AGREEMENT)), "Bookkeeper: Invalid blueprint data type"
+            blueprintDataType == bytes1(uint8(BlueprintDataType.AGREEMENT)),
+            "Bookkeeper: Invalid blueprint data type"
         );
         Agreement memory agreement = abi.decode(blueprintData, (Agreement));
         require(
@@ -141,11 +143,14 @@ contract Bookkeeper is Tractor, ReentrancyGuard {
         if (LibUtils.isValidLoanAssetAsCost(agreement.loanAsset, costAsset)) {
             lenderOwed += cost;
             distributeValue = msg.value;
-        } // If cost in eth but loan asset is not eth.
+        }
+        // If cost in eth but loan asset is not eth.
         else if (costAsset.standard == ETH_STANDARD) {
             require(msg.value == cost, "exitPosition: msg.value mismatch from Eth denoted cost");
             IAccount(agreement.lenderAccount.addr).loadFromPosition{value: msg.value}(
-                costAsset, cost, agreement.lenderAccount.parameters
+                costAsset,
+                cost,
+                agreement.lenderAccount.parameters
             );
         } else {
             revert("exitPosition: isLiquidatable: invalid cost asset");
@@ -155,18 +160,18 @@ contract Bookkeeper is Tractor, ReentrancyGuard {
         position.distribute{value: distributeValue}(msg.sender, lenderOwed, agreement);
 
         IAccount(agreement.borrowerAccount.addr).unlockCollateral(
-            agreement.collAsset, agreement.collAmount, agreement.borrowerAccount.parameters
+            agreement.collAsset,
+            agreement.collAmount,
+            agreement.borrowerAccount.parameters
         );
 
         // Marks position as closed from Bookkeeper pov.
         position.transferContract(msg.sender);
     }
 
-    function kick(SignedBlueprint calldata agreementBlueprint)
-        external
-        nonReentrant
-        verifySignature(agreementBlueprint)
-    {
+    function kick(
+        SignedBlueprint calldata agreementBlueprint
+    ) external nonReentrant verifySignature(agreementBlueprint) {
         (, bytes memory blueprintData) = unpackDataField(agreementBlueprint.blueprint.data);
         // require(blueprintDataType == bytes1(uint8(BlueprintDataType.AGREEMENT)), "BKKIBDT"); // decoding will fail
         Agreement memory agreement = abi.decode(blueprintData, (Agreement));
@@ -205,19 +210,22 @@ contract Bookkeeper is Tractor, ReentrancyGuard {
         // NOTE lots of gas savings if collateral can be kept in borrower account until absolutely necessary.
         console.log("locking %s of %s as collateral", agreement.collAmount, agreement.collAsset.addr);
         IAccount(agreement.borrowerAccount.addr).lockCollateral(
-            agreement.collAsset, agreement.collAmount, agreement.borrowerAccount.parameters
+            agreement.collAsset,
+            agreement.collAmount,
+            agreement.borrowerAccount.parameters
         );
         IPosition(agreement.position.addr).deploy(
-            agreement.loanAsset, agreement.loanAmount, agreement.position.parameters
+            agreement.loanAsset,
+            agreement.loanAmount,
+            agreement.position.parameters
         );
     }
 
     /// @dev assumes compatibility between match, offer, and request already verified.
-    function _agreementFromOrder(Fill calldata fill, Order memory order)
-        private
-        pure
-        returns (Agreement memory agreement)
-    {
+    function _agreementFromOrder(
+        Fill calldata fill,
+        Order memory order
+    ) private pure returns (Agreement memory agreement) {
         // NOTE MAKE CHECKS FOR VALIDITY
 
         // NOTE this is prly not gas efficient bc of zero -> non-zero changes...
@@ -241,8 +249,10 @@ contract Bookkeeper is Tractor, ReentrancyGuard {
     function _signAgreement(Agreement memory agreement) private returns (SignedBlueprint memory signedBlueprint) {
         // Create blueprint to store signed Agreement off chain via events.
         signedBlueprint.blueprint.publisher = address(this);
-        signedBlueprint.blueprint.data =
-            packDataField(bytes1(uint8(BlueprintDataType.AGREEMENT)), abi.encode(agreement));
+        signedBlueprint.blueprint.data = packDataField(
+            bytes1(uint8(BlueprintDataType.AGREEMENT)),
+            abi.encode(agreement)
+        );
         signedBlueprint.blueprint.endTime = type(uint256).max;
         signedBlueprint.blueprintHash = getBlueprintHash(signedBlueprint.blueprint);
         // NOTE: Security: Is is possible to intentionally manufacture a blueprint with different data that creates the same hash?

src/README.md

@@ -20,6 +20,15 @@ https://fravoll.github.io/solidity-patterns/pull_over_push.html
 
 - What are Pharos invariants?
 https://www.nascent.xyz/idea/youre-writing-require-statements-wrong
+
+## Temporary Security Limitations
+In order to ensure a more secure launch, Pharos will limit some early functionality. This provides us more time to
+test, audit, and improve some of the elements that are most novel.
+
+- Testnet / L2 testing will have agreement size limitations.
+- Permissionless use of 3rd party modules will be disabled.
+- Direct interaction with Position protocol wrappers will not be implemented.
+
 ### Core: 
 
 ### Entity-Centric

src/interfaces/IAccount.sol

@@ -45,11 +45,14 @@ import {Asset} from "src/libraries/LibUtils.sol";
 interface IAccount {
     /// @notice Transfer asset and increment account balance. Pulls asset from sender or uses msg.value.
     function loadFromUser(Asset calldata asset, uint256 amount, bytes calldata parameters) external payable;
+
     /// @notice Transfer asset and increment account balance. Pulls asset from sender or uses msg.value.
     /// @dev Assets may not literally be coming from a position.
     function loadFromPosition(Asset calldata asset, uint256 amount, bytes calldata parameters) external payable;
+
     /// @notice Transfer asset out and decrement account balance. Pushes asset to sender.
     function unloadToUser(Asset calldata asset, uint256 amount, bytes calldata parameters) external;
+
     /// @notice Transfer loan or collateral asset from account to Position MPC. Pushes.
     function unloadToPosition(
         address position,
@@ -60,6 +63,7 @@ interface IAccount {
     ) external;
 
     function lockCollateral(Asset calldata asset, uint256 amount, bytes calldata parameters) external;
+
     function unlockCollateral(Asset calldata asset, uint256 amount, bytes calldata parameters) external;
 
     // NOTE is is possible to (securely) require the owner addr to be the first parameter so that owner can

src/interfaces/IAssessor.sol

@@ -16,9 +16,10 @@ import {Asset} from "src/libraries/LibUtils.sol";
 interface IAssessor {
     /// @notice Returns the cost of a loan (not including principle) and the asset it is denoted in.
     /// @dev Asset must be ETH or ERC20.
-    function getCost(Agreement calldata agreement, uint256 currentAmount)
-        external
-        view
-        returns (Asset memory asset, uint256 amount);
+    function getCost(
+        Agreement calldata agreement,
+        uint256 currentAmount
+    ) external view returns (Asset memory asset, uint256 amount);
+
     function canHandleAsset(Asset calldata asset, bytes calldata parameters) external view returns (bool);
 }

src/interfaces/IBookkeeper.sol

@@ -8,7 +8,10 @@ import {SignedBlueprint} from "lib/tractor/Tractor.sol";
 
 interface IBookkeeper is ITractor {
     function signPublishOrder(Order calldata order, uint256 endTime) external;
+
     function fillOrder(Fill calldata fill, SignedBlueprint calldata orderBlueprint) external;
+
     function exitPosition(SignedBlueprint calldata agreementBlueprint) external payable;
+
     function kick(SignedBlueprint calldata agreementBlueprint) external;
 }

src/interfaces/ILiquidator.sol

@@ -28,8 +28,9 @@ interface ILiquidator {
     /// @notice Handles receipt of a position that the bookkeeper has passed along for liquidation.
     function receiveKick(address kicker, Agreement calldata agreement) external;
 
-    function canHandleAssets(Asset calldata loanAsset, Asset calldata collAsset, bytes calldata parameters)
-        external
-        view
-        returns (bool);
+    function canHandleAssets(
+        Asset calldata loanAsset,
+        Asset calldata collAsset,
+        bytes calldata parameters
+    ) external view returns (bool);
 }

src/interfaces/IPosition.sol

@@ -25,16 +25,19 @@ interface IPosition is IAccessControl {
 
     /// @notice Get current exitable value of the position, denoted in loan asset.
     function getCloseAmount(bytes calldata parameters) external view returns (uint256);
+
     /// @notice Transfer the position to a new controller. Used for liquidations.
     /// @dev Do not set admin role to prevent liquidator from pushing the position back into the protocol.
     function transferContract(address controller) external;
 
     function canHandleAsset(Asset calldata asset, bytes calldata parameters) external pure returns (bool);
+
     /// @notice Pass through function to allow the position to interact with other contracts after liquidation.
     /// @dev Internal functions are not reachable. // NOTE right? bc allowing controller to be set *back* to bookkeeper will open exploits
-    function passThrough(address payable destination, bytes calldata data, bool delegateCall)
-        external
-        payable
-        returns (bool, bytes memory);
+    function passThrough(
+        address payable destination,
+        bytes calldata data,
+        bool delegateCall
+    ) external payable returns (bool, bytes memory);
     // function removeEth(address payable recipient) external // ONLY_ROLE(BOOKKEEPER_ROLE)
 }

src/libraries/LibBookkeeper.sol

@@ -103,20 +103,26 @@ library LibBookkeeper {
         uint256 outstandingValue;
         if (LibUtils.isValidLoanAssetAsCost(agreement.loanAsset, costAsset)) {
             if (cost > exitAmount) return true;
-            outstandingValue =
-                IOracle(agreement.loanOracle.addr).getSpotValue(exitAmount - cost, agreement.loanOracle.parameters);
+            outstandingValue = IOracle(agreement.loanOracle.addr).getSpotValue(
+                exitAmount - cost,
+                agreement.loanOracle.parameters
+            );
         } else if (costAsset.standard == ETH_STANDARD) {
-            uint256 positionValue =
-                IOracle(agreement.loanOracle.addr).getSpotValue(exitAmount, agreement.loanOracle.parameters);
+            uint256 positionValue = IOracle(agreement.loanOracle.addr).getSpotValue(
+                exitAmount,
+                agreement.loanOracle.parameters
+            );
             if (positionValue > cost) return true;
             outstandingValue = positionValue - cost;
         } else {
             revert("isLiquidatable: invalid cost asset");
         }
-        uint256 collValue =
-            IOracle(agreement.collOracle.addr).getSpotValue(agreement.collAmount, agreement.collOracle.parameters);
+        uint256 collValue = IOracle(agreement.collOracle.addr).getSpotValue(
+            agreement.collAmount,
+            agreement.collOracle.parameters
+        );
 
-        uint256 collateralRatio = C.RATIO_FACTOR * outstandingValue / collValue;
+        uint256 collateralRatio = (C.RATIO_FACTOR * outstandingValue) / collValue;
 
         if (collateralRatio < agreement.minCollateralRatio) {
             return true;

src/libraries/LibUniswapV3.sol

@@ -49,8 +49,10 @@ library LibUniswapV3 {
                 (tokenIn, tokenOut, fee) = path.decodeFirstPool();
                 tokens[i] = tokenIn;
                 // console.log("tokenIn: %s, tokenOut: %s, fee: %s", tokenIn, tokenOut, fee);
-                address pool =
-                    PoolAddress.computeAddress(C.UNI_V3_FACTORY, PoolAddress.getPoolKey(tokenIn, tokenOut, fee));
+                address pool = PoolAddress.computeAddress(
+                    C.UNI_V3_FACTORY,
+                    PoolAddress.getPoolKey(tokenIn, tokenOut, fee)
+                );
                 // console.log("pool: %s", pool);
                 // Computation depends on PoolAddress.POOL_INIT_CODE_HASH. Default value in Uni repo may not be correct.
                 ticks[i] = getTWATick(pool, twapTime);
@@ -72,14 +74,17 @@ library LibUniswapV3 {
     /// Get the TWAP of the pool across interval. token1/token0.
     function getTWATick(address pool, uint32 twapTime) internal view returns (int24 arithmeticMeanTick) {
         if (twapTime == 0) {
-            (, arithmeticMeanTick,,,,,) = IUniswapV3PoolState(pool).slot0();
+            (, arithmeticMeanTick, , , , , ) = IUniswapV3PoolState(pool).slot0();
         } else {
             require(LibUtils.isDeployedContract(pool), "Invalid pool, no contract at address");
-            require(OracleLibrary.getOldestObservationSecondsAgo(pool) >= twapTime, "UniV3 pool observations too young"); // ensure needed data is available
+            require(
+                OracleLibrary.getOldestObservationSecondsAgo(pool) >= twapTime,
+                "UniV3 pool observations too young"
+            ); // ensure needed data is available
             // console.log("oldest observation seconds ago: %s", OracleLibrary.getOldestObservationSecondsAgo(pool));
-            (,,, uint16 observationCardinality,,,) = IUniswapV3PoolState(pool).slot0();
+            (, , , uint16 observationCardinality, , , ) = IUniswapV3PoolState(pool).slot0();
             require(observationCardinality >= twapTime / 12, "UniV3 pool cardinality too low"); // shortest case scenario should always cover twap time
-            (arithmeticMeanTick,) = OracleLibrary.consult(pool, twapTime);
+            (arithmeticMeanTick, ) = OracleLibrary.consult(pool, twapTime);
             // console.log("arithmeticMeanTick:");
             // console.logInt(arithmeticMeanTick);
         }

src/libraries/LibUtils.sol

@@ -60,4 +60,3 @@ library LibUtils {
         return true;
     }
 }
-