#wasm #rpc #message #websocket


KASPA WASM bindings

4 releases

0.0.3 Apr 17, 2023
0.0.2 Apr 17, 2023
0.0.1 Apr 4, 2023
0.0.0 Mar 23, 2023

#2085 in Magic Beans

23 downloads per month

MIT/Apache and LGPL-3.0-only


kaspa-wasm WASM32 bindings for Kaspa

github crates.io docs.rs license

Rusty-Kaspa WASM32 bindings offer direct integration of Rust code and Rusty-Kaspa codebase within JavaScript environments such as Node.js and Web Browsers.


Please note that while WASM directly binds JacaScript and Rust resources, their names on JavaScript side are different from their name in Rust as they conform to the 'camelCase' convention in JavaScript and to the 'snake_case' convention in Rust.


The APIs are currently separated into the following groups:

  • Transaction API — Bindings for primitives related to transactions. This includes basic primitives related to consensus transactions, as well as MutableTransaction and VirtualTransaction primitives usable for transaction creation.

  • Wallet API — API for async core wallet processing tasks.

  • RPC APIRPC interface bindings for the Kaspa node using WebSocket connections. Compatible with Rusty Kaspa as well as with the Golang node (kaspad) via the kaspa-wrpc-proxy WebSocket / gRPC proxy (located in rpc/wrpc/proxy).

Using RPC

There are multiple ways to use RPC:

  • Control over WebSocket-framed JSON-RPC protocol (you have to manually handle serialization)
  • Use RpcClient class that handles the connectivity automatically and provides RPC interfaces in a form of async function calls.

NODEJS: To use WASM RPC client in the Node.js environment, you need to introduce a W3C WebSocket object before loading the WASM32 library. You can use any Node.js module that exposes a W3C-compatible WebSocket implementation. Two of such modules are WebSocket (provides a custom implementation) and isomorphic-ws (built on top of the ws WebSocket module).

You can use the following shims:

// `websocket` module
globalThis.WebSocket = require('websocket').w3cwebsocket;
// `isomorphic-ws` module
globalThis.WebSocket = require('isomorphic-ws');

For more details, please follow the integrating with Kaspa guide.


~812K SLoC