Skip to content

Consensys/linea-attestation-registry

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

494 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


Verax
Verax Attestation Registry

Verax is a shared registry for storing attestations of public interest on EVM chains, designed to improve discoverability and reuse across applications.

LinksRepository OrganisationGlobal SetupWorkspace QuickstartEnvironment FilesContributingContracts AddressesSubgraphs URLsNetwork PrefixesDeployment and Release NotesLicense

Links

Statuses

Lint Contracts Examples Subgraph SDK Explorer

npm npm

Repository Organisation

Workspace Purpose Contributor guide
contracts/ Core registries, deploy scripts, upgrade scripts, published contracts package contracts/README.md
examples/ Example portals/modules and example-contract CI workspace examples/README.md
sdk/ TypeScript SDK, generated Graph client, examples and tests sdk/README.md
subgraph/ Graph manifests, mappings, tests and Studio deploy scripts subgraph/README.md
explorer/ Public Verax explorer frontend explorer/README.md
tutorial/ Demo/tutorial app built on top of the SDK tutorial/README.md
doc/ GitBook source for the published docs GitBook entrypoint lives in doc/README.md

Global Setup

CI reads Node.js and pnpm directly from the root package.json. On this branch, that means:

  • Node.js 24.14.1
  • pnpm 10.32.1

Install dependencies once from the monorepo root:

pnpm install

Foundry is required when working on contracts/ or examples/. Other workspaces use the root Node.js/pnpm toolchain plus package-local scripts.

Workspace Quickstart

Run the commands below from the monorepo root.

Area Common commands Notes
Contracts pnpm --filter @verax-attestation-registry/verax-contracts build / test Requires Foundry
Examples pnpm --filter @verax-attestation-registry/verax-examples build / test Requires Foundry
SDK pnpm --filter @verax-attestation-registry/verax-sdk test:unit / test:integration Uses .env.example
Subgraph pnpm --filter linea-attestation-registry-subgraph build:linea-sepolia / test Deploys to The Graph Studio
Explorer pnpm --filter verax-explorer dev / build Uses VITE_* env vars
Tutorial pnpm --filter @verax-attestation-registry/verax-tutorial dev / build Demo app, no dedicated CI workflow today

Each workspace README describes the maintainer workflow for that package in more detail.

Environment Files

Workspace Expected file Purpose
contracts/ contracts/.env copied from contracts/env/.env.<network> Deployments, upgrades, explorer verification, reimport
sdk/ sdk/.env copied from sdk/.env.example Examples and integration tests
explorer/ explorer/.env copied from explorer/.env.example WalletConnect, Infura, The Graph gateway
tutorial/ tutorial/.env copied from tutorial/.env.example WalletConnect and Infura for the demo app
subgraph/ No repo-local .env.example Use graph auth <ACCESS_TOKEN> when deploying

Contributing

Day-to-day contributions target dev. For contributor workflow, review expectations, package-specific validation, and maintainer/community process, see CONTRIBUTING.md.

Contracts Addresses

The core registry and AttestationReader addresses below are sourced from the deployment env templates under contracts/env/ and aligned with the SDK defaults. The standard library addresses are the current published deployments tracked in this repository and should be updated alongside deployment work.

Linea Sepolia
Linea Mainnet
Arbitrum Sepolia
Arbitrum Mainnet
Base Sepolia
Base Mainnet
BSC Testnet
BSC Mainnet

Subgraphs URLs

These URLs should stay aligned across:

Network Prefixes

Attestation IDs embed a 32-byte chain prefix. The short forms below correspond to the values declared in contracts/script/utils.ts.

  • Linea Sepolia - 0x0000
  • Linea Mainnet - 0x0000
  • Arbitrum Sepolia - 0x0001
  • Arbitrum Mainnet - 0x0001
  • Base Sepolia - 0x0005
  • Base Mainnet - 0x0005
  • BSC Testnet - 0x0006
  • BSC Mainnet - 0x0006
  • Ethereum Sepolia - 0x0008

Deployment and Release Notes

Adding or updating a public Verax deployment usually touches more than one workspace:

  1. Deploy or upgrade the core contracts in contracts/.
  2. Build and publish the matching subgraph deployment in subgraph/.
  3. Update SDK defaults and fallback URLs in sdk/.
  4. Update explorer network config and gateway overrides in explorer/.
  5. Update this root README if public addresses, subgraph URLs, or prefixes changed.

Releases are currently maintainers-only and run through the manual releaser.yml workflow, which merges dev into main and then rebases dev onto main.

License

License

About

Verax is a shared registry for storing attestations of public interest on EVM chains, designed to enhance data discoverability and consumption for dApps across the network.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Contributors