Skip to content

Commit

Permalink
GITBOOK-460: typos + onchain verification cheatsheet
Browse files Browse the repository at this point in the history
  • Loading branch information
dhadrien authored and gitbook-bot committed Jul 2, 2023
1 parent e9f77a0 commit f9d04ca
Show file tree
Hide file tree
Showing 12 changed files with 121 additions and 33 deletions.
Binary file modified .gitbook/assets/SafeDrop_Case Study (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/SafeDrop_Case Study (2).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/Sismo Connect Flow (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/Sismo Connect Flow (2).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/Sismo Connect Flow.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/What is Sismo Connect (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/What is Sismo Connect.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 @@ -50,7 +50,7 @@ You can create your own Data Vault and start aggregating your identity [here](ht

Sismo Connect is a crypto-native 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.

<figure><img src=".gitbook/assets/Sismo Connect Flow (1).png" alt=""><figcaption></figcaption></figure>
<figure><img src=".gitbook/assets/Sismo Connect Flow (2).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.

Expand Down
18 changes: 5 additions & 13 deletions build-with-sismo-connect/getting-started-1.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,12 +82,12 @@ import { config } from "./sismo-connect-config.ts";
auths={[{ authType: AuthType.GITHUB }]}
// request zk proof that Data Source are part of a group
// (e.g NFT ownership, Dao Participation, GitHub commits)
claims=[{{groupId: ENS_DAO_VOTERS_GROUP_ID}}]
claims={[{groupId: ENS_DAO_VOTERS_GROUP_ID}]}
// request message signature from users.
signature={message: "I vote Yes to Privacy"}}
onResponseBytes={(response: string) => {
// call your contract/ backend with the response as bytes
}
}}
/>
```

Expand All @@ -97,22 +97,14 @@ Check the [Sismo Connect Example Requests](sismo-connect-cheatsheet.md) to get a

## Step 3 - Verify: Sismo Connect in your Smart Contracts/ Backends

You backend/smart contract will receive a Sismo Connect Response forwarded from your frontend that you must verify.
Your backend/smart contract will receive a Sismo Connect Response forwarded from your frontend that you must verify.

1. Install the Sismo Connect Library

<details>

<summary>EVM Chains supported</summary>

####
####
####
####
#### Mainnets

* **Arbitrum One** (42161)
Expand Down Expand Up @@ -202,9 +194,8 @@ contract Airdrop is SismoConnect {
// use buildConfig helper to easily build a Sismo Connect config in Solidity
SismoConnect(buildConfig(APP_ID))
{}
}
<strong>
</strong><strong>function verifySismoConnectResponse(bytes memory response) public {
</strong><strong> function verifySismoConnectResponse(bytes memory response) public {
</strong><strong> SismoConnectVerifiedResult memory result = verify({
</strong> responseBytes: response,
auths: auths,
Expand All @@ -213,6 +204,7 @@ contract Airdrop is SismoConnect {
});

// implement some logic if the proof is successful
}
}
</code></pre>
{% endtab %}
Expand Down
12 changes: 2 additions & 10 deletions build-with-sismo-connect/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Overview

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

Integrating Sismo Connect means two things:

Expand All @@ -11,14 +11,6 @@ Integrating Sismo Connect means two things:

<summary>EVM Chains supported</summary>

####

####

####

####

#### Mainnets

* **Arbitrum One** (42161)
Expand All @@ -38,5 +30,5 @@ 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="../welcome-to-sismo/what-is-sismo-connect.md">what-is-sismo-connect.md</a></td><td><a href="../.gitbook/assets/What is Sismo Connect (1).png">What is Sismo Connect (1).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="../welcome-to-sismo/what-is-sismo-connect.md">what-is-sismo-connect.md</a></td><td><a href="../.gitbook/assets/What is Sismo Connect.png">What is Sismo Connect.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>

120 changes: 112 additions & 8 deletions build-with-sismo-connect/sismo-connect-cheatsheet.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion welcome-to-sismo/what-is-sismo-connect.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Sismo Connect allows developers to implement Zero-Knowledge proofs in their appl

<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 (1).png">AppStore (1).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>

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

## Apps can access powerful data at once

Expand Down

0 comments on commit f9d04ca

Please sign in to comment.