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
  • generate-group
  • send-to-attester
  • api
  1. Data Groups
  2. Sismo Hub
  3. Sismo Hub Repository

Command Line Interface

PreviousData OperatorsNextAccounts Registry Tree

Last updated 1 year ago

The command line interface (CLI) is made of three commands.

generate-group

The generate-group command is used to store a specific group of users in a JSON format in an off-chain database. You have to choose a valid to run this command.

# generate a group with the 'ens-voters' Group Generator
yarn generate-group ens-voters

The mandatory argument is a valid generator-name, i.e a valid .

You then have the following options:

--timestamp : Pass a custom timestamp for your group generation

--block-number : Use a custom block number for your group generation

--additional-data: Add additional addresses and data in the generated group. Multiple addresses must be separated by a coma while addresses and data are separated by an equality sign.

yarn generate-group ens-voters --additional-data 0x2a3..ab4=2,0x1e5..th0=4

send-to-attester

The send-to-attester command aims at sending generated groups on-chain. This command updates the on-chain by sending a new root.

# send groups on-chain for the 'hydra-s1-local' attester deployed on the 'local' chain
yarn send-to-attester hydra-s1-local local --send-on-chain

# send groups on-chain for the 'hydra-s1' attester deployed on the 'polygon' chain
yarn send-to-attester hydra-s1 polygon --send-on-chain

The two mandatory arguments for this command are:

attester-name: the name of your attester

network: the network where you attester is deployed

The following option is necessary to send the new registry root on-chain:

--send-on-chain: send available groups on-chain

api

yarn api:watch

  • All the available data on the different chains, sorted by attesters

  • All the created badges on the different chains

  • The metadata of a specific badge

  • A list of all the flows

  • A list of all generated groups

  • The latest groups generated

  • The different group generators used

This command allows you to launch a local api at this url: This swagger api can give information about:

Group Generator
Group Generator
registry tree
http://127.0.0.1:8000/static/rapidoc/index.html