Access Control Indexers

OpenZeppelin Access Control and Ownable event indexers for multiple blockchain networks.

Overview

This monorepo contains SubQuery indexers for indexing OpenZeppelin Access Control and Ownable events across multiple blockchain networks:

• EVM Networks: Ethereum, Arbitrum, Polygon, Base, Optimism, and more
• Stellar Networks: Mainnet and Testnet

Run pnpm run build:network --list to see all supported networks.

All indexers output a unified GraphQL schema, enabling single-app consumption without network-specific customization.

Structure

├── packages/
│   ├── schema/          # Unified GraphQL schema
│   ├── common/          # Shared utilities and types
│   ├── evm-handlers/    # Shared EVM mapping handlers (single source of truth)
│   ├── network-config/  # Network definitions
│   └── client/          # Query SDK
├── networks/
│   ├── evm/             # EVM network indexers (lightweight wrappers)
│   └── stellar/         # Stellar network indexers
├── playgrounds/
│   ├── evm/             # EVM test contracts
│   └── stellar/         # Stellar test contracts
└── scripts/             # Utility scripts

Architecture

Shared Handlers (EVM)

All EVM networks use a single shared handler implementation from @oz-indexers/evm-handlers. Each network's index.ts is a lightweight wrapper that:

1. Imports generated types from SubQuery codegen
2. Initializes the shared handlers with network-specific configuration
3. Re-exports the handlers for SubQuery to discover

// Example: networks/evm/ethereum-mainnet/src/index.ts
import { initializeHandlers, handleRoleGranted, ... } from '@oz-indexers/evm-handlers';
import { AccessControlEvent, RoleMembership, ... } from './types';

initializeHandlers({
  networkId: 'ethereum-mainnet',
  entities: { AccessControlEvent, RoleMembership, ContractOwnership, Contract },
  store,
});

export { handleRoleGranted, handleRoleRevoked, ... };

Benefits:

• Single source of truth for handler logic
• Bug fixes propagate to all networks automatically
• Minimal code duplication
• No risk of handler drift between networks

Quick Start

# Install dependencies
pnpm install

# Build all packages
pnpm build

# Run tests
pnpm test

Building Networks

Build a Specific Network (with codegen)

The build:network command runs codegen to regenerate types from the schema, then builds the project:

# Build any network by name
pnpm run build:network ethereum-mainnet
pnpm run build:network stellar-testnet
pnpm run build:network polygon-amoy

# List all available networks
pnpm run build:network --list

# Build all networks
pnpm run build:network --all

Build by Ecosystem

# Build all EVM networks
pnpm run build:evm

# Build all Stellar networks
pnpm run build:stellar

# Codegen only (regenerate types)
pnpm run codegen           # All networks
pnpm run codegen:evm       # EVM networks only
pnpm run codegen:stellar   # Stellar networks only

Build a Specific Package Directly

pnpm --filter @oz-indexers/ethereum-mainnet build

Supported Networks

EVM Mainnets

• Ethereum, Arbitrum One, Polygon, Polygon zkEVM, Base
• BNB Smart Chain, OP Mainnet, Avalanche C-Chain
• ZkSync Era, Scroll, Linea
• Polkadot Hub, Moonbeam, Moonriver

EVM Testnets

• Sepolia, Arbitrum Sepolia, Polygon Amoy, Polygon zkEVM Cardona
• Base Sepolia, BSC Testnet, OP Sepolia, Avalanche Fuji
• ZkSync Era Sepolia, Scroll Sepolia, Linea Sepolia, Monad Testnet
• Polkadot Hub Testnet, Moonbase Alpha

Stellar

• Mainnet, Testnet

Unified Schema

All indexers output the same GraphQL schema with these entities:

• AccessControlEvent - Historical event log
• RoleMembership - Current role assignments
• ContractOwnership - Current ownership state
• Contract - Contract metadata

See packages/schema/schema.graphql for the full schema.

OpenZeppelin Event Coverage

This indexer provides complete coverage of all OpenZeppelin Access Control and Ownable contract events.

EVM Event Coverage

Contract	Event	Handler	Status
AccessControl	RoleGranted(bytes32,address,address)	handleRoleGranted	✅
AccessControl	RoleRevoked(bytes32,address,address)	handleRoleRevoked	✅
AccessControl	RoleAdminChanged(bytes32,bytes32,bytes32)	handleRoleAdminChanged	✅
Ownable	OwnershipTransferred(address,address)	handleOwnershipTransferred	✅
Ownable2Step	OwnershipTransferStarted(address,address)	handleOwnershipTransferStarted	✅
AccessControlDefaultAdminRules	DefaultAdminTransferScheduled(address,uint48)	handleDefaultAdminTransferScheduled	✅
AccessControlDefaultAdminRules	DefaultAdminTransferCanceled()	handleDefaultAdminTransferCanceled	✅
AccessControlDefaultAdminRules	DefaultAdminDelayChangeScheduled(uint48,uint48)	handleDefaultAdminDelayChangeScheduled	✅
AccessControlDefaultAdminRules	DefaultAdminDelayChangeCanceled()	handleDefaultAdminDelayChangeCanceled	✅

Stellar Event Coverage

Module	Event	Handler	Status
Access Control	role_granted	handleRoleGranted	✅
Access Control	role_revoked	handleRoleRevoked	✅
Access Control	role_admin_changed	handleRoleAdminChanged	✅
Access Control	admin_transfer_initiated	handleAdminTransferInitiated	✅
Access Control	admin_transfer_completed	handleAdminTransferCompleted	✅
Access Control	admin_renounced	handleAdminRenounced	✅
Ownable	ownership_transfer	handleOwnershipTransferStarted	✅
Ownable	ownership_transfer_completed	handleOwnershipTransferCompleted	✅
Ownable	ownership_renounced	handleOwnershipRenounced	✅

Event Types (GraphQL Enum)

enum EventType {
  # Role events (EVM + Stellar)
  ROLE_GRANTED
  ROLE_REVOKED
  ROLE_ADMIN_CHANGED

  # Ownership events (EVM + Stellar)
  OWNERSHIP_TRANSFER_COMPLETED
  OWNERSHIP_TRANSFER_STARTED
  OWNERSHIP_RENOUNCED

  # Admin events (Stellar only)
  ADMIN_TRANSFER_INITIATED
  ADMIN_TRANSFER_COMPLETED
  ADMIN_RENOUNCED

  # Default admin events (EVM AccessControlDefaultAdminRules)
  DEFAULT_ADMIN_TRANSFER_SCHEDULED
  DEFAULT_ADMIN_TRANSFER_CANCELED
  DEFAULT_ADMIN_DELAY_CHANGE_SCHEDULED
  DEFAULT_ADMIN_DELAY_CHANGE_CANCELED
}

Verification Checklist

#	Requirement	Status	Evidence
1	All AccessControl base events indexed	✅	RoleGranted, RoleRevoked, RoleAdminChanged
2	All Ownable events indexed	✅	OwnershipTransferred with renounce detection
3	All Ownable2Step events indexed	✅	OwnershipTransferStarted
4	All AccessControlDefaultAdminRules events indexed	✅	4 DefaultAdmin events
5	All Stellar Access Control events indexed	✅	6 events including admin transfer
6	All Stellar Ownable events indexed	✅	3 ownership events
7	RoleMembership state tracking	✅	Created on grant, removed on revoke
8	ContractOwnership state tracking	✅	Updated on transfer, tracks pending
9	Contract metadata tracking	✅	Type classification (AC/Ownable/Both)
10	Network field in all entities	✅	Multi-network query support
11	UI Builder adapter compatibility	✅	Schema matches adapter expectations
12	ABI files for all contracts	✅	AccessControl, Ownable, Ownable2Step, AccessControlDefaultAdminRules

Available Scripts

Command	Description
pnpm run build	Build all packages and networks
pnpm run build:network <name>	Build a specific network with codegen
pnpm run build:network --list	List all available networks
pnpm run build:evm	Build all EVM networks
pnpm run build:stellar	Build all Stellar networks
pnpm run codegen	Regenerate types for all networks
pnpm run codegen:evm	Regenerate types for EVM networks
pnpm run codegen:stellar	Regenerate types for Stellar networks
pnpm run test	Run all tests
pnpm run lint	Lint all packages
pnpm run clean	Clean build artifacts
pnpm run generate:network	Generate a new network from template
pnpm run sync:schema	Sync schema across all networks

Git Hooks

This repo uses Husky for git hooks:

• pre-commit: Runs sync:schema to verify all networks reference the shared schema correctly

Hooks are automatically installed when you run pnpm install.

Documentation

• Architecture
• Adding a Network
• Versioning

License

MIT