diff --git a/EIPS/eip-7092.md b/EIPS/eip-7092.md new file mode 100644 index 0000000000000..6971b21604b79 --- /dev/null +++ b/EIPS/eip-7092.md @@ -0,0 +1,412 @@ +--- +eip: 7092 +title: Financial Bonds +description: This interface defines a specification for debt issued by corporations, goverments or other entities to investors in order to raise funds. +author: Samuel Gwlanold Edoumou (@Edoumou) +discussions-to: https://ethereum-magicians.org/t/financial-bonds/14461 +status: Draft +type: Standards Track +category: ERC +created: 2023-05-28 +--- + +## Abstract + +This proposal introduces fixed income financial bonds. Important bond characteristics such as the International Securities Identification Number (ISIN), +the issue volume, the issue date, the maturity date, the coupon rate, the coupon frequency, the principal, or the day count basis are defined to allow issuing +bonds in the primary market (origination), and different transfer functions allow to buy or sell bonds in the secondary market. The standard also provides a +functionality to allow bonds to be approved by owners in order to be spent by third party. + +## Motivation + +Fixed income instruments is one of the asset classes that is widely used by corporations and other entities to raise funds. Bonds +are considered more secured than equity since the issuer is supposed to repay the principal at maturity in addition to coupons +that are paid to investsors. + +This standard interface allows fixed income instruments to be represented as on-chain tokens, so as they can be managed through wallets, +and be used by applications like decentrailized exchanges. + +The existing standard [ERC-3475](./eip-3475) that may be used to create abstract storage bonds does not follow same standards as +with traditional bonds. By introducing concepts such as **classes** and **nonces** that are not used for traditional bonds, the ERC-3475 standard makes it difficult for +traditional entities to migrate to tokenized bonds. Morever, the use of on-chain metadata with ERC-3475, like **classMetadata** and **nonceMetadata**, and also **classValues** +leads to unnecessary gas consumption. The lack of named variables like coupon, maturity date, principal, etc... makes it difficult to implement the ERC-3475 since developers +need to rember which metadata is assigned to each parameter. + +By keeping same standards as with traditional bonds, the [ERC-7092](./eip-7092.md) allows to create a new token for bonds with same caracteristics as traditional bonds so as to make it simple +to migrate to tokenized bonds. + +Tokenizing bonds will offer several advantages compared to traditional bond issuance and trading, among with: + +1. Fractional ownership: The bond standard does not limit the bond denomination to some minimum value compared to traditioanal bonds where the denomination is typically equal to $100 or $1,000. +2. Accessibility: By allowing lower investment thresholds, tokenized bonds are supposed to attract retail investors who could not participate in traditional markets due to high minimum investment requirements. +3. Increased liquidity: Fractioanal ownership will bring new investors in the bond market, this will increase liquidity in the bond market. +4. Cost savings: By replacing intermediaries with smart contracts, bond's tokenization will reduce costs associated with the bond issuance and management. +5. Easy accessibility and 24/7 trading: Tokenized bonds are supposed to be traded on digital platforms such as decentralized exchanges. Therefore, they will be more accessible compared to tradional bond market. + +## Specification + +The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119 and RFC 8174. + +**Every contract compliant with the [ERC-7092](./eip-7092.md) MUST implement the following interface** + +```solidity +pragma solidity ^0.8.0; + +/** +* @title ERC-7092 Financial Bonds tandard +*/ +interface IERC7092 { + /** + * @notice Returns the bond isin + */ + function isin() external view returns(string memory); + + /** + * @notice Returns the bond name + */ + function name() external view returns(string memory); + + /** + * @notice Returns the bond symbol + * It is RECOMMENDED to represent the symbol as a combination of the issuer Issuer'shorter name and the maturity date + * Ex: If a company named Green Energy issues bonds that will mature on october 25, 2030, the bond symbol could be `GE30` or `GE2030` or `GE102530` + * + * OPTIONAL - interfaces and other contracts MUST NOT expect these values to be present. The method is used to improve usability. + */ + function symbol() external view returns(string memory); + + /** + * @notice Returns the number of decimals the bond uses - e.g `10`, means to divide the token amount by `10000000000` + * + * OPTIONAL - interfaces and other contracts MUST NOT expect these values to be present. The method is used to improve usability. + */ + function decimals() external view returns(uint8); + + /** + * @notice Returns the bond currency. This is the contract address of the token used to pay and return the bond principal + */ + function currency() external view returns(address); + + /** + * @notice Returns the copoun currency. This is the contract address of the token used to pay coupons. It can be same as the the one used for the principal + * + * OPTIONAL - interfaces and other contracts MUST NOT expect these values to be present. The method is used to improve usability. + */ + function currencyOfCoupon() external view returns(address); + + /** + * @notice Returns the bond denominiation. This is the minimum amount in which the Bonds may be issued. It must be expressend in unnit of the principal currency + * ex: If the denomination is equal to 1,000 and the currency is USDC, then bond denomination is equal to 1,000 USDC + */ + function denomination() external view returns(uint256); + + /** + * @notice Returns the issue volume (total debt amount). It is RECOMMENDED to express the issue volume in the bond currency unit (USDC, DAI, etc...). + * NOTICE: The `issue volume` can also be expressed in `denomination` unit. In that case, the `issue volume` MUST equal the `totalSupply` + * of the bonds, i.e. the total number of bond tokens issued. + * ex: if denomination = $1,000, and the total debt is $5,000,000 + * then, issueVolume() = $5,000, 000 / $1,000 = 5,000 bonds + */ + function issueVolume() external view returns(uint256); + + /** + * @notice Returns the bond interest rate. It is RECOMMENDED to express the interest rate in basis point unit. + * 1 basis point = 0.01% = 0.0001 + * ex: if interest rate = 5%, then coupon() => 500 basis points + */ + function couponRate() external view returns(uint256); + + /** + * @notice Returns the coupon type + * ex: 0: Zero coupon, 1: Fixed Rate, 2: Floating Rate, etc... + * + * OPTIONAL - interfaces and other contracts MUST NOT expect these values to be present. The method is used to improve usability. + */ + function couponType() external view returns(uint256); + + /** + * @notice Returns the coupon frequency, i.e. the number of times coupons are paid in a year. + * + * * OPTIONAL - interfaces and other contracts MUST NOT expect these values to be present. The method is used to improve usability. + */ + function couponFrequency() external view returns(uint256); + + /** + * @notice Returns the date when bonds were issued to investors. This is a Unix Timestamp like the one returned by block.timestamp + */ + function issueDate() external view returns(uint256); + + /** + * @notice Returns the bond maturity date, i.e, the date when the pricipal is repaid. This is a Unix Timestamp like the one returned by block.timestamp + * The` maturity date` MUST be greater than the `issue date` + */ + function maturityDate() external view returns(uint256); + + /** + * @notice Returns the day count basis + * Ex: 0: actual/actual, 1: actual/360, etc... + * + * OPTIONAL - interfaces and other contracts MUST NOT expect these values to be present. The method is used to improve usability. + */ + function dayCountBasis() external view returns(uint256); + + /** + * @notice Returns the principal of an account. It is RECOMMENDED to express the principal in the bond currency unit (USDC, DAI, etc...). + * NOTICE: The `principal` can also be expressed in `denomination` unit. In that case, the `principal` MUST equal the balance of `_account`. + * Ex: if denomination = $1,000, and the user has invested $5,000 (princiapl in currency unit), then + * principalOf(_account) = 5,000/1,000 = 5 + * @param _account account address + */ + function principalOf(address _account) external view returns(uint256); + + /** + * @notice Returns the amount of tokens the `_spender` account has been authorized by the `_owner`` + * acount to manage their bonds + * @param _owner the bondholder address + * @param _spender the address that has been authorized by the bondholder + */ + function approval(address _owner, address _spender) external view returns(uint256); + + /** + * @notice Authorizes `_spender` account to manage `_amount`of their bonds + * @param _spender the address to be authorized by the bondholder + * @param _amount amount of bond to approve. _amount MUST be a multiple of denomination + */ + function approve(address _spender, uint256 _amount) external returns(bool); + + /** + * @notice Authorizes the `_spender` account to manage all their bonds + * @param _spender the address to be authorized by the bondholder + * + * OPTIONAL - interfaces and other contracts MUST NOT expect these values to be present. The method is used to improve usability. + */ + function approveAll(address _spender) external returns(bool); + + /** + * @notice Lower the allowance of `_spender` by `_amount` + * @param _spender the address to be authorized by the bondholder + * @param _amount amount of bond to remove approval; _amount MUST be a multiple of denomination + */ + function decreaseAllowance(address _spender, uint256 _amount) external returns(bool); + + /** + * @notice Remove the allowance for `_spender` + * @param _spender the address to remove the authorization by from + * + * OPTIONAL - interfaces and other contracts MUST NOT expect these values to be present. The method is used to improve usability. + */ + function decreaseAllowanceForAll(address _spender) external returns(bool); + + /** + * @notice Moves `_amount` bonds to address `_to` + * @param _to the address to send the bonds to + * @param _amount amount of bond to transfer. _amount MUST be a multiple of denomination + * @param _data additional information provided by the token holder + */ + function transfer(address _to, uint256 _amount, bytes calldata _data) external returns(bool); + + /** + * @notice Moves all bonds to address `_to` + * @param _to the address to send the bonds to + * @param _data additional information provided by the token holder + * + * OPTIONAL - interfaces and other contracts MUST NOT expect these values to be present. The method is used to improve usability. + */ + function transferAll(address _to, bytes calldata _data) external returns(bool); + + /** + * @notice Moves `_amount` bonds from an account that has authorized through the approve function + * @param _from the bondholder address + * @param _to the address to transfer bonds to + * @param _amount amount of bond to transfer. _amount MUST be a multiple of denomination + * @param _data additional information provided by the token holder + */ + function transferFrom(address _from, address _to, uint256 _amount, bytes calldata _data) external returns(bool); + + /** + * @notice Moves all bonds from `_from` to `_to`. The caller must have been authorized through the approve function + * @param _from the bondholder address + * @param _to the address to transfer bonds to + * @param _data additional information provided by the token holder + * + * OPTIONAL - interfaces and other contracts MUST NOT expect these values to be present. The method is used to improve usability. + */ + function transferAllFrom(address _from, address _to, bytes calldata _data) external returns(bool); + + /** + * @notice MUST be emitted when bonds are transferred + * @param _from the account that owns bonds + * @param _to the account that receives the bond + * @param _amount the amount of bonds to be transferred + * @param _data additional information provided by the token holder + */ + event Transferred(address _from, address _to, uint256 _amount, bytes _data); + + /** + * @notice MUST be emitted when an account is approved + * @param _owner the bonds owner + * @param _spender the account to be allowed to spend bonds + * @param _amount the amount allowed by _owner to be spent by _spender. + */ + event Approved(address _owner, address _spender, uint256 _amount); + + /** + * @notice MUST be emmitted when the `_owner` decreases allowance from `_sepnder` by quantity `_amount` + * @param _owner the bonds owner + * @param _spender the account that has been allowed to spend bonds + * @param _amount the amount of tokens to disapprove + */ + event AllowanceDecreased(address _owner, address _spender, uint256 _amount); +} +``` + +## Rationale + +The financial bond standard is designed to represent fixed income assets, which reprensent a loan made by an investor to a borrower. +The proposed design has been motivated by the necessity to tokenize fixed income assets, and to represent the bond token with same +characteristics as in traditional finance. Keeping the same properties as in tradional finance is necessary for issuers and investors +to move to tokenized bonds without major difficulties. The same structure used in tradional finace, i.e issuer-investment bank-investors +can be used for the bond standard, in that case the investment bank intermediary may be replaced by smart contracts. In the case of +institutional issuance, the smart contracts can be managed by the investment bank. Decentralized exchanges may also use the bond standard +to list bonds, in that case, decentralized exchanges will be in charge of managing the smart contracts. Other entities may also create +tokenized bonds by integrating this financial bond interface. + +The use of terminology such as `issueVolume` and `principalOf` instead of `totalSupply` and `balanceOf` respectively, as used in other standards like +[ERC-20](./eip-20) is motivated by the need to use same the terminology as with traditional bond. Furthermore, by adding the `data` input parameter +in all `transfer` functions to allow the transfer of additional data, the ERC-7092 SHOULD NOT be compatible with the ERC-20 standard, even if both +the `principalOf` and `balanceOf` functions were used. + +Another reason that has motivated not to extend other standards like the ERC-20 is to allow token explorer platforms like etherscan to represent +the ERC-7092 token not as a simple ERC-20 token, but as a new token showing some bonds characteristics like the `principal`, the `coupon`, +the `denomination`, and the `maturity date`. Those information are very important for bondholders to know the return on the capital invested. + +### Total Supply + +We made the choice not to define the `totalSupply` function beacause it can be derived from both the `issue volume` and the `denomination`. +However it is RECOMMENDED to define the `totalSupply` function in any contract that implements this standard. In that case, +the `total supply` MUST be equal to the ratio of the `issue volume` and the `denomination`. + +```javascript + totalSupply = issueVolume / denomination +``` + +### Account Balance + +Because the balance of an account can be derived from both the `principal` and the `denomination`, we made the choice not to define the `balanceOf` function. +However it is RECOMMENDED to define the `balanceOf` function in any contract that implements this standard. In that case, +the `balance` of an account MUST be equal to the ratio of the `principal` of that account and the `denomination`. + +```javascript + balanceOf(account) = principalOf(account) / denomination +``` + +## Backwards Compatibility + +Beacause some functions like `totalSupply` or `balanceOf` are not implemented, the ERC-7092 SHOULD NOT extend existing standards, +like [ERC-20](./eip-20) or [ERC-1155](./eip-1155). The ERC-7092 is a representation of a new token for bonds with all bonds characteristics +and functionalities already attached to it. + +**_For the reasons mentionned above, we recommand a pure implementation of the standard_** to issue tokenized bonds, since any hybrid solution +with other standards mentionned above SHOULD fail. + + +## Reference Implementation + +The reference implementation of the [ERC-7092](./eip-7092.md) can be found [here](../assets/eip-7092/ERC7092.sol). + +Some bonds have embedded options attached to them. As an example we can cite: + +1. Callable bonds that have an option that gives the issuer the right to retire bonds before they mature. +2. Puttable bonds that have an option that gives investors the right to retire bonds before they mature. +3. Convertible bonds that gives investors the right to convert their bonds to equity. + +Bonds with embedded options can be created by inheriting from the basic ERC-7092 that integrates the proposed interface. + +### CALLABLE BONDS: + +```solidity +pragma solidity ^0.8.0; + +import 'ERC7092.sol'; + +contract ERC7092Callable is ERC7092 { + // WRITE THE LOGIC TO ALLOW THE ISSUER TO CALL BONDS + // STATE VARIABLES AND FUNCTIONS NEEDED + + /** + * @notice call bonds owned by `_investor` + * MUST be called by the issuer only + */ + function call(address _investor) public { + require(_principals[_investor] > 0, "ERC7092Callable: ONLY_ISSUER"); + require(block.timestamp < _bond[bondISIN].maturityDate, "ERC7092Callable: BOND_MATURED"); + + uint256 principal = _principals[_investor]; + _principals[_investor] = 0; + + // ADD LOGIC HERE + } +} +``` + +### PUTTABLE BONDS: + +```solidity +pragma solidity ^0.8.0; + +import 'ERC7092.sol'; + +contract ERC7092Puttable is ERC7092 { + // WRITE THE LOGIC TO ALLOW INVESTORS TO PUT BONDS + // STATE VARIABLES AND FUNCTIONS NEEDED + + /** + * @notice put bonds + * MUST be called by investors who own bonds + */ + function put() public { + require(_principals[msg.sender] > 0, "ERC7092Puttable: ONLY_INVESTORS"); + require(block.timestamp < _bond[bondISIN].maturityDate, "ERC7092Puttable: BOND_MATURED"); + + uint256 principal = _principals[msg.sender]; + _principals[msg.sender] = 0; + + // ADD LOGIC + } +} +``` + +### CONVERTIBLE BONDS: + +```solidity +pragma solidity ^0.8.0; + +import 'ERC7092.sol'; + +contract ERC7092Convertible is ERC7092 { + // WRITE THE LOGIC TO ALLOW INVESTOR OR ISSUER TO CONVERT BONDS TO EQUITY + // STATE VARIABLES AND FUNCTIONS NEEDED + + /** + * @notice convert bonds to equity. Here we assumed that the investors must convert their bonds to equity + * Issuer can also convert invetsors bonds to equity. + */ + function convert() public { + require(_principals[msg.sender] > 0, "ERC7092Convertible: ONLY_INVESTORS"); + require(block.timestamp < _bond[bondISIN].maturityDate, "ERC7092Convertible: BOND_MATURED"); + + uint256 principal = _principals[msg.sender]; + _principals[msg.sender] = 0; + + // ADD LOGIC HERE + } +} +``` + +## Security Considerations + +When implementing the ERC-7092, it is important to consider security risk related to functions that give approval to operators to manage owner's bonds, and to functions that allow to transfer bonds. Functions `transferAll` and `transferAllFrom` allow to transfer all the balance of an account. Therefore, it is crucial to ensure that only the bonds owner and accounts that have been approved by the bonds owner can call these functions. + +## Copyright + +Copyright and related rights waived via [CC0](../LICENSE.md). diff --git a/assets/eip-7092/BondStorage.sol b/assets/eip-7092/BondStorage.sol new file mode 100644 index 0000000000000..d68928ac5ed63 --- /dev/null +++ b/assets/eip-7092/BondStorage.sol @@ -0,0 +1,76 @@ +// SPDX-License-Identifier: CC0-1.0 +pragma solidity ^0.8.18; + +contract BondStorage { + struct Bond { + string isin; + string name; + string symbol; + address currency; + address currencyOfCoupon; + uint8 decimals; + uint256 denomination; + uint256 issueVolume; + uint256 couponRate; + uint256 couponType; + uint256 couponFrequency; + uint256 issueDate; + uint256 maturityDate; + uint256 dayCountBasis; + } + + struct Issuer { + string name; + string email; + string country; + string headquarters; + string issuerType; + string creditRating; + uint256 carbonCredit; + address issuerAddress; + } + + struct IssueData { + address investor; + uint256 principal; + } + + enum BondStatus {UNREGISTERED, SUBMITTED, ISSUED, REDEEMED} + + mapping(string => Bond) internal _bond; + mapping(string => Issuer) internal _issuer; + mapping(address => uint256) internal _principals; + mapping(address => mapping(address => uint256)) internal _approvals; + + string internal bondISIN; + string internal _countryOfIssuance; + + BondStatus internal _bondStatus; + IssueData[] internal _listOfInvestors; + + address internal _bondManager; + + modifier onlyBondManager { + require(msg.sender == _bondManager, "BondStorage: ONLY_BOND_MANAGER"); + _; + } + + event BondIssued(IssueData[] _issueData, Bond _bond); + event BondRedeemed(); + + function bondStatus() external view returns(BondStatus) { + return _bondStatus; + } + + function listOfInvestors() external view returns(IssueData[] memory) { + return _listOfInvestors; + } + + function bondInfo() public view returns(Bond memory) { + return _bond[bondISIN]; + } + + function issuerInfo() public view returns(Issuer memory) { + return _issuer[bondISIN]; + } +} diff --git a/assets/eip-7092/ERC7092.sol b/assets/eip-7092/ERC7092.sol new file mode 100644 index 0000000000000..cf410ed8edb7c --- /dev/null +++ b/assets/eip-7092/ERC7092.sol @@ -0,0 +1,298 @@ +// SPDX-License-Identifier: CC0-1.0 +pragma solidity ^0.8.0; + +import "./IERC7092.sol"; +import "./BondStorage.sol"; + +/** +* @notice Minimum implementation of the ERC7092 +*/ +contract ERC7092 is IERC7092, BondStorage { + constructor( + string memory _bondISIN, + Issuer memory _issuerInfo + ) { + bondISIN = _bondISIN; + _bondManager = msg.sender; + _issuer[_bondISIN] = _issuerInfo; + } + + function issue( + IssueData[] memory _issueData, + Bond memory _bond + ) external onlyBondManager { + _issue(_issueData, _bond); + } + + function redeem() external onlyBondManager { + _redeem(_listOfInvestors); + } + + function _issue(IssueData[] memory _issueData, Bond memory _bondInfo) internal virtual { + uint256 volume; + uint256 _issueVolume = _bondInfo.issueVolume; + + for(uint256 i; i < _issueData.length; i++) { + address investor = _issueData[i].investor; + uint256 principal = _issueData[i].principal; + uint256 _denomination = _bondInfo.denomination; + + require(investor != address(0), "ERC7092: ZERO_ADDRESS_INVESTOR"); + require(principal != 0 && (principal * _denomination) % _denomination == 0, "ERC: INVALID_PRINCIPAL_AMOUNT"); + + volume += principal; + _principals[investor] = principal; + _listOfInvestors.push(IssueData({investor:investor, principal:principal})); + } + + _bond[bondISIN] = _bondInfo; + _bond[bondISIN].issueDate = block.timestamp; + _bondStatus = BondStatus.ISSUED; + + uint256 _maturityDate = _bond[bondISIN].maturityDate; + + require(_maturityDate > block.timestamp, "ERC7092: INVALID_MATURITY_DATE"); + require(volume == _issueVolume, "ERC7092: INVALID_ISSUE_VOLUME"); + + emit BondIssued(_issueData, _bondInfo); + } + + function _redeem(IssueData[] memory _bondsData) internal virtual { + uint256 _maturityDate = _bond[bondISIN].maturityDate; + require(block.timestamp > _maturityDate, "ERC2721: WAIT_MATURITY"); + + for(uint256 i; i < _bondsData.length; i++) { + if(_principals[_bondsData[i].investor] != 0) { + _principals[_bondsData[i].investor] = 0; + } + } + + _bondStatus = BondStatus.REDEEMED; + emit BondRedeemed(); + } + + function isin() external view returns(string memory) { + return _bond[bondISIN].isin; + } + + function name() external view returns(string memory) { + return _bond[bondISIN].name; + } + + function symbol() external view returns(string memory) { + return _bond[bondISIN].symbol; + } + + function decimals() external view returns(uint8) { + return _bond[bondISIN].decimals; + } + + function currency() external view returns(address) { + return _bond[bondISIN].currency; + } + + function currencyOfCoupon() external view returns(address) { + return _bond[bondISIN].currencyOfCoupon; + } + + function denomination() public view returns(uint256) { + return _bond[bondISIN].denomination; + } + + function issueVolume() external view returns(uint256) { + return _bond[bondISIN].issueVolume; + } + + function couponRate() external view returns(uint256) { + return _bond[bondISIN].couponRate; + } + + function couponType() external view returns(uint256) { + return _bond[bondISIN].couponType; + } + + function couponFrequency() external view returns(uint256) { + return _bond[bondISIN].couponFrequency; + } + + function issueDate() external view returns(uint256) { + return _bond[bondISIN].issueDate; + } + + function maturityDate() public view returns(uint256) { + return _bond[bondISIN].maturityDate; + } + + function dayCountBasis() external view returns(uint256) { + return _bond[bondISIN].dayCountBasis; + } + + function principalOf(address _account) external view returns(uint256) { + return _principals[_account]; + } + + function balanceOf(address _account) public view returns(uint256) { + require(_bondStatus == BondStatus.ISSUED, "ERC7092: NOT_ISSUED_OR_REDEEMED"); + + return _principals[_account] / _bond[bondISIN].denomination; + } + + function totalSupply() public view returns(uint256) { + require(_bondStatus == BondStatus.ISSUED, "ERC7092: NOT_ISSUED_OR_REDEEMED"); + + return _bond[bondISIN].issueVolume / _bond[bondISIN].denomination; + } + + function approval(address _owner, address _spender) external view returns(uint256) { + return _approvals[_owner][_spender]; + } + + function approve(address _spender, uint256 _amount) external returns(bool) { + address _owner = msg.sender; + + _approve(_owner, _spender, _amount); + + return true; + } + + function approveAll(address _spender) external external returns(bool) { + address _owner = msg.sender; + uint256 _amount = _principals[_owner]; + + _approve(_owner, _spender, _amount); + + return true; + } + + function decreaseAllowance(address _spender, uint256 _amount) external returns(bool) { + address _owner = msg.sender; + + _decreaseAllowance(_owner, _spender, _amount); + + return true; + } + + function decreaseAllowanceForAll(address _spender) external returns(bool) { + address _owner = msg.sender; + uint256 _amount = _principals[_owner]; + + _decreaseAllowance(_owner, _spender, _amount); + + return true; + } + + function transfer(address _to, uint256 _amount, bytes calldata _data) external returns(bool) { + address _from = msg.sender; + + _transfer(_from, _to, _amount, _data); + + return true; + } + + function transferAll(address _to, bytes calldata _data) external returns(bool) { + address _from = msg.sender; + uint256 _amount = _principals[_from]; + + _transfer(_from, _to, _amount, _data); + + return true; + } + + function transferFrom(address _from, address _to, uint256 _amount, bytes calldata _data) external returns(bool) { + address _spender = msg.sender; + + _spendApproval(_from, _spender, _amount); + + _transfer(_from, _to, _amount, _data); + + return true; + } + + function transferAllFrom(address _from, address _to, bytes calldata _data) external returns(bool) { + address _spender = msg.sender; + uint256 _amount = _principals[_from]; + + _spendApproval(_from, _spender, _amount); + + _transfer(_from, _to, _amount, _data); + + return true; + } + + function _approve(address _owner, address _spender, uint256 _amount) internal virtual { + require(_owner != address(0), "ERC7092: OWNER_ZERO_ADDRESS"); + require(_spender != address(0), "ERC7092: SPENDER_ZERO_ADDRESS"); + require(_amount > 0, "ERC7092: INVALID_AMOUNT"); + + uint256 principal = _principals[_owner]; + uint256 _approval = _approvals[_owner][_spender]; + uint256 _denomination = denomination(); + uint256 _maturityDate = maturityDate(); + + require(block.timestamp < _maturityDate, "ERC7092: BONDS_MATURED"); + require(_amount <= principal, "ERC7092: INSUFFICIENT_BALANCE"); + require(_amount % _denomination == 0, "ERC7092: INVALID_AMOUNT"); + + _approvals[_owner][_spender] = _approval + _amount; + + emit Approved(_owner, _spender, _amount); + } + + function _decreaseAllowance(address _owner, address _spender, uint256 _amount) internal virtual { + require(_owner != address(0), "ERC7092: OWNER_ZERO_ADDRESS"); + require(_spender != address(0), "ERC7092: SPENDER_ZERO_ADDRESS"); + require(_amount > 0, "ERC7092: INVALID_AMOUNT"); + + uint256 _approval = _approvals[_owner][_spender]; + uint256 _denomination = denomination(); + uint256 _maturityDate = maturityDate(); + + require(block.timestamp < _maturityDate, "ERC7092: BONDS_MATURED"); + require(_amount <= _approval, "ERC7092: NOT_ENOUGH_APPROVAL"); + require(_amount % _denomination == 0, "ERC7092: INVALID_AMOUNT"); + + _approvals[_owner][_spender] = _approval - _amount; + + emit AllowanceDecreased(_owner, _spender, _amount); + } + + function _transfer(address _from, address _to, uint256 _amount, bytes calldata _data) internal virtual { + require(_from != address(0), "ERC7092: OWNER_ZERO_ADDRESS"); + require(_to != address(0), "ERC7092: SPENDER_ZERO_ADDRESS"); + require(_amount > 0, "ERC7092: INVALID_AMOUNT"); + + uint256 principal = _principals[_from]; + uint256 _denomination = denomination(); + uint256 _maturityDate = maturityDate(); + + require(block.timestamp < _maturityDate, "ERC7092: BONDS_MATURED"); + require(_amount <= principal, "ERC7092: INSUFFICIENT_BALANCE"); + require(_amount % _denomination == 0, "ERC7092: INVALID_AMOUNT"); + + _beforeBondTransfer(_from, _to, _amount, _data); + + uint256 principalTo = _principals[_to]; + + unchecked { + _principals[_from] = principal - _amount; + _principals[_to] = principalTo + _amount; + } + + emit Transferred(_from, _to, _amount, _data); + + _afterBondTransfer(_from, _to, _amount, _data); + } + + function _spendApproval(address _from, address _spender, uint256 _amount) internal virtual { + uint256 currentApproval = _approvals[_from][_spender]; + require(_amount <= currentApproval, "ERC7092: INSUFFICIENT_ALLOWANCE"); + + unchecked { + _approvals[_from][_spender] = currentApproval - _amount; + } + } + + function _beforeBondTransfer(address _from, address _to, uint256 _amount, bytes calldata _data) internal virtual {} + + function _afterBondTransfer(address _from, address _to, uint256 _amount, bytes calldata _data) internal virtual {} +} diff --git a/assets/eip-7092/IERC7092.sol b/assets/eip-7092/IERC7092.sol new file mode 100644 index 0000000000000..bae6f376f8873 --- /dev/null +++ b/assets/eip-7092/IERC7092.sol @@ -0,0 +1,186 @@ +// SPDX-License-Identifier: CC0-1.0 +pragma solidity ^0.8.0; + +/** +* @title ERC-7092 Financial Bonds tandard +*/ +interface IERC7092 { + /** + * @notice Returns the bond isin + */ + function isin() external view returns(string memory); + + /** + * @notice Returns the bond name + */ + function name() external view returns(string memory); + + /** + * @notice Returns the bond symbol + */ + function symbol() external view returns(string memory); + + /** + * @notice Returns the number of decimals the bond uses - e.g `10`, means to divide the token amount by `10000000000` + * + * OPTIONAL + */ + function decimals() external view returns(uint8); + + /** + * @notice Returns the bond currency. This is the contract address of the token used to pay and return the bond principal + */ + function currency() external view returns(address); + + /** + * @notice Returns the copoun currency. This is the contract address of the token used to pay coupons. It can be same as the the one used for the principal + */ + function currencyOfCoupon() external view returns(address); + + /** + * @notice Returns the bond denominiation. This is the minimum amount in which the Bonds may be issued. It must be expressend in unit of the principal currency + * ex: If the denomination is equal to 1,000 and the currency is USDC, then the bond denomination is equal to 1,000 USDC + */ + function denomination() external view returns(uint256); + + /** + * @notice Returns the issue volume (total debt amount). It is RECOMMENDED to express the issue volume in denomination unit. + * ex: if denomination = $1,000, and the total debt is $5,000,000 + * then, issueVolume() = $5,000, 000 / $1,000 = 5,000 bonds + */ + function issueVolume() external view returns(uint256); + + /** + * @notice Returns the bond interest rate. It is RECOMMENDED to express the interest rate in basis point unit. + * 1 basis point = 0.01% = 0.0001 + * ex: if interest rate = 5%, then coupon() => 500 basis points + */ + function couponRate() external view returns(uint256); + + /** + * @notice Returns the coupon type + * ex: 0: Zero coupon, 1: Fixed Rate, 2: Floating Rate, etc... + */ + function couponType() external view returns(uint256); + + /** + * @notice Returns the coupon frequency, i.e. the number of times coupons are paid in a year. + */ + function couponFrequency() external view returns(uint256); + + /** + * @notice Returns the date when bonds were issued to investors. This is a Unix Timestamp like the one returned by block.timestamp + */ + function issueDate() external view returns(uint256); + + /** + * @notice Returns the bond maturity date, i.e, the date when the pricipal is repaid. This is a Unix Timestamp like the one returned by block.timestamp + * The maturity date MUST be greater than the issue date + */ + function maturityDate() external view returns(uint256); + + /** + * @notice Returns the day count basis + * Ex: 0: actual/actual, 1: actual/360, etc... + */ + function dayCountBasis() external view returns(uint256); + + /** + * @notice Returns the principal of an account. It is RECOMMENDED to express the principal in denomination unit. + * Ex: if denomination = $1,000, and the user has invested $5,000 + * then principalOf(_account) = 5,000/1,000 = 5 + * @param _account account address + */ + function principalOf(address _account) external view returns(uint256); + + /** + * @notice Returns the amount of tokens the `_spender` account has been authorized by the `_owner`` + * acount to manage their bonds + * @param _owner the bondholder address + * @param _spender the address that has been authorized by the bondholder + */ + function approval(address _owner, address _spender) external view returns(uint256); + + /** + * @notice Authorizes `_spender` account to manage `_amount`of their bonds + * @param _spender the address to be authorized by the bondholder + * @param _amount amount of bond to approve. _amount MUST be a multiple of denomination + */ + function approve(address _spender, uint256 _amount) external; + + /** + * @notice Authorizes the `_spender` account to manage all their bonds + * @param _spender the address to be authorized by the bondholder + */ + function approveAll(address _spender) external; + + /** + * @notice Lowers the allowance of `_spender` by `_amount` + * @param _spender the address to be authorized by the bondholder + * @param _amount amount of bond to remove approval; _amount MUST be a multiple of denomination + */ + function decreaseAllowance(address _spender, uint256 _amount) external; + + /** + * @notice Removes the allowance for `_spender` + * @param _spender the address to remove the authorization by from + */ + function decreaseAllowanceForAll(address _spender) external; + + /** + * @notice Moves `_amount` bonds to address `_to` + * @param _to the address to send the bonds to + * @param _amount amount of bond to transfer. _amount MUST be a multiple of denomination + * @param _data additional information provided by the token holder + */ + function transfer(address _to, uint256 _amount, bytes calldata _data) external; + + /** + * @notice Moves all bonds to address `_to` + * @param _to the address to send the bonds to + * @param _data additional information provided by the token holder + */ + function transferAll(address _to, bytes calldata _data) external; + + /** + * @notice Moves `_amount` bonds from an account that has authorized the caller through the approve function + * @param _from the bondholder address + * @param _to the address to transfer bonds to + * @param _amount amount of bond to transfer. _amount MUST be a multiple of denomination + * @param _data additional information provided by the token holder + */ + function transferFrom(address _from, address _to, uint256 _amount, bytes calldata _data) external; + + /** + * @notice Moves all bonds from `_from` to `_to`. The caller must have been authorized through the approve function + * @param _from the bondholder address + * @param _to the address to transfer bonds to + * @param _data additional information provided by the token holder + */ + function transferAllFrom(address _from, address _to, bytes calldata _data) external; + + /** + * @notice MUST be emitted when bonds are transferred + * @param _from the account that owns bonds + * @param _to the account that receives the bond + * @param _amount the amount of bonds to be transferred + * @param _data additional information provided by the token holder + */ + event Transferred(address _from, address _to, uint256 _amount, bytes _data); + + /** + * @notice MUST be emitted when an account is approved + * @param _owner the bonds owner + * @param _spender the account to be allowed to spend bonds + * @param _amount the amount allowed by _owner to be spent by _spender. + */ + event Approved(address _owner, address _spender, uint256 _amount); + + /** + * @notice MUST be emmitted when the `_owner` decreases allowance from `_sepnder` by quantity `_amount` + * @param _owner the bonds owner + * @param _spender the account that has been allowed to spend bonds + * @param _amount the amount of tokens to disapprove + */ + event AllowanceDecreased(address _owner, address _spender, uint256 _amount); +} diff --git a/assets/eip-7092/coupons/CouponMath.sol b/assets/eip-7092/coupons/CouponMath.sol new file mode 100644 index 0000000000000..458b42d5d2c91 --- /dev/null +++ b/assets/eip-7092/coupons/CouponMath.sol @@ -0,0 +1,58 @@ +// SPDX-License-Identifier: CC0-1.0 +pragma solidity ^0.8.0; + +import "../IERC7092.sol"; + +library CouponMath { + /** + * @notice Returns the annual interest earned by an account in bips + * @param _investor the investor account address + * @param _bondContract the bond contract address + */ + function annualInterest( + address _investor, + address _bondContract + ) external view returns(uint256) { + uint256 couponRate = IERC7092(_bondContract).couponRate(); + uint256 denomination = IERC7092(_bondContract).denomination(); + uint256 principal = IERC7092(_bondContract).principalOf(_investor); + + return principal * denomination * couponRate; + } + + /** + * @notice Returns the interest earned by an account in period `_duration` in bips + * @param _investor the investor account address + * @param _duration time ellapsed since the last coupon payment + * @param _bondContract the bond contract address + */ + function interest( + address _investor, + uint256 _duration, + address _bondContract + ) external view returns(uint256) { + uint256 couponRate = IERC7092(_bondContract).couponRate(); + uint256 denomination = IERC7092(_bondContract).denomination(); + uint256 principal = IERC7092(_bondContract).principalOf(_investor); + uint256 frequency = IERC7092(_bondContract).couponFrequency(); + uint256 numberOfDays = _numberOfDays(_bondContract); + + return principal * denomination * couponRate * _duration / (frequency * numberOfDays); + } + + /** + * @notice Returns the number of days in a year based on the base count basis used. + * Here we just check for two values. + */ + function _numberOfDays(address _bondContract) private view returns(uint256) { + uint256 dayCountBasis = IERC7092(_bondContract).dayCountBasis(); + + if(dayCountBasis == 0) { + return 365; + } else if(dayCountBasis == 1) { + return 360; + } else { + revert("invalid day count basis value"); + } + } +}