diff --git a/docs/common/src/src/interfaces/IERC20.sol/interface.IERC20.md b/docs/common/src/src/interfaces/IERC20.sol/interface.IERC20.md index 8d8f372..865c719 100644 --- a/docs/common/src/src/interfaces/IERC20.sol/interface.IERC20.md +++ b/docs/common/src/src/interfaces/IERC20.sol/interface.IERC20.md @@ -22,7 +22,7 @@ function approve(address spender, uint256 amount) external returns (bool); |Name|Type|Description| |----|----|-----------| -|`spender`|`address`|The address of the account being allowed to spend up to the allowed amount.| +|`spender`|`address`|The address of the account is allowed to spend up to the allowed amount.| |`amount`|`uint256`| The amount of the allowance being approved.| **Returns** diff --git a/docs/common/src/src/interfaces/IERC712.sol/interface.IERC712.md b/docs/common/src/src/interfaces/IERC712.sol/interface.IERC712.md index 13e4ee7..243a8e9 100644 --- a/docs/common/src/src/interfaces/IERC712.sol/interface.IERC712.md +++ b/docs/common/src/src/interfaces/IERC712.sol/interface.IERC712.md @@ -19,7 +19,7 @@ function DOMAIN_SEPARATOR() external view returns (bytes32); ## Errors ### InvalidSignature -Revert message when an invalid signature is detected. +Revert the message when an invalid signature is detected. ```solidity @@ -27,7 +27,7 @@ error InvalidSignature(); ``` ### InvalidSignatureLength -Revert message when a signature with invalid length is detected. +Revert the message when a signature with an invalid length is detected. ```solidity @@ -35,7 +35,7 @@ error InvalidSignatureLength(); ``` ### InvalidSignatureS -Revert message when the S portion of a signature is invalid. +Revert the message when the S portion of a signature is invalid. ```solidity @@ -43,7 +43,7 @@ error InvalidSignatureS(); ``` ### InvalidSignatureV -Revert message when the V portion of a signature is invalid. +Revert the message when the V portion of a signature is invalid. ```solidity @@ -51,7 +51,7 @@ error InvalidSignatureV(); ``` ### SignatureExpired -Revert message when a signature is being used beyond its deadline (i.e. expiry). +Revert the message when a signature is being used beyond its deadline (i.e. expiry). ```solidity diff --git a/docs/common/src/src/libs/SignatureChecker.sol/library.SignatureChecker.md b/docs/common/src/src/libs/SignatureChecker.sol/library.SignatureChecker.md index 7583ea2..4b3fa90 100644 --- a/docs/common/src/src/libs/SignatureChecker.sol/library.SignatureChecker.md +++ b/docs/common/src/src/libs/SignatureChecker.sol/library.SignatureChecker.md @@ -169,7 +169,7 @@ function recoverECDSASigner(bytes32 digest, bytes memory signature) internal pur |Name|Type|Description| |----|----|-----------| |``|`Error`|An error, if any, that occurred during the signer recovery.| -|``|`address`|The address of the account recovered form the signature (0 if error).| +|``|`address`|The address of the account recovered from the signature (0 if error).| ### recoverECDSASigner diff --git a/docs/protocol/src/src/MinterGateway.sol/contract.MinterGateway.md b/docs/protocol/src/src/MinterGateway.sol/contract.MinterGateway.md index 3b1c90a..c18ddac 100644 --- a/docs/protocol/src/src/MinterGateway.sol/contract.MinterGateway.md +++ b/docs/protocol/src/src/MinterGateway.sol/contract.MinterGateway.md @@ -299,7 +299,7 @@ function mintM(uint256 mintId_) Burns M tokens -*If amount to burn is greater than minter's owedM including penalties, burn all up to owedM.* +*If the amount to burn is greater than minter's owedM including penalties, burn all up to owedM.* ```solidity @@ -324,7 +324,7 @@ function burnM(address minter_, uint256 maxAmount_) external returns (uint112 pr Burns M tokens -*If amount to burn is greater than minter's owedM including penalties, burn all up to owedM.* +*If the amount to burn is greater than minter's owedM including penalties, burn all up to owedM.* ```solidity @@ -350,7 +350,7 @@ function burnM(address minter_, uint256 maxPrincipalAmount_, uint256 maxAmount_) ### cancelMint -Cancels minting request for selected minter by validator +Cancels minting request for selected minter by the validator ```solidity @@ -478,7 +478,7 @@ function minterRate() external view returns (uint32); ### isActiveMinter -Checks if minter was activated after approval by TTG +Checks if the minter was activated after approval by TTG ```solidity @@ -496,7 +496,7 @@ function isDeactivatedMinter(address minter_) external view returns (bool); ### isFrozenMinter -Checks if minter was frozen by validator +Checks if the minter was frozen by validator ```solidity diff --git a/docs/protocol/src/src/Protocol.sol/contract.Protocol.md b/docs/protocol/src/src/Protocol.sol/contract.Protocol.md index 6f95357..9b537cd 100644 --- a/docs/protocol/src/src/Protocol.sol/contract.Protocol.md +++ b/docs/protocol/src/src/Protocol.sol/contract.Protocol.md @@ -319,7 +319,7 @@ function mintM(uint256 mintId_) external onlyActiveMinter onlyUnfrozenMinter; Burns M tokens -*If amount to burn is greater than minter's outstandingValue including penalties, burn all outstandingValue* +*If the amount to burn is greater than the minter's outstandingValue including penalties, burn all outstandingValue* ```solidity @@ -335,7 +335,7 @@ function burnM(address minter_, uint256 maxAmount_) external; ### cancelMint -Cancels minting request for selected minter by validator +Cancels minting request for selected minter by the validator ```solidity @@ -465,7 +465,7 @@ function excessActiveOwedM() public view returns (uint256 getExcessOwedM_); ### minterRate -The last saved value of Minter rate. +The last saved value of the Minter rate. ```solidity @@ -474,7 +474,7 @@ function minterRate() external view returns (uint256 minterRate_); ### activeOwedMOf -The active owed M of minter. +The active owed M of the minter. ```solidity diff --git a/docs/protocol/src/src/interfaces/IMToken.sol/interface.IMToken.md b/docs/protocol/src/src/interfaces/IMToken.sol/interface.IMToken.md index 4acd0fd..4fc01eb 100644 --- a/docs/protocol/src/src/interfaces/IMToken.sol/interface.IMToken.md +++ b/docs/protocol/src/src/interfaces/IMToken.sol/interface.IMToken.md @@ -88,7 +88,7 @@ function rateModel() external view returns (address); ### earnerRate -The current value of earner rate in basis points. +The current value of the earner rate in basis points. ```solidity diff --git a/docs/protocol/src/src/interfaces/IMinterGateway.sol/interface.IMinterGateway.md b/docs/protocol/src/src/interfaces/IMinterGateway.sol/interface.IMinterGateway.md index 3c4e326..b05cae8 100644 --- a/docs/protocol/src/src/interfaces/IMinterGateway.sol/interface.IMinterGateway.md +++ b/docs/protocol/src/src/interfaces/IMinterGateway.sol/interface.IMinterGateway.md @@ -111,7 +111,7 @@ function mintM(uint256 mintId) external returns (uint112 principalAmount, uint24 Burns M tokens -*If amount to burn is greater than minter's owedM including penalties, burn all up to owedM.* +*If the amount to burn is greater than the minter's owedM including penalties, burn all up to owedM.* ```solidity @@ -136,7 +136,7 @@ function burnM(address minter, uint256 maxAmount) external returns (uint112 prin Burns M tokens -*If amount to burn is greater than minter's owedM including penalties, burn all up to owedM.* +*If the amount to burn is greater than the minter's owedM including penalties, burn all up to owedM.* ```solidity @@ -162,7 +162,7 @@ function burnM(address minter, uint256 maxPrincipalAmount, uint256 maxAmount) ### cancelMint -Cancels minting request for selected minter by validator +Cancels minting request for selected minter by the validator ```solidity diff --git a/docs/protocol/src/src/interfaces/IProtocol.sol/interface.IProtocol.md b/docs/protocol/src/src/interfaces/IProtocol.sol/interface.IProtocol.md index 5f706e4..4077ecf 100644 --- a/docs/protocol/src/src/interfaces/IProtocol.sol/interface.IProtocol.md +++ b/docs/protocol/src/src/interfaces/IProtocol.sol/interface.IProtocol.md @@ -105,7 +105,7 @@ function mintM(uint256 mintId) external; Burns M tokens -*If amount to burn is greater than minter's outstandingValue including penalties, burn all outstandingValue* +*If the amount to burn is greater than minter's outstandingValue including penalties, burn all outstandingValue* ```solidity @@ -121,7 +121,7 @@ function burnM(address minter, uint256 amount) external; ### cancelMint -Cancels minting request for selected minter by validator +Cancels minting request for selected minter by the validator ```solidity diff --git a/docs/protocol/src/src/libs/TTGRegistrarReader.sol/library.TTGRegistrarReader.md b/docs/protocol/src/src/libs/TTGRegistrarReader.sol/library.TTGRegistrarReader.md index 8d5b166..3dc15f6 100644 --- a/docs/protocol/src/src/libs/TTGRegistrarReader.sol/library.TTGRegistrarReader.md +++ b/docs/protocol/src/src/libs/TTGRegistrarReader.sol/library.TTGRegistrarReader.md @@ -106,7 +106,7 @@ bytes32 internal constant UPDATE_COLLATERAL_INTERVAL = "update_collateral_interv ### UPDATE_COLLATERAL_VALIDATOR_THRESHOLD -The name of parameter that defines number of signatures required for successful collateral update +The name of parameter that defines number of signatures required for a successful collateral update ```solidity diff --git a/docs/ttg/src/src/PowerToken.sol/contract.PowerToken.md b/docs/ttg/src/src/PowerToken.sol/contract.PowerToken.md index eb6c247..f35528f 100644 --- a/docs/ttg/src/src/PowerToken.sol/contract.PowerToken.md +++ b/docs/ttg/src/src/PowerToken.sol/contract.PowerToken.md @@ -269,7 +269,7 @@ Returns the target supply, which helps determine the amount of tokens up for auc linearly, with time, to some "rightPoint" (which is half of that "leftPoint"). This is done by computing the weighted average between the "leftPoint" and "rightPoint" for the time remaining in the auction period. -- For the next next auction period, the new "leftPoint" is half of the previous period's "leftPoint" +- For the next auction period, the new "leftPoint" is half of the previous period's "leftPoint" (which also equals the previous period's "rightPoint"). - Combined, this results in the price decreasing by half every auction period at a macro level, but decreasing linearly at a micro-level during each period, without any jumps. diff --git a/docs/ttg/src/src/interfaces/IDistributionVault.sol/interface.IDistributionVault.md b/docs/ttg/src/src/interfaces/IDistributionVault.sol/interface.IDistributionVault.md index a25e93c..7b403c2 100644 --- a/docs/ttg/src/src/interfaces/IDistributionVault.sol/interface.IDistributionVault.md +++ b/docs/ttg/src/src/interfaces/IDistributionVault.sol/interface.IDistributionVault.md @@ -26,7 +26,7 @@ function claim(address token, uint256 startEpoch, uint256 endEpoch, address dest |`token`|`address`| The address of the token being claimed.| |`startEpoch`|`uint256`| The starting epoch number as a clock value.| |`endEpoch`|`uint256`| The ending epoch number as a clock value.| -|`destination`|`address`|The address the account where the claimed token will be sent.| +|`destination`|`address`|The address of the account where the claimed token will be sent.| **Returns** diff --git a/docs/ttg/src/src/interfaces/IPowerToken.sol/interface.IPowerToken.md b/docs/ttg/src/src/interfaces/IPowerToken.sol/interface.IPowerToken.md index b5a3bb3..24e2fae 100644 --- a/docs/ttg/src/src/interfaces/IPowerToken.sol/interface.IPowerToken.md +++ b/docs/ttg/src/src/interfaces/IPowerToken.sol/interface.IPowerToken.md @@ -181,7 +181,7 @@ event Buy(address indexed buyer, uint240 amount, uint256 cost); |Name|Type|Description| |----|----|-----------| -|`buyer`|`address`| The address of account that bought tokens from the auction.| +|`buyer`|`address`| The address of the account that bought tokens from the auction.| |`amount`|`uint240`|The amount of tokens bought.| |`cost`|`uint256`| The total cash token cost of the purchase.| diff --git a/docs/ttg/src/src/interfaces/IZeroGovernor.sol/interface.IZeroGovernor.md b/docs/ttg/src/src/interfaces/IZeroGovernor.sol/interface.IZeroGovernor.md index 517b82c..960b6c8 100644 --- a/docs/ttg/src/src/interfaces/IZeroGovernor.sol/interface.IZeroGovernor.md +++ b/docs/ttg/src/src/interfaces/IZeroGovernor.sol/interface.IZeroGovernor.md @@ -157,7 +157,7 @@ event AllowedCashTokensSet(address[] allowedCashTokens); |Name|Type|Description| |----|----|-----------| -|`allowedCashTokens`|`address[]`|An array of addressed that are allowed as cash tokens.| +|`allowedCashTokens`|`address[]`|An array of addresses that are allowed as cash tokens.| ### ResetExecuted Emitted upon a Reset, resulting in a new Standard Governor, Emergency Governor, and Power Token.