cip-19!: breaking Shwap protocol improvements #128
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Wondertan
force-pushed
the
cip-19-decouple-ids
branch
from
ea75462 to
6b22498
Compare
can you pull in latest changes from main @Wondertan? then we can edit it to Review
|
Wondertan
force-pushed
the
cip-19-decouple-ids
branch
from
6b22498 to
f277db4
Compare
|
@jcstein, rebased + changed to Review |
Wondertan
changed the title
Wondertan
changed the title
rootulp
approved these changes
Apr 17, 2024
jcstein
reviewed
Apr 17, 2024
Co-authored-by: Rootul P <[email protected]>
jcstein
approved these changes
Apr 17, 2024
|
Noooo |
|
I was just about to commit something |
|
OK, will do another PR |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Decouple IDs out of Containers
This is a protocol-breaking change for Shwap. Initially, containers kept the identifiers as a first field in them. However, we decided to decouple those.
The Bitswap protocol dictates the requirement to have IDs in containers and this enforces certain limitations and overhead for the core Shwap containers. However, we want to use the containers outside of the Bitswap composition context, and thus, we need to remove this requirement from the containers. Furthermore, we design Shwap in a protocol-agnostic way, and Bitswap enforcing limits on containers is inconsistent with that.
As Bitswap still requires coupling between data and identifiers, we introduce container adapters for the Bitswap composition to address that.
Rename
Datacontainer and IDWe rename
Data->RowNamespaceDataand increase verbosity to improve clarity around the meaning of the type. PrefixingRowandNamespacenarrows down the scope of the very generalData. Altogether,RowNamespaceDataspecifies that its data of a specific namespace in a specific row. This opens up space for future containers likeNamespaceDatawhich is data of a specific namespace, but over multiple rows.