Skip to content

Commit b779d67

Browse files
authored
Updating with mainnet deployment March 8th, 2026 (#124)
1 parent 94e7de5 commit b779d67

17 files changed

Lines changed: 1369 additions & 47 deletions

File tree

docs/build/api/contracts/api-reference/app-registry.md

Lines changed: 40 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ displayed_sidebar: buildSidebar
66
---
77

88
# AppRegistry
9-
[Git Source](https://github.com/layer-3/yellow/blob/f97fcc52ddfdc5918cb91b2af5538abb0060ee27/src/AppRegistry.sol)
9+
[Git Source](https://github.com/layer-3/yellow/blob/dcd9928fb0cdf7b35bc4cae06401284b2529d311/src/AppRegistry.sol)
1010

1111
**Inherits:**
1212
[Locker](/src/Locker.sol/abstract.Locker.md), [ISlash](/src/interfaces/ISlash.sol/interface.ISlash.md), AccessControl
@@ -25,6 +25,10 @@ No collateral weight for parameter administration — this registry is purely fo
2525
collateral management and slashing. See NodeRegistry for the parameter-administration-enabled
2626
variant used by node operators.
2727
Slashing can occur in both Locked and Unlocking states.
28+
Adjudicators are not economically incentivised by slash outcomes by design.
29+
Dispute initiators pay the adjudicator's handling fee off-chain (similar to
30+
arbitration forums / ODRP). This avoids creating perverse incentives around
31+
decision outcomes.
2832

2933

3034
## State Variables
@@ -36,7 +40,7 @@ bytes32 public constant ADJUDICATOR_ROLE = keccak256("ADJUDICATOR_ROLE")
3640

3741

3842
### slashCooldown
39-
Minimum time (seconds) that must elapse between any two slash calls.
43+
Minimum time (seconds) that must elapse between consecutive slashes by the same adjudicator.
4044

4145

4246
```solidity
@@ -45,11 +49,21 @@ uint256 public slashCooldown
4549

4650

4751
### lastSlashTimestamp
48-
Timestamp of the last successful slash.
52+
Timestamp of the last successful slash per adjudicator.
4953

5054

5155
```solidity
52-
uint256 public lastSlashTimestamp
56+
mapping(address => uint256) public lastSlashTimestamp
57+
```
58+
59+
60+
### minSlashAmount
61+
Minimum slash amount. Slashes below this are rejected unless `amount == balance`
62+
(full-balance slash). Prevents zero-amount or dust slashes from resetting the cooldown.
63+
64+
65+
```solidity
66+
uint256 public minSlashAmount
5367
```
5468

5569

@@ -63,7 +77,7 @@ constructor(address asset_, uint256 unlockPeriod_, address admin_) Locker(asset_
6377

6478
### setSlashCooldown
6579

66-
Sets the global cooldown between slash calls.
80+
Sets the per-adjudicator cooldown between slash calls.
6781

6882

6983
```solidity
@@ -76,6 +90,21 @@ function setSlashCooldown(uint256 newCooldown) external onlyRole(DEFAULT_ADMIN_R
7690
|`newCooldown`|`uint256`|The new cooldown in seconds (0 disables the cooldown).|
7791

7892

93+
### setMinSlashAmount
94+
95+
Sets the minimum slash amount.
96+
97+
98+
```solidity
99+
function setMinSlashAmount(uint256 newAmount) external onlyRole(DEFAULT_ADMIN_ROLE);
100+
```
101+
**Parameters**
102+
103+
|Name|Type|Description|
104+
|----|----|-----------|
105+
|`newAmount`|`uint256`|The new minimum amount (0 disables the minimum).|
106+
107+
79108
### slash
80109

81110
Reduces a user's locked balance and transfers the slashed tokens
@@ -105,6 +134,12 @@ function slash(address user, uint256 amount, address recipient, bytes calldata d
105134
event SlashCooldownUpdated(uint256 oldCooldown, uint256 newCooldown);
106135
```
107136

137+
### MinSlashAmountUpdated
138+
139+
```solidity
140+
event MinSlashAmountUpdated(uint256 oldAmount, uint256 newAmount);
141+
```
142+
108143
## Errors
109144
### SlashCooldownActive
110145

docs/build/api/contracts/api-reference/faucet.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ displayed_sidebar: buildSidebar
66
---
77

88
# Faucet
9-
[Git Source](https://github.com/layer-3/yellow/blob/f97fcc52ddfdc5918cb91b2af5538abb0060ee27/src/Faucet.sol)
9+
[Git Source](https://github.com/layer-3/yellow/blob/dcd9928fb0cdf7b35bc4cae06401284b2529d311/src/Faucet.sol)
1010

1111
**Title:**
1212
Faucet — YELLOW testnet token faucet

docs/build/api/contracts/api-reference/interfaces/ilock.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ displayed_sidebar: buildSidebar
66
---
77

88
# ILock
9-
[Git Source](https://github.com/layer-3/yellow/blob/f97fcc52ddfdc5918cb91b2af5538abb0060ee27/src/interfaces/ILock.sol)
9+
[Git Source](https://github.com/layer-3/yellow/blob/dcd9928fb0cdf7b35bc4cae06401284b2529d311/src/interfaces/ILock.sol)
1010

1111
**Title:**
1212
ILock
@@ -146,14 +146,15 @@ event Relocked(address indexed user, uint256 balance);
146146
### Withdrawn
147147

148148
```solidity
149-
event Withdrawn(address indexed user, uint256 balance);
149+
event Withdrawn(address indexed user, address indexed destination, uint256 balance);
150150
```
151151

152152
**Parameters**
153153

154154
|Name|Type|Description|
155155
|----|----|-----------|
156156
|`user`|`address`|The user that withdrew.|
157+
|`destination`|`address`|The address that received the tokens.|
157158
|`balance`|`uint256`|The amount withdrawn.|
158159

159160
## Errors

docs/build/api/contracts/api-reference/interfaces/islash.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ displayed_sidebar: buildSidebar
66
---
77

88
# ISlash
9-
[Git Source](https://github.com/layer-3/yellow/blob/f97fcc52ddfdc5918cb91b2af5538abb0060ee27/src/interfaces/ISlash.sol)
9+
[Git Source](https://github.com/layer-3/yellow/blob/dcd9928fb0cdf7b35bc4cae06401284b2529d311/src/interfaces/ISlash.sol)
1010

1111
**Title:**
1212
ISlash
@@ -68,3 +68,19 @@ The recipient cannot be the adjudicator calling slash.
6868
error RecipientIsAdjudicator();
6969
```
7070

71+
### RecipientIsUser
72+
The recipient cannot be the slashed user.
73+
74+
75+
```solidity
76+
error RecipientIsUser();
77+
```
78+
79+
### SlashAmountTooLow
80+
The slash amount is below the minimum and does not equal the full balance.
81+
82+
83+
```solidity
84+
error SlashAmountTooLow();
85+
```
86+

docs/build/api/contracts/api-reference/locker.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ displayed_sidebar: buildSidebar
66
---
77

88
# Locker
9-
[Git Source](https://github.com/layer-3/yellow/blob/f97fcc52ddfdc5918cb91b2af5538abb0060ee27/src/Locker.sol)
9+
[Git Source](https://github.com/layer-3/yellow/blob/dcd9928fb0cdf7b35bc4cae06401284b2529d311/src/Locker.sol)
1010

1111
**Inherits:**
1212
[ILock](/src/interfaces/ILock.sol/interface.ILock.md), ReentrancyGuard

docs/build/api/contracts/api-reference/node-registry.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ displayed_sidebar: buildSidebar
66
---
77

88
# NodeRegistry
9-
[Git Source](https://github.com/layer-3/yellow/blob/f97fcc52ddfdc5918cb91b2af5538abb0060ee27/src/NodeRegistry.sol)
9+
[Git Source](https://github.com/layer-3/yellow/blob/dcd9928fb0cdf7b35bc4cae06401284b2529d311/src/NodeRegistry.sol)
1010

1111
**Inherits:**
1212
[Locker](/src/Locker.sol/abstract.Locker.md), Votes

docs/build/api/contracts/api-reference/treasury.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ displayed_sidebar: buildSidebar
66
---
77

88
# Treasury
9-
[Git Source](https://github.com/layer-3/yellow/blob/f97fcc52ddfdc5918cb91b2af5538abb0060ee27/src/Treasury.sol)
9+
[Git Source](https://github.com/layer-3/yellow/blob/dcd9928fb0cdf7b35bc4cae06401284b2529d311/src/Treasury.sol)
1010

1111
**Inherits:**
1212
Ownable2Step, ReentrancyGuard

docs/build/api/contracts/api-reference/yellow-governor.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ displayed_sidebar: buildSidebar
66
---
77

88
# YellowGovernor
9-
[Git Source](https://github.com/layer-3/yellow/blob/f97fcc52ddfdc5918cb91b2af5538abb0060ee27/src/Governor.sol)
9+
[Git Source](https://github.com/layer-3/yellow/blob/dcd9928fb0cdf7b35bc4cae06401284b2529d311/src/Governor.sol)
1010

1111
**Inherits:**
1212
Governor, GovernorSettings, GovernorCountingSimple, GovernorVotes, GovernorVotesQuorumFraction, GovernorTimelockControl, GovernorPreventLateQuorum, GovernorProposalGuardian

docs/build/api/contracts/api-reference/yellow-token.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ displayed_sidebar: buildSidebar
66
---
77

88
# YellowToken
9-
[Git Source](https://github.com/layer-3/yellow/blob/f97fcc52ddfdc5918cb91b2af5538abb0060ee27/src/Token.sol)
9+
[Git Source](https://github.com/layer-3/yellow/blob/dcd9928fb0cdf7b35bc4cae06401284b2529d311/src/Token.sol)
1010

1111
**Inherits:**
1212
ERC20Permit

docs/build/api/contracts/faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "FAQ"
33
description: "Frequently asked questions about Yellow Network smart contracts."
4-
sidebar_position: 7
4+
sidebar_position: 2
55
displayed_sidebar: buildSidebar
66
---
77

0 commit comments

Comments
 (0)