Cryptographic validation of Scuttlebutt messages in the form of Rust bindings for Node.js.
Note: messages are expected to be values and not KVT's (
key, value, timestamp). The key is returned for each successfully validated message.
The node-bindgen crate is currently used to generate the bindings from Rust code.
Rust first needs to be installed in order to build the bindings (installation instructions).
git clone email@example.com:ssb-ngi-pointer/ssb-validate2-rsjs-node.git cd ssb-validate2-rsjs-node cargo install nj-cli # generate release build of ssb-validate2-rsjs-node npm run build # run the tests npm run test
The build process creates bindings in
If you wish to rebuild the bindings after making changes to the code, use the
nj-cli build --release
Tests for single-author and multi-author messages are included. These tests are defined and executed using tape. Test data (SSB messages) are dynamically-generated using ssb-fixtures. The tests can be found in the
After performing build instructions (see above):
cd ssb-validate2-rsjs-node # Run benchmarks npm run perf
The default values for the performance benchmarks (
test/perf.js) are 100 messages from 1 author, for a total of 10 iterations. These value constants can be changed in
test/perf.js. Performance benchmarks for the multi-author method default to 100 messages from 5 authors, for a total of 10 iterations (
Releasing New Versions
To release a new version, all that you need to do is update the version number in
package.json and commit with a message that starts with the word "release", e.g.
release 1.1.0. Then, CI (GitHub Actions) will detect that, and compile this library for many variations of operating system and Node.js versions and then publish those as prebuilds to NPM. This repository has an environment variable
NPM_TOKEN set up so that GitHub Actions has publish permissions for this package.