ssbc / ssb-keys

keyfile operations for ssb
36 stars 26 forks source link

adding missing docs but needs more work. #53

Closed soapdog closed 5 years ago

soapdog commented 5 years ago

There are more exported functions in the module than the README shows. I've tried to add the missing documentation for them but couldn't because I don't know crypto/sodium stuff. The roadblock is that the missing methods are little wrappers around private-box which unfortunately is out of sync with NPM. The version of that module on GH doesn't contain the stuff called by ssb-keys. Digging deeper into node_modules, I can see that these private-box functions are just wrappers around libsodium functions which I couldn't find documentation for. Kinda need help filling these last two methods in the README (they are tagged with TODO:).

dominictarr commented 5 years ago

merging! thanks!