diff --git a/build-with-sismo-connect/getting-started-1.md b/build-with-sismo-connect/getting-started-1.md index 857f82f..fc4397f 100644 --- a/build-with-sismo-connect/getting-started-1.md +++ b/build-with-sismo-connect/getting-started-1.md @@ -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. @@ -139,7 +139,7 @@ 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", @@ -147,7 +147,7 @@ export default function Home() { }); 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); // }} diff --git a/build-with-sismo-connect/sismo-connect-cheatsheet.md b/build-with-sismo-connect/sismo-connect-cheatsheet.md index 72d93d9..12819ce 100644 --- a/build-with-sismo-connect/sismo-connect-cheatsheet.md +++ b/build-with-sismo-connect/sismo-connect-cheatsheet.md @@ -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 ( 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 }, { @@ -128,7 +128,7 @@ return ( 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 @@ -150,7 +150,7 @@ return (
-Sismo Connect Reponse from the previous Request +Sismo Connect Response from the previous Request Copy-pasted from the test Sismo Connect Request 👉 [https://test-request.sismo.io ](https://test-request.sismo.io) @@ -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( diff --git a/build-with-sismo-connect/technical-documentation/auths.md b/build-with-sismo-connect/technical-documentation/auths.md index 3e9b64f..036e0fe 100644 --- a/build-with-sismo-connect/technical-documentation/auths.md +++ b/build-with-sismo-connect/technical-documentation/auths.md @@ -12,7 +12,7 @@ The `AuthRequest` is an object with the following properties: * `GITHUB`: Sismo Connect returns the user's GitHub account id. * `TWITTER` Sismo Connect returns the user's Twitter account id. * `EVM_ACCOUNT`: Sismo Connect returns the user's Ethereum address. - * `TELEGRAM` : Sismo Connect returns the user's Telegram account id. + * `TELEGRAM`: Sismo Connect returns the user's Telegram account id. * `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`. @@ -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(); @@ -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(); diff --git a/build-with-sismo-connect/technical-documentation/claims.md b/build-with-sismo-connect/technical-documentation/claims.md index cba4131..3034442 100644 --- a/build-with-sismo-connect/technical-documentation/claims.md +++ b/build-with-sismo-connect/technical-documentation/claims.md @@ -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 %} @@ -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(); @@ -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(); @@ -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** diff --git a/build-with-sismo-connect/technical-documentation/packages/react.md b/build-with-sismo-connect/technical-documentation/packages/react.md index 2c52474..67cd0bc 100644 --- a/build-with-sismo-connect/technical-documentation/packages/react.md +++ b/build-with-sismo-connect/technical-documentation/packages/react.md @@ -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 diff --git a/build-with-sismo-connect/technical-documentation/packages/server.md b/build-with-sismo-connect/technical-documentation/packages/server.md index a1b3ba7..b9e120c 100644 --- a/build-with-sismo-connect/technical-documentation/packages/server.md +++ b/build-with-sismo-connect/technical-documentation/packages/server.md @@ -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, { diff --git a/build-with-sismo-connect/technical-documentation/signature.md b/build-with-sismo-connect/technical-documentation/signature.md index 32f58f3..7e6417b 100644 --- a/build-with-sismo-connect/technical-documentation/signature.md +++ b/build-with-sismo-connect/technical-documentation/signature.md @@ -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. +Making a `SignatureRequest` is only possible if it is made alongside an auth or a claim request. {% endhint %} {% tabs %} @@ -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(); diff --git a/build-with-sismo-connect/technical-documentation/sismo-connect-configuration.md b/build-with-sismo-connect/technical-documentation/sismo-connect-configuration.md index f34d20b..5903924 100644 --- a/build-with-sismo-connect/technical-documentation/sismo-connect-configuration.md +++ b/build-with-sismo-connect/technical-documentation/sismo-connect-configuration.md @@ -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"}} @@ -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"}} diff --git a/build-with-sismo-connect/tutorials/deploy-your-contracts.md b/build-with-sismo-connect/tutorials/deploy-your-contracts.md index 62511c7..a25832a 100644 --- a/build-with-sismo-connect/tutorials/deploy-your-contracts.md +++ b/build-with-sismo-connect/tutorials/deploy-your-contracts.md @@ -122,7 +122,7 @@ You can simply run this command to see the simulation of your contract deploymen ```bash forge script DeployAirdrop --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 ``` @@ -167,12 +167,12 @@ Here is how to deploy the airdrop smart contract on the Mumbai testnet network. ```bash forge script DeployAirdrop --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. @@ -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 %} diff --git a/build-with-sismo-connect/tutorials/tuto.md b/build-with-sismo-connect/tutorials/tuto.md index 3b3ba96..c5f5911 100644 --- a/build-with-sismo-connect/tutorials/tuto.md +++ b/build-with-sismo-connect/tutorials/tuto.md @@ -146,7 +146,7 @@ Let's add the Sismo Connect Button and request the`vaultId` of users.
-vaultId: anonymous indentifier for a user. Will be used to avoid users to claim twice +vaultId: anonymous identifier for a user. Will be used to avoid users to claim twice 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. @@ -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. diff --git a/create-data-gems/create-a-sismo-connect-app.md b/create-data-gems/create-a-sismo-connect-app.md index ddb65f8..69e2a94 100644 --- a/create-data-gems/create-a-sismo-connect-app.md +++ b/create-data-gems/create-a-sismo-connect-app.md @@ -6,7 +6,7 @@ Before you begin integrating [**Sismo Connect**](../welcome-to-sismo/what-is-sis Why is an appId required for Sismo Connect? -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)$$ diff --git a/create-data-gems/tutorials/create-your-group.md b/create-data-gems/tutorials/create-your-group.md index 87d2632..2abd35d 100644 --- a/create-data-gems/tutorials/create-your-group.md +++ b/create-data-gems/tutorials/create-your-group.md @@ -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): -

wainting for approval

+

waiting for approval

We can see that now your Group request is in **waiting for approval** (red box) and a few time after in **Deploying**. @@ -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 ✔ **Deployed**. diff --git a/data-groups/data-groups-and-creation/create-your-data-group.md b/data-groups/data-groups-and-creation/create-your-data-group.md index 9f0899e..8c294b4 100644 --- a/data-groups/data-groups-and-creation/create-your-data-group.md +++ b/data-groups/data-groups-and-creation/create-your-data-group.md @@ -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): -

wainting for approval

+

waiting for approval

We can see that now your Group request is in **waiting for approval** (red box) and a few time after in **Deploying**. @@ -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 ✔ **Deployed**. diff --git a/data-groups/data-groups-and-creation/create-your-group-generator.md b/data-groups/data-groups-and-creation/create-your-group-generator.md index 374fdc2..431127b 100644 --- a/data-groups/data-groups-and-creation/create-your-group-generator.md +++ b/data-groups/data-groups-and-creation/create-your-group-generator.md @@ -454,7 +454,7 @@ When your PR is merged your Group generator will be registered in the Sismo Hub, Finally, your Group will be available in the Sismo Hub and anyone will be able to use it to create **Badges** or **Sismo Connect apps**, great job! 💪 {% hint style="success" %} -Don't hesitate to join our [**Dev** **Telegram**](https://t.me/+Z-SwcvXZFRVhZTQ0) and ping us during hackaton. We would love to talk to you and meet you there. Don't hesitate to send your PR there as well, we will quickly review and merge it (usually under 1 hour). +Don't hesitate to join our [**Dev** **Telegram**](https://t.me/+Z-SwcvXZFRVhZTQ0) and ping us during the hackathon. We would love to talk to you and meet you there. Don't hesitate to send your PR there as well, we will quickly review and merge it (usually under 1 hour). {% endhint %} ### Use your Group diff --git a/data-groups/data-groups-and-how-to-create-them/create-your-data-provider.md b/data-groups/data-groups-and-how-to-create-them/create-your-data-provider.md index 794cb3e..5af21cc 100644 --- a/data-groups/data-groups-and-how-to-create-them/create-your-data-provider.md +++ b/data-groups/data-groups-and-how-to-create-them/create-your-data-provider.md @@ -256,7 +256,7 @@ export class TutorialLensProvider extends GraphQLProvider { return dataProfiles; } - // method that iterate on the getWhoCollectedPublicationQuery + // method that iterates on the getWhoCollectedPublicationQuery private async *_getWhoCollectedPublication({ publicationId, }: PublicationId): AsyncGenerator { @@ -279,7 +279,7 @@ export class TutorialLensProvider extends GraphQLProvider { {% hint style="warning" %} It is very important to pass an object that contains all your argument as argument of the function that the Factory will use. -Indeed, when the Factory create the group using your data provider, it will use take all the arguments gave by the user as input and create an object from it. Then it will call your function with this object, like this: +Indeed, when the Factory create the group using your data provider, it will use take all the arguments given by the user as input and create an object from it. Then it will call your function with this object, like this: ```typescript const lensProviderData0 = await lensProvider.getWhoCollectedPublication({ @@ -625,4 +625,4 @@ Finally, your Data Provider will be available in the Sismo Hub and anyone will b You want to contribute, but you don't have any ideas for Data Providers to create? Check out the current [Sismo Hub GitHub's issues](https://github.com/sismo-core/sismo-hub/issues), as you will find some interesting ideas for Data Providers to implement. -If you have any questions or you need help regarding your Data Providers creation process, do not hesitate to join our [Discord](https://discord.gg/sismo) and ask us in **#dev-support** or ou [Dev Telegram](https://t.me/+Z-SwcvXZFRVhZTQ0). We will be glad to answer you 🤗 +If you have any questions or you need help regarding your Data Providers creation process, do not hesitate to join our [Discord](https://discord.gg/sismo) and ask us in **#dev-support** or [Dev Telegram](https://t.me/+Z-SwcvXZFRVhZTQ0). We will be glad to answer you 🤗 diff --git a/knowledge-base/resources/sismo-hub/group-generators.md b/knowledge-base/resources/sismo-hub/group-generators.md index f9f2b11..a6756fc 100644 --- a/knowledge-base/resources/sismo-hub/group-generators.md +++ b/knowledge-base/resources/sismo-hub/group-generators.md @@ -79,7 +79,7 @@ const generator: GroupGenerator = { export default generator; ``` -In the above example, the group generator will create a group named `my-simple-group`. Its timestamp will corresponds to the execution of the `generate` function. +In the above example, the group generator will create a group named `my-simple-group`. Its timestamp will correspond to the execution of the `generate` function. This group, `my-simple-group`, contains 7 accounts, four Ethereum addresses (two addresses as you know them, one ENS handle and one Lens handle) which all have a value of 1, two Github accounts with values of 2 and 4 and one Twitter account with a value of 3 as you can see in the `data` field.