new: node-0.18.0 release note#489
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
🚀 Preview Deployment✅ Deployment Ready 🔗 Preview URL: https://pr-489-midnight-docs.vercel.app 📝 Latest commit: This preview updates automatically when you push new commits to this PR. |
docs/relnotes/node/node-0-18-0.mdx
Outdated
|
|
||
| #### Federated Authority Observation | ||
|
|
||
| Introduces a federated approach to observing external blockchain data. The Federated Authority Observation pallet enables multiple authorities to observe and validate external chain data, ensuring decentralized verification of cross-chain events. |
There was a problem hiding this comment.
I'm not sure that's right. Maybe:
| Introduces a federated approach to observing external blockchain data. The Federated Authority Observation pallet enables multiple authorities to observe and validate external chain data, ensuring decentralized verification of cross-chain events. | |
| Introduces observability of the federation authorised to produce midnight blocks. |
There was a problem hiding this comment.
Thanks for the feedback. I've updated it based on your suggestions
gilescope
left a comment
There was a problem hiding this comment.
With a slight tweak looks good.
kmillikin
left a comment
There was a problem hiding this comment.
I read these as someone who doesn't know much about the node.
docs/relnotes/node/node-0-18-0.mdx
Outdated
|
|
||
| ### High-level summary | ||
|
|
||
| This release introduces the new tokenomics model with unshielded transactions and DUST-based fees. It comprehensively re-engineers the Midnight Generator into the Midnight Toolkit with expanded capabilities, and upgrades to Partner Chains v1.8.0. Breaking changes require chain reset and affect all Preview developers and stake pool operators. |
There was a problem hiding this comment.
I find markdown docs are easier to review if they have line breaks, because you can see what phrase a comment refers to. Because it's markdown, you can break anywhere you want. I tend to break at least every sentence, and sometimes more frequently (at clauses). It's not necessary to try to wrap text, though.
This release introduces the new tokenomics model with unshielded transactions and DUST-based fees.
This sounds like there are only unshielded transactions, which I don't think is true. I suggest structuring this around the difference due to this release. Maybe a bulleted list with () new unshielded transactions in addition to the previous shielded transactions and () DUST-based fees instead of (whatever it was before).
It comprehensively re-engineers the Midnight Generator into the Midnight Toolkit with expanded capabilities, and upgrades to Partner Chains v1.8.0.
I don't think a release can re-engineer anything, that's something that people do. This reads much better if it's something like "The Midnight Generator has been re-engineered into ...". I honestly don't know what is comprehensive about this, I'd stick to just the facts.
This sentence reads like Midnight Toolkit has two things: (1) expanded capabilities and (2) upgrades to Partner Chains v1.8.0. I think it's actually the Node that has been upgraded to Partner Chains v1.8.0. The second clause doesn't seem related to toolkit.
(I'm not sure that the audience of the release notes cares exactly about the "re-engineering" anyway. I think they care about (1) the name has changed and (2) it has new features.)
Breaking changes require chain reset and affect all Preview developers and stake pool operators.
This sounds like a statement about breaking changes in general, but I think it's intended to be about the specific breaking changes in this release. If so it's better to say "The breaking changes in this release require...".
I'm leery of "affect all Preview developers". I can imagine somebody might read through and conclude (correctly) that they are actually unaffected. I'd rather say "potentially affect all Preview developers" or some other way to avoid the absolute "all".
There was a problem hiding this comment.
Very detailed feedback. I've updated the release note to address the points you mentioned.
docs/relnotes/node/node-0-18-0.mdx
Outdated
| - Run a node on Preview | ||
| - Use the Midnight Generator (now Midnight Toolkit) | ||
| - Operate stake pools or maintain infrastructure | ||
| - Build DApps with shielded or unshielded transactions |
There was a problem hiding this comment.
DApp developers don't necessarily have to know about the node software at all. I believe that there are some other release notes that they will read to learn what they need to know (I don't think they will be in the habit of reading these.)
docs/relnotes/node/node-0-18-0.mdx
Outdated
| - Use the Midnight Generator (now Midnight Toolkit) | ||
| - Operate stake pools or maintain infrastructure | ||
| - Build DApps with shielded or unshielded transactions | ||
| - Work with NIGHT token or contract deployment |
There was a problem hiding this comment.
Surely this is "the NIGHT token" or "NIGHT tokens"?
I think developers can deploy contracts without knowing anything about the node software at all.
There was a problem hiding this comment.
Good catch. Updated!
docs/relnotes/node/node-0-18-0.mdx
Outdated
| ### Summary of updates | ||
|
|
||
| - Introduced unshielded transactions alongside existing shielded transactions | ||
| - Implemented new DUST fee mechanism generated from NIGHT token |
There was a problem hiding this comment.
"NIGHT tokens" or "the NIGHT token"?
docs/relnotes/node/node-0-18-0.mdx
Outdated
|
|
||
| - Introduced unshielded transactions alongside existing shielded transactions | ||
| - Implemented new DUST fee mechanism generated from NIGHT token | ||
| - Re-engineered Midnight Generator into comprehensive Midnight Toolkit |
There was a problem hiding this comment.
I'm still confused about comprehensive. Before it described the re-engineering, now it describes the Toolkit. I'd probably just avoid it because I can't figure out what function it is intended to serve here.
docs/relnotes/node/node-0-18-0.mdx
Outdated
|
|
||
| The Midnight Generator has been comprehensively re-engineered into the Midnight Toolkit, a powerful command-line tool for developers. With the new toolkit, you can also: | ||
|
|
||
| - Send Unshielded tokens |
There was a problem hiding this comment.
This list is not parallel. Some items are actions "send ...", "sync ...", "execute ..." and some are things "fee calculation", "support", "contract maintenance".
There was a problem hiding this comment.
Good catch. Thanks
There was a problem hiding this comment.
Also, all lists where at least one item is a complete sentence needs periods. Apply throughout.
|
|
||
| #### Midnight Toolkit | ||
|
|
||
| The Midnight Generator has been comprehensively re-engineered into the Midnight Toolkit, a powerful command-line tool for developers. With the new toolkit, you can also: |
There was a problem hiding this comment.
I feel like all these new features are the kind of thing that we should tell people how to do, either here or better by linking to the toolkit documentation (which we might have to write first). It's frustrating to read about all the new stuff without any idea how to achieve any of it.
There was a problem hiding this comment.
I think it'll be best suited as a separate doc we can link to. I'll make a note of it and share with the team.
There was a problem hiding this comment.
Agreed, @gyrationtechs. The release notes are just a list of changes. The actual instructions belong in linked documentation.
There was a problem hiding this comment.
Feel free to link to the toolkit's documentation: https://github.com/midnightntwrk/midnight-node/blob/main/util/toolkit/README.md
There was a problem hiding this comment.
That's a great idea. Thank you @gilescope
docs/relnotes/node/node-0-18-0.mdx
Outdated
|
|
||
| #### Federated Authority Observation | ||
|
|
||
| Introduces a federated approach to observing external blockchain data. The Federated Authority Observation pallet enables multiple authorities to observe and validate external chain data, ensuring decentralized verification of cross-chain events. |
There was a problem hiding this comment.
I don't have any idea what any of this means. What's an authority? What's external chain data? How do they validate it? Is verification different from validation? What are cross-chain events?
If we're asking people like DApp developers to read this, we have to tell them enough to know whether this is something that they care about or not.
There was a problem hiding this comment.
I updated this section to use a more straightforward explanation provided another reviewer.
|
|
||
| #### State forking for ephemeral environments | ||
|
|
||
| Enables snapshot and restore capabilities for node state. This allows developers to create ephemeral test environments that can be quickly spun up from specific chain states. |
There was a problem hiding this comment.
How? Can we give a short description or link to the documentation?
There was a problem hiding this comment.
I'm not entirely sure. But this is another candidate for a potential new doc we can link to. I'll make a note of this also and get clairfication from the team.
There was a problem hiding this comment.
This capability is only available to internal developers at the moment. Should we consider not publishing it yet?
There was a problem hiding this comment.
@justinfrevert Do you mean this specific feature or the entire new features mentioned in this release note?
|
|
||
| #### Midnight Toolkit | ||
|
|
||
| The Midnight Generator has been comprehensively re-engineered into the Midnight Toolkit, a powerful command-line tool for developers. With the new toolkit, you can also: |
There was a problem hiding this comment.
Agreed, @gyrationtechs. The release notes are just a list of changes. The actual instructions belong in linked documentation.
docs/relnotes/node/node-0-18-0.mdx
Outdated
|
|
||
| The Midnight Generator has been comprehensively re-engineered into the Midnight Toolkit, a powerful command-line tool for developers. With the new toolkit, you can also: | ||
|
|
||
| - Send Unshielded tokens |
There was a problem hiding this comment.
Also, all lists where at least one item is a complete sentence needs periods. Apply throughout.
docs/relnotes/node/node-0-18-0.mdx
Outdated
|
|
||
| Sessions reduced from 2 hours (1200 slots) to 30 minutes (300 slots). | ||
|
|
||
| **Required Updates:** |
There was a problem hiding this comment.
Colon should be outside of bold. Apply throughout.
docs/relnotes/node/node-0-18-0.mdx
Outdated
|
|
||
| #### NetworkId type change | ||
|
|
||
| **What changed:** `NetworkId` changed from `enum` to `String` type |
There was a problem hiding this comment.
Missing periods on lots of lines.
Co-authored-by: DianaHackmamba <diana@hackmamba.io> Signed-off-by: David Ozokoye <davidozokoye@gmail.com>
Co-authored-by: DianaHackmamba <diana@hackmamba.io> Signed-off-by: David Ozokoye <davidozokoye@gmail.com>
Release note for Midnight node v0.18.0. The doc uses the new release note template.