Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: adding some comments & questions #50

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: adding some comments & questions #50

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
961bdb9
docs: adding some comments & questions
nutrina Dec 7, 2023
e8408dc
fixed todos
Dec 7, 2023
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
26 changes: 21 additions & 5 deletions docs/07-identity-slashing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,8 +76,8 @@ When slashed, stake is sent to the **Stake Icebox** contract.

The latest-to-unlock stake will be slashed first.

See [section #8](./08-gitcoin-identity-staking-management.md) for more info about this contract, not
related to slashing.
See [section #8](./08-gitcoin-identity-staking-management.md) for more info about
this contract, not related to slashing.

### Slashing Roles

Expand All @@ -103,6 +103,14 @@ related to slashing.
- `uint16 slashReasonCount`
- `IGitcoinStakingIcebox public icebox`

### Slashing Events

- `Slashed(address user, uint256 amount, uint16 reason)`
- `SlashedMultiple(address[] users, uint256 amount, uint16 reason)`
- `SetIcebox(address iceboxAddress)`
- `AddSlasher(address slasher)`
- `RemoveSlasher(address slasher)`

## Slasher(s)

Can call `slash` to slash stake. Could be...
Expand Down Expand Up @@ -138,17 +146,25 @@ that is older than a set threshold.
- `removeManager(address manager) onlyAdmin`
- `setBurnAgeThreshold(uint64 ageThreshold) onlyAdmin`
- `setStakingContract(address stakingContract) onlyAdmin`

- `release(address user, uint256 amount) onlyManager`
- `burnAgedStake() onlyManager`
- `burnAgedStake(uint256 maxBurn) onlyManager` - optional maxBurn limits the
stake to be burned, in case there is too much stake to burn it all
in one transaction (gas limits)
- `supportsInterface(...)` - implement ERC165 interface for IGitcoinStakingIcebox
- `slash(address user, uint256 amount) onlyStakingContract` - call transferFrom
and record the slash

### State

- `mapping(user => Slash) public slashes`
- `struct Slash { uint256 amount, uint64 slashedDate }`
- `mapping(user => Slash[]) public slashes`
- `struct Slash { uint256 amount, uint64 slashedTime }`
- `uint64 public burnAgeThreshold`
- `IGitcoinIdentityStaking public stakingContract`

### Events

- `Released(address user, uint256 amount)`
- `Burned(uint256 amount)`

_[← Back to README](..#other-topics)_