Skip to content

Commit a1fb886

Browse files
authored
Update contracts docs to v1.0.4 (#126)
<!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * Mainnet deployed addresses now available for NodeRegistry, AppRegistry, YellowGovernor, and TimelockController contracts with direct Etherscan links. * Updated SDK contract type structure with separate treasury-related fields for better organization. * **Documentation** * Updated contract and API reference documentation. * Reorganized SDK documentation structure. * **Chores** * Dependency version update. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
1 parent b696984 commit a1fb886

16 files changed

Lines changed: 61 additions & 23 deletions

File tree

docs/build/api/contracts/api-reference/app-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
# AppRegistry
9-
[Git Source](https://github.com/layer-3/yellow/blob/dcd9928fb0cdf7b35bc4cae06401284b2529d311/src/AppRegistry.sol)
9+
[Git Source](https://github.com/layer-3/yellow/blob/11ed85c3dabaaddeee431052032791a80eaf2a0e/src/AppRegistry.sol)
1010

1111
**Inherits:**
1212
[Locker](/src/Locker.sol/abstract.Locker.md), [ISlash](/src/interfaces/ISlash.sol/interface.ISlash.md), AccessControl

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/dcd9928fb0cdf7b35bc4cae06401284b2529d311/src/Faucet.sol)
9+
[Git Source](https://github.com/layer-3/yellow/blob/11ed85c3dabaaddeee431052032791a80eaf2a0e/src/Faucet.sol)
1010

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

docs/build/api/contracts/api-reference/interfaces/ilock.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
# ILock
9-
[Git Source](https://github.com/layer-3/yellow/blob/dcd9928fb0cdf7b35bc4cae06401284b2529d311/src/interfaces/ILock.sol)
9+
[Git Source](https://github.com/layer-3/yellow/blob/11ed85c3dabaaddeee431052032791a80eaf2a0e/src/interfaces/ILock.sol)
1010

1111
**Title:**
1212
ILock

docs/build/api/contracts/api-reference/interfaces/islash.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
# ISlash
9-
[Git Source](https://github.com/layer-3/yellow/blob/dcd9928fb0cdf7b35bc4cae06401284b2529d311/src/interfaces/ISlash.sol)
9+
[Git Source](https://github.com/layer-3/yellow/blob/11ed85c3dabaaddeee431052032791a80eaf2a0e/src/interfaces/ISlash.sol)
1010

1111
**Title:**
1212
ISlash

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/dcd9928fb0cdf7b35bc4cae06401284b2529d311/src/Locker.sol)
9+
[Git Source](https://github.com/layer-3/yellow/blob/11ed85c3dabaaddeee431052032791a80eaf2a0e/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/dcd9928fb0cdf7b35bc4cae06401284b2529d311/src/NodeRegistry.sol)
9+
[Git Source](https://github.com/layer-3/yellow/blob/11ed85c3dabaaddeee431052032791a80eaf2a0e/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/dcd9928fb0cdf7b35bc4cae06401284b2529d311/src/Treasury.sol)
9+
[Git Source](https://github.com/layer-3/yellow/blob/11ed85c3dabaaddeee431052032791a80eaf2a0e/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/dcd9928fb0cdf7b35bc4cae06401284b2529d311/src/Governor.sol)
9+
[Git Source](https://github.com/layer-3/yellow/blob/11ed85c3dabaaddeee431052032791a80eaf2a0e/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/dcd9928fb0cdf7b35bc4cae06401284b2529d311/src/Token.sol)
9+
[Git Source](https://github.com/layer-3/yellow/blob/11ed85c3dabaaddeee431052032791a80eaf2a0e/src/Token.sol)
1010

1111
**Inherits:**
1212
ERC20Permit

docs/build/api/contracts/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ displayed_sidebar: buildSidebar
1313
| Contract | Address |
1414
|---|---|
1515
| YellowToken | [`0x236eB848C95b231299B4AA9f56c73D6893462720`](https://etherscan.io/address/0x236eB848C95b231299B4AA9f56c73D6893462720) |
16-
| NodeRegistry | |
17-
| AppRegistry | |
18-
| YellowGovernor | |
19-
| TimelockController | |
16+
| NodeRegistry | [`0xB0C7aA4ca9ffF4A48B184d8425eb5B6Fa772d820`](https://etherscan.io/address/0xB0C7aA4ca9ffF4A48B184d8425eb5B6Fa772d820) |
17+
| AppRegistry | [`0x5A70029B843eE272A2392acE21DA392693eef1c6`](https://etherscan.io/address/0x5A70029B843eE272A2392acE21DA392693eef1c6) |
18+
| YellowGovernor | [`0x7Ce0AE21E11dFEDA2F6e4D8bF2749E4061119512`](https://etherscan.io/address/0x7Ce0AE21E11dFEDA2F6e4D8bF2749E4061119512) |
19+
| TimelockController | [`0x9530896F9622b925c37dF5Cfa271cc9deBB226b7`](https://etherscan.io/address/0x9530896F9622b925c37dF5Cfa271cc9deBB226b7) |
2020
| Treasury ||
2121
| Faucet ||
2222

0 commit comments

Comments
 (0)