Skip to content

Commit 080b252

Browse files
committed
docs(issuance): add contract documentation references to README
- Add Contracts section with links to detailed documentation - Reference IssuanceAllocator.md and RewardsEligibilityOracle.md - Include brief descriptions of each contract's purpose
1 parent 25cfb80 commit 080b252

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

packages/issuance/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@ This package contains smart contracts for The Graph's issuance functionality.
66

77
The issuance contracts handle token issuance mechanisms for The Graph protocol.
88

9+
### Contracts
10+
11+
- **[IssuanceAllocator](contracts/allocate/IssuanceAllocator.md)** - Central distribution hub for token issuance, allocating tokens to different protocol components based on configured proportions
12+
- **[RewardsEligibilityOracle](contracts/eligibility/RewardsEligibilityOracle.md)** - Oracle-based eligibility system for indexer rewards with time-based expiration
13+
- **DirectAllocation** - Simple target contract for receiving and distributing allocated tokens
14+
915
## Development
1016

1117
### Setup

0 commit comments

Comments
 (0)