npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

ssb-bfe

v3.7.0

Published

Binary Field Encodings (BFE) for Secure Scuttlebutt (SSB)

Downloads

496

Readme

SSB BFE

Javascript implementation of the SSB binary field encodings spec.

The spec only has one type of nil, but JavaScript has two: null and undefined. ssb-bfe will treat these two values in a way that mirrors what JSON.stringify does:

  • BFE Encoding an object with a null field becomes an object with the nil marker
    • Similar to JSON.stringify({a: null}) === '{"a": null}'
  • BFE Encoding an array with a null element becomes an array with the nil marker
    • Similar to JSON.stringify([null]) === '[null]'
  • BFE Encoding an object with a undefined field will omit that field
    • Similar to JSON.stringify({a: undefined}) === '{}'
  • BFE Encoding an array with an undefined element becomes an array with the nil marker
    • Similar to JSON.stringify([undefined]) === '[null]'

API

encode(input)

Takes any JavaScript primitive and returns its encoded counterpart. Is applied recursively in case the input is an object or an array. All inputs are converted to TFD Buffers, except for objects, arrays, and numbers, which remain the same.

decode(input)

Takes an encoded value (such as the output from encode) and returns the decoded counterparts as JavaScript primitives.

decodeTypeFormat(input, typeName, formatName)

Takes an encoded value (such as the output from encode), a typeName and formatName and returns the decoded counterparts as JavaScript primitives. This is much faster than decode if you know the type.

bfeTypes

Returns the bfe.json object that can be used to look up information based on Type and Field. Example:

const { bfeTypes } = require('ssb-bfe')
const classic_key_size = bfeTypes[0][0].data_length

bfeNamedTypes

Returns the bfe.json object converted to a map where the keys are the type and format names. Example:

const { bfeNamedTypes } = require('ssb-bfe')
const FEED = bfeNamedTypes['feed']
const CLASSIC_FEED_TF = Buffer.from([FEED.code, FEED.formats['classic'].code])

toTF(typeName, formatName)

Sometimes when you're wanting to check what sort of buffer you're handling, you want to pivot on the type and format bytes.

const CLASSIC_MSG_TF = Buffer.from([1, 0])  // << Did I get the right codes?

if (buf.slice(0, 2).equals(CLASSIC_MSG_TF)) {
  // ...
}

because remembering those codes is tricky, it's safer to use this convenience method:

const CLASSIC_MSG_TF = bfe.toTF('msg', 'classic')

If you remembered the type or format name wrong, you'll instantly get an error!

Check whether a buffer is an encoded type

Given any input, these functions tell you whether the input is of the specified type (and format, if applicable). Example:

const bfe = require('ssb-bfe')

const x = bfe.encode('@6CAxOI3f+LUOVrbAl0IemqiS7ATpQvr9Mdw9LC4+Uv0=.ed25519')

bfe.isEncodedFeedClassic(x) // true

List of functions:

  • isEncodedFeed(input) => boolean
  • isEncodedFeedClassic(input) => boolean
  • isEncodedFeedGabbygroveV1(input) => boolean
  • isEncodedFeedBamboo(input) => boolean
  • isEncodedFeedBendybuttV1(input) => boolean
  • isEncodedFeedButtwooV1(input) => boolean
  • isEncodedMessage(input) => boolean
  • isEncodedMessageClassic(input) => boolean
  • isEncodedMessageGabbygroveV1(input) => boolean
  • isEncodedMessageCloaked(input) => boolean
  • isEncodedMessageBamboo(input) => boolean
  • isEncodedMessageBendybuttV1(input) => boolean
  • isEncodedMessageButtwooV1(input) => boolean
  • isEncodedBlob(input) => boolean
  • isEncodedBlobClassic(input) => boolean
  • isEncodedEncryptionKey(input) => boolean
  • isEncodedEncryptionKeyBox2DmDh(input) => boolean
  • isEncodedEncryptionKeyBox2PoboxDh(input) => boolean
  • isEncodedSignature(input) => boolean
  • isEncodedSignatureMsgEd25519(input) => boolean
  • isEncodedEncrypted(input) => boolean
  • isEncodedEncryptedBox1(input) => boolean
  • isEncodedEncryptedBox2(input) => boolean
  • isEncodedGeneric(input) => boolean
  • isEncodedGenericStringUTF8(input) => boolean
  • isEncodedGenericBoolean(input) => boolean
  • isEncodedGenericNil(input) => boolean
  • isEncodedGenericAnyBytes(input) => boolean
  • isEncodedIdentity(input) => boolean
  • isEncodedIdentityPoBox(input) => boolean