Skip to content

Update contracts docs to v1.0.4 #126

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

Merged
mod merged 1 commit into from
Mar 12, 2026
Merged

Update contracts docs to v1.0.4 #126

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion docs/build/api/contracts/api-reference/app-registry.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ displayed_sidebar: buildSidebar
---

# AppRegistry
[Git Source](https://github.com/layer-3/yellow/blob/dcd9928fb0cdf7b35bc4cae06401284b2529d311/src/AppRegistry.sol)
[Git Source](https://github.com/layer-3/yellow/blob/11ed85c3dabaaddeee431052032791a80eaf2a0e/src/AppRegistry.sol)

**Inherits:**
[Locker](/src/Locker.sol/abstract.Locker.md), [ISlash](/src/interfaces/ISlash.sol/interface.ISlash.md), AccessControl
Expand Down
2 changes: 1 addition & 1 deletion docs/build/api/contracts/api-reference/faucet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ displayed_sidebar: buildSidebar
---

# Faucet
[Git Source](https://github.com/layer-3/yellow/blob/dcd9928fb0cdf7b35bc4cae06401284b2529d311/src/Faucet.sol)
[Git Source](https://github.com/layer-3/yellow/blob/11ed85c3dabaaddeee431052032791a80eaf2a0e/src/Faucet.sol)

**Title:**
Faucet — YELLOW testnet token faucet
Expand Down
2 changes: 1 addition & 1 deletion docs/build/api/contracts/api-reference/interfaces/ilock.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ displayed_sidebar: buildSidebar
---

# ILock
[Git Source](https://github.com/layer-3/yellow/blob/dcd9928fb0cdf7b35bc4cae06401284b2529d311/src/interfaces/ILock.sol)
[Git Source](https://github.com/layer-3/yellow/blob/11ed85c3dabaaddeee431052032791a80eaf2a0e/src/interfaces/ILock.sol)

**Title:**
ILock
Expand Down
2 changes: 1 addition & 1 deletion docs/build/api/contracts/api-reference/interfaces/islash.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ displayed_sidebar: buildSidebar
---

# ISlash
[Git Source](https://github.com/layer-3/yellow/blob/dcd9928fb0cdf7b35bc4cae06401284b2529d311/src/interfaces/ISlash.sol)
[Git Source](https://github.com/layer-3/yellow/blob/11ed85c3dabaaddeee431052032791a80eaf2a0e/src/interfaces/ISlash.sol)

**Title:**
ISlash
Expand Down
2 changes: 1 addition & 1 deletion docs/build/api/contracts/api-reference/locker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ displayed_sidebar: buildSidebar
---

# Locker
[Git Source](https://github.com/layer-3/yellow/blob/dcd9928fb0cdf7b35bc4cae06401284b2529d311/src/Locker.sol)
[Git Source](https://github.com/layer-3/yellow/blob/11ed85c3dabaaddeee431052032791a80eaf2a0e/src/Locker.sol)

**Inherits:**
[ILock](/src/interfaces/ILock.sol/interface.ILock.md), ReentrancyGuard
Expand Down
2 changes: 1 addition & 1 deletion docs/build/api/contracts/api-reference/node-registry.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ displayed_sidebar: buildSidebar
---

# NodeRegistry
[Git Source](https://github.com/layer-3/yellow/blob/dcd9928fb0cdf7b35bc4cae06401284b2529d311/src/NodeRegistry.sol)
[Git Source](https://github.com/layer-3/yellow/blob/11ed85c3dabaaddeee431052032791a80eaf2a0e/src/NodeRegistry.sol)

**Inherits:**
[Locker](/src/Locker.sol/abstract.Locker.md), Votes
Expand Down
2 changes: 1 addition & 1 deletion docs/build/api/contracts/api-reference/treasury.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ displayed_sidebar: buildSidebar
---

# Treasury
[Git Source](https://github.com/layer-3/yellow/blob/dcd9928fb0cdf7b35bc4cae06401284b2529d311/src/Treasury.sol)
[Git Source](https://github.com/layer-3/yellow/blob/11ed85c3dabaaddeee431052032791a80eaf2a0e/src/Treasury.sol)

**Inherits:**
Ownable2Step, ReentrancyGuard
Expand Down
2 changes: 1 addition & 1 deletion docs/build/api/contracts/api-reference/yellow-governor.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ displayed_sidebar: buildSidebar
---

# YellowGovernor
[Git Source](https://github.com/layer-3/yellow/blob/dcd9928fb0cdf7b35bc4cae06401284b2529d311/src/Governor.sol)
[Git Source](https://github.com/layer-3/yellow/blob/11ed85c3dabaaddeee431052032791a80eaf2a0e/src/Governor.sol)

**Inherits:**
Governor, GovernorSettings, GovernorCountingSimple, GovernorVotes, GovernorVotesQuorumFraction, GovernorTimelockControl, GovernorPreventLateQuorum, GovernorProposalGuardian
Expand Down
2 changes: 1 addition & 1 deletion docs/build/api/contracts/api-reference/yellow-token.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ displayed_sidebar: buildSidebar
---

# YellowToken
[Git Source](https://github.com/layer-3/yellow/blob/dcd9928fb0cdf7b35bc4cae06401284b2529d311/src/Token.sol)
[Git Source](https://github.com/layer-3/yellow/blob/11ed85c3dabaaddeee431052032791a80eaf2a0e/src/Token.sol)

**Inherits:**
ERC20Permit
Expand Down
8 changes: 4 additions & 4 deletions docs/build/api/contracts/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ displayed_sidebar: buildSidebar
| Contract | Address |
|---|---|
| YellowToken | [`0x236eB848C95b231299B4AA9f56c73D6893462720`](https://etherscan.io/address/0x236eB848C95b231299B4AA9f56c73D6893462720) |
| NodeRegistry | — |
| AppRegistry | — |
| YellowGovernor | — |
| TimelockController | — |
| NodeRegistry | [`0xB0C7aA4ca9ffF4A48B184d8425eb5B6Fa772d820`](https://etherscan.io/address/0xB0C7aA4ca9ffF4A48B184d8425eb5B6Fa772d820) |
| AppRegistry | [`0x5A70029B843eE272A2392acE21DA392693eef1c6`](https://etherscan.io/address/0x5A70029B843eE272A2392acE21DA392693eef1c6) |
| YellowGovernor | [`0x7Ce0AE21E11dFEDA2F6e4D8bF2749E4061119512`](https://etherscan.io/address/0x7Ce0AE21E11dFEDA2F6e4D8bF2749E4061119512) |
| TimelockController | [`0x9530896F9622b925c37dF5Cfa271cc9deBB226b7`](https://etherscan.io/address/0x9530896F9622b925c37dF5Cfa271cc9deBB226b7) |
| Treasury | — |
| Faucet | — |

Expand Down
3 changes: 2 additions & 1 deletion docs/build/api/contracts/sdk/_category_.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"label": "Contracts SDK",
"label": "SDK",
"position": 5,
"key": "contracts-sdk",
"link": {
"type": "generated-index"
},
Expand Down
7 changes: 6 additions & 1 deletion docs/build/api/contracts/sdk/api-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,12 @@ type ContractAddresses = {
appRegistry: `0x${string}`;
governor: `0x${string}`;
timelock: `0x${string}`;
treasury: `0x${string}`;
treasuryFounder: `0x${string}`;
treasuryCommunity: `0x${string}`;
treasuryTokenSale: `0x${string}`;
treasuryFoundation: `0x${string}`;
treasuryNetwork: `0x${string}`;
treasuryLiquidity: `0x${string}`;
faucet?: `0x${string}`; // testnet only
};
```
Expand Down
41 changes: 36 additions & 5 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading