Specify standard SSSOM hashing algorithm - #534
Merged
Merged
Conversation
This commit adds a new section to the normative part of the website, intended for specifying stuff that are not part of the SSSOM data model nor of any of the SSSOM serialisation formats, but that should still be formally specified so that they can be implemented in the expected way by the various implementations. The existing page about "chaining rules" is moved to that new section, as it does not really belong to the "data model". A new page is added to the new section to define a standard SSSOM hashing function. closes #436
Provide examples in SSSOM/TSV rather than JSON format. Add an example of a mapping record making use of extension slots. Show for each example the canonical S-expression in addition to the final hash value.
Add a table explaining how to turn the value of an extension slot into a string, based on the declared type of the extension.
Run the following command:
npx --yes prettier --check --prose-wrap always --tab-width 4 \
--write src/docs/spec-support-hashing.md
Note the `--tab-width 4`! Without it, that piece of crap that is npx
prettier would completely mangle the nested lists.
This mostly turns my comment (#529 (comment)) into a guidance page. Not convinced this is really useful, but that's what has been asked in review.
Change the specification of the proposed SSSOM hashing procedure so that it uses the FNV64 hash function (RFC 9923) instead of SHA2-256. We should not need the cryptographic properties of SHA2-256, and FNV64 yields smaller, more easily handled hash values which can then be encoded in simple hexadecimal.
gouttegd
force-pushed
the
add-hashing-function-fnv64
branch
from
April 14, 2026 08:52
463a518 to
2a8a8fc
Compare
cthoyt
previously approved these changes
Apr 14, 2026
4 tasks
matentzn
previously approved these changes
Apr 14, 2026
matentzn
left a comment
matentzn
left a comment
Collaborator
There was a problem hiding this comment.
This is incredibly thorough. And the discussion was a masterpiece of Open Data coordination. THANKS!
Member
|
confirming the FNV64 variant works in the sssom-pydantic implementation c.f. cthoyt/sssom-pydantic@5a2863c |
gouttegd
commented
Apr 14, 2026
gouttegd
commented
Apr 14, 2026
gouttegd
force-pushed
the
add-hashing-function-fnv64
branch
from
April 14, 2026 12:35
8590a8c to
ebe5cb5
Compare
cthoyt
reviewed
Apr 14, 2026
cthoyt
reviewed
Apr 14, 2026
Co-authored-by: Charles Tapley Hoyt <cthoyt@gmail.com>
cthoyt
changed the title
cthoyt
changed the title
cthoyt
approved these changes
Apr 14, 2026
cthoyt
changed the title
matentzn
approved these changes
Apr 14, 2026
Member
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
(This is an alternative to #529. The core proposition is the same, but the hashing procedure uses the FNV64 condensation function and hexadecimal encoding, rather than SHA2-256 and ZBase32 – as tentatively proposed in this comment.)
Resolves [#436]
docs/have been added/updated if necessarymake testhas been run locallytests have been added/updated (if applicable)This PR adds a new section to the normative part of the website, intended for specifying stuff that are not part of the SSSOM data model nor of any of the SSSOM serialisation formats, but that should still be formally specified so that they can be implemented in the expected way by the various implementations.
The existing page about "chaining rules" is moved to that new section, as it does not really belong to the "data model".
Finally, the core of the PR is that a new page is added to the new section to define a standard SSSOM hashing function.
closes #436