Welcome to the documentation for Wallet Infra SDK! This guide will help you navigate our powerful toolkit for managing wallets, transactions, and assets within the Brillion ecosystem.
Install the Wallet Infra SDK into your project with a single command:
npm install @brillionfi/wallet-infra-sdkVisit the Brillion Dashboard to set up your organization and create your first application. This process will give you a unique API key (appId).
To start using the SDK, you need to initialize it with your API key:
import { WalletInfra } from '@brillionfi/wallet-infra-sdk';
// Initialize the SDK
const appId = 'your-app-id';
const baseUrl = 'your-base-url';
const walletInfra = new WalletInfra(appId, baseUrl);Note
Make sure to replace "your-app-id" with the actual API key you obtained from the Brillion Dashboard.
The Wallet Infra SDK is organized into several modules, each handling specific functionalities:
The Authentication module handles user creation and authentication:
The Wallet module provides functionality for creating and managing wallets:
- Wallet Interface
- Create Wallet
- Get Wallets
- Wallet Recovery
- Get Wallet Portfolio
- Get Transaction History
- Get Wallet Nonce
- Gas Configuration
- Get Gas Fees
- Sign Transaction
The Token module provides functionality for retrieving information about tokens on a network:
The Transaction module handles the management of wallet transactions, retrieving transaction details, and estimating gas costs:
- Transaction Interface
- Create Signed Transaction
- Create Unsigned Transaction
- Get Transaction
- Approve Sign Transaction
- Reject Sign Transaction
- Cancel Transaction
The KYC module handles KYC management to create a KYC session
Now that you're familiar with the structure of the Wallet Infra SDK, you can dive deeper into each module based on your specific needs.
Check out our Simple Wallet Demo to see the Wallet Infra SDK in action.
If you encounter any issues or have questions, please open an issue or contact the Brillion support team.