Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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**
Expand Down
10 changes: 5 additions & 5 deletions docs/common/src/src/interfaces/IERC712.sol/interface.IERC712.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,39 +19,39 @@ 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
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
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
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
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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ function recoverECDSASigner(bytes32 digest, bytes memory signature) internal pur
|Name|Type|Description|
|----|----|-----------|
|`<none>`|`Error`|An error, if any, that occurred during the signer recovery.|
|`<none>`|`address`|The address of the account recovered form the signature (0 if error).|
|`<none>`|`address`|The address of the account recovered from the signature (0 if error).|


### recoverECDSASigner
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down
8 changes: 4 additions & 4 deletions docs/protocol/src/src/Protocol.sol/contract.Protocol.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/ttg/src/src/PowerToken.sol/contract.PowerToken.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.|

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down