Skip to content

Commit

Permalink
GITBOOK-486: Overall wording review
Browse files Browse the repository at this point in the history
  • Loading branch information
@f9s216 @gitbook-bot
f9s216 authored and gitbook-bot committed Jul 13, 2023
1 parent 4bb5337 commit 5f048c1
Show file tree
Hide file tree
Showing 41 changed files with 385 additions and 458 deletions.
53 changes: 26 additions & 27 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: Sovereign Identity Aggregator and Cryptonative SSO
description: Sovereign identity aggregator and crypto-native SSO
cover: .gitbook/assets/Gibook Banner1_1900x400.png
coverY: 0
layout:
Expand All @@ -22,48 +22,48 @@ layout:

Sismo leverages zero-knowledge proofs (ZKPs) and privacy-preserving technologies to **enable** **users to aggregate their identities and selectively disclose personal data** to applications. 

By using Sismo Connect, an easy-to-integrate SSO, applications **can now obtain personal data that was previously inaccessible, while respecting users' privacy.**
By using Sismo Connect, an easy-to-integrate single sign-on (SSO), applications **can now obtain personal data that was previously inaccessible, while respecting user privacy.**

[Sismo Connect](./#sismo-connect-the-crypto-native-sso) aims to replace non-sovereign SSOs such as Google Connect and improve limited SSOs such as Wallet Connect. 

<figure><img src=".gitbook/assets/Introduction (2).png" alt=""><figcaption><p>Sismo: Personal Data Aggregation and Selective Disclosure</p></figcaption></figure>

## Data Vault: Sovereign Identity Aggregator

Users aggregate their identity by adding Data Sources to their sovereign, local and private [Data Vault](how-sismo-works/core-components/what-is-the-data-vault.md).
Users aggregate their identity by adding Data Sources to their private, local and sovereign [Data Vault](how-sismo-works/core-components/what-is-the-data-vault.md).

The Data Vault currently supports the following types of Data Sources: Ethereum wallets, GitHub, Twitter or Telegram accounts. Users can generate ZK Proofs from their Data Sources, enabling them to reveal data to applications in a sovereign way.
The Data Vault currently supports the following types of Data Sources: Ethereum wallets, GitHub, Twitter or Telegram accounts. Users can generate ZK proofs from their Data Sources, enabling them to reveal data to applications in a sovereign way.

<figure><img src=".gitbook/assets/image.png" alt=""><figcaption><p>What a Data Vault looks like</p></figcaption></figure>

{% hint style="success" %}
You can create your own Data Vault and start aggregating your identity [here](https://vault-beta.sismo.io/).
{% endhint %}

## Sismo Connect: The Cryptonative SSO
## Sismo Connect: The Crypto-Native SSO

Sismo Connect is a cryptonative single sign-on method (SSO) for onchain and offchain apps. Sismo Connect makes it easy for developers to obtain users' personal data by requesting and verifying ZK proofs.
Sismo Connect is a crypto-native single sign-on (SSO) for onchain and offchain apps. Sismo Connect makes it easy for developers to access personal data without infringing on user privacy by requesting and verifying ZK proofs.

{% hint style="success" %}
Experience Sismo Connect on the [Demo App Store](https://demo.apps.sismo.io)!
{% endhint %}

<figure><img src=".gitbook/assets/Sismo Connect Flow (4).png" alt=""><figcaption></figcaption></figure>

Integration is simple with just a few lines of code: import the front-end package or React button to make Sismo Connect requests, and verify proofs in your backend/ smart contracts using Sismo’s Solidity or TypeScript package.
Integration is simple with just a few lines of code: import the front-end package or React button to make Sismo Connect requests, and verify proofs in your back end/smart contracts using Sismo’s Solidity or TypeScript package.

Applications can request many data at once. There exist two types request that can be made:
With Sismo Connect, applications can request data from multiple sources at once. There are two types of requests that can be made:

* authentication: ZK Proof of Data Source ownership. (Ethereum wallets, GitHub, Twitter or Telegram accounts)
* disclosure of anonymised personal data: ZK Proofs of Data Source inclusion in a specific Data Group (+ claim about its value in the group).&#x20;
* **Authentication**: ZK proof of Data Source ownership (e.g. Ethereum wallets, GitHub, Twitter or Telegram accounts).
* **Disclosure of anonymized personal data**: ZK proofs of Data Source inclusion in a specific Data Group (e.g. GR15 contributor).

{% hint style="info" %}
Data Groups are sets of Data Sources where each Data Source has an associated value.
Data Groups are sets of Data Sources in which each Data Source has an associated value.
{% endhint %}

<details>

<summary>Concrete examples Data Groups and ZK Proofs you can request from users</summary>
<summary>Concrete examples Data Groups and ZK proofs you can request from users</summary>

```json
{ // "Stand With Crypto" NFT Minters Data Group
Expand All @@ -81,12 +81,12 @@ Data Groups are sets of Data Sources where each Data Source has an associated va
}
```

* All owners of these wallets can create a ZK Proof that they are part of this group
* All owners of these wallets can generate a ZK proof attesting that they are part of this group

<!---->

* owner of `0x70ddb5abf21202602b57f4860ee1262a594a0086` can create a ZK Proof that they are part of the group with value > 10 (e.g minted more than 10 NFTs)
* owner of 0xa2bf1b0a7e079767b4701b5a1d9d5700eb42d1d1 can create a ZK Proof that they are part of the group with value = 21 (e.g minted exactly 2 NFT)
* The owner of `0x70ddb5abf21202602b57f4860ee1262a594a0086` can generate a ZK proof attesting that they are part of this group with a value > 10 (e.g, minted more than 10 NFTs)
* The owner of 0xa2bf1b0a7e079767b4701b5a1d9d5700eb42d1d1 can generate a ZK proof attesting that they are part of this group with a value = 2 (e.g, minted exactly 2 NFTs)



Expand All @@ -108,12 +108,12 @@ Data Groups are sets of Data Sources where each Data Source has an associated va
}
```

* All owners of these wallets can create a ZK Proof that they are part of this group
* All owners of these wallets can generate a ZK proof attesting that they are part of this group

<!---->

* owner of `dhadrien.eth` can create a ZK Proof that they are part of the group with value > 2 (e.g community member with level > 2)
* owner of @wojtekwtf on twitter can create a ZK Proof that they are part of the group with value = 3 (e.g community member with level 3)
* The owner of `dhadrien.eth` can generate a ZK proof attesting that they are part of the group with a value > 2 (e.g, community member with level > 2)
* The owner of @wojtekwtf on Twitter can generate a ZK proof attesting that they are part of the group with a value = 3 (e.g, community member with level 3)



Expand All @@ -123,26 +123,25 @@ Examples of Data Groups:

| Data Group Examples | Members (Data Sources) | Value for each Data Source |
| --------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | ---------------------------------------- |
| ["Stand With Crypto" NFT Minters](https://factory.sismo.io/groups-explorer?search=0xfae674b6cba3ff2f8ce2114defb200b1) | Wallets of minters | number of NFT minted |
| [Gitcoin Passport Holders](https://factory.sismo.io/groups-explorer?search=0x1cde61966decb8600dfd0749bd371f12) | Wallets of Gitcoin Passport holders | sybil-resistant score |
| [Sismo Hub Github Contributors ](https://factory.sismo.io/groups-explorer?search=0xda1c3726426d5639f4c6352c2c976b87) | Github accounts of contributors to sismo-core/sismo-hub repo | number of contributions |
| [ENS DAO Voters](https://factory.sismo.io/groups-explorer?search=0x85c7ee90829de70d0d51f52336ea4722) | Wallets of voters in ENS DAO | number of votes |
| [Sismo Community Members](https://factory.sismo.io/groups-explorer?search=0xd630aa769278cacde879c5c0fe5d203c) | Wallets, GitHub, Telegram and twitter accounts of all people that helped Sismo | level of their contributions (1, 2 or 3) |
| ["Stand With Crypto" NFT Minters](https://factory.sismo.io/groups-explorer?search=0xfae674b6cba3ff2f8ce2114defb200b1) | Wallets of minters | Number of NFT minted |
| [Gitcoin Passport Holders](https://factory.sismo.io/groups-explorer?search=0x1cde61966decb8600dfd0749bd371f12) | Wallets of Gitcoin Passport holders | Sybil-resistant score |
| [Sismo Hub GitHub Contributors ](https://factory.sismo.io/groups-explorer?search=0xda1c3726426d5639f4c6352c2c976b87) | GitHub accounts of contributors to sismo-core/sismo-hub repo | Number of contributions |
| [ENS DAO Voters](https://factory.sismo.io/groups-explorer?search=0x85c7ee90829de70d0d51f52336ea4722) | Wallets of voters in ENS DAO | Number of votes |
| [Sismo Community Members](https://factory.sismo.io/groups-explorer?search=0xd630aa769278cacde879c5c0fe5d203c) | Wallets, GitHub, Telegram and Twitter accounts of all people that helped Sismo | Level of their contributions (1, 2 or 3) |

{% hint style="info" %}
Anyone can [create a new Data Group](data-groups/data-groups-and-how-to-create-them/).&#x20;
Anyone can [create a new Data Group](data-groups/data-groups-and-creation/).&#x20;
{% endhint %}

<table data-view="cards"><thead><tr><th data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><a href="broken-reference">Broken link</a></td><td><a href=".gitbook/assets/Build with Sismo Connect.png">Build with Sismo Connect.png</a></td></tr><tr><td><a href="https://apps.sismo.io">https://apps.sismo.io</a></td><td><a href=".gitbook/assets/AppStore.png">AppStore.png</a></td></tr><tr><td><a href="https://case-studies.sismo.io">https://case-studies.sismo.io</a></td><td><a href=".gitbook/assets/Case Studies.png">Case Studies.png</a></td></tr></tbody></table>

## Case Study: Sybil-Resistant Airdrop from Privately Aggregated Data

SafeDrop is a Sybil-resistant and privacy-preserving ERC20 airdrop that distributes AIR tokens to users proportionally based on their reputation, aggregated from diverse sources of data (EVM wallets, Telegram, Twitter and GitHub accounts).
SafeDrop is a Sybil-resistant and privacy-preserving ERC20 airdrop that distributes $AIR tokens to users proportionally based on their reputation, aggregated from diverse sources of data (EVM wallets, Telegram, Twitter and GitHub accounts).

<figure><img src=".gitbook/assets/SafeDrop_Case Study (2).png" alt=""><figcaption></figcaption></figure>

By integrating Sismo Connect, SafeDrop users can generate a ZK proof to establish they own data in their accounts that make them eligible for the airdrop. \
No connection between these accounts and the airdrop destination address is ever made.
By integrating Sismo Connect, SafeDrop users can generate a ZK proof to establish ownership of the data that makes them eligible for the airdrop. No connection between these accounts and the airdrop destination address is ever made.

{% hint style="success" %}
Read the full case study [here](https://case-studies.sismo.io/db/safe-drop).
Expand Down
27 changes: 14 additions & 13 deletions SUMMARY.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@
* [Onchain Boilerplate](build-with-sismo-connect/run-example-apps/onchain-sample-project.md)
* [Offchain Boilerplate](build-with-sismo-connect/run-example-apps/offchain-sample-project.md)
* [Tutorials](build-with-sismo-connect/tutorials/README.md)
* [Get your appId - Create a Sismo Connect App](build-with-sismo-connect/tutorials/create-a-sismo-connect-app.md)
* [Onchain Tutorial (1/2): code your Airdrop contract with privately-aggregated data](build-with-sismo-connect/tutorials/tuto.md)
* [Onchain Tutorial (2/2): deploy your Airdrop contract](build-with-sismo-connect/tutorials/deploy-your-contracts.md)
* [Get Your appId - Create a Sismo Connect App](build-with-sismo-connect/tutorials/create-a-sismo-connect-app.md)
* [Onchain Tutorial (1/2): Code Your Airdrop Contract With Privately-Aggregated Data](build-with-sismo-connect/tutorials/tuto.md)
* [Onchain Tutorial (2/2): Deploy Your Airdrop Contract](build-with-sismo-connect/tutorials/deploy-your-contracts.md)
* [Technical Documentation](build-with-sismo-connect/technical-documentation/README.md)
* [Sismo Connect Configuration](build-with-sismo-connect/technical-documentation/sismo-connect-configuration.md)
* [Auths](build-with-sismo-connect/technical-documentation/auths.md)
Expand All @@ -31,10 +31,10 @@

## Data Groups

* [Data Groups & How to Create them?](data-groups/data-groups-and-how-to-create-them/README.md)
* [Factory Guide: Create a Data Group in 5 Minutes](data-groups/data-groups-and-how-to-create-them/create-your-data-group.md)
* [Sismo Hub Guide: Create Data Groups Programmatically](data-groups/data-groups-and-how-to-create-them/create-your-group-generator.md)
* [Sismo Hub Guide: Add a Data Provider to the Sismo Factory](data-groups/data-groups-and-how-to-create-them/create-your-data-provider.md)
* [Data Groups & Creation](data-groups/data-groups-and-creation/README.md)
* [Factory Guide: Create a Data Group in 5 Minutes](data-groups/data-groups-and-creation/create-your-data-group.md)
* [Sismo Hub Guide: Create Data Groups Programmatically](data-groups/data-groups-and-creation/create-your-group-generator.md)
* [Sismo Hub Guide: Add a Data Provider to the Sismo Factory](data-groups/data-groups-and-creation/create-your-data-provider.md)

## How Sismo Works

Expand All @@ -55,21 +55,22 @@
* [Command Line Interface](how-sismo-works/resources/sismo-hub/command-line-interface.md)
* [Sismo API](how-sismo-works/resources/sismo-api/README.md)
* [API Links](how-sismo-works/resources/sismo-api/api-links.md)
* [Query from a client](how-sismo-works/resources/sismo-api/query-from-a-client.md)
* [Query From a Client](how-sismo-works/resources/sismo-api/query-from-a-client.md)
* [Group](how-sismo-works/resources/sismo-api/group/README.md)
* [Get groups](how-sismo-works/resources/sismo-api/group/get-groups.md)
* [Get group snapshots](how-sismo-works/resources/sismo-api/group/get-group-snapshots.md)
* [Common parameters](how-sismo-works/resources/sismo-api/common-parameters.md)
* [Advanced filtering](how-sismo-works/resources/sismo-api/advanced-filtering.md)
* [Other models](how-sismo-works/resources/sismo-api/other-models/README.md)
* [Transaction](how-sismo-works/resources/sismo-api/other-models/transaction.md)
* [Common Parameters](how-sismo-works/resources/sismo-api/common-parameters.md)
* [Advanced Filtering](how-sismo-works/resources/sismo-api/advanced-filtering.md)
* [Transaction](how-sismo-works/resources/sismo-api/transaction.md)
* [Deployed Contract Addresses](how-sismo-works/resources/sismo-101.md)

## Links

* [Sismo Landing Page](https://www.sismo.io/)
* [Sismo Factory](https://factory.sismo.io/)
* [Sismo App Store](https://apps.sismo.io)
* [Sismo Builders Resources](https://resources.sismo.io)
* [Sismo Builder Resources](https://resources.sismo.io)
* [GitHub](https://github.com/sismo-core)
* [Discord](https://discord.gg/xKTMeRUX6u)
* [Twitter](https://twitter.com/sismo\_eth)
* [Blog](https://blog.sismo.io/)
Loading

0 comments on commit 5f048c1

Please sign in to comment.