add OpenTimestamps file parser

[fiatjaf]

https://opentimestamps.org/ (there is no spec or docs about the file format in this website, only libraries).

This is my first time contributing and I don't know if I did this right. I did read the developer guide.

One thing I wanted to know is how to make .ots files be detected automatically. They have this clear extension in their filenames and also an obvious sequence "magic bytes" at their beginning, so it should be pretty easy to detect without having to parse them entirely.

[wader]

https://opentimestamps.org/ (there is no spec or docs about the file format in this website, only libraries).

Your welcome to add URLs to code etc you used as reference to the top of ots.go or to a ots.md file, also you might want a ots.md file in any case, example file https://github.com/wader/fq/blob/master/format/bson/bson.md and see bson.go about embedding it to have cli help also.

And you can use make doc to regenerate part of the documentation to include your format.

This is my first time contributing and I don't know if I did this right. I did read the developer guide.

🥳 hope it gave some good tips at least

One thing I wanted to know is how to make .ots files be detected automatically. They have this clear extension in their filenames and also an obvious sequence "magic bytes" at their beginning, so it should be pretty easy to detect without having to parse them entirely.

I add a code comment about how automatic detection works. It's is currently solely done on content, maybe in the future a decoder will get access to the filename somehow

BTW the CI error seems to be that a common format test i failing, can updated using WRITE_ACTUAL=1 go test -run TestFormats/all/all.fqtest ./format

[fiatjaf]

I think I got it all now.

I don't know what to put on an ots.md file. Where do these CLI docs show up?

I don't have a use case for filtering through these files actually, my initial reason for implementing this was to be able to "see" the entire file in one go, not so much to dig into its sections and so on.

[wader]

I think I got it all now.

👍

I don't know what to put on an ots.md file. Where do these CLI docs show up?

You can put a author section, links to references, examples and such, but it's optional.

You can show format help with fq -h <format_name> or in the REPL help(<format_name>). It will also be used for doc/formats.md by make doc.

I don't have a use case for filtering through these files actually, my initial reason for implementing this was to be able to "see" the entire file in one go, not so much to dig into its sections and so on.

Ok! but i think it's good to sym map numbers etc to human friendly things, not only for queries but also for when turning it into JSON.

[wader]

Overall it looks good now i think, had just one comment and maybe if you want some documentation. Otherwise i'm ready to merge

[wader]

Ready to merge?

[fiatjaf]

Should be ready now. Added the doc file with some simple examples.

[wader]

Do one last make doc to add the docs to formats.md

[wader]

Thanks!

[fiatjaf]

Thank you very much for merging and for your patience!

[wader]

No worries! also reminded me that i should look into minimizing number files needed to change to add a format