### Clone ZK Attestify Repository

Source: https://github.com/ethereum-attestation-service/eas-docs-site/blob/main/docs/zk--playbook/quickstart.md

Clones the ZK Attestify toolkit repository to your local machine. This repository contains all the necessary code and scripts for generating and verifying ZK attestations. Ensure you have Git installed.

```bash
git clone https://github.com/Shivannsh/ZKAttestify-Sp1-verifier.git
cd ZKAttestify-Sp1-verifier
```

--------------------------------

### Install Dependencies and Setup Project

Source: https://github.com/ethereum-attestation-service/eas-docs-site/blob/main/docs/tutorials/ceramic-storage.md

Clones the EAS repository, installs npm dependencies, and creates an .env file for environment variables. Requires Git and Node.js.

```bash
git clone https://github.com/ceramicstudio/ceramic-eas && cd ceramic-eas
npm install
touch .env
```

--------------------------------

### Start EAS Indexer with Docker Compose

Source: https://github.com/ethereum-attestation-service/eas-docs-site/blob/main/docs/quick--start/quickstart.md

This command starts the EAS indexer using Docker Compose. Ensure Docker is installed and configured. This tool allows you to quickly spin up your own EAS indexer on any EVM chain with deployed EAS contracts.

```bash
docker-compose up
```

--------------------------------

### Install Dependencies with Yarn

Source: https://github.com/ethereum-attestation-service/eas-docs-site/blob/main/README.md

Installs the project's dependencies using the Yarn package manager. This is a prerequisite for running other development or build commands.

```bash
$ yarn
```

--------------------------------

### Verify ZK Proof Locally with WASM

Source: https://github.com/ethereum-attestation-service/eas-docs-site/blob/main/docs/zk--playbook/quickstart.md

Installs dependencies and runs a test script to verify a generated JSON proof within a Node.js environment using the WASM verifier. This demonstrates local or browser-side proof verification. Requires Node.js, pnpm, and the WASM verifier build.

```bash
cd example/WASM_verifier
pnpm install
pnpm run test
```

--------------------------------

### Install EAS SDK using Yarn, npm, or pnpm

Source: https://github.com/ethereum-attestation-service/eas-docs-site/blob/main/docs/quick--start/quickstart.md

This snippet shows how to install the EAS SDK, a library that provides tools for seamless integration of EAS into projects. It supports multiple package managers for developer convenience.

```bash
yarn add @ethereum-attestation-service/eas-sdk
```

```bash
npm install @ethereum-attestation-service/eas-sdk
```

```bash
pnpm add @ethereum-attestation-service/eas-sdk
```

--------------------------------

### Start Local Development Server with Yarn

Source: https://github.com/ethereum-attestation-service/eas-docs-site/blob/main/README.md

Starts a local development server for the Docusaurus 2 website. This command enables live reloading for most changes, facilitating rapid development.

```bash
$ yarn start
```

--------------------------------

### Installation

Source: https://github.com/ethereum-attestation-service/eas-docs-site/blob/main/docs/developer-tools/eas-sdk.md

Instructions on how to install the EAS SDK using various package managers.

```APIDOC
## Installing the EAS SDK

To install the EAS SDK, run the following command within your project directory:

```sh
yarn add @ethereum-attestation-service/eas-sdk
```

OR

```sh
npm install @ethereum-attestation-service/eas-sdk
```

OR

```sh
pnpm add @ethereum-attestation-service/eas-sdk
```
```

--------------------------------

### Build WASM Verifier with wasm-pack

Source: https://github.com/ethereum-attestation-service/eas-docs-site/blob/main/docs/zk--playbook/quickstart.md

Compiles the Rust-based Groth16/Plonk verifier into a JavaScript-callable module using wasm-pack. This module can be used for in-browser or Node.js verification. Requires Rust, Cargo, and wasm-pack to be installed.

```bash
cd verifier
wasm-pack build --target nodejs --dev
```

--------------------------------

### Generate ZK Proofs with SP1 CLI

Source: https://github.com/ethereum-attestation-service/eas-docs-site/blob/main/docs/zk--playbook/quickstart.md

Generates Zero-Knowledge proofs using the Succinct SP1 prover. This command runs the age-checking program and produces proof files in JSON format. Supports both Groth16 and Plonk proof systems. Requires SP1 CLI and Rust with Cargo installed.

```bash
cd example/dob-script
cargo run --release -- --mode groth16 --prove
cargo run --release -- --mode plonk --prove
```

--------------------------------

### Onchain Attestation Verification Script

Source: https://github.com/ethereum-attestation-service/eas-docs-site/blob/main/docs/zk--playbook/quickstart.md

A Rust script to submit a generated ZK proof to an on-chain Solidity verifier contract. If the proof is valid, the contract verifies it and creates an EAS attestation. Requires RPC URL, private key, and contract address configured in a .env file.

```bash
# Setup .env file:
RPC_URL=https://sepolia.base.org
PRIVATE_KEY=your_private_key
CONTRACT_ADDRESS=The contract address

# Run the verification script:
cd example/solidity-verifier
cargo run --release
```

--------------------------------

### Run Application in Developer Mode Command

Source: https://github.com/ethereum-attestation-service/eas-docs-site/blob/main/docs/tutorials/ceramic-storage.md

Commands to set up and run the application in developer mode. It requires Node.js version 16 and uses npm to start the development server.

```bash
nvm use 16
npm run dev
```

--------------------------------

### Install EAS SDK with npm, yarn, or pnpm

Source: https://context7.com/ethereum-attestation-service/eas-docs-site/llms.txt

Installs the Ethereum Attestation Service (EAS) SDK package into your JavaScript/TypeScript project using your preferred package manager (npm, yarn, or pnpm). This is the first step to integrating EAS functionality into your application.

```bash
# Using npm
npm install @ethereum-attestation-service/eas-sdk

# Using yarn
yarn add @ethereum-attestation-service/eas-sdk

# Using pnpm
pnpm add @ethereum-attestation-service/eas-sdk
```

--------------------------------

### Generate Local Node Configuration

Source: https://github.com/ethereum-attestation-service/eas-docs-site/blob/main/docs/tutorials/ceramic-storage.md

Generates the necessary configuration files for running a local Ceramic node, including the ComposeDB server configuration and admin seed phrase. This script automates the setup process.

```bash
npm run generate
```

--------------------------------

### Build Static Website Assets with Yarn

Source: https://github.com/ethereum-attestation-service/eas-docs-site/blob/main/README.md

Generates the static content for the website, typically placed in a 'build' directory. This command is used to prepare the site for deployment on any static hosting service.

```bash
$ yarn build
```

--------------------------------

### Example Usage of useProvider Hook

Source: https://github.com/ethereum-attestation-service/eas-docs-site/blob/main/docs/developer-tools/sdk-wagmi.md

Shows how to utilize the useProvider hook to get an ethers-compatible provider from a wagmi public client. This is a fundamental usage pattern.

```typescript
import { useProvider } from './hooks'; // Assuming hooks are in './hooks'

function MyComponent() {
  const provider = useProvider();

  // You can now use the provider object with libraries that require an ethers provider
  // For example: 
  // const blockNumber = await provider.getBlockNumber();

  return (
    <div>
      {provider ? 'Provider obtained' : 'Getting provider...'}
    </div>
  );
}
```

--------------------------------

### EAS SDK Initialization

Source: https://github.com/ethereum-attestation-service/eas-docs-site/blob/main/docs/developer-tools/eas-sdk.md

Demonstrates how to import and initialize the EAS SDK with a provider.

```APIDOC
## Using the EAS SDK

Import and initialize the library

```javascript
import {
  EAS,
  Offchain,
  SchemaEncoder,
  SchemaRegistry,
} from "@ethereum-attestation-service/eas-sdk";
import { ethers } from "ethers";

export const EASContractAddress = "0xC2679fBD37d54388Ce493F1DB75320D236e1815e"; // Sepolia v0.26

// Initialize the sdk with the address of the EAS Schema contract address
const eas = new EAS(EASContractAddress);

// Gets a default provider (in production use something else like infura/alchemy)
const provider = ethers.getDefaultProvider("sepolia");

// Connects an ethers style provider/signingProvider to perform read/write functions.
// MUST be a signer to do write operations!
eas.connect(provider);
```
```

--------------------------------

### Deploy Website with Yarn (SSH)

Source: https://github.com/ethereum-attestation-service/eas-docs-site/blob/main/README.md

Deploys the built website using SSH. This command is a convenient way to build the site and push it to the 'gh-pages' branch, suitable for hosting services like GitHub Pages.

```bash
$ USE_SSH=true yarn deploy
```

--------------------------------

### Deploy Website with Yarn (No SSH)

Source: https://github.com/ethereum-attestation-service/eas-docs-site/blob/main/README.md

Deploys the built website without using SSH, requiring the user's GitHub username. This command builds the site and pushes it to the 'gh-pages' branch for hosting.

```bash
$ GIT_USER=<Your GitHub username> yarn deploy
```

--------------------------------

### Example Usage of useSigner Hook

Source: https://github.com/ethereum-attestation-service/eas-docs-site/blob/main/docs/developer-tools/sdk-wagmi.md

Demonstrates how to use the useSigner hook to obtain an ethers-compatible signer from a wagmi wallet client. This is a basic usage example.

```typescript
import { useSigner } from './hooks'; // Assuming hooks are in './hooks'

function MyComponent() {
  const signer = useSigner();

  // Now you can use the signer object with libraries that expect an ethers signer
  // For example: 
  // const eas = new EAS(signer);

  return (
    <div>
      {signer ? 'Signer obtained' : 'Getting signer...'}
    </div>
  );
}
```

--------------------------------

### Install EAS Contracts with pnpm

Source: https://github.com/ethereum-attestation-service/eas-docs-site/blob/main/docs/quick--start/contracts.md

This command installs the Ethereum Attestation Service (EAS) contracts package using the pnpm package manager. This is a prerequisite for using EAS functionalities in your project.

```sh
pnpm add @ethereum-attestation-service/eas-contracts
```

--------------------------------

### Initialize EAS SDK with Ethereum Provider

Source: https://github.com/ethereum-attestation-service/eas-docs-site/blob/main/docs/developer-tools/eas-sdk.md

Demonstrates how to import and initialize the EAS SDK using an ethers.js provider. It covers connecting to a specific network (e.g., Sepolia) and binding the provider to the EAS instance for read/write operations.

```javascript
import {
  EAS,
  Offchain,
  SchemaEncoder,
  SchemaRegistry,
} from "@ethereum-attestation-service/eas-sdk";
import { ethers } from "ethers";

export const EASContractAddress = "0xC2679fBD37d54388Ce493F1DB75320D236e1815e"; // Sepolia v0.26

// Initialize the sdk with the address of the EAS Schema contract address
const eas = new EAS(EASContractAddress);

// Gets a default provider (in production use something else like infura/alchemy)
const provider = ethers.getDefaultProvider("sepolia");

// Connects an ethers style provider/signingProvider to perform read/write functions.
// MUST be a signer to do write operations!
eas.connect(provider);
```