svm-codec npm package

A public npm package providing the Spacemesh svm-codec for browser and node.js apps.

Setup

yarn

Copy an svm_codec.wasm file to include in the package from the Spacemesh svm codec crate. No autoamted pull is implemented yet.

Building

yarn build

Testing

yarn test

Linting

yarn lint

Publishing

npm publish --access=public

Using

look at index.test.ts for some useful helper functions for working with the package that you may want to use in your code.

svm_codev.wasm is not included in the package as different javascript apps will want to load it in different ways. e.g. load from app resources in a node.js or electron app. Load using a resources' loader in a web-app.

Electron / Node.js App

Add svm_codec.wasm to be used by the lib to your app's resources.

import fs from 'fs';
import Path from 'path';

import * as SvmCodec from '@spacemesh/svm-codec';

const path = Path.resolve(__dirname, 'svm_codec.wasm');
const code = fs.readFileSync(path);

await SvmCodec.init(code);

// call svmCodec functions...

Web App

Load the binary data of svm_codec.wasm from your website static resoruces.

import * as SvmCodec from '@spacemesh/svm-codec';

const code = .... // load data from svm_codec.wasm here...
await SvmCodec.init(code);

// call svmCodec functions....

Known Issues

• integration with svm-codec releases is NYI.