docs(cip-19): add missing shwap IDs along with the containers
Added missing shwap types:
- IDs - NamespaceDataID, RangeNamespaceDataID
- Containers - NamespaceData, RangeNamespaceData
Summary of Changes
Hello @vgonkivs, I'm Gemini Code Assist[^1]! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request significantly enhances the Shwap Protocol (CIP-19) documentation by integrating new identifiers and data container structures. These additions provide a more precise and comprehensive framework for how namespace-specific data and share ranges are identified and managed within the protocol, thereby improving the clarity and functionality of data handling in the Celestia ecosystem.
Highlights
- New Shwap IDs Introduced: The CIP-19 document now includes formal definitions for
NamespaceDataIDandRangeNamespaceDataID, which are crucial for identifying specific data containers and continuous ranges of shares within the Shwap protocol. - New Shwap Containers Defined: Definitions for
NamespaceData ContainerandRangeNamespaceData Containerhave been added, detailing the protobuf structures used to encapsulate namespace-specific data and ranges of shares, respectively. - RowShares Structure Added: A new
RowSharesprotobuf definition has been introduced, providing a clear structure for representing an array of shares within a single row of the data square. - Documentation and Table Updates: The CIP-19 document's header now includes an
updateddate, and the 'Share Identifiers and Bitswap' table has been expanded to include the newly definedNamespaceDataIDandRangeNamespaceDataIDwith their corresponding Multihash and Codec values.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in pull request comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with :thumbsup: and :thumbsdown: on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
[^1]: Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.
once resolved, we can merge 🫡
@jcstein can we merged it?
yep. do we need to make this final @vgonkivs @Wondertan ?
we can also follow up with a Last Call -> Final PR
There are likely to be further updates and ideally all of them should be there own CIPs. Change directly to this one is rather an exception