Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: organize functions #30

Closed
wants to merge 3 commits into from
Closed

chore: organize functions #30

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e25557f
moving functions around
dsshap Mar 5, 2024
8da767d
fmt and snapshot
dsshap Mar 5, 2024
0a6a708
Merge branch 'feature/roles-authority' into chore/organize-functions
dsshap Mar 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
214 changes: 111 additions & 103 deletions src/settled-cash/CrossMarginCashEngine.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,51 +148,60 @@ contract CrossMarginCashEngine is
}

/*///////////////////////////////////////////////////////////////
Override Upgrade Permission
Execute and BatchExecute
//////////////////////////////////////////////////////////////*/

/**
* @dev Upgradable by the owner.
*
* @notice gets access status of an address
* @dev if whitelist address is not set, it ignores this
* @param _address address
*/
function _authorizeUpgrade(address /*newImplementation*/ ) internal view override {
_checkOwner();
function _checkPermissioned(address _address) internal view {
if (!authority.canCall(_address, address(this), msg.sig)) revert NoAccess();
}

/*///////////////////////////////////////////////////////////////
External Functions
//////////////////////////////////////////////////////////////*/

/**
* @notice sets the Collateralizable Mask for a pair of assets
* @param _asset0 the address of the asset 0
* @param _asset1 the address of the asset 1
* @param _value is margin-able
* @notice execute multiple actions on one subAccounts
* @dev also check access of msg.sender
*/
function setCollateralizable(address _asset0, address _asset1, bool _value) external {
_checkOwner();

uint256 collateralId = grappa.assetIds(_asset0);
uint256 mask = 1 << grappa.assetIds(_asset1);

if (_value) collateralizable[collateralId] |= mask;
else collateralizable[collateralId] &= ~mask;

emit CollateralizableSet(_asset0, _asset1, _value);
}
function _execute(address _subAccount, ActionArgs[] calldata actions) internal {
_assertCallerHasAccess(_subAccount);

/**
* @dev check if a pair of assets are collateralizable
*/
function isCollateralizable(address _asset0, address _asset1) external view returns (bool) {
return _isCollateralizable(grappa.assetIds(_asset0), grappa.assetIds(_asset1));
}
// update the account storage and do external calls on the flight
for (uint256 i; i < actions.length;) {
if (actions[i].action == ActionType.AddCollateral) {
_addCollateral(_subAccount, actions[i].data);
} else if (actions[i].action == ActionType.RemoveCollateral) {
_removeCollateral(_subAccount, actions[i].data);
} else if (actions[i].action == ActionType.MintShort) {
_mintOption(_subAccount, actions[i].data);
} else if (actions[i].action == ActionType.MintShortIntoAccount) {
_mintOptionIntoAccount(_subAccount, actions[i].data);
} else if (actions[i].action == ActionType.BurnShort) {
_burnOption(_subAccount, actions[i].data);
} else if (actions[i].action == ActionType.BurnShortInAccount) {
_burnOptionFromAccount(_subAccount, actions[i].data);
} else if (actions[i].action == ActionType.TransferLong) {
_transferLong(_subAccount, actions[i].data);
} else if (actions[i].action == ActionType.TransferShort) {
_transferShort(_subAccount, actions[i].data);
} else if (actions[i].action == ActionType.TransferCollateral) {
_transferCollateral(_subAccount, actions[i].data);
} else if (actions[i].action == ActionType.AddLong) {
_addOption(_subAccount, actions[i].data);
} else if (actions[i].action == ActionType.RemoveLong) {
_removeOption(_subAccount, actions[i].data);
} else if (actions[i].action == ActionType.SettleAccount) {
_settle(_subAccount);
} else {
revert CM_UnsupportedAction();
}

/**
* @dev check if a pair of assets are collateralizable
*/
function isCollateralizable(uint8 _asset0, uint8 _asset1) external view returns (bool) {
return _isCollateralizable(_asset0, _asset1);
// increase i without checking overflow
unchecked {
++i;
}
}
}

/**
Expand Down Expand Up @@ -262,21 +271,6 @@ contract CrossMarginCashEngine is
return _getMinCollateral(account);
}

/**
* @notice move an account to someone else
* @dev expected to be call by account owner
* @param _subAccount the id of subaccount to transfer
* @param _newSubAccount the id of receiving account
*/
function transferAccount(address _subAccount, address _newSubAccount) external {
if (!_isPrimaryAccountFor(msg.sender, _subAccount)) revert NoAccess();

if (!accounts[_newSubAccount].isEmpty()) revert CM_AccountIsNotEmpty();
accounts[_newSubAccount] = accounts[_subAccount];

delete accounts[_subAccount];
}

/**
* @dev view function to get all shorts, longs and collaterals
*/
Expand Down Expand Up @@ -563,59 +557,6 @@ contract CrossMarginCashEngine is
* ========================================================= *
*/

/**
* @notice gets access status of an address
* @dev if whitelist address is not set, it ignores this
* @param _address address
*/
function _checkPermissioned(address _address) internal view {
if (!authority.canCall(_address, address(this), msg.sig)) revert NoAccess();
}

/**
* @notice execute multiple actions on one subAccounts
* @dev also check access of msg.sender
*/
function _execute(address _subAccount, ActionArgs[] calldata actions) internal {
_assertCallerHasAccess(_subAccount);

// update the account storage and do external calls on the flight
for (uint256 i; i < actions.length;) {
if (actions[i].action == ActionType.AddCollateral) {
_addCollateral(_subAccount, actions[i].data);
} else if (actions[i].action == ActionType.RemoveCollateral) {
_removeCollateral(_subAccount, actions[i].data);
} else if (actions[i].action == ActionType.MintShort) {
_mintOption(_subAccount, actions[i].data);
} else if (actions[i].action == ActionType.MintShortIntoAccount) {
_mintOptionIntoAccount(_subAccount, actions[i].data);
} else if (actions[i].action == ActionType.BurnShort) {
_burnOption(_subAccount, actions[i].data);
} else if (actions[i].action == ActionType.BurnShortInAccount) {
_burnOptionFromAccount(_subAccount, actions[i].data);
} else if (actions[i].action == ActionType.TransferLong) {
_transferLong(_subAccount, actions[i].data);
} else if (actions[i].action == ActionType.TransferShort) {
_transferShort(_subAccount, actions[i].data);
} else if (actions[i].action == ActionType.TransferCollateral) {
_transferCollateral(_subAccount, actions[i].data);
} else if (actions[i].action == ActionType.AddLong) {
_addOption(_subAccount, actions[i].data);
} else if (actions[i].action == ActionType.RemoveLong) {
_removeOption(_subAccount, actions[i].data);
} else if (actions[i].action == ActionType.SettleAccount) {
_settle(_subAccount);
} else {
revert CM_UnsupportedAction();
}

// increase i without checking overflow
unchecked {
++i;
}
}
}

/**
* @dev get minimum collateral requirement for an account
*/
Expand Down Expand Up @@ -644,4 +585,71 @@ contract CrossMarginCashEngine is
)
);
}

/*///////////////////////////////////////////////////////////////
Collateralizable Functions
//////////////////////////////////////////////////////////////*/

/**
* @notice sets the Collateralizable Mask for a pair of assets
* @param _asset0 the address of the asset 0
* @param _asset1 the address of the asset 1
* @param _value is margin-able
*/
function setCollateralizable(address _asset0, address _asset1, bool _value) external {
_checkOwner();

uint256 collateralId = grappa.assetIds(_asset0);
uint256 mask = 1 << grappa.assetIds(_asset1);

if (_value) collateralizable[collateralId] |= mask;
else collateralizable[collateralId] &= ~mask;

emit CollateralizableSet(_asset0, _asset1, _value);
}

/**
* @dev check if a pair of assets are collateralizable
*/
function isCollateralizable(address _asset0, address _asset1) external view returns (bool) {
return _isCollateralizable(grappa.assetIds(_asset0), grappa.assetIds(_asset1));
}

/**
* @dev check if a pair of assets are collateralizable
*/
function isCollateralizable(uint8 _asset0, uint8 _asset1) external view returns (bool) {
return _isCollateralizable(_asset0, _asset1);
}

/*///////////////////////////////////////////////////////////////
Transfer Account Functions
//////////////////////////////////////////////////////////////*/

/**
* @notice move an account to someone else
* @dev expected to be call by account owner
* @param _subAccount the id of subaccount to transfer
* @param _newSubAccount the id of receiving account
*/
function transferAccount(address _subAccount, address _newSubAccount) external {
if (!_isPrimaryAccountFor(msg.sender, _subAccount)) revert NoAccess();

if (!accounts[_newSubAccount].isEmpty()) revert CM_AccountIsNotEmpty();
accounts[_newSubAccount] = accounts[_subAccount];

delete accounts[_subAccount];
}

/*///////////////////////////////////////////////////////////////
Override Upgrade Permission
//////////////////////////////////////////////////////////////*/

/**
* @dev Upgradable by the owner.
*
*/
function _authorizeUpgrade(address /*newImplementation*/ ) internal view override {
_checkOwner();
}
}
Loading
Loading