kaspa-wasm

Crates.iokaspa-wasm
lib.rskaspa-wasm
version0.13.4
sourcesrc
created_at2023-03-23 12:33:57.275931
updated_at2024-01-24 13:54:35.977024
descriptionKASPA WASM bindings
homepage
repository
max_upload_size
id818278
size13,690
Michael Sutton (michaelsutton)

documentation

README

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.

Documentation

Please note that while WASM directly binds JavaScript 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.

Interfaces

The APIs are currently separated into the following groups:

  • Transaction API — Bindings for primitives related to transactions.
  • RPC API — RPC interface bindings for the Kaspa node using WebSocket (wRPC) connections.
  • Wallet API — API for async core wallet processing tasks.

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).

Loading in a Web App

<html>
    <head>
        <script type="module">
            import * as kaspa_wasm from './kaspa/kaspa-wasm.js';
            (async () => {
                const kaspa = await kaspa_wasm.default('./kaspa/kaspa-wasm_bg.wasm');
                // ...
            })();
        </script>
    </head>
    <body></body>
</html>

Loading in a Node.js App

// W3C WebSocket module shim
// this is provided by NPM `kaspa` module and is only needed
// if you are building WASM libraries for NodeJS from source
// globalThis.WebSocket = require('websocket').w3cwebsocket;

let {RpcClient,Encoding,initConsolePanicHook} = require('./kaspa-rpc');

// enabling console panic hooks allows WASM to print panic details to console
// initConsolePanicHook();
// enabling browser panic hooks will create a full-page DIV with panic details
// this is useful for mobile devices where console is not available
// initBrowserPanicHook();

// if port is not specified, it will use the default port for the specified network
const rpc = new RpcClient("127.0.0.1", Encoding.Borsh, "testnet-10");

(async () => {
    try {
        await rpc.connect();
        let info = await rpc.getInfo();
        console.log(info);
    } finally {
        await rpc.disconnect();
    }
})();

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

Commit count: 0

cargo fmt