LayerG Universal Account SDK API Reference
Welcome to the API reference documentation for the LayerG Universal Account SDK. This section provides detailed information about the SDK packages, their components, and how to use them in your applications.
SDK Packages
The LayerG Universal Account SDK consists of several packages, each serving a specific purpose:
@layerg-ua-sdk/aa-sdk
The core package that provides the main functionality for working with Universal Accounts. This package includes:
- Providers: Connect to the blockchain and manage authentication
- Account APIs: Create and manage Universal Accounts
- Contract Calls: Interact with smart contracts through Universal Accounts
@layerg-ua-sdk/aa-smc
The smart contract package that provides tools for working with the LayerG Universal Account smart contracts, including:
- Contract ABIs and interfaces
- Contract deployment utilities
- Contract interaction helpers
@layerg-ua-sdk/aa-utils
A collection of utility functions for common tasks such as:
- Data formatting
- Signature creation and verification
- Transaction handling
- Log decoding
@layerg-ua-sdk/aa-validation
Validation utilities to ensure the integrity and correctness of operations, including:
- Transaction validation
- Input validation
- Security validation
- Data validation
Getting Started with the API
If you're new to the LayerG Universal Account SDK, we recommend starting with the Quick Start Guide to get a basic understanding of how the SDK works.
For more detailed information about specific functionality, browse the sidebar to find the relevant API documentation.
API Structure
Each API reference page follows a consistent structure:
- Overview: A brief description of the component or functionality
- Methods: Detailed information about available methods, including:
- Method signatures
- Parameter descriptions
- Return values
- Example usage
- Types and Interfaces: Information about relevant TypeScript types and interfaces
- Examples: Code examples showing common usage patterns