Skip to content

README.md

Latest commit

 

History

History
77 lines (50 loc) · 1.87 KB

README.md

File metadata and controls

77 lines (50 loc) · 1.87 KB

Permit3 API Reference

This section provides comprehensive API documentation for Permit3.

Available Documentation

Document Description
API Reference Complete reference of all interfaces and functions
Data Structures Detailed documentation of Permit3 data structures
Events Documentation of all events emitted by Permit3
Error Codes List of error codes and their meanings
Interfaces Documentation of Permit3 interfaces

Key Interfaces

IPermit3

The main interface for Permit3, extending IPermit and INonceManager.

interface IPermit3 is IPermit, INonceManager {
    // Functions defined in api-reference.md
}

IPermit

Interface for backwards compatibility with Permit2.

interface IPermit {
    // Functions for standard permits and transfers
}

INonceManager

Interface for nonce management and signature validation.

interface INonceManager {
    // Functions for nonce management
}

Function Categories

Standard Permit Functions

Functions for processing standard permits (single-chain and cross-chain).

Witness Permit Functions

Functions for processing permits with witness data for enhanced verification.

Token Transfer Functions

Functions for transferring tokens using permits or allowances.

Allowance Management Functions

Functions for managing token allowances with flexible modes.

Nonce Management Functions

Functions for handling nonces to prevent replay attacks.

Using the API

For practical examples of using the Permit3 API, see the 💻 Examples section.