Unirep
  • 👏Welcome
  • 🧩Introduction
  • 🎮Getting Started
    • Install & build 🛠
    • Start with cli commands 🔌
      • 0. Install and build
      • 1. Spin up the testing chain
      • 2. Deploy Unirep contract
      • 3. User generates semaphore identity
      • 4. User signs up
      • 5. Attester signs up
      • 6. User generates epoch key and epoch key proof
      • 7. Attesters/Users verify epoch key proof
      • 8. Submit epoch key proof to Unirep smart contract
      • 9. Attester attest to epoch key
      • 10. Epoch transition
      • 11. User state transition
      • 12. User generates reputation proof
      • 13. Attesters/ Users verify the reputation proof
      • 14. User generates sign up proof
      • 15. Attesters/ Users verify the sign up proof
    • Start with Typescript 📠
      • 0. Install packages
      • 1. deploy
      • 2. User signs up
      • 3. Attester signs up
      • 4. Epoch key proof
      • 5. Attest
      • 6. Epoch transition
      • 7. User state transition
      • 8. Reputation proof
    • Computation happens off-chain â„šī¸
  • â˜€ī¸Protocol
    • Glossary
      • Users and Attesters
      • Epoch
      • Epoch Key
      • Reputation
      • Trees
      • Nullifiers
      • Epoch Transition
      • User State Transition
    • Circuits
      • Epoch Key Proof
      • Reputation Proof
      • User Sign Up Proof
      • User State Transition Proof
    • Contract
      • Sign up
      • Attestations
      • Epoch transition
      • User state transition
      • Verify proofs
  • 🌈Package usage
    • @unirep/crypto
    • @unirep/circuits
    • @unirep/contracts
    • @unirep/core
    • @unirep/subgraph
    • cli
      • Deploy Unirep Contract
      • User Identity
      • User Sign Up
      • Epoch Key And Proof
      • Attestation
      • Epoch transition
      • User state transition
      • Reputation Proof
      • Airdrop Reputation
      • Spend Reputation
  • đŸŒģApplications
    • Unirep Social
Powered by GitBook
On this page
  • userSignup
  • Options
  • attesterSignUp
  • Options

Was this helpful?

Edit on GitHub
  1. Package usage
  2. cli

User Sign Up

User and attester sign up

  • There are two different actors in Unirep: user and attester

  • A user with a semaphore identity can generate an epoch key without revealing the semaphore identity and identity commitment

  • An attester is associated with his Ethereum account or a smart contract. When an attester sign up, the attester has a unique attester id, and whenever the attester submit attestations, other users will know the attestation comes from which attester id.

userSignup

npx ts-node cli/index.ts userSignUp 
                  [-h] 
                  [-e ETH_PROVIDER] 
                  -c IDENTITY_COMMITMENT 
                  -x CONTRACT 
                  -d ETH_PRIVKEY

Options

  -e ETH_PROVIDER, --eth-provider ETH_PROVIDER
                        A connection string to an Ethereum provider. Default: http://localhost:8545
  -c IDENTITY_COMMITMENT, --identity-commitment IDENTITY_COMMITMENT
                        The user's identity commitment (in hex representation)
  -x CONTRACT, --contract CONTRACT
                        The Unirep contract address
  -d ETH_PRIVKEY, --eth-privkey ETH_PRIVKEY
                        The user's Ethereum private key

Options inherited from parent commands

  -h, --help            Show this help message and exit.

attesterSignUp

npx ts-node cli/index.ts attesterSignUp 
                  [-h] 
                  [-e ETH_PROVIDER] 
                  -x CONTRACT 
                  -d ETH_PRIVKEY
  • When an attester signs up, the Unirep smart contract will record the address of the attester and assign an attester id to the attester.

  • The attester id will start indexing from 1.

Options

  -e ETH_PROVIDER, --eth-provider ETH_PROVIDER
                        A connection string to an Ethereum provider. Default: http://localhost:8545
  -x CONTRACT, --contract CONTRACT
                        The Unirep contract address
  -d ETH_PRIVKEY, --eth-privkey ETH_PRIVKEY
                        The attester's Ethereum private keyhin

Options inherited from parent commands

  -h, --help            Show this help message and exit.
PreviousUser IdentityNextEpoch Key And Proof

Last updated 2 years ago

Was this helpful?

source:

source:

🌈
core/cli/userSignUp.ts
core/cli/attesterSignUp.ts