Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: several typos in the docs #19

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion build-with-sismo-connect/getting-started-1.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Before anything, go to the [Sismo Factory](https://factory.sismo.io) and create

## Quick start - (1 min)

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

<pre class="language-bash"><code class="lang-bash">npx create-sismo-connect-app@latest
# or
Expand Down
4 changes: 2 additions & 2 deletions build-with-sismo-connect/technical-documentation/auths.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ function onClick(){
});
}

// Proofs are available in two differents types depending on usage (offchain or onchaon verification)
// Proofs are available in two different types depending on usage (offchain or onchain verification)
const response: SismoConnectResponse | null = sismoConnect.getResponse();
const responseBytes: string | null = sismoConnect.getResponseBytes();

Expand Down Expand Up @@ -162,7 +162,7 @@ function onClick(){
});
}

// Proofs are available in two differents types depending on usage (offchain or onchaon verification)
// Proofs are available in two different types depending on usage (offchain or onchain verification)
const response: SismoConnectResponse | null = sismoConnect.getResponse();
const responseBytes: string | null = sismoConnect.getResponseBytes();

Expand Down
6 changes: 3 additions & 3 deletions build-with-sismo-connect/technical-documentation/claims.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Requests are then verified either in a backend using the [`sismo-connect-server`
### Making a ClaimRequest - Front-end integration

{% hint style="info" %}
Making an `ClaimRequest` is only possible in the front end as the request redirects users to the Sismo Vault app, where users can generate a zero-knowledge proof.
Making a `ClaimRequest` is only possible in the front end as the request redirects users to the Sismo Vault app, where users can generate a zero-knowledge proof.
{% endhint %}

{% tabs %}
Expand Down Expand Up @@ -135,7 +135,7 @@ function onClick(){
});
}

// Proofs are available in two differents types depending on usage (offchain or onchaon verification)
// Proofs are available in two different types depending on usage (offchain or onchain verification)
const response: SismoConnectResponse | null = sismoConnect.getResponse();
const responseBytes: string | null = sismoConnect.getResponseBytes();

Expand Down Expand Up @@ -166,7 +166,7 @@ function onClick(){
});
}

// Proofs are available in two differents types depending on usage (offchain or onchaon verification)
// Proofs are available in two different types depending on usage (offchain or onchain verification)
const response: SismoConnectResponse | null = sismoConnect.getResponse();
const responseBytes: string | null = sismoConnect.getResponseBytes();

Expand Down
4 changes: 2 additions & 2 deletions build-with-sismo-connect/technical-documentation/signature.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ If you are verifying your proofs in a smart contract, you will need to encode yo
### Making a SignatureRequest - Front-end integration

{% hint style="info" %}
Making an `SignatureRequest` is only possible if it is made alongside an auth or a claim request.&#x20;
Making a `SignatureRequest` is only possible if it is made alongside an auth or a claim request.&#x20;
{% endhint %}

{% tabs %}
Expand Down Expand Up @@ -109,7 +109,7 @@ function onClick(){
});
}

// Proofs are available in two differents types depending on usage (offchain or onchaon verification)
// Proofs are available in two different types depending on usage (offchain or onchain verification)
const response: SismoConnectResponse | null = sismoConnect.getResponse();
const responseBytes: string | null = sismoConnect.getResponseBytes();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Overview

This tutorial aims at describing the process behind the deployment of Sismo Connect contracts. In this context, we will recap on what a Sismo Connect Client config is and how to impersonate accounts. Once understood, these notions will allow you to confidently deploy contracts with Sismo Connect's functionalities.
This tutorial aims to describe the process behind the deployment of Sismo Connect contracts. In this context, we will recap on what a Sismo Connect Client config is and how to impersonate accounts. Once understood, these notions will allow you to confidently deploy contracts with Sismo Connect's functionalities.

{% hint style="success" %}
To better understand the different notions highlighted in this tutorial, we strongly advise you to go through [**the first tutorial**](tuto.md)**,** which will show you how to leverage data aggregation in your app by [**building a Gated Airdrop for Gitcoin Passport holders**](tuto.md).&#x20;
Expand Down
6 changes: 3 additions & 3 deletions build-with-sismo-connect/tutorials/tuto.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ Congrats on getting your airdrop! Now, let's see how this simple Sismo Connect i
Go to the `front/src/app/page.tsx`

{% hint style="success" %}
To use Sismo Connect in your application, you will need to create an application in the [Sismo Factory](https://factory.sismo.io/apps-explorer) and get its `appId`. You can see a quick tutorial on how to do it [here](create-a-sismo-connect-app.md).
To use Sismo Connect in your application, you will need to create an application in the [Sismo Factory](https://factory.sismo.io/apps-explorer) and get it's appId`. You can see a quick tutorial on how to do it [here](create-a-sismo-connect-app.md).

For this tutorial, we will use an already existing app (appId: 0xf4977993e52606cfd67b7a1cde717069)
{% endhint %}
Expand Down Expand Up @@ -146,7 +146,7 @@ Let's add the Sismo Connect Button and request the`vaultId` of users.

<details>

<summary>vaultId: anonymous indentifier for a user. Will be used to avoid users to claim twice</summary>
<summary>vaultId: anonymous identifier for a user. Will be used to avoid users to claim twice</summary>

Sismo users have a sovereign [Data Vault](../../data-vault/what-is-the-data-vault.md) where they import Data Sources from which they will generate ZK proofs. Each Data Vault has a secret only known by its owner.

Expand Down Expand Up @@ -284,7 +284,7 @@ contract Airdrop is ERC20, SismoConnect {
}
</code></pre>

The `vaultId` enables protection against double spends in an anonymous way. Indeed, if a user generates a second proof from the same Vault, he would not be able to claim the airdrop again since each proof generated from a Vault has the same `vaultId` associated with it.&#x20;
The `vaultId` enables protection against double spending in an anonymous way. Indeed, if a user generates a second proof from the same Vault, he would not be able to claim the airdrop again since each proof generated from a Vault has the same `vaultId` associated with it.&#x20;

{% hint style="success" %}
If you use Impersonation Mode, you will be able to claim the airdrop each time you try since the `vaultId` is randomized in this mode.
Expand Down