Skip to content

Commit

Permalink
GITBOOK-475: change request with no subject merged in GitBook
Browse files Browse the repository at this point in the history
  • Loading branch information
dhadrien authored and gitbook-bot committed Jul 8, 2023
1 parent e41783f commit cac1323
Show file tree
Hide file tree
Showing 6 changed files with 28 additions and 7 deletions.
Binary file added .gitbook/assets/Sismo Connect_ Under the Hood.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ Examples of Data Groups:
| [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 in the [Sismo Factory](https://factory.sismo.io).
Anyone can [create a new Data Group](data-groups/data-groups-and-how-to-create-them/). 
{% 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>
Expand Down
4 changes: 4 additions & 0 deletions build-with-sismo-connect/getting-started-1.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@ You must create a Sismo Connect App in the [Sismo Factory](https://factory.sismo
Your frontend must make a Sismo Connect request, users will be redirected to their Data Vault to generate a ZK Proof and your frontend will receive a Sismo Connect Response from them. \
This response, containing the ZK Proof, will be verified on your backend/smart contract.

{% hint style="success" %}
Check the [Sismo Connect Cheatsheet](sismo-connect-cheatsheet.md) to see examples of requests.
{% endhint %}

1. Install our React Library

{% tabs %}
Expand Down
6 changes: 4 additions & 2 deletions build-with-sismo-connect/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@

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

Integrating Sismo Connect means two things:
Integrating Sismo Connect means 3 things main steps:

* Create a **Sismo Connect Application in the Sismo Factory**
* **In your Frontend: Use our React button or client library to request ZK Proofs from users** (like you would request a signature with Wallet Connect)
* **In your Backend/Smart Contracts: Use our Solidity/TypeScript library to verify those ZK Proofs** (like you would verify a signature with ethers/viem/ecrecover)

Expand All @@ -30,5 +31,6 @@ Integrating Sismo Connect means two things:

</details>

<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="../#sismo-connect-the-crypto-native-sso">#sismo-connect-the-crypto-native-sso</a></td><td><a href="../.gitbook/assets/What is Sismo Connect (2).png">What is Sismo Connect (2).png</a></td></tr><tr><td><a href="run-example-apps/">run-example-apps</a></td><td><a href="../.gitbook/assets/Boilerplates.png">Boilerplates.png</a></td></tr><tr><td><a href="tutorials/">tutorials</a></td><td><a href="../.gitbook/assets/Tutorials.png">Tutorials.png</a></td></tr></tbody></table>


<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="../#sismo-connect-the-crypto-native-sso">#sismo-connect-the-crypto-native-sso</a></td><td><a href="../.gitbook/assets/What is Sismo Connect (2).png">What is Sismo Connect (2).png</a></td></tr><tr><td><a href="run-example-apps/">run-example-apps</a></td><td><a href="../.gitbook/assets/Boilerplates.png">Boilerplates.png</a></td></tr><tr><td><a href="tutorials/">tutorials</a></td><td><a href="../.gitbook/assets/Tutorials.png">Tutorials.png</a></td></tr></tbody></table>
9 changes: 8 additions & 1 deletion build-with-sismo-connect/sismo-connect-cheatsheet.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,16 @@ This cheatsheet presents all types of requests you can make with Sismo Connect.
It contains:&#x20;

* How to impersonate Data Sources in your dev vault when developing a Sismo Connect App
* Request a large and diversified set of Data Sources ownerships/group membership
* Impersonating Data Sources enables you to be part of Data Groups and be able to make ZK Proofs claims.
* Request a large and diversified request:
* authentication: Data Sources ownerships
* claims: Data Group memberships
* Verify them in a backend and access verified data

{% hint style="success" %}
To understand Data Groups and how to create new ones Data Groups, [visit this section](../data-groups/data-groups-and-how-to-create-them/)
{% endhint %}

<details>

<summary>How the Request and Response look like 👉 <a href="https://test-request.sismo.io">https://test-request.sismo.io </a></summary>
Expand Down
14 changes: 11 additions & 3 deletions data-groups/data-groups-and-how-to-create-them/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,18 @@
# Data Groups & How to Create them?

Data Groups are created via the [Factory](https://factory.sismo.io) or by creating a pull request on the [Sismo Hub](https://github.com/sismo-core/sismo-hub).
Data Groups are created via the [Factory UI](https://factory.sismo.io) or by creating a pull request on the [Sismo Hub](https://github.com/sismo-core/sismo-hub).

The Factory is an interface to create groups on the Sismo Hub. The Sismo Hub will compute merkle trees of Data Groups and publish the roots onchain.
<figure><img src="../../.gitbook/assets/Sismo Connect_ Under the Hood.png" alt=""><figcaption></figcaption></figure>

Smart contracts and backends, to verify ZK Proofs, needs access to these merkle tree roots of the Data Groups.
The Factory is an interface to easily create Data Groups on the Sismo Hub infrastructure.&#x20;

The Sismo Hub computes merkle trees of groups, store them in its database and publish the merkle tree roots onchain.&#x20;

Onchain roots are the source of truth for backend and smart contracts to verify whether a ZK Proof is valid.

{% hint style="info" %}
Everything is [open-source](https://github.com/sismo-core/sismo-hub) and all groups can be computed by all.
{% endhint %}

## Data Sources

Expand Down

0 comments on commit cac1323

Please sign in to comment.