Transaction Hash:
Block:
21251833 at Nov-23-2024 05:08:11 PM +UTC
Transaction Fee:
0.007038562081462282 ETH
$17.03
Gas Used:
248,509 Gas / 28.323167698 Gwei
Emitted Events:
409 |
FiatTokenProxy.0x8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925( 0x8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925, 0x0000000000000000000000005155f44c8d2fdb50375c295ed0e1daf42f17c7a7, 0x00000000000000000000000002f7dbc5e3c32b70bf90cb2919c00573ce0e69f1, 0000000000000000000000000000000000000000000000000000001bb69f2500 )
|
410 |
TransparentUpgradeableProxy.0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef( 0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef, 0x00000000000000000000000002f7dbc5e3c32b70bf90cb2919c00573ce0e69f1, 0x0000000000000000000000000000000000000000000000000000000000000000, 000000000000000000000000000000000000000000000000000000000332c62a )
|
411 |
TransparentUpgradeableProxy.0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef( 0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef, 0x0000000000000000000000000000000000000000000000000000000000000000, 0x00000000000000000000000010fb0bbece3c5b893563bcb8850403eacaeae30c, 000000000000000000000000000000000000000000000000000000000332c629 )
|
412 |
CompoundV3USDCPortfolio.AumFeesTaken( feeAmount=53659178, timeDelta=64764 )
|
413 |
FiatTokenProxy.0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef( 0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef, 0x0000000000000000000000005155f44c8d2fdb50375c295ed0e1daf42f17c7a7, 0x00000000000000000000000002f7dbc5e3c32b70bf90cb2919c00573ce0e69f1, 0000000000000000000000000000000000000000000000000000001bb69f2500 )
|
414 |
FiatTokenProxy.0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef( 0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef, 0x00000000000000000000000002f7dbc5e3c32b70bf90cb2919c00573ce0e69f1, 0x00000000000000000000000010fb0bbece3c5b893563bcb8850403eacaeae30c, 0000000000000000000000000000000000000000000000000000000000000000 )
|
415 |
FiatTokenProxy.0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef( 0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef, 0x00000000000000000000000002f7dbc5e3c32b70bf90cb2919c00573ce0e69f1, 0x000000000000000000000000c3d688b66703497daa19211eedff47f25384cdc3, 0000000000000000000000000000000000000000000000000000001bb69f2500 )
|
416 |
TransparentUpgradeableProxy.0xd1cf3d156d5f8f0d50f6c122ed609cec09d35c9b9fb3fff6ea0959134dae424e( 0xd1cf3d156d5f8f0d50f6c122ed609cec09d35c9b9fb3fff6ea0959134dae424e, 0x00000000000000000000000002f7dbc5e3c32b70bf90cb2919c00573ce0e69f1, 0x00000000000000000000000002f7dbc5e3c32b70bf90cb2919c00573ce0e69f1, 0000000000000000000000000000000000000000000000000000001bb69f2500 )
|
417 |
TransparentUpgradeableProxy.0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef( 0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef, 0x0000000000000000000000000000000000000000000000000000000000000000, 0x00000000000000000000000002f7dbc5e3c32b70bf90cb2919c00573ce0e69f1, 0000000000000000000000000000000000000000000000000000001bb69f24fe )
|
418 |
CompoundV3USDCPortfolio.Transfer( from=0x0000000000000000000000000000000000000000, to=Fund, amount=112281407681 )
|
419 |
CompoundV3USDCPortfolio.Deposit( sender=Fund, receiver=Fund, assets=119028000000, shares=112281407681, depositAmount=119028000000, fee=0 )
|
420 |
Fund.EntityDeposit( portfolio=CompoundV3USDCPortfolio, baseTokenDeposited=119028000000, sharesReceived=112281407681 )
|
Account State Difference:
Address | Before | After | State Difference | ||
---|---|---|---|---|---|
0x02f7dbc5...3Ce0e69F1 | |||||
0x5155F44C...42F17C7A7 | (Endaoment: Private Fund 0x515...7a7) | ||||
0x95222290...5CC4BAfe5
Miner
| (beaverbuild) | 13.739487417059382331 Eth | 13.739920272251040066 Eth | 0.000432855191657735 | |
0x9D5025B3...8c07fd8B2 | (Endaoment: Administrative Wallet) |
0.817352776477590354 Eth
Nonce: 6141
|
0.810314214396128072 Eth
Nonce: 6142
| 0.007038562081462282 | |
0xA0b86991...E3606eB48 | |||||
0xc3d688B6...25384cdc3 |
Execution Trace
EntityMulticall.multicall( _entity=0x5155F44C8D2FDb50375c295eD0E1DAF42F17C7A7, _calls= )
-
Registry.isActiveEntity( 0x5155F44C8D2FDb50375c295eD0E1DAF42F17C7A7 ) => ( True )
Fund.STATICCALL( )
-
Fund.DELEGATECALL( )
-
-
Registry.canCall( user=0x9D5025B327E6B863E5050141C987d988c07fd8B2, target=0xF15c683FfBa50254BAb340eFE49FA2038EE9354c, functionSig=System.Byte[] ) => ( True )
Fund.portfolioDeposit( _portfolio=0x02f7dbc5E3c32B70Bf90CB2919C00573Ce0e69F1, _amount=119028000000, _data=0x0000000000000000000000000000000000000000000000000000000000000001 ) => ( 112281407681 )
Fund.portfolioDeposit( _portfolio=0x02f7dbc5E3c32B70Bf90CB2919C00573Ce0e69F1, _amount=119028000000, _data=0x0000000000000000000000000000000000000000000000000000000000000001 ) => ( 112281407681 )
-
Registry.canCall( user=0xF15c683FfBa50254BAb340eFE49FA2038EE9354c, target=0x656e746974790200000000000000000000000000, functionSig=System.Byte[] ) => ( True )
-
Registry.isActivePortfolio( 0x02f7dbc5E3c32B70Bf90CB2919C00573Ce0e69F1 ) => ( True )
FiatTokenProxy.095ea7b3( )
-
FiatTokenV2_2.approve( spender=0x02f7dbc5E3c32B70Bf90CB2919C00573Ce0e69F1, value=119028000000 ) => ( True )
-
CompoundV3USDCPortfolio.deposit( _amountBaseToken=119028000000, _data=0x0000000000000000000000000000000000000000000000000000000000000001 ) => ( 112281407681 )
-
Registry.isActiveEntity( 0x5155F44C8D2FDb50375c295eD0E1DAF42F17C7A7 ) => ( True )
TransparentUpgradeableProxy.70a08231( )
-
Comet.balanceOf( account=0x02f7dbc5E3c32B70Bf90CB2919C00573Ce0e69F1 ) => ( 2614600893290 )
-
TransparentUpgradeableProxy.a9059cbb( )
-
Comet.transfer( dst=0x10FB0bBecE3c5b893563bCb8850403eaCaeAE30c, amount=53659178 ) => ( True )
-
TransparentUpgradeableProxy.70a08231( )
-
Comet.balanceOf( account=0x02f7dbc5E3c32B70Bf90CB2919C00573Ce0e69F1 ) => ( 2614547234111 )
-
FiatTokenProxy.23b872dd( )
-
FiatTokenV2_2.transferFrom( from=0x5155F44C8D2FDb50375c295eD0E1DAF42F17C7A7, to=0x02f7dbc5E3c32B70Bf90CB2919C00573Ce0e69F1, value=119028000000 ) => ( True )
-
FiatTokenProxy.a9059cbb( )
-
FiatTokenV2_2.transfer( to=0x10FB0bBecE3c5b893563bCb8850403eaCaeAE30c, value=0 ) => ( True )
-
TransparentUpgradeableProxy.f2b9fdb8( )
Comet.supply( asset=0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48, amount=119028000000 )
-
FiatTokenProxy.23b872dd( )
-
TransparentUpgradeableProxy.70a08231( )
-
Comet.balanceOf( account=0x02f7dbc5E3c32B70Bf90CB2919C00573Ce0e69F1 ) => ( 2733575234110 )
-
-
-
multicall[EntityMulticall (ln:57)]
_validate[EntityMulticall (ln:59)]
isActiveEntity[EntityMulticall (ln:48)]
EntityInactive[EntityMulticall (ln:48)]
manager[EntityMulticall (ln:49)]
isAuthorized[EntityMulticall (ln:49)]
Unauthorized[EntityMulticall (ln:49)]
_performCalls[EntityMulticall (ln:61)]
call[EntityMulticall (ln:102)]
CallFailed[EntityMulticall (ln:103)]
File 1 of 9: EntityMulticall
File 2 of 9: FiatTokenProxy
File 3 of 9: TransparentUpgradeableProxy
File 4 of 9: CompoundV3USDCPortfolio
File 5 of 9: Fund
File 6 of 9: Registry
File 7 of 9: Fund
File 8 of 9: FiatTokenV2_2
File 9 of 9: Comet
//SPDX-License-Identifier: BSD 3-Clause pragma solidity >=0.8.0; import {EndaomentAuth} from "./lib/auth/EndaomentAuth.sol"; import {Registry} from "./Registry.sol"; import {Entity} from "./Entity.sol"; import {ERC20} from "solmate/tokens/ERC20.sol"; error Unauthorized(); error EntityInactive(); error CallFailed(bytes response); /** * @notice Contract to execute multiple calls to an entity in a single transaction. * @dev Made possible by giving `EntityMulticall` manager-level permissions on all entities. * @dev We intentionally do not offer admin version of the multicall since admins can batch call entities through their multisigs. */ contract EntityMulticall is EndaomentAuth { /// CONSTANTS /// @notice The registry contract. Registry public immutable registry; /// STRUCTS /// @notice Struct to hold the data for a call to an entity. struct Call { /// @notice The amount of ETH for this call, if any. uint256 value; /// @notice The call data. bytes data; } /// @notice Struct to hold the data for an allowance to forward to an entity. struct TokenAllowance { /// @notice The token to forward the allowance for. ERC20 token; /// @notice The amount of tokens to forward the allowance for. uint256 amount; } /** * @param _registry The registry contract. */ constructor(Registry _registry) { __initEndaomentAuth(_registry, ""); registry = _registry; } /** * @notice Validate that the entity is active and the caller is the entity's manager. * @param _entity The entity to call. * @dev Checking if the entity is active can be considered superfluous since we already check for manager, but leave the extra check for * futher safety considerations and possible future-proofing. */ function _validate(Entity _entity) private view { if (!registry.isActiveEntity(_entity)) revert EntityInactive(); if (msg.sender != _entity.manager() && !isAuthorized(msg.sender, msg.sig)) revert Unauthorized(); } /** * @notice Execute multiple calls to an entity in a single transaction. * @param _entity The entity to call. * @param _calls The calls to make on the target entity. * @dev Reverts if the entity is inactive or the caller is not the entity's manager or a privileged aacount. */ function multicall(Entity _entity, Call[] calldata _calls) external payable { // Validate entity and caller _validate(_entity); // Execute all calls _performCalls(_entity, _calls); } /** * @notice Execute multiple calls to an entity in a single transaction, while forwarding an allowance to the entity. * @param _entity The entity to forward the allowance to and call. * @param _allowances The allowances to forward to the target entity. * @param _calls The calls to make on the target entity. * @dev Reverts if the entity is inactive or the caller is not the entity's manager or a privileged aacount. * @dev If a donation or swap is included in the calls, this needs to be called instead of `multicall` to ensure the entity has the allowance to make the donation or swap. */ function multicallWithAllowance(Entity _entity, TokenAllowance[] calldata _allowances, Call[] calldata _calls) external payable { // Validate entity and caller _validate(_entity); // Forward allowance to entity _forwardAllowances(_entity, _allowances); // Execute all calls _performCalls(_entity, _calls); } /** * @notice Forward multiple allowances to an entity. * @param _entity The entity to forward the allowance to. * @param _allowances The allowances to forward to the target entity. */ function _forwardAllowances(Entity _entity, TokenAllowance[] calldata _allowances) private { for (uint256 i = 0; i < _allowances.length; ++i) { // Transfer allowed balance to this contract _allowances[i].token.transferFrom(msg.sender, address(this), _allowances[i].amount); // Forward allowance to entity _allowances[i].token.approve(address(_entity), _allowances[i].amount); } } /** * @notice Execute multiple calls to an entity in a single transaction. * @param _entity The entity to call. * @param _calls The calls to make on the target entity. */ function _performCalls(Entity _entity, Call[] calldata _calls) private { for (uint256 i = 0; i < _calls.length; ++i) { (bool _success, bytes memory _data) = address(_entity).call{value: _calls[i].value}(_calls[i].data); if (!_success) revert CallFailed(_data); } } } // SPDX-License-Identifier: AGPL-3.0-only pragma solidity >=0.8.0; import {RolesAuthority} from "./authorities/RolesAuthority.sol"; /** * @notice An abstract Auth that contracts in the Endaoment ecosystem can inherit from. It is based on * the `Auth.sol` contract from Solmate, but does not inherit from it. Most of the functionality * is either slightly different, or not needed. In particular: * - EndaomentAuth uses an initializer such that it can be deployed with minimal proxies. * - EndaomentAuth contracts reference a RolesAuthority, not just an Authority, when looking up permissions. * In the Endaoment ecosystem, this is assumed to be the Registry. * - EndaomentAuth contracts do not have an owner, but instead grant ubiquitous permission to its RoleAuthority's * owner. In the Endaoment ecosystem, this is assumed to be the board of directors multi-sig. * - EndaomentAuth contracts can optionally declare themselves a "special target" at deploy time. Instead of passing * their address to the authority when looking up their permissions, they'll instead pass the special target bytes. * See documentation on `specialTarget` for more information. * */ abstract contract EndaomentAuth { /// @notice Thrown when an account without proper permissions calls a privileged method. error Unauthorized(); /// @notice Thrown if there is an attempt to deploy with address 0 as the authority. error InvalidAuthority(); /// @notice Thrown if there is a second call to initialize. error AlreadyInitialized(); /// @notice The contract used to source permissions for accounts targeting this contract. RolesAuthority public authority; /** * @notice If set to a non-zero value, this contract will pass these byes as the target contract * to the RolesAuthority's `canCall` method, rather than its own contract. This allows a single * RolesAuthority permission to manage permissions simultaneously for a group of contracts that * identify themselves as a certain type. For example: set a permission for all "entity" contracts. */ bytes20 public specialTarget; /** * @notice One time method to be called at deployment to configure the contract. Required so EndaomentAuth * contracts can be deployed as minimal proxies (clones). * @param _authority Contract that will be used to source permissions for accounts targeting this contract. * @param _specialTarget The bytes that this contract will pass as the "target" when looking up permissions * from the authority. If set to empty bytes, this contract will pass its own address instead. */ function __initEndaomentAuth(RolesAuthority _authority, bytes20 _specialTarget) internal virtual { if (address(_authority) == address(0)) revert InvalidAuthority(); if (address(authority) != address(0)) revert AlreadyInitialized(); authority = _authority; specialTarget = _specialTarget; } /** * @notice Modifier for methods that require authorization to execute. */ modifier requiresAuth() virtual { if (!isAuthorized(msg.sender, msg.sig)) revert Unauthorized(); _; } /** * @notice Internal method that asks the authority whether the caller has permission to execute a method. * @param user The account attempting to call a permissioned method on this contract * @param functionSig The signature hash of the permissioned method being invoked. */ function isAuthorized(address user, bytes4 functionSig) internal view virtual returns (bool) { RolesAuthority auth = authority; // Memoizing authority saves us a warm SLOAD, around 100 gas. address _target = specialTarget == "" ? address(this) : address(specialTarget); // The caller has permission on authority, or the caller is the RolesAuthority owner return auth.canCall(user, _target, functionSig) || user == auth.owner(); } } //SPDX-License-Identifier: BSD 3-Clause pragma solidity 0.8.13; import {Math} from "./lib/Math.sol"; import {ERC20} from "solmate/tokens/ERC20.sol"; import {Auth, Authority} from "./lib/auth/Auth.sol"; import {SafeTransferLib} from "solmate/utils/SafeTransferLib.sol"; import {RegistryAuth} from "./RegistryAuth.sol"; import {Entity} from "./Entity.sol"; import {ISwapWrapper} from "./interfaces/ISwapWrapper.sol"; import {Portfolio} from "./Portfolio.sol"; // --- Errors --- error Unauthorized(); error UnsupportedSwapper(); /** * @notice Registry entity - manages Factory and Entity state info. */ contract Registry is RegistryAuth { // --- Storage --- /// @notice Treasury address can receives fees. address public treasury; /// @notice Base Token address is the stable coin contract used throughout the system. ERC20 public immutable baseToken; /// @notice Mapping of approved factory contracts that are allowed to register new Entities. mapping(address => bool) public isApprovedFactory; /// @notice Mapping of active status of entities. mapping(Entity => bool) public isActiveEntity; /// @notice Maps entity type to donation fee percentage stored as a zoc, where type(uint32).max represents 0. mapping(uint8 => uint32) defaultDonationFee; /// @notice Maps specific entity receiver to donation fee percentage stored as a zoc. mapping(Entity => uint32) donationFeeReceiverOverride; /// @notice Maps entity type to payout fee percentage stored as a zoc, where type(uint32).max represents 0. mapping(uint8 => uint32) defaultPayoutFee; /// @notice Maps specific entity sender to payout fee percentage stored as a zoc. mapping(Entity => uint32) payoutFeeOverride; /// @notice Maps sender entity type to receiver entity type to fee percentage as a zoc. mapping(uint8 => mapping(uint8 => uint32)) defaultTransferFee; /// @notice Maps specific entity sender to receiver entity type to fee percentage as a zoc. mapping(Entity => mapping(uint8 => uint32)) transferFeeSenderOverride; /// @notice Maps sender entity type to specific entity receiver to fee percentage as a zoc. mapping(uint8 => mapping(Entity => uint32)) transferFeeReceiverOverride; /// @notice Maps swap wrappers to their enabled/disabled status. mapping(ISwapWrapper => bool) public isSwapperSupported; /// @notice Maps portfolios to their enabled/disabled status. mapping(Portfolio => bool) public isActivePortfolio; // --- Events --- /// @notice The event emitted when a factory is approved (whitelisted) or has it's approval removed. event FactoryApprovalSet(address indexed factory, bool isApproved); /// @notice The event emitted when an entity is set active or inactive. event EntityStatusSet(address indexed entity, bool isActive); /// @notice The event emitted when a swap wrapper is set active or inactive. event SwapWrapperStatusSet(address indexed swapWrapper, bool isSupported); /// @notice The event emitted when a portfolio is set active or inactive. event PortfolioStatusSet(address indexed portfolio, bool isActive); /// @notice Emitted when a default donation fee is set for an entity type. event DefaultDonationFeeSet(uint8 indexed entityType, uint32 fee); /// @notice Emitted when a donation fee override is set for a specific receiving entity. event DonationFeeReceiverOverrideSet(address indexed entity, uint32 fee); /// @notice Emitted when a default payout fee is set for an entity type. event DefaultPayoutFeeSet(uint8 indexed entityType, uint32 fee); /// @notice Emitted when a payout fee override is set for a specific sender entity. event PayoutFeeOverrideSet(address indexed entity, uint32 fee); /// @notice Emitted when a default transfer fee is set for transfers between entity types. event DefaultTransferFeeSet(uint8 indexed fromEntityType, uint8 indexed toEntityType, uint32 fee); /// @notice Emitted when a transfer fee override is set for transfers from an entity to a specific entityType. event TransferFeeSenderOverrideSet(address indexed fromEntity, uint8 indexed toEntityType, uint32 fee); /// @notice Emitted when a transfer fee override is set for transfers from an entityType to an entity. event TransferFeeReceiverOverrideSet(uint8 indexed fromEntityType, address indexed toEntity, uint32 fee); /// @notice Emitted when the registry treasury contract is changed event TreasuryChanged(address oldTreasury, address indexed newTreasury); /** * @notice Modifier for methods that require auth and that the manager cannot access. * @dev Overridden from Auth.sol. Reason: use custom error. */ modifier requiresAuth() override { if (!isAuthorized(msg.sender, msg.sig)) revert Unauthorized(); _; } // --- Constructor --- constructor(address _admin, address _treasury, ERC20 _baseToken) RegistryAuth(_admin, Authority(address(this))) { treasury = _treasury; emit TreasuryChanged(address(0), _treasury); baseToken = _baseToken; } // --- Internal fns --- /** * @notice Fee parsing to convert the special "type(uint32).max" value to zero, and zero to the "max". * @dev After converting, "type(uint32).max" will cause overflow/revert when used as a fee percentage multiplier and zero will mean no fee. * @param _value The value to be converted. * @return The parsed fee to use. */ function _parseFeeWithFlip(uint32 _value) private pure returns (uint32) { if (_value == 0) { return type(uint32).max; } else if (_value == type(uint32).max) { return 0; } else { return _value; } } // --- External fns --- /** * @notice Sets a new Endaoment treasury address. * @param _newTreasury The new treasury. */ function setTreasury(address _newTreasury) external requiresAuth { emit TreasuryChanged(treasury, _newTreasury); treasury = _newTreasury; } /** * @notice Sets the approval state of a factory. Grants the factory permissions to set entity status. * @param _factory The factory whose approval state is to be updated. * @param _isApproved True if the factory should be approved, false otherwise. */ function setFactoryApproval(address _factory, bool _isApproved) external requiresAuth { isApprovedFactory[_factory] = _isApproved; emit FactoryApprovalSet(address(_factory), _isApproved); } /** * @notice Sets the enable/disable state of an Entity. * @param _entity The entity whose active state is to be updated. * @param _isActive True if the entity should be active, false otherwise. */ function setEntityStatus(Entity _entity, bool _isActive) external requiresAuth { isActiveEntity[_entity] = _isActive; emit EntityStatusSet(address(_entity), _isActive); } /** * @notice Sets Entity as active. This is a special method to be called only by approved factories. * Other callers should use `setEntityStatus` instead. * @param _entity The entity. */ function setEntityActive(Entity _entity) external { if (!isApprovedFactory[msg.sender]) revert Unauthorized(); isActiveEntity[_entity] = true; emit EntityStatusSet(address(_entity), true); } /** * @notice Sets the enable/disable state of a Portfolio. * @param _portfolio Portfolio. * @param _isActive True if setting portfolio to active, false otherwise. */ function setPortfolioStatus(Portfolio _portfolio, bool _isActive) external requiresAuth { isActivePortfolio[_portfolio] = _isActive; emit PortfolioStatusSet(address(_portfolio), _isActive); } /** * @notice Gets default donation fee pct (as a zoc) for an Entity. * @param _entity The receiving entity of the donation for which the fee is being fetched. * @return uint32 The default donation fee for the entity's type. * @dev Makes use of _parseFeeWithFlip, so if no default exists, "max" will be returned. */ function getDonationFee(Entity _entity) external view returns (uint32) { return _parseFeeWithFlip(defaultDonationFee[_entity.entityType()]); } /** * @notice Gets lowest possible donation fee pct (as a zoc) for an Entity, among default and override. * @param _entity The receiving entity of the donation for which the fee is being fetched. * @return uint32 The minimum of the default donation fee and the receiver's fee override. * @dev Makes use of _parseFeeWithFlip, so if no default or override exists, "max" will be returned. */ function getDonationFeeWithOverrides(Entity _entity) external view returns (uint32) { uint32 _default = _parseFeeWithFlip(defaultDonationFee[_entity.entityType()]); uint32 _receiverOverride = _parseFeeWithFlip(donationFeeReceiverOverride[_entity]); return _receiverOverride < _default ? _receiverOverride : _default; } /** * @notice Gets default payout fee pct (as a zoc) for an Entity. * @param _entity The sender entity of the payout for which the fee is being fetched. * @return uint32 The default payout fee for the entity's type. * @dev Makes use of _parseFeeWithFlip, so if no default exists, "max" will be returned. */ function getPayoutFee(Entity _entity) external view returns (uint32) { return _parseFeeWithFlip(defaultPayoutFee[_entity.entityType()]); } /** * @notice Gets lowest possible payout fee pct (as a zoc) for an Entity, among default and override. * @param _entity The sender entity of the payout for which the fee is being fetched. * @return uint32 The minimum of the default payout fee and the sender's fee override. * @dev Makes use of _parseFeeWithFlip, so if no default or override exists, "max" will be returned. */ function getPayoutFeeWithOverrides(Entity _entity) external view returns (uint32) { uint32 _default = _parseFeeWithFlip(defaultPayoutFee[_entity.entityType()]); uint32 _senderOverride = _parseFeeWithFlip(payoutFeeOverride[_entity]); return _senderOverride < _default ? _senderOverride : _default; } /** * @notice Gets default transfer fee pct (as a zoc) between sender & receiver Entities. * @param _sender The sending entity of the transfer for which the fee is being fetched. * @param _receiver The receiving entity of the transfer for which the fee is being fetched. * @return uint32 The default transfer fee. * @dev Makes use of _parseFeeWithFlip, so if no default exists, "type(uint32).max" will be returned. */ function getTransferFee(Entity _sender, Entity _receiver) external view returns (uint32) { return _parseFeeWithFlip(defaultTransferFee[_sender.entityType()][_receiver.entityType()]); } /** * @notice Gets lowest possible transfer fee pct (as a zoc) between sender & receiver Entities, among default and overrides. * @param _sender The sending entity of the transfer for which the fee is being fetched. * @param _receiver The receiving entity of the transfer for which the fee is being fetched. * @return uint32 The minimum of the default transfer fee, and sender and receiver overrides. * @dev Makes use of _parseFeeWithFlip, so if no default or overrides exist, "type(uint32).max" will be returned. */ function getTransferFeeWithOverrides(Entity _sender, Entity _receiver) external view returns (uint32) { uint32 _default = _parseFeeWithFlip(defaultTransferFee[_sender.entityType()][_receiver.entityType()]); uint32 _senderOverride = _parseFeeWithFlip(transferFeeSenderOverride[_sender][_receiver.entityType()]); uint32 _receiverOverride = _parseFeeWithFlip(transferFeeReceiverOverride[_sender.entityType()][_receiver]); uint32 _lowestFee = _default; _lowestFee = _senderOverride < _lowestFee ? _senderOverride : _lowestFee; _lowestFee = _receiverOverride < _lowestFee ? _receiverOverride : _lowestFee; return _lowestFee; } /** * @notice Sets the default donation fee for an entity type. * @param _entityType Entity type. * @param _fee The fee percentage to be set (a zoc). */ function setDefaultDonationFee(uint8 _entityType, uint32 _fee) external requiresAuth { defaultDonationFee[_entityType] = _parseFeeWithFlip(_fee); emit DefaultDonationFeeSet(_entityType, _fee); } /** * @notice Sets the donation fee receiver override for a specific entity. * @param _entity Entity. * @param _fee The overriding fee (a zoc). */ function setDonationFeeReceiverOverride(Entity _entity, uint32 _fee) external requiresAuth { donationFeeReceiverOverride[_entity] = _parseFeeWithFlip(_fee); emit DonationFeeReceiverOverrideSet(address(_entity), _fee); } /** * @notice Sets the default payout fee for an entity type. * @param _entityType Entity type. * @param _fee The fee percentage to be set (a zoc). */ function setDefaultPayoutFee(uint8 _entityType, uint32 _fee) external requiresAuth { defaultPayoutFee[_entityType] = _parseFeeWithFlip(_fee); emit DefaultPayoutFeeSet(_entityType, _fee); } /** * @notice Sets the payout fee override for a specific entity. * @param _entity Entity. * @param _fee The overriding fee (a zoc). */ function setPayoutFeeOverride(Entity _entity, uint32 _fee) external requiresAuth { payoutFeeOverride[_entity] = _parseFeeWithFlip(_fee); emit PayoutFeeOverrideSet(address(_entity), _fee); } /** * @notice Sets the default transfer fee for transfers from one specific entity type to another. * @param _fromEntityType The entityType making the transfer. * @param _toEntityType The receiving entityType. * @param _fee The transfer fee percentage (a zoc). */ function setDefaultTransferFee(uint8 _fromEntityType, uint8 _toEntityType, uint32 _fee) external requiresAuth { defaultTransferFee[_fromEntityType][_toEntityType] = _parseFeeWithFlip(_fee); emit DefaultTransferFeeSet(_fromEntityType, _toEntityType, _fee); } /** * @notice Sets the transfer fee override for transfers from one specific entity to entities of a given type. * @param _fromEntity The entity making the transfer. * @param _toEntityType The receiving entityType. * @param _fee The overriding fee percentage (a zoc). */ function setTransferFeeSenderOverride(Entity _fromEntity, uint8 _toEntityType, uint32 _fee) external requiresAuth { transferFeeSenderOverride[_fromEntity][_toEntityType] = _parseFeeWithFlip(_fee); emit TransferFeeSenderOverrideSet(address(_fromEntity), _toEntityType, _fee); } /** * @notice Sets the transfer fee override for transfers from entities of a given type to a specific entity. * @param _fromEntityType The entityType making the transfer. * @param _toEntity The receiving entity. * @param _fee The overriding fee percentage (a zoc). */ function setTransferFeeReceiverOverride(uint8 _fromEntityType, Entity _toEntity, uint32 _fee) external requiresAuth { transferFeeReceiverOverride[_fromEntityType][_toEntity] = _parseFeeWithFlip(_fee); emit TransferFeeReceiverOverrideSet(_fromEntityType, address(_toEntity), _fee); } /** * @notice Sets the enable/disable state of a SwapWrapper. System owners must ensure meticulous review of SwapWrappers before approving them. * @param _swapWrapper A contract that implements ISwapWrapper. * @param _supported `true` if supported, `false` if unsupported. */ function setSwapWrapperStatus(ISwapWrapper _swapWrapper, bool _supported) external requiresAuth { isSwapperSupported[_swapWrapper] = _supported; emit SwapWrapperStatusSet(address(_swapWrapper), _supported); } } //SPDX-License-Identifier: BSD 3-Clause pragma solidity >=0.8.0; import "solmate/tokens/ERC20.sol"; import "solmate/utils/SafeTransferLib.sol"; import "./lib/ReentrancyGuard.sol"; import {Registry} from "./Registry.sol"; import {ISwapWrapper} from "./interfaces/ISwapWrapper.sol"; import {EndaomentAuth} from "./lib/auth/EndaomentAuth.sol"; import {Portfolio} from "./Portfolio.sol"; import {Math} from "./lib/Math.sol"; error EntityInactive(); error PortfolioInactive(); error InsufficientFunds(); error InvalidAction(); error BalanceMismatch(); error CallFailed(bytes response); /** * @notice Entity contract inherited by Org and Fund contracts (and all future kinds of Entities). */ abstract contract Entity is EndaomentAuth, ReentrancyGuard { using Math for uint256; using SafeTransferLib for ERC20; /// @notice The base registry to which the entity is connected. Registry public registry; /// @notice The entity's manager. address public manager; // @notice The base token used for tracking the entity's fund balance. ERC20 public baseToken; /// @notice The current balance for the entity, denominated in the base token's units. uint256 public balance; /// @notice Placeholder address used in swapping method to denote usage of ETH instead of a token. address public constant ETH_PLACEHOLDER = 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE; /// @notice Emitted when manager is set. event EntityManagerSet(address indexed oldManager, address indexed newManager); /// @notice Emitted when a donation is made. event EntityDonationReceived( address indexed from, address indexed to, address indexed tokenIn, uint256 amountIn, uint256 amountReceived, uint256 amountFee ); /// @notice Emitted when a payout is made from an entity. event EntityValuePaidOut(address indexed from, address indexed to, uint256 amountSent, uint256 amountFee); /// @notice Emitted when a transfer is made between entities. event EntityValueTransferred(address indexed from, address indexed to, uint256 amountReceived, uint256 amountFee); /// @notice Emitted when a base token reconciliation completes event EntityBalanceReconciled(address indexed entity, uint256 amountReceived, uint256 amountFee); /// @notice Emitted when a base token balance is used to correct the internal contract balance. event EntityBalanceCorrected(address indexed entity, uint256 newBalance); /// @notice Emitted when a portfolio deposit is made. event EntityDeposit(address indexed portfolio, uint256 baseTokenDeposited, uint256 sharesReceived); /// @notice Emitted when a portfolio share redemption is made. event EntityRedeem(address indexed portfolio, uint256 sharesRedeemed, uint256 baseTokenReceived); /// @notice Emitted when ether is received. event EntityEthReceived(address indexed sender, uint256 amount); /** * @notice Modifier for methods that require auth and that the manager can access. * @dev Uses the same condition as `requiresAuth` but with added manager access. */ modifier requiresManager() { if (msg.sender != manager && !isAuthorized(msg.sender, msg.sig)) revert Unauthorized(); _; } /// @notice Each entity will implement this function to allow a caller to interrogate what kind of entity it is. function entityType() public pure virtual returns (uint8); /** * @notice One time method to be called at deployment to configure the contract. Required so Entity * contracts can be deployed as minimal proxies (clones). * @param _registry The registry to host the Entity. * @param _manager The address of the Entity's manager. */ function __initEntity(Registry _registry, address _manager) internal { // Call to EndaomentAuth's initialize function ensures that this can't be called again __initEndaomentAuth(_registry, bytes20(bytes.concat("entity", bytes1(entityType())))); __initReentrancyGuard(); registry = _registry; manager = _manager; baseToken = _registry.baseToken(); } /** * @notice Set a new manager for this entity. * @param _manager Address of new manager. * @dev Callable by current manager or permissioned role. */ function setManager(address _manager) external virtual requiresManager { emit EntityManagerSet(manager, _manager); manager = _manager; } /** * @notice Receives a donated amount of base tokens to be added to the entity's balance. Transfers default fee to treasury. * @param _amount Amount donated in base token. * @dev Reverts if the donation fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). * @dev Reverts if the token transfer fails. */ function donate(uint256 _amount) external virtual { uint32 _feeMultiplier = registry.getDonationFee(this); _donateWithFeeMultiplier(_amount, _feeMultiplier); } /** * @notice Receives a donated amount of base tokens to be added to the entity's balance. Transfers default or overridden fee to treasury. * @param _amount Amount donated in base token. * @dev Reverts if the donation fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). * @dev Reverts if the token transfer fails. */ function donateWithOverrides(uint256 _amount) external virtual { uint32 _feeMultiplier = registry.getDonationFeeWithOverrides(this); _donateWithFeeMultiplier(_amount, _feeMultiplier); } /** * @notice Receives a donated amount of base tokens to be added to the entity's balance. * This method can be called by permissioned actors to make a donation with a manually specified fee. * @param _amount Amount donated in base token. * @param _feeOverride Fee percentage as zoc. * @dev Reverts if the transfer fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). * @dev Reverts if the token transfer fails. * @dev Reverts with `Unauthorized` if the `msg.sender` is not a privileged role. */ function donateWithAdminOverrides(uint256 _amount, uint32 _feeOverride) external virtual requiresAuth { _donateWithFeeMultiplier(_amount, _feeOverride); } /** * @notice Receives a donated amount of base tokens to be added to the entity's balance. Transfers fee calculated by fee multiplier to treasury. * @param _amount Amount donated in base token. * @param _feeMultiplier Value indicating the percentage of the Endaoment donation fee to go to the Endaoment treasury. * @dev Reverts if the donation fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). * @dev Reverts if the token transfer fails. */ function _donateWithFeeMultiplier(uint256 _amount, uint32 _feeMultiplier) internal virtual { (uint256 _netAmount, uint256 _fee) = _calculateFee(_amount, _feeMultiplier); baseToken.safeTransferFrom(msg.sender, registry.treasury(), _fee); baseToken.safeTransferFrom(msg.sender, address(this), _netAmount); unchecked { // unchecked as no possibility of overflow with baseToken precision balance += _netAmount; } emit EntityDonationReceived(msg.sender, address(this), address(baseToken), _amount, _amount, _fee); } /** * @notice Receive a donated amount of ETH or ERC20 tokens, swaps them to base tokens, and adds the output to the * entity's balance. Fee calculated using default rate and sent to treasury. * @param _swapWrapper The swap wrapper to use for the donation. Must be whitelisted on the Registry. * @param _tokenIn The address of the ERC20 token to swap and donate, or ETH_PLACEHOLDER if donating ETH. * @param _amountIn The amount of tokens or ETH being swapped and donated. * @param _data Additional call data required by the ISwapWrapper being used. */ function swapAndDonate(ISwapWrapper _swapWrapper, address _tokenIn, uint256 _amountIn, bytes calldata _data) external payable virtual { uint32 _feeMultiplier = registry.getDonationFee(this); _swapAndDonateWithFeeMultiplier(_swapWrapper, _tokenIn, _amountIn, _data, _feeMultiplier); } /** * @notice Receive a donated amount of ETH or ERC20 tokens, swaps them to base tokens, and adds the output to the * entity's balance. Fee calculated using override rate and sent to treasury. * @param _swapWrapper The swap wrapper to use for the donation. Must be whitelisted on the Registry. * @param _tokenIn The address of the ERC20 token to swap and donate, or ETH_PLACEHOLDER if donating ETH. * @param _amountIn The amount of tokens or ETH being swapped and donated. * @param _data Additional call data required by the ISwapWrapper being used. */ function swapAndDonateWithOverrides( ISwapWrapper _swapWrapper, address _tokenIn, uint256 _amountIn, bytes calldata _data ) external payable virtual { uint32 _feeMultiplier = registry.getDonationFeeWithOverrides(this); _swapAndDonateWithFeeMultiplier(_swapWrapper, _tokenIn, _amountIn, _data, _feeMultiplier); } /// @dev Internal helper implementing swap and donate functionality for any fee multiplier provided. function _swapAndDonateWithFeeMultiplier( ISwapWrapper _swapWrapper, address _tokenIn, uint256 _amountIn, bytes calldata _data, uint32 _feeMultiplier ) internal virtual nonReentrant { if (!registry.isSwapperSupported(_swapWrapper)) revert InvalidAction(); // THINK: do we need a re-entrancy guard on this method? if (_tokenIn != ETH_PLACEHOLDER) { ERC20(_tokenIn).safeTransferFrom(msg.sender, address(this), _amountIn); ERC20(_tokenIn).safeApprove(address(_swapWrapper), 0); ERC20(_tokenIn).safeApprove(address(_swapWrapper), _amountIn); } uint256 _amountOut = _swapWrapper.swap{value: msg.value}(_tokenIn, address(baseToken), address(this), _amountIn, _data); (uint256 _netAmount, uint256 _fee) = _calculateFee(_amountOut, _feeMultiplier); baseToken.safeTransfer(registry.treasury(), _fee); unchecked { // unchecked as no possibility of overflow with baseToken precision balance += _netAmount; } if (balance > baseToken.balanceOf(address(this))) revert BalanceMismatch(); emit EntityDonationReceived(msg.sender, address(this), _tokenIn, _amountIn, _amountOut, _fee); } /** * @notice Transfers an amount of base tokens from one entity to another. Transfers default fee to treasury. * @param _to The entity to receive the tokens. * @param _amount Contains the amount being donated (denominated in the base token's units). * @dev Reverts if the entity is inactive or if the token transfer fails. * @dev Reverts if the transfer fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). * @dev Reverts with `Unauthorized` if the `msg.sender` is not the entity manager or a privileged role. * @dev Renamed from `transfer` to distinguish from ERC20 transfer in 3rd party tools. */ function transferToEntity(Entity _to, uint256 _amount) external virtual requiresManager { uint32 _feeMultiplier = registry.getTransferFee(this, _to); _transferWithFeeMultiplier(_to, _amount, _feeMultiplier); } /** * @notice Transfers an amount of base tokens from one entity to another. Transfers default or overridden fee to treasury. * @param _to The entity to receive the tokens. * @param _amount Contains the amount being donated (denominated in the base token's units). * @dev Reverts if the entity is inactive or if the token transfer fails. * @dev Reverts if the transfer fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). * @dev Reverts with `Unauthorized` if the `msg.sender` is not the entity manager or a privileged role. */ function transferToEntityWithOverrides(Entity _to, uint256 _amount) external virtual requiresManager { uint32 _feeMultiplier = registry.getTransferFeeWithOverrides(this, _to); _transferWithFeeMultiplier(_to, _amount, _feeMultiplier); } /** * @notice Transfers an amount of base tokens from one entity to another. Transfers fee specified by a privileged role. * @param _to The entity to receive the tokens. * @param _amount Contains the amount being donated (denominated in the base token's units). * @param _feeOverride Admin override configured by an Admin * @dev Reverts if the entity is inactive or if the token transfer fails. * @dev Reverts if the transfer fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). * @dev Reverts with `Unauthorized` if the `msg.sender` is not a privileged role. */ function transferToEntityWithAdminOverrides(Entity _to, uint256 _amount, uint32 _feeOverride) external virtual requiresAuth { _transferWithFeeMultiplier(_to, _amount, _feeOverride); } /** * @notice Transfers an amount of base tokens from one entity to another. Transfers fee calculated by fee multiplier to treasury. * @param _to The entity to receive the tokens. * @param _amount Contains the amount being donated (denominated in the base token's units). * @param _feeMultiplier Value indicating the percentage of the Endaoment donation fee to go to the Endaoment treasury. * @dev Reverts with 'Inactive' if the entity sending the transfer or the entity receiving the transfer is inactive. * @dev Reverts if the transfer fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). * @dev Reverts with `Unauthorized` if the `msg.sender` is not the entity manager or a privileged role. * @dev Reverts if the token transfer fails. */ function _transferWithFeeMultiplier(Entity _to, uint256 _amount, uint32 _feeMultiplier) internal virtual { if (!registry.isActiveEntity(this) || !registry.isActiveEntity(_to)) revert EntityInactive(); if (balance < _amount) revert InsufficientFunds(); (uint256 _netAmount, uint256 _fee) = _calculateFee(_amount, _feeMultiplier); baseToken.safeTransfer(registry.treasury(), _fee); baseToken.safeTransfer(address(_to), _netAmount); unchecked { // unchecked as no possibility of overflow with baseToken precision balance -= _amount; _to.receiveTransfer(_netAmount); } emit EntityValueTransferred(address(this), address(_to), _amount, _fee); } /** * @notice Updates the receiving entity balance on a transfer. * @param _transferAmount The amount being received on the transfer. * @dev This function is external, but is restricted such that it can only be called by other entities. */ function receiveTransfer(uint256 _transferAmount) external virtual { if (!registry.isActiveEntity(Entity(payable(msg.sender)))) revert EntityInactive(); unchecked { // Cannot overflow with realistic balances. balance += _transferAmount; } } /** * @notice Deposits an amount of Entity's `baseToken` into an Endaoment-approved Portfolio. * @param _portfolio An Endaoment-approved portfolio. * @param _amount Amount of `baseToken` to deposit into the portfolio. * @param _data Data required by a portfolio to deposit. * @return _shares Amount of portfolio share tokens Entity received as a result of this deposit. */ function portfolioDeposit(Portfolio _portfolio, uint256 _amount, bytes calldata _data) external virtual requiresManager returns (uint256) { if (!registry.isActivePortfolio(_portfolio)) revert PortfolioInactive(); balance -= _amount; baseToken.safeApprove(address(_portfolio), _amount); uint256 _shares = _portfolio.deposit(_amount, _data); emit EntityDeposit(address(_portfolio), _amount, _shares); return _shares; } /** * @notice Redeems an amount of Entity's portfolio shares for an amount of `baseToken`. * @param _portfolio An Endaoment-approved portfolio. * @param _shares Amount of share tokens to redeem. * @param _data Data required by a portfolio to redeem. * @return _received Amount of `baseToken` Entity received as a result of this redemption. */ function portfolioRedeem(Portfolio _portfolio, uint256 _shares, bytes calldata _data) external virtual requiresManager returns (uint256) { if (!registry.isActivePortfolio(_portfolio)) revert PortfolioInactive(); uint256 _received = _portfolio.redeem(_shares, _data); // unchecked: a realistic balance can never overflow a uint256 unchecked { balance += _received; } emit EntityRedeem(address(_portfolio), _shares, _received); return _received; } /** * @notice This method should be called to reconcile the Entity's internal baseToken accounting with the baseToken contract's accounting. * There are a 2 situations where calling this method is appropriate: * 1. To process amounts of baseToken that arrived at this Entity through methods besides Entity:donate or Entity:transfer. For example, * if this Entity receives a normal ERC20 transfer of baseToken, the amount received will be unavailable for Entity use until this method * is called to adjust the balance and process fees. OrgFundFactory.sol:_donate makes use of this method to do this as well. * 2. Unusually, the Entity's perspective of balance could be lower than `baseToken.balanceOf(this)`. This could happen if * Entity:callAsEntity is used to transfer baseToken. In this case, this method provides a way of correcting the Entity's internal balance. */ function reconcileBalance() external virtual { uint256 _tokenBalance = baseToken.balanceOf(address(this)); if (_tokenBalance >= balance) { uint256 _sweepAmount = _tokenBalance - balance; uint32 _feeMultiplier = registry.getDonationFeeWithOverrides(this); (uint256 _netAmount, uint256 _fee) = _calculateFee(_sweepAmount, _feeMultiplier); baseToken.safeTransfer(registry.treasury(), _fee); unchecked { balance += _netAmount; } emit EntityBalanceReconciled(address(this), _sweepAmount, _fee); } else { // Handle abnormal scenario where _tokenBalance < balance (see method docs) balance = _tokenBalance; emit EntityBalanceCorrected(address(this), _tokenBalance); } } /** * @notice Takes stray tokens or ETH sent directly to this Entity, swaps them for base token, then adds them to the * Entity's balance after paying the appropriate fee to the treasury. * @param _swapWrapper The swap wrapper to use to convert the assets. Must be whitelisted on the Registry. * @param _tokenIn The address of the ERC20 token to swap, or ETH_PLACEHOLDER if ETH. * @param _amountIn The amount of tokens or ETH being swapped and added to the balance. * @param _data Additional call data required by the ISwapWrapper being used. */ function swapAndReconcileBalance( ISwapWrapper _swapWrapper, address _tokenIn, uint256 _amountIn, bytes calldata _data ) external virtual nonReentrant requiresManager { if (!registry.isSwapperSupported(_swapWrapper)) revert InvalidAction(); uint32 _feeMultiplier = registry.getDonationFeeWithOverrides(this); if (_tokenIn != ETH_PLACEHOLDER) { ERC20(_tokenIn).safeApprove(address(_swapWrapper), 0); ERC20(_tokenIn).safeApprove(address(_swapWrapper), _amountIn); } // Send value only if token in is ETH uint256 _value = _tokenIn == ETH_PLACEHOLDER ? _amountIn : 0; uint256 _amountOut = _swapWrapper.swap{value: _value}(_tokenIn, address(baseToken), address(this), _amountIn, _data); (uint256 _netAmount, uint256 _fee) = _calculateFee(_amountOut, _feeMultiplier); baseToken.safeTransfer(registry.treasury(), _fee); unchecked { // unchecked as no possibility of overflow with baseToken precision balance += _netAmount; } if (balance > baseToken.balanceOf(address(this))) revert BalanceMismatch(); emit EntityBalanceReconciled(address(this), _amountOut, _fee); } /** * @notice Permissioned method that allows Endaoment admin to make arbitrary calls acting as this Entity. * @param _target The address to which the call will be made. * @param _value The ETH value that should be forwarded with the call. * @param _data The calldata that will be sent with the call. * @return _return The data returned by the call. */ function callAsEntity(address _target, uint256 _value, bytes memory _data) external payable virtual requiresAuth returns (bytes memory) { (bool _success, bytes memory _response) = payable(_target).call{value: _value}(_data); if (!_success) revert CallFailed(_response); return _response; } /** * @notice Pays out an amount of base tokens from the entity to an address. Transfers the fee calculated by the * default fee multiplier to the treasury. * @param _to The address to receive the tokens. * @param _amount Amount donated in base token. * @dev Reverts with `Unauthorized` if the `msg.sender` is not a privileged role. * @dev Reverts if the fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). * @dev Reverts if the token transfer fails. */ function payout(address _to, uint256 _amount) external virtual requiresAuth { uint32 _feeMultiplier = registry.getPayoutFee(this); _payoutWithFeeMultiplier(_to, _amount, _feeMultiplier); } /** * @notice Pays out an amount of base tokens from the entity to an address. Transfers the fee calculated by the * default fee multiplier to the treasury. * @param _amount Amount donated in base token. * @dev Reverts with `Unauthorized` if the `msg.sender` is not a privileged role. * @dev Reverts if the fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). * @dev Reverts if the token transfer fails. */ function payoutWithOverrides(address _to, uint256 _amount) external virtual requiresAuth { uint32 _feeMultiplier = registry.getPayoutFeeWithOverrides(this); _payoutWithFeeMultiplier(_to, _amount, _feeMultiplier); } /** * @notice Pays out an amount of base tokens from the entity to an address. Transfers fee specified by a privileged role. * @param _amount Amount donated in base token. * @param _feeOverride Payout override configured by an Admin * @dev Reverts with `Unauthorized` if the `msg.sender` is not a privileged role. * @dev Reverts if the fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). * @dev Reverts if the token transfer fails. */ function payoutWithAdminOverrides(address _to, uint256 _amount, uint32 _feeOverride) external virtual requiresAuth { _payoutWithFeeMultiplier(_to, _amount, _feeOverride); } /** * @notice Pays out an amount of base tokens from the entity to an address. Transfers the fee calculated by fee multiplier to the treasury. * @param _to The address to receive the tokens. * @param _amount Contains the amount being paid out (denominated in the base token's units). * @param _feeMultiplier Value indicating the percentage of the Endaoment fee to go to the Endaoment treasury. * @dev Reverts if the token transfer fails. * @dev Reverts if the fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). */ function _payoutWithFeeMultiplier(address _to, uint256 _amount, uint32 _feeMultiplier) internal virtual { if (balance < _amount) revert InsufficientFunds(); (uint256 _netAmount, uint256 _fee) = _calculateFee(_amount, _feeMultiplier); baseToken.safeTransfer(registry.treasury(), _fee); baseToken.safeTransfer(address(_to), _netAmount); unchecked { // unchecked because we've already validated that amount is less than or equal to the balance balance -= _amount; } emit EntityValuePaidOut(address(this), _to, _amount, _fee); } /// @dev Internal helper method to calculate the fee on a base token amount for a given fee multiplier. function _calculateFee(uint256 _amount, uint256 _feeMultiplier) internal pure virtual returns (uint256 _netAmount, uint256 _fee) { if (_feeMultiplier > Math.ZOC) revert InvalidAction(); unchecked { // unchecked as no possibility of overflow with baseToken precision _fee = _amount.zocmul(_feeMultiplier); // unchecked as the _feeMultiplier check with revert above protects against overflow _netAmount = _amount - _fee; } } receive() external payable virtual { emit EntityEthReceived(msg.sender, msg.value); } } // SPDX-License-Identifier: AGPL-3.0-only pragma solidity >=0.8.0; /// @notice Modern and gas efficient ERC20 + EIP-2612 implementation. /// @author Solmate (https://github.com/Rari-Capital/solmate/blob/main/src/tokens/ERC20.sol) /// @author Modified from Uniswap (https://github.com/Uniswap/uniswap-v2-core/blob/master/contracts/UniswapV2ERC20.sol) /// @dev Do not manually set balances without updating totalSupply, as the sum of all user balances must not exceed it. abstract contract ERC20 { /*/////////////////////////////////////////////////////////////// EVENTS //////////////////////////////////////////////////////////////*/ event Transfer(address indexed from, address indexed to, uint256 amount); event Approval(address indexed owner, address indexed spender, uint256 amount); /*/////////////////////////////////////////////////////////////// METADATA STORAGE //////////////////////////////////////////////////////////////*/ string public name; string public symbol; uint8 public immutable decimals; /*/////////////////////////////////////////////////////////////// ERC20 STORAGE //////////////////////////////////////////////////////////////*/ uint256 public totalSupply; mapping(address => uint256) public balanceOf; mapping(address => mapping(address => uint256)) public allowance; /*/////////////////////////////////////////////////////////////// EIP-2612 STORAGE //////////////////////////////////////////////////////////////*/ bytes32 public constant PERMIT_TYPEHASH = keccak256("Permit(address owner,address spender,uint256 value,uint256 nonce,uint256 deadline)"); uint256 internal immutable INITIAL_CHAIN_ID; bytes32 internal immutable INITIAL_DOMAIN_SEPARATOR; mapping(address => uint256) public nonces; /*/////////////////////////////////////////////////////////////// CONSTRUCTOR //////////////////////////////////////////////////////////////*/ constructor( string memory _name, string memory _symbol, uint8 _decimals ) { name = _name; symbol = _symbol; decimals = _decimals; INITIAL_CHAIN_ID = block.chainid; INITIAL_DOMAIN_SEPARATOR = computeDomainSeparator(); } /*/////////////////////////////////////////////////////////////// ERC20 LOGIC //////////////////////////////////////////////////////////////*/ function approve(address spender, uint256 amount) public virtual returns (bool) { allowance[msg.sender][spender] = amount; emit Approval(msg.sender, spender, amount); return true; } function transfer(address to, uint256 amount) public virtual returns (bool) { balanceOf[msg.sender] -= amount; // Cannot overflow because the sum of all user // balances can't exceed the max uint256 value. unchecked { balanceOf[to] += amount; } emit Transfer(msg.sender, to, amount); return true; } function transferFrom( address from, address to, uint256 amount ) public virtual returns (bool) { uint256 allowed = allowance[from][msg.sender]; // Saves gas for limited approvals. if (allowed != type(uint256).max) allowance[from][msg.sender] = allowed - amount; balanceOf[from] -= amount; // Cannot overflow because the sum of all user // balances can't exceed the max uint256 value. unchecked { balanceOf[to] += amount; } emit Transfer(from, to, amount); return true; } /*/////////////////////////////////////////////////////////////// EIP-2612 LOGIC //////////////////////////////////////////////////////////////*/ function permit( address owner, address spender, uint256 value, uint256 deadline, uint8 v, bytes32 r, bytes32 s ) public virtual { require(deadline >= block.timestamp, "PERMIT_DEADLINE_EXPIRED"); // Unchecked because the only math done is incrementing // the owner's nonce which cannot realistically overflow. unchecked { bytes32 digest = keccak256( abi.encodePacked( "\\x19\\x01", DOMAIN_SEPARATOR(), keccak256(abi.encode(PERMIT_TYPEHASH, owner, spender, value, nonces[owner]++, deadline)) ) ); address recoveredAddress = ecrecover(digest, v, r, s); require(recoveredAddress != address(0) && recoveredAddress == owner, "INVALID_SIGNER"); allowance[recoveredAddress][spender] = value; } emit Approval(owner, spender, value); } function DOMAIN_SEPARATOR() public view virtual returns (bytes32) { return block.chainid == INITIAL_CHAIN_ID ? INITIAL_DOMAIN_SEPARATOR : computeDomainSeparator(); } function computeDomainSeparator() internal view virtual returns (bytes32) { return keccak256( abi.encode( keccak256("EIP712Domain(string name,string version,uint256 chainId,address verifyingContract)"), keccak256(bytes(name)), keccak256("1"), block.chainid, address(this) ) ); } /*/////////////////////////////////////////////////////////////// INTERNAL MINT/BURN LOGIC //////////////////////////////////////////////////////////////*/ function _mint(address to, uint256 amount) internal virtual { totalSupply += amount; // Cannot overflow because the sum of all user // balances can't exceed the max uint256 value. unchecked { balanceOf[to] += amount; } emit Transfer(address(0), to, amount); } function _burn(address from, uint256 amount) internal virtual { balanceOf[from] -= amount; // Cannot underflow because a user's balance // will never be larger than the total supply. unchecked { totalSupply -= amount; } emit Transfer(from, address(0), amount); } } // SPDX-License-Identifier: AGPL-3.0-only pragma solidity >=0.8.0; // This contract is modified from Solmate only to import modified Auth.sol on line 5 import {Auth, Authority} from "../Auth.sol"; /// @notice Role based Authority that supports up to 256 roles. /// @author Solmate (https://github.com/Rari-Capital/solmate/blob/main/src/auth/authorities/RolesAuthority.sol) /// @author Modified from Dappsys (https://github.com/dapphub/ds-roles/blob/master/src/roles.sol) contract RolesAuthority is Auth, Authority { /*/////////////////////////////////////////////////////////////// EVENTS //////////////////////////////////////////////////////////////*/ event UserRoleUpdated(address indexed user, uint8 indexed role, bool enabled); event PublicCapabilityUpdated(address indexed target, bytes4 indexed functionSig, bool enabled); event RoleCapabilityUpdated(uint8 indexed role, address indexed target, bytes4 indexed functionSig, bool enabled); /*/////////////////////////////////////////////////////////////// CONSTRUCTOR //////////////////////////////////////////////////////////////*/ constructor(address _owner, Authority _authority) Auth(_owner, _authority) {} /*/////////////////////////////////////////////////////////////// ROLE/USER STORAGE //////////////////////////////////////////////////////////////*/ mapping(address => bytes32) public getUserRoles; mapping(address => mapping(bytes4 => bool)) public isCapabilityPublic; mapping(address => mapping(bytes4 => bytes32)) public getRolesWithCapability; function doesUserHaveRole(address user, uint8 role) public view virtual returns (bool) { return (uint256(getUserRoles[user]) >> role) & 1 != 0; } function doesRoleHaveCapability(uint8 role, address target, bytes4 functionSig) public view virtual returns (bool) { return (uint256(getRolesWithCapability[target][functionSig]) >> role) & 1 != 0; } /*/////////////////////////////////////////////////////////////// AUTHORIZATION LOGIC //////////////////////////////////////////////////////////////*/ function canCall(address user, address target, bytes4 functionSig) public view virtual override returns (bool) { return isCapabilityPublic[target][functionSig] || bytes32(0) != getUserRoles[user] & getRolesWithCapability[target][functionSig]; } /*/////////////////////////////////////////////////////////////// ROLE CAPABILITY CONFIGURATION LOGIC //////////////////////////////////////////////////////////////*/ function setPublicCapability(address target, bytes4 functionSig, bool enabled) public virtual requiresAuth { isCapabilityPublic[target][functionSig] = enabled; emit PublicCapabilityUpdated(target, functionSig, enabled); } function setRoleCapability(uint8 role, address target, bytes4 functionSig, bool enabled) public virtual requiresAuth { if (enabled) { getRolesWithCapability[target][functionSig] |= bytes32(1 << role); } else { getRolesWithCapability[target][functionSig] &= ~bytes32(1 << role); } emit RoleCapabilityUpdated(role, target, functionSig, enabled); } /*/////////////////////////////////////////////////////////////// USER ROLE ASSIGNMENT LOGIC //////////////////////////////////////////////////////////////*/ function setUserRole(address user, uint8 role, bool enabled) public virtual requiresAuth { if (enabled) { getUserRoles[user] |= bytes32(1 << role); } else { getUserRoles[user] &= ~bytes32(1 << role); } emit UserRoleUpdated(user, role, enabled); } } // SPDX-License-Identifier: BSD 3-Clause pragma solidity 0.8.13; library Math { uint256 internal constant ZOC = 1e4; /** * @dev Multiply 2 numbers where at least one is a zoc, return product in original units of the other number. */ function zocmul(uint256 x, uint256 y) internal pure returns (uint256 z) { z = x * y; unchecked { z /= ZOC; } } // Below is WAD math from solmate's FixedPointMathLib. // https://github.com/Rari-Capital/solmate/blob/c8278b3cb948cffda3f1de5a401858035f262060/src/utils/FixedPointMathLib.sol uint256 internal constant WAD = 1e18; // The scalar of ETH and most ERC20s. function mulWadDown(uint256 x, uint256 y) internal pure returns (uint256) { return mulDivDown(x, y, WAD); // Equivalent to (x * y) / WAD rounded down. } function divWadDown(uint256 x, uint256 y) internal pure returns (uint256) { return mulDivDown(x, WAD, y); // Equivalent to (x * WAD) / y rounded down. } // For tokens with 6 decimals like USDC, these scale by 1e6 (one million). function mulMilDown(uint256 x, uint256 y) internal pure returns (uint256) { return mulDivDown(x, y, 1e6); // Equivalent to (x * y) / 1e6 rounded down. } function divMilDown(uint256 x, uint256 y) internal pure returns (uint256) { return mulDivDown(x, 1e6, y); // Equivalent to (x * 1e6) / y rounded down. } /*////////////////////////////////////////////////////////////// LOW LEVEL FIXED POINT OPERATIONS //////////////////////////////////////////////////////////////*/ function mulDivDown(uint256 x, uint256 y, uint256 denominator) internal pure returns (uint256 z) { assembly { // Store x * y in z for now. z := mul(x, y) // Equivalent to require(denominator != 0 && (x == 0 || (x * y) / x == y)) if iszero(and(iszero(iszero(denominator)), or(iszero(x), eq(div(z, x), y)))) { revert(0, 0) } // Divide z by the denominator. z := div(z, denominator) } } } // SPDX-License-Identifier: AGPL-3.0-only pragma solidity >=0.8.0; // This contract is modified from Solmate only to make requiresAuth virtual on line 26 /// @notice Provides a flexible and updatable auth pattern which is completely separate from application logic. /// @author Solmate (https://github.com/Rari-Capital/solmate/blob/main/src/auth/Auth.sol) /// @author Modified from Dappsys (https://github.com/dapphub/ds-auth/blob/master/src/auth.sol) abstract contract Auth { event OwnerUpdated(address indexed user, address indexed newOwner); event AuthorityUpdated(address indexed user, Authority indexed newAuthority); address public owner; Authority public authority; constructor(address _owner, Authority _authority) { owner = _owner; authority = _authority; emit OwnerUpdated(msg.sender, _owner); emit AuthorityUpdated(msg.sender, _authority); } modifier requiresAuth() virtual { require(isAuthorized(msg.sender, msg.sig), "UNAUTHORIZED"); _; } function isAuthorized(address user, bytes4 functionSig) internal view virtual returns (bool) { Authority auth = authority; // Memoizing authority saves us a warm SLOAD, around 100 gas. // Checking if the caller is the owner only after calling the authority saves gas in most cases, but be // aware that this makes protected functions uncallable even to the owner if the authority is out of order. return (address(auth) != address(0) && auth.canCall(user, address(this), functionSig)) || user == owner; } function setAuthority(Authority newAuthority) public virtual { // We check if the caller is the owner first because we want to ensure they can // always swap out the authority even if it's reverting or using up a lot of gas. require(msg.sender == owner || authority.canCall(msg.sender, address(this), msg.sig)); authority = newAuthority; emit AuthorityUpdated(msg.sender, newAuthority); } function setOwner(address newOwner) public virtual requiresAuth { owner = newOwner; emit OwnerUpdated(msg.sender, newOwner); } } /// @notice A generic interface for a contract which provides authorization data to an Auth instance. /// @author Solmate (https://github.com/Rari-Capital/solmate/blob/main/src/auth/Auth.sol) /// @author Modified from Dappsys (https://github.com/dapphub/ds-auth/blob/master/src/auth.sol) interface Authority { function canCall(address user, address target, bytes4 functionSig) external view returns (bool); } // SPDX-License-Identifier: AGPL-3.0-only pragma solidity >=0.8.0; import {ERC20} from "../tokens/ERC20.sol"; /// @notice Safe ETH and ERC20 transfer library that gracefully handles missing return values. /// @author Solmate (https://github.com/Rari-Capital/solmate/blob/main/src/utils/SafeTransferLib.sol) /// @author Modified from Gnosis (https://github.com/gnosis/gp-v2-contracts/blob/main/src/contracts/libraries/GPv2SafeERC20.sol) /// @dev Use with caution! Some functions in this library knowingly create dirty bits at the destination of the free memory pointer. library SafeTransferLib { /*/////////////////////////////////////////////////////////////// ETH OPERATIONS //////////////////////////////////////////////////////////////*/ function safeTransferETH(address to, uint256 amount) internal { bool callStatus; assembly { // Transfer the ETH and store if it succeeded or not. callStatus := call(gas(), to, amount, 0, 0, 0, 0) } require(callStatus, "ETH_TRANSFER_FAILED"); } /*/////////////////////////////////////////////////////////////// ERC20 OPERATIONS //////////////////////////////////////////////////////////////*/ function safeTransferFrom( ERC20 token, address from, address to, uint256 amount ) internal { bool callStatus; assembly { // Get a pointer to some free memory. let freeMemoryPointer := mload(0x40) // Write the abi-encoded calldata to memory piece by piece: mstore(freeMemoryPointer, 0x23b872dd00000000000000000000000000000000000000000000000000000000) // Begin with the function selector. mstore(add(freeMemoryPointer, 4), and(from, 0xffffffffffffffffffffffffffffffffffffffff)) // Mask and append the "from" argument. mstore(add(freeMemoryPointer, 36), and(to, 0xffffffffffffffffffffffffffffffffffffffff)) // Mask and append the "to" argument. mstore(add(freeMemoryPointer, 68), amount) // Finally append the "amount" argument. No mask as it's a full 32 byte value. // Call the token and store if it succeeded or not. // We use 100 because the calldata length is 4 + 32 * 3. callStatus := call(gas(), token, 0, freeMemoryPointer, 100, 0, 0) } require(didLastOptionalReturnCallSucceed(callStatus), "TRANSFER_FROM_FAILED"); } function safeTransfer( ERC20 token, address to, uint256 amount ) internal { bool callStatus; assembly { // Get a pointer to some free memory. let freeMemoryPointer := mload(0x40) // Write the abi-encoded calldata to memory piece by piece: mstore(freeMemoryPointer, 0xa9059cbb00000000000000000000000000000000000000000000000000000000) // Begin with the function selector. mstore(add(freeMemoryPointer, 4), and(to, 0xffffffffffffffffffffffffffffffffffffffff)) // Mask and append the "to" argument. mstore(add(freeMemoryPointer, 36), amount) // Finally append the "amount" argument. No mask as it's a full 32 byte value. // Call the token and store if it succeeded or not. // We use 68 because the calldata length is 4 + 32 * 2. callStatus := call(gas(), token, 0, freeMemoryPointer, 68, 0, 0) } require(didLastOptionalReturnCallSucceed(callStatus), "TRANSFER_FAILED"); } function safeApprove( ERC20 token, address to, uint256 amount ) internal { bool callStatus; assembly { // Get a pointer to some free memory. let freeMemoryPointer := mload(0x40) // Write the abi-encoded calldata to memory piece by piece: mstore(freeMemoryPointer, 0x095ea7b300000000000000000000000000000000000000000000000000000000) // Begin with the function selector. mstore(add(freeMemoryPointer, 4), and(to, 0xffffffffffffffffffffffffffffffffffffffff)) // Mask and append the "to" argument. mstore(add(freeMemoryPointer, 36), amount) // Finally append the "amount" argument. No mask as it's a full 32 byte value. // Call the token and store if it succeeded or not. // We use 68 because the calldata length is 4 + 32 * 2. callStatus := call(gas(), token, 0, freeMemoryPointer, 68, 0, 0) } require(didLastOptionalReturnCallSucceed(callStatus), "APPROVE_FAILED"); } /*/////////////////////////////////////////////////////////////// INTERNAL HELPER LOGIC //////////////////////////////////////////////////////////////*/ function didLastOptionalReturnCallSucceed(bool callStatus) private pure returns (bool success) { assembly { // Get how many bytes the call returned. let returnDataSize := returndatasize() // If the call reverted: if iszero(callStatus) { // Copy the revert message into memory. returndatacopy(0, 0, returnDataSize) // Revert with the same message. revert(0, returnDataSize) } switch returnDataSize case 32 { // Copy the return data into memory. returndatacopy(0, 0, returnDataSize) // Set success to whether it returned true. success := iszero(iszero(mload(0))) } case 0 { // There was no return data. success := 1 } default { // It returned some malformed input. success := 0 } } } } //SPDX-License-Identifier: BSD 3-Clause pragma solidity 0.8.13; import {Auth, Authority} from "./lib/auth/Auth.sol"; import {RolesAuthority} from "./lib/auth/authorities/RolesAuthority.sol"; // --- Errors --- error OwnershipInvalid(); /** * @notice RegistryAuth - contract to control ownership of the Registry. */ contract RegistryAuth is RolesAuthority { /// @notice Emitted when the first step of an ownership transfer (proposal) is done. event OwnershipTransferProposed(address indexed user, address indexed newOwner); /// @notice Emitted when the second step of an ownership transfer (claim) is done. event OwnershipChanged(address indexed owner, address indexed newOwner); // --- Storage --- /// @notice Pending owner for 2 step ownership transfer address public pendingOwner; // --- Constructor --- constructor(address _owner, Authority _authority) RolesAuthority(_owner, _authority) {} /** * @notice Starts the 2 step process of transferring registry authorization to a new owner. * @param _newOwner Proposed new owner of registry authorization. */ function transferOwnership(address _newOwner) external requiresAuth { pendingOwner = _newOwner; emit OwnershipTransferProposed(msg.sender, _newOwner); } /** * @notice Completes the 2 step process of transferring registry authorization to a new owner. * This function must be called by the proposed new owner. */ function claimOwnership() external { if (msg.sender != pendingOwner) revert OwnershipInvalid(); emit OwnershipChanged(owner, pendingOwner); owner = pendingOwner; pendingOwner = address(0); } /** * @notice Old approach of setting a new owner in a single step. * @dev This function throws an error to force use of the new 2-step approach. */ function setOwner(address /*newOwner*/ ) public view override requiresAuth { revert OwnershipInvalid(); } } //SPDX-License-Identifier: BSD 3-Clause pragma solidity >=0.8.0; error ETHAmountInMismatch(); /** * @notice ISwapWrapper is the interface that all swap wrappers should implement. * This will be used to support swap protocols like Uniswap V2 and V3, Sushiswap, 1inch, etc. */ interface ISwapWrapper { /// @notice Event emitted after a successful swap. event WrapperSwapExecuted( address indexed tokenIn, address indexed tokenOut, address sender, address indexed recipient, uint256 amountIn, uint256 amountOut ); /// @notice Name of swap wrapper for UX readability. function name() external returns (string memory); /** * @notice Swap function. Generally we expect the implementer to call some exactAmountIn-like swap method, and so the documentation * is written with this in mind. However, the method signature is general enough to support exactAmountOut swaps as well. * @param _tokenIn Token to be swapped (or 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE for ETH). * @param _tokenOut Token to receive (or 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE for ETH). * @param _recipient Receiver of `_tokenOut`. * @param _amount Amount of `_tokenIn` that should be swapped. * @param _data Additional data that the swap wrapper may require to execute the swap. * @return Amount of _tokenOut received. */ function swap(address _tokenIn, address _tokenOut, address _recipient, uint256 _amount, bytes calldata _data) external payable returns (uint256); } //SPDX-License-Identifier: BSD 3-Clause pragma solidity >=0.8.0; import {ReentrancyGuard} from "solmate/utils/ReentrancyGuard.sol"; import {ERC20} from "solmate/tokens/ERC20.sol"; import {SafeTransferLib} from "solmate/utils/SafeTransferLib.sol"; import {Registry} from "./Registry.sol"; import {Entity} from "./Entity.sol"; import {EndaomentAuth} from "./lib/auth/EndaomentAuth.sol"; import {Math} from "./lib/Math.sol"; abstract contract Portfolio is ERC20, EndaomentAuth, ReentrancyGuard { using Math for uint256; using SafeTransferLib for ERC20; Registry public immutable registry; bool public immutable async; uint256 public cap; address public feeTreasury; uint256 public depositFee; uint256 public redemptionFee; address public immutable asset; address public immutable receiptAsset; ERC20 public immutable baseToken; bool public didShutdown; uint256 public timestampAumFeesTaken; uint256 public aumRate; uint256 internal constant MAX_AUM_RATE = 3168808782; error InvalidSwapper(); error InvalidRate(); error TransferDisallowed(); error DepositAfterShutdown(); error DidShutdown(); error NotEntity(); error BadCheckCapImplementation(); error ExceedsCap(); error PercentageOver100(); error RoundsToZero(); error Slippage(); error CallFailed(bytes response); /// @notice `sender` has exchanged `assets` (after fees) for `shares`, and transferred those `shares` to `receiver`. /// The sender paid a total of `depositAmount` and was charged `fee` for the transaction. event Deposit( address indexed sender, address indexed receiver, uint256 assets, uint256 shares, uint256 depositAmount, uint256 fee ); /// @notice `sender` has exchanged `shares` for `assets`, and transferred those `assets` to `receiver`. /// The sender received a net of `redeemedAmount` after the conversion of `assets` into base tokens /// and was charged `fee` for the transaction. event Redeem( address indexed sender, address indexed receiver, uint256 assets, uint256 shares, uint256 redeemedAmount, uint256 fee ); /// @notice Event emitted when `cap` is set. event CapSet(uint256 cap); /// @notice Event emitted when `depositFee` is set. event DepositFeeSet(uint256 fee); /// @notice Event emitted when `redemptionFee` is set. event RedemptionFeeSet(uint256 fee); /// @notice Event emitted when `feeTreasury` is set. event FeeTreasurySet(address feeTreasury); /// @notice Event emitted when management takes fees. event FeesTaken(uint256 amount); /// @notice Event emitted when AUM fees are taken. event AumFeesTaken(uint256 feeAmount, uint256 timeDelta); /// @notice Event emitted when `aumRate` is set. event AumRateSet(uint256 rate); /// @notice Event emitted when admin forcefully swaps portfolio asset balance for baseToken. event Shutdown(uint256 assetAmount, uint256 baseTokenOut); /** * @param _registry Endaoment registry. * @param _receiptAsset Address of token that the portfolio receives from a deposit. * @param _name Name of the ERC20 Portfolio share tokens. * @param _async Whether the portfolio is async for deposits and redeems. Typically used for T+N portfolios * @param _symbol Symbol of the ERC20 Portfolio share tokens. * @param _cap Amount in baseToken that value of totalAssets should not exceed. * @param _depositFee Percentage fee as ZOC that will go to treasury on asset deposit. * @param _redemptionFee Percentage fee as ZOC that will go to treasury on share redemption. * @param _aumRate Percentage fee per second (as WAD) that should accrue to treasury as AUM fee. (1e16 = 1%). */ constructor( Registry _registry, address _receiptAsset, string memory _name, string memory _symbol, bool _async, uint256 _cap, address _feeTreasury, uint256 _depositFee, uint256 _redemptionFee, uint256 _aumRate ) ERC20(_name, _symbol, ERC20(_getAsset(_receiptAsset)).decimals()) { __initEndaomentAuth(_registry, "portfolio"); registry = _registry; async = _async; feeTreasury = _feeTreasury; emit FeeTreasurySet(_feeTreasury); if (_redemptionFee > Math.ZOC) revert PercentageOver100(); redemptionFee = _redemptionFee; emit RedemptionFeeSet(_redemptionFee); if (_depositFee > Math.ZOC) revert PercentageOver100(); depositFee = _depositFee; emit DepositFeeSet(_depositFee); cap = _cap; emit CapSet(_cap); receiptAsset = _receiptAsset; asset = _getAsset(_receiptAsset); baseToken = registry.baseToken(); if (_aumRate > MAX_AUM_RATE) revert InvalidRate(); aumRate = _aumRate; emit AumRateSet(_aumRate); timestampAumFeesTaken = block.timestamp; } /** * @notice Returns the underlying asset for the `receiptAsset`. * @param _receiptAsset Address of token that the portfolio receives from a deposit. * @return Address of the underlying asset. */ function _getAsset(address _receiptAsset) internal view virtual returns (address); /** * @notice Function used to determine whether an Entity is active on the registry. * @param _entity The Entity. */ function _isEntity(Entity _entity) internal view returns (bool) { return registry.isActiveEntity(_entity); } /** * @notice Set the Portfolio cap. * @param _amount Amount, denominated in baseToken. */ function setCap(uint256 _amount) external requiresAuth { cap = _amount; emit CapSet(_amount); } /** * @notice Set deposit fee. * @param _pct Percentage as ZOC (e.g. 1000 = 10%). */ function setDepositFee(uint256 _pct) external requiresAuth { if (_pct > Math.ZOC) revert PercentageOver100(); depositFee = _pct; emit DepositFeeSet(_pct); } /** * @notice Set redemption fee. * @param _pct Percentage as ZOC (e.g. 1000 = 10%). */ function setRedemptionFee(uint256 _pct) external requiresAuth { if (_pct > Math.ZOC) revert PercentageOver100(); redemptionFee = _pct; emit RedemptionFeeSet(_pct); } /** * @notice Set fee treasury. * @param _feeTreasury Address of the treasury that should receive fees. * */ function setFeeTreasury(address _feeTreasury) external requiresAuth { feeTreasury = _feeTreasury; emit FeeTreasurySet(_feeTreasury); } /** * @notice Set AUM rate. * @param _pct Percentage *per second* as WAD (e.g. .01e18 / 365.25 days = 1% per year). */ function setAumRate(uint256 _pct) external requiresAuth { // check to make sure _pct isn't above 10% over a year (.1e18 / 365.25 days = 3168808782 per second) if (_pct > MAX_AUM_RATE) revert InvalidRate(); takeAumFees(); aumRate = _pct; emit AumRateSet(_pct); } /** * @notice Total amount of the underlying asset that is managed by the Portfolio. * @return Total amount of the underlying asset. */ function totalAssets() public view returns (uint256) { return convertReceiptAssetsToAssets(totalReceiptAssets()); } /** * @notice Total amount of the receipt asset that is managed by the Portfolio. * @return Total amount of the receipt asset. */ function totalReceiptAssets() public view returns (uint256) { return ERC20(receiptAsset).balanceOf(address(this)); } /** * @notice Calculates the equivalent amount of assets for the given amount of receipt assets. * @param _receiptAssets Amount of receipt assets to convert. * @return Amount of assets. */ function convertReceiptAssetsToAssets(uint256 _receiptAssets) public view virtual returns (uint256); /** * @notice Takes some amount of receipt assets from this portfolio as management fee. * @param _amountReceiptAssets Amount of receipt assets to take. */ function takeFees(uint256 _amountReceiptAssets) external requiresAuth { ERC20(receiptAsset).safeTransfer(feeTreasury, _amountReceiptAssets); emit FeesTaken(_amountReceiptAssets); } /** * @notice Takes accrued percentage of assets from this portfolio as AUM fee. */ function takeAumFees() public { if (didShutdown) return _takeAumFeesShutdown(); uint256 _totalReceiptAssets = totalReceiptAssets(); uint256 _period = block.timestamp - timestampAumFeesTaken; uint256 _feeAmount = _calculateAumFee(_totalReceiptAssets, _period); if (_feeAmount > _totalReceiptAssets) _feeAmount = _totalReceiptAssets; if (_feeAmount > 0 || totalSupply == 0) { // in either case, we want to set `timestampAumFeesTaken`... timestampAumFeesTaken = block.timestamp; // but we only want to transfer/emit on non-zero amount if (_feeAmount > 0) { ERC20(receiptAsset).safeTransfer(feeTreasury, _feeAmount); emit AumFeesTaken(_feeAmount, _period); } } } /** * @notice Takes accrued percentage of post-shutdown baseToken from this portfolio as AUM fee. */ function _takeAumFeesShutdown() internal { uint256 _totalAssets = baseToken.balanceOf(address(this)); uint256 _period = block.timestamp - timestampAumFeesTaken; uint256 _feeAmount = _calculateAumFee(_totalAssets, _period); if (_feeAmount > _totalAssets) _feeAmount = _totalAssets; // in `takeAumFees`, the following conditional checks totalSupply as well, solving a first deposit corner case. // In this case, we don't need to check, because deposits aren't allowed after shutdown. if (_feeAmount > 0) { timestampAumFeesTaken = block.timestamp; baseToken.safeTransfer(feeTreasury, _feeAmount); emit AumFeesTaken(_feeAmount, _period); } } /** * @notice Exchange `_amountBaseToken` for some amount of Portfolio shares. * @param _amountBaseToken The amount of the Entity's baseToken to deposit. * @param _data Data that the portfolio needs to make the deposit. In some cases, this will be swap parameters. * The first 32 bytes of this data should be the ABI-encoded `minSharesOut`. * @return shares The amount of shares that this deposit yields to the Entity. * @dev If the portfolio is `async`, shares will not be minted on deposit. Instead, each async * portfolio will have a unique implementation that will handle the minting of those shares * elsewhere e.g. T+N portfolios perform minting in consolidations. */ function deposit(uint256 _amountBaseToken, bytes calldata _data) external nonReentrant returns (uint256) { // All portfolios should revert on deposit after shutdown if (didShutdown) revert DepositAfterShutdown(); // All portfolios should revert on a deposit from a non-entity (or inactive one) if (!_isEntity(Entity(payable(msg.sender)))) revert NotEntity(); // All portfolios should take AUM fees takeAumFees(); // All portfolios should make a deposit // All transferring of baseToken and share calculation should occur inside _deposit // TODO: move fee taking logic here instead of `_deposit` for all portfolios and update tests (uint256 _shares, uint256 _assets, uint256 _fee) = _deposit(_amountBaseToken, _data); // Only sync portfolios require minting and share amount checking on deposit if (!async) { if (_shares < abi.decode(_data, (uint256))) revert Slippage(); if (_shares == 0) revert RoundsToZero(); // mint shares _mint(msg.sender, _shares); } // And check cap _checkCap(); // And emit an event emit Deposit(msg.sender, msg.sender, _assets, _shares, _amountBaseToken, _fee); return _shares; } /** * @notice Check to make sure the cap has not been exceeded. * @dev Most portfolios have the same asset and baseToken, so the _checkCap implementation here is written to accomodate * that situation. For portfolios where that is not the case, this method needs to be overwritten to ensure the cap * (denominated in baseToken) is properly compared to the number of assets. */ function _checkCap() internal virtual { if (asset != address(baseToken)) revert BadCheckCapImplementation(); if (totalAssets() > cap) revert ExceedsCap(); } /** * @notice Exchange `_amountIn` for some amount of Portfolio shares. * @dev Should include the transferring of baseToken and conversion to shares. * @param _amountIn The amount of the Entity's baseToken to deposit. * @param _data Data that the portfolio needs to make the deposit. In some cases, this will be swap parameters. * @return shares The amount of shares that this deposit yields to the Entity. * @return assets The amount of assets that this deposit yields to the portfolio. * @return fee The baseToken fee that this deposit yields to the treasury. */ function _deposit(uint256 _amountIn, bytes calldata _data) internal virtual returns (uint256 shares, uint256 assets, uint256 fee); /** * @notice Exchange `_amountShares` for some amount of baseToken. * @param _amountShares The amount of the Entity's portfolio shares to exchange. * @param _data Data that the portfolio needs to make the redemption. In some cases, this will be swap parameters. * @return baseTokenOut The amount of baseToken that this redemption yields to the Entity. */ function redeem(uint256 _amountShares, bytes calldata _data) external nonReentrant returns (uint256 /* baseTokenOut */ ) { // All redeems should take AUM fees takeAumFees(); // All portfolios should handle redemption after shutdown if (didShutdown) return _redeemShutdown(_amountShares); // All portfolios should handle the actual redeem of shares (uint256 _assetsOut, uint256 _baseTokenOut) = _redeem(_amountShares, _data); // All portfolios should burn the redeemed shares from the caller _burn(msg.sender, _amountShares); // Portfolios must signal amount of assets being redeemed, which must be non-zero if (_assetsOut == 0) revert RoundsToZero(); // Any portfolio that outputs base token should transfer to caller and charge fee for treasury uint256 _netAmount; uint256 _fee; if (_baseTokenOut > 0) { (_netAmount, _fee) = _calculateFee(_baseTokenOut, redemptionFee); baseToken.safeTransfer(feeTreasury, _fee); baseToken.safeTransfer(msg.sender, _netAmount); } // And emit an event emit Redeem(msg.sender, msg.sender, _assetsOut, _amountShares, _netAmount, _fee); return _netAmount; } /** * @notice Exchange `_amountShares` for some amount of Portfolio assets. * @param _amountShares The amount of portfolio shares to exchange. * @param _data Data that the portfolio needs to redeem the assets. In some cases, this will be swap parameters. * @return assetsOut The amount of assets that this redemption yielded (and then converted to baseToken). * @return baseTokenOut Amount in baseToken to which these assets were converted. */ function _redeem(uint256 _amountShares, bytes calldata _data) internal virtual returns (uint256 assetsOut, uint256 baseTokenOut); /** * @notice Handles redemption after shutdown, exchanging shares for baseToken. * @param _amountShares Shares being redeemed. * @return Amount of baseToken received. */ function _redeemShutdown(uint256 _amountShares) internal returns (uint256) { uint256 _baseTokenOut = convertToAssetsShutdown(_amountShares); _burn(msg.sender, _amountShares); (uint256 _netAmount, uint256 _fee) = _calculateFee(_baseTokenOut, redemptionFee); baseToken.safeTransfer(feeTreasury, _fee); baseToken.safeTransfer(msg.sender, _netAmount); emit Redeem(msg.sender, msg.sender, _baseTokenOut, _amountShares, _netAmount, _fee); return _netAmount; } /** * @notice Calculates the amount of shares that the Portfolio should exchange for the amount of assets provided. * @param _assets Amount of assets. * @return Amount of shares. */ function convertToShares(uint256 _assets) public view returns (uint256) { uint256 _supply = totalSupply; // Saves an extra SLOAD if totalSupply is non-zero. return _supply == 0 ? _assets : _assets.mulDivDown(_supply, totalAssets()); } /** * @notice Calculates the amount of assets that the Portfolio should exchange for the amount of shares provided. * @param _shares Amount of shares. * @return Amount of assets. */ function convertToAssets(uint256 _shares) public view returns (uint256) { uint256 _supply = totalSupply; // Saves an extra SLOAD if totalSupply is non-zero. return _supply == 0 ? _shares : _shares.mulDivDown(totalAssets(), _supply); } /** * @notice Calculates the amount of baseToken that the Portfolio should exchange for the amount of shares provided. * Used only if the Portfolio has shut down. * @dev Rounding down here favors the portfolio, so the user gets slightly less and the portfolio gets slightly more, * that way it prevents a situation where the user is owed x but the vault only has x - epsilon, where epsilon is * some tiny number due to rounding error. * @param _shares Amount of shares. * @return Amount of baseToken. */ function convertToAssetsShutdown(uint256 _shares) public view returns (uint256) { uint256 _supply = totalSupply; // Saves an extra SLOAD if totalSupply is non-zero. return _supply == 0 ? _shares : _shares.mulDivDown(baseToken.balanceOf(address(this)), _supply); } /** * @notice Exit out all assets of portfolio for baseToken. Must persist a mechanism for entities to redeem their shares for baseToken. * @param _data Data that the portfolio needs to exit from asset. Consult the portfolio's `_exit` method to determine * the correct format for this data. * @return baseTokenOut The amount of baseToken that this exit yielded. */ function shutdown(bytes calldata _data) external requiresAuth returns (uint256 baseTokenOut) { if (didShutdown) revert DidShutdown(); didShutdown = true; uint256 _assetsOut = totalAssets(); // In most cases, _actualAssetsOut will equal _assetsOut, but in SingleTokenPortfolio, it may be less. (uint256 _actualAssetsOut, uint256 _baseTokenOut) = _exit(_assetsOut, _data); emit Shutdown(_actualAssetsOut, _baseTokenOut); return _baseTokenOut; } /** * @notice Convert some amount of asset into baseToken, either partially or fully exiting the portfolio asset. * @dev This method is used in `redeem` and `shutdown` calls. * @param _amount The amount of the Entity's portfolio asset to exchange. * @param _data Data that the portfolio needs to exit from asset. In some cases, this will be swap parameters. Consult the portfolio's * `_exit` method to determine the correct format for this data. * @return actualAssetsOut The amount of assets that were exited. In most cases, this will be equal to `_amount`, but may differ * by some errorMarginPct in SingleTokenPortfolio. * @return baseTokenOut The amount of baseToken that this exit yielded. */ function _exit(uint256 _amount, bytes calldata _data) internal virtual returns (uint256 actualAssetsOut, uint256 baseTokenOut); /// @notice `transfer` disabled on Portfolio tokens. function transfer( address, // to uint256 // amount ) public pure override returns (bool) { revert TransferDisallowed(); } /// @notice `transferFrom` disabled on Portfolio tokens. function transferFrom( address, /* from */ address, /* to */ uint256 /* amount */ ) public pure override returns (bool) { revert TransferDisallowed(); } /// @notice `approve` disabled on Portfolio tokens. function approve( address, /* to */ uint256 /* amount */ ) public pure override returns (bool) { revert TransferDisallowed(); } /// @notice `permit` disabled on Portfolio tokens. function permit( address, /* owner */ address, /* spender */ uint256, /* value */ uint256, /* deadline */ uint8, /* v */ bytes32, /* r */ bytes32 /* s */ ) public pure override { revert TransferDisallowed(); } /** * @notice Permissioned method that allows Endaoment admin to make arbitrary calls acting as this Portfolio. * @param _target The address to which the call will be made. * @param _value The ETH value that should be forwarded with the call. * @param _data The calldata that will be sent with the call. * @return _return The data returned by the call. */ function callAsPortfolio(address _target, uint256 _value, bytes memory _data) external payable requiresAuth returns (bytes memory) { (bool _success, bytes memory _response) = payable(_target).call{value: _value}(_data); if (!_success) revert CallFailed(_response); return _response; } /** * @notice Internal helper method to calculate the fee on a base token amount for a given fee multiplier. * @param _amount Amount of baseToken. * @param _feeMultiplier Multiplier (as zoc) to apply to the amount. * @return _netAmount The amount of baseToken after the fee is applied. * @return _fee The amount of baseToken to be taken as a fee. */ function _calculateFee(uint256 _amount, uint256 _feeMultiplier) internal pure returns (uint256 _netAmount, uint256 _fee) { if (_feeMultiplier > Math.ZOC) revert PercentageOver100(); unchecked { // unchecked as no possibility of overflow with baseToken precision _fee = _amount.zocmul(_feeMultiplier); // unchecked as the _feeMultiplier check with revert above protects against overflow _netAmount = _amount - _fee; } } /** * @notice Helper method to calculate AUM fee based on assets and time elapsed. * @param _totalAssets Assets over which to calculate AUM fee. * @param _period Seconds elapsed since AUM fee was last taken. * @dev We chose to calculate using simple interest rather than compound interest because the error was small and * simple interest is easier to calculate, reason about, and test. * @return _aumFee The amount of baseToken to be taken as AUM fee. */ function _calculateAumFee(uint256 _totalAssets, uint256 _period) internal view returns (uint256) { if (_totalAssets == 0 || aumRate == 0 || _period == 0) return 0; // _period * aumRate is safe; max expected aum rate * 10 years of seconds is just over 1 WAD return _totalAssets.mulWadDown(_period * aumRate); } } // SPDX-License-Identifier: AGPL-3.0-only pragma solidity >=0.8.0; /// @notice Gas optimized reentrancy protection for smart contracts. /// @author Modified Solmate (https://github.com/Rari-Capital/solmate/blob/main/src/utils/ReentrancyGuard.sol) /// @author Modified from OpenZeppelin (https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/contracts/security/ReentrancyGuard.sol) abstract contract ReentrancyGuard { uint256 private reentrancyStatus; error Reentrancy(); function __initReentrancyGuard() internal { if (reentrancyStatus != 0) revert Reentrancy(); reentrancyStatus = 1; } modifier nonReentrant() { if (reentrancyStatus != 1) revert Reentrancy(); reentrancyStatus = 2; _; reentrancyStatus = 1; } } // SPDX-License-Identifier: AGPL-3.0-only pragma solidity >=0.8.0; /// @notice Gas optimized reentrancy protection for smart contracts. /// @author Solmate (https://github.com/Rari-Capital/solmate/blob/main/src/utils/ReentrancyGuard.sol) /// @author Modified from OpenZeppelin (https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/contracts/security/ReentrancyGuard.sol) abstract contract ReentrancyGuard { uint256 private reentrancyStatus = 1; modifier nonReentrant() { require(reentrancyStatus == 1, "REENTRANCY"); reentrancyStatus = 2; _; reentrancyStatus = 1; } }
File 2 of 9: FiatTokenProxy
pragma solidity ^0.4.24; // File: zos-lib/contracts/upgradeability/Proxy.sol /** * @title Proxy * @dev Implements delegation of calls to other contracts, with proper * forwarding of return values and bubbling of failures. * It defines a fallback function that delegates all calls to the address * returned by the abstract _implementation() internal function. */ contract Proxy { /** * @dev Fallback function. * Implemented entirely in `_fallback`. */ function () payable external { _fallback(); } /** * @return The Address of the implementation. */ function _implementation() internal view returns (address); /** * @dev Delegates execution to an implementation contract. * This is a low level function that doesn't return to its internal call site. * It will return to the external caller whatever the implementation returns. * @param implementation Address to delegate. */ function _delegate(address implementation) internal { assembly { // Copy msg.data. We take full control of memory in this inline assembly // block because it will not return to Solidity code. We overwrite the // Solidity scratch pad at memory position 0. calldatacopy(0, 0, calldatasize) // Call the implementation. // out and outsize are 0 because we don't know the size yet. let result := delegatecall(gas, implementation, 0, calldatasize, 0, 0) // Copy the returned data. returndatacopy(0, 0, returndatasize) switch result // delegatecall returns 0 on error. case 0 { revert(0, returndatasize) } default { return(0, returndatasize) } } } /** * @dev Function that is run as the first thing in the fallback function. * Can be redefined in derived contracts to add functionality. * Redefinitions must call super._willFallback(). */ function _willFallback() internal { } /** * @dev fallback implementation. * Extracted to enable manual triggering. */ function _fallback() internal { _willFallback(); _delegate(_implementation()); } } // File: openzeppelin-solidity/contracts/AddressUtils.sol /** * Utility library of inline functions on addresses */ library AddressUtils { /** * Returns whether the target address is a contract * @dev This function will return false if invoked during the constructor of a contract, * as the code is not actually created until after the constructor finishes. * @param addr address to check * @return whether the target address is a contract */ function isContract(address addr) internal view returns (bool) { uint256 size; // XXX Currently there is no better way to check if there is a contract in an address // than to check the size of the code at that address. // See https://ethereum.stackexchange.com/a/14016/36603 // for more details about how this works. // TODO Check this again before the Serenity release, because all addresses will be // contracts then. // solium-disable-next-line security/no-inline-assembly assembly { size := extcodesize(addr) } return size > 0; } } // File: zos-lib/contracts/upgradeability/UpgradeabilityProxy.sol /** * @title UpgradeabilityProxy * @dev This contract implements a proxy that allows to change the * implementation address to which it will delegate. * Such a change is called an implementation upgrade. */ contract UpgradeabilityProxy is Proxy { /** * @dev Emitted when the implementation is upgraded. * @param implementation Address of the new implementation. */ event Upgraded(address implementation); /** * @dev Storage slot with the address of the current implementation. * This is the keccak-256 hash of "org.zeppelinos.proxy.implementation", and is * validated in the constructor. */ bytes32 private constant IMPLEMENTATION_SLOT = 0x7050c9e0f4ca769c69bd3a8ef740bc37934f8e2c036e5a723fd8ee048ed3f8c3; /** * @dev Contract constructor. * @param _implementation Address of the initial implementation. */ constructor(address _implementation) public { assert(IMPLEMENTATION_SLOT == keccak256("org.zeppelinos.proxy.implementation")); _setImplementation(_implementation); } /** * @dev Returns the current implementation. * @return Address of the current implementation */ function _implementation() internal view returns (address impl) { bytes32 slot = IMPLEMENTATION_SLOT; assembly { impl := sload(slot) } } /** * @dev Upgrades the proxy to a new implementation. * @param newImplementation Address of the new implementation. */ function _upgradeTo(address newImplementation) internal { _setImplementation(newImplementation); emit Upgraded(newImplementation); } /** * @dev Sets the implementation address of the proxy. * @param newImplementation Address of the new implementation. */ function _setImplementation(address newImplementation) private { require(AddressUtils.isContract(newImplementation), "Cannot set a proxy implementation to a non-contract address"); bytes32 slot = IMPLEMENTATION_SLOT; assembly { sstore(slot, newImplementation) } } } // File: zos-lib/contracts/upgradeability/AdminUpgradeabilityProxy.sol /** * @title AdminUpgradeabilityProxy * @dev This contract combines an upgradeability proxy with an authorization * mechanism for administrative tasks. * All external functions in this contract must be guarded by the * `ifAdmin` modifier. See ethereum/solidity#3864 for a Solidity * feature proposal that would enable this to be done automatically. */ contract AdminUpgradeabilityProxy is UpgradeabilityProxy { /** * @dev Emitted when the administration has been transferred. * @param previousAdmin Address of the previous admin. * @param newAdmin Address of the new admin. */ event AdminChanged(address previousAdmin, address newAdmin); /** * @dev Storage slot with the admin of the contract. * This is the keccak-256 hash of "org.zeppelinos.proxy.admin", and is * validated in the constructor. */ bytes32 private constant ADMIN_SLOT = 0x10d6a54a4754c8869d6886b5f5d7fbfa5b4522237ea5c60d11bc4e7a1ff9390b; /** * @dev Modifier to check whether the `msg.sender` is the admin. * If it is, it will run the function. Otherwise, it will delegate the call * to the implementation. */ modifier ifAdmin() { if (msg.sender == _admin()) { _; } else { _fallback(); } } /** * Contract constructor. * It sets the `msg.sender` as the proxy administrator. * @param _implementation address of the initial implementation. */ constructor(address _implementation) UpgradeabilityProxy(_implementation) public { assert(ADMIN_SLOT == keccak256("org.zeppelinos.proxy.admin")); _setAdmin(msg.sender); } /** * @return The address of the proxy admin. */ function admin() external view ifAdmin returns (address) { return _admin(); } /** * @return The address of the implementation. */ function implementation() external view ifAdmin returns (address) { return _implementation(); } /** * @dev Changes the admin of the proxy. * Only the current admin can call this function. * @param newAdmin Address to transfer proxy administration to. */ function changeAdmin(address newAdmin) external ifAdmin { require(newAdmin != address(0), "Cannot change the admin of a proxy to the zero address"); emit AdminChanged(_admin(), newAdmin); _setAdmin(newAdmin); } /** * @dev Upgrade the backing implementation of the proxy. * Only the admin can call this function. * @param newImplementation Address of the new implementation. */ function upgradeTo(address newImplementation) external ifAdmin { _upgradeTo(newImplementation); } /** * @dev Upgrade the backing implementation of the proxy and call a function * on the new implementation. * This is useful to initialize the proxied contract. * @param newImplementation Address of the new implementation. * @param data Data to send as msg.data in the low level call. * It should include the signature and the parameters of the function to be * called, as described in * https://solidity.readthedocs.io/en/develop/abi-spec.html#function-selector-and-argument-encoding. */ function upgradeToAndCall(address newImplementation, bytes data) payable external ifAdmin { _upgradeTo(newImplementation); require(address(this).call.value(msg.value)(data)); } /** * @return The admin slot. */ function _admin() internal view returns (address adm) { bytes32 slot = ADMIN_SLOT; assembly { adm := sload(slot) } } /** * @dev Sets the address of the proxy admin. * @param newAdmin Address of the new proxy admin. */ function _setAdmin(address newAdmin) internal { bytes32 slot = ADMIN_SLOT; assembly { sstore(slot, newAdmin) } } /** * @dev Only fall back when the sender is not the admin. */ function _willFallback() internal { require(msg.sender != _admin(), "Cannot call fallback function from the proxy admin"); super._willFallback(); } } // File: contracts/FiatTokenProxy.sol /** * Copyright CENTRE SECZ 2018 * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is furnished to * do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in all * copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ pragma solidity ^0.4.24; /** * @title FiatTokenProxy * @dev This contract proxies FiatToken calls and enables FiatToken upgrades */ contract FiatTokenProxy is AdminUpgradeabilityProxy { constructor(address _implementation) public AdminUpgradeabilityProxy(_implementation) { } }
File 3 of 9: TransparentUpgradeableProxy
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts v4.4.1 (proxy/transparent/TransparentUpgradeableProxy.sol) pragma solidity ^0.8.0; import "../ERC1967/ERC1967Proxy.sol"; /** * @dev This contract implements a proxy that is upgradeable by an admin. * * To avoid https://medium.com/nomic-labs-blog/malicious-backdoors-in-ethereum-proxies-62629adf3357[proxy selector * clashing], which can potentially be used in an attack, this contract uses the * https://blog.openzeppelin.com/the-transparent-proxy-pattern/[transparent proxy pattern]. This pattern implies two * things that go hand in hand: * * 1. If any account other than the admin calls the proxy, the call will be forwarded to the implementation, even if * that call matches one of the admin functions exposed by the proxy itself. * 2. If the admin calls the proxy, it can access the admin functions, but its calls will never be forwarded to the * implementation. If the admin tries to call a function on the implementation it will fail with an error that says * "admin cannot fallback to proxy target". * * These properties mean that the admin account can only be used for admin actions like upgrading the proxy or changing * the admin, so it's best if it's a dedicated account that is not used for anything else. This will avoid headaches due * to sudden errors when trying to call a function from the proxy implementation. * * Our recommendation is for the dedicated account to be an instance of the {ProxyAdmin} contract. If set up this way, * you should think of the `ProxyAdmin` instance as the real administrative interface of your proxy. */ contract TransparentUpgradeableProxy is ERC1967Proxy { /** * @dev Initializes an upgradeable proxy managed by `_admin`, backed by the implementation at `_logic`, and * optionally initialized with `_data` as explained in {ERC1967Proxy-constructor}. */ constructor( address _logic, address admin_, bytes memory _data ) payable ERC1967Proxy(_logic, _data) { assert(_ADMIN_SLOT == bytes32(uint256(keccak256("eip1967.proxy.admin")) - 1)); _changeAdmin(admin_); } /** * @dev Modifier used internally that will delegate the call to the implementation unless the sender is the admin. */ modifier ifAdmin() { if (msg.sender == _getAdmin()) { _; } else { _fallback(); } } /** * @dev Returns the current admin. * * NOTE: Only the admin can call this function. See {ProxyAdmin-getProxyAdmin}. * * TIP: To get this value clients can read directly from the storage slot shown below (specified by EIP1967) using the * https://eth.wiki/json-rpc/API#eth_getstorageat[`eth_getStorageAt`] RPC call. * `0xb53127684a568b3173ae13b9f8a6016e243e63b6e8ee1178d6a717850b5d6103` */ function admin() external ifAdmin returns (address admin_) { admin_ = _getAdmin(); } /** * @dev Returns the current implementation. * * NOTE: Only the admin can call this function. See {ProxyAdmin-getProxyImplementation}. * * TIP: To get this value clients can read directly from the storage slot shown below (specified by EIP1967) using the * https://eth.wiki/json-rpc/API#eth_getstorageat[`eth_getStorageAt`] RPC call. * `0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc` */ function implementation() external ifAdmin returns (address implementation_) { implementation_ = _implementation(); } /** * @dev Changes the admin of the proxy. * * Emits an {AdminChanged} event. * * NOTE: Only the admin can call this function. See {ProxyAdmin-changeProxyAdmin}. */ function changeAdmin(address newAdmin) external virtual ifAdmin { _changeAdmin(newAdmin); } /** * @dev Upgrade the implementation of the proxy. * * NOTE: Only the admin can call this function. See {ProxyAdmin-upgrade}. */ function upgradeTo(address newImplementation) external ifAdmin { _upgradeToAndCall(newImplementation, bytes(""), false); } /** * @dev Upgrade the implementation of the proxy, and then call a function from the new implementation as specified * by `data`, which should be an encoded function call. This is useful to initialize new storage variables in the * proxied contract. * * NOTE: Only the admin can call this function. See {ProxyAdmin-upgradeAndCall}. */ function upgradeToAndCall(address newImplementation, bytes calldata data) external payable ifAdmin { _upgradeToAndCall(newImplementation, data, true); } /** * @dev Returns the current admin. */ function _admin() internal view virtual returns (address) { return _getAdmin(); } /** * @dev Makes sure the admin cannot access the fallback function. See {Proxy-_beforeFallback}. */ function _beforeFallback() internal virtual override { require(msg.sender != _getAdmin(), "TransparentUpgradeableProxy: admin cannot fallback to proxy target"); super._beforeFallback(); } } // SPDX-License-Identifier: MIT // OpenZeppelin Contracts v4.4.1 (proxy/ERC1967/ERC1967Proxy.sol) pragma solidity ^0.8.0; import "../Proxy.sol"; import "./ERC1967Upgrade.sol"; /** * @dev This contract implements an upgradeable proxy. It is upgradeable because calls are delegated to an * implementation address that can be changed. This address is stored in storage in the location specified by * https://eips.ethereum.org/EIPS/eip-1967[EIP1967], so that it doesn't conflict with the storage layout of the * implementation behind the proxy. */ contract ERC1967Proxy is Proxy, ERC1967Upgrade { /** * @dev Initializes the upgradeable proxy with an initial implementation specified by `_logic`. * * If `_data` is nonempty, it's used as data in a delegate call to `_logic`. This will typically be an encoded * function call, and allows initializating the storage of the proxy like a Solidity constructor. */ constructor(address _logic, bytes memory _data) payable { assert(_IMPLEMENTATION_SLOT == bytes32(uint256(keccak256("eip1967.proxy.implementation")) - 1)); _upgradeToAndCall(_logic, _data, false); } /** * @dev Returns the current implementation address. */ function _implementation() internal view virtual override returns (address impl) { return ERC1967Upgrade._getImplementation(); } } // SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v4.5.0) (proxy/Proxy.sol) pragma solidity ^0.8.0; /** * @dev This abstract contract provides a fallback function that delegates all calls to another contract using the EVM * instruction `delegatecall`. We refer to the second contract as the _implementation_ behind the proxy, and it has to * be specified by overriding the virtual {_implementation} function. * * Additionally, delegation to the implementation can be triggered manually through the {_fallback} function, or to a * different contract through the {_delegate} function. * * The success and return data of the delegated call will be returned back to the caller of the proxy. */ abstract contract Proxy { /** * @dev Delegates the current call to `implementation`. * * This function does not return to its internal call site, it will return directly to the external caller. */ function _delegate(address implementation) internal virtual { assembly { // Copy msg.data. We take full control of memory in this inline assembly // block because it will not return to Solidity code. We overwrite the // Solidity scratch pad at memory position 0. calldatacopy(0, 0, calldatasize()) // Call the implementation. // out and outsize are 0 because we don't know the size yet. let result := delegatecall(gas(), implementation, 0, calldatasize(), 0, 0) // Copy the returned data. returndatacopy(0, 0, returndatasize()) switch result // delegatecall returns 0 on error. case 0 { revert(0, returndatasize()) } default { return(0, returndatasize()) } } } /** * @dev This is a virtual function that should be overriden so it returns the address to which the fallback function * and {_fallback} should delegate. */ function _implementation() internal view virtual returns (address); /** * @dev Delegates the current call to the address returned by `_implementation()`. * * This function does not return to its internall call site, it will return directly to the external caller. */ function _fallback() internal virtual { _beforeFallback(); _delegate(_implementation()); } /** * @dev Fallback function that delegates calls to the address returned by `_implementation()`. Will run if no other * function in the contract matches the call data. */ fallback() external payable virtual { _fallback(); } /** * @dev Fallback function that delegates calls to the address returned by `_implementation()`. Will run if call data * is empty. */ receive() external payable virtual { _fallback(); } /** * @dev Hook that is called before falling back to the implementation. Can happen as part of a manual `_fallback` * call, or as part of the Solidity `fallback` or `receive` functions. * * If overriden should call `super._beforeFallback()`. */ function _beforeFallback() internal virtual {} } // SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v4.5.0) (proxy/ERC1967/ERC1967Upgrade.sol) pragma solidity ^0.8.2; import "../beacon/IBeacon.sol"; import "../../interfaces/draft-IERC1822.sol"; import "../../utils/Address.sol"; import "../../utils/StorageSlot.sol"; /** * @dev This abstract contract provides getters and event emitting update functions for * https://eips.ethereum.org/EIPS/eip-1967[EIP1967] slots. * * _Available since v4.1._ * * @custom:oz-upgrades-unsafe-allow delegatecall */ abstract contract ERC1967Upgrade { // This is the keccak-256 hash of "eip1967.proxy.rollback" subtracted by 1 bytes32 private constant _ROLLBACK_SLOT = 0x4910fdfa16fed3260ed0e7147f7cc6da11a60208b5b9406d12a635614ffd9143; /** * @dev Storage slot with the address of the current implementation. * This is the keccak-256 hash of "eip1967.proxy.implementation" subtracted by 1, and is * validated in the constructor. */ bytes32 internal constant _IMPLEMENTATION_SLOT = 0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc; /** * @dev Emitted when the implementation is upgraded. */ event Upgraded(address indexed implementation); /** * @dev Returns the current implementation address. */ function _getImplementation() internal view returns (address) { return StorageSlot.getAddressSlot(_IMPLEMENTATION_SLOT).value; } /** * @dev Stores a new address in the EIP1967 implementation slot. */ function _setImplementation(address newImplementation) private { require(Address.isContract(newImplementation), "ERC1967: new implementation is not a contract"); StorageSlot.getAddressSlot(_IMPLEMENTATION_SLOT).value = newImplementation; } /** * @dev Perform implementation upgrade * * Emits an {Upgraded} event. */ function _upgradeTo(address newImplementation) internal { _setImplementation(newImplementation); emit Upgraded(newImplementation); } /** * @dev Perform implementation upgrade with additional setup call. * * Emits an {Upgraded} event. */ function _upgradeToAndCall( address newImplementation, bytes memory data, bool forceCall ) internal { _upgradeTo(newImplementation); if (data.length > 0 || forceCall) { Address.functionDelegateCall(newImplementation, data); } } /** * @dev Perform implementation upgrade with security checks for UUPS proxies, and additional setup call. * * Emits an {Upgraded} event. */ function _upgradeToAndCallUUPS( address newImplementation, bytes memory data, bool forceCall ) internal { // Upgrades from old implementations will perform a rollback test. This test requires the new // implementation to upgrade back to the old, non-ERC1822 compliant, implementation. Removing // this special case will break upgrade paths from old UUPS implementation to new ones. if (StorageSlot.getBooleanSlot(_ROLLBACK_SLOT).value) { _setImplementation(newImplementation); } else { try IERC1822Proxiable(newImplementation).proxiableUUID() returns (bytes32 slot) { require(slot == _IMPLEMENTATION_SLOT, "ERC1967Upgrade: unsupported proxiableUUID"); } catch { revert("ERC1967Upgrade: new implementation is not UUPS"); } _upgradeToAndCall(newImplementation, data, forceCall); } } /** * @dev Storage slot with the admin of the contract. * This is the keccak-256 hash of "eip1967.proxy.admin" subtracted by 1, and is * validated in the constructor. */ bytes32 internal constant _ADMIN_SLOT = 0xb53127684a568b3173ae13b9f8a6016e243e63b6e8ee1178d6a717850b5d6103; /** * @dev Emitted when the admin account has changed. */ event AdminChanged(address previousAdmin, address newAdmin); /** * @dev Returns the current admin. */ function _getAdmin() internal view returns (address) { return StorageSlot.getAddressSlot(_ADMIN_SLOT).value; } /** * @dev Stores a new address in the EIP1967 admin slot. */ function _setAdmin(address newAdmin) private { require(newAdmin != address(0), "ERC1967: new admin is the zero address"); StorageSlot.getAddressSlot(_ADMIN_SLOT).value = newAdmin; } /** * @dev Changes the admin of the proxy. * * Emits an {AdminChanged} event. */ function _changeAdmin(address newAdmin) internal { emit AdminChanged(_getAdmin(), newAdmin); _setAdmin(newAdmin); } /** * @dev The storage slot of the UpgradeableBeacon contract which defines the implementation for this proxy. * This is bytes32(uint256(keccak256('eip1967.proxy.beacon')) - 1)) and is validated in the constructor. */ bytes32 internal constant _BEACON_SLOT = 0xa3f0ad74e5423aebfd80d3ef4346578335a9a72aeaee59ff6cb3582b35133d50; /** * @dev Emitted when the beacon is upgraded. */ event BeaconUpgraded(address indexed beacon); /** * @dev Returns the current beacon. */ function _getBeacon() internal view returns (address) { return StorageSlot.getAddressSlot(_BEACON_SLOT).value; } /** * @dev Stores a new beacon in the EIP1967 beacon slot. */ function _setBeacon(address newBeacon) private { require(Address.isContract(newBeacon), "ERC1967: new beacon is not a contract"); require( Address.isContract(IBeacon(newBeacon).implementation()), "ERC1967: beacon implementation is not a contract" ); StorageSlot.getAddressSlot(_BEACON_SLOT).value = newBeacon; } /** * @dev Perform beacon upgrade with additional setup call. Note: This upgrades the address of the beacon, it does * not upgrade the implementation contained in the beacon (see {UpgradeableBeacon-_setImplementation} for that). * * Emits a {BeaconUpgraded} event. */ function _upgradeBeaconToAndCall( address newBeacon, bytes memory data, bool forceCall ) internal { _setBeacon(newBeacon); emit BeaconUpgraded(newBeacon); if (data.length > 0 || forceCall) { Address.functionDelegateCall(IBeacon(newBeacon).implementation(), data); } } } // SPDX-License-Identifier: MIT // OpenZeppelin Contracts v4.4.1 (proxy/beacon/IBeacon.sol) pragma solidity ^0.8.0; /** * @dev This is the interface that {BeaconProxy} expects of its beacon. */ interface IBeacon { /** * @dev Must return an address that can be used as a delegate call target. * * {BeaconProxy} will check that this address is a contract. */ function implementation() external view returns (address); } // SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v4.5.0) (interfaces/draft-IERC1822.sol) pragma solidity ^0.8.0; /** * @dev ERC1822: Universal Upgradeable Proxy Standard (UUPS) documents a method for upgradeability through a simplified * proxy whose upgrades are fully controlled by the current implementation. */ interface IERC1822Proxiable { /** * @dev Returns the storage slot that the proxiable contract assumes is being used to store the implementation * address. * * IMPORTANT: A proxy pointing at a proxiable contract should not be considered proxiable itself, because this risks * bricking a proxy that upgrades to it, by delegating to itself until out of gas. Thus it is critical that this * function revert if invoked through a proxy. */ function proxiableUUID() external view returns (bytes32); } // SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v4.5.0) (utils/Address.sol) pragma solidity ^0.8.1; /** * @dev Collection of functions related to the address type */ library Address { /** * @dev Returns true if `account` is a contract. * * [IMPORTANT] * ==== * It is unsafe to assume that an address for which this function returns * false is an externally-owned account (EOA) and not a contract. * * Among others, `isContract` will return false for the following * types of addresses: * * - an externally-owned account * - a contract in construction * - an address where a contract will be created * - an address where a contract lived, but was destroyed * ==== * * [IMPORTANT] * ==== * You shouldn't rely on `isContract` to protect against flash loan attacks! * * Preventing calls from contracts is highly discouraged. It breaks composability, breaks support for smart wallets * like Gnosis Safe, and does not provide security since it can be circumvented by calling from a contract * constructor. * ==== */ function isContract(address account) internal view returns (bool) { // This method relies on extcodesize/address.code.length, which returns 0 // for contracts in construction, since the code is only stored at the end // of the constructor execution. return account.code.length > 0; } /** * @dev Replacement for Solidity's `transfer`: sends `amount` wei to * `recipient`, forwarding all available gas and reverting on errors. * * https://eips.ethereum.org/EIPS/eip-1884[EIP1884] increases the gas cost * of certain opcodes, possibly making contracts go over the 2300 gas limit * imposed by `transfer`, making them unable to receive funds via * `transfer`. {sendValue} removes this limitation. * * https://diligence.consensys.net/posts/2019/09/stop-using-soliditys-transfer-now/[Learn more]. * * IMPORTANT: because control is transferred to `recipient`, care must be * taken to not create reentrancy vulnerabilities. Consider using * {ReentrancyGuard} or the * https://solidity.readthedocs.io/en/v0.5.11/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern]. */ function sendValue(address payable recipient, uint256 amount) internal { require(address(this).balance >= amount, "Address: insufficient balance"); (bool success, ) = recipient.call{value: amount}(""); require(success, "Address: unable to send value, recipient may have reverted"); } /** * @dev Performs a Solidity function call using a low level `call`. A * plain `call` is an unsafe replacement for a function call: use this * function instead. * * If `target` reverts with a revert reason, it is bubbled up by this * function (like regular Solidity function calls). * * Returns the raw returned data. To convert to the expected return value, * use https://solidity.readthedocs.io/en/latest/units-and-global-variables.html?highlight=abi.decode#abi-encoding-and-decoding-functions[`abi.decode`]. * * Requirements: * * - `target` must be a contract. * - calling `target` with `data` must not revert. * * _Available since v3.1._ */ function functionCall(address target, bytes memory data) internal returns (bytes memory) { return functionCall(target, data, "Address: low-level call failed"); } /** * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], but with * `errorMessage` as a fallback revert reason when `target` reverts. * * _Available since v3.1._ */ function functionCall( address target, bytes memory data, string memory errorMessage ) internal returns (bytes memory) { return functionCallWithValue(target, data, 0, errorMessage); } /** * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], * but also transferring `value` wei to `target`. * * Requirements: * * - the calling contract must have an ETH balance of at least `value`. * - the called Solidity function must be `payable`. * * _Available since v3.1._ */ function functionCallWithValue( address target, bytes memory data, uint256 value ) internal returns (bytes memory) { return functionCallWithValue(target, data, value, "Address: low-level call with value failed"); } /** * @dev Same as {xref-Address-functionCallWithValue-address-bytes-uint256-}[`functionCallWithValue`], but * with `errorMessage` as a fallback revert reason when `target` reverts. * * _Available since v3.1._ */ function functionCallWithValue( address target, bytes memory data, uint256 value, string memory errorMessage ) internal returns (bytes memory) { require(address(this).balance >= value, "Address: insufficient balance for call"); require(isContract(target), "Address: call to non-contract"); (bool success, bytes memory returndata) = target.call{value: value}(data); return verifyCallResult(success, returndata, errorMessage); } /** * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], * but performing a static call. * * _Available since v3.3._ */ function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) { return functionStaticCall(target, data, "Address: low-level static call failed"); } /** * @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`], * but performing a static call. * * _Available since v3.3._ */ function functionStaticCall( address target, bytes memory data, string memory errorMessage ) internal view returns (bytes memory) { require(isContract(target), "Address: static call to non-contract"); (bool success, bytes memory returndata) = target.staticcall(data); return verifyCallResult(success, returndata, errorMessage); } /** * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], * but performing a delegate call. * * _Available since v3.4._ */ function functionDelegateCall(address target, bytes memory data) internal returns (bytes memory) { return functionDelegateCall(target, data, "Address: low-level delegate call failed"); } /** * @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`], * but performing a delegate call. * * _Available since v3.4._ */ function functionDelegateCall( address target, bytes memory data, string memory errorMessage ) internal returns (bytes memory) { require(isContract(target), "Address: delegate call to non-contract"); (bool success, bytes memory returndata) = target.delegatecall(data); return verifyCallResult(success, returndata, errorMessage); } /** * @dev Tool to verifies that a low level call was successful, and revert if it wasn't, either by bubbling the * revert reason using the provided one. * * _Available since v4.3._ */ function verifyCallResult( bool success, bytes memory returndata, string memory errorMessage ) internal pure returns (bytes memory) { if (success) { return returndata; } else { // Look for revert reason and bubble it up if present if (returndata.length > 0) { // The easiest way to bubble the revert reason is using memory via assembly assembly { let returndata_size := mload(returndata) revert(add(32, returndata), returndata_size) } } else { revert(errorMessage); } } } } // SPDX-License-Identifier: MIT // OpenZeppelin Contracts v4.4.1 (utils/StorageSlot.sol) pragma solidity ^0.8.0; /** * @dev Library for reading and writing primitive types to specific storage slots. * * Storage slots are often used to avoid storage conflict when dealing with upgradeable contracts. * This library helps with reading and writing to such slots without the need for inline assembly. * * The functions in this library return Slot structs that contain a `value` member that can be used to read or write. * * Example usage to set ERC1967 implementation slot: * ``` * contract ERC1967 { * bytes32 internal constant _IMPLEMENTATION_SLOT = 0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc; * * function _getImplementation() internal view returns (address) { * return StorageSlot.getAddressSlot(_IMPLEMENTATION_SLOT).value; * } * * function _setImplementation(address newImplementation) internal { * require(Address.isContract(newImplementation), "ERC1967: new implementation is not a contract"); * StorageSlot.getAddressSlot(_IMPLEMENTATION_SLOT).value = newImplementation; * } * } * ``` * * _Available since v4.1 for `address`, `bool`, `bytes32`, and `uint256`._ */ library StorageSlot { struct AddressSlot { address value; } struct BooleanSlot { bool value; } struct Bytes32Slot { bytes32 value; } struct Uint256Slot { uint256 value; } /** * @dev Returns an `AddressSlot` with member `value` located at `slot`. */ function getAddressSlot(bytes32 slot) internal pure returns (AddressSlot storage r) { assembly { r.slot := slot } } /** * @dev Returns an `BooleanSlot` with member `value` located at `slot`. */ function getBooleanSlot(bytes32 slot) internal pure returns (BooleanSlot storage r) { assembly { r.slot := slot } } /** * @dev Returns an `Bytes32Slot` with member `value` located at `slot`. */ function getBytes32Slot(bytes32 slot) internal pure returns (Bytes32Slot storage r) { assembly { r.slot := slot } } /** * @dev Returns an `Uint256Slot` with member `value` located at `slot`. */ function getUint256Slot(bytes32 slot) internal pure returns (Uint256Slot storage r) { assembly { r.slot := slot } } }
File 4 of 9: CompoundV3USDCPortfolio
//SPDX-License-Identifier: BSD 3-Clause pragma solidity 0.8.13; import {Registry} from "../Registry.sol"; import {Portfolio} from "../Portfolio.sol"; import {IComet} from "../interfaces/ICErc20.sol"; import {Auth} from "../lib/auth/Auth.sol"; import {Math} from "../lib/Math.sol"; import {ERC20} from "solmate/tokens/ERC20.sol"; import {SafeTransferLib} from "solmate/utils/SafeTransferLib.sol"; contract CompoundV3USDCPortfolio is Portfolio { using SafeTransferLib for ERC20; using Math for uint256; /// @notice Address of the Compound III (Comet) USDC market/token. IComet public immutable cusdc; /// @dev Thrown when there's a mismatch between constructor arguments and the underlying asset. error AssetMismatch(); /// @dev Thrown when the `sync` method is called after shutdown. error SyncAfterShutdown(); /** * @param _registry Endaoment registry. * @param _receiptAsset Receipt token for this portfolio. * @param _cap Amount of baseToken that this portfolio's asset balance should not exceed. * @param _feeTreasury Address of the treasury that should receive fees. * @param _depositFee Percentage fee as ZOC that should go to treasury on deposit. (100 = 1%). * @param _redemptionFee Percentage fee as ZOC that should go to treasury on redemption. (100 = 1%). * @param _aumRate Percentage fee per second (as WAD) that should accrue to treasury as AUM fee. (1e16 = 1%). */ constructor( Registry _registry, address _receiptAsset, uint256 _cap, address _feeTreasury, uint256 _depositFee, uint256 _redemptionFee, uint256 _aumRate ) Portfolio( _registry, _receiptAsset, "Compound III USDC Portfolio Shares", "cUSDCv3-PS", _cap, _feeTreasury, _depositFee, _redemptionFee, _aumRate ) { // The `asset` should match the base token, which means we expect it to be USDC. if (address(baseToken) != asset) revert AssetMismatch(); cusdc = IComet(_receiptAsset); // Inputs are consistent, so we can approve the pool to spend our USDC. ERC20(asset).safeApprove(address(receiptAsset), type(uint256).max); } /** * @inheritdoc Portfolio */ function _getAsset(address _receiptAsset) internal view override returns (address) { return IComet(_receiptAsset).baseToken(); } /** * @inheritdoc Portfolio */ function convertReceiptAssetsToAssets(uint256 _receiptAssets) public pure override returns (uint256) { // in this case, receipt asset and USDC balance are 1:1 return _receiptAssets; } /** * @inheritdoc Portfolio * @dev `_data` should be the ABI-encoded `uint minSharesOut`. */ function _deposit(uint256 _amountBaseToken, bytes calldata /* _data */ ) internal override returns (uint256, uint256, uint256) { (uint256 _amountNet, uint256 _amountFee) = _calculateFee(_amountBaseToken, depositFee); uint256 _shares = convertToShares(_amountNet); ERC20(asset).safeTransferFrom(msg.sender, address(this), _amountBaseToken); ERC20(asset).safeTransfer(feeTreasury, _amountFee); cusdc.supply(asset, _amountNet); return (_shares, _amountNet, _amountFee); } /** * @inheritdoc Portfolio * @dev No calldata is needed for redeem/exit. */ function _redeem(uint256 _amountShares, bytes calldata _data) internal override returns (uint256, uint256) { uint256 _assetsOut = convertToAssets(_amountShares); (, uint256 _baseTokenOut) = _exit(_assetsOut, _data); return (_assetsOut, _baseTokenOut); } /** * @inheritdoc Portfolio * @dev No calldata is needed for redeem/exit. */ function _exit(uint256 _amountAssets, bytes calldata /*_data */ ) internal override returns (uint256, uint256) { if (_amountAssets == 0) revert RoundsToZero(); cusdc.withdraw(asset, _amountAssets); return (_amountAssets, _amountAssets); } /** * @notice Deposits stray USDC for the benefit of everyone else */ function sync() external requiresAuth { if (didShutdown) revert SyncAfterShutdown(); cusdc.supply(asset, ERC20(asset).balanceOf(address(this))); } } //SPDX-License-Identifier: BSD 3-Clause pragma solidity 0.8.13; import {Math} from "./lib/Math.sol"; import {ERC20} from "solmate/tokens/ERC20.sol"; import {Auth, Authority} from "./lib/auth/Auth.sol"; import {SafeTransferLib} from "solmate/utils/SafeTransferLib.sol"; import {RegistryAuth} from "./RegistryAuth.sol"; import {Entity} from "./Entity.sol"; import {ISwapWrapper} from "./interfaces/ISwapWrapper.sol"; import {Portfolio} from "./Portfolio.sol"; // --- Errors --- error Unauthorized(); error UnsupportedSwapper(); /** * @notice Registry entity - manages Factory and Entity state info. */ contract Registry is RegistryAuth { // --- Storage --- /// @notice Treasury address can receives fees. address public treasury; /// @notice Base Token address is the stable coin contract used throughout the system. ERC20 public immutable baseToken; /// @notice Mapping of approved factory contracts that are allowed to register new Entities. mapping(address => bool) public isApprovedFactory; /// @notice Mapping of active status of entities. mapping(Entity => bool) public isActiveEntity; /// @notice Maps entity type to donation fee percentage stored as a zoc, where type(uint32).max represents 0. mapping(uint8 => uint32) defaultDonationFee; /// @notice Maps specific entity receiver to donation fee percentage stored as a zoc. mapping(Entity => uint32) donationFeeReceiverOverride; /// @notice Maps entity type to payout fee percentage stored as a zoc, where type(uint32).max represents 0. mapping(uint8 => uint32) defaultPayoutFee; /// @notice Maps specific entity sender to payout fee percentage stored as a zoc. mapping(Entity => uint32) payoutFeeOverride; /// @notice Maps sender entity type to receiver entity type to fee percentage as a zoc. mapping(uint8 => mapping(uint8 => uint32)) defaultTransferFee; /// @notice Maps specific entity sender to receiver entity type to fee percentage as a zoc. mapping(Entity => mapping(uint8 => uint32)) transferFeeSenderOverride; /// @notice Maps sender entity type to specific entity receiver to fee percentage as a zoc. mapping(uint8 => mapping(Entity => uint32)) transferFeeReceiverOverride; /// @notice Maps swap wrappers to their enabled/disabled status. mapping(ISwapWrapper => bool) public isSwapperSupported; /// @notice Maps portfolios to their enabled/disabled status. mapping(Portfolio => bool) public isActivePortfolio; // --- Events --- /// @notice The event emitted when a factory is approved (whitelisted) or has it's approval removed. event FactoryApprovalSet(address indexed factory, bool isApproved); /// @notice The event emitted when an entity is set active or inactive. event EntityStatusSet(address indexed entity, bool isActive); /// @notice The event emitted when a swap wrapper is set active or inactive. event SwapWrapperStatusSet(address indexed swapWrapper, bool isSupported); /// @notice The event emitted when a portfolio is set active or inactive. event PortfolioStatusSet(address indexed portfolio, bool isActive); /// @notice Emitted when a default donation fee is set for an entity type. event DefaultDonationFeeSet(uint8 indexed entityType, uint32 fee); /// @notice Emitted when a donation fee override is set for a specific receiving entity. event DonationFeeReceiverOverrideSet(address indexed entity, uint32 fee); /// @notice Emitted when a default payout fee is set for an entity type. event DefaultPayoutFeeSet(uint8 indexed entityType, uint32 fee); /// @notice Emitted when a payout fee override is set for a specific sender entity. event PayoutFeeOverrideSet(address indexed entity, uint32 fee); /// @notice Emitted when a default transfer fee is set for transfers between entity types. event DefaultTransferFeeSet(uint8 indexed fromEntityType, uint8 indexed toEntityType, uint32 fee); /// @notice Emitted when a transfer fee override is set for transfers from an entity to a specific entityType. event TransferFeeSenderOverrideSet(address indexed fromEntity, uint8 indexed toEntityType, uint32 fee); /// @notice Emitted when a transfer fee override is set for transfers from an entityType to an entity. event TransferFeeReceiverOverrideSet(uint8 indexed fromEntityType, address indexed toEntity, uint32 fee); /// @notice Emitted when the registry treasury contract is changed event TreasuryChanged(address oldTreasury, address indexed newTreasury); /** * @notice Modifier for methods that require auth and that the manager cannot access. * @dev Overridden from Auth.sol. Reason: use custom error. */ modifier requiresAuth() override { if (!isAuthorized(msg.sender, msg.sig)) revert Unauthorized(); _; } // --- Constructor --- constructor(address _admin, address _treasury, ERC20 _baseToken) RegistryAuth(_admin, Authority(address(this))) { treasury = _treasury; emit TreasuryChanged(address(0), _treasury); baseToken = _baseToken; } // --- Internal fns --- /** * @notice Fee parsing to convert the special "type(uint32).max" value to zero, and zero to the "max". * @dev After converting, "type(uint32).max" will cause overflow/revert when used as a fee percentage multiplier and zero will mean no fee. * @param _value The value to be converted. * @return The parsed fee to use. */ function _parseFeeWithFlip(uint32 _value) private pure returns (uint32) { if (_value == 0) { return type(uint32).max; } else if (_value == type(uint32).max) { return 0; } else { return _value; } } // --- External fns --- /** * @notice Sets a new Endaoment treasury address. * @param _newTreasury The new treasury. */ function setTreasury(address _newTreasury) external requiresAuth { emit TreasuryChanged(treasury, _newTreasury); treasury = _newTreasury; } /** * @notice Sets the approval state of a factory. Grants the factory permissions to set entity status. * @param _factory The factory whose approval state is to be updated. * @param _isApproved True if the factory should be approved, false otherwise. */ function setFactoryApproval(address _factory, bool _isApproved) external requiresAuth { isApprovedFactory[_factory] = _isApproved; emit FactoryApprovalSet(address(_factory), _isApproved); } /** * @notice Sets the enable/disable state of an Entity. * @param _entity The entity whose active state is to be updated. * @param _isActive True if the entity should be active, false otherwise. */ function setEntityStatus(Entity _entity, bool _isActive) external requiresAuth { isActiveEntity[_entity] = _isActive; emit EntityStatusSet(address(_entity), _isActive); } /** * @notice Sets Entity as active. This is a special method to be called only by approved factories. * Other callers should use `setEntityStatus` instead. * @param _entity The entity. */ function setEntityActive(Entity _entity) external { if (!isApprovedFactory[msg.sender]) revert Unauthorized(); isActiveEntity[_entity] = true; emit EntityStatusSet(address(_entity), true); } /** * @notice Sets the enable/disable state of a Portfolio. * @param _portfolio Portfolio. * @param _isActive True if setting portfolio to active, false otherwise. */ function setPortfolioStatus(Portfolio _portfolio, bool _isActive) external requiresAuth { isActivePortfolio[_portfolio] = _isActive; emit PortfolioStatusSet(address(_portfolio), _isActive); } /** * @notice Gets default donation fee pct (as a zoc) for an Entity. * @param _entity The receiving entity of the donation for which the fee is being fetched. * @return uint32 The default donation fee for the entity's type. * @dev Makes use of _parseFeeWithFlip, so if no default exists, "max" will be returned. */ function getDonationFee(Entity _entity) external view returns (uint32) { return _parseFeeWithFlip(defaultDonationFee[_entity.entityType()]); } /** * @notice Gets lowest possible donation fee pct (as a zoc) for an Entity, among default and override. * @param _entity The receiving entity of the donation for which the fee is being fetched. * @return uint32 The minimum of the default donation fee and the receiver's fee override. * @dev Makes use of _parseFeeWithFlip, so if no default or override exists, "max" will be returned. */ function getDonationFeeWithOverrides(Entity _entity) external view returns (uint32) { uint32 _default = _parseFeeWithFlip(defaultDonationFee[_entity.entityType()]); uint32 _receiverOverride = _parseFeeWithFlip(donationFeeReceiverOverride[_entity]); return _receiverOverride < _default ? _receiverOverride : _default; } /** * @notice Gets default payout fee pct (as a zoc) for an Entity. * @param _entity The sender entity of the payout for which the fee is being fetched. * @return uint32 The default payout fee for the entity's type. * @dev Makes use of _parseFeeWithFlip, so if no default exists, "max" will be returned. */ function getPayoutFee(Entity _entity) external view returns (uint32) { return _parseFeeWithFlip(defaultPayoutFee[_entity.entityType()]); } /** * @notice Gets lowest possible payout fee pct (as a zoc) for an Entity, among default and override. * @param _entity The sender entity of the payout for which the fee is being fetched. * @return uint32 The minimum of the default payout fee and the sender's fee override. * @dev Makes use of _parseFeeWithFlip, so if no default or override exists, "max" will be returned. */ function getPayoutFeeWithOverrides(Entity _entity) external view returns (uint32) { uint32 _default = _parseFeeWithFlip(defaultPayoutFee[_entity.entityType()]); uint32 _senderOverride = _parseFeeWithFlip(payoutFeeOverride[_entity]); return _senderOverride < _default ? _senderOverride : _default; } /** * @notice Gets default transfer fee pct (as a zoc) between sender & receiver Entities. * @param _sender The sending entity of the transfer for which the fee is being fetched. * @param _receiver The receiving entity of the transfer for which the fee is being fetched. * @return uint32 The default transfer fee. * @dev Makes use of _parseFeeWithFlip, so if no default exists, "type(uint32).max" will be returned. */ function getTransferFee(Entity _sender, Entity _receiver) external view returns (uint32) { return _parseFeeWithFlip(defaultTransferFee[_sender.entityType()][_receiver.entityType()]); } /** * @notice Gets lowest possible transfer fee pct (as a zoc) between sender & receiver Entities, among default and overrides. * @param _sender The sending entity of the transfer for which the fee is being fetched. * @param _receiver The receiving entity of the transfer for which the fee is being fetched. * @return uint32 The minimum of the default transfer fee, and sender and receiver overrides. * @dev Makes use of _parseFeeWithFlip, so if no default or overrides exist, "type(uint32).max" will be returned. */ function getTransferFeeWithOverrides(Entity _sender, Entity _receiver) external view returns (uint32) { uint32 _default = _parseFeeWithFlip(defaultTransferFee[_sender.entityType()][_receiver.entityType()]); uint32 _senderOverride = _parseFeeWithFlip(transferFeeSenderOverride[_sender][_receiver.entityType()]); uint32 _receiverOverride = _parseFeeWithFlip(transferFeeReceiverOverride[_sender.entityType()][_receiver]); uint32 _lowestFee = _default; _lowestFee = _senderOverride < _lowestFee ? _senderOverride : _lowestFee; _lowestFee = _receiverOverride < _lowestFee ? _receiverOverride : _lowestFee; return _lowestFee; } /** * @notice Sets the default donation fee for an entity type. * @param _entityType Entity type. * @param _fee The fee percentage to be set (a zoc). */ function setDefaultDonationFee(uint8 _entityType, uint32 _fee) external requiresAuth { defaultDonationFee[_entityType] = _parseFeeWithFlip(_fee); emit DefaultDonationFeeSet(_entityType, _fee); } /** * @notice Sets the donation fee receiver override for a specific entity. * @param _entity Entity. * @param _fee The overriding fee (a zoc). */ function setDonationFeeReceiverOverride(Entity _entity, uint32 _fee) external requiresAuth { donationFeeReceiverOverride[_entity] = _parseFeeWithFlip(_fee); emit DonationFeeReceiverOverrideSet(address(_entity), _fee); } /** * @notice Sets the default payout fee for an entity type. * @param _entityType Entity type. * @param _fee The fee percentage to be set (a zoc). */ function setDefaultPayoutFee(uint8 _entityType, uint32 _fee) external requiresAuth { defaultPayoutFee[_entityType] = _parseFeeWithFlip(_fee); emit DefaultPayoutFeeSet(_entityType, _fee); } /** * @notice Sets the payout fee override for a specific entity. * @param _entity Entity. * @param _fee The overriding fee (a zoc). */ function setPayoutFeeOverride(Entity _entity, uint32 _fee) external requiresAuth { payoutFeeOverride[_entity] = _parseFeeWithFlip(_fee); emit PayoutFeeOverrideSet(address(_entity), _fee); } /** * @notice Sets the default transfer fee for transfers from one specific entity type to another. * @param _fromEntityType The entityType making the transfer. * @param _toEntityType The receiving entityType. * @param _fee The transfer fee percentage (a zoc). */ function setDefaultTransferFee(uint8 _fromEntityType, uint8 _toEntityType, uint32 _fee) external requiresAuth { defaultTransferFee[_fromEntityType][_toEntityType] = _parseFeeWithFlip(_fee); emit DefaultTransferFeeSet(_fromEntityType, _toEntityType, _fee); } /** * @notice Sets the transfer fee override for transfers from one specific entity to entities of a given type. * @param _fromEntity The entity making the transfer. * @param _toEntityType The receiving entityType. * @param _fee The overriding fee percentage (a zoc). */ function setTransferFeeSenderOverride(Entity _fromEntity, uint8 _toEntityType, uint32 _fee) external requiresAuth { transferFeeSenderOverride[_fromEntity][_toEntityType] = _parseFeeWithFlip(_fee); emit TransferFeeSenderOverrideSet(address(_fromEntity), _toEntityType, _fee); } /** * @notice Sets the transfer fee override for transfers from entities of a given type to a specific entity. * @param _fromEntityType The entityType making the transfer. * @param _toEntity The receiving entity. * @param _fee The overriding fee percentage (a zoc). */ function setTransferFeeReceiverOverride(uint8 _fromEntityType, Entity _toEntity, uint32 _fee) external requiresAuth { transferFeeReceiverOverride[_fromEntityType][_toEntity] = _parseFeeWithFlip(_fee); emit TransferFeeReceiverOverrideSet(_fromEntityType, address(_toEntity), _fee); } /** * @notice Sets the enable/disable state of a SwapWrapper. System owners must ensure meticulous review of SwapWrappers before approving them. * @param _swapWrapper A contract that implements ISwapWrapper. * @param _supported `true` if supported, `false` if unsupported. */ function setSwapWrapperStatus(ISwapWrapper _swapWrapper, bool _supported) external requiresAuth { isSwapperSupported[_swapWrapper] = _supported; emit SwapWrapperStatusSet(address(_swapWrapper), _supported); } } //SPDX-License-Identifier: BSD 3-Clause pragma solidity >=0.8.0; import {ReentrancyGuard} from "solmate/utils/ReentrancyGuard.sol"; import {ERC20} from "solmate/tokens/ERC20.sol"; import {SafeTransferLib} from "solmate/utils/SafeTransferLib.sol"; import {Registry} from "./Registry.sol"; import {Entity} from "./Entity.sol"; import {EndaomentAuth} from "./lib/auth/EndaomentAuth.sol"; import {Math} from "./lib/Math.sol"; abstract contract Portfolio is ERC20, EndaomentAuth, ReentrancyGuard { using Math for uint256; using SafeTransferLib for ERC20; Registry public immutable registry; uint256 public cap; address public feeTreasury; uint256 public depositFee; uint256 public redemptionFee; address public immutable asset; address public immutable receiptAsset; ERC20 public immutable baseToken; bool public didShutdown; uint256 public timestampAumFeesTaken; uint256 public aumRate; uint256 internal constant MAX_AUM_RATE = 3168808782; error InvalidSwapper(); error InvalidRate(); error TransferDisallowed(); error DepositAfterShutdown(); error DidShutdown(); error NotEntity(); error BadCheckCapImplementation(); error ExceedsCap(); error PercentageOver100(); error RoundsToZero(); error Slippage(); error CallFailed(bytes response); /// @notice `sender` has exchanged `assets` (after fees) for `shares`, and transferred those `shares` to `receiver`. /// The sender paid a total of `depositAmount` and was charged `fee` for the transaction. event Deposit( address indexed sender, address indexed receiver, uint256 assets, uint256 shares, uint256 depositAmount, uint256 fee ); /// @notice `sender` has exchanged `shares` for `assets`, and transferred those `assets` to `receiver`. /// The sender received a net of `redeemedAmount` after the conversion of `assets` into base tokens /// and was charged `fee` for the transaction. event Redeem( address indexed sender, address indexed receiver, uint256 assets, uint256 shares, uint256 redeemedAmount, uint256 fee ); /// @notice Event emitted when `cap` is set. event CapSet(uint256 cap); /// @notice Event emitted when `depositFee` is set. event DepositFeeSet(uint256 fee); /// @notice Event emitted when `redemptionFee` is set. event RedemptionFeeSet(uint256 fee); /// @notice Event emitted when `feeTreasury` is set. event FeeTreasurySet(address feeTreasury); /// @notice Event emitted when management takes fees. event FeesTaken(uint256 amount); /// @notice Event emitted when AUM fees are taken. event AumFeesTaken(uint256 feeAmount, uint256 timeDelta); /// @notice Event emitted when `aumRate` is set. event AumRateSet(uint256 rate); /// @notice Event emitted when admin forcefully swaps portfolio asset balance for baseToken. event Shutdown(uint256 assetAmount, uint256 baseTokenOut); /** * @param _registry Endaoment registry. * @param _receiptAsset Address of token that the portfolio receives from a deposit. * @param _name Name of the ERC20 Portfolio share tokens. * @param _symbol Symbol of the ERC20 Portfolio share tokens. * @param _cap Amount in baseToken that value of totalAssets should not exceed. * @param _depositFee Percentage fee as ZOC that will go to treasury on asset deposit. * @param _redemptionFee Percentage fee as ZOC that will go to treasury on share redemption. * @param _aumRate Percentage fee per second (as WAD) that should accrue to treasury as AUM fee. (1e16 = 1%). */ constructor( Registry _registry, address _receiptAsset, string memory _name, string memory _symbol, uint256 _cap, address _feeTreasury, uint256 _depositFee, uint256 _redemptionFee, uint256 _aumRate ) ERC20(_name, _symbol, ERC20(_getAsset(_receiptAsset)).decimals()) { __initEndaomentAuth(_registry, "portfolio"); registry = _registry; feeTreasury = _feeTreasury; emit FeeTreasurySet(_feeTreasury); if (_redemptionFee > Math.ZOC) revert PercentageOver100(); redemptionFee = _redemptionFee; emit RedemptionFeeSet(_redemptionFee); if (_depositFee > Math.ZOC) revert PercentageOver100(); depositFee = _depositFee; emit DepositFeeSet(_depositFee); cap = _cap; emit CapSet(_cap); receiptAsset = _receiptAsset; asset = _getAsset(_receiptAsset); baseToken = registry.baseToken(); if (_aumRate > MAX_AUM_RATE) revert InvalidRate(); aumRate = _aumRate; emit AumRateSet(_aumRate); timestampAumFeesTaken = block.timestamp; } /** * @notice Returns the underlying asset for the `receiptAsset`. * @param _receiptAsset Address of token that the portfolio receives from a deposit. * @return Address of the underlying asset. */ function _getAsset(address _receiptAsset) internal view virtual returns (address); /** * @notice Function used to determine whether an Entity is active on the registry. * @param _entity The Entity. */ function _isEntity(Entity _entity) internal view returns (bool) { return registry.isActiveEntity(_entity); } /** * @notice Set the Portfolio cap. * @param _amount Amount, denominated in baseToken. */ function setCap(uint256 _amount) external requiresAuth { cap = _amount; emit CapSet(_amount); } /** * @notice Set deposit fee. * @param _pct Percentage as ZOC (e.g. 1000 = 10%). */ function setDepositFee(uint256 _pct) external requiresAuth { if (_pct > Math.ZOC) revert PercentageOver100(); depositFee = _pct; emit DepositFeeSet(_pct); } /** * @notice Set redemption fee. * @param _pct Percentage as ZOC (e.g. 1000 = 10%). */ function setRedemptionFee(uint256 _pct) external requiresAuth { if (_pct > Math.ZOC) revert PercentageOver100(); redemptionFee = _pct; emit RedemptionFeeSet(_pct); } /** * @notice Set fee treasury. * @param _feeTreasury Address of the treasury that should receive fees. * */ function setFeeTreasury(address _feeTreasury) external requiresAuth { feeTreasury = _feeTreasury; emit FeeTreasurySet(_feeTreasury); } /** * @notice Set AUM rate. * @param _pct Percentage *per second* as WAD (e.g. .01e18 / 365.25 days = 1% per year). */ function setAumRate(uint256 _pct) external requiresAuth { // check to make sure _pct isn't above 10% over a year (.1e18 / 365.25 days = 3168808782 per second) if (_pct > MAX_AUM_RATE) revert InvalidRate(); takeAumFees(); aumRate = _pct; emit AumRateSet(_pct); } /** * @notice Total amount of the underlying asset that is managed by the Portfolio. * @return Total amount of the underlying asset. */ function totalAssets() public view returns (uint256) { return convertReceiptAssetsToAssets(totalReceiptAssets()); } /** * @notice Total amount of the receipt asset that is managed by the Portfolio. * @return Total amount of the receipt asset. */ function totalReceiptAssets() public view returns (uint256) { return ERC20(receiptAsset).balanceOf(address(this)); } /** * @notice Calculates the equivalent amount of assets for the given amount of receipt assets. * @param _receiptAssets Amount of receipt assets to convert. * @return Amount of assets. */ function convertReceiptAssetsToAssets(uint256 _receiptAssets) public view virtual returns (uint256); /** * @notice Takes some amount of receipt assets from this portfolio as management fee. * @param _amountReceiptAssets Amount of receipt assets to take. */ function takeFees(uint256 _amountReceiptAssets) external requiresAuth { ERC20(receiptAsset).safeTransfer(feeTreasury, _amountReceiptAssets); emit FeesTaken(_amountReceiptAssets); } /** * @notice Takes accrued percentage of assets from this portfolio as AUM fee. */ function takeAumFees() public { if (didShutdown) return _takeAumFeesShutdown(); uint256 _totalReceiptAssets = totalReceiptAssets(); uint256 _period = block.timestamp - timestampAumFeesTaken; uint256 _feeAmount = _calculateAumFee(_totalReceiptAssets, _period); if (_feeAmount > _totalReceiptAssets) _feeAmount = _totalReceiptAssets; if (_feeAmount > 0 || totalSupply == 0) { // in either case, we want to set `timestampAumFeesTaken`... timestampAumFeesTaken = block.timestamp; // but we only want to transfer/emit on non-zero amount if (_feeAmount > 0) { ERC20(receiptAsset).safeTransfer(feeTreasury, _feeAmount); emit AumFeesTaken(_feeAmount, _period); } } } /** * @notice Takes accrued percentage of post-shutdown baseToken from this portfolio as AUM fee. */ function _takeAumFeesShutdown() internal { uint256 _totalAssets = baseToken.balanceOf(address(this)); uint256 _period = block.timestamp - timestampAumFeesTaken; uint256 _feeAmount = _calculateAumFee(_totalAssets, _period); if (_feeAmount > _totalAssets) _feeAmount = _totalAssets; // in `takeAumFees`, the following conditional checks totalSupply as well, solving a first deposit corner case. // In this case, we don't need to check, because deposits aren't allowed after shutdown. if (_feeAmount > 0) { timestampAumFeesTaken = block.timestamp; baseToken.safeTransfer(feeTreasury, _feeAmount); emit AumFeesTaken(_feeAmount, _period); } } /** * @notice Exchange `_amountBaseToken` for some amount of Portfolio shares. * @param _amountBaseToken The amount of the Entity's baseToken to deposit. * @param _data Data that the portfolio needs to make the deposit. In some cases, this will be swap parameters. * The first 32 bytes of this data should be the ABI-encoded `minSharesOut`. * @return shares The amount of shares that this deposit yields to the Entity. */ function deposit(uint256 _amountBaseToken, bytes calldata _data) external nonReentrant returns (uint256) { // all portfolios should revert on deposit after shutdown if (didShutdown) revert DepositAfterShutdown(); // all portfolios should revert on a deposit from a non-entity (or inactive one) if (!_isEntity(Entity(payable(msg.sender)))) revert NotEntity(); // all portfolios should take AUM fees takeAumFees(); // all portfolios should make a deposit // all transferring of baseToken and share calculation should occur inside _deposit (uint256 _shares, uint256 _assets, uint256 _fee) = _deposit(_amountBaseToken, _data); if (_shares < abi.decode(_data, (uint256))) revert Slippage(); if (_shares == 0) revert RoundsToZero(); // mint shares _mint(msg.sender, _shares); // and check cap _checkCap(); // and emit an event emit Deposit(msg.sender, msg.sender, _assets, _shares, _amountBaseToken, _fee); return _shares; } /** * @notice Check to make sure the cap has not been exceeded. * @dev Most portfolios have the same asset and baseToken, so the _checkCap implementation here is written to accomodate * that situation. For portfolios where that is not the case, this method needs to be overwritten to ensure the cap * (denominated in baseToken) is properly compared to the number of assets. */ function _checkCap() internal virtual { if (asset != address(baseToken)) revert BadCheckCapImplementation(); if (totalAssets() > cap) revert ExceedsCap(); } /** * @notice Exchange `_amountIn` for some amount of Portfolio shares. * @dev Should include the transferring of baseToken and conversion to shares. * @param _amountIn The amount of the Entity's baseToken to deposit. * @param _data Data that the portfolio needs to make the deposit. In some cases, this will be swap parameters. * @return shares The amount of shares that this deposit yields to the Entity. * @return assets The amount of assets that this deposit yields to the portfolio. * @return fee The baseToken fee that this deposit yields to the treasury. */ function _deposit(uint256 _amountIn, bytes calldata _data) internal virtual returns (uint256 shares, uint256 assets, uint256 fee); /** * @notice Exchange `_amountShares` for some amount of baseToken. * @param _amountShares The amount of the Entity's portfolio shares to exchange. * @param _data Data that the portfolio needs to make the redemption. In some cases, this will be swap parameters. * @return baseTokenOut The amount of baseToken that this redemption yields to the Entity. */ function redeem(uint256 _amountShares, bytes calldata _data) external nonReentrant returns (uint256 baseTokenOut) { takeAumFees(); if (didShutdown) return _redeemShutdown(_amountShares); (uint256 _assetsOut, uint256 _baseTokenOut) = _redeem(_amountShares, _data); if (_assetsOut == 0) revert RoundsToZero(); _burn(msg.sender, _amountShares); (uint256 _netAmount, uint256 _fee) = _calculateFee(_baseTokenOut, redemptionFee); baseToken.safeTransfer(feeTreasury, _fee); baseToken.safeTransfer(msg.sender, _netAmount); emit Redeem(msg.sender, msg.sender, _assetsOut, _amountShares, _netAmount, _fee); return _netAmount; } /** * @notice Exchange `_amountShares` for some amount of Portfolio assets. * @param _amountShares The amount of portfolio shares to exchange. * @param _data Data that the portfolio needs to redeem the assets. In some cases, this will be swap parameters. * @return assetsOut The amount of assets that this redemption yielded (and then converted to baseToken). * @return baseTokenOut Amount in baseToken to which these assets were converted. */ function _redeem(uint256 _amountShares, bytes calldata _data) internal virtual returns (uint256 assetsOut, uint256 baseTokenOut); /** * @notice Handles redemption after shutdown, exchanging shares for baseToken. * @param _amountShares Shares being redeemed. * @return Amount of baseToken received. */ function _redeemShutdown(uint256 _amountShares) internal returns (uint256) { uint256 _baseTokenOut = convertToAssetsShutdown(_amountShares); _burn(msg.sender, _amountShares); (uint256 _netAmount, uint256 _fee) = _calculateFee(_baseTokenOut, redemptionFee); baseToken.safeTransfer(feeTreasury, _fee); baseToken.safeTransfer(msg.sender, _netAmount); emit Redeem(msg.sender, msg.sender, _baseTokenOut, _amountShares, _netAmount, _fee); return _netAmount; } /** * @notice Calculates the amount of shares that the Portfolio should exchange for the amount of assets provided. * @param _assets Amount of assets. * @return Amount of shares. */ function convertToShares(uint256 _assets) public view returns (uint256) { uint256 _supply = totalSupply; // Saves an extra SLOAD if totalSupply is non-zero. return _supply == 0 ? _assets : _assets.mulDivDown(_supply, totalAssets()); } /** * @notice Calculates the amount of assets that the Portfolio should exchange for the amount of shares provided. * @param _shares Amount of shares. * @return Amount of assets. */ function convertToAssets(uint256 _shares) public view returns (uint256) { uint256 _supply = totalSupply; // Saves an extra SLOAD if totalSupply is non-zero. return _supply == 0 ? _shares : _shares.mulDivDown(totalAssets(), _supply); } /** * @notice Calculates the amount of baseToken that the Portfolio should exchange for the amount of shares provided. * Used only if the Portfolio has shut down. * @dev Rounding down here favors the portfolio, so the user gets slightly less and the portfolio gets slightly more, * that way it prevents a situation where the user is owed x but the vault only has x - epsilon, where epsilon is * some tiny number due to rounding error. * @param _shares Amount of shares. * @return Amount of baseToken. */ function convertToAssetsShutdown(uint256 _shares) public view returns (uint256) { uint256 _supply = totalSupply; // Saves an extra SLOAD if totalSupply is non-zero. return _supply == 0 ? _shares : _shares.mulDivDown(baseToken.balanceOf(address(this)), _supply); } /** * @notice Exit out all assets of portfolio for baseToken. Must persist a mechanism for entities to redeem their shares for baseToken. * @param _data Data that the portfolio needs to exit from asset. Consult the portfolio's `_exit` method to determine * the correct format for this data. * @return baseTokenOut The amount of baseToken that this exit yielded. */ function shutdown(bytes calldata _data) external requiresAuth returns (uint256 baseTokenOut) { if (didShutdown) revert DidShutdown(); didShutdown = true; uint256 _assetsOut = totalAssets(); // In most cases, _actualAssetsOut will equal _assetsOut, but in SingleTokenPortfolio, it may be less. (uint256 _actualAssetsOut, uint256 _baseTokenOut) = _exit(_assetsOut, _data); emit Shutdown(_actualAssetsOut, _baseTokenOut); return _baseTokenOut; } /** * @notice Convert some amount of asset into baseToken, either partially or fully exiting the portfolio asset. * @dev This method is used in `redeem` and `shutdown` calls. * @param _amount The amount of the Entity's portfolio asset to exchange. * @param _data Data that the portfolio needs to exit from asset. In some cases, this will be swap parameters. Consult the portfolio's * `_exit` method to determine the correct format for this data. * @return actualAssetsOut The amount of assets that were exited. In most cases, this will be equal to `_amount`, but may differ * by some errorMarginPct in SingleTokenPortfolio. * @return baseTokenOut The amount of baseToken that this exit yielded. */ function _exit(uint256 _amount, bytes calldata _data) internal virtual returns (uint256 actualAssetsOut, uint256 baseTokenOut); /// @notice `transfer` disabled on Portfolio tokens. function transfer( address, // to uint256 // amount ) public pure override returns (bool) { revert TransferDisallowed(); } /// @notice `transferFrom` disabled on Portfolio tokens. function transferFrom(address, /* from */ address, /* to */ uint256 /* amount */ ) public pure override returns (bool) { revert TransferDisallowed(); } /// @notice `approve` disabled on Portfolio tokens. function approve(address, /* to */ uint256 /* amount */ ) public pure override returns (bool) { revert TransferDisallowed(); } /// @notice `permit` disabled on Portfolio tokens. function permit( address, /* owner */ address, /* spender */ uint256, /* value */ uint256, /* deadline */ uint8, /* v */ bytes32, /* r */ bytes32 /* s */ ) public pure override { revert TransferDisallowed(); } /** * @notice Permissioned method that allows Endaoment admin to make arbitrary calls acting as this Portfolio. * @param _target The address to which the call will be made. * @param _value The ETH value that should be forwarded with the call. * @param _data The calldata that will be sent with the call. * @return _return The data returned by the call. */ function callAsPortfolio(address _target, uint256 _value, bytes memory _data) external payable requiresAuth returns (bytes memory) { (bool _success, bytes memory _response) = payable(_target).call{value: _value}(_data); if (!_success) revert CallFailed(_response); return _response; } /** * @notice Internal helper method to calculate the fee on a base token amount for a given fee multiplier. * @param _amount Amount of baseToken. * @param _feeMultiplier Multiplier (as zoc) to apply to the amount. * @return _netAmount The amount of baseToken after the fee is applied. * @return _fee The amount of baseToken to be taken as a fee. */ function _calculateFee(uint256 _amount, uint256 _feeMultiplier) internal pure returns (uint256 _netAmount, uint256 _fee) { if (_feeMultiplier > Math.ZOC) revert PercentageOver100(); unchecked { // unchecked as no possibility of overflow with baseToken precision _fee = _amount.zocmul(_feeMultiplier); // unchecked as the _feeMultiplier check with revert above protects against overflow _netAmount = _amount - _fee; } } /** * @notice Helper method to calculate AUM fee based on assets and time elapsed. * @param _totalAssets Assets over which to calculate AUM fee. * @param _period Seconds elapsed since AUM fee was last taken. * @dev We chose to calculate using simple interest rather than compound interest because the error was small and * simple interest is easier to calculate, reason about, and test. * @return _aumFee The amount of baseToken to be taken as AUM fee. */ function _calculateAumFee(uint256 _totalAssets, uint256 _period) internal view returns (uint256) { if (_totalAssets == 0 || aumRate == 0 || _period == 0) return 0; // _period * aumRate is safe; max expected aum rate * 10 years of seconds is just over 1 WAD return _totalAssets.mulWadDown(_period * aumRate); } } pragma solidity 0.8.13; // Compound V2 interfaces. interface ICErc20 { function accrualBlockNumber() external view returns (uint256); function balanceOf(address owner) external view returns (uint256); function balanceOfUnderlying(address owner) external returns (uint256); function borrowRatePerBlock() external view returns (uint256); function exchangeRateCurrent() external returns (uint256); function exchangeRateStored() external view returns (uint256); function getCash() external view returns (uint256); function mint(uint256 mintAmount) external returns (uint256); function redeemUnderlying(uint256 redeemAmount) external returns (uint256); function reserveFactorMantissa() external view returns (uint256); function totalBorrows() external view returns (uint256); function totalReserves() external view returns (uint256); function totalSupply() external view returns (uint256); function underlying() external view returns (address); } // Interfaces for Compound III, which is called Comet. interface IComet { function balanceOf(address account) external view returns (uint256); function baseToken() external view returns (address); function supply(address asset, uint256 amount) external; function transfer(address dst, uint256 amount) external returns (bool); function withdraw(address asset, uint256 amount) external; function withdrawTo(address to, address asset, uint256 amount) external; } // SPDX-License-Identifier: AGPL-3.0-only pragma solidity >=0.8.0; // This contract is modified from Solmate only to make requiresAuth virtual on line 26 /// @notice Provides a flexible and updatable auth pattern which is completely separate from application logic. /// @author Solmate (https://github.com/Rari-Capital/solmate/blob/main/src/auth/Auth.sol) /// @author Modified from Dappsys (https://github.com/dapphub/ds-auth/blob/master/src/auth.sol) abstract contract Auth { event OwnerUpdated(address indexed user, address indexed newOwner); event AuthorityUpdated(address indexed user, Authority indexed newAuthority); address public owner; Authority public authority; constructor(address _owner, Authority _authority) { owner = _owner; authority = _authority; emit OwnerUpdated(msg.sender, _owner); emit AuthorityUpdated(msg.sender, _authority); } modifier requiresAuth() virtual { require(isAuthorized(msg.sender, msg.sig), "UNAUTHORIZED"); _; } function isAuthorized(address user, bytes4 functionSig) internal view virtual returns (bool) { Authority auth = authority; // Memoizing authority saves us a warm SLOAD, around 100 gas. // Checking if the caller is the owner only after calling the authority saves gas in most cases, but be // aware that this makes protected functions uncallable even to the owner if the authority is out of order. return (address(auth) != address(0) && auth.canCall(user, address(this), functionSig)) || user == owner; } function setAuthority(Authority newAuthority) public virtual { // We check if the caller is the owner first because we want to ensure they can // always swap out the authority even if it's reverting or using up a lot of gas. require(msg.sender == owner || authority.canCall(msg.sender, address(this), msg.sig)); authority = newAuthority; emit AuthorityUpdated(msg.sender, newAuthority); } function setOwner(address newOwner) public virtual requiresAuth { owner = newOwner; emit OwnerUpdated(msg.sender, newOwner); } } /// @notice A generic interface for a contract which provides authorization data to an Auth instance. /// @author Solmate (https://github.com/Rari-Capital/solmate/blob/main/src/auth/Auth.sol) /// @author Modified from Dappsys (https://github.com/dapphub/ds-auth/blob/master/src/auth.sol) interface Authority { function canCall(address user, address target, bytes4 functionSig) external view returns (bool); } // SPDX-License-Identifier: BSD 3-Clause pragma solidity 0.8.13; library Math { uint256 internal constant ZOC = 1e4; /** * @dev Multiply 2 numbers where at least one is a zoc, return product in original units of the other number. */ function zocmul(uint256 x, uint256 y) internal pure returns (uint256 z) { z = x * y; unchecked { z /= ZOC; } } // Below is WAD math from solmate's FixedPointMathLib. // https://github.com/Rari-Capital/solmate/blob/c8278b3cb948cffda3f1de5a401858035f262060/src/utils/FixedPointMathLib.sol uint256 internal constant WAD = 1e18; // The scalar of ETH and most ERC20s. function mulWadDown(uint256 x, uint256 y) internal pure returns (uint256) { return mulDivDown(x, y, WAD); // Equivalent to (x * y) / WAD rounded down. } function divWadDown(uint256 x, uint256 y) internal pure returns (uint256) { return mulDivDown(x, WAD, y); // Equivalent to (x * WAD) / y rounded down. } // For tokens with 6 decimals like USDC, these scale by 1e6 (one million). function mulMilDown(uint256 x, uint256 y) internal pure returns (uint256) { return mulDivDown(x, y, 1e6); // Equivalent to (x * y) / 1e6 rounded down. } function divMilDown(uint256 x, uint256 y) internal pure returns (uint256) { return mulDivDown(x, 1e6, y); // Equivalent to (x * 1e6) / y rounded down. } /*////////////////////////////////////////////////////////////// LOW LEVEL FIXED POINT OPERATIONS //////////////////////////////////////////////////////////////*/ function mulDivDown(uint256 x, uint256 y, uint256 denominator) internal pure returns (uint256 z) { assembly { // Store x * y in z for now. z := mul(x, y) // Equivalent to require(denominator != 0 && (x == 0 || (x * y) / x == y)) if iszero(and(iszero(iszero(denominator)), or(iszero(x), eq(div(z, x), y)))) { revert(0, 0) } // Divide z by the denominator. z := div(z, denominator) } } } // SPDX-License-Identifier: AGPL-3.0-only pragma solidity >=0.8.0; /// @notice Modern and gas efficient ERC20 + EIP-2612 implementation. /// @author Solmate (https://github.com/Rari-Capital/solmate/blob/main/src/tokens/ERC20.sol) /// @author Modified from Uniswap (https://github.com/Uniswap/uniswap-v2-core/blob/master/contracts/UniswapV2ERC20.sol) /// @dev Do not manually set balances without updating totalSupply, as the sum of all user balances must not exceed it. abstract contract ERC20 { /*/////////////////////////////////////////////////////////////// EVENTS //////////////////////////////////////////////////////////////*/ event Transfer(address indexed from, address indexed to, uint256 amount); event Approval(address indexed owner, address indexed spender, uint256 amount); /*/////////////////////////////////////////////////////////////// METADATA STORAGE //////////////////////////////////////////////////////////////*/ string public name; string public symbol; uint8 public immutable decimals; /*/////////////////////////////////////////////////////////////// ERC20 STORAGE //////////////////////////////////////////////////////////////*/ uint256 public totalSupply; mapping(address => uint256) public balanceOf; mapping(address => mapping(address => uint256)) public allowance; /*/////////////////////////////////////////////////////////////// EIP-2612 STORAGE //////////////////////////////////////////////////////////////*/ bytes32 public constant PERMIT_TYPEHASH = keccak256("Permit(address owner,address spender,uint256 value,uint256 nonce,uint256 deadline)"); uint256 internal immutable INITIAL_CHAIN_ID; bytes32 internal immutable INITIAL_DOMAIN_SEPARATOR; mapping(address => uint256) public nonces; /*/////////////////////////////////////////////////////////////// CONSTRUCTOR //////////////////////////////////////////////////////////////*/ constructor( string memory _name, string memory _symbol, uint8 _decimals ) { name = _name; symbol = _symbol; decimals = _decimals; INITIAL_CHAIN_ID = block.chainid; INITIAL_DOMAIN_SEPARATOR = computeDomainSeparator(); } /*/////////////////////////////////////////////////////////////// ERC20 LOGIC //////////////////////////////////////////////////////////////*/ function approve(address spender, uint256 amount) public virtual returns (bool) { allowance[msg.sender][spender] = amount; emit Approval(msg.sender, spender, amount); return true; } function transfer(address to, uint256 amount) public virtual returns (bool) { balanceOf[msg.sender] -= amount; // Cannot overflow because the sum of all user // balances can't exceed the max uint256 value. unchecked { balanceOf[to] += amount; } emit Transfer(msg.sender, to, amount); return true; } function transferFrom( address from, address to, uint256 amount ) public virtual returns (bool) { uint256 allowed = allowance[from][msg.sender]; // Saves gas for limited approvals. if (allowed != type(uint256).max) allowance[from][msg.sender] = allowed - amount; balanceOf[from] -= amount; // Cannot overflow because the sum of all user // balances can't exceed the max uint256 value. unchecked { balanceOf[to] += amount; } emit Transfer(from, to, amount); return true; } /*/////////////////////////////////////////////////////////////// EIP-2612 LOGIC //////////////////////////////////////////////////////////////*/ function permit( address owner, address spender, uint256 value, uint256 deadline, uint8 v, bytes32 r, bytes32 s ) public virtual { require(deadline >= block.timestamp, "PERMIT_DEADLINE_EXPIRED"); // Unchecked because the only math done is incrementing // the owner's nonce which cannot realistically overflow. unchecked { bytes32 digest = keccak256( abi.encodePacked( "\\x19\\x01", DOMAIN_SEPARATOR(), keccak256(abi.encode(PERMIT_TYPEHASH, owner, spender, value, nonces[owner]++, deadline)) ) ); address recoveredAddress = ecrecover(digest, v, r, s); require(recoveredAddress != address(0) && recoveredAddress == owner, "INVALID_SIGNER"); allowance[recoveredAddress][spender] = value; } emit Approval(owner, spender, value); } function DOMAIN_SEPARATOR() public view virtual returns (bytes32) { return block.chainid == INITIAL_CHAIN_ID ? INITIAL_DOMAIN_SEPARATOR : computeDomainSeparator(); } function computeDomainSeparator() internal view virtual returns (bytes32) { return keccak256( abi.encode( keccak256("EIP712Domain(string name,string version,uint256 chainId,address verifyingContract)"), keccak256(bytes(name)), keccak256("1"), block.chainid, address(this) ) ); } /*/////////////////////////////////////////////////////////////// INTERNAL MINT/BURN LOGIC //////////////////////////////////////////////////////////////*/ function _mint(address to, uint256 amount) internal virtual { totalSupply += amount; // Cannot overflow because the sum of all user // balances can't exceed the max uint256 value. unchecked { balanceOf[to] += amount; } emit Transfer(address(0), to, amount); } function _burn(address from, uint256 amount) internal virtual { balanceOf[from] -= amount; // Cannot underflow because a user's balance // will never be larger than the total supply. unchecked { totalSupply -= amount; } emit Transfer(from, address(0), amount); } } // SPDX-License-Identifier: AGPL-3.0-only pragma solidity >=0.8.0; import {ERC20} from "../tokens/ERC20.sol"; /// @notice Safe ETH and ERC20 transfer library that gracefully handles missing return values. /// @author Solmate (https://github.com/Rari-Capital/solmate/blob/main/src/utils/SafeTransferLib.sol) /// @author Modified from Gnosis (https://github.com/gnosis/gp-v2-contracts/blob/main/src/contracts/libraries/GPv2SafeERC20.sol) /// @dev Use with caution! Some functions in this library knowingly create dirty bits at the destination of the free memory pointer. library SafeTransferLib { /*/////////////////////////////////////////////////////////////// ETH OPERATIONS //////////////////////////////////////////////////////////////*/ function safeTransferETH(address to, uint256 amount) internal { bool callStatus; assembly { // Transfer the ETH and store if it succeeded or not. callStatus := call(gas(), to, amount, 0, 0, 0, 0) } require(callStatus, "ETH_TRANSFER_FAILED"); } /*/////////////////////////////////////////////////////////////// ERC20 OPERATIONS //////////////////////////////////////////////////////////////*/ function safeTransferFrom( ERC20 token, address from, address to, uint256 amount ) internal { bool callStatus; assembly { // Get a pointer to some free memory. let freeMemoryPointer := mload(0x40) // Write the abi-encoded calldata to memory piece by piece: mstore(freeMemoryPointer, 0x23b872dd00000000000000000000000000000000000000000000000000000000) // Begin with the function selector. mstore(add(freeMemoryPointer, 4), and(from, 0xffffffffffffffffffffffffffffffffffffffff)) // Mask and append the "from" argument. mstore(add(freeMemoryPointer, 36), and(to, 0xffffffffffffffffffffffffffffffffffffffff)) // Mask and append the "to" argument. mstore(add(freeMemoryPointer, 68), amount) // Finally append the "amount" argument. No mask as it's a full 32 byte value. // Call the token and store if it succeeded or not. // We use 100 because the calldata length is 4 + 32 * 3. callStatus := call(gas(), token, 0, freeMemoryPointer, 100, 0, 0) } require(didLastOptionalReturnCallSucceed(callStatus), "TRANSFER_FROM_FAILED"); } function safeTransfer( ERC20 token, address to, uint256 amount ) internal { bool callStatus; assembly { // Get a pointer to some free memory. let freeMemoryPointer := mload(0x40) // Write the abi-encoded calldata to memory piece by piece: mstore(freeMemoryPointer, 0xa9059cbb00000000000000000000000000000000000000000000000000000000) // Begin with the function selector. mstore(add(freeMemoryPointer, 4), and(to, 0xffffffffffffffffffffffffffffffffffffffff)) // Mask and append the "to" argument. mstore(add(freeMemoryPointer, 36), amount) // Finally append the "amount" argument. No mask as it's a full 32 byte value. // Call the token and store if it succeeded or not. // We use 68 because the calldata length is 4 + 32 * 2. callStatus := call(gas(), token, 0, freeMemoryPointer, 68, 0, 0) } require(didLastOptionalReturnCallSucceed(callStatus), "TRANSFER_FAILED"); } function safeApprove( ERC20 token, address to, uint256 amount ) internal { bool callStatus; assembly { // Get a pointer to some free memory. let freeMemoryPointer := mload(0x40) // Write the abi-encoded calldata to memory piece by piece: mstore(freeMemoryPointer, 0x095ea7b300000000000000000000000000000000000000000000000000000000) // Begin with the function selector. mstore(add(freeMemoryPointer, 4), and(to, 0xffffffffffffffffffffffffffffffffffffffff)) // Mask and append the "to" argument. mstore(add(freeMemoryPointer, 36), amount) // Finally append the "amount" argument. No mask as it's a full 32 byte value. // Call the token and store if it succeeded or not. // We use 68 because the calldata length is 4 + 32 * 2. callStatus := call(gas(), token, 0, freeMemoryPointer, 68, 0, 0) } require(didLastOptionalReturnCallSucceed(callStatus), "APPROVE_FAILED"); } /*/////////////////////////////////////////////////////////////// INTERNAL HELPER LOGIC //////////////////////////////////////////////////////////////*/ function didLastOptionalReturnCallSucceed(bool callStatus) private pure returns (bool success) { assembly { // Get how many bytes the call returned. let returnDataSize := returndatasize() // If the call reverted: if iszero(callStatus) { // Copy the revert message into memory. returndatacopy(0, 0, returnDataSize) // Revert with the same message. revert(0, returnDataSize) } switch returnDataSize case 32 { // Copy the return data into memory. returndatacopy(0, 0, returnDataSize) // Set success to whether it returned true. success := iszero(iszero(mload(0))) } case 0 { // There was no return data. success := 1 } default { // It returned some malformed input. success := 0 } } } } //SPDX-License-Identifier: BSD 3-Clause pragma solidity 0.8.13; import {Auth, Authority} from "./lib/auth/Auth.sol"; import {RolesAuthority} from "./lib/auth/authorities/RolesAuthority.sol"; // --- Errors --- error OwnershipInvalid(); /** * @notice RegistryAuth - contract to control ownership of the Registry. */ contract RegistryAuth is RolesAuthority { /// @notice Emitted when the first step of an ownership transfer (proposal) is done. event OwnershipTransferProposed(address indexed user, address indexed newOwner); /// @notice Emitted when the second step of an ownership transfer (claim) is done. event OwnershipChanged(address indexed owner, address indexed newOwner); // --- Storage --- /// @notice Pending owner for 2 step ownership transfer address public pendingOwner; // --- Constructor --- constructor(address _owner, Authority _authority) RolesAuthority(_owner, _authority) {} /** * @notice Starts the 2 step process of transferring registry authorization to a new owner. * @param _newOwner Proposed new owner of registry authorization. */ function transferOwnership(address _newOwner) external requiresAuth { pendingOwner = _newOwner; emit OwnershipTransferProposed(msg.sender, _newOwner); } /** * @notice Completes the 2 step process of transferring registry authorization to a new owner. * This function must be called by the proposed new owner. */ function claimOwnership() external { if (msg.sender != pendingOwner) revert OwnershipInvalid(); emit OwnershipChanged(owner, pendingOwner); owner = pendingOwner; pendingOwner = address(0); } /** * @notice Old approach of setting a new owner in a single step. * @dev This function throws an error to force use of the new 2-step approach. */ function setOwner(address /*newOwner*/ ) public view override requiresAuth { revert OwnershipInvalid(); } } //SPDX-License-Identifier: BSD 3-Clause pragma solidity >=0.8.0; import "solmate/tokens/ERC20.sol"; import "solmate/utils/SafeTransferLib.sol"; import "./lib/ReentrancyGuard.sol"; import {Registry} from "./Registry.sol"; import {ISwapWrapper} from "./interfaces/ISwapWrapper.sol"; import {EndaomentAuth} from "./lib/auth/EndaomentAuth.sol"; import {Portfolio} from "./Portfolio.sol"; import {Math} from "./lib/Math.sol"; error EntityInactive(); error PortfolioInactive(); error InsufficientFunds(); error InvalidAction(); error BalanceMismatch(); error CallFailed(bytes response); /** * @notice Entity contract inherited by Org and Fund contracts (and all future kinds of Entities). */ abstract contract Entity is EndaomentAuth, ReentrancyGuard { using Math for uint256; using SafeTransferLib for ERC20; /// @notice The base registry to which the entity is connected. Registry public registry; /// @notice The entity's manager. address public manager; // @notice The base token used for tracking the entity's fund balance. ERC20 public baseToken; /// @notice The current balance for the entity, denominated in the base token's units. uint256 public balance; /// @notice Placeholder address used in swapping method to denote usage of ETH instead of a token. address public constant ETH_PLACEHOLDER = 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE; /// @notice Emitted when manager is set. event EntityManagerSet(address indexed oldManager, address indexed newManager); /// @notice Emitted when a donation is made. event EntityDonationReceived( address indexed from, address indexed to, address indexed tokenIn, uint256 amountIn, uint256 amountReceived, uint256 amountFee ); /// @notice Emitted when a payout is made from an entity. event EntityValuePaidOut(address indexed from, address indexed to, uint256 amountSent, uint256 amountFee); /// @notice Emitted when a transfer is made between entities. event EntityValueTransferred(address indexed from, address indexed to, uint256 amountReceived, uint256 amountFee); /// @notice Emitted when a base token reconciliation completes event EntityBalanceReconciled(address indexed entity, uint256 amountReceived, uint256 amountFee); /// @notice Emitted when a base token balance is used to correct the internal contract balance. event EntityBalanceCorrected(address indexed entity, uint256 newBalance); /// @notice Emitted when a portfolio deposit is made. event EntityDeposit(address indexed portfolio, uint256 baseTokenDeposited, uint256 sharesReceived); /// @notice Emitted when a portfolio share redemption is made. event EntityRedeem(address indexed portfolio, uint256 sharesRedeemed, uint256 baseTokenReceived); /// @notice Emitted when ether is received. event EntityEthReceived(address indexed sender, uint256 amount); /** * @notice Modifier for methods that require auth and that the manager can access. * @dev Uses the same condition as `requiresAuth` but with added manager access. */ modifier requiresManager() { if (msg.sender != manager && !isAuthorized(msg.sender, msg.sig)) revert Unauthorized(); _; } /// @notice Each entity will implement this function to allow a caller to interrogate what kind of entity it is. function entityType() public pure virtual returns (uint8); /** * @notice One time method to be called at deployment to configure the contract. Required so Entity * contracts can be deployed as minimal proxies (clones). * @param _registry The registry to host the Entity. * @param _manager The address of the Entity's manager. */ function __initEntity(Registry _registry, address _manager) internal { // Call to EndaomentAuth's initialize function ensures that this can't be called again __initEndaomentAuth(_registry, bytes20(bytes.concat("entity", bytes1(entityType())))); __initReentrancyGuard(); registry = _registry; manager = _manager; baseToken = _registry.baseToken(); } /** * @notice Set a new manager for this entity. * @param _manager Address of new manager. * @dev Callable by current manager or permissioned role. */ function setManager(address _manager) external virtual requiresManager { emit EntityManagerSet(manager, _manager); manager = _manager; } /** * @notice Receives a donated amount of base tokens to be added to the entity's balance. Transfers default fee to treasury. * @param _amount Amount donated in base token. * @dev Reverts if the donation fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). * @dev Reverts if the token transfer fails. */ function donate(uint256 _amount) external virtual { uint32 _feeMultiplier = registry.getDonationFee(this); _donateWithFeeMultiplier(_amount, _feeMultiplier); } /** * @notice Receives a donated amount of base tokens to be added to the entity's balance. Transfers default or overridden fee to treasury. * @param _amount Amount donated in base token. * @dev Reverts if the donation fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). * @dev Reverts if the token transfer fails. */ function donateWithOverrides(uint256 _amount) external virtual { uint32 _feeMultiplier = registry.getDonationFeeWithOverrides(this); _donateWithFeeMultiplier(_amount, _feeMultiplier); } /** * @notice Receives a donated amount of base tokens to be added to the entity's balance. * This method can be called by permissioned actors to make a donation with a manually specified fee. * @param _amount Amount donated in base token. * @param _feeOverride Fee percentage as zoc. * @dev Reverts if the transfer fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). * @dev Reverts if the token transfer fails. * @dev Reverts with `Unauthorized` if the `msg.sender` is not a privileged role. */ function donateWithAdminOverrides(uint256 _amount, uint32 _feeOverride) external virtual requiresAuth { _donateWithFeeMultiplier(_amount, _feeOverride); } /** * @notice Receives a donated amount of base tokens to be added to the entity's balance. Transfers fee calculated by fee multiplier to treasury. * @param _amount Amount donated in base token. * @param _feeMultiplier Value indicating the percentage of the Endaoment donation fee to go to the Endaoment treasury. * @dev Reverts if the donation fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). * @dev Reverts if the token transfer fails. */ function _donateWithFeeMultiplier(uint256 _amount, uint32 _feeMultiplier) internal virtual { (uint256 _netAmount, uint256 _fee) = _calculateFee(_amount, _feeMultiplier); baseToken.safeTransferFrom(msg.sender, registry.treasury(), _fee); baseToken.safeTransferFrom(msg.sender, address(this), _netAmount); unchecked { // unchecked as no possibility of overflow with baseToken precision balance += _netAmount; } emit EntityDonationReceived(msg.sender, address(this), address(baseToken), _amount, _amount, _fee); } /** * @notice Receive a donated amount of ETH or ERC20 tokens, swaps them to base tokens, and adds the output to the * entity's balance. Fee calculated using default rate and sent to treasury. * @param _swapWrapper The swap wrapper to use for the donation. Must be whitelisted on the Registry. * @param _tokenIn The address of the ERC20 token to swap and donate, or ETH_PLACEHOLDER if donating ETH. * @param _amountIn The amount of tokens or ETH being swapped and donated. * @param _data Additional call data required by the ISwapWrapper being used. */ function swapAndDonate(ISwapWrapper _swapWrapper, address _tokenIn, uint256 _amountIn, bytes calldata _data) external payable virtual { uint32 _feeMultiplier = registry.getDonationFee(this); _swapAndDonateWithFeeMultiplier(_swapWrapper, _tokenIn, _amountIn, _data, _feeMultiplier); } /** * @notice Receive a donated amount of ETH or ERC20 tokens, swaps them to base tokens, and adds the output to the * entity's balance. Fee calculated using override rate and sent to treasury. * @param _swapWrapper The swap wrapper to use for the donation. Must be whitelisted on the Registry. * @param _tokenIn The address of the ERC20 token to swap and donate, or ETH_PLACEHOLDER if donating ETH. * @param _amountIn The amount of tokens or ETH being swapped and donated. * @param _data Additional call data required by the ISwapWrapper being used. */ function swapAndDonateWithOverrides( ISwapWrapper _swapWrapper, address _tokenIn, uint256 _amountIn, bytes calldata _data ) external payable virtual { uint32 _feeMultiplier = registry.getDonationFeeWithOverrides(this); _swapAndDonateWithFeeMultiplier(_swapWrapper, _tokenIn, _amountIn, _data, _feeMultiplier); } /// @dev Internal helper implementing swap and donate functionality for any fee multiplier provided. function _swapAndDonateWithFeeMultiplier( ISwapWrapper _swapWrapper, address _tokenIn, uint256 _amountIn, bytes calldata _data, uint32 _feeMultiplier ) internal virtual nonReentrant { if (!registry.isSwapperSupported(_swapWrapper)) revert InvalidAction(); // THINK: do we need a re-entrancy guard on this method? if (_tokenIn != ETH_PLACEHOLDER) { ERC20(_tokenIn).safeTransferFrom(msg.sender, address(this), _amountIn); ERC20(_tokenIn).safeApprove(address(_swapWrapper), 0); ERC20(_tokenIn).safeApprove(address(_swapWrapper), _amountIn); } uint256 _amountOut = _swapWrapper.swap{value: msg.value}(_tokenIn, address(baseToken), address(this), _amountIn, _data); (uint256 _netAmount, uint256 _fee) = _calculateFee(_amountOut, _feeMultiplier); baseToken.safeTransfer(registry.treasury(), _fee); unchecked { // unchecked as no possibility of overflow with baseToken precision balance += _netAmount; } if (balance > baseToken.balanceOf(address(this))) revert BalanceMismatch(); emit EntityDonationReceived(msg.sender, address(this), _tokenIn, _amountIn, _amountOut, _fee); } /** * @notice Transfers an amount of base tokens from one entity to another. Transfers default fee to treasury. * @param _to The entity to receive the tokens. * @param _amount Contains the amount being donated (denominated in the base token's units). * @dev Reverts if the entity is inactive or if the token transfer fails. * @dev Reverts if the transfer fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). * @dev Reverts with `Unauthorized` if the `msg.sender` is not the entity manager or a privileged role. * @dev Renamed from `transfer` to distinguish from ERC20 transfer in 3rd party tools. */ function transferToEntity(Entity _to, uint256 _amount) external virtual requiresManager { uint32 _feeMultiplier = registry.getTransferFee(this, _to); _transferWithFeeMultiplier(_to, _amount, _feeMultiplier); } /** * @notice Transfers an amount of base tokens from one entity to another. Transfers default or overridden fee to treasury. * @param _to The entity to receive the tokens. * @param _amount Contains the amount being donated (denominated in the base token's units). * @dev Reverts if the entity is inactive or if the token transfer fails. * @dev Reverts if the transfer fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). * @dev Reverts with `Unauthorized` if the `msg.sender` is not the entity manager or a privileged role. */ function transferToEntityWithOverrides(Entity _to, uint256 _amount) external virtual requiresManager { uint32 _feeMultiplier = registry.getTransferFeeWithOverrides(this, _to); _transferWithFeeMultiplier(_to, _amount, _feeMultiplier); } /** * @notice Transfers an amount of base tokens from one entity to another. Transfers fee specified by a privileged role. * @param _to The entity to receive the tokens. * @param _amount Contains the amount being donated (denominated in the base token's units). * @param _feeOverride Admin override configured by an Admin * @dev Reverts if the entity is inactive or if the token transfer fails. * @dev Reverts if the transfer fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). * @dev Reverts with `Unauthorized` if the `msg.sender` is not a privileged role. */ function transferToEntityWithAdminOverrides(Entity _to, uint256 _amount, uint32 _feeOverride) external virtual requiresAuth { _transferWithFeeMultiplier(_to, _amount, _feeOverride); } /** * @notice Transfers an amount of base tokens from one entity to another. Transfers fee calculated by fee multiplier to treasury. * @param _to The entity to receive the tokens. * @param _amount Contains the amount being donated (denominated in the base token's units). * @param _feeMultiplier Value indicating the percentage of the Endaoment donation fee to go to the Endaoment treasury. * @dev Reverts with 'Inactive' if the entity sending the transfer or the entity receiving the transfer is inactive. * @dev Reverts if the transfer fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). * @dev Reverts with `Unauthorized` if the `msg.sender` is not the entity manager or a privileged role. * @dev Reverts if the token transfer fails. */ function _transferWithFeeMultiplier(Entity _to, uint256 _amount, uint32 _feeMultiplier) internal virtual { if (!registry.isActiveEntity(this) || !registry.isActiveEntity(_to)) revert EntityInactive(); if (balance < _amount) revert InsufficientFunds(); (uint256 _netAmount, uint256 _fee) = _calculateFee(_amount, _feeMultiplier); baseToken.safeTransfer(registry.treasury(), _fee); baseToken.safeTransfer(address(_to), _netAmount); unchecked { // unchecked as no possibility of overflow with baseToken precision balance -= _amount; _to.receiveTransfer(_netAmount); } emit EntityValueTransferred(address(this), address(_to), _amount, _fee); } /** * @notice Updates the receiving entity balance on a transfer. * @param _transferAmount The amount being received on the transfer. * @dev This function is external, but is restricted such that it can only be called by other entities. */ function receiveTransfer(uint256 _transferAmount) external virtual { if (!registry.isActiveEntity(Entity(payable(msg.sender)))) revert EntityInactive(); unchecked { // Cannot overflow with realistic balances. balance += _transferAmount; } } /** * @notice Deposits an amount of Entity's `baseToken` into an Endaoment-approved Portfolio. * @param _portfolio An Endaoment-approved portfolio. * @param _amount Amount of `baseToken` to deposit into the portfolio. * @param _data Data required by a portfolio to deposit. * @return _shares Amount of portfolio share tokens Entity received as a result of this deposit. */ function portfolioDeposit(Portfolio _portfolio, uint256 _amount, bytes calldata _data) external virtual requiresManager returns (uint256) { if (!registry.isActivePortfolio(_portfolio)) revert PortfolioInactive(); balance -= _amount; baseToken.safeApprove(address(_portfolio), _amount); uint256 _shares = _portfolio.deposit(_amount, _data); emit EntityDeposit(address(_portfolio), _amount, _shares); return _shares; } /** * @notice Redeems an amount of Entity's portfolio shares for an amount of `baseToken`. * @param _portfolio An Endaoment-approved portfolio. * @param _shares Amount of share tokens to redeem. * @param _data Data required by a portfolio to redeem. * @return _received Amount of `baseToken` Entity received as a result of this redemption. */ function portfolioRedeem(Portfolio _portfolio, uint256 _shares, bytes calldata _data) external virtual requiresManager returns (uint256) { if (!registry.isActivePortfolio(_portfolio)) revert PortfolioInactive(); uint256 _received = _portfolio.redeem(_shares, _data); // unchecked: a realistic balance can never overflow a uint256 unchecked { balance += _received; } emit EntityRedeem(address(_portfolio), _shares, _received); return _received; } /** * @notice This method should be called to reconcile the Entity's internal baseToken accounting with the baseToken contract's accounting. * There are a 2 situations where calling this method is appropriate: * 1. To process amounts of baseToken that arrived at this Entity through methods besides Entity:donate or Entity:transfer. For example, * if this Entity receives a normal ERC20 transfer of baseToken, the amount received will be unavailable for Entity use until this method * is called to adjust the balance and process fees. OrgFundFactory.sol:_donate makes use of this method to do this as well. * 2. Unusually, the Entity's perspective of balance could be lower than `baseToken.balanceOf(this)`. This could happen if * Entity:callAsEntity is used to transfer baseToken. In this case, this method provides a way of correcting the Entity's internal balance. */ function reconcileBalance() external virtual { uint256 _tokenBalance = baseToken.balanceOf(address(this)); if (_tokenBalance >= balance) { uint256 _sweepAmount = _tokenBalance - balance; uint32 _feeMultiplier = registry.getDonationFeeWithOverrides(this); (uint256 _netAmount, uint256 _fee) = _calculateFee(_sweepAmount, _feeMultiplier); baseToken.safeTransfer(registry.treasury(), _fee); unchecked { balance += _netAmount; } emit EntityBalanceReconciled(address(this), _sweepAmount, _fee); } else { // Handle abnormal scenario where _tokenBalance < balance (see method docs) balance = _tokenBalance; emit EntityBalanceCorrected(address(this), _tokenBalance); } } /** * @notice Takes stray tokens or ETH sent directly to this Entity, swaps them for base token, then adds them to the * Entity's balance after paying the appropriate fee to the treasury. * @param _swapWrapper The swap wrapper to use to convert the assets. Must be whitelisted on the Registry. * @param _tokenIn The address of the ERC20 token to swap, or ETH_PLACEHOLDER if ETH. * @param _amountIn The amount of tokens or ETH being swapped and added to the balance. * @param _data Additional call data required by the ISwapWrapper being used. */ function swapAndReconcileBalance( ISwapWrapper _swapWrapper, address _tokenIn, uint256 _amountIn, bytes calldata _data ) external virtual nonReentrant requiresManager { if (!registry.isSwapperSupported(_swapWrapper)) revert InvalidAction(); uint32 _feeMultiplier = registry.getDonationFeeWithOverrides(this); if (_tokenIn != ETH_PLACEHOLDER) { ERC20(_tokenIn).safeApprove(address(_swapWrapper), 0); ERC20(_tokenIn).safeApprove(address(_swapWrapper), _amountIn); } // Send value only if token in is ETH uint256 _value = _tokenIn == ETH_PLACEHOLDER ? _amountIn : 0; uint256 _amountOut = _swapWrapper.swap{value: _value}(_tokenIn, address(baseToken), address(this), _amountIn, _data); (uint256 _netAmount, uint256 _fee) = _calculateFee(_amountOut, _feeMultiplier); baseToken.safeTransfer(registry.treasury(), _fee); unchecked { // unchecked as no possibility of overflow with baseToken precision balance += _netAmount; } if (balance > baseToken.balanceOf(address(this))) revert BalanceMismatch(); emit EntityBalanceReconciled(address(this), _amountOut, _fee); } /** * @notice Permissioned method that allows Endaoment admin to make arbitrary calls acting as this Entity. * @param _target The address to which the call will be made. * @param _value The ETH value that should be forwarded with the call. * @param _data The calldata that will be sent with the call. * @return _return The data returned by the call. */ function callAsEntity(address _target, uint256 _value, bytes memory _data) external payable virtual requiresAuth returns (bytes memory) { (bool _success, bytes memory _response) = payable(_target).call{value: _value}(_data); if (!_success) revert CallFailed(_response); return _response; } /** * @notice Pays out an amount of base tokens from the entity to an address. Transfers the fee calculated by the * default fee multiplier to the treasury. * @param _to The address to receive the tokens. * @param _amount Amount donated in base token. * @dev Reverts with `Unauthorized` if the `msg.sender` is not a privileged role. * @dev Reverts if the fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). * @dev Reverts if the token transfer fails. */ function payout(address _to, uint256 _amount) external virtual requiresAuth { uint32 _feeMultiplier = registry.getPayoutFee(this); _payoutWithFeeMultiplier(_to, _amount, _feeMultiplier); } /** * @notice Pays out an amount of base tokens from the entity to an address. Transfers the fee calculated by the * default fee multiplier to the treasury. * @param _amount Amount donated in base token. * @dev Reverts with `Unauthorized` if the `msg.sender` is not a privileged role. * @dev Reverts if the fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). * @dev Reverts if the token transfer fails. */ function payoutWithOverrides(address _to, uint256 _amount) external virtual requiresAuth { uint32 _feeMultiplier = registry.getPayoutFeeWithOverrides(this); _payoutWithFeeMultiplier(_to, _amount, _feeMultiplier); } /** * @notice Pays out an amount of base tokens from the entity to an address. Transfers fee specified by a privileged role. * @param _amount Amount donated in base token. * @param _feeOverride Payout override configured by an Admin * @dev Reverts with `Unauthorized` if the `msg.sender` is not a privileged role. * @dev Reverts if the fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). * @dev Reverts if the token transfer fails. */ function payoutWithAdminOverrides(address _to, uint256 _amount, uint32 _feeOverride) external virtual requiresAuth { _payoutWithFeeMultiplier(_to, _amount, _feeOverride); } /** * @notice Pays out an amount of base tokens from the entity to an address. Transfers the fee calculated by fee multiplier to the treasury. * @param _to The address to receive the tokens. * @param _amount Contains the amount being paid out (denominated in the base token's units). * @param _feeMultiplier Value indicating the percentage of the Endaoment fee to go to the Endaoment treasury. * @dev Reverts if the token transfer fails. * @dev Reverts if the fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). */ function _payoutWithFeeMultiplier(address _to, uint256 _amount, uint32 _feeMultiplier) internal virtual { if (balance < _amount) revert InsufficientFunds(); (uint256 _netAmount, uint256 _fee) = _calculateFee(_amount, _feeMultiplier); baseToken.safeTransfer(registry.treasury(), _fee); baseToken.safeTransfer(address(_to), _netAmount); unchecked { // unchecked because we've already validated that amount is less than or equal to the balance balance -= _amount; } emit EntityValuePaidOut(address(this), _to, _amount, _fee); } /// @dev Internal helper method to calculate the fee on a base token amount for a given fee multiplier. function _calculateFee(uint256 _amount, uint256 _feeMultiplier) internal pure virtual returns (uint256 _netAmount, uint256 _fee) { if (_feeMultiplier > Math.ZOC) revert InvalidAction(); unchecked { // unchecked as no possibility of overflow with baseToken precision _fee = _amount.zocmul(_feeMultiplier); // unchecked as the _feeMultiplier check with revert above protects against overflow _netAmount = _amount - _fee; } } receive() external payable virtual { emit EntityEthReceived(msg.sender, msg.value); } } //SPDX-License-Identifier: BSD 3-Clause pragma solidity >=0.8.0; error ETHAmountInMismatch(); /** * @notice ISwapWrapper is the interface that all swap wrappers should implement. * This will be used to support swap protocols like Uniswap V2 and V3, Sushiswap, 1inch, etc. */ interface ISwapWrapper { /// @notice Event emitted after a successful swap. event WrapperSwapExecuted( address indexed tokenIn, address indexed tokenOut, address sender, address indexed recipient, uint256 amountIn, uint256 amountOut ); /// @notice Name of swap wrapper for UX readability. function name() external returns (string memory); /** * @notice Swap function. Generally we expect the implementer to call some exactAmountIn-like swap method, and so the documentation * is written with this in mind. However, the method signature is general enough to support exactAmountOut swaps as well. * @param _tokenIn Token to be swapped (or 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE for ETH). * @param _tokenOut Token to receive (or 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE for ETH). * @param _recipient Receiver of `_tokenOut`. * @param _amount Amount of `_tokenIn` that should be swapped. * @param _data Additional data that the swap wrapper may require to execute the swap. * @return Amount of _tokenOut received. */ function swap(address _tokenIn, address _tokenOut, address _recipient, uint256 _amount, bytes calldata _data) external payable returns (uint256); } // SPDX-License-Identifier: AGPL-3.0-only pragma solidity >=0.8.0; /// @notice Gas optimized reentrancy protection for smart contracts. /// @author Solmate (https://github.com/Rari-Capital/solmate/blob/main/src/utils/ReentrancyGuard.sol) /// @author Modified from OpenZeppelin (https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/contracts/security/ReentrancyGuard.sol) abstract contract ReentrancyGuard { uint256 private reentrancyStatus = 1; modifier nonReentrant() { require(reentrancyStatus == 1, "REENTRANCY"); reentrancyStatus = 2; _; reentrancyStatus = 1; } } // SPDX-License-Identifier: AGPL-3.0-only pragma solidity >=0.8.0; import {RolesAuthority} from "./authorities/RolesAuthority.sol"; /** * @notice An abstract Auth that contracts in the Endaoment ecosystem can inherit from. It is based on * the `Auth.sol` contract from Solmate, but does not inherit from it. Most of the functionality * is either slightly different, or not needed. In particular: * - EndaomentAuth uses an initializer such that it can be deployed with minimal proxies. * - EndaomentAuth contracts reference a RolesAuthority, not just an Authority, when looking up permissions. * In the Endaoment ecosystem, this is assumed to be the Registry. * - EndaomentAuth contracts do not have an owner, but instead grant ubiquitous permission to its RoleAuthority's * owner. In the Endaoment ecosystem, this is assumed to be the board of directors multi-sig. * - EndaomentAuth contracts can optionally declare themselves a "special target" at deploy time. Instead of passing * their address to the authority when looking up their permissions, they'll instead pass the special target bytes. * See documentation on `specialTarget` for more information. * */ abstract contract EndaomentAuth { /// @notice Thrown when an account without proper permissions calls a privileged method. error Unauthorized(); /// @notice Thrown if there is an attempt to deploy with address 0 as the authority. error InvalidAuthority(); /// @notice Thrown if there is a second call to initialize. error AlreadyInitialized(); /// @notice The contract used to source permissions for accounts targeting this contract. RolesAuthority public authority; /** * @notice If set to a non-zero value, this contract will pass these byes as the target contract * to the RolesAuthority's `canCall` method, rather than its own contract. This allows a single * RolesAuthority permission to manage permissions simultaneously for a group of contracts that * identify themselves as a certain type. For example: set a permission for all "entity" contracts. */ bytes20 public specialTarget; /** * @notice One time method to be called at deployment to configure the contract. Required so EndaomentAuth * contracts can be deployed as minimal proxies (clones). * @param _authority Contract that will be used to source permissions for accounts targeting this contract. * @param _specialTarget The bytes that this contract will pass as the "target" when looking up permissions * from the authority. If set to empty bytes, this contract will pass its own address instead. */ function __initEndaomentAuth(RolesAuthority _authority, bytes20 _specialTarget) internal virtual { if (address(_authority) == address(0)) revert InvalidAuthority(); if (address(authority) != address(0)) revert AlreadyInitialized(); authority = _authority; specialTarget = _specialTarget; } /** * @notice Modifier for methods that require authorization to execute. */ modifier requiresAuth() virtual { if (!isAuthorized(msg.sender, msg.sig)) revert Unauthorized(); _; } /** * @notice Internal method that asks the authority whether the caller has permission to execute a method. * @param user The account attempting to call a permissioned method on this contract * @param functionSig The signature hash of the permissioned method being invoked. */ function isAuthorized(address user, bytes4 functionSig) internal view virtual returns (bool) { RolesAuthority auth = authority; // Memoizing authority saves us a warm SLOAD, around 100 gas. address _target = specialTarget == "" ? address(this) : address(specialTarget); // The caller has permission on authority, or the caller is the RolesAuthority owner return auth.canCall(user, _target, functionSig) || user == auth.owner(); } } // SPDX-License-Identifier: AGPL-3.0-only pragma solidity >=0.8.0; // This contract is modified from Solmate only to import modified Auth.sol on line 5 import {Auth, Authority} from "../Auth.sol"; /// @notice Role based Authority that supports up to 256 roles. /// @author Solmate (https://github.com/Rari-Capital/solmate/blob/main/src/auth/authorities/RolesAuthority.sol) /// @author Modified from Dappsys (https://github.com/dapphub/ds-roles/blob/master/src/roles.sol) contract RolesAuthority is Auth, Authority { /*/////////////////////////////////////////////////////////////// EVENTS //////////////////////////////////////////////////////////////*/ event UserRoleUpdated(address indexed user, uint8 indexed role, bool enabled); event PublicCapabilityUpdated(address indexed target, bytes4 indexed functionSig, bool enabled); event RoleCapabilityUpdated(uint8 indexed role, address indexed target, bytes4 indexed functionSig, bool enabled); /*/////////////////////////////////////////////////////////////// CONSTRUCTOR //////////////////////////////////////////////////////////////*/ constructor(address _owner, Authority _authority) Auth(_owner, _authority) {} /*/////////////////////////////////////////////////////////////// ROLE/USER STORAGE //////////////////////////////////////////////////////////////*/ mapping(address => bytes32) public getUserRoles; mapping(address => mapping(bytes4 => bool)) public isCapabilityPublic; mapping(address => mapping(bytes4 => bytes32)) public getRolesWithCapability; function doesUserHaveRole(address user, uint8 role) public view virtual returns (bool) { return (uint256(getUserRoles[user]) >> role) & 1 != 0; } function doesRoleHaveCapability(uint8 role, address target, bytes4 functionSig) public view virtual returns (bool) { return (uint256(getRolesWithCapability[target][functionSig]) >> role) & 1 != 0; } /*/////////////////////////////////////////////////////////////// AUTHORIZATION LOGIC //////////////////////////////////////////////////////////////*/ function canCall(address user, address target, bytes4 functionSig) public view virtual override returns (bool) { return isCapabilityPublic[target][functionSig] || bytes32(0) != getUserRoles[user] & getRolesWithCapability[target][functionSig]; } /*/////////////////////////////////////////////////////////////// ROLE CAPABILITY CONFIGURATION LOGIC //////////////////////////////////////////////////////////////*/ function setPublicCapability(address target, bytes4 functionSig, bool enabled) public virtual requiresAuth { isCapabilityPublic[target][functionSig] = enabled; emit PublicCapabilityUpdated(target, functionSig, enabled); } function setRoleCapability(uint8 role, address target, bytes4 functionSig, bool enabled) public virtual requiresAuth { if (enabled) { getRolesWithCapability[target][functionSig] |= bytes32(1 << role); } else { getRolesWithCapability[target][functionSig] &= ~bytes32(1 << role); } emit RoleCapabilityUpdated(role, target, functionSig, enabled); } /*/////////////////////////////////////////////////////////////// USER ROLE ASSIGNMENT LOGIC //////////////////////////////////////////////////////////////*/ function setUserRole(address user, uint8 role, bool enabled) public virtual requiresAuth { if (enabled) { getUserRoles[user] |= bytes32(1 << role); } else { getUserRoles[user] &= ~bytes32(1 << role); } emit UserRoleUpdated(user, role, enabled); } } // SPDX-License-Identifier: AGPL-3.0-only pragma solidity >=0.8.0; /// @notice Gas optimized reentrancy protection for smart contracts. /// @author Modified Solmate (https://github.com/Rari-Capital/solmate/blob/main/src/utils/ReentrancyGuard.sol) /// @author Modified from OpenZeppelin (https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/contracts/security/ReentrancyGuard.sol) abstract contract ReentrancyGuard { uint256 private reentrancyStatus; error Reentrancy(); function __initReentrancyGuard() internal { if (reentrancyStatus != 0) revert Reentrancy(); reentrancyStatus = 1; } modifier nonReentrant() { if (reentrancyStatus != 1) revert Reentrancy(); reentrancyStatus = 2; _; reentrancyStatus = 1; } }
File 5 of 9: Fund
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity >=0.8.0; /// @notice Modern and gas efficient ERC20 + EIP-2612 implementation. /// @author Solmate (https://github.com/Rari-Capital/solmate/blob/main/src/tokens/ERC20.sol) /// @author Modified from Uniswap (https://github.com/Uniswap/uniswap-v2-core/blob/master/contracts/UniswapV2ERC20.sol) /// @dev Do not manually set balances without updating totalSupply, as the sum of all user balances must not exceed it. abstract contract ERC20 { /*/////////////////////////////////////////////////////////////// EVENTS //////////////////////////////////////////////////////////////*/ event Transfer(address indexed from, address indexed to, uint256 amount); event Approval(address indexed owner, address indexed spender, uint256 amount); /*/////////////////////////////////////////////////////////////// METADATA STORAGE //////////////////////////////////////////////////////////////*/ string public name; string public symbol; uint8 public immutable decimals; /*/////////////////////////////////////////////////////////////// ERC20 STORAGE //////////////////////////////////////////////////////////////*/ uint256 public totalSupply; mapping(address => uint256) public balanceOf; mapping(address => mapping(address => uint256)) public allowance; /*/////////////////////////////////////////////////////////////// EIP-2612 STORAGE //////////////////////////////////////////////////////////////*/ bytes32 public constant PERMIT_TYPEHASH = keccak256("Permit(address owner,address spender,uint256 value,uint256 nonce,uint256 deadline)"); uint256 internal immutable INITIAL_CHAIN_ID; bytes32 internal immutable INITIAL_DOMAIN_SEPARATOR; mapping(address => uint256) public nonces; /*/////////////////////////////////////////////////////////////// CONSTRUCTOR //////////////////////////////////////////////////////////////*/ constructor( string memory _name, string memory _symbol, uint8 _decimals ) { name = _name; symbol = _symbol; decimals = _decimals; INITIAL_CHAIN_ID = block.chainid; INITIAL_DOMAIN_SEPARATOR = computeDomainSeparator(); } /*/////////////////////////////////////////////////////////////// ERC20 LOGIC //////////////////////////////////////////////////////////////*/ function approve(address spender, uint256 amount) public virtual returns (bool) { allowance[msg.sender][spender] = amount; emit Approval(msg.sender, spender, amount); return true; } function transfer(address to, uint256 amount) public virtual returns (bool) { balanceOf[msg.sender] -= amount; // Cannot overflow because the sum of all user // balances can't exceed the max uint256 value. unchecked { balanceOf[to] += amount; } emit Transfer(msg.sender, to, amount); return true; } function transferFrom( address from, address to, uint256 amount ) public virtual returns (bool) { uint256 allowed = allowance[from][msg.sender]; // Saves gas for limited approvals. if (allowed != type(uint256).max) allowance[from][msg.sender] = allowed - amount; balanceOf[from] -= amount; // Cannot overflow because the sum of all user // balances can't exceed the max uint256 value. unchecked { balanceOf[to] += amount; } emit Transfer(from, to, amount); return true; } /*/////////////////////////////////////////////////////////////// EIP-2612 LOGIC //////////////////////////////////////////////////////////////*/ function permit( address owner, address spender, uint256 value, uint256 deadline, uint8 v, bytes32 r, bytes32 s ) public virtual { require(deadline >= block.timestamp, "PERMIT_DEADLINE_EXPIRED"); // Unchecked because the only math done is incrementing // the owner's nonce which cannot realistically overflow. unchecked { bytes32 digest = keccak256( abi.encodePacked( "\\x19\\x01", DOMAIN_SEPARATOR(), keccak256(abi.encode(PERMIT_TYPEHASH, owner, spender, value, nonces[owner]++, deadline)) ) ); address recoveredAddress = ecrecover(digest, v, r, s); require(recoveredAddress != address(0) && recoveredAddress == owner, "INVALID_SIGNER"); allowance[recoveredAddress][spender] = value; } emit Approval(owner, spender, value); } function DOMAIN_SEPARATOR() public view virtual returns (bytes32) { return block.chainid == INITIAL_CHAIN_ID ? INITIAL_DOMAIN_SEPARATOR : computeDomainSeparator(); } function computeDomainSeparator() internal view virtual returns (bytes32) { return keccak256( abi.encode( keccak256("EIP712Domain(string name,string version,uint256 chainId,address verifyingContract)"), keccak256(bytes(name)), keccak256("1"), block.chainid, address(this) ) ); } /*/////////////////////////////////////////////////////////////// INTERNAL MINT/BURN LOGIC //////////////////////////////////////////////////////////////*/ function _mint(address to, uint256 amount) internal virtual { totalSupply += amount; // Cannot overflow because the sum of all user // balances can't exceed the max uint256 value. unchecked { balanceOf[to] += amount; } emit Transfer(address(0), to, amount); } function _burn(address from, uint256 amount) internal virtual { balanceOf[from] -= amount; // Cannot underflow because a user's balance // will never be larger than the total supply. unchecked { totalSupply -= amount; } emit Transfer(from, address(0), amount); } } // SPDX-License-Identifier: AGPL-3.0-only pragma solidity >=0.8.0; import {ERC20} from "../tokens/ERC20.sol"; /// @notice Safe ETH and ERC20 transfer library that gracefully handles missing return values. /// @author Solmate (https://github.com/Rari-Capital/solmate/blob/main/src/utils/SafeTransferLib.sol) /// @author Modified from Gnosis (https://github.com/gnosis/gp-v2-contracts/blob/main/src/contracts/libraries/GPv2SafeERC20.sol) /// @dev Use with caution! Some functions in this library knowingly create dirty bits at the destination of the free memory pointer. library SafeTransferLib { /*/////////////////////////////////////////////////////////////// ETH OPERATIONS //////////////////////////////////////////////////////////////*/ function safeTransferETH(address to, uint256 amount) internal { bool callStatus; assembly { // Transfer the ETH and store if it succeeded or not. callStatus := call(gas(), to, amount, 0, 0, 0, 0) } require(callStatus, "ETH_TRANSFER_FAILED"); } /*/////////////////////////////////////////////////////////////// ERC20 OPERATIONS //////////////////////////////////////////////////////////////*/ function safeTransferFrom( ERC20 token, address from, address to, uint256 amount ) internal { bool callStatus; assembly { // Get a pointer to some free memory. let freeMemoryPointer := mload(0x40) // Write the abi-encoded calldata to memory piece by piece: mstore(freeMemoryPointer, 0x23b872dd00000000000000000000000000000000000000000000000000000000) // Begin with the function selector. mstore(add(freeMemoryPointer, 4), and(from, 0xffffffffffffffffffffffffffffffffffffffff)) // Mask and append the "from" argument. mstore(add(freeMemoryPointer, 36), and(to, 0xffffffffffffffffffffffffffffffffffffffff)) // Mask and append the "to" argument. mstore(add(freeMemoryPointer, 68), amount) // Finally append the "amount" argument. No mask as it's a full 32 byte value. // Call the token and store if it succeeded or not. // We use 100 because the calldata length is 4 + 32 * 3. callStatus := call(gas(), token, 0, freeMemoryPointer, 100, 0, 0) } require(didLastOptionalReturnCallSucceed(callStatus), "TRANSFER_FROM_FAILED"); } function safeTransfer( ERC20 token, address to, uint256 amount ) internal { bool callStatus; assembly { // Get a pointer to some free memory. let freeMemoryPointer := mload(0x40) // Write the abi-encoded calldata to memory piece by piece: mstore(freeMemoryPointer, 0xa9059cbb00000000000000000000000000000000000000000000000000000000) // Begin with the function selector. mstore(add(freeMemoryPointer, 4), and(to, 0xffffffffffffffffffffffffffffffffffffffff)) // Mask and append the "to" argument. mstore(add(freeMemoryPointer, 36), amount) // Finally append the "amount" argument. No mask as it's a full 32 byte value. // Call the token and store if it succeeded or not. // We use 68 because the calldata length is 4 + 32 * 2. callStatus := call(gas(), token, 0, freeMemoryPointer, 68, 0, 0) } require(didLastOptionalReturnCallSucceed(callStatus), "TRANSFER_FAILED"); } function safeApprove( ERC20 token, address to, uint256 amount ) internal { bool callStatus; assembly { // Get a pointer to some free memory. let freeMemoryPointer := mload(0x40) // Write the abi-encoded calldata to memory piece by piece: mstore(freeMemoryPointer, 0x095ea7b300000000000000000000000000000000000000000000000000000000) // Begin with the function selector. mstore(add(freeMemoryPointer, 4), and(to, 0xffffffffffffffffffffffffffffffffffffffff)) // Mask and append the "to" argument. mstore(add(freeMemoryPointer, 36), amount) // Finally append the "amount" argument. No mask as it's a full 32 byte value. // Call the token and store if it succeeded or not. // We use 68 because the calldata length is 4 + 32 * 2. callStatus := call(gas(), token, 0, freeMemoryPointer, 68, 0, 0) } require(didLastOptionalReturnCallSucceed(callStatus), "APPROVE_FAILED"); } /*/////////////////////////////////////////////////////////////// INTERNAL HELPER LOGIC //////////////////////////////////////////////////////////////*/ function didLastOptionalReturnCallSucceed(bool callStatus) private pure returns (bool success) { assembly { // Get how many bytes the call returned. let returnDataSize := returndatasize() // If the call reverted: if iszero(callStatus) { // Copy the revert message into memory. returndatacopy(0, 0, returnDataSize) // Revert with the same message. revert(0, returnDataSize) } switch returnDataSize case 32 { // Copy the return data into memory. returndatacopy(0, 0, returnDataSize) // Set success to whether it returned true. success := iszero(iszero(mload(0))) } case 0 { // There was no return data. success := 1 } default { // It returned some malformed input. success := 0 } } } } //SPDX-License-Identifier: BSD 3-Clause pragma solidity >=0.8.0; import "solmate/tokens/ERC20.sol"; import "solmate/utils/SafeTransferLib.sol"; import "./lib/ReentrancyGuard.sol"; import { Registry } from "./Registry.sol"; import { ISwapWrapper } from "./interfaces/ISwapWrapper.sol"; import { EndaomentAuth } from "./lib/auth/EndaomentAuth.sol"; import { Portfolio } from "./Portfolio.sol"; import { Math } from "./lib/Math.sol"; error EntityInactive(); error PortfolioInactive(); error InsufficientFunds(); error InvalidAction(); error BalanceMismatch(); error CallFailed(bytes response); /** * @notice Entity contract inherited by Org and Fund contracts (and all future kinds of Entities). */ abstract contract Entity is EndaomentAuth, ReentrancyGuard { using Math for uint256; using SafeTransferLib for ERC20; /// @notice The base registry to which the entity is connected. Registry public registry; /// @notice The entity's manager. address public manager; // @notice The base token used for tracking the entity's fund balance. ERC20 public baseToken; /// @notice The current balance for the entity, denominated in the base token's units. uint256 public balance; /// @notice Placeholder address used in swapping method to denote usage of ETH instead of a token. address public constant ETH_PLACEHOLDER = 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE; /// @notice Emitted when manager is set. event EntityManagerSet(address indexed oldManager, address indexed newManager); /// @notice Emitted when a donation is made. event EntityDonationReceived( address indexed from, address indexed to, address indexed tokenIn, uint256 amountIn, uint256 amountReceived, uint256 amountFee ); /// @notice Emitted when a payout is made from an entity. event EntityValuePaidOut(address indexed from, address indexed to, uint256 amountSent, uint256 amountFee); /// @notice Emitted when a transfer is made between entities. event EntityValueTransferred(address indexed from, address indexed to, uint256 amountReceived, uint256 amountFee); /// @notice Emitted when a base token reconciliation completes event EntityBalanceReconciled(address indexed entity, uint256 amountReceived, uint256 amountFee); /// @notice Emitted when a base token balance is used to correct the internal contract balance. event EntityBalanceCorrected(address indexed entity, uint256 newBalance); /// @notice Emitted when a portfolio deposit is made. event EntityDeposit(address indexed portfolio, uint256 baseTokenDeposited, uint256 sharesReceived); /// @notice Emitted when a portfolio share redemption is made. event EntityRedeem(address indexed portfolio, uint256 sharesRedeemed, uint256 baseTokenReceived); /// @notice Emitted when ether is received. event EntityEthReceived(address indexed sender, uint256 amount); /** * @notice Modifier for methods that require auth and that the manager can access. * @dev Uses the same condition as `requiresAuth` but with added manager access. */ modifier requiresManager { if(msg.sender != manager && !isAuthorized(msg.sender, msg.sig)) revert Unauthorized(); _; } /// @notice Each entity will implement this function to allow a caller to interrogate what kind of entity it is. function entityType() public pure virtual returns (uint8); /** * @notice One time method to be called at deployment to configure the contract. Required so Entity * contracts can be deployed as minimal proxies (clones). * @param _registry The registry to host the Entity. * @param _manager The address of the Entity's manager. */ function __initEntity(Registry _registry, address _manager) internal { // Call to EndaomentAuth's initialize function ensures that this can't be called again __initEndaomentAuth(_registry, bytes20(bytes.concat("entity", bytes1(entityType())))); __initReentrancyGuard(); registry = _registry; manager = _manager; baseToken = _registry.baseToken(); } /** * @notice Set a new manager for this entity. * @param _manager Address of new manager. * @dev Callable by current manager or permissioned role. */ function setManager(address _manager) external virtual requiresManager { emit EntityManagerSet(manager, _manager); manager = _manager; } /** * @notice Receives a donated amount of base tokens to be added to the entity's balance. Transfers default fee to treasury. * @param _amount Amount donated in base token. * @dev Reverts if the donation fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). * @dev Reverts if the token transfer fails. */ function donate(uint256 _amount) external virtual { uint32 _feeMultiplier = registry.getDonationFee(this); _donateWithFeeMultiplier(_amount, _feeMultiplier); } /** * @notice Receives a donated amount of base tokens to be added to the entity's balance. Transfers default or overridden fee to treasury. * @param _amount Amount donated in base token. * @dev Reverts if the donation fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). * @dev Reverts if the token transfer fails. */ function donateWithOverrides(uint256 _amount) external virtual { uint32 _feeMultiplier = registry.getDonationFeeWithOverrides(this); _donateWithFeeMultiplier(_amount, _feeMultiplier); } /** * @notice Receives a donated amount of base tokens to be added to the entity's balance. * This method can be called by permissioned actors to make a donation with a manually specified fee. * @param _amount Amount donated in base token. * @param _feeOverride Fee percentage as zoc. * @dev Reverts if the transfer fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). * @dev Reverts if the token transfer fails. * @dev Reverts with `Unauthorized` if the `msg.sender` is not a privileged role. */ function donateWithAdminOverrides(uint256 _amount, uint32 _feeOverride) requiresAuth external virtual { _donateWithFeeMultiplier(_amount, _feeOverride); } /** * @notice Receives a donated amount of base tokens to be added to the entity's balance. Transfers fee calculated by fee multiplier to treasury. * @param _amount Amount donated in base token. * @param _feeMultiplier Value indicating the percentage of the Endaoment donation fee to go to the Endaoment treasury. * @dev Reverts if the donation fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). * @dev Reverts if the token transfer fails. */ function _donateWithFeeMultiplier(uint256 _amount, uint32 _feeMultiplier) internal virtual { (uint256 _netAmount, uint256 _fee) = _calculateFee(_amount, _feeMultiplier); baseToken.safeTransferFrom(msg.sender, registry.treasury(), _fee); baseToken.safeTransferFrom(msg.sender, address(this), _netAmount); unchecked { // unchecked as no possibility of overflow with baseToken precision balance += _netAmount; } emit EntityDonationReceived(msg.sender, address(this), address(baseToken), _amount, _amount, _fee); } /** * @notice Receive a donated amount of ETH or ERC20 tokens, swaps them to base tokens, and adds the output to the * entity's balance. Fee calculated using default rate and sent to treasury. * @param _swapWrapper The swap wrapper to use for the donation. Must be whitelisted on the Registry. * @param _tokenIn The address of the ERC20 token to swap and donate, or ETH_PLACEHOLDER if donating ETH. * @param _amountIn The amount of tokens or ETH being swapped and donated. * @param _data Additional call data required by the ISwapWrapper being used. */ function swapAndDonate( ISwapWrapper _swapWrapper, address _tokenIn, uint256 _amountIn, bytes calldata _data ) external virtual payable { uint32 _feeMultiplier = registry.getDonationFee(this); _swapAndDonateWithFeeMultiplier(_swapWrapper, _tokenIn, _amountIn, _data, _feeMultiplier); } /** * @notice Receive a donated amount of ETH or ERC20 tokens, swaps them to base tokens, and adds the output to the * entity's balance. Fee calculated using override rate and sent to treasury. * @param _swapWrapper The swap wrapper to use for the donation. Must be whitelisted on the Registry. * @param _tokenIn The address of the ERC20 token to swap and donate, or ETH_PLACEHOLDER if donating ETH. * @param _amountIn The amount of tokens or ETH being swapped and donated. * @param _data Additional call data required by the ISwapWrapper being used. */ function swapAndDonateWithOverrides( ISwapWrapper _swapWrapper, address _tokenIn, uint256 _amountIn, bytes calldata _data ) external virtual payable { uint32 _feeMultiplier = registry.getDonationFeeWithOverrides(this); _swapAndDonateWithFeeMultiplier(_swapWrapper, _tokenIn, _amountIn, _data, _feeMultiplier); } /// @dev Internal helper implementing swap and donate functionality for any fee multiplier provided. function _swapAndDonateWithFeeMultiplier( ISwapWrapper _swapWrapper, address _tokenIn, uint256 _amountIn, bytes calldata _data, uint32 _feeMultiplier ) nonReentrant internal virtual { if (!registry.isSwapperSupported(_swapWrapper)) revert InvalidAction(); // THINK: do we need a re-entrancy guard on this method? if (_tokenIn != ETH_PLACEHOLDER) { ERC20(_tokenIn).safeTransferFrom(msg.sender, address(this), _amountIn); ERC20(_tokenIn).safeApprove(address(_swapWrapper), 0); ERC20(_tokenIn).safeApprove(address(_swapWrapper), _amountIn); } uint256 _amountOut = _swapWrapper.swap{value: msg.value}( _tokenIn, address(baseToken), address(this), _amountIn, _data ); (uint256 _netAmount, uint256 _fee) = _calculateFee(_amountOut, _feeMultiplier); baseToken.safeTransfer(registry.treasury(), _fee); unchecked { // unchecked as no possibility of overflow with baseToken precision balance += _netAmount; } if(balance > baseToken.balanceOf(address(this))) revert BalanceMismatch(); emit EntityDonationReceived(msg.sender, address(this), _tokenIn, _amountIn, _amountOut, _fee); } /** * @notice Transfers an amount of base tokens from one entity to another. Transfers default fee to treasury. * @param _to The entity to receive the tokens. * @param _amount Contains the amount being donated (denominated in the base token's units). * @dev Reverts if the entity is inactive or if the token transfer fails. * @dev Reverts if the transfer fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). * @dev Reverts with `Unauthorized` if the `msg.sender` is not the entity manager or a privileged role. * @dev Renamed from `transfer` to distinguish from ERC20 transfer in 3rd party tools. */ function transferToEntity(Entity _to, uint256 _amount) requiresManager external virtual { uint32 _feeMultiplier = registry.getTransferFee(this, _to); _transferWithFeeMultiplier(_to, _amount, _feeMultiplier); } /** * @notice Transfers an amount of base tokens from one entity to another. Transfers default or overridden fee to treasury. * @param _to The entity to receive the tokens. * @param _amount Contains the amount being donated (denominated in the base token's units). * @dev Reverts if the entity is inactive or if the token transfer fails. * @dev Reverts if the transfer fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). * @dev Reverts with `Unauthorized` if the `msg.sender` is not the entity manager or a privileged role. */ function transferToEntityWithOverrides(Entity _to, uint256 _amount) requiresManager external virtual { uint32 _feeMultiplier = registry.getTransferFeeWithOverrides(this, _to); _transferWithFeeMultiplier(_to, _amount, _feeMultiplier); } /** * @notice Transfers an amount of base tokens from one entity to another. Transfers fee specified by a privileged role. * @param _to The entity to receive the tokens. * @param _amount Contains the amount being donated (denominated in the base token's units). * @param _feeOverride Admin override configured by an Admin * @dev Reverts if the entity is inactive or if the token transfer fails. * @dev Reverts if the transfer fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). * @dev Reverts with `Unauthorized` if the `msg.sender` is not a privileged role. */ function transferToEntityWithAdminOverrides(Entity _to, uint256 _amount, uint32 _feeOverride) requiresAuth external virtual { _transferWithFeeMultiplier(_to, _amount, _feeOverride); } /** * @notice Transfers an amount of base tokens from one entity to another. Transfers fee calculated by fee multiplier to treasury. * @param _to The entity to receive the tokens. * @param _amount Contains the amount being donated (denominated in the base token's units). * @param _feeMultiplier Value indicating the percentage of the Endaoment donation fee to go to the Endaoment treasury. * @dev Reverts with 'Inactive' if the entity sending the transfer or the entity receiving the transfer is inactive. * @dev Reverts if the transfer fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). * @dev Reverts with `Unauthorized` if the `msg.sender` is not the entity manager or a privileged role. * @dev Reverts if the token transfer fails. */ function _transferWithFeeMultiplier(Entity _to, uint256 _amount, uint32 _feeMultiplier) internal virtual { if (!registry.isActiveEntity(this) || !registry.isActiveEntity(_to)) revert EntityInactive(); if (balance < _amount) revert InsufficientFunds(); (uint256 _netAmount, uint256 _fee) = _calculateFee(_amount, _feeMultiplier); baseToken.safeTransfer(registry.treasury(), _fee); baseToken.safeTransfer(address(_to), _netAmount); unchecked { // unchecked as no possibility of overflow with baseToken precision balance -= _amount; _to.receiveTransfer(_netAmount); } emit EntityValueTransferred(address(this), address(_to), _amount, _fee); } /** * @notice Updates the receiving entity balance on a transfer. * @param _transferAmount The amount being received on the transfer. * @dev This function is external, but is restricted such that it can only be called by other entities. */ function receiveTransfer(uint256 _transferAmount) external virtual { if (!registry.isActiveEntity(Entity(payable(msg.sender)))) revert EntityInactive(); unchecked { // Cannot overflow with realistic balances. balance += _transferAmount; } } /** * @notice Deposits an amount of Entity's `baseToken` into an Endaoment-approved Portfolio. * @param _portfolio An Endaoment-approved portfolio. * @param _amount Amount of `baseToken` to deposit into the portfolio. * @param _data Data required by a portfolio to deposit. * @return _shares Amount of portfolio share tokens Entity received as a result of this deposit. */ function portfolioDeposit(Portfolio _portfolio, uint256 _amount, bytes calldata _data) external virtual requiresManager returns (uint256) { if(!registry.isActivePortfolio(_portfolio)) revert PortfolioInactive(); balance -= _amount; baseToken.safeApprove(address(_portfolio), _amount); uint256 _shares = _portfolio.deposit(_amount, _data); emit EntityDeposit(address(_portfolio), _amount, _shares); return _shares; } /** * @notice Redeems an amount of Entity's portfolio shares for an amount of `baseToken`. * @param _portfolio An Endaoment-approved portfolio. * @param _shares Amount of share tokens to redeem. * @param _data Data required by a portfolio to redeem. * @return _received Amount of `baseToken` Entity received as a result of this redemption. */ function portfolioRedeem(Portfolio _portfolio, uint256 _shares, bytes calldata _data) external virtual requiresManager returns (uint256) { if(!registry.isActivePortfolio(_portfolio)) revert PortfolioInactive(); uint256 _received = _portfolio.redeem(_shares, _data); // unchecked: a realistic balance can never overflow a uint256 unchecked { balance += _received; } emit EntityRedeem(address(_portfolio), _shares, _received); return _received; } /** * @notice This method should be called to reconcile the Entity's internal baseToken accounting with the baseToken contract's accounting. * There are a 2 situations where calling this method is appropriate: * 1. To process amounts of baseToken that arrived at this Entity through methods besides Entity:donate or Entity:transfer. For example, * if this Entity receives a normal ERC20 transfer of baseToken, the amount received will be unavailable for Entity use until this method * is called to adjust the balance and process fees. OrgFundFactory.sol:_donate makes use of this method to do this as well. * 2. Unusually, the Entity's perspective of balance could be lower than `baseToken.balanceOf(this)`. This could happen if * Entity:callAsEntity is used to transfer baseToken. In this case, this method provides a way of correcting the Entity's internal balance. */ function reconcileBalance() external virtual { uint256 _tokenBalance = baseToken.balanceOf(address(this)); if (_tokenBalance >= balance) { uint256 _sweepAmount = _tokenBalance - balance; uint32 _feeMultiplier = registry.getDonationFeeWithOverrides(this); (uint256 _netAmount, uint256 _fee) = _calculateFee(_sweepAmount, _feeMultiplier); baseToken.safeTransfer(registry.treasury(), _fee); unchecked { balance += _netAmount; } emit EntityBalanceReconciled(address(this), _sweepAmount, _fee); } else { // Handle abnormal scenario where _tokenBalance < balance (see method docs) balance = _tokenBalance; emit EntityBalanceCorrected(address(this), _tokenBalance); } } /** * @notice Takes stray tokens or ETH sent directly to this Entity, swaps them for base token, then adds them to the * Entity's balance after paying the appropriate fee to the treasury. * @param _swapWrapper The swap wrapper to use to convert the assets. Must be whitelisted on the Registry. * @param _tokenIn The address of the ERC20 token to swap, or ETH_PLACEHOLDER if ETH. * @param _amountIn The amount of tokens or ETH being swapped and added to the balance. * @param _data Additional call data required by the ISwapWrapper being used. */ function swapAndReconcileBalance( ISwapWrapper _swapWrapper, address _tokenIn, uint256 _amountIn, bytes calldata _data ) nonReentrant external virtual requiresManager { if (!registry.isSwapperSupported(_swapWrapper)) revert InvalidAction(); uint32 _feeMultiplier = registry.getDonationFeeWithOverrides(this); if (_tokenIn != ETH_PLACEHOLDER) { ERC20(_tokenIn).safeApprove(address(_swapWrapper), 0); ERC20(_tokenIn).safeApprove(address(_swapWrapper), _amountIn); } // Send value only if token in is ETH uint256 _value = _tokenIn == ETH_PLACEHOLDER ? _amountIn : 0; uint256 _amountOut = _swapWrapper.swap{value: _value}( _tokenIn, address(baseToken), address(this), _amountIn, _data ); (uint256 _netAmount, uint256 _fee) = _calculateFee(_amountOut, _feeMultiplier); baseToken.safeTransfer(registry.treasury(), _fee); unchecked { // unchecked as no possibility of overflow with baseToken precision balance += _netAmount; } if(balance > baseToken.balanceOf(address(this))) revert BalanceMismatch(); emit EntityBalanceReconciled(address(this), _amountOut, _fee); } /** * @notice Permissioned method that allows Endaoment admin to make arbitrary calls acting as this Entity. * @param _target The address to which the call will be made. * @param _value The ETH value that should be forwarded with the call. * @param _data The calldata that will be sent with the call. * @return _return The data returned by the call. */ function callAsEntity( address _target, uint256 _value, bytes memory _data ) external virtual payable requiresAuth returns (bytes memory) { (bool _success, bytes memory _response) = payable(_target).call{value: _value}(_data); if (!_success) revert CallFailed(_response); return _response; } /** * @notice Pays out an amount of base tokens from the entity to an address. Transfers the fee calculated by the * default fee multiplier to the treasury. * @param _to The address to receive the tokens. * @param _amount Amount donated in base token. * @dev Reverts with `Unauthorized` if the `msg.sender` is not a privileged role. * @dev Reverts if the fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). * @dev Reverts if the token transfer fails. */ function payout(address _to, uint256 _amount) external virtual requiresAuth { uint32 _feeMultiplier = registry.getPayoutFee(this); _payoutWithFeeMultiplier(_to, _amount, _feeMultiplier); } /** * @notice Pays out an amount of base tokens from the entity to an address. Transfers the fee calculated by the * default fee multiplier to the treasury. * @param _amount Amount donated in base token. * @dev Reverts with `Unauthorized` if the `msg.sender` is not a privileged role. * @dev Reverts if the fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). * @dev Reverts if the token transfer fails. */ function payoutWithOverrides(address _to, uint256 _amount) external virtual requiresAuth { uint32 _feeMultiplier = registry.getPayoutFeeWithOverrides(this); _payoutWithFeeMultiplier(_to, _amount, _feeMultiplier); } /** * @notice Pays out an amount of base tokens from the entity to an address. Transfers fee specified by a privileged role. * @param _amount Amount donated in base token. * @param _feeOverride Payout override configured by an Admin * @dev Reverts with `Unauthorized` if the `msg.sender` is not a privileged role. * @dev Reverts if the fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). * @dev Reverts if the token transfer fails. */ function payoutWithAdminOverrides(address _to, uint256 _amount, uint32 _feeOverride) external virtual requiresAuth { _payoutWithFeeMultiplier(_to, _amount, _feeOverride); } /** * @notice Pays out an amount of base tokens from the entity to an address. Transfers the fee calculated by fee multiplier to the treasury. * @param _to The address to receive the tokens. * @param _amount Contains the amount being paid out (denominated in the base token's units). * @param _feeMultiplier Value indicating the percentage of the Endaoment fee to go to the Endaoment treasury. * @dev Reverts if the token transfer fails. * @dev Reverts if the fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). */ function _payoutWithFeeMultiplier(address _to, uint256 _amount, uint32 _feeMultiplier) internal virtual { if (balance < _amount) revert InsufficientFunds(); (uint256 _netAmount, uint256 _fee) = _calculateFee(_amount, _feeMultiplier); baseToken.safeTransfer(registry.treasury(), _fee); baseToken.safeTransfer(address(_to), _netAmount); unchecked { // unchecked because we've already validated that amount is less than or equal to the balance balance -= _amount; } emit EntityValuePaidOut(address(this), _to, _amount, _fee); } /// @dev Internal helper method to calculate the fee on a base token amount for a given fee multiplier. function _calculateFee( uint256 _amount, uint256 _feeMultiplier ) internal virtual pure returns (uint256 _netAmount, uint256 _fee) { if (_feeMultiplier > Math.ZOC) revert InvalidAction(); unchecked { // unchecked as no possibility of overflow with baseToken precision _fee = _amount.zocmul(_feeMultiplier); // unchecked as the _feeMultiplier check with revert above protects against overflow _netAmount = _amount - _fee; } } receive() external virtual payable { emit EntityEthReceived(msg.sender, msg.value); } } //SPDX-License-Identifier: BSD 3-Clause pragma solidity 0.8.13; import { Registry } from "./Registry.sol"; import { Entity } from "./Entity.sol"; /** * @notice Fund entity */ contract Fund is Entity { /** * @notice One time method to be called at deployment to configure the contract. Required so Fund * contracts can be deployed as minimal proxies (clones). * @param _registry The registry to host the Fund Entity. * @param _manager The address of the Fund's manager. */ function initialize(Registry _registry, address _manager) public { // Call to Entity's initialization function ensures this can only be called once __initEntity(_registry, _manager); } /** * @inheritdoc Entity */ function entityType() public pure override returns (uint8) { return 2; } } //SPDX-License-Identifier: BSD 3-Clause pragma solidity >=0.8.0; import { ERC20 } from "solmate/tokens/ERC20.sol"; import { Registry } from "./Registry.sol"; import { Entity } from "./Entity.sol"; import { EndaomentAuth } from "./lib/auth/EndaomentAuth.sol"; import { RolesAuthority } from "./lib/auth/authorities/RolesAuthority.sol"; import { Math } from "./lib/Math.sol"; abstract contract Portfolio is ERC20, EndaomentAuth { using Math for uint256; Registry public immutable registry; uint256 public cap; uint256 public depositFee; uint256 public redemptionFee; address public immutable asset; bool public didShutdown; error InvalidSwapper(); error TransferDisallowed(); error DepositAfterShutdown(); error DidShutdown(); error NotEntity(); error ExceedsCap(); error PercentageOver100(); error RoundsToZero(); error CallFailed(bytes response); /// @notice `sender` has exchanged `assets` (after fees) for `shares`, and transferred those `shares` to `receiver`. /// The sender paid a total of `depositAmount` and was charged `fee` for the transaction. event Deposit( address indexed sender, address indexed receiver, uint256 assets, uint256 shares, uint256 depositAmount, uint256 fee ); /// @notice `sender` has exchanged `shares` for `assets`, and transferred those `assets` to `receiver`. /// The sender received a net of `redeemedAmount` after the conversion of `assets` into base tokens /// and was charged `fee` for the transaction. event Redeem( address indexed sender, address indexed receiver, uint256 assets, uint256 shares, uint256 redeemedAmount, uint256 fee ); /// @notice Event emitted when `cap` is set. event CapSet(uint256 cap); /// @notice Event emitted when `depositFee` is set. event DepositFeeSet(uint256 fee); /// @notice Event emitted when `redemptionFee` is set. event RedemptionFeeSet(uint256 fee); /// @notice Event emitted when management takes fees. event FeesTaken(uint256 amount); /// @notice Event emitted when admin forcefully swaps portfolio asset balance for baseToken. event Shutdown(uint256 assetAmount, uint256 baseTokenOut); /** * @param _registry Endaoment registry. * @param _name Name of the ERC20 Portfolio share tokens. * @param _symbol Symbol of the ERC20 Portfolio share tokens. * @param _cap Amount in baseToken that value of totalAssets should not exceed. * @param _depositFee Percentage fee as ZOC that will go to treasury on asset deposit. * @param _redemptionFee Percentage fee as ZOC that will go to treasury on share redemption. */ constructor(Registry _registry, address _asset, string memory _name, string memory _symbol, uint256 _cap, uint256 _depositFee, uint256 _redemptionFee) ERC20(_name, _symbol, ERC20(_asset).decimals()) { registry = _registry; if(_redemptionFee > Math.ZOC) revert PercentageOver100(); depositFee = _depositFee; redemptionFee = _redemptionFee; cap = _cap; asset = _asset; __initEndaomentAuth(_registry, "portfolio"); } /** * @notice Function used to determine whether an Entity is active on the registry. * @param _entity The Entity. */ function _isEntity(Entity _entity) internal view returns (bool) { return registry.isActiveEntity(_entity); } /** * @notice Set the Portfolio cap. * @param _amount Amount, denominated in baseToken. */ function setCap(uint256 _amount) external virtual requiresAuth { cap = _amount; emit CapSet(_amount); } /** * @notice Set deposit fee. * @param _pct Percentage as ZOC (e.g. 1000 = 10%). */ function setDepositFee(uint256 _pct) external virtual requiresAuth { if(_pct > Math.ZOC) revert PercentageOver100(); depositFee = _pct; emit DepositFeeSet(_pct); } /** * @notice Set redemption fee. * @param _pct Percentage as ZOC (e.g. 1000 = 10%). */ function setRedemptionFee(uint256 _pct) external virtual requiresAuth { if(_pct > Math.ZOC) revert PercentageOver100(); redemptionFee = _pct; emit RedemptionFeeSet(_pct); } /** * @notice Total amount of the underlying asset that is managed by the Portfolio. */ function totalAssets() external view virtual returns (uint256); /** * @notice Takes some amount of assets from this portfolio as assets under management fee. * @param _amountAssets Amount of assets to take. */ function takeFees(uint256 _amountAssets) external virtual; /** * @notice Exchange `_amountBaseToken` for some amount of Portfolio shares. * @param _amountBaseToken The amount of the Entity's baseToken to deposit. * @param _data Data that the portfolio needs to make the deposit. In some cases, this will be swap parameters. * @return shares The amount of shares that this deposit yields to the Entity. */ function deposit(uint256 _amountBaseToken, bytes calldata _data) virtual external returns (uint256 shares); /** * @notice Exchange `_amountShares` for some amount of baseToken. * @param _amountShares The amount of the Entity's portfolio shares to exchange. * @param _data Data that the portfolio needs to make the redemption. In some cases, this will be swap parameters. * @return baseTokenOut The amount of baseToken that this redemption yields to the Entity. */ function redeem(uint256 _amountShares, bytes calldata _data) virtual external returns (uint256 baseTokenOut); /** * @notice Calculates the amount of shares that the Portfolio should exchange for the amount of assets provided. * @param _amountAssets Amount of assets. */ function convertToShares(uint256 _amountAssets) virtual public view returns (uint256); /** * @notice Calculates the amount of assets that the Portfolio should exchange for the amount of shares provided. * @param _amountShares Amount of shares. */ function convertToAssets(uint256 _amountShares) virtual public view returns (uint256); /** * @notice Exit out all assets of portfolio for baseToken. Must persist a mechanism for entities to redeem their shares for baseToken. * @param _data Data that the portfolio needs to exit from asset. In some cases, this will be swap parameters. * @return baseTokenOut The amount of baseToken that this exit yielded. */ function shutdown(bytes calldata _data) virtual external returns (uint256 baseTokenOut); /// @notice `transfer` disabled on Portfolio tokens. function transfer(address /** to */, uint256 /** amount */) public pure override returns (bool) { revert TransferDisallowed(); } /// @notice `transferFrom` disabled on Portfolio tokens. function transferFrom(address /** from */, address /** to */, uint256 /** amount */) public pure override returns (bool) { revert TransferDisallowed(); } /// @notice `approve` disabled on Portfolio tokens. function approve(address /** to */, uint256 /** amount */) public pure override returns (bool) { revert TransferDisallowed(); } /// @notice `permit` disabled on Portfolio tokens. function permit( address /* owner */, address /* spender */, uint256 /* value */, uint256 /* deadline */, uint8 /* v */, bytes32 /* r */, bytes32 /* s */ ) public pure override { revert TransferDisallowed(); } /** * @notice Permissioned method that allows Endaoment admin to make arbitrary calls acting as this Portfolio. * @param _target The address to which the call will be made. * @param _value The ETH value that should be forwarded with the call. * @param _data The calldata that will be sent with the call. * @return _return The data returned by the call. */ function callAsPortfolio( address _target, uint256 _value, bytes memory _data ) external payable requiresAuth returns (bytes memory) { (bool _success, bytes memory _response) = payable(_target).call{value: _value}(_data); if (!_success) revert CallFailed(_response); return _response; } /// @dev Internal helper method to calculate the fee on a base token amount for a given fee multiplier. function _calculateFee( uint256 _amount, uint256 _feeMultiplier ) internal pure returns (uint256 _netAmount, uint256 _fee) { if (_feeMultiplier > Math.ZOC) revert PercentageOver100(); unchecked { // unchecked as no possibility of overflow with baseToken precision _fee = _amount.zocmul(_feeMultiplier); // unchecked as the _feeMultiplier check with revert above protects against overflow _netAmount = _amount - _fee; } } } //SPDX-License-Identifier: BSD 3-Clause pragma solidity 0.8.13; import { Math } from "./lib/Math.sol"; import { ERC20 } from "solmate/tokens/ERC20.sol"; import { Auth, Authority } from "./lib/auth/Auth.sol"; import { SafeTransferLib } from "solmate/utils/SafeTransferLib.sol"; import { RegistryAuth } from "./RegistryAuth.sol"; import { Entity } from "./Entity.sol"; import { ISwapWrapper } from "./interfaces/ISwapWrapper.sol"; import { Portfolio } from "./Portfolio.sol"; // --- Errors --- error Unauthorized(); error UnsupportedSwapper(); /** * @notice Registry entity - manages Factory and Entity state info. */ contract Registry is RegistryAuth { // --- Storage --- /// @notice Treasury address can receives fees. address public treasury; /// @notice Base Token address is the stable coin contract used throughout the system. ERC20 public immutable baseToken; /// @notice Mapping of approved factory contracts that are allowed to register new Entities. mapping (address => bool) public isApprovedFactory; /// @notice Mapping of active status of entities. mapping (Entity => bool) public isActiveEntity; /// @notice Maps entity type to donation fee percentage stored as a zoc, where type(uint32).max represents 0. mapping (uint8 => uint32) defaultDonationFee; /// @notice Maps specific entity receiver to donation fee percentage stored as a zoc. mapping (Entity => uint32) donationFeeReceiverOverride; /// @notice Maps entity type to payout fee percentage stored as a zoc, where type(uint32).max represents 0. mapping (uint8 => uint32) defaultPayoutFee; /// @notice Maps specific entity sender to payout fee percentage stored as a zoc. mapping (Entity => uint32) payoutFeeOverride; /// @notice Maps sender entity type to receiver entity type to fee percentage as a zoc. mapping (uint8 => mapping(uint8 => uint32)) defaultTransferFee; /// @notice Maps specific entity sender to receiver entity type to fee percentage as a zoc. mapping (Entity => mapping(uint8 => uint32)) transferFeeSenderOverride; /// @notice Maps sender entity type to specific entity receiver to fee percentage as a zoc. mapping (uint8 => mapping(Entity => uint32)) transferFeeReceiverOverride; /// @notice Maps swap wrappers to their enabled/disabled status. mapping (ISwapWrapper => bool) public isSwapperSupported; /// @notice Maps portfolios to their enabled/disabled status. mapping (Portfolio => bool) public isActivePortfolio; // --- Events --- /// @notice The event emitted when a factory is approved (whitelisted) or has it's approval removed. event FactoryApprovalSet(address indexed factory, bool isApproved); /// @notice The event emitted when an entity is set active or inactive. event EntityStatusSet(address indexed entity, bool isActive); /// @notice The event emitted when a swap wrapper is set active or inactive. event SwapWrapperStatusSet(address indexed swapWrapper, bool isSupported); /// @notice The event emitted when a portfolio is set active or inactive. event PortfolioStatusSet(address indexed portfolio, bool isActive); /// @notice Emitted when a default donation fee is set for an entity type. event DefaultDonationFeeSet(uint8 indexed entityType, uint32 fee); /// @notice Emitted when a donation fee override is set for a specific receiving entity. event DonationFeeReceiverOverrideSet(address indexed entity, uint32 fee); /// @notice Emitted when a default payout fee is set for an entity type. event DefaultPayoutFeeSet(uint8 indexed entityType, uint32 fee); /// @notice Emitted when a payout fee override is set for a specific sender entity. event PayoutFeeOverrideSet(address indexed entity, uint32 fee); /// @notice Emitted when a default transfer fee is set for transfers between entity types. event DefaultTransferFeeSet(uint8 indexed fromEntityType, uint8 indexed toEntityType, uint32 fee); /// @notice Emitted when a transfer fee override is set for transfers from an entity to a specific entityType. event TransferFeeSenderOverrideSet(address indexed fromEntity, uint8 indexed toEntityType, uint32 fee); /// @notice Emitted when a transfer fee override is set for transfers from an entityType to an entity. event TransferFeeReceiverOverrideSet(uint8 indexed fromEntityType, address indexed toEntity, uint32 fee); /// @notice Emitted when the registry treasury contract is changed event TreasuryChanged(address oldTreasury, address indexed newTreasury); /** * @notice Modifier for methods that require auth and that the manager cannot access. * @dev Overridden from Auth.sol. Reason: use custom error. */ modifier requiresAuth override { if(!isAuthorized(msg.sender, msg.sig)) revert Unauthorized(); _; } // --- Constructor --- constructor(address _admin, address _treasury, ERC20 _baseToken) RegistryAuth(_admin, Authority(address(this))) { treasury = _treasury; emit TreasuryChanged(address(0), _treasury); baseToken = _baseToken; } // --- Internal fns --- /** * @notice Fee parsing to convert the special "type(uint32).max" value to zero, and zero to the "max". * @dev After converting, "type(uint32).max" will cause overflow/revert when used as a fee percentage multiplier and zero will mean no fee. * @param _value The value to be converted. * @return The parsed fee to use. */ function _parseFeeWithFlip(uint32 _value) private pure returns (uint32) { if (_value == 0) { return type(uint32).max; } else if (_value == type(uint32).max) { return 0; } else { return _value; } } // --- External fns --- /** * @notice Sets a new Endaoment treasury address. * @param _newTreasury The new treasury. */ function setTreasury(address _newTreasury) external requiresAuth { emit TreasuryChanged(treasury, _newTreasury); treasury = _newTreasury; } /** * @notice Sets the approval state of a factory. Grants the factory permissions to set entity status. * @param _factory The factory whose approval state is to be updated. * @param _isApproved True if the factory should be approved, false otherwise. */ function setFactoryApproval(address _factory, bool _isApproved) external requiresAuth { isApprovedFactory[_factory] = _isApproved; emit FactoryApprovalSet(address(_factory), _isApproved); } /** * @notice Sets the enable/disable state of an Entity. * @param _entity The entity whose active state is to be updated. * @param _isActive True if the entity should be active, false otherwise. */ function setEntityStatus(Entity _entity, bool _isActive) external requiresAuth { isActiveEntity[_entity] = _isActive; emit EntityStatusSet(address(_entity), _isActive); } /** * @notice Sets Entity as active. This is a special method to be called only by approved factories. * Other callers should use `setEntityStatus` instead. * @param _entity The entity. */ function setEntityActive(Entity _entity) external { if(!isApprovedFactory[msg.sender]) revert Unauthorized(); isActiveEntity[_entity] = true; emit EntityStatusSet(address(_entity), true); } /** * @notice Sets the enable/disable state of a Portfolio. * @param _portfolio Portfolio. * @param _isActive True if setting portfolio to active, false otherwise. */ function setPortfolioStatus(Portfolio _portfolio, bool _isActive) external requiresAuth { isActivePortfolio[_portfolio] = _isActive; emit PortfolioStatusSet(address(_portfolio), _isActive); } /** * @notice Gets default donation fee pct (as a zoc) for an Entity. * @param _entity The receiving entity of the donation for which the fee is being fetched. * @return uint32 The default donation fee for the entity's type. * @dev Makes use of _parseFeeWithFlip, so if no default exists, "max" will be returned. */ function getDonationFee(Entity _entity) external view returns (uint32) { return _parseFeeWithFlip(defaultDonationFee[_entity.entityType()]); } /** * @notice Gets lowest possible donation fee pct (as a zoc) for an Entity, among default and override. * @param _entity The receiving entity of the donation for which the fee is being fetched. * @return uint32 The minimum of the default donation fee and the receiver's fee override. * @dev Makes use of _parseFeeWithFlip, so if no default or override exists, "max" will be returned. */ function getDonationFeeWithOverrides(Entity _entity) external view returns (uint32) { uint32 _default = _parseFeeWithFlip(defaultDonationFee[_entity.entityType()]); uint32 _receiverOverride = _parseFeeWithFlip(donationFeeReceiverOverride[_entity]); return _receiverOverride < _default ? _receiverOverride : _default; } /** * @notice Gets default payout fee pct (as a zoc) for an Entity. * @param _entity The sender entity of the payout for which the fee is being fetched. * @return uint32 The default payout fee for the entity's type. * @dev Makes use of _parseFeeWithFlip, so if no default exists, "max" will be returned. */ function getPayoutFee(Entity _entity) external view returns (uint32) { return _parseFeeWithFlip(defaultPayoutFee[_entity.entityType()]); } /** * @notice Gets lowest possible payout fee pct (as a zoc) for an Entity, among default and override. * @param _entity The sender entity of the payout for which the fee is being fetched. * @return uint32 The minimum of the default payout fee and the sender's fee override. * @dev Makes use of _parseFeeWithFlip, so if no default or override exists, "max" will be returned. */ function getPayoutFeeWithOverrides(Entity _entity) external view returns (uint32) { uint32 _default = _parseFeeWithFlip(defaultPayoutFee[_entity.entityType()]); uint32 _senderOverride = _parseFeeWithFlip(payoutFeeOverride[_entity]); return _senderOverride < _default ? _senderOverride : _default; } /** * @notice Gets default transfer fee pct (as a zoc) between sender & receiver Entities. * @param _sender The sending entity of the transfer for which the fee is being fetched. * @param _receiver The receiving entity of the transfer for which the fee is being fetched. * @return uint32 The default transfer fee. * @dev Makes use of _parseFeeWithFlip, so if no default exists, "type(uint32).max" will be returned. */ function getTransferFee(Entity _sender, Entity _receiver) external view returns (uint32) { return _parseFeeWithFlip(defaultTransferFee[_sender.entityType()][_receiver.entityType()]); } /** * @notice Gets lowest possible transfer fee pct (as a zoc) between sender & receiver Entities, among default and overrides. * @param _sender The sending entity of the transfer for which the fee is being fetched. * @param _receiver The receiving entity of the transfer for which the fee is being fetched. * @return uint32 The minimum of the default transfer fee, and sender and receiver overrides. * @dev Makes use of _parseFeeWithFlip, so if no default or overrides exist, "type(uint32).max" will be returned. */ function getTransferFeeWithOverrides(Entity _sender, Entity _receiver) external view returns (uint32) { uint32 _default = _parseFeeWithFlip(defaultTransferFee[_sender.entityType()][_receiver.entityType()]); uint32 _senderOverride = _parseFeeWithFlip(transferFeeSenderOverride[_sender][_receiver.entityType()]); uint32 _receiverOverride = _parseFeeWithFlip(transferFeeReceiverOverride[_sender.entityType()][_receiver]); uint32 _lowestFee = _default; _lowestFee = _senderOverride < _lowestFee ? _senderOverride : _lowestFee; _lowestFee = _receiverOverride < _lowestFee ? _receiverOverride : _lowestFee; return _lowestFee; } /** * @notice Sets the default donation fee for an entity type. * @param _entityType Entity type. * @param _fee The fee percentage to be set (a zoc). */ function setDefaultDonationFee(uint8 _entityType, uint32 _fee) external requiresAuth { defaultDonationFee[_entityType] = _parseFeeWithFlip(_fee); emit DefaultDonationFeeSet(_entityType, _fee); } /** * @notice Sets the donation fee receiver override for a specific entity. * @param _entity Entity. * @param _fee The overriding fee (a zoc). */ function setDonationFeeReceiverOverride(Entity _entity, uint32 _fee) external requiresAuth { donationFeeReceiverOverride[_entity] = _parseFeeWithFlip(_fee); emit DonationFeeReceiverOverrideSet(address(_entity), _fee); } /** * @notice Sets the default payout fee for an entity type. * @param _entityType Entity type. * @param _fee The fee percentage to be set (a zoc). */ function setDefaultPayoutFee(uint8 _entityType, uint32 _fee) external requiresAuth { defaultPayoutFee[_entityType] = _parseFeeWithFlip(_fee); emit DefaultPayoutFeeSet(_entityType, _fee); } /** * @notice Sets the payout fee override for a specific entity. * @param _entity Entity. * @param _fee The overriding fee (a zoc). */ function setPayoutFeeOverride(Entity _entity, uint32 _fee) external requiresAuth { payoutFeeOverride[_entity] = _parseFeeWithFlip(_fee); emit PayoutFeeOverrideSet(address(_entity), _fee); } /** * @notice Sets the default transfer fee for transfers from one specific entity type to another. * @param _fromEntityType The entityType making the transfer. * @param _toEntityType The receiving entityType. * @param _fee The transfer fee percentage (a zoc). */ function setDefaultTransferFee(uint8 _fromEntityType, uint8 _toEntityType, uint32 _fee) external requiresAuth { defaultTransferFee[_fromEntityType][_toEntityType] = _parseFeeWithFlip(_fee); emit DefaultTransferFeeSet(_fromEntityType, _toEntityType, _fee); } /** * @notice Sets the transfer fee override for transfers from one specific entity to entities of a given type. * @param _fromEntity The entity making the transfer. * @param _toEntityType The receiving entityType. * @param _fee The overriding fee percentage (a zoc). */ function setTransferFeeSenderOverride(Entity _fromEntity, uint8 _toEntityType, uint32 _fee) external requiresAuth { transferFeeSenderOverride[_fromEntity][_toEntityType] = _parseFeeWithFlip(_fee); emit TransferFeeSenderOverrideSet(address(_fromEntity), _toEntityType, _fee); } /** * @notice Sets the transfer fee override for transfers from entities of a given type to a specific entity. * @param _fromEntityType The entityType making the transfer. * @param _toEntity The receiving entity. * @param _fee The overriding fee percentage (a zoc). */ function setTransferFeeReceiverOverride(uint8 _fromEntityType, Entity _toEntity, uint32 _fee) external requiresAuth { transferFeeReceiverOverride[_fromEntityType][_toEntity] = _parseFeeWithFlip(_fee); emit TransferFeeReceiverOverrideSet(_fromEntityType, address(_toEntity), _fee); } /** * @notice Sets the enable/disable state of a SwapWrapper. System owners must ensure meticulous review of SwapWrappers before approving them. * @param _swapWrapper A contract that implements ISwapWrapper. * @param _supported `true` if supported, `false` if unsupported. */ function setSwapWrapperStatus(ISwapWrapper _swapWrapper, bool _supported) external requiresAuth { isSwapperSupported[_swapWrapper] = _supported; emit SwapWrapperStatusSet(address(_swapWrapper), _supported); } } //SPDX-License-Identifier: BSD 3-Clause pragma solidity 0.8.13; import { Auth, Authority } from "./lib/auth/Auth.sol"; import { RolesAuthority } from "./lib/auth/authorities/RolesAuthority.sol"; // --- Errors --- error OwnershipInvalid(); /** * @notice RegistryAuth - contract to control ownership of the Registry. */ contract RegistryAuth is RolesAuthority { /// @notice Emitted when the first step of an ownership transfer (proposal) is done. event OwnershipTransferProposed(address indexed user, address indexed newOwner); /// @notice Emitted when the second step of an ownership transfer (claim) is done. event OwnershipChanged(address indexed owner, address indexed newOwner); // --- Storage --- /// @notice Pending owner for 2 step ownership transfer address public pendingOwner; // --- Constructor --- constructor(address _owner, Authority _authority) RolesAuthority(_owner, _authority) {} /** * @notice Starts the 2 step process of transferring registry authorization to a new owner. * @param _newOwner Proposed new owner of registry authorization. */ function transferOwnership(address _newOwner) external requiresAuth { pendingOwner = _newOwner; emit OwnershipTransferProposed(msg.sender, _newOwner); } /** * @notice Completes the 2 step process of transferring registry authorization to a new owner. * This function must be called by the proposed new owner. */ function claimOwnership() external { if (msg.sender != pendingOwner) revert OwnershipInvalid(); emit OwnershipChanged(owner, pendingOwner); owner = pendingOwner; pendingOwner = address(0); } /** * @notice Old approach of setting a new owner in a single step. * @dev This function throws an error to force use of the new 2-step approach. */ function setOwner(address /*newOwner*/ ) public view override requiresAuth { revert OwnershipInvalid(); } } //SPDX-License-Identifier: BSD 3-Clause pragma solidity >=0.8.0; error ETHAmountInMismatch(); /** * @notice ISwapWrapper is the interface that all swap wrappers should implement. * This will be used to support swap protocols like Uniswap V2 and V3, Sushiswap, 1inch, etc. */ interface ISwapWrapper { /// @notice Event emitted after a successful swap. event WrapperSwapExecuted(address indexed tokenIn, address indexed tokenOut, address sender, address indexed recipient, uint256 amountIn, uint256 amountOut); /// @notice Name of swap wrapper for UX readability. function name() external returns (string memory); /** * @notice Swap function. Generally we expect the implementer to call some exactAmountIn-like swap method, and so the documentation * is written with this in mind. However, the method signature is general enough to support exactAmountOut swaps as well. * @param _tokenIn Token to be swapped (or 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE for ETH). * @param _tokenOut Token to receive (or 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE for ETH). * @param _recipient Receiver of `_tokenOut`. * @param _amount Amount of `_tokenIn` that should be swapped. * @param _data Additional data that the swap wrapper may require to execute the swap. * @return Amount of _tokenOut received. */ function swap(address _tokenIn, address _tokenOut, address _recipient, uint256 _amount, bytes calldata _data) external payable returns (uint256); } // SPDX-License-Identifier: BSD 3-Clause pragma solidity 0.8.13; library Math { uint256 internal constant ZOC = 1e4; /** * @dev Multiply 2 numbers where at least one is a zoc, return product in original units of the other number. */ function zocmul(uint256 x, uint256 y) internal pure returns (uint256 z) { z = x * y; unchecked { z /= ZOC; } } // Below is WAD math from solmate's FixedPointMathLib. // https://github.com/Rari-Capital/solmate/blob/c8278b3cb948cffda3f1de5a401858035f262060/src/utils/FixedPointMathLib.sol uint256 internal constant WAD = 1e18; // The scalar of ETH and most ERC20s. function mulWadDown(uint256 x, uint256 y) internal pure returns (uint256) { return mulDivDown(x, y, WAD); // Equivalent to (x * y) / WAD rounded down. } function divWadDown(uint256 x, uint256 y) internal pure returns (uint256) { return mulDivDown(x, WAD, y); // Equivalent to (x * WAD) / y rounded down. } // For tokens with 6 decimals like USDC, these scale by 1e6 (one million). function mulMilDown(uint256 x, uint256 y) internal pure returns (uint256) { return mulDivDown(x, y, 1e6); // Equivalent to (x * y) / 1e6 rounded down. } function divMilDown(uint256 x, uint256 y) internal pure returns (uint256) { return mulDivDown(x, 1e6, y); // Equivalent to (x * 1e6) / y rounded down. } /*////////////////////////////////////////////////////////////// LOW LEVEL FIXED POINT OPERATIONS //////////////////////////////////////////////////////////////*/ function mulDivDown( uint256 x, uint256 y, uint256 denominator ) internal pure returns (uint256 z) { assembly { // Store x * y in z for now. z := mul(x, y) // Equivalent to require(denominator != 0 && (x == 0 || (x * y) / x == y)) if iszero(and(iszero(iszero(denominator)), or(iszero(x), eq(div(z, x), y)))) { revert(0, 0) } // Divide z by the denominator. z := div(z, denominator) } } } // SPDX-License-Identifier: AGPL-3.0-only pragma solidity >=0.8.0; /// @notice Gas optimized reentrancy protection for smart contracts. /// @author Modified Solmate (https://github.com/Rari-Capital/solmate/blob/main/src/utils/ReentrancyGuard.sol) /// @author Modified from OpenZeppelin (https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/contracts/security/ReentrancyGuard.sol) abstract contract ReentrancyGuard { uint256 private reentrancyStatus; error Reentrancy(); function __initReentrancyGuard() internal { if(reentrancyStatus != 0) revert Reentrancy(); reentrancyStatus = 1; } modifier nonReentrant() { if(reentrancyStatus != 1) revert Reentrancy(); reentrancyStatus = 2; _; reentrancyStatus = 1; } } // SPDX-License-Identifier: AGPL-3.0-only pragma solidity >=0.8.0; // This contract is modified from Solmate only to make requiresAuth virtual on line 26 /// @notice Provides a flexible and updatable auth pattern which is completely separate from application logic. /// @author Solmate (https://github.com/Rari-Capital/solmate/blob/main/src/auth/Auth.sol) /// @author Modified from Dappsys (https://github.com/dapphub/ds-auth/blob/master/src/auth.sol) abstract contract Auth { event OwnerUpdated(address indexed user, address indexed newOwner); event AuthorityUpdated(address indexed user, Authority indexed newAuthority); address public owner; Authority public authority; constructor(address _owner, Authority _authority) { owner = _owner; authority = _authority; emit OwnerUpdated(msg.sender, _owner); emit AuthorityUpdated(msg.sender, _authority); } modifier requiresAuth virtual { require(isAuthorized(msg.sender, msg.sig), "UNAUTHORIZED"); _; } function isAuthorized(address user, bytes4 functionSig) internal view virtual returns (bool) { Authority auth = authority; // Memoizing authority saves us a warm SLOAD, around 100 gas. // Checking if the caller is the owner only after calling the authority saves gas in most cases, but be // aware that this makes protected functions uncallable even to the owner if the authority is out of order. return (address(auth) != address(0) && auth.canCall(user, address(this), functionSig)) || user == owner; } function setAuthority(Authority newAuthority) public virtual { // We check if the caller is the owner first because we want to ensure they can // always swap out the authority even if it's reverting or using up a lot of gas. require(msg.sender == owner || authority.canCall(msg.sender, address(this), msg.sig)); authority = newAuthority; emit AuthorityUpdated(msg.sender, newAuthority); } function setOwner(address newOwner) public virtual requiresAuth { owner = newOwner; emit OwnerUpdated(msg.sender, newOwner); } } /// @notice A generic interface for a contract which provides authorization data to an Auth instance. /// @author Solmate (https://github.com/Rari-Capital/solmate/blob/main/src/auth/Auth.sol) /// @author Modified from Dappsys (https://github.com/dapphub/ds-auth/blob/master/src/auth.sol) interface Authority { function canCall( address user, address target, bytes4 functionSig ) external view returns (bool); } // SPDX-License-Identifier: AGPL-3.0-only pragma solidity >=0.8.0; import { RolesAuthority } from './authorities/RolesAuthority.sol'; /** * @notice An abstract Auth that contracts in the Endaoment ecosystem can inherit from. It is based on * the `Auth.sol` contract from Solmate, but does not inherit from it. Most of the functionality * is either slightly different, or not needed. In particular: * - EndaomentAuth uses an initializer such that it can be deployed with minimal proxies. * - EndaomentAuth contracts reference a RolesAuthority, not just an Authority, when looking up permissions. * In the Endaoment ecosystem, this is assumed to be the Registry. * - EndaomentAuth contracts do not have an owner, but instead grant ubiquitous permission to its RoleAuthority's * owner. In the Endaoment ecosystem, this is assumed to be the board of directors multi-sig. * - EndaomentAuth contracts can optionally declare themselves a "special target" at deploy time. Instead of passing * their address to the authority when looking up their permissions, they'll instead pass the special target bytes. * See documentation on `specialTarget` for more information. * */ abstract contract EndaomentAuth { /// @notice Thrown when an account without proper permissions calls a privileged method. error Unauthorized(); /// @notice Thrown if there is an attempt to deploy with address 0 as the authority. error InvalidAuthority(); /// @notice Thrown if there is a second call to initialize. error AlreadyInitialized(); /// @notice The contract used to source permissions for accounts targeting this contract. RolesAuthority public authority; /** * @notice If set to a non-zero value, this contract will pass these byes as the target contract * to the RolesAuthority's `canCall` method, rather than its own contract. This allows a single * RolesAuthority permission to manage permissions simultaneously for a group of contracts that * identify themselves as a certain type. For example: set a permission for all "entity" contracts. */ bytes20 public specialTarget; /** * @notice One time method to be called at deployment to configure the contract. Required so EndaomentAuth * contracts can be deployed as minimal proxies (clones). * @param _authority Contract that will be used to source permissions for accounts targeting this contract. * @param _specialTarget The bytes that this contract will pass as the "target" when looking up permissions * from the authority. If set to empty bytes, this contract will pass its own address instead. */ function __initEndaomentAuth(RolesAuthority _authority, bytes20 _specialTarget) internal virtual { if (address(_authority) == address(0)) revert InvalidAuthority(); if (address(authority) != address(0)) revert AlreadyInitialized(); authority = _authority; specialTarget = _specialTarget; } /** * @notice Modifier for methods that require authorization to execute. */ modifier requiresAuth virtual { if(!isAuthorized(msg.sender, msg.sig)) revert Unauthorized(); _; } /** * @notice Internal method that asks the authority whether the caller has permission to execute a method. * @param user The account attempting to call a permissioned method on this contract * @param functionSig The signature hash of the permissioned method being invoked. */ function isAuthorized(address user, bytes4 functionSig) internal virtual view returns (bool) { RolesAuthority auth = authority; // Memoizing authority saves us a warm SLOAD, around 100 gas. address _target = specialTarget == "" ? address(this) : address(specialTarget); // The caller has permission on authority, or the caller is the RolesAuthority owner return auth.canCall(user, _target, functionSig) || user == auth.owner(); } } // SPDX-License-Identifier: AGPL-3.0-only pragma solidity >=0.8.0; // This contract is modified from Solmate only to import modified Auth.sol on line 5 import {Auth, Authority} from "../Auth.sol"; /// @notice Role based Authority that supports up to 256 roles. /// @author Solmate (https://github.com/Rari-Capital/solmate/blob/main/src/auth/authorities/RolesAuthority.sol) /// @author Modified from Dappsys (https://github.com/dapphub/ds-roles/blob/master/src/roles.sol) contract RolesAuthority is Auth, Authority { /*/////////////////////////////////////////////////////////////// EVENTS //////////////////////////////////////////////////////////////*/ event UserRoleUpdated(address indexed user, uint8 indexed role, bool enabled); event PublicCapabilityUpdated(address indexed target, bytes4 indexed functionSig, bool enabled); event RoleCapabilityUpdated(uint8 indexed role, address indexed target, bytes4 indexed functionSig, bool enabled); /*/////////////////////////////////////////////////////////////// CONSTRUCTOR //////////////////////////////////////////////////////////////*/ constructor(address _owner, Authority _authority) Auth(_owner, _authority) {} /*/////////////////////////////////////////////////////////////// ROLE/USER STORAGE //////////////////////////////////////////////////////////////*/ mapping(address => bytes32) public getUserRoles; mapping(address => mapping(bytes4 => bool)) public isCapabilityPublic; mapping(address => mapping(bytes4 => bytes32)) public getRolesWithCapability; function doesUserHaveRole(address user, uint8 role) public view virtual returns (bool) { return (uint256(getUserRoles[user]) >> role) & 1 != 0; } function doesRoleHaveCapability( uint8 role, address target, bytes4 functionSig ) public view virtual returns (bool) { return (uint256(getRolesWithCapability[target][functionSig]) >> role) & 1 != 0; } /*/////////////////////////////////////////////////////////////// AUTHORIZATION LOGIC //////////////////////////////////////////////////////////////*/ function canCall( address user, address target, bytes4 functionSig ) public view virtual override returns (bool) { return isCapabilityPublic[target][functionSig] || bytes32(0) != getUserRoles[user] & getRolesWithCapability[target][functionSig]; } /*/////////////////////////////////////////////////////////////// ROLE CAPABILITY CONFIGURATION LOGIC //////////////////////////////////////////////////////////////*/ function setPublicCapability( address target, bytes4 functionSig, bool enabled ) public virtual requiresAuth { isCapabilityPublic[target][functionSig] = enabled; emit PublicCapabilityUpdated(target, functionSig, enabled); } function setRoleCapability( uint8 role, address target, bytes4 functionSig, bool enabled ) public virtual requiresAuth { if (enabled) { getRolesWithCapability[target][functionSig] |= bytes32(1 << role); } else { getRolesWithCapability[target][functionSig] &= ~bytes32(1 << role); } emit RoleCapabilityUpdated(role, target, functionSig, enabled); } /*/////////////////////////////////////////////////////////////// USER ROLE ASSIGNMENT LOGIC //////////////////////////////////////////////////////////////*/ function setUserRole( address user, uint8 role, bool enabled ) public virtual requiresAuth { if (enabled) { getUserRoles[user] |= bytes32(1 << role); } else { getUserRoles[user] &= ~bytes32(1 << role); } emit UserRoleUpdated(user, role, enabled); } }
File 6 of 9: Registry
//SPDX-License-Identifier: BSD 3-Clause pragma solidity 0.8.13; import { Math } from "./lib/Math.sol"; import { ERC20 } from "solmate/tokens/ERC20.sol"; import { Auth, Authority } from "./lib/auth/Auth.sol"; import { SafeTransferLib } from "solmate/utils/SafeTransferLib.sol"; import { RegistryAuth } from "./RegistryAuth.sol"; import { Entity } from "./Entity.sol"; import { ISwapWrapper } from "./interfaces/ISwapWrapper.sol"; import { Portfolio } from "./Portfolio.sol"; // --- Errors --- error Unauthorized(); error UnsupportedSwapper(); /** * @notice Registry entity - manages Factory and Entity state info. */ contract Registry is RegistryAuth { // --- Storage --- /// @notice Treasury address can receives fees. address public treasury; /// @notice Base Token address is the stable coin contract used throughout the system. ERC20 public immutable baseToken; /// @notice Mapping of approved factory contracts that are allowed to register new Entities. mapping (address => bool) public isApprovedFactory; /// @notice Mapping of active status of entities. mapping (Entity => bool) public isActiveEntity; /// @notice Maps entity type to donation fee percentage stored as a zoc, where type(uint32).max represents 0. mapping (uint8 => uint32) defaultDonationFee; /// @notice Maps specific entity receiver to donation fee percentage stored as a zoc. mapping (Entity => uint32) donationFeeReceiverOverride; /// @notice Maps entity type to payout fee percentage stored as a zoc, where type(uint32).max represents 0. mapping (uint8 => uint32) defaultPayoutFee; /// @notice Maps specific entity sender to payout fee percentage stored as a zoc. mapping (Entity => uint32) payoutFeeOverride; /// @notice Maps sender entity type to receiver entity type to fee percentage as a zoc. mapping (uint8 => mapping(uint8 => uint32)) defaultTransferFee; /// @notice Maps specific entity sender to receiver entity type to fee percentage as a zoc. mapping (Entity => mapping(uint8 => uint32)) transferFeeSenderOverride; /// @notice Maps sender entity type to specific entity receiver to fee percentage as a zoc. mapping (uint8 => mapping(Entity => uint32)) transferFeeReceiverOverride; /// @notice Maps swap wrappers to their enabled/disabled status. mapping (ISwapWrapper => bool) public isSwapperSupported; /// @notice Maps portfolios to their enabled/disabled status. mapping (Portfolio => bool) public isActivePortfolio; // --- Events --- /// @notice The event emitted when a factory is approved (whitelisted) or has it's approval removed. event FactoryApprovalSet(address indexed factory, bool isApproved); /// @notice The event emitted when an entity is set active or inactive. event EntityStatusSet(address indexed entity, bool isActive); /// @notice The event emitted when a swap wrapper is set active or inactive. event SwapWrapperStatusSet(address indexed swapWrapper, bool isSupported); /// @notice The event emitted when a portfolio is set active or inactive. event PortfolioStatusSet(address indexed portfolio, bool isActive); /// @notice Emitted when a default donation fee is set for an entity type. event DefaultDonationFeeSet(uint8 indexed entityType, uint32 fee); /// @notice Emitted when a donation fee override is set for a specific receiving entity. event DonationFeeReceiverOverrideSet(address indexed entity, uint32 fee); /// @notice Emitted when a default payout fee is set for an entity type. event DefaultPayoutFeeSet(uint8 indexed entityType, uint32 fee); /// @notice Emitted when a payout fee override is set for a specific sender entity. event PayoutFeeOverrideSet(address indexed entity, uint32 fee); /// @notice Emitted when a default transfer fee is set for transfers between entity types. event DefaultTransferFeeSet(uint8 indexed fromEntityType, uint8 indexed toEntityType, uint32 fee); /// @notice Emitted when a transfer fee override is set for transfers from an entity to a specific entityType. event TransferFeeSenderOverrideSet(address indexed fromEntity, uint8 indexed toEntityType, uint32 fee); /// @notice Emitted when a transfer fee override is set for transfers from an entityType to an entity. event TransferFeeReceiverOverrideSet(uint8 indexed fromEntityType, address indexed toEntity, uint32 fee); /// @notice Emitted when the registry treasury contract is changed event TreasuryChanged(address oldTreasury, address indexed newTreasury); /** * @notice Modifier for methods that require auth and that the manager cannot access. * @dev Overridden from Auth.sol. Reason: use custom error. */ modifier requiresAuth override { if(!isAuthorized(msg.sender, msg.sig)) revert Unauthorized(); _; } // --- Constructor --- constructor(address _admin, address _treasury, ERC20 _baseToken) RegistryAuth(_admin, Authority(address(this))) { treasury = _treasury; emit TreasuryChanged(address(0), _treasury); baseToken = _baseToken; } // --- Internal fns --- /** * @notice Fee parsing to convert the special "type(uint32).max" value to zero, and zero to the "max". * @dev After converting, "type(uint32).max" will cause overflow/revert when used as a fee percentage multiplier and zero will mean no fee. * @param _value The value to be converted. * @return The parsed fee to use. */ function _parseFeeWithFlip(uint32 _value) private pure returns (uint32) { if (_value == 0) { return type(uint32).max; } else if (_value == type(uint32).max) { return 0; } else { return _value; } } // --- External fns --- /** * @notice Sets a new Endaoment treasury address. * @param _newTreasury The new treasury. */ function setTreasury(address _newTreasury) external requiresAuth { emit TreasuryChanged(treasury, _newTreasury); treasury = _newTreasury; } /** * @notice Sets the approval state of a factory. Grants the factory permissions to set entity status. * @param _factory The factory whose approval state is to be updated. * @param _isApproved True if the factory should be approved, false otherwise. */ function setFactoryApproval(address _factory, bool _isApproved) external requiresAuth { isApprovedFactory[_factory] = _isApproved; emit FactoryApprovalSet(address(_factory), _isApproved); } /** * @notice Sets the enable/disable state of an Entity. * @param _entity The entity whose active state is to be updated. * @param _isActive True if the entity should be active, false otherwise. */ function setEntityStatus(Entity _entity, bool _isActive) external requiresAuth { isActiveEntity[_entity] = _isActive; emit EntityStatusSet(address(_entity), _isActive); } /** * @notice Sets Entity as active. This is a special method to be called only by approved factories. * Other callers should use `setEntityStatus` instead. * @param _entity The entity. */ function setEntityActive(Entity _entity) external { if(!isApprovedFactory[msg.sender]) revert Unauthorized(); isActiveEntity[_entity] = true; emit EntityStatusSet(address(_entity), true); } /** * @notice Sets the enable/disable state of a Portfolio. * @param _portfolio Portfolio. * @param _isActive True if setting portfolio to active, false otherwise. */ function setPortfolioStatus(Portfolio _portfolio, bool _isActive) external requiresAuth { isActivePortfolio[_portfolio] = _isActive; emit PortfolioStatusSet(address(_portfolio), _isActive); } /** * @notice Gets default donation fee pct (as a zoc) for an Entity. * @param _entity The receiving entity of the donation for which the fee is being fetched. * @return uint32 The default donation fee for the entity's type. * @dev Makes use of _parseFeeWithFlip, so if no default exists, "max" will be returned. */ function getDonationFee(Entity _entity) external view returns (uint32) { return _parseFeeWithFlip(defaultDonationFee[_entity.entityType()]); } /** * @notice Gets lowest possible donation fee pct (as a zoc) for an Entity, among default and override. * @param _entity The receiving entity of the donation for which the fee is being fetched. * @return uint32 The minimum of the default donation fee and the receiver's fee override. * @dev Makes use of _parseFeeWithFlip, so if no default or override exists, "max" will be returned. */ function getDonationFeeWithOverrides(Entity _entity) external view returns (uint32) { uint32 _default = _parseFeeWithFlip(defaultDonationFee[_entity.entityType()]); uint32 _receiverOverride = _parseFeeWithFlip(donationFeeReceiverOverride[_entity]); return _receiverOverride < _default ? _receiverOverride : _default; } /** * @notice Gets default payout fee pct (as a zoc) for an Entity. * @param _entity The sender entity of the payout for which the fee is being fetched. * @return uint32 The default payout fee for the entity's type. * @dev Makes use of _parseFeeWithFlip, so if no default exists, "max" will be returned. */ function getPayoutFee(Entity _entity) external view returns (uint32) { return _parseFeeWithFlip(defaultPayoutFee[_entity.entityType()]); } /** * @notice Gets lowest possible payout fee pct (as a zoc) for an Entity, among default and override. * @param _entity The sender entity of the payout for which the fee is being fetched. * @return uint32 The minimum of the default payout fee and the sender's fee override. * @dev Makes use of _parseFeeWithFlip, so if no default or override exists, "max" will be returned. */ function getPayoutFeeWithOverrides(Entity _entity) external view returns (uint32) { uint32 _default = _parseFeeWithFlip(defaultPayoutFee[_entity.entityType()]); uint32 _senderOverride = _parseFeeWithFlip(payoutFeeOverride[_entity]); return _senderOverride < _default ? _senderOverride : _default; } /** * @notice Gets default transfer fee pct (as a zoc) between sender & receiver Entities. * @param _sender The sending entity of the transfer for which the fee is being fetched. * @param _receiver The receiving entity of the transfer for which the fee is being fetched. * @return uint32 The default transfer fee. * @dev Makes use of _parseFeeWithFlip, so if no default exists, "type(uint32).max" will be returned. */ function getTransferFee(Entity _sender, Entity _receiver) external view returns (uint32) { return _parseFeeWithFlip(defaultTransferFee[_sender.entityType()][_receiver.entityType()]); } /** * @notice Gets lowest possible transfer fee pct (as a zoc) between sender & receiver Entities, among default and overrides. * @param _sender The sending entity of the transfer for which the fee is being fetched. * @param _receiver The receiving entity of the transfer for which the fee is being fetched. * @return uint32 The minimum of the default transfer fee, and sender and receiver overrides. * @dev Makes use of _parseFeeWithFlip, so if no default or overrides exist, "type(uint32).max" will be returned. */ function getTransferFeeWithOverrides(Entity _sender, Entity _receiver) external view returns (uint32) { uint32 _default = _parseFeeWithFlip(defaultTransferFee[_sender.entityType()][_receiver.entityType()]); uint32 _senderOverride = _parseFeeWithFlip(transferFeeSenderOverride[_sender][_receiver.entityType()]); uint32 _receiverOverride = _parseFeeWithFlip(transferFeeReceiverOverride[_sender.entityType()][_receiver]); uint32 _lowestFee = _default; _lowestFee = _senderOverride < _lowestFee ? _senderOverride : _lowestFee; _lowestFee = _receiverOverride < _lowestFee ? _receiverOverride : _lowestFee; return _lowestFee; } /** * @notice Sets the default donation fee for an entity type. * @param _entityType Entity type. * @param _fee The fee percentage to be set (a zoc). */ function setDefaultDonationFee(uint8 _entityType, uint32 _fee) external requiresAuth { defaultDonationFee[_entityType] = _parseFeeWithFlip(_fee); emit DefaultDonationFeeSet(_entityType, _fee); } /** * @notice Sets the donation fee receiver override for a specific entity. * @param _entity Entity. * @param _fee The overriding fee (a zoc). */ function setDonationFeeReceiverOverride(Entity _entity, uint32 _fee) external requiresAuth { donationFeeReceiverOverride[_entity] = _parseFeeWithFlip(_fee); emit DonationFeeReceiverOverrideSet(address(_entity), _fee); } /** * @notice Sets the default payout fee for an entity type. * @param _entityType Entity type. * @param _fee The fee percentage to be set (a zoc). */ function setDefaultPayoutFee(uint8 _entityType, uint32 _fee) external requiresAuth { defaultPayoutFee[_entityType] = _parseFeeWithFlip(_fee); emit DefaultPayoutFeeSet(_entityType, _fee); } /** * @notice Sets the payout fee override for a specific entity. * @param _entity Entity. * @param _fee The overriding fee (a zoc). */ function setPayoutFeeOverride(Entity _entity, uint32 _fee) external requiresAuth { payoutFeeOverride[_entity] = _parseFeeWithFlip(_fee); emit PayoutFeeOverrideSet(address(_entity), _fee); } /** * @notice Sets the default transfer fee for transfers from one specific entity type to another. * @param _fromEntityType The entityType making the transfer. * @param _toEntityType The receiving entityType. * @param _fee The transfer fee percentage (a zoc). */ function setDefaultTransferFee(uint8 _fromEntityType, uint8 _toEntityType, uint32 _fee) external requiresAuth { defaultTransferFee[_fromEntityType][_toEntityType] = _parseFeeWithFlip(_fee); emit DefaultTransferFeeSet(_fromEntityType, _toEntityType, _fee); } /** * @notice Sets the transfer fee override for transfers from one specific entity to entities of a given type. * @param _fromEntity The entity making the transfer. * @param _toEntityType The receiving entityType. * @param _fee The overriding fee percentage (a zoc). */ function setTransferFeeSenderOverride(Entity _fromEntity, uint8 _toEntityType, uint32 _fee) external requiresAuth { transferFeeSenderOverride[_fromEntity][_toEntityType] = _parseFeeWithFlip(_fee); emit TransferFeeSenderOverrideSet(address(_fromEntity), _toEntityType, _fee); } /** * @notice Sets the transfer fee override for transfers from entities of a given type to a specific entity. * @param _fromEntityType The entityType making the transfer. * @param _toEntity The receiving entity. * @param _fee The overriding fee percentage (a zoc). */ function setTransferFeeReceiverOverride(uint8 _fromEntityType, Entity _toEntity, uint32 _fee) external requiresAuth { transferFeeReceiverOverride[_fromEntityType][_toEntity] = _parseFeeWithFlip(_fee); emit TransferFeeReceiverOverrideSet(_fromEntityType, address(_toEntity), _fee); } /** * @notice Sets the enable/disable state of a SwapWrapper. System owners must ensure meticulous review of SwapWrappers before approving them. * @param _swapWrapper A contract that implements ISwapWrapper. * @param _supported `true` if supported, `false` if unsupported. */ function setSwapWrapperStatus(ISwapWrapper _swapWrapper, bool _supported) external requiresAuth { isSwapperSupported[_swapWrapper] = _supported; emit SwapWrapperStatusSet(address(_swapWrapper), _supported); } } // SPDX-License-Identifier: BSD 3-Clause pragma solidity 0.8.13; library Math { uint256 internal constant ZOC = 1e4; /** * @dev Multiply 2 numbers where at least one is a zoc, return product in original units of the other number. */ function zocmul(uint256 x, uint256 y) internal pure returns (uint256 z) { z = x * y; unchecked { z /= ZOC; } } // Below is WAD math from solmate's FixedPointMathLib. // https://github.com/Rari-Capital/solmate/blob/c8278b3cb948cffda3f1de5a401858035f262060/src/utils/FixedPointMathLib.sol uint256 internal constant WAD = 1e18; // The scalar of ETH and most ERC20s. function mulWadDown(uint256 x, uint256 y) internal pure returns (uint256) { return mulDivDown(x, y, WAD); // Equivalent to (x * y) / WAD rounded down. } function divWadDown(uint256 x, uint256 y) internal pure returns (uint256) { return mulDivDown(x, WAD, y); // Equivalent to (x * WAD) / y rounded down. } // For tokens with 6 decimals like USDC, these scale by 1e6 (one million). function mulMilDown(uint256 x, uint256 y) internal pure returns (uint256) { return mulDivDown(x, y, 1e6); // Equivalent to (x * y) / 1e6 rounded down. } function divMilDown(uint256 x, uint256 y) internal pure returns (uint256) { return mulDivDown(x, 1e6, y); // Equivalent to (x * 1e6) / y rounded down. } /*////////////////////////////////////////////////////////////// LOW LEVEL FIXED POINT OPERATIONS //////////////////////////////////////////////////////////////*/ function mulDivDown( uint256 x, uint256 y, uint256 denominator ) internal pure returns (uint256 z) { assembly { // Store x * y in z for now. z := mul(x, y) // Equivalent to require(denominator != 0 && (x == 0 || (x * y) / x == y)) if iszero(and(iszero(iszero(denominator)), or(iszero(x), eq(div(z, x), y)))) { revert(0, 0) } // Divide z by the denominator. z := div(z, denominator) } } } // SPDX-License-Identifier: AGPL-3.0-only pragma solidity >=0.8.0; /// @notice Modern and gas efficient ERC20 + EIP-2612 implementation. /// @author Solmate (https://github.com/Rari-Capital/solmate/blob/main/src/tokens/ERC20.sol) /// @author Modified from Uniswap (https://github.com/Uniswap/uniswap-v2-core/blob/master/contracts/UniswapV2ERC20.sol) /// @dev Do not manually set balances without updating totalSupply, as the sum of all user balances must not exceed it. abstract contract ERC20 { /*/////////////////////////////////////////////////////////////// EVENTS //////////////////////////////////////////////////////////////*/ event Transfer(address indexed from, address indexed to, uint256 amount); event Approval(address indexed owner, address indexed spender, uint256 amount); /*/////////////////////////////////////////////////////////////// METADATA STORAGE //////////////////////////////////////////////////////////////*/ string public name; string public symbol; uint8 public immutable decimals; /*/////////////////////////////////////////////////////////////// ERC20 STORAGE //////////////////////////////////////////////////////////////*/ uint256 public totalSupply; mapping(address => uint256) public balanceOf; mapping(address => mapping(address => uint256)) public allowance; /*/////////////////////////////////////////////////////////////// EIP-2612 STORAGE //////////////////////////////////////////////////////////////*/ bytes32 public constant PERMIT_TYPEHASH = keccak256("Permit(address owner,address spender,uint256 value,uint256 nonce,uint256 deadline)"); uint256 internal immutable INITIAL_CHAIN_ID; bytes32 internal immutable INITIAL_DOMAIN_SEPARATOR; mapping(address => uint256) public nonces; /*/////////////////////////////////////////////////////////////// CONSTRUCTOR //////////////////////////////////////////////////////////////*/ constructor( string memory _name, string memory _symbol, uint8 _decimals ) { name = _name; symbol = _symbol; decimals = _decimals; INITIAL_CHAIN_ID = block.chainid; INITIAL_DOMAIN_SEPARATOR = computeDomainSeparator(); } /*/////////////////////////////////////////////////////////////// ERC20 LOGIC //////////////////////////////////////////////////////////////*/ function approve(address spender, uint256 amount) public virtual returns (bool) { allowance[msg.sender][spender] = amount; emit Approval(msg.sender, spender, amount); return true; } function transfer(address to, uint256 amount) public virtual returns (bool) { balanceOf[msg.sender] -= amount; // Cannot overflow because the sum of all user // balances can't exceed the max uint256 value. unchecked { balanceOf[to] += amount; } emit Transfer(msg.sender, to, amount); return true; } function transferFrom( address from, address to, uint256 amount ) public virtual returns (bool) { uint256 allowed = allowance[from][msg.sender]; // Saves gas for limited approvals. if (allowed != type(uint256).max) allowance[from][msg.sender] = allowed - amount; balanceOf[from] -= amount; // Cannot overflow because the sum of all user // balances can't exceed the max uint256 value. unchecked { balanceOf[to] += amount; } emit Transfer(from, to, amount); return true; } /*/////////////////////////////////////////////////////////////// EIP-2612 LOGIC //////////////////////////////////////////////////////////////*/ function permit( address owner, address spender, uint256 value, uint256 deadline, uint8 v, bytes32 r, bytes32 s ) public virtual { require(deadline >= block.timestamp, "PERMIT_DEADLINE_EXPIRED"); // Unchecked because the only math done is incrementing // the owner's nonce which cannot realistically overflow. unchecked { bytes32 digest = keccak256( abi.encodePacked( "\\x19\\x01", DOMAIN_SEPARATOR(), keccak256(abi.encode(PERMIT_TYPEHASH, owner, spender, value, nonces[owner]++, deadline)) ) ); address recoveredAddress = ecrecover(digest, v, r, s); require(recoveredAddress != address(0) && recoveredAddress == owner, "INVALID_SIGNER"); allowance[recoveredAddress][spender] = value; } emit Approval(owner, spender, value); } function DOMAIN_SEPARATOR() public view virtual returns (bytes32) { return block.chainid == INITIAL_CHAIN_ID ? INITIAL_DOMAIN_SEPARATOR : computeDomainSeparator(); } function computeDomainSeparator() internal view virtual returns (bytes32) { return keccak256( abi.encode( keccak256("EIP712Domain(string name,string version,uint256 chainId,address verifyingContract)"), keccak256(bytes(name)), keccak256("1"), block.chainid, address(this) ) ); } /*/////////////////////////////////////////////////////////////// INTERNAL MINT/BURN LOGIC //////////////////////////////////////////////////////////////*/ function _mint(address to, uint256 amount) internal virtual { totalSupply += amount; // Cannot overflow because the sum of all user // balances can't exceed the max uint256 value. unchecked { balanceOf[to] += amount; } emit Transfer(address(0), to, amount); } function _burn(address from, uint256 amount) internal virtual { balanceOf[from] -= amount; // Cannot underflow because a user's balance // will never be larger than the total supply. unchecked { totalSupply -= amount; } emit Transfer(from, address(0), amount); } } // SPDX-License-Identifier: AGPL-3.0-only pragma solidity >=0.8.0; // This contract is modified from Solmate only to make requiresAuth virtual on line 26 /// @notice Provides a flexible and updatable auth pattern which is completely separate from application logic. /// @author Solmate (https://github.com/Rari-Capital/solmate/blob/main/src/auth/Auth.sol) /// @author Modified from Dappsys (https://github.com/dapphub/ds-auth/blob/master/src/auth.sol) abstract contract Auth { event OwnerUpdated(address indexed user, address indexed newOwner); event AuthorityUpdated(address indexed user, Authority indexed newAuthority); address public owner; Authority public authority; constructor(address _owner, Authority _authority) { owner = _owner; authority = _authority; emit OwnerUpdated(msg.sender, _owner); emit AuthorityUpdated(msg.sender, _authority); } modifier requiresAuth virtual { require(isAuthorized(msg.sender, msg.sig), "UNAUTHORIZED"); _; } function isAuthorized(address user, bytes4 functionSig) internal view virtual returns (bool) { Authority auth = authority; // Memoizing authority saves us a warm SLOAD, around 100 gas. // Checking if the caller is the owner only after calling the authority saves gas in most cases, but be // aware that this makes protected functions uncallable even to the owner if the authority is out of order. return (address(auth) != address(0) && auth.canCall(user, address(this), functionSig)) || user == owner; } function setAuthority(Authority newAuthority) public virtual { // We check if the caller is the owner first because we want to ensure they can // always swap out the authority even if it's reverting or using up a lot of gas. require(msg.sender == owner || authority.canCall(msg.sender, address(this), msg.sig)); authority = newAuthority; emit AuthorityUpdated(msg.sender, newAuthority); } function setOwner(address newOwner) public virtual requiresAuth { owner = newOwner; emit OwnerUpdated(msg.sender, newOwner); } } /// @notice A generic interface for a contract which provides authorization data to an Auth instance. /// @author Solmate (https://github.com/Rari-Capital/solmate/blob/main/src/auth/Auth.sol) /// @author Modified from Dappsys (https://github.com/dapphub/ds-auth/blob/master/src/auth.sol) interface Authority { function canCall( address user, address target, bytes4 functionSig ) external view returns (bool); } // SPDX-License-Identifier: AGPL-3.0-only pragma solidity >=0.8.0; import {ERC20} from "../tokens/ERC20.sol"; /// @notice Safe ETH and ERC20 transfer library that gracefully handles missing return values. /// @author Solmate (https://github.com/Rari-Capital/solmate/blob/main/src/utils/SafeTransferLib.sol) /// @author Modified from Gnosis (https://github.com/gnosis/gp-v2-contracts/blob/main/src/contracts/libraries/GPv2SafeERC20.sol) /// @dev Use with caution! Some functions in this library knowingly create dirty bits at the destination of the free memory pointer. library SafeTransferLib { /*/////////////////////////////////////////////////////////////// ETH OPERATIONS //////////////////////////////////////////////////////////////*/ function safeTransferETH(address to, uint256 amount) internal { bool callStatus; assembly { // Transfer the ETH and store if it succeeded or not. callStatus := call(gas(), to, amount, 0, 0, 0, 0) } require(callStatus, "ETH_TRANSFER_FAILED"); } /*/////////////////////////////////////////////////////////////// ERC20 OPERATIONS //////////////////////////////////////////////////////////////*/ function safeTransferFrom( ERC20 token, address from, address to, uint256 amount ) internal { bool callStatus; assembly { // Get a pointer to some free memory. let freeMemoryPointer := mload(0x40) // Write the abi-encoded calldata to memory piece by piece: mstore(freeMemoryPointer, 0x23b872dd00000000000000000000000000000000000000000000000000000000) // Begin with the function selector. mstore(add(freeMemoryPointer, 4), and(from, 0xffffffffffffffffffffffffffffffffffffffff)) // Mask and append the "from" argument. mstore(add(freeMemoryPointer, 36), and(to, 0xffffffffffffffffffffffffffffffffffffffff)) // Mask and append the "to" argument. mstore(add(freeMemoryPointer, 68), amount) // Finally append the "amount" argument. No mask as it's a full 32 byte value. // Call the token and store if it succeeded or not. // We use 100 because the calldata length is 4 + 32 * 3. callStatus := call(gas(), token, 0, freeMemoryPointer, 100, 0, 0) } require(didLastOptionalReturnCallSucceed(callStatus), "TRANSFER_FROM_FAILED"); } function safeTransfer( ERC20 token, address to, uint256 amount ) internal { bool callStatus; assembly { // Get a pointer to some free memory. let freeMemoryPointer := mload(0x40) // Write the abi-encoded calldata to memory piece by piece: mstore(freeMemoryPointer, 0xa9059cbb00000000000000000000000000000000000000000000000000000000) // Begin with the function selector. mstore(add(freeMemoryPointer, 4), and(to, 0xffffffffffffffffffffffffffffffffffffffff)) // Mask and append the "to" argument. mstore(add(freeMemoryPointer, 36), amount) // Finally append the "amount" argument. No mask as it's a full 32 byte value. // Call the token and store if it succeeded or not. // We use 68 because the calldata length is 4 + 32 * 2. callStatus := call(gas(), token, 0, freeMemoryPointer, 68, 0, 0) } require(didLastOptionalReturnCallSucceed(callStatus), "TRANSFER_FAILED"); } function safeApprove( ERC20 token, address to, uint256 amount ) internal { bool callStatus; assembly { // Get a pointer to some free memory. let freeMemoryPointer := mload(0x40) // Write the abi-encoded calldata to memory piece by piece: mstore(freeMemoryPointer, 0x095ea7b300000000000000000000000000000000000000000000000000000000) // Begin with the function selector. mstore(add(freeMemoryPointer, 4), and(to, 0xffffffffffffffffffffffffffffffffffffffff)) // Mask and append the "to" argument. mstore(add(freeMemoryPointer, 36), amount) // Finally append the "amount" argument. No mask as it's a full 32 byte value. // Call the token and store if it succeeded or not. // We use 68 because the calldata length is 4 + 32 * 2. callStatus := call(gas(), token, 0, freeMemoryPointer, 68, 0, 0) } require(didLastOptionalReturnCallSucceed(callStatus), "APPROVE_FAILED"); } /*/////////////////////////////////////////////////////////////// INTERNAL HELPER LOGIC //////////////////////////////////////////////////////////////*/ function didLastOptionalReturnCallSucceed(bool callStatus) private pure returns (bool success) { assembly { // Get how many bytes the call returned. let returnDataSize := returndatasize() // If the call reverted: if iszero(callStatus) { // Copy the revert message into memory. returndatacopy(0, 0, returnDataSize) // Revert with the same message. revert(0, returnDataSize) } switch returnDataSize case 32 { // Copy the return data into memory. returndatacopy(0, 0, returnDataSize) // Set success to whether it returned true. success := iszero(iszero(mload(0))) } case 0 { // There was no return data. success := 1 } default { // It returned some malformed input. success := 0 } } } } //SPDX-License-Identifier: BSD 3-Clause pragma solidity 0.8.13; import { Auth, Authority } from "./lib/auth/Auth.sol"; import { RolesAuthority } from "./lib/auth/authorities/RolesAuthority.sol"; // --- Errors --- error OwnershipInvalid(); /** * @notice RegistryAuth - contract to control ownership of the Registry. */ contract RegistryAuth is RolesAuthority { /// @notice Emitted when the first step of an ownership transfer (proposal) is done. event OwnershipTransferProposed(address indexed user, address indexed newOwner); /// @notice Emitted when the second step of an ownership transfer (claim) is done. event OwnershipChanged(address indexed owner, address indexed newOwner); // --- Storage --- /// @notice Pending owner for 2 step ownership transfer address public pendingOwner; // --- Constructor --- constructor(address _owner, Authority _authority) RolesAuthority(_owner, _authority) {} /** * @notice Starts the 2 step process of transferring registry authorization to a new owner. * @param _newOwner Proposed new owner of registry authorization. */ function transferOwnership(address _newOwner) external requiresAuth { pendingOwner = _newOwner; emit OwnershipTransferProposed(msg.sender, _newOwner); } /** * @notice Completes the 2 step process of transferring registry authorization to a new owner. * This function must be called by the proposed new owner. */ function claimOwnership() external { if (msg.sender != pendingOwner) revert OwnershipInvalid(); emit OwnershipChanged(owner, pendingOwner); owner = pendingOwner; pendingOwner = address(0); } /** * @notice Old approach of setting a new owner in a single step. * @dev This function throws an error to force use of the new 2-step approach. */ function setOwner(address /*newOwner*/ ) public view override requiresAuth { revert OwnershipInvalid(); } } //SPDX-License-Identifier: BSD 3-Clause pragma solidity >=0.8.0; import "solmate/tokens/ERC20.sol"; import "solmate/utils/SafeTransferLib.sol"; import "./lib/ReentrancyGuard.sol"; import { Registry } from "./Registry.sol"; import { ISwapWrapper } from "./interfaces/ISwapWrapper.sol"; import { EndaomentAuth } from "./lib/auth/EndaomentAuth.sol"; import { Portfolio } from "./Portfolio.sol"; import { Math } from "./lib/Math.sol"; error EntityInactive(); error PortfolioInactive(); error InsufficientFunds(); error InvalidAction(); error BalanceMismatch(); error CallFailed(bytes response); /** * @notice Entity contract inherited by Org and Fund contracts (and all future kinds of Entities). */ abstract contract Entity is EndaomentAuth, ReentrancyGuard { using Math for uint256; using SafeTransferLib for ERC20; /// @notice The base registry to which the entity is connected. Registry public registry; /// @notice The entity's manager. address public manager; // @notice The base token used for tracking the entity's fund balance. ERC20 public baseToken; /// @notice The current balance for the entity, denominated in the base token's units. uint256 public balance; /// @notice Placeholder address used in swapping method to denote usage of ETH instead of a token. address public constant ETH_PLACEHOLDER = 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE; /// @notice Emitted when manager is set. event EntityManagerSet(address indexed oldManager, address indexed newManager); /// @notice Emitted when a donation is made. event EntityDonationReceived( address indexed from, address indexed to, address indexed tokenIn, uint256 amountIn, uint256 amountReceived, uint256 amountFee ); /// @notice Emitted when a payout is made from an entity. event EntityValuePaidOut(address indexed from, address indexed to, uint256 amountSent, uint256 amountFee); /// @notice Emitted when a transfer is made between entities. event EntityValueTransferred(address indexed from, address indexed to, uint256 amountReceived, uint256 amountFee); /// @notice Emitted when a base token reconciliation completes event EntityBalanceReconciled(address indexed entity, uint256 amountReceived, uint256 amountFee); /// @notice Emitted when a base token balance is used to correct the internal contract balance. event EntityBalanceCorrected(address indexed entity, uint256 newBalance); /// @notice Emitted when a portfolio deposit is made. event EntityDeposit(address indexed portfolio, uint256 baseTokenDeposited, uint256 sharesReceived); /// @notice Emitted when a portfolio share redemption is made. event EntityRedeem(address indexed portfolio, uint256 sharesRedeemed, uint256 baseTokenReceived); /** * @notice Modifier for methods that require auth and that the manager can access. * @dev Uses the same condition as `requiresAuth` but with added manager access. */ modifier requiresManager { if(msg.sender != manager && !isAuthorized(msg.sender, msg.sig)) revert Unauthorized(); _; } /// @notice Each entity will implement this function to allow a caller to interrogate what kind of entity it is. function entityType() public pure virtual returns (uint8); /** * @notice One time method to be called at deployment to configure the contract. Required so Entity * contracts can be deployed as minimal proxies (clones). * @param _registry The registry to host the Entity. * @param _manager The address of the Entity's manager. */ function __initEntity(Registry _registry, address _manager) internal { // Call to EndaomentAuth's initialize function ensures that this can't be called again __initEndaomentAuth(_registry, bytes20(bytes.concat("entity", bytes1(entityType())))); __initReentrancyGuard(); registry = _registry; manager = _manager; baseToken = _registry.baseToken(); } /** * @notice Set a new manager for this entity. * @param _manager Address of new manager. * @dev Callable by current manager or permissioned role. */ function setManager(address _manager) external virtual requiresManager { emit EntityManagerSet(manager, _manager); manager = _manager; } /** * @notice Receives a donated amount of base tokens to be added to the entity's balance. Transfers default fee to treasury. * @param _amount Amount donated in base token. * @dev Reverts if the donation fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). * @dev Reverts if the token transfer fails. */ function donate(uint256 _amount) external virtual { uint32 _feeMultiplier = registry.getDonationFee(this); _donateWithFeeMultiplier(_amount, _feeMultiplier); } /** * @notice Receives a donated amount of base tokens to be added to the entity's balance. Transfers default or overridden fee to treasury. * @param _amount Amount donated in base token. * @dev Reverts if the donation fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). * @dev Reverts if the token transfer fails. */ function donateWithOverrides(uint256 _amount) external virtual { uint32 _feeMultiplier = registry.getDonationFeeWithOverrides(this); _donateWithFeeMultiplier(_amount, _feeMultiplier); } /** * @notice Receives a donated amount of base tokens to be added to the entity's balance. * This method can be called by permissioned actors to make a donation with a manually specified fee. * @param _amount Amount donated in base token. * @param _feeOverride Fee percentage as zoc. * @dev Reverts if the transfer fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). * @dev Reverts if the token transfer fails. * @dev Reverts with `Unauthorized` if the `msg.sender` is not a privileged role. */ function donateWithAdminOverrides(uint256 _amount, uint32 _feeOverride) requiresAuth external virtual { _donateWithFeeMultiplier(_amount, _feeOverride); } /** * @notice Receives a donated amount of base tokens to be added to the entity's balance. Transfers fee calculated by fee multiplier to treasury. * @param _amount Amount donated in base token. * @param _feeMultiplier Value indicating the percentage of the Endaoment donation fee to go to the Endaoment treasury. * @dev Reverts if the donation fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). * @dev Reverts if the token transfer fails. */ function _donateWithFeeMultiplier(uint256 _amount, uint32 _feeMultiplier) internal virtual { (uint256 _netAmount, uint256 _fee) = _calculateFee(_amount, _feeMultiplier); baseToken.safeTransferFrom(msg.sender, registry.treasury(), _fee); baseToken.safeTransferFrom(msg.sender, address(this), _netAmount); unchecked { // unchecked as no possibility of overflow with baseToken precision balance += _netAmount; } emit EntityDonationReceived(msg.sender, address(this), address(baseToken), _amount, _amount, _fee); } /** * @notice Receive a donated amount of ETH or ERC20 tokens, swaps them to base tokens, and adds the output to the * entity's balance. Fee calculated using default rate and sent to treasury. * @param _swapWrapper The swap wrapper to use for the donation. Must be whitelisted on the Registry. * @param _tokenIn The address of the ERC20 token to swap and donate, or ETH_PLACEHOLDER if donating ETH. * @param _amountIn The amount of tokens or ETH being swapped and donated. * @param _data Additional call data required by the ISwapWrapper being used. */ function swapAndDonate( ISwapWrapper _swapWrapper, address _tokenIn, uint256 _amountIn, bytes calldata _data ) external virtual payable { uint32 _feeMultiplier = registry.getDonationFee(this); _swapAndDonateWithFeeMultiplier(_swapWrapper, _tokenIn, _amountIn, _data, _feeMultiplier); } /** * @notice Receive a donated amount of ETH or ERC20 tokens, swaps them to base tokens, and adds the output to the * entity's balance. Fee calculated using override rate and sent to treasury. * @param _swapWrapper The swap wrapper to use for the donation. Must be whitelisted on the Registry. * @param _tokenIn The address of the ERC20 token to swap and donate, or ETH_PLACEHOLDER if donating ETH. * @param _amountIn The amount of tokens or ETH being swapped and donated. * @param _data Additional call data required by the ISwapWrapper being used. */ function swapAndDonateWithOverrides( ISwapWrapper _swapWrapper, address _tokenIn, uint256 _amountIn, bytes calldata _data ) external virtual payable { uint32 _feeMultiplier = registry.getDonationFeeWithOverrides(this); _swapAndDonateWithFeeMultiplier(_swapWrapper, _tokenIn, _amountIn, _data, _feeMultiplier); } /// @dev Internal helper implementing swap and donate functionality for any fee multiplier provided. function _swapAndDonateWithFeeMultiplier( ISwapWrapper _swapWrapper, address _tokenIn, uint256 _amountIn, bytes calldata _data, uint32 _feeMultiplier ) nonReentrant internal virtual { if (!registry.isSwapperSupported(_swapWrapper)) revert InvalidAction(); // THINK: do we need a re-entrancy guard on this method? if (_tokenIn != ETH_PLACEHOLDER) { ERC20(_tokenIn).safeTransferFrom(msg.sender, address(this), _amountIn); ERC20(_tokenIn).safeApprove(address(_swapWrapper), 0); ERC20(_tokenIn).safeApprove(address(_swapWrapper), _amountIn); } uint256 _amountOut = _swapWrapper.swap{value: msg.value}( _tokenIn, address(baseToken), address(this), _amountIn, _data ); (uint256 _netAmount, uint256 _fee) = _calculateFee(_amountOut, _feeMultiplier); baseToken.safeTransfer(registry.treasury(), _fee); unchecked { // unchecked as no possibility of overflow with baseToken precision balance += _netAmount; } if(balance > baseToken.balanceOf(address(this))) revert BalanceMismatch(); emit EntityDonationReceived(msg.sender, address(this), _tokenIn, _amountIn, _amountOut, _fee); } /** * @notice Transfers an amount of base tokens from one entity to another. Transfers default fee to treasury. * @param _to The entity to receive the tokens. * @param _amount Contains the amount being donated (denominated in the base token's units). * @dev Reverts if the entity is inactive or if the token transfer fails. * @dev Reverts if the transfer fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). * @dev Reverts with `Unauthorized` if the `msg.sender` is not the entity manager or a privileged role. */ function transfer(Entity _to, uint256 _amount) requiresManager external virtual { uint32 _feeMultiplier = registry.getTransferFee(this, _to); _transferWithFeeMultiplier(_to, _amount, _feeMultiplier); } /** * @notice Transfers an amount of base tokens from one entity to another. Transfers default or overridden fee to treasury. * @param _to The entity to receive the tokens. * @param _amount Contains the amount being donated (denominated in the base token's units). * @dev Reverts if the entity is inactive or if the token transfer fails. * @dev Reverts if the transfer fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). * @dev Reverts with `Unauthorized` if the `msg.sender` is not the entity manager or a privileged role. */ function transferWithOverrides(Entity _to, uint256 _amount) requiresManager external virtual { uint32 _feeMultiplier = registry.getTransferFeeWithOverrides(this, _to); _transferWithFeeMultiplier(_to, _amount, _feeMultiplier); } /** * @notice Transfers an amount of base tokens from one entity to another. Transfers fee specified by a privileged role. * @param _to The entity to receive the tokens. * @param _amount Contains the amount being donated (denominated in the base token's units). * @param _feeOverride Admin override configured by an Admin * @dev Reverts if the entity is inactive or if the token transfer fails. * @dev Reverts if the transfer fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). * @dev Reverts with `Unauthorized` if the `msg.sender` is not a privileged role. */ function transferWithAdminOverrides(Entity _to, uint256 _amount, uint32 _feeOverride) requiresAuth external virtual { _transferWithFeeMultiplier(_to, _amount, _feeOverride); } /** * @notice Transfers an amount of base tokens from one entity to another. Transfers fee calculated by fee multiplier to treasury. * @param _to The entity to receive the tokens. * @param _amount Contains the amount being donated (denominated in the base token's units). * @param _feeMultiplier Value indicating the percentage of the Endaoment donation fee to go to the Endaoment treasury. * @dev Reverts with 'Inactive' if the entity sending the transfer or the entity receiving the transfer is inactive. * @dev Reverts if the transfer fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). * @dev Reverts with `Unauthorized` if the `msg.sender` is not the entity manager or a privileged role. * @dev Reverts if the token transfer fails. */ function _transferWithFeeMultiplier(Entity _to, uint256 _amount, uint32 _feeMultiplier) internal virtual { if (!registry.isActiveEntity(this) || !registry.isActiveEntity(_to)) revert EntityInactive(); if (balance < _amount) revert InsufficientFunds(); (uint256 _netAmount, uint256 _fee) = _calculateFee(_amount, _feeMultiplier); baseToken.safeTransfer(registry.treasury(), _fee); baseToken.safeTransfer(address(_to), _netAmount); unchecked { // unchecked as no possibility of overflow with baseToken precision balance -= _amount; _to.receiveTransfer(_netAmount); } emit EntityValueTransferred(address(this), address(_to), _amount, _fee); } /** * @notice Updates the receiving entity balance on a transfer. * @param _transferAmount The amount being received on the transfer. * @dev This function is external, but is restricted such that it can only be called by other entities. */ function receiveTransfer(uint256 _transferAmount) external virtual { if (!registry.isActiveEntity(Entity(msg.sender))) revert EntityInactive(); unchecked { // Cannot overflow with realistic balances. balance += _transferAmount; } } /** * @notice Deposits an amount of Entity's `baseToken` into an Endaoment-approved Portfolio. * @param _portfolio An Endaoment-approved portfolio. * @param _amount Amount of `baseToken` to deposit into the portfolio. * @param _data Data required by a portfolio to deposit. * @return _shares Amount of portfolio share tokens Entity received as a result of this deposit. */ function portfolioDeposit(Portfolio _portfolio, uint256 _amount, bytes calldata _data) external virtual requiresManager returns (uint256) { if(!registry.isActivePortfolio(_portfolio)) revert PortfolioInactive(); balance -= _amount; baseToken.safeApprove(address(_portfolio), _amount); uint256 _shares = _portfolio.deposit(_amount, _data); emit EntityDeposit(address(_portfolio), _amount, _shares); return _shares; } /** * @notice Redeems an amount of Entity's portfolio shares for an amount of `baseToken`. * @param _portfolio An Endaoment-approved portfolio. * @param _shares Amount of share tokens to redeem. * @param _data Data required by a portfolio to redeem. * @return _received Amount of `baseToken` Entity received as a result of this redemption. */ function portfolioRedeem(Portfolio _portfolio, uint256 _shares, bytes calldata _data) external virtual requiresManager returns (uint256) { if(!registry.isActivePortfolio(_portfolio)) revert PortfolioInactive(); uint256 _received = _portfolio.redeem(_shares, _data); // unchecked: a realistic balance can never overflow a uint256 unchecked { balance += _received; } emit EntityRedeem(address(_portfolio), _shares, _received); return _received; } /** * @notice This method should be called to reconcile the Entity's internal baseToken accounting with the baseToken contract's accounting. * There are a 2 situations where calling this method is appropriate: * 1. To process amounts of baseToken that arrived at this Entity through methods besides Entity:donate or Entity:transfer. For example, * if this Entity receives a normal ERC20 transfer of baseToken, the amount received will be unavailable for Entity use until this method * is called to adjust the balance and process fees. OrgFundFactory.sol:_donate makes use of this method to do this as well. * 2. Unusually, the Entity's perspective of balance could be lower than `baseToken.balanceOf(this)`. This could happen if * Entity:callAsEntity is used to transfer baseToken. In this case, this method provides a way of correcting the Entity's internal balance. */ function reconcileBalance() external virtual { uint256 _tokenBalance = baseToken.balanceOf(address(this)); if (_tokenBalance >= balance) { uint256 _sweepAmount = _tokenBalance - balance; uint32 _feeMultiplier = registry.getDonationFeeWithOverrides(this); (uint256 _netAmount, uint256 _fee) = _calculateFee(_sweepAmount, _feeMultiplier); baseToken.safeTransfer(registry.treasury(), _fee); unchecked { balance += _netAmount; } emit EntityBalanceReconciled(address(this), _sweepAmount, _fee); } else { // Handle abnormal scenario where _tokenBalance < balance (see method docs) balance = _tokenBalance; emit EntityBalanceCorrected(address(this), _tokenBalance); } } /** * @notice Takes stray tokens or ETH sent directly to this Entity, swaps them for base token, then adds them to the * Entity's balance after paying the appropriate fee to the treasury. * @param _swapWrapper The swap wrapper to use to convert the assets. Must be whitelisted on the Registry. * @param _tokenIn The address of the ERC20 token to swap, or ETH_PLACEHOLDER if ETH. * @param _amountIn The amount of tokens or ETH being swapped and added to the balance. * @param _data Additional call data required by the ISwapWrapper being used. */ function swapAndReconcileBalance( ISwapWrapper _swapWrapper, address _tokenIn, uint256 _amountIn, bytes calldata _data ) nonReentrant external virtual requiresManager { if (!registry.isSwapperSupported(_swapWrapper)) revert InvalidAction(); uint32 _feeMultiplier = registry.getDonationFeeWithOverrides(this); if (_tokenIn != ETH_PLACEHOLDER) { ERC20(_tokenIn).safeApprove(address(_swapWrapper), 0); ERC20(_tokenIn).safeApprove(address(_swapWrapper), _amountIn); } // Send value only if token in is ETH uint256 _value = _tokenIn == ETH_PLACEHOLDER ? _amountIn : 0; uint256 _amountOut = _swapWrapper.swap{value: _value}( _tokenIn, address(baseToken), address(this), _amountIn, _data ); (uint256 _netAmount, uint256 _fee) = _calculateFee(_amountOut, _feeMultiplier); baseToken.safeTransfer(registry.treasury(), _fee); unchecked { // unchecked as no possibility of overflow with baseToken precision balance += _netAmount; } if(balance > baseToken.balanceOf(address(this))) revert BalanceMismatch(); emit EntityBalanceReconciled(address(this), _amountOut, _fee); } /** * @notice Permissioned method that allows Endaoment admin to make arbitrary calls acting as this Entity. * @param _target The address to which the call will be made. * @param _value The ETH value that should be forwarded with the call. * @param _data The calldata that will be sent with the call. * @return _return The data returned by the call. */ function callAsEntity( address _target, uint256 _value, bytes memory _data ) external virtual payable requiresAuth returns (bytes memory) { (bool _success, bytes memory _response) = payable(_target).call{value: _value}(_data); if (!_success) revert CallFailed(_response); return _response; } /** * @notice Pays out an amount of base tokens from the entity to an address. Transfers the fee calculated by the * default fee multiplier to the treasury. * @param _to The address to receive the tokens. * @param _amount Amount donated in base token. * @dev Reverts with `Unauthorized` if the `msg.sender` is not a privileged role. * @dev Reverts if the fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). * @dev Reverts if the token transfer fails. */ function payout(address _to, uint256 _amount) external virtual requiresAuth { uint32 _feeMultiplier = registry.getPayoutFee(this); _payoutWithFeeMultiplier(_to, _amount, _feeMultiplier); } /** * @notice Pays out an amount of base tokens from the entity to an address. Transfers the fee calculated by the * default fee multiplier to the treasury. * @param _amount Amount donated in base token. * @dev Reverts with `Unauthorized` if the `msg.sender` is not a privileged role. * @dev Reverts if the fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). * @dev Reverts if the token transfer fails. */ function payoutWithOverrides(address _to, uint256 _amount) external virtual requiresAuth { uint32 _feeMultiplier = registry.getPayoutFeeWithOverrides(this); _payoutWithFeeMultiplier(_to, _amount, _feeMultiplier); } /** * @notice Pays out an amount of base tokens from the entity to an address. Transfers fee specified by a privileged role. * @param _amount Amount donated in base token. * @param _feeOverride Payout override configured by an Admin * @dev Reverts with `Unauthorized` if the `msg.sender` is not a privileged role. * @dev Reverts if the fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). * @dev Reverts if the token transfer fails. */ function payoutWithAdminOverrides(address _to, uint256 _amount, uint32 _feeOverride) external virtual requiresAuth { _payoutWithFeeMultiplier(_to, _amount, _feeOverride); } /** * @notice Pays out an amount of base tokens from the entity to an address. Transfers the fee calculated by fee multiplier to the treasury. * @param _to The address to receive the tokens. * @param _amount Contains the amount being paid out (denominated in the base token's units). * @param _feeMultiplier Value indicating the percentage of the Endaoment fee to go to the Endaoment treasury. * @dev Reverts if the token transfer fails. * @dev Reverts if the fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). */ function _payoutWithFeeMultiplier(address _to, uint256 _amount, uint32 _feeMultiplier) internal virtual { if (balance < _amount) revert InsufficientFunds(); (uint256 _netAmount, uint256 _fee) = _calculateFee(_amount, _feeMultiplier); baseToken.safeTransfer(registry.treasury(), _fee); baseToken.safeTransfer(address(_to), _netAmount); unchecked { // unchecked because we've already validated that amount is less than or equal to the balance balance -= _amount; } emit EntityValuePaidOut(address(this), _to, _amount, _fee); } /// @dev Internal helper method to calculate the fee on a base token amount for a given fee multiplier. function _calculateFee( uint256 _amount, uint256 _feeMultiplier ) internal virtual pure returns (uint256 _netAmount, uint256 _fee) { if (_feeMultiplier > Math.ZOC) revert InvalidAction(); unchecked { // unchecked as no possibility of overflow with baseToken precision _fee = _amount.zocmul(_feeMultiplier); // unchecked as the _feeMultiplier check with revert above protects against overflow _netAmount = _amount - _fee; } } } //SPDX-License-Identifier: BSD 3-Clause pragma solidity >=0.8.0; error ETHAmountInMismatch(); /** * @notice ISwapWrapper is the interface that all swap wrappers should implement. * This will be used to support swap protocols like Uniswap V2 and V3, Sushiswap, 1inch, etc. */ interface ISwapWrapper { /// @notice Event emitted after a successful swap. event WrapperSwapExecuted(address indexed tokenIn, address indexed tokenOut, address sender, address indexed recipient, uint256 amountIn, uint256 amountOut); /// @notice Name of swap wrapper for UX readability. function name() external returns (string memory); /** * @notice Swap function. Generally we expect the implementer to call some exactAmountIn-like swap method, and so the documentation * is written with this in mind. However, the method signature is general enough to support exactAmountOut swaps as well. * @param _tokenIn Token to be swapped (or 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE for ETH). * @param _tokenOut Token to receive (or 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE for ETH). * @param _recipient Receiver of `_tokenOut`. * @param _amount Amount of `_tokenIn` that should be swapped. * @param _data Additional data that the swap wrapper may require to execute the swap. * @return Amount of _tokenOut received. */ function swap(address _tokenIn, address _tokenOut, address _recipient, uint256 _amount, bytes calldata _data) external payable returns (uint256); } //SPDX-License-Identifier: BSD 3-Clause pragma solidity >=0.8.0; import { ERC20 } from "solmate/tokens/ERC20.sol"; import { Registry } from "./Registry.sol"; import { Entity } from "./Entity.sol"; import { EndaomentAuth } from "./lib/auth/EndaomentAuth.sol"; import { RolesAuthority } from "./lib/auth/authorities/RolesAuthority.sol"; import { Math } from "./lib/Math.sol"; abstract contract Portfolio is ERC20, EndaomentAuth { using Math for uint256; Registry public immutable registry; uint256 public cap; uint256 public depositFee; uint256 public redemptionFee; address public immutable asset; bool public didShutdown; error InvalidSwapper(); error TransferDisallowed(); error DepositAfterShutdown(); error DidShutdown(); error NotEntity(); error ExceedsCap(); error PercentageOver100(); error RoundsToZero(); error CallFailed(bytes response); /// @notice `sender` has exchanged `assets` (after fees) for `shares`, and transferred those `shares` to `receiver`. /// The sender paid a total of `depositAmount` and was charged `fee` for the transaction. event Deposit( address indexed sender, address indexed receiver, uint256 assets, uint256 shares, uint256 depositAmount, uint256 fee ); /// @notice `sender` has exchanged `shares` for `assets`, and transferred those `assets` to `receiver`. /// The sender received a net of `redeemedAmount` after the conversion of `assets` into base tokens /// and was charged `fee` for the transaction. event Redeem( address indexed sender, address indexed receiver, uint256 assets, uint256 shares, uint256 redeemedAmount, uint256 fee ); /// @notice Event emitted when `cap` is set. event CapSet(uint256 cap); /// @notice Event emitted when `depositFee` is set. event DepositFeeSet(uint256 fee); /// @notice Event emitted when `redemptionFee` is set. event RedemptionFeeSet(uint256 fee); /// @notice Event emitted when management takes fees. event FeesTaken(uint256 amount); /// @notice Event emitted when admin forcefully swaps portfolio asset balance for baseToken. event Shutdown(uint256 assetAmount, uint256 baseTokenOut); /** * @param _registry Endaoment registry. * @param _name Name of the ERC20 Portfolio share tokens. * @param _symbol Symbol of the ERC20 Portfolio share tokens. * @param _cap Amount in baseToken that value of totalAssets should not exceed. * @param _depositFee Percentage fee as ZOC that will go to treasury on asset deposit. * @param _redemptionFee Percentage fee as ZOC that will go to treasury on share redemption. */ constructor(Registry _registry, address _asset, string memory _name, string memory _symbol, uint256 _cap, uint256 _depositFee, uint256 _redemptionFee) ERC20(_name, _symbol, ERC20(_asset).decimals()) { registry = _registry; if(_redemptionFee > Math.ZOC) revert PercentageOver100(); depositFee = _depositFee; redemptionFee = _redemptionFee; cap = _cap; asset = _asset; __initEndaomentAuth(_registry, "portfolio"); } /** * @notice Function used to determine whether an Entity is active on the registry. * @param _entity The Entity. */ function _isEntity(Entity _entity) internal view returns (bool) { return registry.isActiveEntity(_entity); } /** * @notice Set the Portfolio cap. * @param _amount Amount, denominated in baseToken. */ function setCap(uint256 _amount) external virtual requiresAuth { cap = _amount; emit CapSet(_amount); } /** * @notice Set deposit fee. * @param _pct Percentage as ZOC (e.g. 1000 = 10%). */ function setDepositFee(uint256 _pct) external virtual requiresAuth { if(_pct > Math.ZOC) revert PercentageOver100(); depositFee = _pct; emit DepositFeeSet(_pct); } /** * @notice Set redemption fee. * @param _pct Percentage as ZOC (e.g. 1000 = 10%). */ function setRedemptionFee(uint256 _pct) external virtual requiresAuth { if(_pct > Math.ZOC) revert PercentageOver100(); redemptionFee = _pct; emit RedemptionFeeSet(_pct); } /** * @notice Total amount of the underlying asset that is managed by the Portfolio. */ function totalAssets() external view virtual returns (uint256); /** * @notice Takes some amount of assets from this portfolio as assets under management fee. * @param _amountAssets Amount of assets to take. */ function takeFees(uint256 _amountAssets) external virtual; /** * @notice Exchange `_amountBaseToken` for some amount of Portfolio shares. * @param _amountBaseToken The amount of the Entity's baseToken to deposit. * @param _data Data that the portfolio needs to make the deposit. In some cases, this will be swap parameters. * @return shares The amount of shares that this deposit yields to the Entity. */ function deposit(uint256 _amountBaseToken, bytes calldata _data) virtual external returns (uint256 shares); /** * @notice Exchange `_amountShares` for some amount of baseToken. * @param _amountShares The amount of the Entity's portfolio shares to exchange. * @param _data Data that the portfolio needs to make the redemption. In some cases, this will be swap parameters. * @return baseTokenOut The amount of baseToken that this redemption yields to the Entity. */ function redeem(uint256 _amountShares, bytes calldata _data) virtual external returns (uint256 baseTokenOut); /** * @notice Calculates the amount of shares that the Portfolio should exchange for the amount of assets provided. * @param _amountAssets Amount of assets. */ function convertToShares(uint256 _amountAssets) virtual public view returns (uint256); /** * @notice Calculates the amount of assets that the Portfolio should exchange for the amount of shares provided. * @param _amountShares Amount of shares. */ function convertToAssets(uint256 _amountShares) virtual public view returns (uint256); /** * @notice Exit out all assets of portfolio for baseToken. Must persist a mechanism for entities to redeem their shares for baseToken. * @param _data Data that the portfolio needs to exit from asset. In some cases, this will be swap parameters. * @return baseTokenOut The amount of baseToken that this exit yielded. */ function shutdown(bytes calldata _data) virtual external returns (uint256 baseTokenOut); /// @notice `transfer` disabled on Portfolio tokens. function transfer(address /** to */, uint256 /** amount */) public pure override returns (bool) { revert TransferDisallowed(); } /// @notice `transferFrom` disabled on Portfolio tokens. function transferFrom(address /** from */, address /** to */, uint256 /** amount */) public pure override returns (bool) { revert TransferDisallowed(); } /// @notice `approve` disabled on Portfolio tokens. function approve(address /** to */, uint256 /** amount */) public pure override returns (bool) { revert TransferDisallowed(); } /// @notice `permit` disabled on Portfolio tokens. function permit( address /* owner */, address /* spender */, uint256 /* value */, uint256 /* deadline */, uint8 /* v */, bytes32 /* r */, bytes32 /* s */ ) public pure override { revert TransferDisallowed(); } /** * @notice Permissioned method that allows Endaoment admin to make arbitrary calls acting as this Portfolio. * @param _target The address to which the call will be made. * @param _value The ETH value that should be forwarded with the call. * @param _data The calldata that will be sent with the call. * @return _return The data returned by the call. */ function callAsPortfolio( address _target, uint256 _value, bytes memory _data ) external payable requiresAuth returns (bytes memory) { (bool _success, bytes memory _response) = payable(_target).call{value: _value}(_data); if (!_success) revert CallFailed(_response); return _response; } /// @dev Internal helper method to calculate the fee on a base token amount for a given fee multiplier. function _calculateFee( uint256 _amount, uint256 _feeMultiplier ) internal pure returns (uint256 _netAmount, uint256 _fee) { if (_feeMultiplier > Math.ZOC) revert PercentageOver100(); unchecked { // unchecked as no possibility of overflow with baseToken precision _fee = _amount.zocmul(_feeMultiplier); // unchecked as the _feeMultiplier check with revert above protects against overflow _netAmount = _amount - _fee; } } } // SPDX-License-Identifier: AGPL-3.0-only pragma solidity >=0.8.0; // This contract is modified from Solmate only to import modified Auth.sol on line 5 import {Auth, Authority} from "../Auth.sol"; /// @notice Role based Authority that supports up to 256 roles. /// @author Solmate (https://github.com/Rari-Capital/solmate/blob/main/src/auth/authorities/RolesAuthority.sol) /// @author Modified from Dappsys (https://github.com/dapphub/ds-roles/blob/master/src/roles.sol) contract RolesAuthority is Auth, Authority { /*/////////////////////////////////////////////////////////////// EVENTS //////////////////////////////////////////////////////////////*/ event UserRoleUpdated(address indexed user, uint8 indexed role, bool enabled); event PublicCapabilityUpdated(address indexed target, bytes4 indexed functionSig, bool enabled); event RoleCapabilityUpdated(uint8 indexed role, address indexed target, bytes4 indexed functionSig, bool enabled); /*/////////////////////////////////////////////////////////////// CONSTRUCTOR //////////////////////////////////////////////////////////////*/ constructor(address _owner, Authority _authority) Auth(_owner, _authority) {} /*/////////////////////////////////////////////////////////////// ROLE/USER STORAGE //////////////////////////////////////////////////////////////*/ mapping(address => bytes32) public getUserRoles; mapping(address => mapping(bytes4 => bool)) public isCapabilityPublic; mapping(address => mapping(bytes4 => bytes32)) public getRolesWithCapability; function doesUserHaveRole(address user, uint8 role) public view virtual returns (bool) { return (uint256(getUserRoles[user]) >> role) & 1 != 0; } function doesRoleHaveCapability( uint8 role, address target, bytes4 functionSig ) public view virtual returns (bool) { return (uint256(getRolesWithCapability[target][functionSig]) >> role) & 1 != 0; } /*/////////////////////////////////////////////////////////////// AUTHORIZATION LOGIC //////////////////////////////////////////////////////////////*/ function canCall( address user, address target, bytes4 functionSig ) public view virtual override returns (bool) { return isCapabilityPublic[target][functionSig] || bytes32(0) != getUserRoles[user] & getRolesWithCapability[target][functionSig]; } /*/////////////////////////////////////////////////////////////// ROLE CAPABILITY CONFIGURATION LOGIC //////////////////////////////////////////////////////////////*/ function setPublicCapability( address target, bytes4 functionSig, bool enabled ) public virtual requiresAuth { isCapabilityPublic[target][functionSig] = enabled; emit PublicCapabilityUpdated(target, functionSig, enabled); } function setRoleCapability( uint8 role, address target, bytes4 functionSig, bool enabled ) public virtual requiresAuth { if (enabled) { getRolesWithCapability[target][functionSig] |= bytes32(1 << role); } else { getRolesWithCapability[target][functionSig] &= ~bytes32(1 << role); } emit RoleCapabilityUpdated(role, target, functionSig, enabled); } /*/////////////////////////////////////////////////////////////// USER ROLE ASSIGNMENT LOGIC //////////////////////////////////////////////////////////////*/ function setUserRole( address user, uint8 role, bool enabled ) public virtual requiresAuth { if (enabled) { getUserRoles[user] |= bytes32(1 << role); } else { getUserRoles[user] &= ~bytes32(1 << role); } emit UserRoleUpdated(user, role, enabled); } } // SPDX-License-Identifier: AGPL-3.0-only pragma solidity >=0.8.0; /// @notice Gas optimized reentrancy protection for smart contracts. /// @author Modified Solmate (https://github.com/Rari-Capital/solmate/blob/main/src/utils/ReentrancyGuard.sol) /// @author Modified from OpenZeppelin (https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/contracts/security/ReentrancyGuard.sol) abstract contract ReentrancyGuard { uint256 private reentrancyStatus; error Reentrancy(); function __initReentrancyGuard() internal { if(reentrancyStatus != 0) revert Reentrancy(); reentrancyStatus = 1; } modifier nonReentrant() { if(reentrancyStatus != 1) revert Reentrancy(); reentrancyStatus = 2; _; reentrancyStatus = 1; } } // SPDX-License-Identifier: AGPL-3.0-only pragma solidity >=0.8.0; import { RolesAuthority } from './authorities/RolesAuthority.sol'; /** * @notice An abstract Auth that contracts in the Endaoment ecosystem can inherit from. It is based on * the `Auth.sol` contract from Solmate, but does not inherit from it. Most of the functionality * is either slightly different, or not needed. In particular: * - EndaomentAuth uses an initializer such that it can be deployed with minimal proxies. * - EndaomentAuth contracts reference a RolesAuthority, not just an Authority, when looking up permissions. * In the Endaoment ecosystem, this is assumed to be the Registry. * - EndaomentAuth contracts do not have an owner, but instead grant ubiquitous permission to its RoleAuthority's * owner. In the Endaoment ecosystem, this is assumed to be the board of directors multi-sig. * - EndaomentAuth contracts can optionally declare themselves a "special target" at deploy time. Instead of passing * their address to the authority when looking up their permissions, they'll instead pass the special target bytes. * See documentation on `specialTarget` for more information. * */ abstract contract EndaomentAuth { /// @notice Thrown when an account without proper permissions calls a privileged method. error Unauthorized(); /// @notice Thrown if there is an attempt to deploy with address 0 as the authority. error InvalidAuthority(); /// @notice Thrown if there is a second call to initialize. error AlreadyInitialized(); /// @notice The contract used to source permissions for accounts targeting this contract. RolesAuthority public authority; /** * @notice If set to a non-zero value, this contract will pass these byes as the target contract * to the RolesAuthority's `canCall` method, rather than its own contract. This allows a single * RolesAuthority permission to manage permissions simultaneously for a group of contracts that * identify themselves as a certain type. For example: set a permission for all "entity" contracts. */ bytes20 public specialTarget; /** * @notice One time method to be called at deployment to configure the contract. Required so EndaomentAuth * contracts can be deployed as minimal proxies (clones). * @param _authority Contract that will be used to source permissions for accounts targeting this contract. * @param _specialTarget The bytes that this contract will pass as the "target" when looking up permissions * from the authority. If set to empty bytes, this contract will pass its own address instead. */ function __initEndaomentAuth(RolesAuthority _authority, bytes20 _specialTarget) internal virtual { if (address(_authority) == address(0)) revert InvalidAuthority(); if (address(authority) != address(0)) revert AlreadyInitialized(); authority = _authority; specialTarget = _specialTarget; } /** * @notice Modifier for methods that require authorization to execute. */ modifier requiresAuth virtual { if(!isAuthorized(msg.sender, msg.sig)) revert Unauthorized(); _; } /** * @notice Internal method that asks the authority whether the caller has permission to execute a method. * @param user The account attempting to call a permissioned method on this contract * @param functionSig The signature hash of the permissioned method being invoked. */ function isAuthorized(address user, bytes4 functionSig) internal virtual view returns (bool) { RolesAuthority auth = authority; // Memoizing authority saves us a warm SLOAD, around 100 gas. address _target = specialTarget == "" ? address(this) : address(specialTarget); // The caller has permission on authority, or the caller is the RolesAuthority owner return auth.canCall(user, _target, functionSig) || user == auth.owner(); } }
File 7 of 9: Fund
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity >=0.8.0; /// @notice Modern and gas efficient ERC20 + EIP-2612 implementation. /// @author Solmate (https://github.com/Rari-Capital/solmate/blob/main/src/tokens/ERC20.sol) /// @author Modified from Uniswap (https://github.com/Uniswap/uniswap-v2-core/blob/master/contracts/UniswapV2ERC20.sol) /// @dev Do not manually set balances without updating totalSupply, as the sum of all user balances must not exceed it. abstract contract ERC20 { /*/////////////////////////////////////////////////////////////// EVENTS //////////////////////////////////////////////////////////////*/ event Transfer(address indexed from, address indexed to, uint256 amount); event Approval(address indexed owner, address indexed spender, uint256 amount); /*/////////////////////////////////////////////////////////////// METADATA STORAGE //////////////////////////////////////////////////////////////*/ string public name; string public symbol; uint8 public immutable decimals; /*/////////////////////////////////////////////////////////////// ERC20 STORAGE //////////////////////////////////////////////////////////////*/ uint256 public totalSupply; mapping(address => uint256) public balanceOf; mapping(address => mapping(address => uint256)) public allowance; /*/////////////////////////////////////////////////////////////// EIP-2612 STORAGE //////////////////////////////////////////////////////////////*/ bytes32 public constant PERMIT_TYPEHASH = keccak256("Permit(address owner,address spender,uint256 value,uint256 nonce,uint256 deadline)"); uint256 internal immutable INITIAL_CHAIN_ID; bytes32 internal immutable INITIAL_DOMAIN_SEPARATOR; mapping(address => uint256) public nonces; /*/////////////////////////////////////////////////////////////// CONSTRUCTOR //////////////////////////////////////////////////////////////*/ constructor( string memory _name, string memory _symbol, uint8 _decimals ) { name = _name; symbol = _symbol; decimals = _decimals; INITIAL_CHAIN_ID = block.chainid; INITIAL_DOMAIN_SEPARATOR = computeDomainSeparator(); } /*/////////////////////////////////////////////////////////////// ERC20 LOGIC //////////////////////////////////////////////////////////////*/ function approve(address spender, uint256 amount) public virtual returns (bool) { allowance[msg.sender][spender] = amount; emit Approval(msg.sender, spender, amount); return true; } function transfer(address to, uint256 amount) public virtual returns (bool) { balanceOf[msg.sender] -= amount; // Cannot overflow because the sum of all user // balances can't exceed the max uint256 value. unchecked { balanceOf[to] += amount; } emit Transfer(msg.sender, to, amount); return true; } function transferFrom( address from, address to, uint256 amount ) public virtual returns (bool) { uint256 allowed = allowance[from][msg.sender]; // Saves gas for limited approvals. if (allowed != type(uint256).max) allowance[from][msg.sender] = allowed - amount; balanceOf[from] -= amount; // Cannot overflow because the sum of all user // balances can't exceed the max uint256 value. unchecked { balanceOf[to] += amount; } emit Transfer(from, to, amount); return true; } /*/////////////////////////////////////////////////////////////// EIP-2612 LOGIC //////////////////////////////////////////////////////////////*/ function permit( address owner, address spender, uint256 value, uint256 deadline, uint8 v, bytes32 r, bytes32 s ) public virtual { require(deadline >= block.timestamp, "PERMIT_DEADLINE_EXPIRED"); // Unchecked because the only math done is incrementing // the owner's nonce which cannot realistically overflow. unchecked { bytes32 digest = keccak256( abi.encodePacked( "\\x19\\x01", DOMAIN_SEPARATOR(), keccak256(abi.encode(PERMIT_TYPEHASH, owner, spender, value, nonces[owner]++, deadline)) ) ); address recoveredAddress = ecrecover(digest, v, r, s); require(recoveredAddress != address(0) && recoveredAddress == owner, "INVALID_SIGNER"); allowance[recoveredAddress][spender] = value; } emit Approval(owner, spender, value); } function DOMAIN_SEPARATOR() public view virtual returns (bytes32) { return block.chainid == INITIAL_CHAIN_ID ? INITIAL_DOMAIN_SEPARATOR : computeDomainSeparator(); } function computeDomainSeparator() internal view virtual returns (bytes32) { return keccak256( abi.encode( keccak256("EIP712Domain(string name,string version,uint256 chainId,address verifyingContract)"), keccak256(bytes(name)), keccak256("1"), block.chainid, address(this) ) ); } /*/////////////////////////////////////////////////////////////// INTERNAL MINT/BURN LOGIC //////////////////////////////////////////////////////////////*/ function _mint(address to, uint256 amount) internal virtual { totalSupply += amount; // Cannot overflow because the sum of all user // balances can't exceed the max uint256 value. unchecked { balanceOf[to] += amount; } emit Transfer(address(0), to, amount); } function _burn(address from, uint256 amount) internal virtual { balanceOf[from] -= amount; // Cannot underflow because a user's balance // will never be larger than the total supply. unchecked { totalSupply -= amount; } emit Transfer(from, address(0), amount); } } // SPDX-License-Identifier: AGPL-3.0-only pragma solidity >=0.8.0; import {ERC20} from "../tokens/ERC20.sol"; /// @notice Safe ETH and ERC20 transfer library that gracefully handles missing return values. /// @author Solmate (https://github.com/Rari-Capital/solmate/blob/main/src/utils/SafeTransferLib.sol) /// @author Modified from Gnosis (https://github.com/gnosis/gp-v2-contracts/blob/main/src/contracts/libraries/GPv2SafeERC20.sol) /// @dev Use with caution! Some functions in this library knowingly create dirty bits at the destination of the free memory pointer. library SafeTransferLib { /*/////////////////////////////////////////////////////////////// ETH OPERATIONS //////////////////////////////////////////////////////////////*/ function safeTransferETH(address to, uint256 amount) internal { bool callStatus; assembly { // Transfer the ETH and store if it succeeded or not. callStatus := call(gas(), to, amount, 0, 0, 0, 0) } require(callStatus, "ETH_TRANSFER_FAILED"); } /*/////////////////////////////////////////////////////////////// ERC20 OPERATIONS //////////////////////////////////////////////////////////////*/ function safeTransferFrom( ERC20 token, address from, address to, uint256 amount ) internal { bool callStatus; assembly { // Get a pointer to some free memory. let freeMemoryPointer := mload(0x40) // Write the abi-encoded calldata to memory piece by piece: mstore(freeMemoryPointer, 0x23b872dd00000000000000000000000000000000000000000000000000000000) // Begin with the function selector. mstore(add(freeMemoryPointer, 4), and(from, 0xffffffffffffffffffffffffffffffffffffffff)) // Mask and append the "from" argument. mstore(add(freeMemoryPointer, 36), and(to, 0xffffffffffffffffffffffffffffffffffffffff)) // Mask and append the "to" argument. mstore(add(freeMemoryPointer, 68), amount) // Finally append the "amount" argument. No mask as it's a full 32 byte value. // Call the token and store if it succeeded or not. // We use 100 because the calldata length is 4 + 32 * 3. callStatus := call(gas(), token, 0, freeMemoryPointer, 100, 0, 0) } require(didLastOptionalReturnCallSucceed(callStatus), "TRANSFER_FROM_FAILED"); } function safeTransfer( ERC20 token, address to, uint256 amount ) internal { bool callStatus; assembly { // Get a pointer to some free memory. let freeMemoryPointer := mload(0x40) // Write the abi-encoded calldata to memory piece by piece: mstore(freeMemoryPointer, 0xa9059cbb00000000000000000000000000000000000000000000000000000000) // Begin with the function selector. mstore(add(freeMemoryPointer, 4), and(to, 0xffffffffffffffffffffffffffffffffffffffff)) // Mask and append the "to" argument. mstore(add(freeMemoryPointer, 36), amount) // Finally append the "amount" argument. No mask as it's a full 32 byte value. // Call the token and store if it succeeded or not. // We use 68 because the calldata length is 4 + 32 * 2. callStatus := call(gas(), token, 0, freeMemoryPointer, 68, 0, 0) } require(didLastOptionalReturnCallSucceed(callStatus), "TRANSFER_FAILED"); } function safeApprove( ERC20 token, address to, uint256 amount ) internal { bool callStatus; assembly { // Get a pointer to some free memory. let freeMemoryPointer := mload(0x40) // Write the abi-encoded calldata to memory piece by piece: mstore(freeMemoryPointer, 0x095ea7b300000000000000000000000000000000000000000000000000000000) // Begin with the function selector. mstore(add(freeMemoryPointer, 4), and(to, 0xffffffffffffffffffffffffffffffffffffffff)) // Mask and append the "to" argument. mstore(add(freeMemoryPointer, 36), amount) // Finally append the "amount" argument. No mask as it's a full 32 byte value. // Call the token and store if it succeeded or not. // We use 68 because the calldata length is 4 + 32 * 2. callStatus := call(gas(), token, 0, freeMemoryPointer, 68, 0, 0) } require(didLastOptionalReturnCallSucceed(callStatus), "APPROVE_FAILED"); } /*/////////////////////////////////////////////////////////////// INTERNAL HELPER LOGIC //////////////////////////////////////////////////////////////*/ function didLastOptionalReturnCallSucceed(bool callStatus) private pure returns (bool success) { assembly { // Get how many bytes the call returned. let returnDataSize := returndatasize() // If the call reverted: if iszero(callStatus) { // Copy the revert message into memory. returndatacopy(0, 0, returnDataSize) // Revert with the same message. revert(0, returnDataSize) } switch returnDataSize case 32 { // Copy the return data into memory. returndatacopy(0, 0, returnDataSize) // Set success to whether it returned true. success := iszero(iszero(mload(0))) } case 0 { // There was no return data. success := 1 } default { // It returned some malformed input. success := 0 } } } } //SPDX-License-Identifier: BSD 3-Clause pragma solidity >=0.8.0; import "solmate/tokens/ERC20.sol"; import "solmate/utils/SafeTransferLib.sol"; import "./lib/ReentrancyGuard.sol"; import { Registry } from "./Registry.sol"; import { ISwapWrapper } from "./interfaces/ISwapWrapper.sol"; import { EndaomentAuth } from "./lib/auth/EndaomentAuth.sol"; import { Portfolio } from "./Portfolio.sol"; import { Math } from "./lib/Math.sol"; error EntityInactive(); error PortfolioInactive(); error InsufficientFunds(); error InvalidAction(); error BalanceMismatch(); error CallFailed(bytes response); /** * @notice Entity contract inherited by Org and Fund contracts (and all future kinds of Entities). */ abstract contract Entity is EndaomentAuth, ReentrancyGuard { using Math for uint256; using SafeTransferLib for ERC20; /// @notice The base registry to which the entity is connected. Registry public registry; /// @notice The entity's manager. address public manager; // @notice The base token used for tracking the entity's fund balance. ERC20 public baseToken; /// @notice The current balance for the entity, denominated in the base token's units. uint256 public balance; /// @notice Placeholder address used in swapping method to denote usage of ETH instead of a token. address public constant ETH_PLACEHOLDER = 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE; /// @notice Emitted when manager is set. event EntityManagerSet(address indexed oldManager, address indexed newManager); /// @notice Emitted when a donation is made. event EntityDonationReceived( address indexed from, address indexed to, address indexed tokenIn, uint256 amountIn, uint256 amountReceived, uint256 amountFee ); /// @notice Emitted when a payout is made from an entity. event EntityValuePaidOut(address indexed from, address indexed to, uint256 amountSent, uint256 amountFee); /// @notice Emitted when a transfer is made between entities. event EntityValueTransferred(address indexed from, address indexed to, uint256 amountReceived, uint256 amountFee); /// @notice Emitted when a base token reconciliation completes event EntityBalanceReconciled(address indexed entity, uint256 amountReceived, uint256 amountFee); /// @notice Emitted when a base token balance is used to correct the internal contract balance. event EntityBalanceCorrected(address indexed entity, uint256 newBalance); /// @notice Emitted when a portfolio deposit is made. event EntityDeposit(address indexed portfolio, uint256 baseTokenDeposited, uint256 sharesReceived); /// @notice Emitted when a portfolio share redemption is made. event EntityRedeem(address indexed portfolio, uint256 sharesRedeemed, uint256 baseTokenReceived); /// @notice Emitted when ether is received. event EntityEthReceived(address indexed sender, uint256 amount); /** * @notice Modifier for methods that require auth and that the manager can access. * @dev Uses the same condition as `requiresAuth` but with added manager access. */ modifier requiresManager { if(msg.sender != manager && !isAuthorized(msg.sender, msg.sig)) revert Unauthorized(); _; } /// @notice Each entity will implement this function to allow a caller to interrogate what kind of entity it is. function entityType() public pure virtual returns (uint8); /** * @notice One time method to be called at deployment to configure the contract. Required so Entity * contracts can be deployed as minimal proxies (clones). * @param _registry The registry to host the Entity. * @param _manager The address of the Entity's manager. */ function __initEntity(Registry _registry, address _manager) internal { // Call to EndaomentAuth's initialize function ensures that this can't be called again __initEndaomentAuth(_registry, bytes20(bytes.concat("entity", bytes1(entityType())))); __initReentrancyGuard(); registry = _registry; manager = _manager; baseToken = _registry.baseToken(); } /** * @notice Set a new manager for this entity. * @param _manager Address of new manager. * @dev Callable by current manager or permissioned role. */ function setManager(address _manager) external virtual requiresManager { emit EntityManagerSet(manager, _manager); manager = _manager; } /** * @notice Receives a donated amount of base tokens to be added to the entity's balance. Transfers default fee to treasury. * @param _amount Amount donated in base token. * @dev Reverts if the donation fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). * @dev Reverts if the token transfer fails. */ function donate(uint256 _amount) external virtual { uint32 _feeMultiplier = registry.getDonationFee(this); _donateWithFeeMultiplier(_amount, _feeMultiplier); } /** * @notice Receives a donated amount of base tokens to be added to the entity's balance. Transfers default or overridden fee to treasury. * @param _amount Amount donated in base token. * @dev Reverts if the donation fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). * @dev Reverts if the token transfer fails. */ function donateWithOverrides(uint256 _amount) external virtual { uint32 _feeMultiplier = registry.getDonationFeeWithOverrides(this); _donateWithFeeMultiplier(_amount, _feeMultiplier); } /** * @notice Receives a donated amount of base tokens to be added to the entity's balance. * This method can be called by permissioned actors to make a donation with a manually specified fee. * @param _amount Amount donated in base token. * @param _feeOverride Fee percentage as zoc. * @dev Reverts if the transfer fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). * @dev Reverts if the token transfer fails. * @dev Reverts with `Unauthorized` if the `msg.sender` is not a privileged role. */ function donateWithAdminOverrides(uint256 _amount, uint32 _feeOverride) requiresAuth external virtual { _donateWithFeeMultiplier(_amount, _feeOverride); } /** * @notice Receives a donated amount of base tokens to be added to the entity's balance. Transfers fee calculated by fee multiplier to treasury. * @param _amount Amount donated in base token. * @param _feeMultiplier Value indicating the percentage of the Endaoment donation fee to go to the Endaoment treasury. * @dev Reverts if the donation fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). * @dev Reverts if the token transfer fails. */ function _donateWithFeeMultiplier(uint256 _amount, uint32 _feeMultiplier) internal virtual { (uint256 _netAmount, uint256 _fee) = _calculateFee(_amount, _feeMultiplier); baseToken.safeTransferFrom(msg.sender, registry.treasury(), _fee); baseToken.safeTransferFrom(msg.sender, address(this), _netAmount); unchecked { // unchecked as no possibility of overflow with baseToken precision balance += _netAmount; } emit EntityDonationReceived(msg.sender, address(this), address(baseToken), _amount, _amount, _fee); } /** * @notice Receive a donated amount of ETH or ERC20 tokens, swaps them to base tokens, and adds the output to the * entity's balance. Fee calculated using default rate and sent to treasury. * @param _swapWrapper The swap wrapper to use for the donation. Must be whitelisted on the Registry. * @param _tokenIn The address of the ERC20 token to swap and donate, or ETH_PLACEHOLDER if donating ETH. * @param _amountIn The amount of tokens or ETH being swapped and donated. * @param _data Additional call data required by the ISwapWrapper being used. */ function swapAndDonate( ISwapWrapper _swapWrapper, address _tokenIn, uint256 _amountIn, bytes calldata _data ) external virtual payable { uint32 _feeMultiplier = registry.getDonationFee(this); _swapAndDonateWithFeeMultiplier(_swapWrapper, _tokenIn, _amountIn, _data, _feeMultiplier); } /** * @notice Receive a donated amount of ETH or ERC20 tokens, swaps them to base tokens, and adds the output to the * entity's balance. Fee calculated using override rate and sent to treasury. * @param _swapWrapper The swap wrapper to use for the donation. Must be whitelisted on the Registry. * @param _tokenIn The address of the ERC20 token to swap and donate, or ETH_PLACEHOLDER if donating ETH. * @param _amountIn The amount of tokens or ETH being swapped and donated. * @param _data Additional call data required by the ISwapWrapper being used. */ function swapAndDonateWithOverrides( ISwapWrapper _swapWrapper, address _tokenIn, uint256 _amountIn, bytes calldata _data ) external virtual payable { uint32 _feeMultiplier = registry.getDonationFeeWithOverrides(this); _swapAndDonateWithFeeMultiplier(_swapWrapper, _tokenIn, _amountIn, _data, _feeMultiplier); } /// @dev Internal helper implementing swap and donate functionality for any fee multiplier provided. function _swapAndDonateWithFeeMultiplier( ISwapWrapper _swapWrapper, address _tokenIn, uint256 _amountIn, bytes calldata _data, uint32 _feeMultiplier ) nonReentrant internal virtual { if (!registry.isSwapperSupported(_swapWrapper)) revert InvalidAction(); // THINK: do we need a re-entrancy guard on this method? if (_tokenIn != ETH_PLACEHOLDER) { ERC20(_tokenIn).safeTransferFrom(msg.sender, address(this), _amountIn); ERC20(_tokenIn).safeApprove(address(_swapWrapper), 0); ERC20(_tokenIn).safeApprove(address(_swapWrapper), _amountIn); } uint256 _amountOut = _swapWrapper.swap{value: msg.value}( _tokenIn, address(baseToken), address(this), _amountIn, _data ); (uint256 _netAmount, uint256 _fee) = _calculateFee(_amountOut, _feeMultiplier); baseToken.safeTransfer(registry.treasury(), _fee); unchecked { // unchecked as no possibility of overflow with baseToken precision balance += _netAmount; } if(balance > baseToken.balanceOf(address(this))) revert BalanceMismatch(); emit EntityDonationReceived(msg.sender, address(this), _tokenIn, _amountIn, _amountOut, _fee); } /** * @notice Transfers an amount of base tokens from one entity to another. Transfers default fee to treasury. * @param _to The entity to receive the tokens. * @param _amount Contains the amount being donated (denominated in the base token's units). * @dev Reverts if the entity is inactive or if the token transfer fails. * @dev Reverts if the transfer fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). * @dev Reverts with `Unauthorized` if the `msg.sender` is not the entity manager or a privileged role. * @dev Renamed from `transfer` to distinguish from ERC20 transfer in 3rd party tools. */ function transferToEntity(Entity _to, uint256 _amount) requiresManager external virtual { uint32 _feeMultiplier = registry.getTransferFee(this, _to); _transferWithFeeMultiplier(_to, _amount, _feeMultiplier); } /** * @notice Transfers an amount of base tokens from one entity to another. Transfers default or overridden fee to treasury. * @param _to The entity to receive the tokens. * @param _amount Contains the amount being donated (denominated in the base token's units). * @dev Reverts if the entity is inactive or if the token transfer fails. * @dev Reverts if the transfer fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). * @dev Reverts with `Unauthorized` if the `msg.sender` is not the entity manager or a privileged role. */ function transferToEntityWithOverrides(Entity _to, uint256 _amount) requiresManager external virtual { uint32 _feeMultiplier = registry.getTransferFeeWithOverrides(this, _to); _transferWithFeeMultiplier(_to, _amount, _feeMultiplier); } /** * @notice Transfers an amount of base tokens from one entity to another. Transfers fee specified by a privileged role. * @param _to The entity to receive the tokens. * @param _amount Contains the amount being donated (denominated in the base token's units). * @param _feeOverride Admin override configured by an Admin * @dev Reverts if the entity is inactive or if the token transfer fails. * @dev Reverts if the transfer fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). * @dev Reverts with `Unauthorized` if the `msg.sender` is not a privileged role. */ function transferToEntityWithAdminOverrides(Entity _to, uint256 _amount, uint32 _feeOverride) requiresAuth external virtual { _transferWithFeeMultiplier(_to, _amount, _feeOverride); } /** * @notice Transfers an amount of base tokens from one entity to another. Transfers fee calculated by fee multiplier to treasury. * @param _to The entity to receive the tokens. * @param _amount Contains the amount being donated (denominated in the base token's units). * @param _feeMultiplier Value indicating the percentage of the Endaoment donation fee to go to the Endaoment treasury. * @dev Reverts with 'Inactive' if the entity sending the transfer or the entity receiving the transfer is inactive. * @dev Reverts if the transfer fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). * @dev Reverts with `Unauthorized` if the `msg.sender` is not the entity manager or a privileged role. * @dev Reverts if the token transfer fails. */ function _transferWithFeeMultiplier(Entity _to, uint256 _amount, uint32 _feeMultiplier) internal virtual { if (!registry.isActiveEntity(this) || !registry.isActiveEntity(_to)) revert EntityInactive(); if (balance < _amount) revert InsufficientFunds(); (uint256 _netAmount, uint256 _fee) = _calculateFee(_amount, _feeMultiplier); baseToken.safeTransfer(registry.treasury(), _fee); baseToken.safeTransfer(address(_to), _netAmount); unchecked { // unchecked as no possibility of overflow with baseToken precision balance -= _amount; _to.receiveTransfer(_netAmount); } emit EntityValueTransferred(address(this), address(_to), _amount, _fee); } /** * @notice Updates the receiving entity balance on a transfer. * @param _transferAmount The amount being received on the transfer. * @dev This function is external, but is restricted such that it can only be called by other entities. */ function receiveTransfer(uint256 _transferAmount) external virtual { if (!registry.isActiveEntity(Entity(payable(msg.sender)))) revert EntityInactive(); unchecked { // Cannot overflow with realistic balances. balance += _transferAmount; } } /** * @notice Deposits an amount of Entity's `baseToken` into an Endaoment-approved Portfolio. * @param _portfolio An Endaoment-approved portfolio. * @param _amount Amount of `baseToken` to deposit into the portfolio. * @param _data Data required by a portfolio to deposit. * @return _shares Amount of portfolio share tokens Entity received as a result of this deposit. */ function portfolioDeposit(Portfolio _portfolio, uint256 _amount, bytes calldata _data) external virtual requiresManager returns (uint256) { if(!registry.isActivePortfolio(_portfolio)) revert PortfolioInactive(); balance -= _amount; baseToken.safeApprove(address(_portfolio), _amount); uint256 _shares = _portfolio.deposit(_amount, _data); emit EntityDeposit(address(_portfolio), _amount, _shares); return _shares; } /** * @notice Redeems an amount of Entity's portfolio shares for an amount of `baseToken`. * @param _portfolio An Endaoment-approved portfolio. * @param _shares Amount of share tokens to redeem. * @param _data Data required by a portfolio to redeem. * @return _received Amount of `baseToken` Entity received as a result of this redemption. */ function portfolioRedeem(Portfolio _portfolio, uint256 _shares, bytes calldata _data) external virtual requiresManager returns (uint256) { if(!registry.isActivePortfolio(_portfolio)) revert PortfolioInactive(); uint256 _received = _portfolio.redeem(_shares, _data); // unchecked: a realistic balance can never overflow a uint256 unchecked { balance += _received; } emit EntityRedeem(address(_portfolio), _shares, _received); return _received; } /** * @notice This method should be called to reconcile the Entity's internal baseToken accounting with the baseToken contract's accounting. * There are a 2 situations where calling this method is appropriate: * 1. To process amounts of baseToken that arrived at this Entity through methods besides Entity:donate or Entity:transfer. For example, * if this Entity receives a normal ERC20 transfer of baseToken, the amount received will be unavailable for Entity use until this method * is called to adjust the balance and process fees. OrgFundFactory.sol:_donate makes use of this method to do this as well. * 2. Unusually, the Entity's perspective of balance could be lower than `baseToken.balanceOf(this)`. This could happen if * Entity:callAsEntity is used to transfer baseToken. In this case, this method provides a way of correcting the Entity's internal balance. */ function reconcileBalance() external virtual { uint256 _tokenBalance = baseToken.balanceOf(address(this)); if (_tokenBalance >= balance) { uint256 _sweepAmount = _tokenBalance - balance; uint32 _feeMultiplier = registry.getDonationFeeWithOverrides(this); (uint256 _netAmount, uint256 _fee) = _calculateFee(_sweepAmount, _feeMultiplier); baseToken.safeTransfer(registry.treasury(), _fee); unchecked { balance += _netAmount; } emit EntityBalanceReconciled(address(this), _sweepAmount, _fee); } else { // Handle abnormal scenario where _tokenBalance < balance (see method docs) balance = _tokenBalance; emit EntityBalanceCorrected(address(this), _tokenBalance); } } /** * @notice Takes stray tokens or ETH sent directly to this Entity, swaps them for base token, then adds them to the * Entity's balance after paying the appropriate fee to the treasury. * @param _swapWrapper The swap wrapper to use to convert the assets. Must be whitelisted on the Registry. * @param _tokenIn The address of the ERC20 token to swap, or ETH_PLACEHOLDER if ETH. * @param _amountIn The amount of tokens or ETH being swapped and added to the balance. * @param _data Additional call data required by the ISwapWrapper being used. */ function swapAndReconcileBalance( ISwapWrapper _swapWrapper, address _tokenIn, uint256 _amountIn, bytes calldata _data ) nonReentrant external virtual requiresManager { if (!registry.isSwapperSupported(_swapWrapper)) revert InvalidAction(); uint32 _feeMultiplier = registry.getDonationFeeWithOverrides(this); if (_tokenIn != ETH_PLACEHOLDER) { ERC20(_tokenIn).safeApprove(address(_swapWrapper), 0); ERC20(_tokenIn).safeApprove(address(_swapWrapper), _amountIn); } // Send value only if token in is ETH uint256 _value = _tokenIn == ETH_PLACEHOLDER ? _amountIn : 0; uint256 _amountOut = _swapWrapper.swap{value: _value}( _tokenIn, address(baseToken), address(this), _amountIn, _data ); (uint256 _netAmount, uint256 _fee) = _calculateFee(_amountOut, _feeMultiplier); baseToken.safeTransfer(registry.treasury(), _fee); unchecked { // unchecked as no possibility of overflow with baseToken precision balance += _netAmount; } if(balance > baseToken.balanceOf(address(this))) revert BalanceMismatch(); emit EntityBalanceReconciled(address(this), _amountOut, _fee); } /** * @notice Permissioned method that allows Endaoment admin to make arbitrary calls acting as this Entity. * @param _target The address to which the call will be made. * @param _value The ETH value that should be forwarded with the call. * @param _data The calldata that will be sent with the call. * @return _return The data returned by the call. */ function callAsEntity( address _target, uint256 _value, bytes memory _data ) external virtual payable requiresAuth returns (bytes memory) { (bool _success, bytes memory _response) = payable(_target).call{value: _value}(_data); if (!_success) revert CallFailed(_response); return _response; } /** * @notice Pays out an amount of base tokens from the entity to an address. Transfers the fee calculated by the * default fee multiplier to the treasury. * @param _to The address to receive the tokens. * @param _amount Amount donated in base token. * @dev Reverts with `Unauthorized` if the `msg.sender` is not a privileged role. * @dev Reverts if the fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). * @dev Reverts if the token transfer fails. */ function payout(address _to, uint256 _amount) external virtual requiresAuth { uint32 _feeMultiplier = registry.getPayoutFee(this); _payoutWithFeeMultiplier(_to, _amount, _feeMultiplier); } /** * @notice Pays out an amount of base tokens from the entity to an address. Transfers the fee calculated by the * default fee multiplier to the treasury. * @param _amount Amount donated in base token. * @dev Reverts with `Unauthorized` if the `msg.sender` is not a privileged role. * @dev Reverts if the fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). * @dev Reverts if the token transfer fails. */ function payoutWithOverrides(address _to, uint256 _amount) external virtual requiresAuth { uint32 _feeMultiplier = registry.getPayoutFeeWithOverrides(this); _payoutWithFeeMultiplier(_to, _amount, _feeMultiplier); } /** * @notice Pays out an amount of base tokens from the entity to an address. Transfers fee specified by a privileged role. * @param _amount Amount donated in base token. * @param _feeOverride Payout override configured by an Admin * @dev Reverts with `Unauthorized` if the `msg.sender` is not a privileged role. * @dev Reverts if the fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). * @dev Reverts if the token transfer fails. */ function payoutWithAdminOverrides(address _to, uint256 _amount, uint32 _feeOverride) external virtual requiresAuth { _payoutWithFeeMultiplier(_to, _amount, _feeOverride); } /** * @notice Pays out an amount of base tokens from the entity to an address. Transfers the fee calculated by fee multiplier to the treasury. * @param _to The address to receive the tokens. * @param _amount Contains the amount being paid out (denominated in the base token's units). * @param _feeMultiplier Value indicating the percentage of the Endaoment fee to go to the Endaoment treasury. * @dev Reverts if the token transfer fails. * @dev Reverts if the fee percentage is larger than 100% (equal to 1e4 when represented as a zoc). */ function _payoutWithFeeMultiplier(address _to, uint256 _amount, uint32 _feeMultiplier) internal virtual { if (balance < _amount) revert InsufficientFunds(); (uint256 _netAmount, uint256 _fee) = _calculateFee(_amount, _feeMultiplier); baseToken.safeTransfer(registry.treasury(), _fee); baseToken.safeTransfer(address(_to), _netAmount); unchecked { // unchecked because we've already validated that amount is less than or equal to the balance balance -= _amount; } emit EntityValuePaidOut(address(this), _to, _amount, _fee); } /// @dev Internal helper method to calculate the fee on a base token amount for a given fee multiplier. function _calculateFee( uint256 _amount, uint256 _feeMultiplier ) internal virtual pure returns (uint256 _netAmount, uint256 _fee) { if (_feeMultiplier > Math.ZOC) revert InvalidAction(); unchecked { // unchecked as no possibility of overflow with baseToken precision _fee = _amount.zocmul(_feeMultiplier); // unchecked as the _feeMultiplier check with revert above protects against overflow _netAmount = _amount - _fee; } } receive() external virtual payable { emit EntityEthReceived(msg.sender, msg.value); } } //SPDX-License-Identifier: BSD 3-Clause pragma solidity 0.8.13; import { Registry } from "./Registry.sol"; import { Entity } from "./Entity.sol"; /** * @notice Fund entity */ contract Fund is Entity { /** * @notice One time method to be called at deployment to configure the contract. Required so Fund * contracts can be deployed as minimal proxies (clones). * @param _registry The registry to host the Fund Entity. * @param _manager The address of the Fund's manager. */ function initialize(Registry _registry, address _manager) public { // Call to Entity's initialization function ensures this can only be called once __initEntity(_registry, _manager); } /** * @inheritdoc Entity */ function entityType() public pure override returns (uint8) { return 2; } } //SPDX-License-Identifier: BSD 3-Clause pragma solidity >=0.8.0; import { ERC20 } from "solmate/tokens/ERC20.sol"; import { Registry } from "./Registry.sol"; import { Entity } from "./Entity.sol"; import { EndaomentAuth } from "./lib/auth/EndaomentAuth.sol"; import { RolesAuthority } from "./lib/auth/authorities/RolesAuthority.sol"; import { Math } from "./lib/Math.sol"; abstract contract Portfolio is ERC20, EndaomentAuth { using Math for uint256; Registry public immutable registry; uint256 public cap; uint256 public depositFee; uint256 public redemptionFee; address public immutable asset; bool public didShutdown; error InvalidSwapper(); error TransferDisallowed(); error DepositAfterShutdown(); error DidShutdown(); error NotEntity(); error ExceedsCap(); error PercentageOver100(); error RoundsToZero(); error CallFailed(bytes response); /// @notice `sender` has exchanged `assets` (after fees) for `shares`, and transferred those `shares` to `receiver`. /// The sender paid a total of `depositAmount` and was charged `fee` for the transaction. event Deposit( address indexed sender, address indexed receiver, uint256 assets, uint256 shares, uint256 depositAmount, uint256 fee ); /// @notice `sender` has exchanged `shares` for `assets`, and transferred those `assets` to `receiver`. /// The sender received a net of `redeemedAmount` after the conversion of `assets` into base tokens /// and was charged `fee` for the transaction. event Redeem( address indexed sender, address indexed receiver, uint256 assets, uint256 shares, uint256 redeemedAmount, uint256 fee ); /// @notice Event emitted when `cap` is set. event CapSet(uint256 cap); /// @notice Event emitted when `depositFee` is set. event DepositFeeSet(uint256 fee); /// @notice Event emitted when `redemptionFee` is set. event RedemptionFeeSet(uint256 fee); /// @notice Event emitted when management takes fees. event FeesTaken(uint256 amount); /// @notice Event emitted when admin forcefully swaps portfolio asset balance for baseToken. event Shutdown(uint256 assetAmount, uint256 baseTokenOut); /** * @param _registry Endaoment registry. * @param _name Name of the ERC20 Portfolio share tokens. * @param _symbol Symbol of the ERC20 Portfolio share tokens. * @param _cap Amount in baseToken that value of totalAssets should not exceed. * @param _depositFee Percentage fee as ZOC that will go to treasury on asset deposit. * @param _redemptionFee Percentage fee as ZOC that will go to treasury on share redemption. */ constructor(Registry _registry, address _asset, string memory _name, string memory _symbol, uint256 _cap, uint256 _depositFee, uint256 _redemptionFee) ERC20(_name, _symbol, ERC20(_asset).decimals()) { registry = _registry; if(_redemptionFee > Math.ZOC) revert PercentageOver100(); depositFee = _depositFee; redemptionFee = _redemptionFee; cap = _cap; asset = _asset; __initEndaomentAuth(_registry, "portfolio"); } /** * @notice Function used to determine whether an Entity is active on the registry. * @param _entity The Entity. */ function _isEntity(Entity _entity) internal view returns (bool) { return registry.isActiveEntity(_entity); } /** * @notice Set the Portfolio cap. * @param _amount Amount, denominated in baseToken. */ function setCap(uint256 _amount) external virtual requiresAuth { cap = _amount; emit CapSet(_amount); } /** * @notice Set deposit fee. * @param _pct Percentage as ZOC (e.g. 1000 = 10%). */ function setDepositFee(uint256 _pct) external virtual requiresAuth { if(_pct > Math.ZOC) revert PercentageOver100(); depositFee = _pct; emit DepositFeeSet(_pct); } /** * @notice Set redemption fee. * @param _pct Percentage as ZOC (e.g. 1000 = 10%). */ function setRedemptionFee(uint256 _pct) external virtual requiresAuth { if(_pct > Math.ZOC) revert PercentageOver100(); redemptionFee = _pct; emit RedemptionFeeSet(_pct); } /** * @notice Total amount of the underlying asset that is managed by the Portfolio. */ function totalAssets() external view virtual returns (uint256); /** * @notice Takes some amount of assets from this portfolio as assets under management fee. * @param _amountAssets Amount of assets to take. */ function takeFees(uint256 _amountAssets) external virtual; /** * @notice Exchange `_amountBaseToken` for some amount of Portfolio shares. * @param _amountBaseToken The amount of the Entity's baseToken to deposit. * @param _data Data that the portfolio needs to make the deposit. In some cases, this will be swap parameters. * @return shares The amount of shares that this deposit yields to the Entity. */ function deposit(uint256 _amountBaseToken, bytes calldata _data) virtual external returns (uint256 shares); /** * @notice Exchange `_amountShares` for some amount of baseToken. * @param _amountShares The amount of the Entity's portfolio shares to exchange. * @param _data Data that the portfolio needs to make the redemption. In some cases, this will be swap parameters. * @return baseTokenOut The amount of baseToken that this redemption yields to the Entity. */ function redeem(uint256 _amountShares, bytes calldata _data) virtual external returns (uint256 baseTokenOut); /** * @notice Calculates the amount of shares that the Portfolio should exchange for the amount of assets provided. * @param _amountAssets Amount of assets. */ function convertToShares(uint256 _amountAssets) virtual public view returns (uint256); /** * @notice Calculates the amount of assets that the Portfolio should exchange for the amount of shares provided. * @param _amountShares Amount of shares. */ function convertToAssets(uint256 _amountShares) virtual public view returns (uint256); /** * @notice Exit out all assets of portfolio for baseToken. Must persist a mechanism for entities to redeem their shares for baseToken. * @param _data Data that the portfolio needs to exit from asset. In some cases, this will be swap parameters. * @return baseTokenOut The amount of baseToken that this exit yielded. */ function shutdown(bytes calldata _data) virtual external returns (uint256 baseTokenOut); /// @notice `transfer` disabled on Portfolio tokens. function transfer(address /** to */, uint256 /** amount */) public pure override returns (bool) { revert TransferDisallowed(); } /// @notice `transferFrom` disabled on Portfolio tokens. function transferFrom(address /** from */, address /** to */, uint256 /** amount */) public pure override returns (bool) { revert TransferDisallowed(); } /// @notice `approve` disabled on Portfolio tokens. function approve(address /** to */, uint256 /** amount */) public pure override returns (bool) { revert TransferDisallowed(); } /// @notice `permit` disabled on Portfolio tokens. function permit( address /* owner */, address /* spender */, uint256 /* value */, uint256 /* deadline */, uint8 /* v */, bytes32 /* r */, bytes32 /* s */ ) public pure override { revert TransferDisallowed(); } /** * @notice Permissioned method that allows Endaoment admin to make arbitrary calls acting as this Portfolio. * @param _target The address to which the call will be made. * @param _value The ETH value that should be forwarded with the call. * @param _data The calldata that will be sent with the call. * @return _return The data returned by the call. */ function callAsPortfolio( address _target, uint256 _value, bytes memory _data ) external payable requiresAuth returns (bytes memory) { (bool _success, bytes memory _response) = payable(_target).call{value: _value}(_data); if (!_success) revert CallFailed(_response); return _response; } /// @dev Internal helper method to calculate the fee on a base token amount for a given fee multiplier. function _calculateFee( uint256 _amount, uint256 _feeMultiplier ) internal pure returns (uint256 _netAmount, uint256 _fee) { if (_feeMultiplier > Math.ZOC) revert PercentageOver100(); unchecked { // unchecked as no possibility of overflow with baseToken precision _fee = _amount.zocmul(_feeMultiplier); // unchecked as the _feeMultiplier check with revert above protects against overflow _netAmount = _amount - _fee; } } } //SPDX-License-Identifier: BSD 3-Clause pragma solidity 0.8.13; import { Math } from "./lib/Math.sol"; import { ERC20 } from "solmate/tokens/ERC20.sol"; import { Auth, Authority } from "./lib/auth/Auth.sol"; import { SafeTransferLib } from "solmate/utils/SafeTransferLib.sol"; import { RegistryAuth } from "./RegistryAuth.sol"; import { Entity } from "./Entity.sol"; import { ISwapWrapper } from "./interfaces/ISwapWrapper.sol"; import { Portfolio } from "./Portfolio.sol"; // --- Errors --- error Unauthorized(); error UnsupportedSwapper(); /** * @notice Registry entity - manages Factory and Entity state info. */ contract Registry is RegistryAuth { // --- Storage --- /// @notice Treasury address can receives fees. address public treasury; /// @notice Base Token address is the stable coin contract used throughout the system. ERC20 public immutable baseToken; /// @notice Mapping of approved factory contracts that are allowed to register new Entities. mapping (address => bool) public isApprovedFactory; /// @notice Mapping of active status of entities. mapping (Entity => bool) public isActiveEntity; /// @notice Maps entity type to donation fee percentage stored as a zoc, where type(uint32).max represents 0. mapping (uint8 => uint32) defaultDonationFee; /// @notice Maps specific entity receiver to donation fee percentage stored as a zoc. mapping (Entity => uint32) donationFeeReceiverOverride; /// @notice Maps entity type to payout fee percentage stored as a zoc, where type(uint32).max represents 0. mapping (uint8 => uint32) defaultPayoutFee; /// @notice Maps specific entity sender to payout fee percentage stored as a zoc. mapping (Entity => uint32) payoutFeeOverride; /// @notice Maps sender entity type to receiver entity type to fee percentage as a zoc. mapping (uint8 => mapping(uint8 => uint32)) defaultTransferFee; /// @notice Maps specific entity sender to receiver entity type to fee percentage as a zoc. mapping (Entity => mapping(uint8 => uint32)) transferFeeSenderOverride; /// @notice Maps sender entity type to specific entity receiver to fee percentage as a zoc. mapping (uint8 => mapping(Entity => uint32)) transferFeeReceiverOverride; /// @notice Maps swap wrappers to their enabled/disabled status. mapping (ISwapWrapper => bool) public isSwapperSupported; /// @notice Maps portfolios to their enabled/disabled status. mapping (Portfolio => bool) public isActivePortfolio; // --- Events --- /// @notice The event emitted when a factory is approved (whitelisted) or has it's approval removed. event FactoryApprovalSet(address indexed factory, bool isApproved); /// @notice The event emitted when an entity is set active or inactive. event EntityStatusSet(address indexed entity, bool isActive); /// @notice The event emitted when a swap wrapper is set active or inactive. event SwapWrapperStatusSet(address indexed swapWrapper, bool isSupported); /// @notice The event emitted when a portfolio is set active or inactive. event PortfolioStatusSet(address indexed portfolio, bool isActive); /// @notice Emitted when a default donation fee is set for an entity type. event DefaultDonationFeeSet(uint8 indexed entityType, uint32 fee); /// @notice Emitted when a donation fee override is set for a specific receiving entity. event DonationFeeReceiverOverrideSet(address indexed entity, uint32 fee); /// @notice Emitted when a default payout fee is set for an entity type. event DefaultPayoutFeeSet(uint8 indexed entityType, uint32 fee); /// @notice Emitted when a payout fee override is set for a specific sender entity. event PayoutFeeOverrideSet(address indexed entity, uint32 fee); /// @notice Emitted when a default transfer fee is set for transfers between entity types. event DefaultTransferFeeSet(uint8 indexed fromEntityType, uint8 indexed toEntityType, uint32 fee); /// @notice Emitted when a transfer fee override is set for transfers from an entity to a specific entityType. event TransferFeeSenderOverrideSet(address indexed fromEntity, uint8 indexed toEntityType, uint32 fee); /// @notice Emitted when a transfer fee override is set for transfers from an entityType to an entity. event TransferFeeReceiverOverrideSet(uint8 indexed fromEntityType, address indexed toEntity, uint32 fee); /// @notice Emitted when the registry treasury contract is changed event TreasuryChanged(address oldTreasury, address indexed newTreasury); /** * @notice Modifier for methods that require auth and that the manager cannot access. * @dev Overridden from Auth.sol. Reason: use custom error. */ modifier requiresAuth override { if(!isAuthorized(msg.sender, msg.sig)) revert Unauthorized(); _; } // --- Constructor --- constructor(address _admin, address _treasury, ERC20 _baseToken) RegistryAuth(_admin, Authority(address(this))) { treasury = _treasury; emit TreasuryChanged(address(0), _treasury); baseToken = _baseToken; } // --- Internal fns --- /** * @notice Fee parsing to convert the special "type(uint32).max" value to zero, and zero to the "max". * @dev After converting, "type(uint32).max" will cause overflow/revert when used as a fee percentage multiplier and zero will mean no fee. * @param _value The value to be converted. * @return The parsed fee to use. */ function _parseFeeWithFlip(uint32 _value) private pure returns (uint32) { if (_value == 0) { return type(uint32).max; } else if (_value == type(uint32).max) { return 0; } else { return _value; } } // --- External fns --- /** * @notice Sets a new Endaoment treasury address. * @param _newTreasury The new treasury. */ function setTreasury(address _newTreasury) external requiresAuth { emit TreasuryChanged(treasury, _newTreasury); treasury = _newTreasury; } /** * @notice Sets the approval state of a factory. Grants the factory permissions to set entity status. * @param _factory The factory whose approval state is to be updated. * @param _isApproved True if the factory should be approved, false otherwise. */ function setFactoryApproval(address _factory, bool _isApproved) external requiresAuth { isApprovedFactory[_factory] = _isApproved; emit FactoryApprovalSet(address(_factory), _isApproved); } /** * @notice Sets the enable/disable state of an Entity. * @param _entity The entity whose active state is to be updated. * @param _isActive True if the entity should be active, false otherwise. */ function setEntityStatus(Entity _entity, bool _isActive) external requiresAuth { isActiveEntity[_entity] = _isActive; emit EntityStatusSet(address(_entity), _isActive); } /** * @notice Sets Entity as active. This is a special method to be called only by approved factories. * Other callers should use `setEntityStatus` instead. * @param _entity The entity. */ function setEntityActive(Entity _entity) external { if(!isApprovedFactory[msg.sender]) revert Unauthorized(); isActiveEntity[_entity] = true; emit EntityStatusSet(address(_entity), true); } /** * @notice Sets the enable/disable state of a Portfolio. * @param _portfolio Portfolio. * @param _isActive True if setting portfolio to active, false otherwise. */ function setPortfolioStatus(Portfolio _portfolio, bool _isActive) external requiresAuth { isActivePortfolio[_portfolio] = _isActive; emit PortfolioStatusSet(address(_portfolio), _isActive); } /** * @notice Gets default donation fee pct (as a zoc) for an Entity. * @param _entity The receiving entity of the donation for which the fee is being fetched. * @return uint32 The default donation fee for the entity's type. * @dev Makes use of _parseFeeWithFlip, so if no default exists, "max" will be returned. */ function getDonationFee(Entity _entity) external view returns (uint32) { return _parseFeeWithFlip(defaultDonationFee[_entity.entityType()]); } /** * @notice Gets lowest possible donation fee pct (as a zoc) for an Entity, among default and override. * @param _entity The receiving entity of the donation for which the fee is being fetched. * @return uint32 The minimum of the default donation fee and the receiver's fee override. * @dev Makes use of _parseFeeWithFlip, so if no default or override exists, "max" will be returned. */ function getDonationFeeWithOverrides(Entity _entity) external view returns (uint32) { uint32 _default = _parseFeeWithFlip(defaultDonationFee[_entity.entityType()]); uint32 _receiverOverride = _parseFeeWithFlip(donationFeeReceiverOverride[_entity]); return _receiverOverride < _default ? _receiverOverride : _default; } /** * @notice Gets default payout fee pct (as a zoc) for an Entity. * @param _entity The sender entity of the payout for which the fee is being fetched. * @return uint32 The default payout fee for the entity's type. * @dev Makes use of _parseFeeWithFlip, so if no default exists, "max" will be returned. */ function getPayoutFee(Entity _entity) external view returns (uint32) { return _parseFeeWithFlip(defaultPayoutFee[_entity.entityType()]); } /** * @notice Gets lowest possible payout fee pct (as a zoc) for an Entity, among default and override. * @param _entity The sender entity of the payout for which the fee is being fetched. * @return uint32 The minimum of the default payout fee and the sender's fee override. * @dev Makes use of _parseFeeWithFlip, so if no default or override exists, "max" will be returned. */ function getPayoutFeeWithOverrides(Entity _entity) external view returns (uint32) { uint32 _default = _parseFeeWithFlip(defaultPayoutFee[_entity.entityType()]); uint32 _senderOverride = _parseFeeWithFlip(payoutFeeOverride[_entity]); return _senderOverride < _default ? _senderOverride : _default; } /** * @notice Gets default transfer fee pct (as a zoc) between sender & receiver Entities. * @param _sender The sending entity of the transfer for which the fee is being fetched. * @param _receiver The receiving entity of the transfer for which the fee is being fetched. * @return uint32 The default transfer fee. * @dev Makes use of _parseFeeWithFlip, so if no default exists, "type(uint32).max" will be returned. */ function getTransferFee(Entity _sender, Entity _receiver) external view returns (uint32) { return _parseFeeWithFlip(defaultTransferFee[_sender.entityType()][_receiver.entityType()]); } /** * @notice Gets lowest possible transfer fee pct (as a zoc) between sender & receiver Entities, among default and overrides. * @param _sender The sending entity of the transfer for which the fee is being fetched. * @param _receiver The receiving entity of the transfer for which the fee is being fetched. * @return uint32 The minimum of the default transfer fee, and sender and receiver overrides. * @dev Makes use of _parseFeeWithFlip, so if no default or overrides exist, "type(uint32).max" will be returned. */ function getTransferFeeWithOverrides(Entity _sender, Entity _receiver) external view returns (uint32) { uint32 _default = _parseFeeWithFlip(defaultTransferFee[_sender.entityType()][_receiver.entityType()]); uint32 _senderOverride = _parseFeeWithFlip(transferFeeSenderOverride[_sender][_receiver.entityType()]); uint32 _receiverOverride = _parseFeeWithFlip(transferFeeReceiverOverride[_sender.entityType()][_receiver]); uint32 _lowestFee = _default; _lowestFee = _senderOverride < _lowestFee ? _senderOverride : _lowestFee; _lowestFee = _receiverOverride < _lowestFee ? _receiverOverride : _lowestFee; return _lowestFee; } /** * @notice Sets the default donation fee for an entity type. * @param _entityType Entity type. * @param _fee The fee percentage to be set (a zoc). */ function setDefaultDonationFee(uint8 _entityType, uint32 _fee) external requiresAuth { defaultDonationFee[_entityType] = _parseFeeWithFlip(_fee); emit DefaultDonationFeeSet(_entityType, _fee); } /** * @notice Sets the donation fee receiver override for a specific entity. * @param _entity Entity. * @param _fee The overriding fee (a zoc). */ function setDonationFeeReceiverOverride(Entity _entity, uint32 _fee) external requiresAuth { donationFeeReceiverOverride[_entity] = _parseFeeWithFlip(_fee); emit DonationFeeReceiverOverrideSet(address(_entity), _fee); } /** * @notice Sets the default payout fee for an entity type. * @param _entityType Entity type. * @param _fee The fee percentage to be set (a zoc). */ function setDefaultPayoutFee(uint8 _entityType, uint32 _fee) external requiresAuth { defaultPayoutFee[_entityType] = _parseFeeWithFlip(_fee); emit DefaultPayoutFeeSet(_entityType, _fee); } /** * @notice Sets the payout fee override for a specific entity. * @param _entity Entity. * @param _fee The overriding fee (a zoc). */ function setPayoutFeeOverride(Entity _entity, uint32 _fee) external requiresAuth { payoutFeeOverride[_entity] = _parseFeeWithFlip(_fee); emit PayoutFeeOverrideSet(address(_entity), _fee); } /** * @notice Sets the default transfer fee for transfers from one specific entity type to another. * @param _fromEntityType The entityType making the transfer. * @param _toEntityType The receiving entityType. * @param _fee The transfer fee percentage (a zoc). */ function setDefaultTransferFee(uint8 _fromEntityType, uint8 _toEntityType, uint32 _fee) external requiresAuth { defaultTransferFee[_fromEntityType][_toEntityType] = _parseFeeWithFlip(_fee); emit DefaultTransferFeeSet(_fromEntityType, _toEntityType, _fee); } /** * @notice Sets the transfer fee override for transfers from one specific entity to entities of a given type. * @param _fromEntity The entity making the transfer. * @param _toEntityType The receiving entityType. * @param _fee The overriding fee percentage (a zoc). */ function setTransferFeeSenderOverride(Entity _fromEntity, uint8 _toEntityType, uint32 _fee) external requiresAuth { transferFeeSenderOverride[_fromEntity][_toEntityType] = _parseFeeWithFlip(_fee); emit TransferFeeSenderOverrideSet(address(_fromEntity), _toEntityType, _fee); } /** * @notice Sets the transfer fee override for transfers from entities of a given type to a specific entity. * @param _fromEntityType The entityType making the transfer. * @param _toEntity The receiving entity. * @param _fee The overriding fee percentage (a zoc). */ function setTransferFeeReceiverOverride(uint8 _fromEntityType, Entity _toEntity, uint32 _fee) external requiresAuth { transferFeeReceiverOverride[_fromEntityType][_toEntity] = _parseFeeWithFlip(_fee); emit TransferFeeReceiverOverrideSet(_fromEntityType, address(_toEntity), _fee); } /** * @notice Sets the enable/disable state of a SwapWrapper. System owners must ensure meticulous review of SwapWrappers before approving them. * @param _swapWrapper A contract that implements ISwapWrapper. * @param _supported `true` if supported, `false` if unsupported. */ function setSwapWrapperStatus(ISwapWrapper _swapWrapper, bool _supported) external requiresAuth { isSwapperSupported[_swapWrapper] = _supported; emit SwapWrapperStatusSet(address(_swapWrapper), _supported); } } //SPDX-License-Identifier: BSD 3-Clause pragma solidity 0.8.13; import { Auth, Authority } from "./lib/auth/Auth.sol"; import { RolesAuthority } from "./lib/auth/authorities/RolesAuthority.sol"; // --- Errors --- error OwnershipInvalid(); /** * @notice RegistryAuth - contract to control ownership of the Registry. */ contract RegistryAuth is RolesAuthority { /// @notice Emitted when the first step of an ownership transfer (proposal) is done. event OwnershipTransferProposed(address indexed user, address indexed newOwner); /// @notice Emitted when the second step of an ownership transfer (claim) is done. event OwnershipChanged(address indexed owner, address indexed newOwner); // --- Storage --- /// @notice Pending owner for 2 step ownership transfer address public pendingOwner; // --- Constructor --- constructor(address _owner, Authority _authority) RolesAuthority(_owner, _authority) {} /** * @notice Starts the 2 step process of transferring registry authorization to a new owner. * @param _newOwner Proposed new owner of registry authorization. */ function transferOwnership(address _newOwner) external requiresAuth { pendingOwner = _newOwner; emit OwnershipTransferProposed(msg.sender, _newOwner); } /** * @notice Completes the 2 step process of transferring registry authorization to a new owner. * This function must be called by the proposed new owner. */ function claimOwnership() external { if (msg.sender != pendingOwner) revert OwnershipInvalid(); emit OwnershipChanged(owner, pendingOwner); owner = pendingOwner; pendingOwner = address(0); } /** * @notice Old approach of setting a new owner in a single step. * @dev This function throws an error to force use of the new 2-step approach. */ function setOwner(address /*newOwner*/ ) public view override requiresAuth { revert OwnershipInvalid(); } } //SPDX-License-Identifier: BSD 3-Clause pragma solidity >=0.8.0; error ETHAmountInMismatch(); /** * @notice ISwapWrapper is the interface that all swap wrappers should implement. * This will be used to support swap protocols like Uniswap V2 and V3, Sushiswap, 1inch, etc. */ interface ISwapWrapper { /// @notice Event emitted after a successful swap. event WrapperSwapExecuted(address indexed tokenIn, address indexed tokenOut, address sender, address indexed recipient, uint256 amountIn, uint256 amountOut); /// @notice Name of swap wrapper for UX readability. function name() external returns (string memory); /** * @notice Swap function. Generally we expect the implementer to call some exactAmountIn-like swap method, and so the documentation * is written with this in mind. However, the method signature is general enough to support exactAmountOut swaps as well. * @param _tokenIn Token to be swapped (or 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE for ETH). * @param _tokenOut Token to receive (or 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE for ETH). * @param _recipient Receiver of `_tokenOut`. * @param _amount Amount of `_tokenIn` that should be swapped. * @param _data Additional data that the swap wrapper may require to execute the swap. * @return Amount of _tokenOut received. */ function swap(address _tokenIn, address _tokenOut, address _recipient, uint256 _amount, bytes calldata _data) external payable returns (uint256); } // SPDX-License-Identifier: BSD 3-Clause pragma solidity 0.8.13; library Math { uint256 internal constant ZOC = 1e4; /** * @dev Multiply 2 numbers where at least one is a zoc, return product in original units of the other number. */ function zocmul(uint256 x, uint256 y) internal pure returns (uint256 z) { z = x * y; unchecked { z /= ZOC; } } // Below is WAD math from solmate's FixedPointMathLib. // https://github.com/Rari-Capital/solmate/blob/c8278b3cb948cffda3f1de5a401858035f262060/src/utils/FixedPointMathLib.sol uint256 internal constant WAD = 1e18; // The scalar of ETH and most ERC20s. function mulWadDown(uint256 x, uint256 y) internal pure returns (uint256) { return mulDivDown(x, y, WAD); // Equivalent to (x * y) / WAD rounded down. } function divWadDown(uint256 x, uint256 y) internal pure returns (uint256) { return mulDivDown(x, WAD, y); // Equivalent to (x * WAD) / y rounded down. } // For tokens with 6 decimals like USDC, these scale by 1e6 (one million). function mulMilDown(uint256 x, uint256 y) internal pure returns (uint256) { return mulDivDown(x, y, 1e6); // Equivalent to (x * y) / 1e6 rounded down. } function divMilDown(uint256 x, uint256 y) internal pure returns (uint256) { return mulDivDown(x, 1e6, y); // Equivalent to (x * 1e6) / y rounded down. } /*////////////////////////////////////////////////////////////// LOW LEVEL FIXED POINT OPERATIONS //////////////////////////////////////////////////////////////*/ function mulDivDown( uint256 x, uint256 y, uint256 denominator ) internal pure returns (uint256 z) { assembly { // Store x * y in z for now. z := mul(x, y) // Equivalent to require(denominator != 0 && (x == 0 || (x * y) / x == y)) if iszero(and(iszero(iszero(denominator)), or(iszero(x), eq(div(z, x), y)))) { revert(0, 0) } // Divide z by the denominator. z := div(z, denominator) } } } // SPDX-License-Identifier: AGPL-3.0-only pragma solidity >=0.8.0; /// @notice Gas optimized reentrancy protection for smart contracts. /// @author Modified Solmate (https://github.com/Rari-Capital/solmate/blob/main/src/utils/ReentrancyGuard.sol) /// @author Modified from OpenZeppelin (https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/contracts/security/ReentrancyGuard.sol) abstract contract ReentrancyGuard { uint256 private reentrancyStatus; error Reentrancy(); function __initReentrancyGuard() internal { if(reentrancyStatus != 0) revert Reentrancy(); reentrancyStatus = 1; } modifier nonReentrant() { if(reentrancyStatus != 1) revert Reentrancy(); reentrancyStatus = 2; _; reentrancyStatus = 1; } } // SPDX-License-Identifier: AGPL-3.0-only pragma solidity >=0.8.0; // This contract is modified from Solmate only to make requiresAuth virtual on line 26 /// @notice Provides a flexible and updatable auth pattern which is completely separate from application logic. /// @author Solmate (https://github.com/Rari-Capital/solmate/blob/main/src/auth/Auth.sol) /// @author Modified from Dappsys (https://github.com/dapphub/ds-auth/blob/master/src/auth.sol) abstract contract Auth { event OwnerUpdated(address indexed user, address indexed newOwner); event AuthorityUpdated(address indexed user, Authority indexed newAuthority); address public owner; Authority public authority; constructor(address _owner, Authority _authority) { owner = _owner; authority = _authority; emit OwnerUpdated(msg.sender, _owner); emit AuthorityUpdated(msg.sender, _authority); } modifier requiresAuth virtual { require(isAuthorized(msg.sender, msg.sig), "UNAUTHORIZED"); _; } function isAuthorized(address user, bytes4 functionSig) internal view virtual returns (bool) { Authority auth = authority; // Memoizing authority saves us a warm SLOAD, around 100 gas. // Checking if the caller is the owner only after calling the authority saves gas in most cases, but be // aware that this makes protected functions uncallable even to the owner if the authority is out of order. return (address(auth) != address(0) && auth.canCall(user, address(this), functionSig)) || user == owner; } function setAuthority(Authority newAuthority) public virtual { // We check if the caller is the owner first because we want to ensure they can // always swap out the authority even if it's reverting or using up a lot of gas. require(msg.sender == owner || authority.canCall(msg.sender, address(this), msg.sig)); authority = newAuthority; emit AuthorityUpdated(msg.sender, newAuthority); } function setOwner(address newOwner) public virtual requiresAuth { owner = newOwner; emit OwnerUpdated(msg.sender, newOwner); } } /// @notice A generic interface for a contract which provides authorization data to an Auth instance. /// @author Solmate (https://github.com/Rari-Capital/solmate/blob/main/src/auth/Auth.sol) /// @author Modified from Dappsys (https://github.com/dapphub/ds-auth/blob/master/src/auth.sol) interface Authority { function canCall( address user, address target, bytes4 functionSig ) external view returns (bool); } // SPDX-License-Identifier: AGPL-3.0-only pragma solidity >=0.8.0; import { RolesAuthority } from './authorities/RolesAuthority.sol'; /** * @notice An abstract Auth that contracts in the Endaoment ecosystem can inherit from. It is based on * the `Auth.sol` contract from Solmate, but does not inherit from it. Most of the functionality * is either slightly different, or not needed. In particular: * - EndaomentAuth uses an initializer such that it can be deployed with minimal proxies. * - EndaomentAuth contracts reference a RolesAuthority, not just an Authority, when looking up permissions. * In the Endaoment ecosystem, this is assumed to be the Registry. * - EndaomentAuth contracts do not have an owner, but instead grant ubiquitous permission to its RoleAuthority's * owner. In the Endaoment ecosystem, this is assumed to be the board of directors multi-sig. * - EndaomentAuth contracts can optionally declare themselves a "special target" at deploy time. Instead of passing * their address to the authority when looking up their permissions, they'll instead pass the special target bytes. * See documentation on `specialTarget` for more information. * */ abstract contract EndaomentAuth { /// @notice Thrown when an account without proper permissions calls a privileged method. error Unauthorized(); /// @notice Thrown if there is an attempt to deploy with address 0 as the authority. error InvalidAuthority(); /// @notice Thrown if there is a second call to initialize. error AlreadyInitialized(); /// @notice The contract used to source permissions for accounts targeting this contract. RolesAuthority public authority; /** * @notice If set to a non-zero value, this contract will pass these byes as the target contract * to the RolesAuthority's `canCall` method, rather than its own contract. This allows a single * RolesAuthority permission to manage permissions simultaneously for a group of contracts that * identify themselves as a certain type. For example: set a permission for all "entity" contracts. */ bytes20 public specialTarget; /** * @notice One time method to be called at deployment to configure the contract. Required so EndaomentAuth * contracts can be deployed as minimal proxies (clones). * @param _authority Contract that will be used to source permissions for accounts targeting this contract. * @param _specialTarget The bytes that this contract will pass as the "target" when looking up permissions * from the authority. If set to empty bytes, this contract will pass its own address instead. */ function __initEndaomentAuth(RolesAuthority _authority, bytes20 _specialTarget) internal virtual { if (address(_authority) == address(0)) revert InvalidAuthority(); if (address(authority) != address(0)) revert AlreadyInitialized(); authority = _authority; specialTarget = _specialTarget; } /** * @notice Modifier for methods that require authorization to execute. */ modifier requiresAuth virtual { if(!isAuthorized(msg.sender, msg.sig)) revert Unauthorized(); _; } /** * @notice Internal method that asks the authority whether the caller has permission to execute a method. * @param user The account attempting to call a permissioned method on this contract * @param functionSig The signature hash of the permissioned method being invoked. */ function isAuthorized(address user, bytes4 functionSig) internal virtual view returns (bool) { RolesAuthority auth = authority; // Memoizing authority saves us a warm SLOAD, around 100 gas. address _target = specialTarget == "" ? address(this) : address(specialTarget); // The caller has permission on authority, or the caller is the RolesAuthority owner return auth.canCall(user, _target, functionSig) || user == auth.owner(); } } // SPDX-License-Identifier: AGPL-3.0-only pragma solidity >=0.8.0; // This contract is modified from Solmate only to import modified Auth.sol on line 5 import {Auth, Authority} from "../Auth.sol"; /// @notice Role based Authority that supports up to 256 roles. /// @author Solmate (https://github.com/Rari-Capital/solmate/blob/main/src/auth/authorities/RolesAuthority.sol) /// @author Modified from Dappsys (https://github.com/dapphub/ds-roles/blob/master/src/roles.sol) contract RolesAuthority is Auth, Authority { /*/////////////////////////////////////////////////////////////// EVENTS //////////////////////////////////////////////////////////////*/ event UserRoleUpdated(address indexed user, uint8 indexed role, bool enabled); event PublicCapabilityUpdated(address indexed target, bytes4 indexed functionSig, bool enabled); event RoleCapabilityUpdated(uint8 indexed role, address indexed target, bytes4 indexed functionSig, bool enabled); /*/////////////////////////////////////////////////////////////// CONSTRUCTOR //////////////////////////////////////////////////////////////*/ constructor(address _owner, Authority _authority) Auth(_owner, _authority) {} /*/////////////////////////////////////////////////////////////// ROLE/USER STORAGE //////////////////////////////////////////////////////////////*/ mapping(address => bytes32) public getUserRoles; mapping(address => mapping(bytes4 => bool)) public isCapabilityPublic; mapping(address => mapping(bytes4 => bytes32)) public getRolesWithCapability; function doesUserHaveRole(address user, uint8 role) public view virtual returns (bool) { return (uint256(getUserRoles[user]) >> role) & 1 != 0; } function doesRoleHaveCapability( uint8 role, address target, bytes4 functionSig ) public view virtual returns (bool) { return (uint256(getRolesWithCapability[target][functionSig]) >> role) & 1 != 0; } /*/////////////////////////////////////////////////////////////// AUTHORIZATION LOGIC //////////////////////////////////////////////////////////////*/ function canCall( address user, address target, bytes4 functionSig ) public view virtual override returns (bool) { return isCapabilityPublic[target][functionSig] || bytes32(0) != getUserRoles[user] & getRolesWithCapability[target][functionSig]; } /*/////////////////////////////////////////////////////////////// ROLE CAPABILITY CONFIGURATION LOGIC //////////////////////////////////////////////////////////////*/ function setPublicCapability( address target, bytes4 functionSig, bool enabled ) public virtual requiresAuth { isCapabilityPublic[target][functionSig] = enabled; emit PublicCapabilityUpdated(target, functionSig, enabled); } function setRoleCapability( uint8 role, address target, bytes4 functionSig, bool enabled ) public virtual requiresAuth { if (enabled) { getRolesWithCapability[target][functionSig] |= bytes32(1 << role); } else { getRolesWithCapability[target][functionSig] &= ~bytes32(1 << role); } emit RoleCapabilityUpdated(role, target, functionSig, enabled); } /*/////////////////////////////////////////////////////////////// USER ROLE ASSIGNMENT LOGIC //////////////////////////////////////////////////////////////*/ function setUserRole( address user, uint8 role, bool enabled ) public virtual requiresAuth { if (enabled) { getUserRoles[user] |= bytes32(1 << role); } else { getUserRoles[user] &= ~bytes32(1 << role); } emit UserRoleUpdated(user, role, enabled); } }
File 8 of 9: FiatTokenV2_2
/** * SPDX-License-Identifier: Apache-2.0 * * Copyright (c) 2023, Circle Internet Financial, LLC. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ pragma solidity 0.6.12; import { EIP712Domain } from "./EIP712Domain.sol"; // solhint-disable-line no-unused-import import { Blacklistable } from "../v1/Blacklistable.sol"; // solhint-disable-line no-unused-import import { FiatTokenV1 } from "../v1/FiatTokenV1.sol"; // solhint-disable-line no-unused-import import { FiatTokenV2 } from "./FiatTokenV2.sol"; // solhint-disable-line no-unused-import import { FiatTokenV2_1 } from "./FiatTokenV2_1.sol"; import { EIP712 } from "../util/EIP712.sol"; // solhint-disable func-name-mixedcase /** * @title FiatToken V2.2 * @notice ERC20 Token backed by fiat reserves, version 2.2 */ contract FiatTokenV2_2 is FiatTokenV2_1 { /** * @notice Initialize v2.2 * @param accountsToBlacklist A list of accounts to migrate from the old blacklist * @param newSymbol New token symbol * data structure to the new blacklist data structure. */ function initializeV2_2( address[] calldata accountsToBlacklist, string calldata newSymbol ) external { // solhint-disable-next-line reason-string require(_initializedVersion == 2); // Update fiat token symbol symbol = newSymbol; // Add previously blacklisted accounts to the new blacklist data structure // and remove them from the old blacklist data structure. for (uint256 i = 0; i < accountsToBlacklist.length; i++) { require( _deprecatedBlacklisted[accountsToBlacklist[i]], "FiatTokenV2_2: Blacklisting previously unblacklisted account!" ); _blacklist(accountsToBlacklist[i]); delete _deprecatedBlacklisted[accountsToBlacklist[i]]; } _blacklist(address(this)); delete _deprecatedBlacklisted[address(this)]; _initializedVersion = 3; } /** * @dev Internal function to get the current chain id. * @return The current chain id. */ function _chainId() internal virtual view returns (uint256) { uint256 chainId; assembly { chainId := chainid() } return chainId; } /** * @inheritdoc EIP712Domain */ function _domainSeparator() internal override view returns (bytes32) { return EIP712.makeDomainSeparator(name, "2", _chainId()); } /** * @notice Update allowance with a signed permit * @dev EOA wallet signatures should be packed in the order of r, s, v. * @param owner Token owner's address (Authorizer) * @param spender Spender's address * @param value Amount of allowance * @param deadline The time at which the signature expires (unix time), or max uint256 value to signal no expiration * @param signature Signature bytes signed by an EOA wallet or a contract wallet */ function permit( address owner, address spender, uint256 value, uint256 deadline, bytes memory signature ) external whenNotPaused { _permit(owner, spender, value, deadline, signature); } /** * @notice Execute a transfer with a signed authorization * @dev EOA wallet signatures should be packed in the order of r, s, v. * @param from Payer's address (Authorizer) * @param to Payee's address * @param value Amount to be transferred * @param validAfter The time after which this is valid (unix time) * @param validBefore The time before which this is valid (unix time) * @param nonce Unique nonce * @param signature Signature bytes signed by an EOA wallet or a contract wallet */ function transferWithAuthorization( address from, address to, uint256 value, uint256 validAfter, uint256 validBefore, bytes32 nonce, bytes memory signature ) external whenNotPaused notBlacklisted(from) notBlacklisted(to) { _transferWithAuthorization( from, to, value, validAfter, validBefore, nonce, signature ); } /** * @notice Receive a transfer with a signed authorization from the payer * @dev This has an additional check to ensure that the payee's address * matches the caller of this function to prevent front-running attacks. * EOA wallet signatures should be packed in the order of r, s, v. * @param from Payer's address (Authorizer) * @param to Payee's address * @param value Amount to be transferred * @param validAfter The time after which this is valid (unix time) * @param validBefore The time before which this is valid (unix time) * @param nonce Unique nonce * @param signature Signature bytes signed by an EOA wallet or a contract wallet */ function receiveWithAuthorization( address from, address to, uint256 value, uint256 validAfter, uint256 validBefore, bytes32 nonce, bytes memory signature ) external whenNotPaused notBlacklisted(from) notBlacklisted(to) { _receiveWithAuthorization( from, to, value, validAfter, validBefore, nonce, signature ); } /** * @notice Attempt to cancel an authorization * @dev Works only if the authorization is not yet used. * EOA wallet signatures should be packed in the order of r, s, v. * @param authorizer Authorizer's address * @param nonce Nonce of the authorization * @param signature Signature bytes signed by an EOA wallet or a contract wallet */ function cancelAuthorization( address authorizer, bytes32 nonce, bytes memory signature ) external whenNotPaused { _cancelAuthorization(authorizer, nonce, signature); } /** * @dev Helper method that sets the blacklist state of an account on balanceAndBlacklistStates. * If _shouldBlacklist is true, we apply a (1 << 255) bitmask with an OR operation on the * account's balanceAndBlacklistState. This flips the high bit for the account to 1, * indicating that the account is blacklisted. * * If _shouldBlacklist if false, we reset the account's balanceAndBlacklistStates to their * balances. This clears the high bit for the account, indicating that the account is unblacklisted. * @param _account The address of the account. * @param _shouldBlacklist True if the account should be blacklisted, false if the account should be unblacklisted. */ function _setBlacklistState(address _account, bool _shouldBlacklist) internal override { balanceAndBlacklistStates[_account] = _shouldBlacklist ? balanceAndBlacklistStates[_account] | (1 << 255) : _balanceOf(_account); } /** * @dev Helper method that sets the balance of an account on balanceAndBlacklistStates. * Since balances are stored in the last 255 bits of the balanceAndBlacklistStates value, * we need to ensure that the updated balance does not exceed (2^255 - 1). * Since blacklisted accounts' balances cannot be updated, the method will also * revert if the account is blacklisted * @param _account The address of the account. * @param _balance The new fiat token balance of the account (max: (2^255 - 1)). */ function _setBalance(address _account, uint256 _balance) internal override { require( _balance <= ((1 << 255) - 1), "FiatTokenV2_2: Balance exceeds (2^255 - 1)" ); require( !_isBlacklisted(_account), "FiatTokenV2_2: Account is blacklisted" ); balanceAndBlacklistStates[_account] = _balance; } /** * @inheritdoc Blacklistable */ function _isBlacklisted(address _account) internal override view returns (bool) { return balanceAndBlacklistStates[_account] >> 255 == 1; } /** * @dev Helper method to obtain the balance of an account. Since balances * are stored in the last 255 bits of the balanceAndBlacklistStates value, * we apply a ((1 << 255) - 1) bit bitmask with an AND operation on the * balanceAndBlacklistState to obtain the balance. * @param _account The address of the account. * @return The fiat token balance of the account. */ function _balanceOf(address _account) internal override view returns (uint256) { return balanceAndBlacklistStates[_account] & ((1 << 255) - 1); } /** * @inheritdoc FiatTokenV1 */ function approve(address spender, uint256 value) external override whenNotPaused returns (bool) { _approve(msg.sender, spender, value); return true; } /** * @inheritdoc FiatTokenV2 */ function permit( address owner, address spender, uint256 value, uint256 deadline, uint8 v, bytes32 r, bytes32 s ) external override whenNotPaused { _permit(owner, spender, value, deadline, v, r, s); } /** * @inheritdoc FiatTokenV2 */ function increaseAllowance(address spender, uint256 increment) external override whenNotPaused returns (bool) { _increaseAllowance(msg.sender, spender, increment); return true; } /** * @inheritdoc FiatTokenV2 */ function decreaseAllowance(address spender, uint256 decrement) external override whenNotPaused returns (bool) { _decreaseAllowance(msg.sender, spender, decrement); return true; } } // SPDX-License-Identifier: MIT pragma solidity >=0.6.2 <0.8.0; /** * @dev Collection of functions related to the address type */ library Address { /** * @dev Returns true if `account` is a contract. * * [IMPORTANT] * ==== * It is unsafe to assume that an address for which this function returns * false is an externally-owned account (EOA) and not a contract. * * Among others, `isContract` will return false for the following * types of addresses: * * - an externally-owned account * - a contract in construction * - an address where a contract will be created * - an address where a contract lived, but was destroyed * ==== */ function isContract(address account) internal view returns (bool) { // This method relies on extcodesize, which returns 0 for contracts in // construction, since the code is only stored at the end of the // constructor execution. uint256 size; // solhint-disable-next-line no-inline-assembly assembly { size := extcodesize(account) } return size > 0; } /** * @dev Replacement for Solidity's `transfer`: sends `amount` wei to * `recipient`, forwarding all available gas and reverting on errors. * * https://eips.ethereum.org/EIPS/eip-1884[EIP1884] increases the gas cost * of certain opcodes, possibly making contracts go over the 2300 gas limit * imposed by `transfer`, making them unable to receive funds via * `transfer`. {sendValue} removes this limitation. * * https://diligence.consensys.net/posts/2019/09/stop-using-soliditys-transfer-now/[Learn more]. * * IMPORTANT: because control is transferred to `recipient`, care must be * taken to not create reentrancy vulnerabilities. Consider using * {ReentrancyGuard} or the * https://solidity.readthedocs.io/en/v0.5.11/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern]. */ function sendValue(address payable recipient, uint256 amount) internal { require(address(this).balance >= amount, "Address: insufficient balance"); // solhint-disable-next-line avoid-low-level-calls, avoid-call-value (bool success, ) = recipient.call{ value: amount }(""); require(success, "Address: unable to send value, recipient may have reverted"); } /** * @dev Performs a Solidity function call using a low level `call`. A * plain`call` is an unsafe replacement for a function call: use this * function instead. * * If `target` reverts with a revert reason, it is bubbled up by this * function (like regular Solidity function calls). * * Returns the raw returned data. To convert to the expected return value, * use https://solidity.readthedocs.io/en/latest/units-and-global-variables.html?highlight=abi.decode#abi-encoding-and-decoding-functions[`abi.decode`]. * * Requirements: * * - `target` must be a contract. * - calling `target` with `data` must not revert. * * _Available since v3.1._ */ function functionCall(address target, bytes memory data) internal returns (bytes memory) { return functionCall(target, data, "Address: low-level call failed"); } /** * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], but with * `errorMessage` as a fallback revert reason when `target` reverts. * * _Available since v3.1._ */ function functionCall(address target, bytes memory data, string memory errorMessage) internal returns (bytes memory) { return functionCallWithValue(target, data, 0, errorMessage); } /** * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], * but also transferring `value` wei to `target`. * * Requirements: * * - the calling contract must have an ETH balance of at least `value`. * - the called Solidity function must be `payable`. * * _Available since v3.1._ */ function functionCallWithValue(address target, bytes memory data, uint256 value) internal returns (bytes memory) { return functionCallWithValue(target, data, value, "Address: low-level call with value failed"); } /** * @dev Same as {xref-Address-functionCallWithValue-address-bytes-uint256-}[`functionCallWithValue`], but * with `errorMessage` as a fallback revert reason when `target` reverts. * * _Available since v3.1._ */ function functionCallWithValue(address target, bytes memory data, uint256 value, string memory errorMessage) internal returns (bytes memory) { require(address(this).balance >= value, "Address: insufficient balance for call"); require(isContract(target), "Address: call to non-contract"); // solhint-disable-next-line avoid-low-level-calls (bool success, bytes memory returndata) = target.call{ value: value }(data); return _verifyCallResult(success, returndata, errorMessage); } /** * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], * but performing a static call. * * _Available since v3.3._ */ function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) { return functionStaticCall(target, data, "Address: low-level static call failed"); } /** * @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`], * but performing a static call. * * _Available since v3.3._ */ function functionStaticCall(address target, bytes memory data, string memory errorMessage) internal view returns (bytes memory) { require(isContract(target), "Address: static call to non-contract"); // solhint-disable-next-line avoid-low-level-calls (bool success, bytes memory returndata) = target.staticcall(data); return _verifyCallResult(success, returndata, errorMessage); } /** * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], * but performing a delegate call. * * _Available since v3.4._ */ function functionDelegateCall(address target, bytes memory data) internal returns (bytes memory) { return functionDelegateCall(target, data, "Address: low-level delegate call failed"); } /** * @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`], * but performing a delegate call. * * _Available since v3.4._ */ function functionDelegateCall(address target, bytes memory data, string memory errorMessage) internal returns (bytes memory) { require(isContract(target), "Address: delegate call to non-contract"); // solhint-disable-next-line avoid-low-level-calls (bool success, bytes memory returndata) = target.delegatecall(data); return _verifyCallResult(success, returndata, errorMessage); } function _verifyCallResult(bool success, bytes memory returndata, string memory errorMessage) private pure returns(bytes memory) { if (success) { return returndata; } else { // Look for revert reason and bubble it up if present if (returndata.length > 0) { // The easiest way to bubble the revert reason is using memory via assembly // solhint-disable-next-line no-inline-assembly assembly { let returndata_size := mload(returndata) revert(add(32, returndata), returndata_size) } } else { revert(errorMessage); } } } } // SPDX-License-Identifier: MIT pragma solidity >=0.6.0 <0.8.0; import "./IERC20.sol"; import "../../math/SafeMath.sol"; import "../../utils/Address.sol"; /** * @title SafeERC20 * @dev Wrappers around ERC20 operations that throw on failure (when the token * contract returns false). Tokens that return no value (and instead revert or * throw on failure) are also supported, non-reverting calls are assumed to be * successful. * To use this library you can add a `using SafeERC20 for IERC20;` statement to your contract, * which allows you to call the safe operations as `token.safeTransfer(...)`, etc. */ library SafeERC20 { using SafeMath for uint256; using Address for address; function safeTransfer(IERC20 token, address to, uint256 value) internal { _callOptionalReturn(token, abi.encodeWithSelector(token.transfer.selector, to, value)); } function safeTransferFrom(IERC20 token, address from, address to, uint256 value) internal { _callOptionalReturn(token, abi.encodeWithSelector(token.transferFrom.selector, from, to, value)); } /** * @dev Deprecated. This function has issues similar to the ones found in * {IERC20-approve}, and its usage is discouraged. * * Whenever possible, use {safeIncreaseAllowance} and * {safeDecreaseAllowance} instead. */ function safeApprove(IERC20 token, address spender, uint256 value) internal { // safeApprove should only be called when setting an initial allowance, // or when resetting it to zero. To increase and decrease it, use // 'safeIncreaseAllowance' and 'safeDecreaseAllowance' // solhint-disable-next-line max-line-length require((value == 0) || (token.allowance(address(this), spender) == 0), "SafeERC20: approve from non-zero to non-zero allowance" ); _callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, value)); } function safeIncreaseAllowance(IERC20 token, address spender, uint256 value) internal { uint256 newAllowance = token.allowance(address(this), spender).add(value); _callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance)); } function safeDecreaseAllowance(IERC20 token, address spender, uint256 value) internal { uint256 newAllowance = token.allowance(address(this), spender).sub(value, "SafeERC20: decreased allowance below zero"); _callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance)); } /** * @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement * on the return value: the return value is optional (but if data is returned, it must not be false). * @param token The token targeted by the call. * @param data The call data (encoded using abi.encode or one of its variants). */ function _callOptionalReturn(IERC20 token, bytes memory data) private { // We need to perform a low level call here, to bypass Solidity's return data size checking mechanism, since // we're implementing it ourselves. We use {Address.functionCall} to perform this call, which verifies that // the target address contains contract code and also asserts for success in the low-level call. bytes memory returndata = address(token).functionCall(data, "SafeERC20: low-level call failed"); if (returndata.length > 0) { // Return data is optional // solhint-disable-next-line max-line-length require(abi.decode(returndata, (bool)), "SafeERC20: ERC20 operation did not succeed"); } } } // SPDX-License-Identifier: MIT pragma solidity >=0.6.0 <0.8.0; /** * @dev Interface of the ERC20 standard as defined in the EIP. */ interface IERC20 { /** * @dev Returns the amount of tokens in existence. */ function totalSupply() external view returns (uint256); /** * @dev Returns the amount of tokens owned by `account`. */ function balanceOf(address account) external view returns (uint256); /** * @dev Moves `amount` tokens from the caller's account to `recipient`. * * Returns a boolean value indicating whether the operation succeeded. * * Emits a {Transfer} event. */ function transfer(address recipient, uint256 amount) external returns (bool); /** * @dev Returns the remaining number of tokens that `spender` will be * allowed to spend on behalf of `owner` through {transferFrom}. This is * zero by default. * * This value changes when {approve} or {transferFrom} are called. */ function allowance(address owner, address spender) external view returns (uint256); /** * @dev Sets `amount` as the allowance of `spender` over the caller's tokens. * * Returns a boolean value indicating whether the operation succeeded. * * IMPORTANT: Beware that changing an allowance with this method brings the risk * that someone may use both the old and the new allowance by unfortunate * transaction ordering. One possible solution to mitigate this race * condition is to first reduce the spender's allowance to 0 and set the * desired value afterwards: * https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729 * * Emits an {Approval} event. */ function approve(address spender, uint256 amount) external returns (bool); /** * @dev Moves `amount` tokens from `sender` to `recipient` using the * allowance mechanism. `amount` is then deducted from the caller's * allowance. * * Returns a boolean value indicating whether the operation succeeded. * * Emits a {Transfer} event. */ function transferFrom(address sender, address recipient, uint256 amount) external returns (bool); /** * @dev Emitted when `value` tokens are moved from one account (`from`) to * another (`to`). * * Note that `value` may be zero. */ event Transfer(address indexed from, address indexed to, uint256 value); /** * @dev Emitted when the allowance of a `spender` for an `owner` is set by * a call to {approve}. `value` is the new allowance. */ event Approval(address indexed owner, address indexed spender, uint256 value); } // SPDX-License-Identifier: MIT pragma solidity >=0.6.0 <0.8.0; /** * @dev Wrappers over Solidity's arithmetic operations with added overflow * checks. * * Arithmetic operations in Solidity wrap on overflow. This can easily result * in bugs, because programmers usually assume that an overflow raises an * error, which is the standard behavior in high level programming languages. * `SafeMath` restores this intuition by reverting the transaction when an * operation overflows. * * Using this library instead of the unchecked operations eliminates an entire * class of bugs, so it's recommended to use it always. */ library SafeMath { /** * @dev Returns the addition of two unsigned integers, with an overflow flag. * * _Available since v3.4._ */ function tryAdd(uint256 a, uint256 b) internal pure returns (bool, uint256) { uint256 c = a + b; if (c < a) return (false, 0); return (true, c); } /** * @dev Returns the substraction of two unsigned integers, with an overflow flag. * * _Available since v3.4._ */ function trySub(uint256 a, uint256 b) internal pure returns (bool, uint256) { if (b > a) return (false, 0); return (true, a - b); } /** * @dev Returns the multiplication of two unsigned integers, with an overflow flag. * * _Available since v3.4._ */ function tryMul(uint256 a, uint256 b) internal pure returns (bool, uint256) { // Gas optimization: this is cheaper than requiring 'a' not being zero, but the // benefit is lost if 'b' is also tested. // See: https://github.com/OpenZeppelin/openzeppelin-contracts/pull/522 if (a == 0) return (true, 0); uint256 c = a * b; if (c / a != b) return (false, 0); return (true, c); } /** * @dev Returns the division of two unsigned integers, with a division by zero flag. * * _Available since v3.4._ */ function tryDiv(uint256 a, uint256 b) internal pure returns (bool, uint256) { if (b == 0) return (false, 0); return (true, a / b); } /** * @dev Returns the remainder of dividing two unsigned integers, with a division by zero flag. * * _Available since v3.4._ */ function tryMod(uint256 a, uint256 b) internal pure returns (bool, uint256) { if (b == 0) return (false, 0); return (true, a % b); } /** * @dev Returns the addition of two unsigned integers, reverting on * overflow. * * Counterpart to Solidity's `+` operator. * * Requirements: * * - Addition cannot overflow. */ function add(uint256 a, uint256 b) internal pure returns (uint256) { uint256 c = a + b; require(c >= a, "SafeMath: addition overflow"); return c; } /** * @dev Returns the subtraction of two unsigned integers, reverting on * overflow (when the result is negative). * * Counterpart to Solidity's `-` operator. * * Requirements: * * - Subtraction cannot overflow. */ function sub(uint256 a, uint256 b) internal pure returns (uint256) { require(b <= a, "SafeMath: subtraction overflow"); return a - b; } /** * @dev Returns the multiplication of two unsigned integers, reverting on * overflow. * * Counterpart to Solidity's `*` operator. * * Requirements: * * - Multiplication cannot overflow. */ function mul(uint256 a, uint256 b) internal pure returns (uint256) { if (a == 0) return 0; uint256 c = a * b; require(c / a == b, "SafeMath: multiplication overflow"); return c; } /** * @dev Returns the integer division of two unsigned integers, reverting on * division by zero. The result is rounded towards zero. * * Counterpart to Solidity's `/` operator. Note: this function uses a * `revert` opcode (which leaves remaining gas untouched) while Solidity * uses an invalid opcode to revert (consuming all remaining gas). * * Requirements: * * - The divisor cannot be zero. */ function div(uint256 a, uint256 b) internal pure returns (uint256) { require(b > 0, "SafeMath: division by zero"); return a / b; } /** * @dev Returns the remainder of dividing two unsigned integers. (unsigned integer modulo), * reverting when dividing by zero. * * Counterpart to Solidity's `%` operator. This function uses a `revert` * opcode (which leaves remaining gas untouched) while Solidity uses an * invalid opcode to revert (consuming all remaining gas). * * Requirements: * * - The divisor cannot be zero. */ function mod(uint256 a, uint256 b) internal pure returns (uint256) { require(b > 0, "SafeMath: modulo by zero"); return a % b; } /** * @dev Returns the subtraction of two unsigned integers, reverting with custom message on * overflow (when the result is negative). * * CAUTION: This function is deprecated because it requires allocating memory for the error * message unnecessarily. For custom revert reasons use {trySub}. * * Counterpart to Solidity's `-` operator. * * Requirements: * * - Subtraction cannot overflow. */ function sub(uint256 a, uint256 b, string memory errorMessage) internal pure returns (uint256) { require(b <= a, errorMessage); return a - b; } /** * @dev Returns the integer division of two unsigned integers, reverting with custom message on * division by zero. The result is rounded towards zero. * * CAUTION: This function is deprecated because it requires allocating memory for the error * message unnecessarily. For custom revert reasons use {tryDiv}. * * Counterpart to Solidity's `/` operator. Note: this function uses a * `revert` opcode (which leaves remaining gas untouched) while Solidity * uses an invalid opcode to revert (consuming all remaining gas). * * Requirements: * * - The divisor cannot be zero. */ function div(uint256 a, uint256 b, string memory errorMessage) internal pure returns (uint256) { require(b > 0, errorMessage); return a / b; } /** * @dev Returns the remainder of dividing two unsigned integers. (unsigned integer modulo), * reverting with custom message when dividing by zero. * * CAUTION: This function is deprecated because it requires allocating memory for the error * message unnecessarily. For custom revert reasons use {tryMod}. * * Counterpart to Solidity's `%` operator. This function uses a `revert` * opcode (which leaves remaining gas untouched) while Solidity uses an * invalid opcode to revert (consuming all remaining gas). * * Requirements: * * - The divisor cannot be zero. */ function mod(uint256 a, uint256 b, string memory errorMessage) internal pure returns (uint256) { require(b > 0, errorMessage); return a % b; } } /** * SPDX-License-Identifier: Apache-2.0 * * Copyright (c) 2023, Circle Internet Financial, LLC. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ pragma solidity 0.6.12; import { FiatTokenV2 } from "./FiatTokenV2.sol"; // solhint-disable func-name-mixedcase /** * @title FiatToken V2.1 * @notice ERC20 Token backed by fiat reserves, version 2.1 */ contract FiatTokenV2_1 is FiatTokenV2 { /** * @notice Initialize v2.1 * @param lostAndFound The address to which the locked funds are sent */ function initializeV2_1(address lostAndFound) external { // solhint-disable-next-line reason-string require(_initializedVersion == 1); uint256 lockedAmount = _balanceOf(address(this)); if (lockedAmount > 0) { _transfer(address(this), lostAndFound, lockedAmount); } _blacklist(address(this)); _initializedVersion = 2; } /** * @notice Version string for the EIP712 domain separator * @return Version string */ function version() external pure returns (string memory) { return "2"; } } /** * SPDX-License-Identifier: Apache-2.0 * * Copyright (c) 2023, Circle Internet Financial, LLC. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ pragma solidity 0.6.12; import { FiatTokenV1_1 } from "../v1.1/FiatTokenV1_1.sol"; import { EIP712 } from "../util/EIP712.sol"; import { EIP3009 } from "./EIP3009.sol"; import { EIP2612 } from "./EIP2612.sol"; /** * @title FiatToken V2 * @notice ERC20 Token backed by fiat reserves, version 2 */ contract FiatTokenV2 is FiatTokenV1_1, EIP3009, EIP2612 { uint8 internal _initializedVersion; /** * @notice Initialize v2 * @param newName New token name */ function initializeV2(string calldata newName) external { // solhint-disable-next-line reason-string require(initialized && _initializedVersion == 0); name = newName; _DEPRECATED_CACHED_DOMAIN_SEPARATOR = EIP712.makeDomainSeparator( newName, "2" ); _initializedVersion = 1; } /** * @notice Increase the allowance by a given increment * @param spender Spender's address * @param increment Amount of increase in allowance * @return True if successful */ function increaseAllowance(address spender, uint256 increment) external virtual whenNotPaused notBlacklisted(msg.sender) notBlacklisted(spender) returns (bool) { _increaseAllowance(msg.sender, spender, increment); return true; } /** * @notice Decrease the allowance by a given decrement * @param spender Spender's address * @param decrement Amount of decrease in allowance * @return True if successful */ function decreaseAllowance(address spender, uint256 decrement) external virtual whenNotPaused notBlacklisted(msg.sender) notBlacklisted(spender) returns (bool) { _decreaseAllowance(msg.sender, spender, decrement); return true; } /** * @notice Execute a transfer with a signed authorization * @param from Payer's address (Authorizer) * @param to Payee's address * @param value Amount to be transferred * @param validAfter The time after which this is valid (unix time) * @param validBefore The time before which this is valid (unix time) * @param nonce Unique nonce * @param v v of the signature * @param r r of the signature * @param s s of the signature */ function transferWithAuthorization( address from, address to, uint256 value, uint256 validAfter, uint256 validBefore, bytes32 nonce, uint8 v, bytes32 r, bytes32 s ) external whenNotPaused notBlacklisted(from) notBlacklisted(to) { _transferWithAuthorization( from, to, value, validAfter, validBefore, nonce, v, r, s ); } /** * @notice Receive a transfer with a signed authorization from the payer * @dev This has an additional check to ensure that the payee's address * matches the caller of this function to prevent front-running attacks. * @param from Payer's address (Authorizer) * @param to Payee's address * @param value Amount to be transferred * @param validAfter The time after which this is valid (unix time) * @param validBefore The time before which this is valid (unix time) * @param nonce Unique nonce * @param v v of the signature * @param r r of the signature * @param s s of the signature */ function receiveWithAuthorization( address from, address to, uint256 value, uint256 validAfter, uint256 validBefore, bytes32 nonce, uint8 v, bytes32 r, bytes32 s ) external whenNotPaused notBlacklisted(from) notBlacklisted(to) { _receiveWithAuthorization( from, to, value, validAfter, validBefore, nonce, v, r, s ); } /** * @notice Attempt to cancel an authorization * @dev Works only if the authorization is not yet used. * @param authorizer Authorizer's address * @param nonce Nonce of the authorization * @param v v of the signature * @param r r of the signature * @param s s of the signature */ function cancelAuthorization( address authorizer, bytes32 nonce, uint8 v, bytes32 r, bytes32 s ) external whenNotPaused { _cancelAuthorization(authorizer, nonce, v, r, s); } /** * @notice Update allowance with a signed permit * @param owner Token owner's address (Authorizer) * @param spender Spender's address * @param value Amount of allowance * @param deadline The time at which the signature expires (unix time), or max uint256 value to signal no expiration * @param v v of the signature * @param r r of the signature * @param s s of the signature */ function permit( address owner, address spender, uint256 value, uint256 deadline, uint8 v, bytes32 r, bytes32 s ) external virtual whenNotPaused notBlacklisted(owner) notBlacklisted(spender) { _permit(owner, spender, value, deadline, v, r, s); } /** * @dev Internal function to increase the allowance by a given increment * @param owner Token owner's address * @param spender Spender's address * @param increment Amount of increase */ function _increaseAllowance( address owner, address spender, uint256 increment ) internal override { _approve(owner, spender, allowed[owner][spender].add(increment)); } /** * @dev Internal function to decrease the allowance by a given decrement * @param owner Token owner's address * @param spender Spender's address * @param decrement Amount of decrease */ function _decreaseAllowance( address owner, address spender, uint256 decrement ) internal override { _approve( owner, spender, allowed[owner][spender].sub( decrement, "ERC20: decreased allowance below zero" ) ); } } /** * SPDX-License-Identifier: Apache-2.0 * * Copyright (c) 2023, Circle Internet Financial, LLC. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ pragma solidity 0.6.12; // solhint-disable func-name-mixedcase /** * @title EIP712 Domain */ contract EIP712Domain { // was originally DOMAIN_SEPARATOR // but that has been moved to a method so we can override it in V2_2+ bytes32 internal _DEPRECATED_CACHED_DOMAIN_SEPARATOR; /** * @notice Get the EIP712 Domain Separator. * @return The bytes32 EIP712 domain separator. */ function DOMAIN_SEPARATOR() external view returns (bytes32) { return _domainSeparator(); } /** * @dev Internal method to get the EIP712 Domain Separator. * @return The bytes32 EIP712 domain separator. */ function _domainSeparator() internal virtual view returns (bytes32) { return _DEPRECATED_CACHED_DOMAIN_SEPARATOR; } } /** * SPDX-License-Identifier: Apache-2.0 * * Copyright (c) 2023, Circle Internet Financial, LLC. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ pragma solidity 0.6.12; import { AbstractFiatTokenV2 } from "./AbstractFiatTokenV2.sol"; import { EIP712Domain } from "./EIP712Domain.sol"; import { SignatureChecker } from "../util/SignatureChecker.sol"; import { MessageHashUtils } from "../util/MessageHashUtils.sol"; /** * @title EIP-3009 * @notice Provide internal implementation for gas-abstracted transfers * @dev Contracts that inherit from this must wrap these with publicly * accessible functions, optionally adding modifiers where necessary */ abstract contract EIP3009 is AbstractFiatTokenV2, EIP712Domain { // keccak256("TransferWithAuthorization(address from,address to,uint256 value,uint256 validAfter,uint256 validBefore,bytes32 nonce)") bytes32 public constant TRANSFER_WITH_AUTHORIZATION_TYPEHASH = 0x7c7c6cdb67a18743f49ec6fa9b35f50d52ed05cbed4cc592e13b44501c1a2267; // keccak256("ReceiveWithAuthorization(address from,address to,uint256 value,uint256 validAfter,uint256 validBefore,bytes32 nonce)") bytes32 public constant RECEIVE_WITH_AUTHORIZATION_TYPEHASH = 0xd099cc98ef71107a616c4f0f941f04c322d8e254fe26b3c6668db87aae413de8; // keccak256("CancelAuthorization(address authorizer,bytes32 nonce)") bytes32 public constant CANCEL_AUTHORIZATION_TYPEHASH = 0x158b0a9edf7a828aad02f63cd515c68ef2f50ba807396f6d12842833a1597429; /** * @dev authorizer address => nonce => bool (true if nonce is used) */ mapping(address => mapping(bytes32 => bool)) private _authorizationStates; event AuthorizationUsed(address indexed authorizer, bytes32 indexed nonce); event AuthorizationCanceled( address indexed authorizer, bytes32 indexed nonce ); /** * @notice Returns the state of an authorization * @dev Nonces are randomly generated 32-byte data unique to the * authorizer's address * @param authorizer Authorizer's address * @param nonce Nonce of the authorization * @return True if the nonce is used */ function authorizationState(address authorizer, bytes32 nonce) external view returns (bool) { return _authorizationStates[authorizer][nonce]; } /** * @notice Execute a transfer with a signed authorization * @param from Payer's address (Authorizer) * @param to Payee's address * @param value Amount to be transferred * @param validAfter The time after which this is valid (unix time) * @param validBefore The time before which this is valid (unix time) * @param nonce Unique nonce * @param v v of the signature * @param r r of the signature * @param s s of the signature */ function _transferWithAuthorization( address from, address to, uint256 value, uint256 validAfter, uint256 validBefore, bytes32 nonce, uint8 v, bytes32 r, bytes32 s ) internal { _transferWithAuthorization( from, to, value, validAfter, validBefore, nonce, abi.encodePacked(r, s, v) ); } /** * @notice Execute a transfer with a signed authorization * @dev EOA wallet signatures should be packed in the order of r, s, v. * @param from Payer's address (Authorizer) * @param to Payee's address * @param value Amount to be transferred * @param validAfter The time after which this is valid (unix time) * @param validBefore The time before which this is valid (unix time) * @param nonce Unique nonce * @param signature Signature byte array produced by an EOA wallet or a contract wallet */ function _transferWithAuthorization( address from, address to, uint256 value, uint256 validAfter, uint256 validBefore, bytes32 nonce, bytes memory signature ) internal { _requireValidAuthorization(from, nonce, validAfter, validBefore); _requireValidSignature( from, keccak256( abi.encode( TRANSFER_WITH_AUTHORIZATION_TYPEHASH, from, to, value, validAfter, validBefore, nonce ) ), signature ); _markAuthorizationAsUsed(from, nonce); _transfer(from, to, value); } /** * @notice Receive a transfer with a signed authorization from the payer * @dev This has an additional check to ensure that the payee's address * matches the caller of this function to prevent front-running attacks. * @param from Payer's address (Authorizer) * @param to Payee's address * @param value Amount to be transferred * @param validAfter The time after which this is valid (unix time) * @param validBefore The time before which this is valid (unix time) * @param nonce Unique nonce * @param v v of the signature * @param r r of the signature * @param s s of the signature */ function _receiveWithAuthorization( address from, address to, uint256 value, uint256 validAfter, uint256 validBefore, bytes32 nonce, uint8 v, bytes32 r, bytes32 s ) internal { _receiveWithAuthorization( from, to, value, validAfter, validBefore, nonce, abi.encodePacked(r, s, v) ); } /** * @notice Receive a transfer with a signed authorization from the payer * @dev This has an additional check to ensure that the payee's address * matches the caller of this function to prevent front-running attacks. * EOA wallet signatures should be packed in the order of r, s, v. * @param from Payer's address (Authorizer) * @param to Payee's address * @param value Amount to be transferred * @param validAfter The time after which this is valid (unix time) * @param validBefore The time before which this is valid (unix time) * @param nonce Unique nonce * @param signature Signature byte array produced by an EOA wallet or a contract wallet */ function _receiveWithAuthorization( address from, address to, uint256 value, uint256 validAfter, uint256 validBefore, bytes32 nonce, bytes memory signature ) internal { require(to == msg.sender, "FiatTokenV2: caller must be the payee"); _requireValidAuthorization(from, nonce, validAfter, validBefore); _requireValidSignature( from, keccak256( abi.encode( RECEIVE_WITH_AUTHORIZATION_TYPEHASH, from, to, value, validAfter, validBefore, nonce ) ), signature ); _markAuthorizationAsUsed(from, nonce); _transfer(from, to, value); } /** * @notice Attempt to cancel an authorization * @param authorizer Authorizer's address * @param nonce Nonce of the authorization * @param v v of the signature * @param r r of the signature * @param s s of the signature */ function _cancelAuthorization( address authorizer, bytes32 nonce, uint8 v, bytes32 r, bytes32 s ) internal { _cancelAuthorization(authorizer, nonce, abi.encodePacked(r, s, v)); } /** * @notice Attempt to cancel an authorization * @dev EOA wallet signatures should be packed in the order of r, s, v. * @param authorizer Authorizer's address * @param nonce Nonce of the authorization * @param signature Signature byte array produced by an EOA wallet or a contract wallet */ function _cancelAuthorization( address authorizer, bytes32 nonce, bytes memory signature ) internal { _requireUnusedAuthorization(authorizer, nonce); _requireValidSignature( authorizer, keccak256( abi.encode(CANCEL_AUTHORIZATION_TYPEHASH, authorizer, nonce) ), signature ); _authorizationStates[authorizer][nonce] = true; emit AuthorizationCanceled(authorizer, nonce); } /** * @notice Validates that signature against input data struct * @param signer Signer's address * @param dataHash Hash of encoded data struct * @param signature Signature byte array produced by an EOA wallet or a contract wallet */ function _requireValidSignature( address signer, bytes32 dataHash, bytes memory signature ) private view { require( SignatureChecker.isValidSignatureNow( signer, MessageHashUtils.toTypedDataHash(_domainSeparator(), dataHash), signature ), "FiatTokenV2: invalid signature" ); } /** * @notice Check that an authorization is unused * @param authorizer Authorizer's address * @param nonce Nonce of the authorization */ function _requireUnusedAuthorization(address authorizer, bytes32 nonce) private view { require( !_authorizationStates[authorizer][nonce], "FiatTokenV2: authorization is used or canceled" ); } /** * @notice Check that authorization is valid * @param authorizer Authorizer's address * @param nonce Nonce of the authorization * @param validAfter The time after which this is valid (unix time) * @param validBefore The time before which this is valid (unix time) */ function _requireValidAuthorization( address authorizer, bytes32 nonce, uint256 validAfter, uint256 validBefore ) private view { require( now > validAfter, "FiatTokenV2: authorization is not yet valid" ); require(now < validBefore, "FiatTokenV2: authorization is expired"); _requireUnusedAuthorization(authorizer, nonce); } /** * @notice Mark an authorization as used * @param authorizer Authorizer's address * @param nonce Nonce of the authorization */ function _markAuthorizationAsUsed(address authorizer, bytes32 nonce) private { _authorizationStates[authorizer][nonce] = true; emit AuthorizationUsed(authorizer, nonce); } } /** * SPDX-License-Identifier: Apache-2.0 * * Copyright (c) 2023, Circle Internet Financial, LLC. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ pragma solidity 0.6.12; import { AbstractFiatTokenV2 } from "./AbstractFiatTokenV2.sol"; import { EIP712Domain } from "./EIP712Domain.sol"; import { MessageHashUtils } from "../util/MessageHashUtils.sol"; import { SignatureChecker } from "../util/SignatureChecker.sol"; /** * @title EIP-2612 * @notice Provide internal implementation for gas-abstracted approvals */ abstract contract EIP2612 is AbstractFiatTokenV2, EIP712Domain { // keccak256("Permit(address owner,address spender,uint256 value,uint256 nonce,uint256 deadline)") bytes32 public constant PERMIT_TYPEHASH = 0x6e71edae12b1b97f4d1f60370fef10105fa2faae0126114a169c64845d6126c9; mapping(address => uint256) private _permitNonces; /** * @notice Nonces for permit * @param owner Token owner's address (Authorizer) * @return Next nonce */ function nonces(address owner) external view returns (uint256) { return _permitNonces[owner]; } /** * @notice Verify a signed approval permit and execute if valid * @param owner Token owner's address (Authorizer) * @param spender Spender's address * @param value Amount of allowance * @param deadline The time at which the signature expires (unix time), or max uint256 value to signal no expiration * @param v v of the signature * @param r r of the signature * @param s s of the signature */ function _permit( address owner, address spender, uint256 value, uint256 deadline, uint8 v, bytes32 r, bytes32 s ) internal { _permit(owner, spender, value, deadline, abi.encodePacked(r, s, v)); } /** * @notice Verify a signed approval permit and execute if valid * @dev EOA wallet signatures should be packed in the order of r, s, v. * @param owner Token owner's address (Authorizer) * @param spender Spender's address * @param value Amount of allowance * @param deadline The time at which the signature expires (unix time), or max uint256 value to signal no expiration * @param signature Signature byte array signed by an EOA wallet or a contract wallet */ function _permit( address owner, address spender, uint256 value, uint256 deadline, bytes memory signature ) internal { require( deadline == type(uint256).max || deadline >= now, "FiatTokenV2: permit is expired" ); bytes32 typedDataHash = MessageHashUtils.toTypedDataHash( _domainSeparator(), keccak256( abi.encode( PERMIT_TYPEHASH, owner, spender, value, _permitNonces[owner]++, deadline ) ) ); require( SignatureChecker.isValidSignatureNow( owner, typedDataHash, signature ), "EIP2612: invalid signature" ); _approve(owner, spender, value); } } /** * SPDX-License-Identifier: Apache-2.0 * * Copyright (c) 2023, Circle Internet Financial, LLC. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ pragma solidity 0.6.12; import { AbstractFiatTokenV1 } from "../v1/AbstractFiatTokenV1.sol"; abstract contract AbstractFiatTokenV2 is AbstractFiatTokenV1 { function _increaseAllowance( address owner, address spender, uint256 increment ) internal virtual; function _decreaseAllowance( address owner, address spender, uint256 decrement ) internal virtual; } /** * SPDX-License-Identifier: MIT * * Copyright (c) 2016 Smart Contract Solutions, Inc. * Copyright (c) 2018-2020 CENTRE SECZ * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in * copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ pragma solidity 0.6.12; import { Ownable } from "./Ownable.sol"; /** * @notice Base contract which allows children to implement an emergency stop * mechanism * @dev Forked from https://github.com/OpenZeppelin/openzeppelin-contracts/blob/feb665136c0dae9912e08397c1a21c4af3651ef3/contracts/lifecycle/Pausable.sol * Modifications: * 1. Added pauser role, switched pause/unpause to be onlyPauser (6/14/2018) * 2. Removed whenNotPause/whenPaused from pause/unpause (6/14/2018) * 3. Removed whenPaused (6/14/2018) * 4. Switches ownable library to use ZeppelinOS (7/12/18) * 5. Remove constructor (7/13/18) * 6. Reformat, conform to Solidity 0.6 syntax and add error messages (5/13/20) * 7. Make public functions external (5/27/20) */ contract Pausable is Ownable { event Pause(); event Unpause(); event PauserChanged(address indexed newAddress); address public pauser; bool public paused = false; /** * @dev Modifier to make a function callable only when the contract is not paused. */ modifier whenNotPaused() { require(!paused, "Pausable: paused"); _; } /** * @dev throws if called by any account other than the pauser */ modifier onlyPauser() { require(msg.sender == pauser, "Pausable: caller is not the pauser"); _; } /** * @dev called by the owner to pause, triggers stopped state */ function pause() external onlyPauser { paused = true; emit Pause(); } /** * @dev called by the owner to unpause, returns to normal state */ function unpause() external onlyPauser { paused = false; emit Unpause(); } /** * @notice Updates the pauser address. * @param _newPauser The address of the new pauser. */ function updatePauser(address _newPauser) external onlyOwner { require( _newPauser != address(0), "Pausable: new pauser is the zero address" ); pauser = _newPauser; emit PauserChanged(pauser); } } /** * SPDX-License-Identifier: MIT * * Copyright (c) 2018 zOS Global Limited. * Copyright (c) 2018-2020 CENTRE SECZ * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in * copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ pragma solidity 0.6.12; /** * @notice The Ownable contract has an owner address, and provides basic * authorization control functions * @dev Forked from https://github.com/OpenZeppelin/openzeppelin-labs/blob/3887ab77b8adafba4a26ace002f3a684c1a3388b/upgradeability_ownership/contracts/ownership/Ownable.sol * Modifications: * 1. Consolidate OwnableStorage into this contract (7/13/18) * 2. Reformat, conform to Solidity 0.6 syntax, and add error messages (5/13/20) * 3. Make public functions external (5/27/20) */ contract Ownable { // Owner of the contract address private _owner; /** * @dev Event to show ownership has been transferred * @param previousOwner representing the address of the previous owner * @param newOwner representing the address of the new owner */ event OwnershipTransferred(address previousOwner, address newOwner); /** * @dev The constructor sets the original owner of the contract to the sender account. */ constructor() public { setOwner(msg.sender); } /** * @dev Tells the address of the owner * @return the address of the owner */ function owner() external view returns (address) { return _owner; } /** * @dev Sets a new owner address */ function setOwner(address newOwner) internal { _owner = newOwner; } /** * @dev Throws if called by any account other than the owner. */ modifier onlyOwner() { require(msg.sender == _owner, "Ownable: caller is not the owner"); _; } /** * @dev Allows the current owner to transfer control of the contract to a newOwner. * @param newOwner The address to transfer ownership to. */ function transferOwnership(address newOwner) external onlyOwner { require( newOwner != address(0), "Ownable: new owner is the zero address" ); emit OwnershipTransferred(_owner, newOwner); setOwner(newOwner); } } /** * SPDX-License-Identifier: Apache-2.0 * * Copyright (c) 2023, Circle Internet Financial, LLC. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ pragma solidity 0.6.12; import { SafeMath } from "@openzeppelin/contracts/math/SafeMath.sol"; import { AbstractFiatTokenV1 } from "./AbstractFiatTokenV1.sol"; import { Ownable } from "./Ownable.sol"; import { Pausable } from "./Pausable.sol"; import { Blacklistable } from "./Blacklistable.sol"; /** * @title FiatToken * @dev ERC20 Token backed by fiat reserves */ contract FiatTokenV1 is AbstractFiatTokenV1, Ownable, Pausable, Blacklistable { using SafeMath for uint256; string public name; string public symbol; uint8 public decimals; string public currency; address public masterMinter; bool internal initialized; /// @dev A mapping that stores the balance and blacklist states for a given address. /// The first bit defines whether the address is blacklisted (1 if blacklisted, 0 otherwise). /// The last 255 bits define the balance for the address. mapping(address => uint256) internal balanceAndBlacklistStates; mapping(address => mapping(address => uint256)) internal allowed; uint256 internal totalSupply_ = 0; mapping(address => bool) internal minters; mapping(address => uint256) internal minterAllowed; event Mint(address indexed minter, address indexed to, uint256 amount); event Burn(address indexed burner, uint256 amount); event MinterConfigured(address indexed minter, uint256 minterAllowedAmount); event MinterRemoved(address indexed oldMinter); event MasterMinterChanged(address indexed newMasterMinter); /** * @notice Initializes the fiat token contract. * @param tokenName The name of the fiat token. * @param tokenSymbol The symbol of the fiat token. * @param tokenCurrency The fiat currency that the token represents. * @param tokenDecimals The number of decimals that the token uses. * @param newMasterMinter The masterMinter address for the fiat token. * @param newPauser The pauser address for the fiat token. * @param newBlacklister The blacklister address for the fiat token. * @param newOwner The owner of the fiat token. */ function initialize( string memory tokenName, string memory tokenSymbol, string memory tokenCurrency, uint8 tokenDecimals, address newMasterMinter, address newPauser, address newBlacklister, address newOwner ) public { require(!initialized, "FiatToken: contract is already initialized"); require( newMasterMinter != address(0), "FiatToken: new masterMinter is the zero address" ); require( newPauser != address(0), "FiatToken: new pauser is the zero address" ); require( newBlacklister != address(0), "FiatToken: new blacklister is the zero address" ); require( newOwner != address(0), "FiatToken: new owner is the zero address" ); name = tokenName; symbol = tokenSymbol; currency = tokenCurrency; decimals = tokenDecimals; masterMinter = newMasterMinter; pauser = newPauser; blacklister = newBlacklister; setOwner(newOwner); initialized = true; } /** * @dev Throws if called by any account other than a minter. */ modifier onlyMinters() { require(minters[msg.sender], "FiatToken: caller is not a minter"); _; } /** * @notice Mints fiat tokens to an address. * @param _to The address that will receive the minted tokens. * @param _amount The amount of tokens to mint. Must be less than or equal * to the minterAllowance of the caller. * @return True if the operation was successful. */ function mint(address _to, uint256 _amount) external whenNotPaused onlyMinters notBlacklisted(msg.sender) notBlacklisted(_to) returns (bool) { require(_to != address(0), "FiatToken: mint to the zero address"); require(_amount > 0, "FiatToken: mint amount not greater than 0"); uint256 mintingAllowedAmount = minterAllowed[msg.sender]; require( _amount <= mintingAllowedAmount, "FiatToken: mint amount exceeds minterAllowance" ); totalSupply_ = totalSupply_.add(_amount); _setBalance(_to, _balanceOf(_to).add(_amount)); minterAllowed[msg.sender] = mintingAllowedAmount.sub(_amount); emit Mint(msg.sender, _to, _amount); emit Transfer(address(0), _to, _amount); return true; } /** * @dev Throws if called by any account other than the masterMinter */ modifier onlyMasterMinter() { require( msg.sender == masterMinter, "FiatToken: caller is not the masterMinter" ); _; } /** * @notice Gets the minter allowance for an account. * @param minter The address to check. * @return The remaining minter allowance for the account. */ function minterAllowance(address minter) external view returns (uint256) { return minterAllowed[minter]; } /** * @notice Checks if an account is a minter. * @param account The address to check. * @return True if the account is a minter, false if the account is not a minter. */ function isMinter(address account) external view returns (bool) { return minters[account]; } /** * @notice Gets the remaining amount of fiat tokens a spender is allowed to transfer on * behalf of the token owner. * @param owner The token owner's address. * @param spender The spender's address. * @return The remaining allowance. */ function allowance(address owner, address spender) external override view returns (uint256) { return allowed[owner][spender]; } /** * @notice Gets the totalSupply of the fiat token. * @return The totalSupply of the fiat token. */ function totalSupply() external override view returns (uint256) { return totalSupply_; } /** * @notice Gets the fiat token balance of an account. * @param account The address to check. * @return balance The fiat token balance of the account. */ function balanceOf(address account) external override view returns (uint256) { return _balanceOf(account); } /** * @notice Sets a fiat token allowance for a spender to spend on behalf of the caller. * @param spender The spender's address. * @param value The allowance amount. * @return True if the operation was successful. */ function approve(address spender, uint256 value) external virtual override whenNotPaused notBlacklisted(msg.sender) notBlacklisted(spender) returns (bool) { _approve(msg.sender, spender, value); return true; } /** * @dev Internal function to set allowance. * @param owner Token owner's address. * @param spender Spender's address. * @param value Allowance amount. */ function _approve( address owner, address spender, uint256 value ) internal override { require(owner != address(0), "ERC20: approve from the zero address"); require(spender != address(0), "ERC20: approve to the zero address"); allowed[owner][spender] = value; emit Approval(owner, spender, value); } /** * @notice Transfers tokens from an address to another by spending the caller's allowance. * @dev The caller must have some fiat token allowance on the payer's tokens. * @param from Payer's address. * @param to Payee's address. * @param value Transfer amount. * @return True if the operation was successful. */ function transferFrom( address from, address to, uint256 value ) external override whenNotPaused notBlacklisted(msg.sender) notBlacklisted(from) notBlacklisted(to) returns (bool) { require( value <= allowed[from][msg.sender], "ERC20: transfer amount exceeds allowance" ); _transfer(from, to, value); allowed[from][msg.sender] = allowed[from][msg.sender].sub(value); return true; } /** * @notice Transfers tokens from the caller. * @param to Payee's address. * @param value Transfer amount. * @return True if the operation was successful. */ function transfer(address to, uint256 value) external override whenNotPaused notBlacklisted(msg.sender) notBlacklisted(to) returns (bool) { _transfer(msg.sender, to, value); return true; } /** * @dev Internal function to process transfers. * @param from Payer's address. * @param to Payee's address. * @param value Transfer amount. */ function _transfer( address from, address to, uint256 value ) internal override { require(from != address(0), "ERC20: transfer from the zero address"); require(to != address(0), "ERC20: transfer to the zero address"); require( value <= _balanceOf(from), "ERC20: transfer amount exceeds balance" ); _setBalance(from, _balanceOf(from).sub(value)); _setBalance(to, _balanceOf(to).add(value)); emit Transfer(from, to, value); } /** * @notice Adds or updates a new minter with a mint allowance. * @param minter The address of the minter. * @param minterAllowedAmount The minting amount allowed for the minter. * @return True if the operation was successful. */ function configureMinter(address minter, uint256 minterAllowedAmount) external whenNotPaused onlyMasterMinter returns (bool) { minters[minter] = true; minterAllowed[minter] = minterAllowedAmount; emit MinterConfigured(minter, minterAllowedAmount); return true; } /** * @notice Removes a minter. * @param minter The address of the minter to remove. * @return True if the operation was successful. */ function removeMinter(address minter) external onlyMasterMinter returns (bool) { minters[minter] = false; minterAllowed[minter] = 0; emit MinterRemoved(minter); return true; } /** * @notice Allows a minter to burn some of its own tokens. * @dev The caller must be a minter, must not be blacklisted, and the amount to burn * should be less than or equal to the account's balance. * @param _amount the amount of tokens to be burned. */ function burn(uint256 _amount) external whenNotPaused onlyMinters notBlacklisted(msg.sender) { uint256 balance = _balanceOf(msg.sender); require(_amount > 0, "FiatToken: burn amount not greater than 0"); require(balance >= _amount, "FiatToken: burn amount exceeds balance"); totalSupply_ = totalSupply_.sub(_amount); _setBalance(msg.sender, balance.sub(_amount)); emit Burn(msg.sender, _amount); emit Transfer(msg.sender, address(0), _amount); } /** * @notice Updates the master minter address. * @param _newMasterMinter The address of the new master minter. */ function updateMasterMinter(address _newMasterMinter) external onlyOwner { require( _newMasterMinter != address(0), "FiatToken: new masterMinter is the zero address" ); masterMinter = _newMasterMinter; emit MasterMinterChanged(masterMinter); } /** * @inheritdoc Blacklistable */ function _blacklist(address _account) internal override { _setBlacklistState(_account, true); } /** * @inheritdoc Blacklistable */ function _unBlacklist(address _account) internal override { _setBlacklistState(_account, false); } /** * @dev Helper method that sets the blacklist state of an account. * @param _account The address of the account. * @param _shouldBlacklist True if the account should be blacklisted, false if the account should be unblacklisted. */ function _setBlacklistState(address _account, bool _shouldBlacklist) internal virtual { _deprecatedBlacklisted[_account] = _shouldBlacklist; } /** * @dev Helper method that sets the balance of an account. * @param _account The address of the account. * @param _balance The new fiat token balance of the account. */ function _setBalance(address _account, uint256 _balance) internal virtual { balanceAndBlacklistStates[_account] = _balance; } /** * @inheritdoc Blacklistable */ function _isBlacklisted(address _account) internal virtual override view returns (bool) { return _deprecatedBlacklisted[_account]; } /** * @dev Helper method to obtain the balance of an account. * @param _account The address of the account. * @return The fiat token balance of the account. */ function _balanceOf(address _account) internal virtual view returns (uint256) { return balanceAndBlacklistStates[_account]; } } /** * SPDX-License-Identifier: Apache-2.0 * * Copyright (c) 2023, Circle Internet Financial, LLC. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ pragma solidity 0.6.12; import { Ownable } from "./Ownable.sol"; /** * @title Blacklistable Token * @dev Allows accounts to be blacklisted by a "blacklister" role */ abstract contract Blacklistable is Ownable { address public blacklister; mapping(address => bool) internal _deprecatedBlacklisted; event Blacklisted(address indexed _account); event UnBlacklisted(address indexed _account); event BlacklisterChanged(address indexed newBlacklister); /** * @dev Throws if called by any account other than the blacklister. */ modifier onlyBlacklister() { require( msg.sender == blacklister, "Blacklistable: caller is not the blacklister" ); _; } /** * @dev Throws if argument account is blacklisted. * @param _account The address to check. */ modifier notBlacklisted(address _account) { require( !_isBlacklisted(_account), "Blacklistable: account is blacklisted" ); _; } /** * @notice Checks if account is blacklisted. * @param _account The address to check. * @return True if the account is blacklisted, false if the account is not blacklisted. */ function isBlacklisted(address _account) external view returns (bool) { return _isBlacklisted(_account); } /** * @notice Adds account to blacklist. * @param _account The address to blacklist. */ function blacklist(address _account) external onlyBlacklister { _blacklist(_account); emit Blacklisted(_account); } /** * @notice Removes account from blacklist. * @param _account The address to remove from the blacklist. */ function unBlacklist(address _account) external onlyBlacklister { _unBlacklist(_account); emit UnBlacklisted(_account); } /** * @notice Updates the blacklister address. * @param _newBlacklister The address of the new blacklister. */ function updateBlacklister(address _newBlacklister) external onlyOwner { require( _newBlacklister != address(0), "Blacklistable: new blacklister is the zero address" ); blacklister = _newBlacklister; emit BlacklisterChanged(blacklister); } /** * @dev Checks if account is blacklisted. * @param _account The address to check. * @return true if the account is blacklisted, false otherwise. */ function _isBlacklisted(address _account) internal virtual view returns (bool); /** * @dev Helper method that blacklists an account. * @param _account The address to blacklist. */ function _blacklist(address _account) internal virtual; /** * @dev Helper method that unblacklists an account. * @param _account The address to unblacklist. */ function _unBlacklist(address _account) internal virtual; } /** * SPDX-License-Identifier: Apache-2.0 * * Copyright (c) 2023, Circle Internet Financial, LLC. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ pragma solidity 0.6.12; import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol"; abstract contract AbstractFiatTokenV1 is IERC20 { function _approve( address owner, address spender, uint256 value ) internal virtual; function _transfer( address from, address to, uint256 value ) internal virtual; } /** * SPDX-License-Identifier: Apache-2.0 * * Copyright (c) 2023, Circle Internet Financial, LLC. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ pragma solidity 0.6.12; import { Ownable } from "../v1/Ownable.sol"; import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol"; import { SafeERC20 } from "@openzeppelin/contracts/token/ERC20/SafeERC20.sol"; contract Rescuable is Ownable { using SafeERC20 for IERC20; address private _rescuer; event RescuerChanged(address indexed newRescuer); /** * @notice Returns current rescuer * @return Rescuer's address */ function rescuer() external view returns (address) { return _rescuer; } /** * @notice Revert if called by any account other than the rescuer. */ modifier onlyRescuer() { require(msg.sender == _rescuer, "Rescuable: caller is not the rescuer"); _; } /** * @notice Rescue ERC20 tokens locked up in this contract. * @param tokenContract ERC20 token contract address * @param to Recipient address * @param amount Amount to withdraw */ function rescueERC20( IERC20 tokenContract, address to, uint256 amount ) external onlyRescuer { tokenContract.safeTransfer(to, amount); } /** * @notice Updates the rescuer address. * @param newRescuer The address of the new rescuer. */ function updateRescuer(address newRescuer) external onlyOwner { require( newRescuer != address(0), "Rescuable: new rescuer is the zero address" ); _rescuer = newRescuer; emit RescuerChanged(newRescuer); } } /** * SPDX-License-Identifier: Apache-2.0 * * Copyright (c) 2023, Circle Internet Financial, LLC. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ pragma solidity 0.6.12; import { FiatTokenV1 } from "../v1/FiatTokenV1.sol"; import { Rescuable } from "./Rescuable.sol"; /** * @title FiatTokenV1_1 * @dev ERC20 Token backed by fiat reserves */ contract FiatTokenV1_1 is FiatTokenV1, Rescuable { } /** * SPDX-License-Identifier: Apache-2.0 * * Copyright (c) 2023, Circle Internet Financial, LLC. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ pragma solidity 0.6.12; import { ECRecover } from "./ECRecover.sol"; import { IERC1271 } from "../interface/IERC1271.sol"; /** * @dev Signature verification helper that can be used instead of `ECRecover.recover` to seamlessly support both ECDSA * signatures from externally owned accounts (EOAs) as well as ERC1271 signatures from smart contract wallets. * * Adapted from https://github.com/OpenZeppelin/openzeppelin-contracts/blob/21bb89ef5bfc789b9333eb05e3ba2b7b284ac77c/contracts/utils/cryptography/SignatureChecker.sol */ library SignatureChecker { /** * @dev Checks if a signature is valid for a given signer and data hash. If the signer is a smart contract, the * signature is validated against that smart contract using ERC1271, otherwise it's validated using `ECRecover.recover`. * @param signer Address of the claimed signer * @param digest Keccak-256 hash digest of the signed message * @param signature Signature byte array associated with hash */ function isValidSignatureNow( address signer, bytes32 digest, bytes memory signature ) external view returns (bool) { if (!isContract(signer)) { return ECRecover.recover(digest, signature) == signer; } return isValidERC1271SignatureNow(signer, digest, signature); } /** * @dev Checks if a signature is valid for a given signer and data hash. The signature is validated * against the signer smart contract using ERC1271. * @param signer Address of the claimed signer * @param digest Keccak-256 hash digest of the signed message * @param signature Signature byte array associated with hash * * NOTE: Unlike ECDSA signatures, contract signatures are revocable, and the outcome of this function can thus * change through time. It could return true at block N and false at block N+1 (or the opposite). */ function isValidERC1271SignatureNow( address signer, bytes32 digest, bytes memory signature ) internal view returns (bool) { (bool success, bytes memory result) = signer.staticcall( abi.encodeWithSelector( IERC1271.isValidSignature.selector, digest, signature ) ); return (success && result.length >= 32 && abi.decode(result, (bytes32)) == bytes32(IERC1271.isValidSignature.selector)); } /** * @dev Checks if the input address is a smart contract. */ function isContract(address addr) internal view returns (bool) { uint256 size; assembly { size := extcodesize(addr) } return size > 0; } } /** * SPDX-License-Identifier: Apache-2.0 * * Copyright (c) 2023, Circle Internet Financial, LLC. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ pragma solidity 0.6.12; /** * @dev Signature message hash utilities for producing digests to be consumed by {ECDSA} recovery or signing. * * The library provides methods for generating a hash of a message that conforms to the * https://eips.ethereum.org/EIPS/eip-191[EIP 191] and https://eips.ethereum.org/EIPS/eip-712[EIP 712] * specifications. */ library MessageHashUtils { /** * @dev Returns the keccak256 digest of an EIP-712 typed data (EIP-191 version `0x01`). * Adapted from https://github.com/OpenZeppelin/openzeppelin-contracts/blob/21bb89ef5bfc789b9333eb05e3ba2b7b284ac77c/contracts/utils/cryptography/MessageHashUtils.sol * * The digest is calculated from a `domainSeparator` and a `structHash`, by prefixing them with * `\\x19\\x01` and hashing the result. It corresponds to the hash signed by the * https://eips.ethereum.org/EIPS/eip-712[`eth_signTypedData`] JSON-RPC method as part of EIP-712. * * @param domainSeparator Domain separator * @param structHash Hashed EIP-712 data struct * @return digest The keccak256 digest of an EIP-712 typed data */ function toTypedDataHash(bytes32 domainSeparator, bytes32 structHash) internal pure returns (bytes32 digest) { assembly { let ptr := mload(0x40) mstore(ptr, "\\x19\\x01") mstore(add(ptr, 0x02), domainSeparator) mstore(add(ptr, 0x22), structHash) digest := keccak256(ptr, 0x42) } } } /** * SPDX-License-Identifier: Apache-2.0 * * Copyright (c) 2023, Circle Internet Financial, LLC. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ pragma solidity 0.6.12; /** * @title EIP712 * @notice A library that provides EIP712 helper functions */ library EIP712 { /** * @notice Make EIP712 domain separator * @param name Contract name * @param version Contract version * @param chainId Blockchain ID * @return Domain separator */ function makeDomainSeparator( string memory name, string memory version, uint256 chainId ) internal view returns (bytes32) { return keccak256( abi.encode( // keccak256("EIP712Domain(string name,string version,uint256 chainId,address verifyingContract)") 0x8b73c3c69bb8fe3d512ecc4cf759cc79239f7b179b0ffacaa9a75d522b39400f, keccak256(bytes(name)), keccak256(bytes(version)), chainId, address(this) ) ); } /** * @notice Make EIP712 domain separator * @param name Contract name * @param version Contract version * @return Domain separator */ function makeDomainSeparator(string memory name, string memory version) internal view returns (bytes32) { uint256 chainId; assembly { chainId := chainid() } return makeDomainSeparator(name, version, chainId); } } /** * SPDX-License-Identifier: Apache-2.0 * * Copyright (c) 2023, Circle Internet Financial, LLC. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ pragma solidity 0.6.12; /** * @title ECRecover * @notice A library that provides a safe ECDSA recovery function */ library ECRecover { /** * @notice Recover signer's address from a signed message * @dev Adapted from: https://github.com/OpenZeppelin/openzeppelin-contracts/blob/65e4ffde586ec89af3b7e9140bdc9235d1254853/contracts/cryptography/ECDSA.sol * Modifications: Accept v, r, and s as separate arguments * @param digest Keccak-256 hash digest of the signed message * @param v v of the signature * @param r r of the signature * @param s s of the signature * @return Signer address */ function recover( bytes32 digest, uint8 v, bytes32 r, bytes32 s ) internal pure returns (address) { // EIP-2 still allows signature malleability for ecrecover(). Remove this possibility and make the signature // unique. Appendix F in the Ethereum Yellow paper (https://ethereum.github.io/yellowpaper/paper.pdf), defines // the valid range for s in (281): 0 < s < secp256k1n ÷ 2 + 1, and for v in (282): v ∈ {27, 28}. Most // signatures from current libraries generate a unique signature with an s-value in the lower half order. // // If your library generates malleable signatures, such as s-values in the upper range, calculate a new s-value // with 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFEBAAEDCE6AF48A03BBFD25E8CD0364141 - s1 and flip v from 27 to 28 or // vice versa. If your library also generates signatures with 0/1 for v instead 27/28, add 27 to v to accept // these malleable signatures as well. if ( uint256(s) > 0x7FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF5D576E7357A4501DDFE92F46681B20A0 ) { revert("ECRecover: invalid signature 's' value"); } if (v != 27 && v != 28) { revert("ECRecover: invalid signature 'v' value"); } // If the signature is valid (and not malleable), return the signer address address signer = ecrecover(digest, v, r, s); require(signer != address(0), "ECRecover: invalid signature"); return signer; } /** * @notice Recover signer's address from a signed message * @dev Adapted from: https://github.com/OpenZeppelin/openzeppelin-contracts/blob/0053ee040a7ff1dbc39691c9e67a69f564930a88/contracts/utils/cryptography/ECDSA.sol * @param digest Keccak-256 hash digest of the signed message * @param signature Signature byte array associated with hash * @return Signer address */ function recover(bytes32 digest, bytes memory signature) internal pure returns (address) { require(signature.length == 65, "ECRecover: invalid signature length"); bytes32 r; bytes32 s; uint8 v; // ecrecover takes the signature parameters, and the only way to get them // currently is to use assembly. /// @solidity memory-safe-assembly assembly { r := mload(add(signature, 0x20)) s := mload(add(signature, 0x40)) v := byte(0, mload(add(signature, 0x60))) } return recover(digest, v, r, s); } } /** * SPDX-License-Identifier: Apache-2.0 * * Copyright (c) 2023, Circle Internet Financial, LLC. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ pragma solidity 0.6.12; /** * @dev Interface of the ERC1271 standard signature validation method for * contracts as defined in https://eips.ethereum.org/EIPS/eip-1271[ERC-1271]. */ interface IERC1271 { /** * @dev Should return whether the signature provided is valid for the provided data * @param hash Hash of the data to be signed * @param signature Signature byte array associated with the provided data hash * @return magicValue bytes4 magic value 0x1626ba7e when function passes */ function isValidSignature(bytes32 hash, bytes memory signature) external view returns (bytes4 magicValue); }
File 9 of 9: Comet
// SPDX-License-Identifier: BUSL-1.1 pragma solidity 0.8.15; import "./CometMainInterface.sol"; import "./ERC20.sol"; import "./vendor/@chainlink/contracts/src/v0.8/interfaces/AggregatorV3Interface.sol"; /** * @title Compound's Comet Contract * @notice An efficient monolithic money market protocol * @author Compound */ contract Comet is CometMainInterface { /** General configuration constants **/ /// @notice The admin of the protocol address public override immutable governor; /// @notice The account which may trigger pauses address public override immutable pauseGuardian; /// @notice The address of the base token contract address public override immutable baseToken; /// @notice The address of the price feed for the base token address public override immutable baseTokenPriceFeed; /// @notice The address of the extension contract delegate address public override immutable extensionDelegate; /// @notice The point in the supply rates separating the low interest rate slope and the high interest rate slope (factor) /// @dev uint64 uint public override immutable supplyKink; /// @notice Per second supply interest rate slope applied when utilization is below kink (factor) /// @dev uint64 uint public override immutable supplyPerSecondInterestRateSlopeLow; /// @notice Per second supply interest rate slope applied when utilization is above kink (factor) /// @dev uint64 uint public override immutable supplyPerSecondInterestRateSlopeHigh; /// @notice Per second supply base interest rate (factor) /// @dev uint64 uint public override immutable supplyPerSecondInterestRateBase; /// @notice The point in the borrow rate separating the low interest rate slope and the high interest rate slope (factor) /// @dev uint64 uint public override immutable borrowKink; /// @notice Per second borrow interest rate slope applied when utilization is below kink (factor) /// @dev uint64 uint public override immutable borrowPerSecondInterestRateSlopeLow; /// @notice Per second borrow interest rate slope applied when utilization is above kink (factor) /// @dev uint64 uint public override immutable borrowPerSecondInterestRateSlopeHigh; /// @notice Per second borrow base interest rate (factor) /// @dev uint64 uint public override immutable borrowPerSecondInterestRateBase; /// @notice The fraction of the liquidation penalty that goes to buyers of collateral instead of the protocol /// @dev uint64 uint public override immutable storeFrontPriceFactor; /// @notice The scale for base token (must be less than 18 decimals) /// @dev uint64 uint public override immutable baseScale; /// @notice The scale for reward tracking /// @dev uint64 uint public override immutable trackingIndexScale; /// @notice The speed at which supply rewards are tracked (in trackingIndexScale) /// @dev uint64 uint public override immutable baseTrackingSupplySpeed; /// @notice The speed at which borrow rewards are tracked (in trackingIndexScale) /// @dev uint64 uint public override immutable baseTrackingBorrowSpeed; /// @notice The minimum amount of base principal wei for rewards to accrue /// @dev This must be large enough so as to prevent division by base wei from overflowing the 64 bit indices /// @dev uint104 uint public override immutable baseMinForRewards; /// @notice The minimum base amount required to initiate a borrow uint public override immutable baseBorrowMin; /// @notice The minimum base token reserves which must be held before collateral is hodled uint public override immutable targetReserves; /// @notice The number of decimals for wrapped base token uint8 public override immutable decimals; /// @notice The number of assets this contract actually supports uint8 public override immutable numAssets; /// @notice Factor to divide by when accruing rewards in order to preserve 6 decimals (i.e. baseScale / 1e6) uint internal immutable accrualDescaleFactor; /** Collateral asset configuration (packed) **/ uint256 internal immutable asset00_a; uint256 internal immutable asset00_b; uint256 internal immutable asset01_a; uint256 internal immutable asset01_b; uint256 internal immutable asset02_a; uint256 internal immutable asset02_b; uint256 internal immutable asset03_a; uint256 internal immutable asset03_b; uint256 internal immutable asset04_a; uint256 internal immutable asset04_b; uint256 internal immutable asset05_a; uint256 internal immutable asset05_b; uint256 internal immutable asset06_a; uint256 internal immutable asset06_b; uint256 internal immutable asset07_a; uint256 internal immutable asset07_b; uint256 internal immutable asset08_a; uint256 internal immutable asset08_b; uint256 internal immutable asset09_a; uint256 internal immutable asset09_b; uint256 internal immutable asset10_a; uint256 internal immutable asset10_b; uint256 internal immutable asset11_a; uint256 internal immutable asset11_b; uint256 internal immutable asset12_a; uint256 internal immutable asset12_b; uint256 internal immutable asset13_a; uint256 internal immutable asset13_b; uint256 internal immutable asset14_a; uint256 internal immutable asset14_b; /** * @notice Construct a new protocol instance * @param config The mapping of initial/constant parameters **/ constructor(Configuration memory config) { // Sanity checks uint8 decimals_ = ERC20(config.baseToken).decimals(); if (decimals_ > MAX_BASE_DECIMALS) revert BadDecimals(); if (config.storeFrontPriceFactor > FACTOR_SCALE) revert BadDiscount(); if (config.assetConfigs.length > MAX_ASSETS) revert TooManyAssets(); if (config.baseMinForRewards == 0) revert BadMinimum(); if (AggregatorV3Interface(config.baseTokenPriceFeed).decimals() != PRICE_FEED_DECIMALS) revert BadDecimals(); // Copy configuration unchecked { governor = config.governor; pauseGuardian = config.pauseGuardian; baseToken = config.baseToken; baseTokenPriceFeed = config.baseTokenPriceFeed; extensionDelegate = config.extensionDelegate; storeFrontPriceFactor = config.storeFrontPriceFactor; decimals = decimals_; baseScale = uint64(10 ** decimals_); trackingIndexScale = config.trackingIndexScale; if (baseScale < BASE_ACCRUAL_SCALE) revert BadDecimals(); accrualDescaleFactor = baseScale / BASE_ACCRUAL_SCALE; baseMinForRewards = config.baseMinForRewards; baseTrackingSupplySpeed = config.baseTrackingSupplySpeed; baseTrackingBorrowSpeed = config.baseTrackingBorrowSpeed; baseBorrowMin = config.baseBorrowMin; targetReserves = config.targetReserves; } // Set interest rate model configs unchecked { supplyKink = config.supplyKink; supplyPerSecondInterestRateSlopeLow = config.supplyPerYearInterestRateSlopeLow / SECONDS_PER_YEAR; supplyPerSecondInterestRateSlopeHigh = config.supplyPerYearInterestRateSlopeHigh / SECONDS_PER_YEAR; supplyPerSecondInterestRateBase = config.supplyPerYearInterestRateBase / SECONDS_PER_YEAR; borrowKink = config.borrowKink; borrowPerSecondInterestRateSlopeLow = config.borrowPerYearInterestRateSlopeLow / SECONDS_PER_YEAR; borrowPerSecondInterestRateSlopeHigh = config.borrowPerYearInterestRateSlopeHigh / SECONDS_PER_YEAR; borrowPerSecondInterestRateBase = config.borrowPerYearInterestRateBase / SECONDS_PER_YEAR; } // Set asset info numAssets = uint8(config.assetConfigs.length); (asset00_a, asset00_b) = getPackedAssetInternal(config.assetConfigs, 0); (asset01_a, asset01_b) = getPackedAssetInternal(config.assetConfigs, 1); (asset02_a, asset02_b) = getPackedAssetInternal(config.assetConfigs, 2); (asset03_a, asset03_b) = getPackedAssetInternal(config.assetConfigs, 3); (asset04_a, asset04_b) = getPackedAssetInternal(config.assetConfigs, 4); (asset05_a, asset05_b) = getPackedAssetInternal(config.assetConfigs, 5); (asset06_a, asset06_b) = getPackedAssetInternal(config.assetConfigs, 6); (asset07_a, asset07_b) = getPackedAssetInternal(config.assetConfigs, 7); (asset08_a, asset08_b) = getPackedAssetInternal(config.assetConfigs, 8); (asset09_a, asset09_b) = getPackedAssetInternal(config.assetConfigs, 9); (asset10_a, asset10_b) = getPackedAssetInternal(config.assetConfigs, 10); (asset11_a, asset11_b) = getPackedAssetInternal(config.assetConfigs, 11); (asset12_a, asset12_b) = getPackedAssetInternal(config.assetConfigs, 12); (asset13_a, asset13_b) = getPackedAssetInternal(config.assetConfigs, 13); (asset14_a, asset14_b) = getPackedAssetInternal(config.assetConfigs, 14); } /** * @notice Initialize storage for the contract * @dev Can be used from constructor or proxy */ function initializeStorage() override external { if (lastAccrualTime != 0) revert AlreadyInitialized(); // Initialize aggregates lastAccrualTime = getNowInternal(); baseSupplyIndex = BASE_INDEX_SCALE; baseBorrowIndex = BASE_INDEX_SCALE; // Implicit initialization (not worth increasing contract size) // trackingSupplyIndex = 0; // trackingBorrowIndex = 0; } /** * @dev Checks and gets the packed asset info for storage */ function getPackedAssetInternal(AssetConfig[] memory assetConfigs, uint i) internal view returns (uint256, uint256) { AssetConfig memory assetConfig; if (i < assetConfigs.length) { assembly { assetConfig := mload(add(add(assetConfigs, 0x20), mul(i, 0x20))) } } else { return (0, 0); } address asset = assetConfig.asset; address priceFeed = assetConfig.priceFeed; uint8 decimals_ = assetConfig.decimals; // Short-circuit if asset is nil if (asset == address(0)) { return (0, 0); } // Sanity check price feed and asset decimals if (AggregatorV3Interface(priceFeed).decimals() != PRICE_FEED_DECIMALS) revert BadDecimals(); if (ERC20(asset).decimals() != decimals_) revert BadDecimals(); // Ensure collateral factors are within range if (assetConfig.borrowCollateralFactor >= assetConfig.liquidateCollateralFactor) revert BorrowCFTooLarge(); if (assetConfig.liquidateCollateralFactor > MAX_COLLATERAL_FACTOR) revert LiquidateCFTooLarge(); unchecked { // Keep 4 decimals for each factor uint64 descale = FACTOR_SCALE / 1e4; uint16 borrowCollateralFactor = uint16(assetConfig.borrowCollateralFactor / descale); uint16 liquidateCollateralFactor = uint16(assetConfig.liquidateCollateralFactor / descale); uint16 liquidationFactor = uint16(assetConfig.liquidationFactor / descale); // Be nice and check descaled values are still within range if (borrowCollateralFactor >= liquidateCollateralFactor) revert BorrowCFTooLarge(); // Keep whole units of asset for supply cap uint64 supplyCap = uint64(assetConfig.supplyCap / (10 ** decimals_)); uint256 word_a = (uint160(asset) << 0 | uint256(borrowCollateralFactor) << 160 | uint256(liquidateCollateralFactor) << 176 | uint256(liquidationFactor) << 192); uint256 word_b = (uint160(priceFeed) << 0 | uint256(decimals_) << 160 | uint256(supplyCap) << 168); return (word_a, word_b); } } /** * @notice Get the i-th asset info, according to the order they were passed in originally * @param i The index of the asset info to get * @return The asset info object */ function getAssetInfo(uint8 i) override public view returns (AssetInfo memory) { if (i >= numAssets) revert BadAsset(); uint256 word_a; uint256 word_b; if (i == 0) { word_a = asset00_a; word_b = asset00_b; } else if (i == 1) { word_a = asset01_a; word_b = asset01_b; } else if (i == 2) { word_a = asset02_a; word_b = asset02_b; } else if (i == 3) { word_a = asset03_a; word_b = asset03_b; } else if (i == 4) { word_a = asset04_a; word_b = asset04_b; } else if (i == 5) { word_a = asset05_a; word_b = asset05_b; } else if (i == 6) { word_a = asset06_a; word_b = asset06_b; } else if (i == 7) { word_a = asset07_a; word_b = asset07_b; } else if (i == 8) { word_a = asset08_a; word_b = asset08_b; } else if (i == 9) { word_a = asset09_a; word_b = asset09_b; } else if (i == 10) { word_a = asset10_a; word_b = asset10_b; } else if (i == 11) { word_a = asset11_a; word_b = asset11_b; } else if (i == 12) { word_a = asset12_a; word_b = asset12_b; } else if (i == 13) { word_a = asset13_a; word_b = asset13_b; } else if (i == 14) { word_a = asset14_a; word_b = asset14_b; } else { revert Absurd(); } address asset = address(uint160(word_a & type(uint160).max)); uint64 rescale = FACTOR_SCALE / 1e4; uint64 borrowCollateralFactor = uint64(((word_a >> 160) & type(uint16).max) * rescale); uint64 liquidateCollateralFactor = uint64(((word_a >> 176) & type(uint16).max) * rescale); uint64 liquidationFactor = uint64(((word_a >> 192) & type(uint16).max) * rescale); address priceFeed = address(uint160(word_b & type(uint160).max)); uint8 decimals_ = uint8(((word_b >> 160) & type(uint8).max)); uint64 scale = uint64(10 ** decimals_); uint128 supplyCap = uint128(((word_b >> 168) & type(uint64).max) * scale); return AssetInfo({ offset: i, asset: asset, priceFeed: priceFeed, scale: scale, borrowCollateralFactor: borrowCollateralFactor, liquidateCollateralFactor: liquidateCollateralFactor, liquidationFactor: liquidationFactor, supplyCap: supplyCap }); } /** * @dev Determine index of asset that matches given address */ function getAssetInfoByAddress(address asset) override public view returns (AssetInfo memory) { for (uint8 i = 0; i < numAssets; ) { AssetInfo memory assetInfo = getAssetInfo(i); if (assetInfo.asset == asset) { return assetInfo; } unchecked { i++; } } revert BadAsset(); } /** * @return The current timestamp **/ function getNowInternal() virtual internal view returns (uint40) { if (block.timestamp >= 2**40) revert TimestampTooLarge(); return uint40(block.timestamp); } /** * @dev Calculate accrued interest indices for base token supply and borrows **/ function accruedInterestIndices(uint timeElapsed) internal view returns (uint64, uint64) { uint64 baseSupplyIndex_ = baseSupplyIndex; uint64 baseBorrowIndex_ = baseBorrowIndex; if (timeElapsed > 0) { uint utilization = getUtilization(); uint supplyRate = getSupplyRate(utilization); uint borrowRate = getBorrowRate(utilization); baseSupplyIndex_ += safe64(mulFactor(baseSupplyIndex_, supplyRate * timeElapsed)); baseBorrowIndex_ += safe64(mulFactor(baseBorrowIndex_, borrowRate * timeElapsed)); } return (baseSupplyIndex_, baseBorrowIndex_); } /** * @dev Accrue interest (and rewards) in base token supply and borrows **/ function accrueInternal() internal { uint40 now_ = getNowInternal(); uint timeElapsed = uint256(now_ - lastAccrualTime); if (timeElapsed > 0) { (baseSupplyIndex, baseBorrowIndex) = accruedInterestIndices(timeElapsed); if (totalSupplyBase >= baseMinForRewards) { trackingSupplyIndex += safe64(divBaseWei(baseTrackingSupplySpeed * timeElapsed, totalSupplyBase)); } if (totalBorrowBase >= baseMinForRewards) { trackingBorrowIndex += safe64(divBaseWei(baseTrackingBorrowSpeed * timeElapsed, totalBorrowBase)); } lastAccrualTime = now_; } } /** * @notice Accrue interest and rewards for an account **/ function accrueAccount(address account) override external { accrueInternal(); UserBasic memory basic = userBasic[account]; updateBasePrincipal(account, basic, basic.principal); } /** * @dev Note: Does not accrue interest first * @param utilization The utilization to check the supply rate for * @return The per second supply rate at `utilization` */ function getSupplyRate(uint utilization) override public view returns (uint64) { if (utilization <= supplyKink) { // interestRateBase + interestRateSlopeLow * utilization return safe64(supplyPerSecondInterestRateBase + mulFactor(supplyPerSecondInterestRateSlopeLow, utilization)); } else { // interestRateBase + interestRateSlopeLow * kink + interestRateSlopeHigh * (utilization - kink) return safe64(supplyPerSecondInterestRateBase + mulFactor(supplyPerSecondInterestRateSlopeLow, supplyKink) + mulFactor(supplyPerSecondInterestRateSlopeHigh, (utilization - supplyKink))); } } /** * @dev Note: Does not accrue interest first * @param utilization The utilization to check the borrow rate for * @return The per second borrow rate at `utilization` */ function getBorrowRate(uint utilization) override public view returns (uint64) { if (utilization <= borrowKink) { // interestRateBase + interestRateSlopeLow * utilization return safe64(borrowPerSecondInterestRateBase + mulFactor(borrowPerSecondInterestRateSlopeLow, utilization)); } else { // interestRateBase + interestRateSlopeLow * kink + interestRateSlopeHigh * (utilization - kink) return safe64(borrowPerSecondInterestRateBase + mulFactor(borrowPerSecondInterestRateSlopeLow, borrowKink) + mulFactor(borrowPerSecondInterestRateSlopeHigh, (utilization - borrowKink))); } } /** * @dev Note: Does not accrue interest first * @return The utilization rate of the base asset */ function getUtilization() override public view returns (uint) { uint totalSupply_ = presentValueSupply(baseSupplyIndex, totalSupplyBase); uint totalBorrow_ = presentValueBorrow(baseBorrowIndex, totalBorrowBase); if (totalSupply_ == 0) { return 0; } else { return totalBorrow_ * FACTOR_SCALE / totalSupply_; } } /** * @notice Get the current price from a feed * @param priceFeed The address of a price feed * @return The price, scaled by `PRICE_SCALE` */ function getPrice(address priceFeed) override public view returns (uint256) { (, int price, , , ) = AggregatorV3Interface(priceFeed).latestRoundData(); if (price <= 0) revert BadPrice(); return uint256(price); } /** * @notice Gets the total balance of protocol collateral reserves for an asset * @dev Note: Reverts if collateral reserves are somehow negative, which should not be possible * @param asset The collateral asset */ function getCollateralReserves(address asset) override public view returns (uint) { return ERC20(asset).balanceOf(address(this)) - totalsCollateral[asset].totalSupplyAsset; } /** * @notice Gets the total amount of protocol reserves of the base asset */ function getReserves() override public view returns (int) { (uint64 baseSupplyIndex_, uint64 baseBorrowIndex_) = accruedInterestIndices(getNowInternal() - lastAccrualTime); uint balance = ERC20(baseToken).balanceOf(address(this)); uint totalSupply_ = presentValueSupply(baseSupplyIndex_, totalSupplyBase); uint totalBorrow_ = presentValueBorrow(baseBorrowIndex_, totalBorrowBase); return signed256(balance) - signed256(totalSupply_) + signed256(totalBorrow_); } /** * @notice Check whether an account has enough collateral to borrow * @param account The address to check * @return Whether the account is minimally collateralized enough to borrow */ function isBorrowCollateralized(address account) override public view returns (bool) { int104 principal = userBasic[account].principal; if (principal >= 0) { return true; } uint16 assetsIn = userBasic[account].assetsIn; int liquidity = signedMulPrice( presentValue(principal), getPrice(baseTokenPriceFeed), uint64(baseScale) ); for (uint8 i = 0; i < numAssets; ) { if (isInAsset(assetsIn, i)) { if (liquidity >= 0) { return true; } AssetInfo memory asset = getAssetInfo(i); uint newAmount = mulPrice( userCollateral[account][asset.asset].balance, getPrice(asset.priceFeed), asset.scale ); liquidity += signed256(mulFactor( newAmount, asset.borrowCollateralFactor )); } unchecked { i++; } } return liquidity >= 0; } /** * @notice Check whether an account has enough collateral to not be liquidated * @param account The address to check * @return Whether the account is minimally collateralized enough to not be liquidated */ function isLiquidatable(address account) override public view returns (bool) { int104 principal = userBasic[account].principal; if (principal >= 0) { return false; } uint16 assetsIn = userBasic[account].assetsIn; int liquidity = signedMulPrice( presentValue(principal), getPrice(baseTokenPriceFeed), uint64(baseScale) ); for (uint8 i = 0; i < numAssets; ) { if (isInAsset(assetsIn, i)) { if (liquidity >= 0) { return false; } AssetInfo memory asset = getAssetInfo(i); uint newAmount = mulPrice( userCollateral[account][asset.asset].balance, getPrice(asset.priceFeed), asset.scale ); liquidity += signed256(mulFactor( newAmount, asset.liquidateCollateralFactor )); } unchecked { i++; } } return liquidity < 0; } /** * @dev The change in principal broken into repay and supply amounts */ function repayAndSupplyAmount(int104 oldPrincipal, int104 newPrincipal) internal pure returns (uint104, uint104) { // If the new principal is less than the old principal, then no amount has been repaid or supplied if (newPrincipal < oldPrincipal) return (0, 0); if (newPrincipal <= 0) { return (uint104(newPrincipal - oldPrincipal), 0); } else if (oldPrincipal >= 0) { return (0, uint104(newPrincipal - oldPrincipal)); } else { return (uint104(-oldPrincipal), uint104(newPrincipal)); } } /** * @dev The change in principal broken into withdraw and borrow amounts */ function withdrawAndBorrowAmount(int104 oldPrincipal, int104 newPrincipal) internal pure returns (uint104, uint104) { // If the new principal is greater than the old principal, then no amount has been withdrawn or borrowed if (newPrincipal > oldPrincipal) return (0, 0); if (newPrincipal >= 0) { return (uint104(oldPrincipal - newPrincipal), 0); } else if (oldPrincipal <= 0) { return (0, uint104(oldPrincipal - newPrincipal)); } else { return (uint104(oldPrincipal), uint104(-newPrincipal)); } } /** * @notice Pauses different actions within Comet * @param supplyPaused Boolean for pausing supply actions * @param transferPaused Boolean for pausing transfer actions * @param withdrawPaused Boolean for pausing withdraw actions * @param absorbPaused Boolean for pausing absorb actions * @param buyPaused Boolean for pausing buy actions */ function pause( bool supplyPaused, bool transferPaused, bool withdrawPaused, bool absorbPaused, bool buyPaused ) override external { if (msg.sender != governor && msg.sender != pauseGuardian) revert Unauthorized(); pauseFlags = uint8(0) | (toUInt8(supplyPaused) << PAUSE_SUPPLY_OFFSET) | (toUInt8(transferPaused) << PAUSE_TRANSFER_OFFSET) | (toUInt8(withdrawPaused) << PAUSE_WITHDRAW_OFFSET) | (toUInt8(absorbPaused) << PAUSE_ABSORB_OFFSET) | (toUInt8(buyPaused) << PAUSE_BUY_OFFSET); emit PauseAction(supplyPaused, transferPaused, withdrawPaused, absorbPaused, buyPaused); } /** * @return Whether or not supply actions are paused */ function isSupplyPaused() override public view returns (bool) { return toBool(pauseFlags & (uint8(1) << PAUSE_SUPPLY_OFFSET)); } /** * @return Whether or not transfer actions are paused */ function isTransferPaused() override public view returns (bool) { return toBool(pauseFlags & (uint8(1) << PAUSE_TRANSFER_OFFSET)); } /** * @return Whether or not withdraw actions are paused */ function isWithdrawPaused() override public view returns (bool) { return toBool(pauseFlags & (uint8(1) << PAUSE_WITHDRAW_OFFSET)); } /** * @return Whether or not absorb actions are paused */ function isAbsorbPaused() override public view returns (bool) { return toBool(pauseFlags & (uint8(1) << PAUSE_ABSORB_OFFSET)); } /** * @return Whether or not buy actions are paused */ function isBuyPaused() override public view returns (bool) { return toBool(pauseFlags & (uint8(1) << PAUSE_BUY_OFFSET)); } /** * @dev Multiply a number by a factor */ function mulFactor(uint n, uint factor) internal pure returns (uint) { return n * factor / FACTOR_SCALE; } /** * @dev Divide a number by an amount of base */ function divBaseWei(uint n, uint baseWei) internal view returns (uint) { return n * baseScale / baseWei; } /** * @dev Multiply a `fromScale` quantity by a price, returning a common price quantity */ function mulPrice(uint n, uint price, uint64 fromScale) internal pure returns (uint) { return n * price / fromScale; } /** * @dev Multiply a signed `fromScale` quantity by a price, returning a common price quantity */ function signedMulPrice(int n, uint price, uint64 fromScale) internal pure returns (int) { return n * signed256(price) / int256(uint256(fromScale)); } /** * @dev Divide a common price quantity by a price, returning a `toScale` quantity */ function divPrice(uint n, uint price, uint64 toScale) internal pure returns (uint) { return n * toScale / price; } /** * @dev Whether user has a non-zero balance of an asset, given assetsIn flags */ function isInAsset(uint16 assetsIn, uint8 assetOffset) internal pure returns (bool) { return (assetsIn & (uint16(1) << assetOffset) != 0); } /** * @dev Update assetsIn bit vector if user has entered or exited an asset */ function updateAssetsIn( address account, AssetInfo memory assetInfo, uint128 initialUserBalance, uint128 finalUserBalance ) internal { if (initialUserBalance == 0 && finalUserBalance != 0) { // set bit for asset userBasic[account].assetsIn |= (uint16(1) << assetInfo.offset); } else if (initialUserBalance != 0 && finalUserBalance == 0) { // clear bit for asset userBasic[account].assetsIn &= ~(uint16(1) << assetInfo.offset); } } /** * @dev Write updated principal to store and tracking participation */ function updateBasePrincipal(address account, UserBasic memory basic, int104 principalNew) internal { int104 principal = basic.principal; basic.principal = principalNew; if (principal >= 0) { uint indexDelta = uint256(trackingSupplyIndex - basic.baseTrackingIndex); basic.baseTrackingAccrued += safe64(uint104(principal) * indexDelta / trackingIndexScale / accrualDescaleFactor); } else { uint indexDelta = uint256(trackingBorrowIndex - basic.baseTrackingIndex); basic.baseTrackingAccrued += safe64(uint104(-principal) * indexDelta / trackingIndexScale / accrualDescaleFactor); } if (principalNew >= 0) { basic.baseTrackingIndex = trackingSupplyIndex; } else { basic.baseTrackingIndex = trackingBorrowIndex; } userBasic[account] = basic; } /** * @dev Safe ERC20 transfer in, assumes no fee is charged and amount is transferred */ function doTransferIn(address asset, address from, uint amount) internal { bool success = ERC20(asset).transferFrom(from, address(this), amount); if (!success) revert TransferInFailed(); } /** * @dev Safe ERC20 transfer out */ function doTransferOut(address asset, address to, uint amount) internal { bool success = ERC20(asset).transfer(to, amount); if (!success) revert TransferOutFailed(); } /** * @notice Supply an amount of asset to the protocol * @param asset The asset to supply * @param amount The quantity to supply */ function supply(address asset, uint amount) override external { return supplyInternal(msg.sender, msg.sender, msg.sender, asset, amount); } /** * @notice Supply an amount of asset to dst * @param dst The address which will hold the balance * @param asset The asset to supply * @param amount The quantity to supply */ function supplyTo(address dst, address asset, uint amount) override external { return supplyInternal(msg.sender, msg.sender, dst, asset, amount); } /** * @notice Supply an amount of asset from `from` to dst, if allowed * @param from The supplier address * @param dst The address which will hold the balance * @param asset The asset to supply * @param amount The quantity to supply */ function supplyFrom(address from, address dst, address asset, uint amount) override external { return supplyInternal(msg.sender, from, dst, asset, amount); } /** * @dev Supply either collateral or base asset, depending on the asset, if operator is allowed * @dev Note: Specifying an `amount` of uint256.max will repay all of `dst`'s accrued base borrow balance */ function supplyInternal(address operator, address from, address dst, address asset, uint amount) internal { if (isSupplyPaused()) revert Paused(); if (!hasPermission(from, operator)) revert Unauthorized(); if (asset == baseToken) { if (amount == type(uint256).max) { amount = borrowBalanceOf(dst); } return supplyBase(from, dst, amount); } else { return supplyCollateral(from, dst, asset, safe128(amount)); } } /** * @dev Supply an amount of base asset from `from` to dst */ function supplyBase(address from, address dst, uint256 amount) internal { doTransferIn(baseToken, from, amount); accrueInternal(); UserBasic memory dstUser = userBasic[dst]; int104 dstPrincipal = dstUser.principal; int256 dstBalance = presentValue(dstPrincipal) + signed256(amount); int104 dstPrincipalNew = principalValue(dstBalance); (uint104 repayAmount, uint104 supplyAmount) = repayAndSupplyAmount(dstPrincipal, dstPrincipalNew); totalSupplyBase += supplyAmount; totalBorrowBase -= repayAmount; updateBasePrincipal(dst, dstUser, dstPrincipalNew); emit Supply(from, dst, amount); if (supplyAmount > 0) { emit Transfer(address(0), dst, presentValueSupply(baseSupplyIndex, supplyAmount)); } } /** * @dev Supply an amount of collateral asset from `from` to dst */ function supplyCollateral(address from, address dst, address asset, uint128 amount) internal { doTransferIn(asset, from, amount); AssetInfo memory assetInfo = getAssetInfoByAddress(asset); TotalsCollateral memory totals = totalsCollateral[asset]; totals.totalSupplyAsset += amount; if (totals.totalSupplyAsset > assetInfo.supplyCap) revert SupplyCapExceeded(); uint128 dstCollateral = userCollateral[dst][asset].balance; uint128 dstCollateralNew = dstCollateral + amount; totalsCollateral[asset] = totals; userCollateral[dst][asset].balance = dstCollateralNew; updateAssetsIn(dst, assetInfo, dstCollateral, dstCollateralNew); emit SupplyCollateral(from, dst, asset, amount); } /** * @notice ERC20 transfer an amount of base token to dst * @param dst The recipient address * @param amount The quantity to transfer * @return true */ function transfer(address dst, uint amount) override external returns (bool) { transferInternal(msg.sender, msg.sender, dst, baseToken, amount); return true; } /** * @notice ERC20 transfer an amount of base token from src to dst, if allowed * @param src The sender address * @param dst The recipient address * @param amount The quantity to transfer * @return true */ function transferFrom(address src, address dst, uint amount) override external returns (bool) { transferInternal(msg.sender, src, dst, baseToken, amount); return true; } /** * @notice Transfer an amount of asset to dst * @param dst The recipient address * @param asset The asset to transfer * @param amount The quantity to transfer */ function transferAsset(address dst, address asset, uint amount) override external { return transferInternal(msg.sender, msg.sender, dst, asset, amount); } /** * @notice Transfer an amount of asset from src to dst, if allowed * @param src The sender address * @param dst The recipient address * @param asset The asset to transfer * @param amount The quantity to transfer */ function transferAssetFrom(address src, address dst, address asset, uint amount) override external { return transferInternal(msg.sender, src, dst, asset, amount); } /** * @dev Transfer either collateral or base asset, depending on the asset, if operator is allowed * @dev Note: Specifying an `amount` of uint256.max will transfer all of `src`'s accrued base balance */ function transferInternal(address operator, address src, address dst, address asset, uint amount) internal { if (isTransferPaused()) revert Paused(); if (!hasPermission(src, operator)) revert Unauthorized(); if (src == dst) revert NoSelfTransfer(); if (asset == baseToken) { if (amount == type(uint256).max) { amount = balanceOf(src); } return transferBase(src, dst, amount); } else { return transferCollateral(src, dst, asset, safe128(amount)); } } /** * @dev Transfer an amount of base asset from src to dst, borrowing if possible/necessary */ function transferBase(address src, address dst, uint256 amount) internal { accrueInternal(); UserBasic memory srcUser = userBasic[src]; UserBasic memory dstUser = userBasic[dst]; int104 srcPrincipal = srcUser.principal; int104 dstPrincipal = dstUser.principal; int256 srcBalance = presentValue(srcPrincipal) - signed256(amount); int256 dstBalance = presentValue(dstPrincipal) + signed256(amount); int104 srcPrincipalNew = principalValue(srcBalance); int104 dstPrincipalNew = principalValue(dstBalance); (uint104 withdrawAmount, uint104 borrowAmount) = withdrawAndBorrowAmount(srcPrincipal, srcPrincipalNew); (uint104 repayAmount, uint104 supplyAmount) = repayAndSupplyAmount(dstPrincipal, dstPrincipalNew); // Note: Instead of `total += addAmount - subAmount` to avoid underflow errors. totalSupplyBase = totalSupplyBase + supplyAmount - withdrawAmount; totalBorrowBase = totalBorrowBase + borrowAmount - repayAmount; updateBasePrincipal(src, srcUser, srcPrincipalNew); updateBasePrincipal(dst, dstUser, dstPrincipalNew); if (srcBalance < 0) { if (uint256(-srcBalance) < baseBorrowMin) revert BorrowTooSmall(); if (!isBorrowCollateralized(src)) revert NotCollateralized(); } if (withdrawAmount > 0) { emit Transfer(src, address(0), presentValueSupply(baseSupplyIndex, withdrawAmount)); } if (supplyAmount > 0) { emit Transfer(address(0), dst, presentValueSupply(baseSupplyIndex, supplyAmount)); } } /** * @dev Transfer an amount of collateral asset from src to dst */ function transferCollateral(address src, address dst, address asset, uint128 amount) internal { uint128 srcCollateral = userCollateral[src][asset].balance; uint128 dstCollateral = userCollateral[dst][asset].balance; uint128 srcCollateralNew = srcCollateral - amount; uint128 dstCollateralNew = dstCollateral + amount; userCollateral[src][asset].balance = srcCollateralNew; userCollateral[dst][asset].balance = dstCollateralNew; AssetInfo memory assetInfo = getAssetInfoByAddress(asset); updateAssetsIn(src, assetInfo, srcCollateral, srcCollateralNew); updateAssetsIn(dst, assetInfo, dstCollateral, dstCollateralNew); // Note: no accrue interest, BorrowCF < LiquidationCF covers small changes if (!isBorrowCollateralized(src)) revert NotCollateralized(); emit TransferCollateral(src, dst, asset, amount); } /** * @notice Withdraw an amount of asset from the protocol * @param asset The asset to withdraw * @param amount The quantity to withdraw */ function withdraw(address asset, uint amount) override external { return withdrawInternal(msg.sender, msg.sender, msg.sender, asset, amount); } /** * @notice Withdraw an amount of asset to `to` * @param to The recipient address * @param asset The asset to withdraw * @param amount The quantity to withdraw */ function withdrawTo(address to, address asset, uint amount) override external { return withdrawInternal(msg.sender, msg.sender, to, asset, amount); } /** * @notice Withdraw an amount of asset from src to `to`, if allowed * @param src The sender address * @param to The recipient address * @param asset The asset to withdraw * @param amount The quantity to withdraw */ function withdrawFrom(address src, address to, address asset, uint amount) override external { return withdrawInternal(msg.sender, src, to, asset, amount); } /** * @dev Withdraw either collateral or base asset, depending on the asset, if operator is allowed * @dev Note: Specifying an `amount` of uint256.max will withdraw all of `src`'s accrued base balance */ function withdrawInternal(address operator, address src, address to, address asset, uint amount) internal { if (isWithdrawPaused()) revert Paused(); if (!hasPermission(src, operator)) revert Unauthorized(); if (asset == baseToken) { if (amount == type(uint256).max) { amount = balanceOf(src); } return withdrawBase(src, to, amount); } else { return withdrawCollateral(src, to, asset, safe128(amount)); } } /** * @dev Withdraw an amount of base asset from src to `to`, borrowing if possible/necessary */ function withdrawBase(address src, address to, uint256 amount) internal { accrueInternal(); UserBasic memory srcUser = userBasic[src]; int104 srcPrincipal = srcUser.principal; int256 srcBalance = presentValue(srcPrincipal) - signed256(amount); int104 srcPrincipalNew = principalValue(srcBalance); (uint104 withdrawAmount, uint104 borrowAmount) = withdrawAndBorrowAmount(srcPrincipal, srcPrincipalNew); totalSupplyBase -= withdrawAmount; totalBorrowBase += borrowAmount; updateBasePrincipal(src, srcUser, srcPrincipalNew); if (srcBalance < 0) { if (uint256(-srcBalance) < baseBorrowMin) revert BorrowTooSmall(); if (!isBorrowCollateralized(src)) revert NotCollateralized(); } doTransferOut(baseToken, to, amount); emit Withdraw(src, to, amount); if (withdrawAmount > 0) { emit Transfer(src, address(0), presentValueSupply(baseSupplyIndex, withdrawAmount)); } } /** * @dev Withdraw an amount of collateral asset from src to `to` */ function withdrawCollateral(address src, address to, address asset, uint128 amount) internal { uint128 srcCollateral = userCollateral[src][asset].balance; uint128 srcCollateralNew = srcCollateral - amount; totalsCollateral[asset].totalSupplyAsset -= amount; userCollateral[src][asset].balance = srcCollateralNew; AssetInfo memory assetInfo = getAssetInfoByAddress(asset); updateAssetsIn(src, assetInfo, srcCollateral, srcCollateralNew); // Note: no accrue interest, BorrowCF < LiquidationCF covers small changes if (!isBorrowCollateralized(src)) revert NotCollateralized(); doTransferOut(asset, to, amount); emit WithdrawCollateral(src, to, asset, amount); } /** * @notice Absorb a list of underwater accounts onto the protocol balance sheet * @param absorber The recipient of the incentive paid to the caller of absorb * @param accounts The list of underwater accounts to absorb */ function absorb(address absorber, address[] calldata accounts) override external { if (isAbsorbPaused()) revert Paused(); uint startGas = gasleft(); accrueInternal(); for (uint i = 0; i < accounts.length; ) { absorbInternal(absorber, accounts[i]); unchecked { i++; } } uint gasUsed = startGas - gasleft(); // Note: liquidator points are an imperfect tool for governance, // to be used while evaluating strategies for incentivizing absorption. // Using gas price instead of base fee would more accurately reflect spend, // but is also subject to abuse if refunds were to be given automatically. LiquidatorPoints memory points = liquidatorPoints[absorber]; points.numAbsorbs++; points.numAbsorbed += safe64(accounts.length); points.approxSpend += safe128(gasUsed * block.basefee); liquidatorPoints[absorber] = points; } /** * @dev Transfer user's collateral and debt to the protocol itself. */ function absorbInternal(address absorber, address account) internal { if (!isLiquidatable(account)) revert NotLiquidatable(); UserBasic memory accountUser = userBasic[account]; int104 oldPrincipal = accountUser.principal; int256 oldBalance = presentValue(oldPrincipal); uint16 assetsIn = accountUser.assetsIn; uint256 basePrice = getPrice(baseTokenPriceFeed); uint256 deltaValue = 0; for (uint8 i = 0; i < numAssets; ) { if (isInAsset(assetsIn, i)) { AssetInfo memory assetInfo = getAssetInfo(i); address asset = assetInfo.asset; uint128 seizeAmount = userCollateral[account][asset].balance; userCollateral[account][asset].balance = 0; totalsCollateral[asset].totalSupplyAsset -= seizeAmount; uint256 value = mulPrice(seizeAmount, getPrice(assetInfo.priceFeed), assetInfo.scale); deltaValue += mulFactor(value, assetInfo.liquidationFactor); emit AbsorbCollateral(absorber, account, asset, seizeAmount, value); } unchecked { i++; } } uint256 deltaBalance = divPrice(deltaValue, basePrice, uint64(baseScale)); int256 newBalance = oldBalance + signed256(deltaBalance); // New balance will not be negative, all excess debt absorbed by reserves if (newBalance < 0) { newBalance = 0; } int104 newPrincipal = principalValue(newBalance); updateBasePrincipal(account, accountUser, newPrincipal); // reset assetsIn userBasic[account].assetsIn = 0; (uint104 repayAmount, uint104 supplyAmount) = repayAndSupplyAmount(oldPrincipal, newPrincipal); // Reserves are decreased by increasing total supply and decreasing borrows // the amount of debt repaid by reserves is `newBalance - oldBalance` totalSupplyBase += supplyAmount; totalBorrowBase -= repayAmount; uint256 basePaidOut = unsigned256(newBalance - oldBalance); uint256 valueOfBasePaidOut = mulPrice(basePaidOut, basePrice, uint64(baseScale)); emit AbsorbDebt(absorber, account, basePaidOut, valueOfBasePaidOut); if (newPrincipal > 0) { emit Transfer(address(0), account, presentValueSupply(baseSupplyIndex, unsigned104(newPrincipal))); } } /** * @notice Buy collateral from the protocol using base tokens, increasing protocol reserves A minimum collateral amount should be specified to indicate the maximum slippage acceptable for the buyer. * @param asset The asset to buy * @param minAmount The minimum amount of collateral tokens that should be received by the buyer * @param baseAmount The amount of base tokens used to buy the collateral * @param recipient The recipient address */ function buyCollateral(address asset, uint minAmount, uint baseAmount, address recipient) override external { if (isBuyPaused()) revert Paused(); int reserves = getReserves(); if (reserves >= 0 && uint(reserves) >= targetReserves) revert NotForSale(); // Note: Re-entrancy can skip the reserves check above on a second buyCollateral call. doTransferIn(baseToken, msg.sender, baseAmount); uint collateralAmount = quoteCollateral(asset, baseAmount); if (collateralAmount < minAmount) revert TooMuchSlippage(); if (collateralAmount > getCollateralReserves(asset)) revert InsufficientReserves(); // Note: Pre-transfer hook can re-enter buyCollateral with a stale collateral ERC20 balance. // Assets should not be listed which allow re-entry from pre-transfer now, as too much collateral could be bought. // This is also a problem if quoteCollateral derives its discount from the collateral ERC20 balance. doTransferOut(asset, recipient, safe128(collateralAmount)); emit BuyCollateral(msg.sender, asset, baseAmount, collateralAmount); } /** * @notice Gets the quote for a collateral asset in exchange for an amount of base asset * @param asset The collateral asset to get the quote for * @param baseAmount The amount of the base asset to get the quote for * @return The quote in terms of the collateral asset */ function quoteCollateral(address asset, uint baseAmount) override public view returns (uint) { AssetInfo memory assetInfo = getAssetInfoByAddress(asset); uint256 assetPrice = getPrice(assetInfo.priceFeed); // Store front discount is derived from the collateral asset's liquidationFactor and storeFrontPriceFactor // discount = storeFrontPriceFactor * (1e18 - liquidationFactor) uint256 discountFactor = mulFactor(storeFrontPriceFactor, FACTOR_SCALE - assetInfo.liquidationFactor); uint256 assetPriceDiscounted = mulFactor(assetPrice, FACTOR_SCALE - discountFactor); uint256 basePrice = getPrice(baseTokenPriceFeed); // # of collateral assets // = (TotalValueOfBaseAmount / DiscountedPriceOfCollateralAsset) * assetScale // = ((basePrice * baseAmount / baseScale) / assetPriceDiscounted) * assetScale return basePrice * baseAmount * assetInfo.scale / assetPriceDiscounted / baseScale; } /** * @notice Withdraws base token reserves if called by the governor * @param to An address of the receiver of withdrawn reserves * @param amount The amount of reserves to be withdrawn from the protocol */ function withdrawReserves(address to, uint amount) override external { if (msg.sender != governor) revert Unauthorized(); int reserves = getReserves(); if (reserves < 0 || amount > unsigned256(reserves)) revert InsufficientReserves(); doTransferOut(baseToken, to, amount); emit WithdrawReserves(to, amount); } /** * @notice Sets Comet's ERC20 allowance of an asset for a manager * @dev Only callable by governor * @dev Note: Setting the `asset` as Comet's address will allow the manager * to withdraw from Comet's Comet balance * @param asset The asset that the manager will gain approval of * @param manager The account which will be allowed or disallowed * @param amount The amount of an asset to approve */ function approveThis(address manager, address asset, uint amount) override external { if (msg.sender != governor) revert Unauthorized(); ERC20(asset).approve(manager, amount); } /** * @notice Get the total number of tokens in circulation * @dev Note: uses updated interest indices to calculate * @return The supply of tokens **/ function totalSupply() override external view returns (uint256) { (uint64 baseSupplyIndex_, ) = accruedInterestIndices(getNowInternal() - lastAccrualTime); return presentValueSupply(baseSupplyIndex_, totalSupplyBase); } /** * @notice Get the total amount of debt * @dev Note: uses updated interest indices to calculate * @return The amount of debt **/ function totalBorrow() override external view returns (uint256) { (, uint64 baseBorrowIndex_) = accruedInterestIndices(getNowInternal() - lastAccrualTime); return presentValueBorrow(baseBorrowIndex_, totalBorrowBase); } /** * @notice Query the current positive base balance of an account or zero * @dev Note: uses updated interest indices to calculate * @param account The account whose balance to query * @return The present day base balance magnitude of the account, if positive */ function balanceOf(address account) override public view returns (uint256) { (uint64 baseSupplyIndex_, ) = accruedInterestIndices(getNowInternal() - lastAccrualTime); int104 principal = userBasic[account].principal; return principal > 0 ? presentValueSupply(baseSupplyIndex_, unsigned104(principal)) : 0; } /** * @notice Query the current negative base balance of an account or zero * @dev Note: uses updated interest indices to calculate * @param account The account whose balance to query * @return The present day base balance magnitude of the account, if negative */ function borrowBalanceOf(address account) override public view returns (uint256) { (, uint64 baseBorrowIndex_) = accruedInterestIndices(getNowInternal() - lastAccrualTime); int104 principal = userBasic[account].principal; return principal < 0 ? presentValueBorrow(baseBorrowIndex_, unsigned104(-principal)) : 0; } /** * @notice Fallback to calling the extension delegate for everything else */ fallback() external payable { address delegate = extensionDelegate; assembly { calldatacopy(0, 0, calldatasize()) let result := delegatecall(gas(), delegate, 0, calldatasize(), 0, 0) returndatacopy(0, 0, returndatasize()) switch result case 0 { revert(0, returndatasize()) } default { return(0, returndatasize()) } } } } // SPDX-License-Identifier: BUSL-1.1 pragma solidity 0.8.15; import "./CometCore.sol"; /** * @title Compound's Comet Main Interface (without Ext) * @notice An efficient monolithic money market protocol * @author Compound */ abstract contract CometMainInterface is CometCore { error Absurd(); error AlreadyInitialized(); error BadAsset(); error BadDecimals(); error BadDiscount(); error BadMinimum(); error BadPrice(); error BorrowTooSmall(); error BorrowCFTooLarge(); error InsufficientReserves(); error LiquidateCFTooLarge(); error NoSelfTransfer(); error NotCollateralized(); error NotForSale(); error NotLiquidatable(); error Paused(); error SupplyCapExceeded(); error TimestampTooLarge(); error TooManyAssets(); error TooMuchSlippage(); error TransferInFailed(); error TransferOutFailed(); error Unauthorized(); event Supply(address indexed from, address indexed dst, uint amount); event Transfer(address indexed from, address indexed to, uint amount); event Withdraw(address indexed src, address indexed to, uint amount); event SupplyCollateral(address indexed from, address indexed dst, address indexed asset, uint amount); event TransferCollateral(address indexed from, address indexed to, address indexed asset, uint amount); event WithdrawCollateral(address indexed src, address indexed to, address indexed asset, uint amount); /// @notice Event emitted when a borrow position is absorbed by the protocol event AbsorbDebt(address indexed absorber, address indexed borrower, uint basePaidOut, uint usdValue); /// @notice Event emitted when a user's collateral is absorbed by the protocol event AbsorbCollateral(address indexed absorber, address indexed borrower, address indexed asset, uint collateralAbsorbed, uint usdValue); /// @notice Event emitted when a collateral asset is purchased from the protocol event BuyCollateral(address indexed buyer, address indexed asset, uint baseAmount, uint collateralAmount); /// @notice Event emitted when an action is paused/unpaused event PauseAction(bool supplyPaused, bool transferPaused, bool withdrawPaused, bool absorbPaused, bool buyPaused); /// @notice Event emitted when reserves are withdrawn by the governor event WithdrawReserves(address indexed to, uint amount); function supply(address asset, uint amount) virtual external; function supplyTo(address dst, address asset, uint amount) virtual external; function supplyFrom(address from, address dst, address asset, uint amount) virtual external; function transfer(address dst, uint amount) virtual external returns (bool); function transferFrom(address src, address dst, uint amount) virtual external returns (bool); function transferAsset(address dst, address asset, uint amount) virtual external; function transferAssetFrom(address src, address dst, address asset, uint amount) virtual external; function withdraw(address asset, uint amount) virtual external; function withdrawTo(address to, address asset, uint amount) virtual external; function withdrawFrom(address src, address to, address asset, uint amount) virtual external; function approveThis(address manager, address asset, uint amount) virtual external; function withdrawReserves(address to, uint amount) virtual external; function absorb(address absorber, address[] calldata accounts) virtual external; function buyCollateral(address asset, uint minAmount, uint baseAmount, address recipient) virtual external; function quoteCollateral(address asset, uint baseAmount) virtual public view returns (uint); function getAssetInfo(uint8 i) virtual public view returns (AssetInfo memory); function getAssetInfoByAddress(address asset) virtual public view returns (AssetInfo memory); function getCollateralReserves(address asset) virtual public view returns (uint); function getReserves() virtual public view returns (int); function getPrice(address priceFeed) virtual public view returns (uint); function isBorrowCollateralized(address account) virtual public view returns (bool); function isLiquidatable(address account) virtual public view returns (bool); function totalSupply() virtual external view returns (uint256); function totalBorrow() virtual external view returns (uint256); function balanceOf(address owner) virtual public view returns (uint256); function borrowBalanceOf(address account) virtual public view returns (uint256); function pause(bool supplyPaused, bool transferPaused, bool withdrawPaused, bool absorbPaused, bool buyPaused) virtual external; function isSupplyPaused() virtual public view returns (bool); function isTransferPaused() virtual public view returns (bool); function isWithdrawPaused() virtual public view returns (bool); function isAbsorbPaused() virtual public view returns (bool); function isBuyPaused() virtual public view returns (bool); function accrueAccount(address account) virtual external; function getSupplyRate(uint utilization) virtual public view returns (uint64); function getBorrowRate(uint utilization) virtual public view returns (uint64); function getUtilization() virtual public view returns (uint); function governor() virtual external view returns (address); function pauseGuardian() virtual external view returns (address); function baseToken() virtual external view returns (address); function baseTokenPriceFeed() virtual external view returns (address); function extensionDelegate() virtual external view returns (address); /// @dev uint64 function supplyKink() virtual external view returns (uint); /// @dev uint64 function supplyPerSecondInterestRateSlopeLow() virtual external view returns (uint); /// @dev uint64 function supplyPerSecondInterestRateSlopeHigh() virtual external view returns (uint); /// @dev uint64 function supplyPerSecondInterestRateBase() virtual external view returns (uint); /// @dev uint64 function borrowKink() virtual external view returns (uint); /// @dev uint64 function borrowPerSecondInterestRateSlopeLow() virtual external view returns (uint); /// @dev uint64 function borrowPerSecondInterestRateSlopeHigh() virtual external view returns (uint); /// @dev uint64 function borrowPerSecondInterestRateBase() virtual external view returns (uint); /// @dev uint64 function storeFrontPriceFactor() virtual external view returns (uint); /// @dev uint64 function baseScale() virtual external view returns (uint); /// @dev uint64 function trackingIndexScale() virtual external view returns (uint); /// @dev uint64 function baseTrackingSupplySpeed() virtual external view returns (uint); /// @dev uint64 function baseTrackingBorrowSpeed() virtual external view returns (uint); /// @dev uint104 function baseMinForRewards() virtual external view returns (uint); /// @dev uint104 function baseBorrowMin() virtual external view returns (uint); /// @dev uint104 function targetReserves() virtual external view returns (uint); function numAssets() virtual external view returns (uint8); function decimals() virtual external view returns (uint8); function initializeStorage() virtual external; }// SPDX-License-Identifier: BUSL-1.1 pragma solidity 0.8.15; /** * @title ERC 20 Token Standard Interface * https://eips.ethereum.org/EIPS/eip-20 */ interface ERC20 { function name() external view returns (string memory); function symbol() external view returns (string memory); function decimals() external view returns (uint8); /** * @notice Get the total number of tokens in circulation * @return The supply of tokens */ function totalSupply() external view returns (uint256); /** * @notice Gets the balance of the specified address * @param owner The address from which the balance will be retrieved * @return The balance */ function balanceOf(address owner) external view returns (uint256); /** * @notice Transfer `amount` tokens from `msg.sender` to `dst` * @param dst The address of the destination account * @param amount The number of tokens to transfer * @return Whether or not the transfer succeeded */ function transfer(address dst, uint256 amount) external returns (bool); /** * @notice Transfer `amount` tokens from `src` to `dst` * @param src The address of the source account * @param dst The address of the destination account * @param amount The number of tokens to transfer * @return Whether or not the transfer succeeded */ function transferFrom(address src, address dst, uint256 amount) external returns (bool); /** * @notice Approve `spender` to transfer up to `amount` from `src` * @dev This will overwrite the approval amount for `spender` * and is subject to issues noted [here](https://eips.ethereum.org/EIPS/eip-20#approve) * @param spender The address of the account which may transfer tokens * @param amount The number of tokens that are approved (-1 means infinite) * @return Whether or not the approval succeeded */ function approve(address spender, uint256 amount) external returns (bool); /** * @notice Get the current allowance from `owner` for `spender` * @param owner The address of the account which owns the tokens to be spent * @param spender The address of the account which may transfer tokens * @return The number of tokens allowed to be spent (-1 means infinite) */ function allowance(address owner, address spender) external view returns (uint256); event Transfer(address indexed from, address indexed to, uint256 amount); event Approval(address indexed owner, address indexed spender, uint256 amount); } // SPDX-License-Identifier: MIT pragma solidity ^0.8.0; interface AggregatorV3Interface { function decimals() external view returns (uint8); function description() external view returns (string memory); function version() external view returns (uint256); // getRoundData and latestRoundData should both raise "No data present" // if they do not have data to report, instead of returning unset values // which could be misinterpreted as actual reported values. function getRoundData(uint80 _roundId) external view returns ( uint80 roundId, int256 answer, uint256 startedAt, uint256 updatedAt, uint80 answeredInRound ); function latestRoundData() external view returns ( uint80 roundId, int256 answer, uint256 startedAt, uint256 updatedAt, uint80 answeredInRound ); } // SPDX-License-Identifier: BUSL-1.1 pragma solidity 0.8.15; import "./CometConfiguration.sol"; import "./CometStorage.sol"; import "./CometMath.sol"; import "./vendor/@chainlink/contracts/src/v0.8/interfaces/AggregatorV3Interface.sol"; abstract contract CometCore is CometConfiguration, CometStorage, CometMath { struct AssetInfo { uint8 offset; address asset; address priceFeed; uint64 scale; uint64 borrowCollateralFactor; uint64 liquidateCollateralFactor; uint64 liquidationFactor; uint128 supplyCap; } /** Internal constants **/ /// @dev The max number of assets this contract is hardcoded to support /// Do not change this variable without updating all the fields throughout the contract, // including the size of UserBasic.assetsIn and corresponding integer conversions. uint8 internal constant MAX_ASSETS = 15; /// @dev The max number of decimals base token can have /// Note this cannot just be increased arbitrarily. uint8 internal constant MAX_BASE_DECIMALS = 18; /// @dev The max value for a collateral factor (1) uint64 internal constant MAX_COLLATERAL_FACTOR = FACTOR_SCALE; /// @dev Offsets for specific actions in the pause flag bit array uint8 internal constant PAUSE_SUPPLY_OFFSET = 0; uint8 internal constant PAUSE_TRANSFER_OFFSET = 1; uint8 internal constant PAUSE_WITHDRAW_OFFSET = 2; uint8 internal constant PAUSE_ABSORB_OFFSET = 3; uint8 internal constant PAUSE_BUY_OFFSET = 4; /// @dev The decimals required for a price feed uint8 internal constant PRICE_FEED_DECIMALS = 8; /// @dev 365 days * 24 hours * 60 minutes * 60 seconds uint64 internal constant SECONDS_PER_YEAR = 31_536_000; /// @dev The scale for base tracking accrual uint64 internal constant BASE_ACCRUAL_SCALE = 1e6; /// @dev The scale for base index (depends on time/rate scales, not base token) uint64 internal constant BASE_INDEX_SCALE = 1e15; /// @dev The scale for prices (in USD) uint64 internal constant PRICE_SCALE = uint64(10 ** PRICE_FEED_DECIMALS); /// @dev The scale for factors uint64 internal constant FACTOR_SCALE = 1e18; /** * @notice Determine if the manager has permission to act on behalf of the owner * @param owner The owner account * @param manager The manager account * @return Whether or not the manager has permission */ function hasPermission(address owner, address manager) public view returns (bool) { return owner == manager || isAllowed[owner][manager]; } /** * @dev The positive present supply balance if positive or the negative borrow balance if negative */ function presentValue(int104 principalValue_) internal view returns (int256) { if (principalValue_ >= 0) { return signed256(presentValueSupply(baseSupplyIndex, uint104(principalValue_))); } else { return -signed256(presentValueBorrow(baseBorrowIndex, uint104(-principalValue_))); } } /** * @dev The principal amount projected forward by the supply index */ function presentValueSupply(uint64 baseSupplyIndex_, uint104 principalValue_) internal pure returns (uint256) { return uint256(principalValue_) * baseSupplyIndex_ / BASE_INDEX_SCALE; } /** * @dev The principal amount projected forward by the borrow index */ function presentValueBorrow(uint64 baseBorrowIndex_, uint104 principalValue_) internal pure returns (uint256) { return uint256(principalValue_) * baseBorrowIndex_ / BASE_INDEX_SCALE; } /** * @dev The positive principal if positive or the negative principal if negative */ function principalValue(int256 presentValue_) internal view returns (int104) { if (presentValue_ >= 0) { return signed104(principalValueSupply(baseSupplyIndex, uint256(presentValue_))); } else { return -signed104(principalValueBorrow(baseBorrowIndex, uint256(-presentValue_))); } } /** * @dev The present value projected backward by the supply index (rounded down) * Note: This will overflow (revert) at 2^104/1e18=~20 trillion principal for assets with 18 decimals. */ function principalValueSupply(uint64 baseSupplyIndex_, uint256 presentValue_) internal pure returns (uint104) { return safe104((presentValue_ * BASE_INDEX_SCALE) / baseSupplyIndex_); } /** * @dev The present value projected backward by the borrow index (rounded up) * Note: This will overflow (revert) at 2^104/1e18=~20 trillion principal for assets with 18 decimals. */ function principalValueBorrow(uint64 baseBorrowIndex_, uint256 presentValue_) internal pure returns (uint104) { return safe104((presentValue_ * BASE_INDEX_SCALE + baseBorrowIndex_ - 1) / baseBorrowIndex_); } } // SPDX-License-Identifier: BUSL-1.1 pragma solidity 0.8.15; /** * @title Compound's Comet Configuration Interface * @author Compound */ contract CometConfiguration { struct ExtConfiguration { bytes32 name32; bytes32 symbol32; } struct Configuration { address governor; address pauseGuardian; address baseToken; address baseTokenPriceFeed; address extensionDelegate; uint64 supplyKink; uint64 supplyPerYearInterestRateSlopeLow; uint64 supplyPerYearInterestRateSlopeHigh; uint64 supplyPerYearInterestRateBase; uint64 borrowKink; uint64 borrowPerYearInterestRateSlopeLow; uint64 borrowPerYearInterestRateSlopeHigh; uint64 borrowPerYearInterestRateBase; uint64 storeFrontPriceFactor; uint64 trackingIndexScale; uint64 baseTrackingSupplySpeed; uint64 baseTrackingBorrowSpeed; uint104 baseMinForRewards; uint104 baseBorrowMin; uint104 targetReserves; AssetConfig[] assetConfigs; } struct AssetConfig { address asset; address priceFeed; uint8 decimals; uint64 borrowCollateralFactor; uint64 liquidateCollateralFactor; uint64 liquidationFactor; uint128 supplyCap; } } // SPDX-License-Identifier: BUSL-1.1 pragma solidity 0.8.15; /** * @title Compound's Comet Storage Interface * @dev Versions can enforce append-only storage slots via inheritance. * @author Compound */ contract CometStorage { // 512 bits total = 2 slots struct TotalsBasic { // 1st slot uint64 baseSupplyIndex; uint64 baseBorrowIndex; uint64 trackingSupplyIndex; uint64 trackingBorrowIndex; // 2nd slot uint104 totalSupplyBase; uint104 totalBorrowBase; uint40 lastAccrualTime; uint8 pauseFlags; } struct TotalsCollateral { uint128 totalSupplyAsset; uint128 _reserved; } struct UserBasic { int104 principal; uint64 baseTrackingIndex; uint64 baseTrackingAccrued; uint16 assetsIn; uint8 _reserved; } struct UserCollateral { uint128 balance; uint128 _reserved; } struct LiquidatorPoints { uint32 numAbsorbs; uint64 numAbsorbed; uint128 approxSpend; uint32 _reserved; } /// @dev Aggregate variables tracked for the entire market uint64 internal baseSupplyIndex; uint64 internal baseBorrowIndex; uint64 internal trackingSupplyIndex; uint64 internal trackingBorrowIndex; uint104 internal totalSupplyBase; uint104 internal totalBorrowBase; uint40 internal lastAccrualTime; uint8 internal pauseFlags; /// @notice Aggregate variables tracked for each collateral asset mapping(address => TotalsCollateral) public totalsCollateral; /// @notice Mapping of users to accounts which may be permitted to manage the user account mapping(address => mapping(address => bool)) public isAllowed; /// @notice The next expected nonce for an address, for validating authorizations via signature mapping(address => uint) public userNonce; /// @notice Mapping of users to base principal and other basic data mapping(address => UserBasic) public userBasic; /// @notice Mapping of users to collateral data per collateral asset mapping(address => mapping(address => UserCollateral)) public userCollateral; /// @notice Mapping of magic liquidator points mapping(address => LiquidatorPoints) public liquidatorPoints; } // SPDX-License-Identifier: BUSL-1.1 pragma solidity 0.8.15; /** * @title Compound's Comet Math Contract * @dev Pure math functions * @author Compound */ contract CometMath { /** Custom errors **/ error InvalidUInt64(); error InvalidUInt104(); error InvalidUInt128(); error InvalidInt104(); error InvalidInt256(); error NegativeNumber(); function safe64(uint n) internal pure returns (uint64) { if (n > type(uint64).max) revert InvalidUInt64(); return uint64(n); } function safe104(uint n) internal pure returns (uint104) { if (n > type(uint104).max) revert InvalidUInt104(); return uint104(n); } function safe128(uint n) internal pure returns (uint128) { if (n > type(uint128).max) revert InvalidUInt128(); return uint128(n); } function signed104(uint104 n) internal pure returns (int104) { if (n > uint104(type(int104).max)) revert InvalidInt104(); return int104(n); } function signed256(uint256 n) internal pure returns (int256) { if (n > uint256(type(int256).max)) revert InvalidInt256(); return int256(n); } function unsigned104(int104 n) internal pure returns (uint104) { if (n < 0) revert NegativeNumber(); return uint104(n); } function unsigned256(int256 n) internal pure returns (uint256) { if (n < 0) revert NegativeNumber(); return uint256(n); } function toUInt8(bool x) internal pure returns (uint8) { return x ? 1 : 0; } function toBool(uint8 x) internal pure returns (bool) { return x != 0; } }