@blyss/sdk
TypeScript icon, indicating that this package has built-in type declarations

0.2.1 • Public • Published

blyss

Open-source SDK for accessing data privately using homomorphic encryption.

Docs   |   Website   |   Contact

The Blyss SDK is released under the MIT license. Blyss SDK on NPM
Chat on Signal Blyss Twitter Blyss GitHub stars

The Blyss SDK lets you use homomorphic encryption to retrieve information privately. With it, you can build new kinds of privacy-preserving services, like private password breach checking, private nameserver resolution, and even private Wikipedia.

You can get an API key by signing up, or run a server locally. Detailed documentation is at docs.blyss.dev.

Warning The SDK has not yet been security reviewed, and the public Blyss service is still in beta. Contact us for access to a production-ready service.

Quick start (cloud)

You can quickly try using the SDK with our managed service without downloading anything.

  1. Get an API key by signing up here.
  2. Open this StackBlitz and enter your API key where it says <YOUR API KEY HERE>.
  3. Try adding users to the service using the "Add a user" button. As you add more users, the service will privately intersect each new users's contacts and the already existing users. Every user's list of contacts stays completely private using homomorphic encryption: it never leaves their device unencrypted.

We also have a simpler example using vanilla JS.

Quick start (local)

You can also use the Blyss SDK completely locally.

  1. Clone this repo with git clone git@github.com:blyssprivacy/sdk.git.
  2. Run the server by entering lib/server and running cargo run --release. The server will run on localhost:8008 by default.
  3. Run the client by entering examples/node-local and running npx ts-node main.ts. This will perform some writes and then a private read to your bucket.

Install

JavaScript / Node

To use the Blyss SDK in an existing TypeScript project, install it with npm install @blyss/sdk. Then, import the client with import { Client } from '@blyss/sdk';. If you're using SDK in Node, and prefer not to use ESM, you can instead import it as const blyss = require('@blyss/sdk/node').

Python

From PyPI:

pip install --upgrade blyss

From repo:

  1. cd python from repo root.
  2. pip install --upgrade .

Examples

The examples/ directory has several examples of how to use the Blyss SDK. Running the examples requires an API key.

Browser

The browser example shows how to quickly start using the Blyss SDK from vanilla JavaScript. The blyss-bundle.min.js build output is a single-file JS bundle that binds the library to window.blyss. Including this is a fast way to get started, especially if you prefer to use vanilla JS.

  1. Edit examples/browser-simple/main.js to use your API key.
  2. Run a local HTTP server (we suggest serve) in the repo root.
  3. Go to http://localhost:3000/examples/browser-simple/ in a browser.

React

The React example shows how to use the Blyss SDK in modern client-side JS. It also implements a more complicated application: private contact intersection.

  1. Enter examples/react-complex, and run npm install.
  2. Edit src/App.tsx to use your API key.
  3. Run npm run start.

Node

The Node.js example shows how to use the Blyss SDK in server-side JS. Node 18+ is required.

  1. Enter examples/node, and run npm install.
  2. Edit main.ts to use your API key.
  3. Run ts-node main.ts.

Python

  1. Install blyss.
  2. Enter examples/python.
  3. Run python main.py.

Documentation

All documentation is available at docs.blyss.dev. You can generate the docs by running npm start in docs/.

Contributing

Please feel free to open issues and pull requests! For bugs, try to provide as much context as possible. We are also always open to documentation contributions.

Building from source

JavaScript / Node

  1. Install Node with nvm, Rust with rustup, and wasm-pack.
  2. Run npm install.
  3. Run npm run build.

This will build the complete SDK, including the core Rust libraries in lib/spiral-rs and lib/doublepir

Python

Requires python 3.8+.

  1. Run pip install . in python.

Repository Map

The Blyss SDK is structured as:

  1. lib/,
    • lib/server/, a Rust project containing the open-source Blyss server.
    • lib/spiral-rs/, a Rust crate containing the core cryptographic implementation of the Spiral PIR scheme.
    • lib/doublepir/, a Rust crate containing the core cryptographic implementation of the DoublePIR scheme.
  2. js/, the TypeScript code that implements the user-facing Blyss SDK.
    • js/bridge/, a Rust "bridge" crate that exposes key functionality from spiral-rs and doublepir to the TypeScript code.
  3. python/, the Python version of the SDK.
    • python/src/lib.rs, another Rust "bridge" crate that exposes key functionality from spiral-rs to the Python code.

License

MIT (see LICENSE.md)

Package Sidebar

Install

npm i @blyss/sdk

Weekly Downloads

25

Version

0.2.1

License

MIT

Unpacked Size

3.56 MB

Total Files

54

Last publish

Collaborators

  • samirmenon