Skip to content

Commit

Permalink
docs: updates
Browse files Browse the repository at this point in the history
  • Loading branch information
PacificYield committed Nov 13, 2024
1 parent 4d18e5e commit 09dd46d
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 5 deletions.
15 changes: 13 additions & 2 deletions docs/governance/GovernorAlphaZama.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,8 +161,19 @@ Possible states that a proposal may be in.

### Parameters

| Name | Type | Description |
| ---- | ---- | ----------- |
| Name | Description |
| ---------------------------- | ------------------------------------------------------------------------------------------- |
| Pending | Proposal does not exist. |
| PendingThresholdVerification | Proposal is created but token threshold verification is pending. |
| Rejected | Proposal was rejected as the proposer did not meet the token threshold. |
| Active | Proposal is active and voters can cast their votes. |
| PendingResults | Proposal is not active and the result decryption is in progress. |
| Canceled | Proposal has been canceled by the proposer or by this contract's owner. |
| Defeated | Proposal has been defeated (either not reaching the quorum or `againstVotes` > `forVotes`). |
| Succeeded | Proposal has succeeded (`forVotes` > `againstVotes`). |
| Queued | Proposal has been queued in the `Timelock`. |
| Expired | Proposal has expired (@dev This state exists only in read-only functions). |
| Executed | Proposal has been executed in the `Timelock`. |

```solidity
enum ProposalState {
Expand Down
8 changes: 5 additions & 3 deletions docs/token/ERC20/extensions/EncryptedERC20WithErrors.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,11 @@ Emitted when tokens are moved from one account (`from`) to another (`to`).

Error codes allow tracking (in the storage) whether a transfer worked.

_NO_ERROR: the transfer worked as expected UNSUFFICIENT_BALANCE: the transfer failed because the from balances were
strictly inferior to the amount to transfer. UNSUFFICIENT_APPROVAL: the transfer failed because the sender allowance was
strictly lower than the amount to transfer._
| Name | Description |
| --------------------- | ------------------------------------------------------------------------------------------------ |
| NO_ERROR | The transfer worked as expected. |
| UNSUFFICIENT_BALANCE | The transfer failed because the from balances were strictly inferior to the amount to transfer. |
| UNSUFFICIENT_APPROVAL | The transfer failed because the sender allowance was strictly lower than the amount to transfer. |

```solidity
enum ErrorCodes {
Expand Down

0 comments on commit 09dd46d

Please sign in to comment.