Skip to content

A go implementation of the bendy-butt format spec to support ssb metafeeds

License

Notifications You must be signed in to change notification settings

ssbc/go-metafeed

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

90 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

go-metafeeds

This Go module implements the bendy butt specification to encode and verify feed entries in that format and offers utility functions for creating and verifiying signed content entries as required by the meta feed spec.

This repository also offers JSON test vectors to assist in testing implementations in other languages.

Usage

See the Go Reference for an exhaustive list of all the APIs this package offers.

The metamngmt Package offers helper types and functions to create the necessary types to manage the subfeeds of a metafeed.

To get the complete picture, read internal/vectors/gen_good_test.go which creates the testvector-metafeed-managment.json and goes through all the steps of creating feed entries and signing subfeeds.

Generating Vectors

Test vector generation is facilitated through Go's testing system.

To regenerate the vectors (e.g. after having changed vector generation ./internal/vectors), run the go test command:

cd internal/vectors/
go test

(Alternatively: stand in the root of the repo and run go test ./internal/vectors/)

License

The code is licenses under MIT.

The test vectors are licensed under Creative Commons Attribution Share Alike 4.0.

REUSE status

About

A go implementation of the bendy-butt format spec to support ssb metafeeds

Resources

License

Code of conduct

Stars

Watchers

Forks

Languages