Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

dms3 draft codec request #366

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Conversation

yozgatsi
Copy link

please consider this request to register a public codec for an early stage project. \thank you

@rvagg
Copy link
Member

rvagg commented Dec 16, 2024

Would you be able to provide a little bit more information for the description field? And are you expecting to be needing a lot more entries around this or can I suggest you move it down among the other numbers just to avoid stretching the far end of the spectrum unnecessarily. Or is there something about this number that is a nice fit for your project?

@yozgatsi
Copy link
Author

DMS3 = Decentralized Multi-State-Space Search (IR) platform on a p2p network. Nodes will leverage the technology, but form a separate network from that of IPFS/Libp2p. I am fine fine to move the number to compact the codec space. I don't expect to need a large block of numbers, and it's difficult to anticipate all my needs at this time. If you allowed block reservations, an order of 10 may be appropriate.

table.csv Outdated
@@ -585,3 +585,4 @@ es384-msig, multisig, 0xd01309, draft, ECDS
es521-msig, multisig, 0xd0130a, draft, ECDSA P-521 Signature as Multisig
rs256-msig, multisig, 0xd0130b, draft, RS256 Signature as Multisig
scion, multiaddr, 0xd02000, draft, SCION Internet architecture
dms3, multiaddr, 0xd03000, draft, dms3
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
dms3, multiaddr, 0xd03000, draft, dms3
dms3, multiaddr, 0xd03000, draft, Decentralized Multi-State-Space Search

@rvagg
Copy link
Member

rvagg commented Dec 30, 2024

There's a ton of space above 0x100000, whole blocks of the first digit in those are missing, there's no good reason to jump to d, you could even just take 0x100000 if you want. I'd just prefer we not stretch the space out further if there's not a good reason to. If it spelled something or the number had some relevance for you then that'd be enough, otherwise, just choose a lower number and you're good. If you pick a number with some space after it then you're welcome to come back later and allocate more. Particularly in this end of the number space, people are reluctant to bump right up against another un-related entry so you should be fine if you choose a block in that end of the table.

@yozgatsi
Copy link
Author

Hi Rod, thank you for the suggestion, works for me. Please let me know if you can apply the following changes. \Tavit

dms3, multiaddr, 0x100000, draft, Decentralized Multi-State-Space Search
dms3-key, ipld, 0x100001, draft, DMS3 Public Key

@rvagg
Copy link
Member

rvagg commented Jan 6, 2025

@yozgatsi please update this branch with the changes or, if you have trouble doing that feel free to close this and open a new pull request with it.

@yozgatsi
Copy link
Author

yozgatsi commented Jan 6, 2025

seem I got it right on the second try to modify the PR...

@@ -557,6 +557,8 @@ eip-191, varsig, 0xd191, draft, EIP-
jwk_jcs-pub, key, 0xeb51, draft, JSON object containing only the required members of a JWK (RFC 7518 and RFC 7517) representing the public key. Serialisation based on JCS (RFC 8785)
fil-commitment-unsealed, filecoin, 0xf101, permanent, Filecoin piece or sector data commitment merkle node/root (CommP & CommD)
fil-commitment-sealed, filecoin, 0xf102, permanent, Filecoin sector data commitment merkle node/root - sealed and replicated (CommR)
dms3, multiaddr, 0x100000, draft, Decentralized Multi-State-Space Search
dms3-key, ipld, 0x100001, draft, DMS3 Public Key
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
dms3-key, ipld, 0x100001, draft, DMS3 Public Key
dms3-key, key, 0x100001, draft, Decentralized Multi-State-Space Search Public Key

unfortunately you can't use ipld if this isn't a codec that can decode bytes into something that can contain links; if it's a codec that doesn't involve links then it's a serialization, but given you're saying it's a public key then I suspect it's not even that.

I'd suggest it's probably just a key, but you also may want to consider the name dms3-pub to match the other public key types. But this also raises the question: is this actually a key type? Can you just use one (or more) of the existing key types for this?

@yozgatsi
Copy link
Author

yozgatsi commented Jan 7, 2025

It is an alternative to, and modeled according to the entry:
libp2p-key, ipld, 0x72, permanent, Libp2p Public Key
If you believe this is problematic or needs more definition, then I can remove that entry now and keep only the multiaddr entry. we can revisit the former at a later time. Please advise, and thanks again for your help.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants