LogoLogo
  • About
    • Introduction
    • Unlockd SDK
    • Partners & Revenue Sharing
  • Getting Started
    • Installation
    • SDK Modules
      • Action Module
      • Auction Module
      • Market Module
      • Buy Now Module
      • Sell Now Module
      • Wallet Module
      • NFT Batch Transfer Module
    • Code Examples
      • Borrowing Assets
      • Fetch prices
      • Login
      • Borrow Signature
      • Minimum Repay
      • Liquidation Price
      • Health Factor
      • Available to borrow
    • UI Snippets
    • Reservoir Integration
  • USE CASES (code examples)
    • Borrow against RWAs
    • 'Buy Now, Pay Later' financing
  • Resources
    • npmJS Package
    • Best Practices
    • Changelog
    • Support & Contact
    • Unlockd V2
    • Product Documentation
    • Protocol Documentation
    • Risk Documentation
    • External Audits
    • Website
    • X (Twitter)
    • Discord
    • Other links
Powered by GitBook
On this page
  • Types
  • ClientOptions
  • Functions
  • Creating a Wallet
  • Retrieving the User's Wallet Address
Export as PDF
  1. Getting Started
  2. SDK Modules

Wallet Module

The Wallet module provides functionality for creating and managing Unlockd abstract wallets.

PreviousSell Now ModuleNextNFT Batch Transfer Module

Last updated 12 months ago

Types

ClientOptions

export type ClientOptions = {
  network?: Chain
}

export type Chain = 'mainnet' | 'sepolia' | 'localhost'

Functions

Creating a Wallet

To create an Unlockd abstract wallet, use the createWallet function from the wallet module:

export const createWallet = async (
        options?: ClientOptions
    ):Promise<void>
const result = await createWallet(options?);

Refer to the Wallet Module documentation for more details on the createWallet function.

Retrieving the User's Wallet Address

To retrieve the wallet address of the user, use the getWallet function from the wallet module:

export const getWallet = async (
        options?: ClientOptions
    ): Promise<any>
const result = await getWallet(options?);

Refer to the Wallet Module documentation for more details on the getWallet function.

Wallet Flow