assafvayner's picture
assafvayner HF Staff
Update README.md
b869b82 verified
metadata
license: apache-2.0
pretty_name: Xet Protocol Reference Files

The files in this repository are intended to provide a reference to content processed using the xet protocol, relative to the original file: Electric_Vehicle_Population_Data_20250917.csv

The original file was exported from https://data.wa.gov/Transportation/Electric-Vehicle-Population-Data/f6w7-q2d2/about_data on September 16, 2025.

The contents are as described:

  • Electric_Vehicle_Population_Data_20250917.csv - the original file

  • Electric_Vehicle_Population_Data_20250917.csv.chunks - a list of the chunk hashes and lengths in order when processing the file using the chunking algorithm
    • The chunk lengths can be used to verify that a chunker implementation is producing correct chunk boundaries.
    • The hashes can be used to verify that an hasher implementation is computing hashes correctly given the listed chunk lengths.
  • Electric_Vehicle_Population_Data_20250917.csv.xet-file-hash - contains the result file hash in string format (118a53328412787fee04011dcf82fdc4acf3a4a1eddec341c910d30a306aaf97).

  • Electric_Vehicle_Population_Data_20250917.csv.xet-xorb-hash - contains the xorb hash eea25d6ee393ccae385820daed127b96ef0ea034dfb7cf6da3a950ce334b7632 that is the xorb that contains all the chunks that make up the file Electric_Vehicle_Population_Data_20250917.csv
  • eea25d6ee393ccae385820daed127b96ef0ea034dfb7cf6da3a950ce334b7632.xorb - contains the serialized contents of the xorb with hash eea25d6ee393ccae385820daed127b96ef0ea034dfb7cf6da3a950ce334b7632 that contains all of the chunks for the file Electric_Vehicle_Population_Data_20250917.csv
  • eea25d6ee393ccae385820daed127b96ef0ea034dfb7cf6da3a950ce334b7632.xorb.chunks - a list of the chunk hashes and lengths in xorb eea25d6ee393ccae385820daed127b96ef0ea034dfb7cf6da3a950ce334b7632.
    • The chunks in this file are the same chunks in the same order as listed in Electric_Vehicle_Population_Data_20250917.csv.chunks
  • eea25d6ee393ccae385820daed127b96ef0ea034dfb7cf6da3a950ce334b7632.xorb.range-hash - contains the range verification hash computed for all the chunks in xorb eea25d6ee393ccae385820daed127b96ef0ea034dfb7cf6da3a950ce334b7632 (its chunks are listed in the file eea25d6ee393ccae385820daed127b96ef0ea034dfb7cf6da3a950ce334b7632.xorb.chunks)

  • b10aa1dc71c61661de92280c41a188aabc47981739b785724a099945d8dc5ce4.chunk - the first chunk data out of Electric_Vehicle_Population_Data_20250917.csv.chunks; the chunk hash in string format for this chunk is b10aa1dc71c61661de92280c41a188aabc47981739b785724a099945d8dc5ce4
  • 26255591fa803b6baf25d88c315b8a6f5153d5bcfdf18ec5ef526264e0ccc907.chunk - the first chunk data out of Electric_Vehicle_Population_Data_20250917.csv.chunks; the chunk hash in string format for this chunk is 26255591fa803b6baf25d88c315b8a6f5153d5bcfdf18ec5ef526264e0ccc907
  • 099cb228194fe640e36a6c7d274ee5ed3a714ccd557a0951d9b6b43a7292b5d1.chunk - the first chunk data out of Electric_Vehicle_Population_Data_20250917.csv.chunks; the chunk hash in string format for this chunk is 099cb228194fe640e36a6c7d274ee5ed3a714ccd557a0951d9b6b43a7292b5d1

  • Electric_Vehicle_Population_Data_20250917.csv.shard - a serialized shard file containing the reconstruction of Electric_Vehicle_Population_Data_20250917.csv in its File Info section and listing xorb eea25d6ee393ccae385820daed127b96ef0ea034dfb7cf6da3a950ce334b7632 in its CAS Info Section.
    • Note that in this shard the range verification hashes are not included.
    • This version of the shard should not be used with API, it serves as a base only.
  • Electric_Vehicle_Population_Data_20250917.csv.shard.verification - This shard contains the file reconstruction information for the file Electric_Vehicle_Population_Data_20250917.csv with file hash 118a53328412787fee04011dcf82fdc4acf3a4a1eddec341c910d30a306aaf97 and the metadata for xorb eea25d6ee393ccae385820daed127b96ef0ea034dfb7cf6da3a950ce334b7632 in its CAS Info Section.
    • This shard does contain the range verification hashes matching each segment.
    • To make this shard uploadable, the footer should be truncated.
  • Electric_Vehicle_Population_Data_20250917.csv.shard.verification-no-footer - Electric_Vehicle_Population_Data_20250917.csv.shard.verification with the footer truncated.
    • This file cannot be viewed in the shard viewer app (the app requires parsing the footer).
    • This is the version of the shard that should be used when uploading the shard to register the file upload, it includes the verification segments, but no footer.
  • Electric_Vehicle_Population_Data_20250917.csv.shard.dedupe - a serialized shard file containing the xorb eea25d6ee393ccae385820daed127b96ef0ea034dfb7cf6da3a950ce334b7632 as if it were a response to a global dedupe query for a chunk in it. - There is no file info contents in this shard - All the chunk hashes listed in the CAS info section were HMAC'd with the HMAC key specified in the shard footer (hash in string form: "1234567812345678123456781234567812345678123456781234567812345678")

    All but the footer-less shard file can be displayed in the Xet Object Viewer app