pivx-wallet
v0.7.3
Published
Standalone PIVX wallet SDK: local key management, shielded (SHIELD/Sapling) scanning, balances, and transaction building. The node is only a chain-data source.
Maintainers
Readme
pivx-wallet
Standalone PIVX wallet SDK: the application owns the keys.
ZIP32 derivation, shielded (SHIELD/Sapling) block scanning with note
decryption, checkpointed sync verified against finalsaplingroot, and
locally-proved shielded transactions — plus a transparent (BIP44 HD, UTXO)
wallet. The node is only a chain-data source; point it at one you trust.
Amounts are integer satoshis.
Install
npm install pivx-wallet pivx-rpcNode >= 20.19. ESM only.
Usage
import { PivxClient } from 'pivx-rpc';
import { PivxWallet } from 'pivx-wallet';
// exchange deposit detection: keys never on this host
const wallet = await PivxWallet.create({ viewingKey, birthHeight: 4_800_000 });
await wallet.sync(new PivxClient({ user, pass }));
console.log(wallet.getBalance()); // sats
// standalone send (with a spending key + prover loaded)
const txid = await wallet.send(client, { to: 'ps1…', amount: 150_000_000, memo: 'hi' });A wallet is built from a seed, spending key, or viewing key — watch-only is a capability level, upgradeable in place. The seed is a 32-byte raw seed or a 64-byte BIP39 seed; the 64-byte BIP39 seed reproduces MyPIVXWallet (MPW) / BIP39 seed-phrase wallet addresses.
Full docs, security model, and examples: https://github.com/Liquid369/pivx-js-sdk
