# Gatekeeper SDK

> Type-safe utilities for the Gatekeeper ticketing protocol

## Docs

- [Getting Started](/getting-started.md): Only install `@ponder/client` if you plan to use the indexed data client. `viem` is only required if you intend to send transactions or read onchain state; the SDK itself just prepares calldata.
- [ABIs](/reference/abis.md): Contract ABIs and config objects exported from the SDK.
- [Contract Addresses](/reference/addresses.md): Deployed contract addresses for the Gatekeeper protocol.
- [Constants](/reference/constants.md): Protocol constants exported from the SDK.
- [Deploying Contracts](/guides/deploying.md): Deploy Gatekeeper1155 contracts via the factory using CREATE2 for deterministic addresses.
- [Executing Purchases](/guides/purchasing.md): Gatekeeper pulls payment tokens from the buyer. If `totalPrice` is greater than zero, the buyer must approve the Gatekeeper contract to spend the sale currency (the `SaleKey.currency` address) before calling `purchase` or `purchaseWithApproval`.
- [Querying Indexed Data](/guides/querying.md): The `url` should point to your Ponder SQL endpoint.
- [Quickstart](/guides/quickstart.md): A minimal, end-to-end path to deploy a contract, register a sale, sell tickets, and withdraw funds.
- [Role Management](/guides/roles.md): Grant roles to addresses. Requires `ADMIN_ROLE` (the owner is also permitted).
- [Managing Sales](/guides/sales.md): Sales are identified by a `SaleKey` and configured with a `SaleState`.
- [Ticket Management](/guides/tickets.md): Admin mint tickets to recipients. Requires `MINTER_ROLE`, `HOST_ROLE`, or `ADMIN_ROLE` (the owner is also permitted).
- [Approval](/api/approval.md): EIP-712 typed data utilities for purchase approval signatures.
- [Balance](/api/balance.md): Query token holder balances.
- [Client](/api/client.md): Query indexed blockchain data via Ponder.
- [Errors](/api/errors.md): Error handling utilities with structured error hierarchy and error chaining.
- [EventContract](/api/event-contract.md): Query deployed Gatekeeper1155 contracts.
- [Factory](/api/factory.md): Utilities for deploying Gatekeeper1155 contracts via the factory pattern.
- [Gatekeeper1155](/api/gatekeeper-1155.md): Utilities for ERC1155 token operations on Gatekeeper1155 contracts.
- [Gatekeeper](/api/gatekeeper.md): Utilities for managing sales and executing purchases on the Gatekeeper protocol.
- [API Reference](/api.md): Complete API documentation for the Gatekeeper SDK.
- [Permission](/api/permission.md): Query user permissions and role grants on contracts.
- [Sale](/api/sale.md): Sale types, schemas, and utilities for the Gatekeeper protocol.
- [Stub](/api/stub.md): Query stubbing events (check-ins where tickets are exchanged for stubs).
- [TicketIntent](/api/ticket-intent.md): EIP-712 typed data for ticket intent signatures.
- [Tier](/api/tier.md): Query ticket tier configurations.
- [Token](/api/token.md): ERC1155 Token types and utilities.
- [Transfer](/api/transfer.md): Query ERC1155 transfer history.
- [Validators](/api/validators.md): Zod schemas for validating Ethereum primitives.
- [Void](/api/void.md): Query voiding events (ticket burns without stub conversion).