npm.io
0.0.2 • Published 3 years ago

@dwn-protocol/vc-sdk-wasm

Licence
Apache-2.0
Version
0.0.2
Deps
4
Size
18.6 MB
Vulns
1
Weekly
0

vc-sdk-wasm

vc-sdk-wasm is a library that provides a WebAssembly (WASM) implementation for Verifiable Credentials SDK. It enables functionality in the browser and other JavaScript environments by compiling the SDK to a WASM file. This repository is responsible for building the main.wasm file and making it available as an npm package.

Table of Contents

Usage

To use the vc-sdk-wasm package, simply import it in your project (Note this only works in nodejs currently, to use in react you can follow the example in the example directory):

import * as VC from 'vc-sdk-wasm';

Build

To install the vc-sdk-wasm package, run:

yarn
yarn build

This will produce create the wasm file from the generation code in the wasm directory the following output files:

  • dist/index.js: Bundled JavaScript file
  • dist/main.wasm: Compiled WASM file

The build script also copies the main.wasm file to the apps/react/public/ directory.

Test

This contains a simple test to make sure all wasm functions are working properly

yarn test

Resources

Resource Description
CODE_OF_CONDUCT Expected behavior for project contributors, promoting a welcoming environment
CONTRIBUTING Developer guide to build, test, run, access CI, chat, discuss, file issues
GOVERNANCE Project governance
LICENSE Apache License, Version 2.0