Skip to content

Latest commit

 

History

History
96 lines (70 loc) · 3.47 KB

README.md

File metadata and controls

96 lines (70 loc) · 3.47 KB
Raw

Attestation Sandbox

Note

This is a sandbox exploring attestation registries for evm rollups

Note

Work around a UI for creating schemas can be found in the apps/nextjs directory

Note

Smart contracts are implemented in Cairo a super-set of Rust check the /packages/cairo for more and run the integration test scripts to programmatically interact with the registry contracts

src-registry

About

Reputation systems rely on attestations across various blockchain networks in Web3. Being able to attest to an activity is a powerful way to prove participation, ownership, or association. This concept has been prevalent with the POAP (Proof of Attendance Protocol) paradigm, and we are now seeing a surge in RWA (Real World Asset) tokenizations, Web3 talent verification, events, community participation, and more.

Attestation registries provide a permissionless and decentralized way to create a Proof of X for any use case that requires proving an affiliation to an activity on-chain.

Repository structure

It uses Turborepo and contains:

.github
  └─ workflows
        └─ CI with pnpm cache setup
.vscode
  └─ Recommended extensions and settings for VSCode users
apps
  ├─ auth-proxy
  |   ├─ Nitro server to proxy OAuth requests in preview deployments
  |   └─ Uses Auth.js Core
  └─ next.js
      ├─ Next.js 14
      ├─ React 18
      ├─ Tailwind CSS
      └─ E2E Typesafe API Server & Client
packages
  ├─ api
  |   └─ tRPC v11 router definition
  ├─ auth
  |   └─ Authentication using next-auth.
  ├─ cairo
  |   └─ Smart contract layer for the registry
  ├─ db
  |   └─ Typesafe db calls using Drizzle & Supabase
  └─ ui
      └─ Start of a UI package for the webapp using shadcn-ui
tooling
  ├─ eslint
  |   └─ shared, fine-grained, eslint presets
  ├─ prettier
  |   └─ shared prettier configuration
  ├─ tailwind
  |   └─ shared tailwind configuration
  └─ typescript
      └─ shared tsconfig you can extend from

In this repo, we use @attestbox as a placeholder for package names. As a user, you might want to replace it with your own organization or project name.

Quick Start

Note The db package is preconfigured to use Supabase and is edge-bound with the Vercel Postgres driver. If you're using something else, make the necessary modifications to the schema as well as the client and the drizzle config. If you want to switch to non-edge database driver, remove export const runtime = "edge"; from all pages and api routes.

1. Setup dependencies

To get it running, follow the steps below:

  1. Clone this repository
  2. Follow the README in the packages/cairo directory to set up and interact with the smart contracts
  3. Navigate to the apps/nextjs directory to work with the schema creation UI
# Install dependencies
pnpm i

# Configure environment variables
# There is an `.env.example` in the root directory you can use for reference
cp .env.example .env

# Push the Drizzle schema to the database
pnpm db:push