Sismo Docs
  • Welcome to Sismo
    • What is Sismo?
  • Build with Sismo Connect
    • Overview
    • Installation
    • Sismo Connect Cheatsheet
    • Tutorials
      • Get Your appId - Create a Sismo Connect App
      • Onchain Tutorial (1/2): Code Your Airdrop Contract With Privately-Aggregated Data
      • Onchain Tutorial (2/2): Deploy Your Airdrop Contract
    • Technical Documentation
      • Sismo Connect Configuration
      • Auths
      • Claims
      • Signature
      • Packages
        • Sismo Connect Client: Request
        • Sismo Connect React: Request
        • Sismo Connect Server: Verify Offchain
        • Sismo Connect Solidity Library: Verify Onchain
    • FAQ
  • Data Groups
    • Overview
    • Tutorials
      • Factory Guide: Create a Data Group in 5 Minutes
      • Sismo Hub Guide: Create Data Groups Programmatically
      • Sismo Hub Guide: Add a Data Provider to the Sismo Factory
    • Sismo Hub
      • Sismo Hub Repository
        • Group Generators
        • Data Providers
        • Data Operators
        • Command Line Interface
      • Accounts Registry Tree
  • Data Vault
    • Overview
    • Vault Identifiers
    • Proving Schemes
      • Hydra-S1
      • Hydra-S2
    • Commitment Mapper
  • Resources
    • Deployed Contract Addresses
    • Sismo API
      • API Links
      • Query From a Client
      • Group
        • Get groups
        • Get group snapshots
      • Common Parameters
      • Advanced Filtering
      • Transaction
  • Links
    • Sismo Landing Page
    • Sismo Factory
    • Sismo App Store
    • Sismo Builder Resources
    • GitHub
    • Discord
    • Twitter
    • Blog
Powered by GitBook
On this page
  • Sismo Connect Flow Walkthrough
  • Packages
  1. Build with Sismo Connect

Technical Documentation

PreviousOnchain Tutorial (2/2): Deploy Your Airdrop ContractNextSismo Connect Configuration

Last updated 1 year ago

Sismo Connect is a crypto-native single sign-on method (SSO) for applications—whether on web2 or web3. Integration is simple with just a few lines of code: import the front-end package or React button for data requests, and verify proofs using the Sismo Connect Solidity library in your smart contract OR server package in your back end. Once integrated, applications can request private and granular data, while users can authenticate and selectively disclose their personal data with the power of zero-knowledge proofs (ZKPs).

In order to use Sismo Connect, you will need to have an appId registered in the Sismo Factory. Here is a tutorial.

In the schema below, you can observe how Sismo Connect functions with both onchain and offchain applications:

Sismo Connect Flow Walkthrough

  1. The Sismo Connect app requests proofs from its users by integrating the Sismo Connect React button from @sismo-core/sismo-connect-react or using the @sismo-core/sismo-connect-clientpackage. Users are redirected to their Data Vault to generate proofs.

  2. After successful proof generation, users are redirected back to the Sismo Connect app with their generated proofs. The app's front end can either call a smart contract or its back end to verify the proofs.

  3. The proof is received by the smart contract OR the backend and verified.

  4. Certain logic is then executed if proofs are valid, successfully ending the Sismo Connect flow.

Learn how to integrate Sismo Connect via these tutorials or gain more in-depth knowledge of Sismo Connect by learning what is a Sismo Connect Configuration, an Auth, a Claim and a Signature.

Packages

Here are the different GitHub links to Sismo Connect packages. You can find their documentation here.

  • @sismo-core/sismo-connect-client: the front-end package to easily request ZKPs from users in a privacy-preserving manner.

  • @sismo-core/sismo-connect-react: the React front-end package to easily integrate the sismoConnectButton and sismo-connect-client in your React app.

  • @sismo-core/sismo-connect-server: the back-end package to easily verify ZKPs offchain.

  • @sismo-core/sismo-connect-solidity : the Solidity Library to easily verify ZKPs onchain.

Sismo Connect Flow