@sismo-core/sismo-connect-client NPM

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 Client is a frontend package that allows to easily request data from the Sismo Data Vault app.

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

You can learn more on Sismo Connect here.

Prerequisites

Node.js >= 18.15.0 (Latest LTS version)

Usage

Installation

Install Sismo Connect Client package in your frontend with npm or yarn:

# with npm
npm install @sismo-core/sismo-connect-client
# with yarn
yarn add @sismo-core/sismo-connect-client

Import

Import the package in your frontend:

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

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

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

See the full documentation here.