Kaspa Wallet Core

Multi-platform Rust framework for Kaspa Wallet.

This framework provides a series of APIs and primitives to simplify building applications that interface with the Kaspa p2p network.

For key generation and derivation, please see the kaspa_wallet_keys crate.

This crate included are low-level primitives such as UtxoProcessor and UtxoContext that provide various levels of automation as well as higher-level APIs such as Wallet, Account (managed via the WalletApi trait) that offer a fully-featured wallet implementation backed by a multi-platform data storage layer capable of storing wallet data on a local file-system as well as within the browser environment.

The wallet framework also includes transaction Generator that can be used to generate transactions from a set of UTXO entries. The generator can be used to create simple transactions as well as batch transactions comprised of multiple chained transactions. Batch transactions (also known as compound transactions) are needed when the total number of inputs required to satisfy the requested amount exceeds the maximum allowed transaction mass.

Key generation and derivation is available in the kaspa_wallet_keys crate.

The framework can operate within native Rust applications as well as within NodeJS, Bun and browser environments via the WASM32 SDK.

WASM32 SDK documentation is available at: https://kaspa.aspectron.org/docs/

For NodeJS JavaScript and TypeScript environments, there are two available NPM modules:

• https://www.npmjs.com/package/kaspa
• https://www.npmjs.com/package/kaspa-wasm

NOTE: for security reasons (to mitigate potential upstream vendor attacks) it is always recommended to build WASM SDK from source or download pre-built redistributables.

Latest development builds of the WASM32 SDK can be found at: https://aspectron.org/en/projects/kaspa-wasm.html

The kaspa-wasm module is a pure WASM32 module that includes the entire wallet framework, but does not support RPC due to an absence of a native WebSocket in NodeJs environment, while the kaspa module includes websocket module dependency simulating the W3C WebSocket and thus supports RPC.

JavaScript examples for using this framework can be found at: https://github.com/kaspanet/rusty-kaspa/tree/master/wasm/nodejs

For pre-built browser-compatible WASM32 redistributables of this framework please see the releases section of the Rusty Kaspa repository at https://github.com/kaspanet/rusty-kaspa/releases.