Skip to content

tetherto/wdk-wallet-solana

Repository files navigation

@tetherto/wdk-wallet-solana

npm version npm downloads license docs

Note: This package is currently in beta. Please test thoroughly in development environments before using in production.

A simple and secure package to manage SLIP-0010 wallets for the Solana blockchain. This package provides a clean API for creating, managing, and interacting with Solana wallets using BIP-39 seed phrases and Solana-specific derivation paths.

About WDK

This module is part of the WDK (Wallet Development Kit) project, which empowers developers to build secure, non-custodial wallets with unified blockchain access, stateless architecture, and complete user control.

For detailed documentation about the complete WDK ecosystem, visit docs.wdk.tether.io.

Installation

npm install @tetherto/wdk-wallet-solana

Quick Start

import WalletManagerSolana from '@tetherto/wdk-wallet-solana'

const seedPhrase = 'abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about'

const wallet = new WalletManagerSolana(seedPhrase, {
  provider: 'https://api.devnet.solana.com',
  commitment: 'confirmed',
})

const account = await wallet.getAccount(0)
const address = await account.getAddress()
console.log('Address:', address)

wallet.dispose()

Key Capabilities

  • SLIP-0010 Derivation Paths: Standard Solana derivation support (m/44'/501')
  • Multi-Account Management: Derive multiple accounts from a single seed phrase
  • Native SOL Transactions: Quote and send SOL transfers through a unified wallet API
  • SPL Token Support: Query balances and transfer SPL tokens
  • Message Signing: Sign messages and verify signatures with Solana accounts
  • Fee Estimation: Retrieve current network fee rates and quote transaction costs
  • Read-Only Accounts: Monitor any Solana address without a private key
  • Secure Memory Disposal: Clear private keys from memory when done

Compatibility

  • Solana Mainnet Beta
  • Solana Testnet
  • Solana Devnet
  • Standard Solana RPC Providers that support account, balance, and fee queries

Documentation

Topic Description Link
Overview Module overview and feature summary Wallet Solana Overview
Usage End-to-end integration walkthrough Wallet Solana Usage
Configuration RPC, commitment, and transfer configuration Wallet Solana Configuration
API Reference Complete class and type reference Wallet Solana API Reference

Examples

Example Description
Create Wallet Initialize a wallet manager and derive Solana accounts from a seed phrase
Manage Accounts Work with multiple accounts and custom SLIP-0010 derivation paths
Check Balances Query native SOL and SPL token balances for owned accounts
Read-Only Account Monitor balances for any Solana address without a private key
Send Transaction Estimate fees and send native SOL transactions
Token Transfer Transfer SPL tokens and estimate transfer fees
Sign & Verify Message Sign messages and verify signatures
Fee Management Retrieve current network fee rates
Memory Management Securely dispose wallets and clear private keys from memory

For detailed walkthroughs, see the Usage Guide. See all runnable examples in the wdk-examples repository.

Community

Join the WDK Discord to connect with other developers.

Support

For support, please open an issue on GitHub or reach out via email.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

About

WDK module to manage BIP-44 wallets for the Solana blockchain.

Topics

Resources

License

Stars

1 star

Watchers

0 watching

Forks

Packages

 
 
 

Contributors