Package Exports

p-sdk-wallet
p-sdk-wallet/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (p-sdk-wallet) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

PWC Wallet SDK

A comprehensive, secure, and user-friendly wallet SDK for React Native applications. This SDK provides a complete solution for managing cryptocurrency wallets with support for multiple blockchains, HD wallet generation, vanity addresses, and advanced features like multi-transfer operations.

Features

🔐 Secure HD Wallet Management: BIP-44 compliant hierarchical deterministic wallets
🎯 Vanity Address Generation: Generate wallets with custom address prefixes
🔗 Multi-Chain Support: Ethereum, BSC, Polygon, Arbitrum, Optimism, Base, and Solana
🚀 Multi-Transfer Operations: Batch send tokens to multiple recipients
🔧 Custom Chain Support: Add custom chains and override built-in configurations
📱 React Native Optimized: Designed specifically for mobile applications
🔒 Encryption: AES-256 encryption for secure vault storage
🎨 TypeScript: Full TypeScript support with comprehensive type definitions

Installation

npm install pwc-wallet-sdk

Quick Start

1. Basic Wallet Creation

import { Vault } from 'pwc-wallet-sdk';

// Create a new wallet
const { vault, encryptedVault } = await Vault.createNew('your-secure-password');

// Get wallet accounts
const accounts = vault.getAccounts();
console.log('Wallet addresses:', accounts.map(acc => acc.address));

2. Vanity Wallet Generation

// Generate wallet with custom address prefix
const { vault, encryptedVault, attempts, foundAddress } = 
  await Vault.generateVanityHDWallet('your-password', (attempts, currentAddress) => {
    console.log(`Attempt ${attempts}: ${currentAddress}`);
  });

console.log(`Found address with prefix after ${attempts} attempts: ${foundAddress}`);

3. Custom Chain Configuration

import { setupChainConfigs, registerCustomChain, overrideChain } from 'pwc-wallet-sdk';

// Setup custom chains and overrides (call once when app starts)
setupChainConfigs({
  // Override built-in chains
  overrides: {
    '1': { rpcUrl: 'https://my-eth-rpc.com' }, // Use custom Ethereum RPC
    '56': { rpcUrl: 'https://my-bsc-rpc.com' }, // Use custom BSC RPC
  },
  // Add custom chains
  customChains: {
    'custom-1': {
      name: 'My Custom Chain',
      rpcUrl: 'https://my-custom-rpc.com',
      explorerUrl: 'https://my-explorer.com',
      nativeCurrency: { name: 'Token', symbol: 'TKN', decimals: 18 },
      type: 'evm'
    },
    'custom-solana': {
      name: 'My Solana Chain',
      rpcUrl: 'https://my-solana-rpc.com',
      explorerUrl: 'https://my-solana-explorer.com',
      nativeCurrency: { name: 'SOL', symbol: 'SOL', decimals: 9 },
      type: 'solana'
    }
  }
});

// Load vault
const vault = await Vault.load(password, encryptedVault);

// Use custom chains normally
await vault.sendToken(from, to, amount, tokenAddress, 'custom-1');
await vault.getNativeBalance(address, 'custom-solana');

React Native Usage

Simple Wallet Component

import React, { useState, useEffect } from 'react';
import { Vault, setupChainConfigs } from 'pwc-wallet-sdk';

const WalletComponent = () => {
  const [vault, setVault] = useState(null);
  const [balance, setBalance] = useState('0');

  useEffect(() => {
    // Setup custom chains when component mounts
    setupChainConfigs({
      overrides: {
        '1': { rpcUrl: 'https://my-eth-rpc.com' }
      },
      customChains: {
        'custom-1': {
          name: 'My Chain',
          rpcUrl: 'https://my-rpc.com',
          type: 'evm'
        }
      }
    });

    loadWallet();
  }, []);

  const loadWallet = async () => {
    try {
      const loadedVault = await Vault.load(password, encryptedVault);
      setVault(loadedVault);
      
      // Get balance using custom chain
      const balance = await loadedVault.getNativeBalance(address, 'custom-1');
      setBalance(ethers.formatEther(balance));
    } catch (error) {
      console.error('Failed to load wallet:', error);
    }
  };

  const sendTransaction = async () => {
    if (!vault) return;
    
    try {
      // Send using custom chain
      const tx = await vault.sendToken(from, to, amount, tokenAddress, 'custom-1');
      console.log('Transaction sent:', tx.hash);
    } catch (error) {
      console.error('Transaction failed:', error);
    }
  };

  return (
    <View>
      <Text>Balance: {balance}</Text>
      <Button title="Send Transaction" onPress={sendTransaction} />
    </View>
  );
};

Custom Hook for Wallet Management

import { useState, useEffect } from 'react';
import { Vault, setupChainConfigs } from 'pwc-wallet-sdk';

export const useWallet = (password: string, encryptedVault: EncryptedData) => {
  const [vault, setVault] = useState(null);
  const [loading, setLoading] = useState(true);
  const [error, setError] = useState(null);

  useEffect(() => {
    initializeWallet();
  }, []);

  const initializeWallet = async () => {
    try {
      setLoading(true);
      
      // Setup chains
      setupChainConfigs({
        overrides: {
          '1': { rpcUrl: 'https://my-eth-rpc.com' }
        }
      });

      const loadedVault = await Vault.load(password, encryptedVault);
      setVault(loadedVault);
    } catch (err) {
      setError(err.message);
    } finally {
      setLoading(false);
    }
  };

  const sendToken = async (from: string, to: string, amount: string, tokenAddress: string, chainId: string) => {
    if (!vault) throw new Error('Wallet not loaded');
    return vault.sendToken(from, to, amount, tokenAddress, chainId);
  };

  const getBalance = async (address: string, chainId: string) => {
    if (!vault) throw new Error('Wallet not loaded');
    return vault.getNativeBalance(address, chainId);
  };

  return {
    vault,
    loading,
    error,
    sendToken,
    getBalance
  };
};

Chain Configuration

Built-in Chains

The SDK supports these chains out of the box:

Ethereum (1): Mainnet
BNB Smart Chain (56): Mainnet
Polygon (137): Mainnet
Arbitrum One (42161): Mainnet
OP Mainnet (10): Mainnet
Base (8453): Mainnet
Solana: Mainnet and Devnet
BSC Testnet (97): Testnet

Custom Chain Management

Override Built-in Chains

import { overrideChain, overrideChains } from 'pwc-wallet-sdk';

// Override single chain
overrideChain('1', { rpcUrl: 'https://my-eth-rpc.com' });

// Override multiple chains
overrideChains({
  '1': { rpcUrl: 'https://my-eth-rpc.com' },
  '56': { rpcUrl: 'https://my-bsc-rpc.com' }
});

Add Custom Chains

import { registerCustomChain } from 'pwc-wallet-sdk';

// Add EVM chain
registerCustomChain('custom-evm', {
  name: 'My EVM Chain',
  rpcUrl: 'https://my-evm-rpc.com',
  explorerUrl: 'https://my-explorer.com',
  nativeCurrency: { name: 'Token', symbol: 'TKN', decimals: 18 },
  type: 'evm'
});

// Add Solana chain
registerCustomChain('custom-solana', {
  name: 'My Solana Chain',
  rpcUrl: 'https://my-solana-rpc.com',
  explorerUrl: 'https://my-solana-explorer.com',
  nativeCurrency: { name: 'SOL', symbol: 'SOL', decimals: 9 },
  type: 'solana'
});

Setup All Chains at Once

import { setupChainConfigs } from 'pwc-wallet-sdk';

// Setup everything in one call
setupChainConfigs({
  overrides: {
    '1': { rpcUrl: 'https://my-eth-rpc.com' },
    '56': { rpcUrl: 'https://my-bsc-rpc.com' }
  },
  customChains: {
    'custom-1': {
      name: 'My Custom Chain',
      rpcUrl: 'https://my-custom-rpc.com',
      type: 'evm'
    }
  }
});

Chain Configuration Priority

The SDK uses this priority order when resolving chain configurations:

Custom Chains (highest priority)
Built-in Chains + Overrides (merged)
Built-in Chains (original, if no override)
Error (if not found)

Utility Functions

import { 
  getAllAvailableChains,
  getCustomChains,
  getOverrides,
  clearCustomChains,
  clearOverrides
} from 'pwc-wallet-sdk';

// Get all available chains
const allChains = getAllAvailableChains();

// Get only custom chains
const customChains = getCustomChains();

// Get only overrides
const overrides = getOverrides();

// Clear all custom chains
clearCustomChains();

// Clear all overrides
clearOverrides();

Multi-Transfer Operations

Batch Send Native Tokens

const recipients = [
  { address: '0x123...', amount: '0.1' },
  { address: '0x456...', amount: '0.2' },
  { address: '0x789...', amount: '0.3' }
];

const result = await vault.multiTransferNativeTokens(
  fromAddress,
  recipients,
  '1', // chainId
  (completed, total, txHash) => {
    console.log(`Completed ${completed}/${total}: ${txHash}`);
  }
);

console.log(`Successfully sent ${result.successful} transactions`);
console.log(`Failed: ${result.failed.length}`);

Batch Send ERC-20 Tokens

const result = await vault.multiTransferTokens(
  fromAddress,
  tokenAddress,
  recipients,
  '1', // chainId
  (completed, total, txHash) => {
    console.log(`Completed ${completed}/${total}: ${txHash}`);
  }
);

Advanced Features

Gas Estimation

// Estimate gas for single transfer
const gasEstimate = await vault.estimateNativeTransferGas(
  fromAddress,
  toAddress,
  amount,
  '1'
);

// Estimate gas for multi-transfer
const multiTransferGas = await vault.estimateMultiTransferGas(
  fromAddress,
  recipients,
  '1',
  true, // isNative
  tokenAddress // optional for token transfers
);

Token Information

// Get token metadata
const tokenInfo = await vault.getTokenInfo(tokenAddress, '1');
console.log(`Token: ${tokenInfo.name} (${tokenInfo.symbol})`);

// Get token balance
const balance = await vault.getTokenBalance(address, tokenAddress, '1');
console.log(`Balance: ${ethers.formatUnits(balance, tokenInfo.decimals)}`);

Configuration

Vanity Wallet Settings

import { VANITY_WALLET_CONFIG } from 'pwc-wallet-sdk';

// Default settings
console.log(VANITY_WALLET_CONFIG.DEFAULT_PREFIX); // 'aaa'
console.log(VANITY_WALLET_CONFIG.DEFAULT_MAX_ATTEMPTS); // 1000000
console.log(VANITY_WALLET_CONFIG.DEFAULT_CASE_SENSITIVE); // false

Supported Chains

import { SUPPORTED_CHAINS } from 'pwc-wallet-sdk';

// View all supported chains
Object.entries(SUPPORTED_CHAINS).forEach(([chainId, config]) => {
  console.log(`${chainId}: ${config.name} (${config.type})`);
});

Security Considerations

Password Strength: Use strong passwords for vault encryption
Private Key Storage: Private keys are never stored in plain text
Memory Safety: Sensitive data is cleared from memory when possible
Encryption: All vault data is encrypted using AES-256
Validation: Input validation prevents common attack vectors

Error Handling

try {
  const vault = await Vault.load(password, encryptedVault);
  await vault.sendToken(from, to, amount, tokenAddress, '1');
} catch (error) {
  if (error.message.includes('incorrect password')) {
    // Handle password error
  } else if (error.message.includes('insufficient balance')) {
    // Handle balance error
  } else {
    // Handle other errors
  }
}

Contributing

Fork the repository
Create a feature branch
Make your changes
Add tests
Submit a pull request

License

MIT License - see LICENSE file for details.