Tari Wallet Interface

A TypeScript client library for interacting with the Tari cryptocurrency wallet system via gRPC and CLI interfaces.

Features

• Connect to Tari wallets via gRPC
• Connect to Tari base nodes via gRPC
• Execute wallet commands using CLI
• Transfer funds
• Manage SHA atomic swaps (initialize, finalize, claim refunds)
• Query wallet information (balance, address, state)

Installation

npm install @krakaw/wallet-interface
# or
pnpm add @krakaw/wallet-interface

Usage

gRPC Wallet Client

import { TariWalletGrpcClient } from '@krakaw/wallet-interface';

// Create a client connected to a Tari wallet gRPC service
const client = new TariWalletGrpcClient('localhost:18142');

// Get wallet balance
const balance = await client.getBalance();
console.log(`Available balance: ${balance.availableBalance}`);

// Get wallet address
const address = await client.getAddress();

// Transfer funds
const result = await client.transfer({
  recipients: [{
    address: 'recipient-address',
    amount: 1000,
    feePerGram: 25,
    paymentType: 0 // STANDARD_MIMBLEWIMBLE
  }]
});

// Close the connection when done
client.close();

Base Node gRPC Client

import { TariBaseNodeGrpcClient } from '@krakaw/wallet-interface';

// Create a client connected to a Tari base node gRPC service
const baseNodeClient = new TariBaseNodeGrpcClient('localhost:18141');

// Get chain metadata
const metadata = await baseNodeClient.getChainMetadata();
console.log(`Current height: ${metadata.metadata.bestBlock.height}`);

// Close the connection when done
baseNodeClient.close();

CLI Wallet Client

import { TariWalletCliClient } from '@krakaw/wallet-interface';

// Create a client using the Tari wallet CLI executable
const client = new TariWalletCliClient('/path/to/tari_wallet_cli');

// Initialize a SHA atomic swap
const swapResult = await client.initShaAtomicSwap({
  amount: 1000,
  pubKey: 'recipient-public-key'
});

// Finalize a SHA atomic swap
await client.finaliseShaAtomicSwap({
  outputHash: swapResult.outputHash,
  preImageHex: swapResult.preImageHex
});

Development

# Install dependencies
pnpm install

# Build the project
pnpm build

# Run tests
pnpm test

# Lint code
pnpm lint

# Format code
pnpm format:fix

License

ISC