Skip to content

Commit

Permalink
GITBOOK-495: 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 16, 2023
1 parent 1397a60 commit a26cd6a
Show file tree
Hide file tree
Showing 12 changed files with 44 additions and 188 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,5 +148,5 @@ Read the full case study [here](https://case-studies.sismo.io/db/safe-drop).
{% endhint %}

{% hint style="info" %}
Learn how to build the Sybil-resistant airdrop [here](build-with-sismo-connect/tutorials/tuto.md). Alternatively, check out the [onchain boilerplate](build-with-sismo-connect/run-example-apps/onchain-sample-project.md).
Learn how to build the Sybil-resistant airdrop [here](build-with-sismo-connect/tutorials/tuto.md). Alternatively, check out the [onchain boilerplate](broken-reference).
{% endhint %}
5 changes: 1 addition & 4 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,8 @@
## Build with Sismo Connect

* [Overview](build-with-sismo-connect/getting-started.md)
* [Quickstart](build-with-sismo-connect/getting-started-1.md)
* [Installation](build-with-sismo-connect/getting-started-1.md)
* [Sismo Connect Cheatsheet](build-with-sismo-connect/sismo-connect-cheatsheet.md)
* [Boilerplates](build-with-sismo-connect/run-example-apps/README.md)
* [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)
Expand Down
2 changes: 1 addition & 1 deletion build-with-sismo-connect/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: Frequently asked questions.

<summary>What to do if I am stuck with pending transactions on a fork network?</summary>

You can end up in this situation if you are following the [onchain tutorial](tutorials/tuto.md) or the [onchain boilerplate](run-example-apps/onchain-sample-project.md). If it is the case, you are unable to make any transaction work on your local chain, and you surely view this type of message on your MetaMask:
You can end up in this situation if you are following the [onchain tutorial](tutorials/tuto.md) or the [onchain boilerplate](broken-reference). If it is the case, you are unable to make any transaction work on your local chain, and you surely view this type of message on your MetaMask:

![MetaMask connected to a locally forked Mumbai Testnet](<../.gitbook/assets/Capture d’écran 2023-05-12 à 01.10.06.png>)

Expand Down
44 changes: 35 additions & 9 deletions build-with-sismo-connect/getting-started-1.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,44 @@
# Quickstart
# Installation

This section is intended for developers who have prior experience with incorporating new tools into their existing repositories.
## Get your appId - (30 secs)

{% hint style="info" %}
Having difficulties? Head over to the pre-configured [boilerplates](run-example-apps/) or [tutorials](tutorials/). Neither demand experience with Sismo's tech stack to get set up.
Before anything, go to the [Sismo Factory](https://https/factory.sismo.io/apps-explorer) and create your app. Once your app is created, make sure to get your appId.

## Quick start - (1 min)

Chose and install the starter of your choice in one unique command line.

```bash
yarn create sismo-connect-app@latest
# or
npx create-sismo-connect-app@latest
# or
npm create sismo-connect-app@latest
```

### Available Starters

1. **offchain: Sismo Connect +** [**Next.js**](https://nextjs.org/docs) \
request ZK Proofs from users and verify them in a backend
2. **onchain: Sismo Connect +** [**Next.js**](https://nextjs.org/docs) **+** [**Foundry**](https://getfoundry.sh/) **+** [**wagmi**](https://wagmi.sh/)\
request ZK Proofs from users and verify them in a smart contract
3. **\[Upcoming] onchain: Sismo Connect + Next.js + hardhat + ethers**\
coming very soon, until then, head over the [Manual Installation](getting-started-1.md#manual-installation) if you want to use Sismo Connect with hardhat&#x20;

Feel free to check the [Sismo Connect Cheatsheet](sismo-connect-cheatsheet.md), a great companion when developing an app using Sismo Connect.

{% hint style="success" %}
We are here to support you on our [builders telegram group](https://buidlers.sismo.io)
{% endhint %}

## Step 1 - Setup: Create Your Sismo Connect App
## Manual Installation

You must create a Sismo Connect app in the [Sismo Factory](https://factory.sismo.io) ([tutorial](tutorials/create-a-sismo-connect-app.md)) and get your appId. This appId will be required both in your front end and smart contracts/back end.
This section is intended for developers who have prior experience with incorporating new tools into their existing repositories.

## Step 2 - Request: Integrate Sismo Connect in Your Front End
### Integrate Sismo Connect in Your Front End

Your front end must make a Sismo Connect request for users to be redirected to their Data Vault to generate a ZK proof and send your front end a Sismo Connect Response. This response, containing the ZK proof, will be verified on your back end/smart contract.
Make a Sismo Connect Request, users will be redirected to their Data Vault to generate a ZK proof and send your front end a Sismo Connect Response. \
This response, containing the ZK proof, will be verified on your back end/smart contract.

{% hint style="success" %}
Check the [Sismo Connect Cheatsheet](sismo-connect-cheatsheet.md) to see examples of requests.
Expand Down Expand Up @@ -111,7 +137,7 @@ Check the [Sismo Connect Cheatsheet ](sismo-connect-cheatsheet.md)to get a large
[Learn more](technical-documentation/sismo-connect-configuration.md) about Sismo Connect config and impersonation mode.
{% endhint %}

## Step 3 - Verify: Sismo Connect in Your Smart Contracts/Back Ends
### Sismo Connect in Your Smart Contracts/Back Ends

Your back end/smart contract will receive a Sismo Connect Response forwarded from your front end that you must verify.

Expand Down
2 changes: 1 addition & 1 deletion build-with-sismo-connect/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@ Integrating Sismo Connect has three main steps:

</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="broken-reference">Broken link</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>
28 changes: 0 additions & 28 deletions build-with-sismo-connect/run-example-apps/README.md

This file was deleted.

This file was deleted.

This file was deleted.

4 changes: 2 additions & 2 deletions build-with-sismo-connect/sismo-connect-cheatsheet.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ SIsmo Connect Response (with a ZK proof in it)
### Front End: Make a Sismo Connect Request with React Button

{% hint style="info" %}
As an alternative to the React Button, you can use the [<mark style="color:blue;">`@sismo-core/sismo-connect-client`</mark>](technical-documentation/packages/client.md) [library](technical-documentation/packages/client.md)
As an alternative to the React Button, you can use the [<mark style="color:blue;">`@sismo-core/sismo-connect-client`</mark>](technical-documentation/packages/client.md) library
{% endhint %}

```tsx
Expand Down Expand Up @@ -542,4 +542,4 @@ contract MyContract is SismoConnect {
}
```

Refer to the [Sismo Connect Solidity Library](technical-documentation/packages/solidity.md), the [onchain app boilerplate](run-example-apps/onchain-sample-project.md) or the [onchain tutorial](tutorials/tuto.md) for more information.
Refer to the [Sismo Connect Solidity Library](technical-documentation/packages/solidity.md), the [onchain app boilerplate](broken-reference) or the [onchain tutorial](tutorials/tuto.md) for more information.
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: Verify proofs from your users

# Sismo Connect Solidity Library: Verify Onchain

The Sismo Connect Solidity Library is built on top of the [Hydra-S2 Verifier](../../../how-sismo-works/core-components/proving-schemes/hydra-s2.md) and allows to easily verify proofs from your users **onchain**.&#x20;
The Sismo Connect Solidity Library allows to easily verify proofs from your users **onchain**.&#x20;

<figure><img src="../../../.gitbook/assets/Sismo Connect onchain Flow.png" alt=""><figcaption><p>Sismo Connect onchain Flow</p></figcaption></figure>

Expand Down
2 changes: 1 addition & 1 deletion build-with-sismo-connect/tutorials/tuto.md
Original file line number Diff line number Diff line change
Expand Up @@ -577,7 +577,7 @@ To see how to deploy your contracts, you can go to the [**associated tutorial**]

## Next steps

If you have any questions about integrating Sismo Connect, don’t hesitate to reach out. The team will be happy to answer any questions you may have. Any feedback is also welcomed! If you want to fork a repository with complex requests already set up, you can check our [**onchain boilerplate**](../run-example-apps/onchain-sample-project.md).
If you have any questions about integrating Sismo Connect, don’t hesitate to reach out. The team will be happy to answer any questions you may have. Any feedback is also welcomed! If you want to fork a repository with complex requests already set up, you can check our [**onchain boilerplate**](broken-reference).

Get involved in the Sismo community! 🎭

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -464,7 +464,7 @@ Now that you have your Group, you can build the following with it:
* [**Sismo Connect App**](../../#sismo-connect-the-crypto-native-sso):
* using the [Factory](https://factory.sismo.io/apps-explorer)
* creating by yourself using the [sismo-connect-packages](https://github.com/sismo-core/sismo-connect-packages/tree/main).
* You can find [**here**](../../build-with-sismo-connect/run-example-apps/) boilerplates to run on your computer.
* You can find [**here**](broken-reference) boilerplates to run on your computer.
* And [**here**](../../build-with-sismo-connect/tutorials/) tutorials that shows how to build Sismo Connect apps.

### Contribute to the Sismo Hub
Expand Down

0 comments on commit a26cd6a

Please sign in to comment.