@sismo-core/sismo-connect-server

Sismo Connect Server

Made by Sismo

Sismo Connect is single sign-on method for applications enabling aggregated data requests to users thanks to privacy. Once integrated, applications can request private, granular data from users, while users can authenticate and selectively reveal their data thanks to zero-knowledge proofs (ZKPs).

The Sismo Connect Server is a backend package built on top of the Hydra-S2 Verifier to easily verify proofs from your users off-chain.

Here is the link to the full documentation of the package: Sismo Connect Server package.

You can learn more on Sismo Connect here.

Prerequisites

• Node.js >= 18.15.0 (Latest LTS version)

Usage

Installation

Install Sismo Connect server package in your backend with npm or yarn:

# with npm
npm i @sismo-core/sismo-connect-server
# with yarn
yarn add @sismo-core/sismo-connect-server

Import

Import the package in your backend:

import { SismoConnect, SismoConnectConfig } from "@sismo-core/sismo-connect-server";

const config: SismoConnectConfig = {
  // you will need to register an appId in the Sismo Factory
  appId: "0x8f347ca31790557391cec39b06f02dc2",
};

// create a new Sismo Connect instance with the server configuration
const sismoConnect = SismoConnect({ config });

See the full documentation here.

License

Distributed under the MIT License.

Contribute

Please, feel free to open issues, PRs or simply provide feedback!

Contact

Send us a message in Telegram or Discord