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: typos #18

Open
wants to merge 17 commits into
base: main
Choose a base branch
from
6 changes: 3 additions & 3 deletions build-with-sismo-connect/getting-started-1.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ This command enables to you install one of the available starters:
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
coming very soon, until then, head over to the [Manual Installation](getting-started-1.md#manual-installation) if you want to use Sismo Connect with hardhat

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

Expand Down Expand Up @@ -139,15 +139,15 @@ export default function Home() {
]}
// request message signature from users.
signature={{ message: "I vote Yes to Privacy" }}
// retrieve the Sismo Connect Reponse from the user's Sismo data vault
// retrieve the Sismo Connect Response from the user's Sismo data vault
onResponse={async (response: SismoConnectResponse) => {
const res = await fetch("/api/verify", {
method: "POST",
body: JSON.stringify(response),
});
console.log(await res.json());
}}
// reponse in bytes to call a contract
// response in bytes to call a contract
// onResponseBytes={async (response: string) => {
// console.log(response);
// }}
Expand Down
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 @@ -74,7 +74,7 @@ const config: SismoConnectConfig = {
// Sismo Connect Response in the vault instead of redirecting back to the app
};

// button that will redirect tu users faults
// button that will redirect to users faults
export default function Home() {
return (
<SismoConnectButton
Expand Down Expand Up @@ -102,7 +102,7 @@ return (
{ authType: AuthType.TELEGRAM, userId: "875608110", isOptional: true },
]}

// Claims = prove groump membership of a Data Source in a specific Data Group.
// Claims = prove group membership of a Data Source in a specific Data Group.
// Data Groups = [{[dataSource1]: value1}, {[dataSource1]: value1}, .. {[dataSource]: value}]
// When doing so Data Source is not shared to the app.
claims={[
Expand Down
20 changes: 10 additions & 10 deletions build-with-sismo-connect/sismo-connect-request-cheatsheet.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,18 +58,18 @@ const config: SismoConnectConfig = {
// Sismo Connect Response in the vault instead of redirecting back to the app
};

// button that will redirect tu users faults
// button that will redirect to users faults
export default function Home() {
return (
<SismoConnectButton
config={config}
// Auths = Data Source Ownership Requests
auths={[
// Anonymus identifier of the vault for this app
// Anonymous identifier of the vault for this app
// vaultId = hash(vaultSecret, appId).
// full docs: https://docs.sismo.io/sismo-docs/build-with-sismo-connect/technical-documentation/vault-and-proof-identifiers
{ authType: AuthType.VAULT },
// can chose any EVM account from the vault
// can choose any EVM account from the vault
{ authType: AuthType.EVM_ACCOUNT },
{
authType: AuthType.EVM_ACCOUNT,
Expand All @@ -83,12 +83,12 @@ return (
{ authType: AuthType.TELEGRAM, userId: "875608110", isOptional: true },
]}
// Claims = Data Gems Ownership Requests
// Data Gem == Groump membership of a Data Source, Data Source won't be revealed
// Data Gem == Group membership of a Data Source, Data Source won't be revealed
claims={[
{
// Stand with Crypto NFT Minter Gem (= part of the Stand with Crypto NFT Minter Group)
// https://sismo-prod-hub-data.s3.eu-west-1.amazonaws.com/group-snapshot-store/0xfae674b6cba3ff2f8ce2114defb200b1/1688203882.json
// note: dhadrien.sismo.eth par of group with value 10 (minted 10 NFT)
// note: dhadrien.sismo.eth part of group with value 10 (minted 10 NFT)
groupId: "0xfae674b6cba3ff2f8ce2114defb200b1",
// default: claimType: ClaimType.GTE
// default value: 1,
Expand All @@ -113,22 +113,22 @@ return (
groupId: "0x1cde61966decb8600dfd0749bd371f12",
claimType: ClaimType.EQ, // member of the group with value == 15
value: 15, // 46 not equal to 15 => won't be able to generate ZK PRoof
isSelectableByUser: true, // can selectively discloe more if user wants
isSelectableByUser: true, // can selectively disclose more if user wants
isOptional: true,
},
{
// Stand with Crypto NFT Minter Gem, dhadrien.sismo.eth minted 10
groupId: "0xfae674b6cba3ff2f8ce2114defb200b1", //
claimType: ClaimType.GTE, // member of the group
isSelectableByUser: true, // can selectively discloe more if user wants
isSelectableByUser: true, // can selectively disclose more if user wants
isOptional: true, // can chose not to reveal
},
{
// Gitcoin Passport Gem, dhadrien.sismo.eth: score 46
groupId: "0x1cde61966decb8600dfd0749bd371f12",
claimType: ClaimType.GTE, // member of the group with value greater or equal to 5
value: 25,
isSelectableByUser: true, // can selectively discloe more if user wants
isSelectableByUser: true, // can selectively disclose more if user wants
},
]}
// we ask the user to sign a message
Expand All @@ -150,7 +150,7 @@ return (

<details>

<summary>Sismo Connect Reponse from the previous Request</summary>
<summary>Sismo Connect Response from the previous Request</summary>

Copy-pasted from the test Sismo Connect Request 👉 [https://test-request.sismo.io ](https://test-request.sismo.io)

Expand Down Expand Up @@ -340,7 +340,7 @@ import {
SismoConnectResponse
} from "@sismo-core/sismo-connect-server";

// reusing the exaxt same config as the frontend's
// reusing the exact same config as the frontend's
const sismoConnect = SismoConnect({ config });

const result: SismoConnectVerifiedResult = await sismoConnect.verify(
Expand Down
6 changes: 3 additions & 3 deletions build-with-sismo-connect/technical-documentation/auths.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The `AuthRequest` is an object with the following properties:
* `GITHUB`: Sismo Connect returns the user's GitHub account id.&#x20;
* `TWITTER` Sismo Connect returns the user's Twitter account id.&#x20;
* `EVM_ACCOUNT`: Sismo Connect returns the user's Ethereum address.
* `TELEGRAM` : Sismo Connect returns the user's Telegram account id.&#x20;
* `TELEGRAM`: Sismo Connect returns the user's Telegram account id.&#x20;
* `userId` (optional): requests the user to have a predefined account.
* `isOptional`(optional): by default set to `false`. Allows the user to optionally authenticate with this `AuthType`.

Expand Down 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.getReponse();
const responseBytes: string | null = sismoConnect.getResponseBytes();

Expand Down
8 changes: 4 additions & 4 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.getReponse();
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.getReponse();
const responseBytes: string | null = sismoConnect.getResponseBytes();

Expand Down Expand Up @@ -314,7 +314,7 @@ The Sismo Connect Library exposes:

* a `verify()` function, which allows you to verify a proof generated by the [Sismo Vault app](broken-reference) with respect to some requests directly in your contract. The verify() function takes an object containing:
1. a `responseBytes` send from the front end,
2. an `claim` or `claims` corresponding to the claim request made in the front end.
2. a `claim` or `claims` corresponding to the claim request made in the front end.
* a `buildClaim()` helper to recreate the `ClaimRequest` made in the front end

**One ClaimRequest - code example**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ Please see the [Sismo Connect Client documentation](client.md) to see all the po

## Documentation

This package is a wrapper of the Sismo Connect Client package, which means that all the core concepts such as `SismoConnectClientConfig`, `AuthRequest`,`ClaimRequest`, `SignatureRequest`, and `SismoConnectResponse` are the same as in the client package. If you need to explore these concepts in detail, we advise you to refer to the [Sismo Connect Client](client.md) page, which provides more detailed information.
This package is a wrapper of the Sismo Connect Client package, which means that all the core concepts such as `SismoConnectClientConfig`, `AuthRequest`, `ClaimRequest`, `SignatureRequest`, and `SismoConnectResponse` are the same as in the client package. If you need to explore these concepts in detail, we advise you to refer to the [Sismo Connect Client](client.md) page, which provides more detailed information.

### SismoConnectButton

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ async function verifyResponse(sismoConnectResponse: SismoConnectResponse) {
// with respect to the different auths
// and the group(s) in the claim(s)
// i.e. user prove they own a Vault, a Twitter account
// and they are member of the group with id "0x42c768bb8ae79e4c5c05d3b51a4ec74a"
// and they are members of the group with id "0x42c768bb8ae79e4c5c05d3b51a4ec74a"
const result: SismoConnectVerifiedResult = await sismoConnect.verify(
sismoConnectResponse,
{
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.getReponse();
const responseBytes: string | null = sismoConnect.getResponseBytes();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ const config: SismoConnectConfig = {
// request proof of Data Sources ownership (e.g EVM, GitHub, Twitter or Telegram)
auths={[{ authType: AuthType.GITHUB }]}
// request proof of Data Group memberships of source
// (e.g part of NFT owners, Dao Participants, GitHub commiters)
// (e.g part of NFT owners, Dao Participants, GitHub committers)
claims={[{groupId: ENS_DAO_VOTERS_GROUP_ID}]}
// request message signature from users.
signature={{message: "I vote Yes to Privacy"}}
Expand Down Expand Up @@ -155,7 +155,7 @@ const config: SismoConnectConfig = {
// request proof of Data Sources ownership (e.g EVM, GitHub, Twitter or Telegram)
auths={[{ authType: AuthType.GITHUB }]}
// request proof of Data Group memberships of source
// (e.g part of NFT owners, Dao Participants, GitHub commiters)
// (e.g part of NFT owners, Dao Participants, GitHub committers)
claims={[{groupId: ENS_DAO_VOTERS_GROUP_ID}]}
// request message signature from users.
signature={{message: "I vote Yes to Privacy"}}
Expand Down
8 changes: 4 additions & 4 deletions build-with-sismo-connect/tutorials/deploy-your-contracts.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ You can simply run this command to see the simulation of your contract deploymen
```bash
forge script DeployAirdrop --rpc-url <your-mumbai-rpc-url>

# if you dont have any personal rpc url
# if you don't have any personal rpc url
# you can try to use https://rpc.ankr.com/polygon_mumbai
```

Expand Down Expand Up @@ -167,12 +167,12 @@ Here is how to deploy the airdrop smart contract on the Mumbai testnet network.
```bash
forge script DeployAirdrop --rpc-url <your-mumbai-rpc-url> --private-key '0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80' --broadcast

# if you dont have any personal rpc url
# if you don't have any personal rpc url
# you can try to use https://rpc.ankr.com/polygon_mumbai
```
{% endcode %}

If you try to run this exact command without changing the private key, you will encounter an error since the account has no funds. You should replace the private key by your own developer private key and have some funds on your dev account (Mumbai faucet link: [https://mumbaifaucet.com/](https://mumbaifaucet.com/)).
If you try to run this exact command without changing the private key, you will encounter an error since the account has no funds. You should replace the private key with your own developer private key and have some funds on your dev account (Mumbai faucet link: [https://mumbaifaucet.com/](https://mumbaifaucet.com/)).

{% hint style="success" %}
Notice the `--broadcast` option, which states that you want to actually trigger the transaction on the Mumbai testnet.
Expand Down Expand Up @@ -200,7 +200,7 @@ forge script DeployAirdrop \
--verify \
--watch

# if you dont have any personal rpc url
# if you don't have any personal rpc url
# you can try to use https://rpc.ankr.com/polygon_mumbai
```
{% endcode %}
Expand Down
4 changes: 2 additions & 2 deletions build-with-sismo-connect/tutorials/tuto.md
Original file line number Diff line number Diff line change
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](../../how-sismo-works/core-components/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 @@ -529,7 +529,7 @@ contract Airdrop is ERC20, SismoConnect {
revert AlreadyClaimed();
}

// each vaultId can claim tokens relatively to their its aggregated reputation
// each vaultId can claim tokens relative to their aggregated reputation
uint256 airdropAmount = _getRewardAmount(result);

// we mark the user as claimed. We could also have stored more user airdrop information for a more complex airdrop system. But we keep it simple here.
Expand Down
2 changes: 1 addition & 1 deletion create-data-gems/create-a-sismo-connect-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Before you begin integrating [**Sismo Connect**](../welcome-to-sismo/what-is-sis

<summary>Why is an <code>appId</code> required for Sismo Connect?</summary>

The `appId` will be used to compute a VaultId, which is the the unique identifier for a user on your app. The VaultId is simply the hash of a user's Vault secret and the appId.
The `appId` will be used to compute a VaultId, which is the unique identifier for a user on your app. The VaultId is simply the hash of a user's Vault secret and the appId.

$$vaultId = hash(vaultSecret, appId)$$

Expand Down
4 changes: 2 additions & 2 deletions create-data-gems/tutorials/create-your-group.md
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ After having completed the captcha, click on the "Request to deploy":

You will be redirected to the [Group Explorer Page](https://factory.sismo.io/groups-explorer):

<figure><img src="../../.gitbook/assets/Capture d’écran 2023-03-14 à 10.11.48 2.png" alt=""><figcaption><p>wainting for approval</p></figcaption></figure>
<figure><img src="../../.gitbook/assets/Capture d’écran 2023-03-14 à 10.11.48 2.png" alt=""><figcaption><p>waiting for approval</p></figcaption></figure>

We can see that now your Group request is in <mark style="background-color:blue;">**waiting for approval**</mark> (<mark style="color:red;">red box</mark>) and a few time after in <mark style="background-color:blue;">**Deploying**</mark>.

Expand All @@ -211,7 +211,7 @@ Don't hesitate to join our [**Dev** **Telegram**](https://t.me/+Z-SwcvXZFRVhZTQ0
{% endhint %}

{% hint style="info" %}
If you Group consist of more than 100k accounts then the Sismo Team will have to approve the Group before deploying it. So don't hesitate to send your PR there as well, we will quickly review and merge it (**usually under 30 minutes**). During hackathons, we are committed to quickly reviewing any new Data Group pull request.
If your Group consists of more than 100k accounts then the Sismo Team will have to approve the Group before deploying it. So don't hesitate to send your PR there as well, we will quickly review and merge it (**usually under 30 minutes**). During hackathons, we are committed to quickly reviewing any new Data Group pull request.
{% endhint %}

So a few time after your Group will be in deployment and it will be displayed as <mark style="background-color:green;">✔</mark> <mark style="background-color:green;">**Deployed**</mark>.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ After having completed the captcha, click on the "Request to deploy":

You will be redirected to the [Group Explorer Page](https://factory.sismo.io/groups-explorer):

<figure><img src="../../.gitbook/assets/Capture d’écran 2023-03-14 à 10.11.48 2.png" alt=""><figcaption><p>wainting for approval</p></figcaption></figure>
<figure><img src="../../.gitbook/assets/Capture d’écran 2023-03-14 à 10.11.48 2.png" alt=""><figcaption><p>waiting for approval</p></figcaption></figure>

We can see that now your Group request is in <mark style="background-color:blue;">**waiting for approval**</mark> (<mark style="color:red;">red box</mark>) and a few time after in <mark style="background-color:blue;">**Deploying**</mark>.

Expand All @@ -221,7 +221,7 @@ Don't hesitate to join our [**Dev** **Telegram**](https://t.me/+Z-SwcvXZFRVhZTQ0
{% endhint %}

{% hint style="info" %}
If you Group consist of more than 100k accounts then the Sismo Team will have to approve the Group before deploying it. So don't hesitate to send your PR there as well, we will quickly review and merge it (**usually under 30 minutes**). During hackathons, we are committed to quickly reviewing any new Data Group pull request.
If your Group consists of more than 100k accounts then the Sismo Team will have to approve the Group before deploying it. So don't hesitate to send your PR there as well, we will quickly review and merge it (**usually under 30 minutes**). During hackathons, we are committed to quickly reviewing any new Data Group pull request.
{% endhint %}

So a few time after your Group will be in deployment and it will be displayed as <mark style="background-color:green;">✔</mark> <mark style="background-color:green;">**Deployed**</mark>.
Expand Down
Loading