Sismo Connect Cheatsheet
Last updated
Last updated
This cheatsheet presents all of the types of requests you can make with Sismo Connect. It should be a great companion when developing a Sismo Connect app.
It contains:
How to impersonate Data Sources in your dev Vault when developing a Sismo Connect app
Impersonating Data Sources enables you to be part of Data Groups and generate ZK proofs.
Request a large and diversified request:
Authentication: Data Source ownership
Claims: Data Group membership
Verify them in a back end and access verified data
Visit this section to understand Data Groups and how to create them.
// react page
import {
SismoConnectButton,
SismoConnectConfig,
AuthType,
ClaimType,
SismoConnectResponse
} from "@sismo-core/sismo-connect-react";
const config: SismoConnectConfig = {
appId: "0x32403ced4b65f2079eda77c84e7d2be6",
vault: {
// For development purposes insert the Data Sources that you want to impersonate
// Never use this in production
impersonate: [
// EVM Data Sources
"dhadrien.sismo.eth",
"leo21.sismo.eth",
"0xA4C94A6091545e40fc9c3E0982AEc8942E282F38",
"0x1b9424ed517f7700e7368e34a9743295a225d889",
"0x82fbed074f62386ed43bb816f748e8817bf46ff7",
"0xc281bd4db5bf94f02a8525dca954db3895685700",
"vitalik.eth",
// Github Data Source
"github:dhadrien",
// Twitter Data Source
"twitter:dhadrien_",
// Telegram Data Source
"telegram:dhadrien",
],
},
displayRawResponse: true, // this enables you to get access directly to the
// Sismo Connect Response in the vault instead of redirecting back to the app
};
// button that will redirect tu users faults
export default function Home() {
return (
<SismoConnectButton
config={config}
// Auths = Data Source Ownership Requests
auths={[
// 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
// user is required to prove ownership of their vaultId for this appId
{ authType: AuthType.VAULT },
// user is required to prove ownership of an EVM account from their vault
{ authType: AuthType.EVM_ACCOUNT },
// user is required to prove ownership of 0xa4c94a6091545e40fc9c3e0982aec8942e282f38
{
authType: AuthType.EVM_ACCOUNT,
userId: "0xa4c94a6091545e40fc9c3e0982aec8942e282f38", // impersonated
},
// user is required to prove ownership of a GitHub account
{ authType: AuthType.GITHUB },
// user can prove ownership of a Twitter account, optional
{ authType: AuthType.TWITTER, isOptional: true },
// user can prove ownership of @dhadrien Telegram account, optional
// telegram of @dhadrien
{ authType: AuthType.TELEGRAM, userId: "875608110", isOptional: true },
]}
// Claims = prove groump 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={[
{
// claim on Sismo Hub GitHub Contributors Data Group membership: https://factory.sismo.io/groups-explorer?search=0xda1c3726426d5639f4c6352c2c976b87
// Data Group members = contributors to sismo-core/sismo-hub
// value for each group member = number of contributions
// request user to prove membership in the group
groupId: "0xda1c3726426d5639f4c6352c2c976b87", // impersonated github:dhadrien has 1 contribution, eligible
},
{
// claim ENS DAO Voters Data Group membership: https://factory.sismo.io/groups-explorer?search=0x85c7ee90829de70d0d51f52336ea4722
// Data Group members = voters in ENS DAO
// value for each group member = number of votes in ENS DAO
// request user to prove membership in the group with value >= 17
groupId: "0x85c7ee90829de70d0d51f52336ea4722",
claimType: ClaimType.GTE,
value: 4, // impersonated dhadrien.sismo.eth has 17 votes, eligible
},
{
// claim on Stand with Crypto NFT Minters Data Group membership: https://factory.sismo.io/groups-explorer?search=0xfae674b6cba3ff2f8ce2114defb200b1
// Data Group members = minters of the Stand with Crypto NFT
// value for each group member = number of NFT minted
// request user to prove membership in the group with value = 10
groupId: "0xfae674b6cba3ff2f8ce2114defb200b1",
claimType: ClaimType.EQ,
value: 10, // dhadrin.sismo.eth minted exactly 10, eligible
},
{
// claim Gitcoin Passport Holders Data Group membership: https://factory.sismo.io/groups-explorer?search=0x1cde61966decb8600dfd0749bd371f12
// Data Group members = Gitcoin Passport Holders
// value for each group member = Gitcoin Passport Score
// request user to prove membership in the group with value > 15, user can reveal more if they want
groupId: "0x1cde61966decb8600dfd0749bd371f12",
claimType: ClaimType.GTE,
value: 15, // dhadrien.sismo.eth has a score of 46, eligible. Can reveal more.
isSelectableByUser: true, // can reveal more than 15 if they want
},
{
// claim on Stand with Crypto NFT Minters Data Group membership: https://factory.sismo.io/groups-explorer?search=0xfae674b6cba3ff2f8ce2114defb200b1
// optional request user to prove membership in the group with value >= 6
groupId: "0xfae674b6cba3ff2f8ce2114defb200b1",
claimType: ClaimType.GTE,
value: 6, // dhadrien.sismo.eth minted 10 NFTs, eligible
isOptional: true,
},
{
// claim on Gitcoin Passport Holders Data Group membership: https://factory.sismo.io/groups-explorer?search=0x1cde61966decb8600dfd0749bd371f12
// optional request user to prove membership in the group with value = 15
groupId: "0x1cde61966decb8600dfd0749bd371f12",
claimType: ClaimType.EQ,
value: 15, // dhadrien.sismo.eth has a score of 46 != 15, not eligible.
isOptional: true, // can chose not to reveal
},
{
// claim on Sismo Hub GitHub Contributors Data Group membership: https://factory.sismo.io/groups-explorer?search=0xda1c3726426d5639f4c6352c2c976b87
// optional request user to prove membership in the group and reveal any value they want
groupId: "0xda1c3726426d5639f4c6352c2c976b87",
claimType: ClaimType.GTE,
value: 1,
isSelectableByUser: true, // can selectively disclose more if user wants
isOptional: true, // can chose not to reveal
},
]}
// we ask the user to sign a message
signature={{message: "I love Sismo!", isSelectableByUser: true}}
// onResponseBytes calls a 'setResponse' function with the responseBytes returned by the Sismo Vault
onResponse={ async (response: SismoConnectResponse) => {
await fetch("/api/verify", {
method: "POST",
body: JSON.stringify(response),
})
}}
/>
)}// backend.ts
import {
SismoConnect,
AuthType,
SismoConnectVerifiedResult,
ClaimType,
SismoConnectConfig,
SignatureRequest,
AuthRequest,
ClaimRequest,
SismoConnectResponse
} from "@sismo-core/sismo-connect-server";
(async () => {
// reusing the exact same config as the front end's
const sismoConnect = SismoConnect({ config });
const result: SismoConnectVerifiedResult = await sismoConnect.verify(
sismoConnectResponse, // copied from the previous step or received from API call
{
auths,
claims,
signature,
}
);
console.log(result.getUserIds(AuthType.VAULT));
// vault anonymous identifier = hash(vaultSecret, AppId)
// ['0x225c5b67c39778b40ef2528707c9fbdfed96f31b9a50826b95c2ac40e15e4c6b']
console.log(result.getUserIds(AuthType.GITHUB));
// [ '35774097' ] GitHub id of @dhadrien
console.log(result.getUserIds(AuthType.TWITTER));
// [ '2390703980' ] Twitter id of @dhadrien_
console.log(result.getUserIds(AuthType.EVM_ACCOUNT));
// [
// '0x8ab1760889f26cbbf33a75fd2cf1696bfccdc9e6', // dhadrien.sismo.eth
// '0xa4c94a6091545e40fc9c3e0982aec8942e282f38' // requested wallet auth
// ]
console.log(result.getUserIds(AuthType.TELEGRAM));
// [ '875608110' ] // Telegram id of @dhadrien
})()// SPDX-License-Identifier: MIT
pragma solidity ^0.8.17;
import "sismo-connect-solidity/SismoConnectLib.sol";
contract MyContract is SismoConnect {
// reference your appId
bytes16 private _appId = 0x32403ced4b65f2079eda77c84e7d2be6;
// allow impersonation
bool private _isImpersonationMode = true;
constructor()
// use buildConfig helper to easily build a Sismo Connect config in Solidity
SismoConnect(buildConfig({appId: _appId, isImpersonationMode: _isImpersonationMode}))
{}
function verifySismoConnectResponse(bytes memory response) public {
// Recreate the request made in the fontend to verify the proof
// We will verify the Sismo Connect Response containing the ZK Proofs against it
AuthRequest[] memory auths = new AuthRequest[](6);
auths[0] = _authRequestBuilder.build({authType: AuthType.VAULT});
auths[1] = _authRequestBuilder.build({authType: AuthType.EVM_ACCOUNT});
auths[2] = _authRequestBuilder.build({
authType: AuthType.EVM_ACCOUNT,
userId: uint160(0xA4C94A6091545e40fc9c3E0982AEc8942E282F38)
});
auths[3] = _authRequestBuilder.build({authType: AuthType.GITHUB});
auths[4] = _authRequestBuilder.build({
authType: AuthType.TWITTER,
userId: 295218901,
isOptional: true,
isSelectableByUser: false
});
auths[5] = _authRequestBuilder.build({
authType: AuthType.TELEGRAM,
userId: 875608110,
isOptional: true,
isSelectableByUser: false
});
ClaimRequest[] memory claims = new ClaimRequest[](7);
claims[0] = _claimRequestBuilder.build({groupId: 0xda1c3726426d5639f4c6352c2c976b87});
claims[1] = _claimRequestBuilder.build({
groupId: 0x85c7ee90829de70d0d51f52336ea4722,
claimType: ClaimType.GTE,
value: 4
});
claims[2] = _claimRequestBuilder.build({
groupId: 0xfae674b6cba3ff2f8ce2114defb200b1,
claimType: ClaimType.EQ,
value: 10
});
claims[3] = _claimRequestBuilder.build({
groupId: 0x1cde61966decb8600dfd0749bd371f12,
claimType: ClaimType.EQ,
value: 15,
isSelectableByUser: true,
isOptional: true
});
claims[4] = _claimRequestBuilder.build({
groupId: 0xfae674b6cba3ff2f8ce2114defb200b1,
claimType: ClaimType.GTE,
value: 6,
isSelectableByUser: true,
isOptional: true
});
claims[5] = _claimRequestBuilder.build({
groupId: 0x1cde61966decb8600dfd0749bd371f12,
claimType: ClaimType.EQ,
value: 15,
isSelectableByUser: true,
isOptional: true
});
claims[6] = _claimRequestBuilder.build({
groupId: 0xda1c3726426d5639f4c6352c2c976b87,
claimType: ClaimType.GTE,
value: 1,
isSelectableByUser: true,
isOptional: true
});
SismoConnectVerifiedResult memory result = verify({
responseBytes: response,
auths: auths,
claims: claims,
signature: _signatureBuilder.build({message: abi.encode("I love Sismo!")})
});
uint256 vaultId = SismoConnectHelper.getUserId(result, AuthType.VAULT);
uint256 githubId = SismoConnectHelper.getUserId(result, AuthType.GITHUB);
uint256 telegramId = SismoConnectHelper.getUserId(result, AuthType.TELEGRAM);
uint256[] memory evmAccountIds = SismoConnectHelper.getUserIds(result, AuthType.EVM_ACCOUNT);
console.log("Vault ID: %s", vaultId);
console.log("Github ID: %s", githubId);
console.log("Telegram ID: %s", telegramId);
console.log("First EVM Account ID: %s", evmAccountIds[0]);
console.log("Second EVM Account ID: %s", evmAccountIds[1]);
}
}Refer to the Sismo Connect Solidity Library, the onchain app boilerplate or the onchain tutorial for more information.
