doc: usage docs for the tokenomics smart contracts #3082
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the documentation for the tokenomics smart contracts by outlining the delegation and staking processes and expanding the technical reference material.
- Added a detailed "Smart contract usage" section in the smart-contracts.md file explaining delegation and staking transactions.
- Introduced a note and glossary section in the network-incentives.md file to provide high-level context on internal token flows and terminology.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/docs/streamr-network/smart-contracts.md | Added detailed usage instructions for tokenomics transactions including delegation and staking. |
| docs/docs/streamr-network/incentives/network-incentives.md | Inserted a clarifying note and a glossary for internal mechanics and token flow terms. |
| @@ -54,6 +54,8 @@ After this, the operator will continue to operate the nodes and earn. When they | |||
|
|
|||
| ## Technical description | |||
|
|
|||
| NOTE: Everything here is "good to know", but this isn't a developer guide. This is a description of the internal mechanics and token flows inside the contracts, on a relatively high level. Please refer to [the smart contracts document](../smart-contracts.md) for how to interact with the contracts. | |||
There was a problem hiding this comment.
This file is about Network tokenomics and is under incentives category in the document. We could move this section to a separate file (e.g. to be a section in that smart-contracts.md) as this is not about tokenomics/incentives.
There was a problem hiding this comment.
I tried moving this whole section to another file, I don't think it reads better. Can you make another PR to show what you mean?
There was a problem hiding this comment.
Why it would be better here than there? As you describe in the text, this section is "a description of the internal mechanics and token flows inside the contracts, on a relatively high level". So it is not about network incentives, but about smart contracts internals.
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
github-actions
bot
added
ci
delegator "default" (data=0x) is that sender gets the delegation. This is what we would normally want as well.
Co-authored-by: Teo Gebhard <teo@streamr.com>
jtakalai
force-pushed
the
eth-853-smart-contract-dev-docs
branch
from
447338d to
4099fe3
Compare
github-actions
bot
removed
ci
Summary
Document what tokenomics smart contracts functions should be called to accomplish basic tasks related to the happy path flows: delegation and staking process.
Changes
add new smart contracts md file, as well as linked to it
Limitations and future improvements
Checklist before requesting a review
TODOcomments left behind are meant to be left in.