Benjamin Kampmann
94b635c074
* feat(crypto-nodejs): Download lib binary in postinstall * build(crypto-nodejs): Workflow to prebuild napi bindings * ci(crypto-nodejs): Disable broken target, install without download * ci(apple-ffi): Don't run for drafts * ci(coverage): Don't run for draft PRs * fix(crypto-nodejs): bind to current version for download * fix(crypto-nodejs): Ignore libs and package * ci(crypto-nodejs): Build and upload NPM package * fix(crypto-nodejs): Set proper target list * ci(crypto-nodejs): Remove FreeBSD from build pipeline * ci(crypto-nodejs): Linkers for linux cross compile * ci(crypto-nodejs): Add arm64 build for windows * ci(crypto-nodejs): Proper linkers for arm and musl * ci(crypto-nodejs): Correct apt command for musl * fix(crypto-nodejs): Drop arm64 linux musl support * ci(crypto-nodejs): Manual Workflow trigger process * chore(crypto-nodejs): Get Github to pickup our action * ci(crypto-nodejs): Add i686 Linux built * ci(crypto-nodejs): Configure cliff for nodejs changelogs * ci(crypto-nodejs): Proper gcc for i868 targets * docs(crypto-nodejs): Add supported targets for npm install * ci(crypto-nodejs): Limit building of binaries to tags * style: consol.log -> console.info; Improve docs Co-authored-by: Ivan Enderlin <ivan@mnt.io> * activate for testing * fix broken merge * 0.1.0 * fix(js): put in the proper package name * activate for PR for testing * fix(nodejs): getting ready for publishing * ci(crypto-nodejs): Adding docs and fixing naming for workflows * typo: missed one * fixing package name Co-authored-by: Ivan Enderlin <ivan@mnt.io>
matrix-sdk-crypto-js
Welcome to the WebAssembly + JavaScript binding for the Rust
matrix-sdk-crypto library! WebAssembly can run anywhere, but these
bindings are designed to run on a JavaScript host. These bindings are
part of the matrix-rust-sdk project, which is a library
implementation of a Matrix client-server.
matrix-sdk-crypto is a no-network-IO implementation of a state
machine, named OlmMachine, that handles E2EE (End-to-End
Encryption) for
Matrix clients.
Usage
These WebAssembly bindings are written in Rust. To build them, you need to install the Rust compiler, see the Install Rust Page. Then, the workflow is pretty classical by using npm, see the Downloading and installing Node.js and npm Page.
Once the Rust compiler, Node.js and npm are installed, you can run the following commands:
$ npm install
$ npm run build
$ npm run test
A matrix_sdk_crypto.js, matrix_sdk_crypto.d.ts and a
matrix_sdk_crypto_bg.wasm files should be generated in the pkg/
directory.
TBD
Documentation
To generate the documentation, please run the following command:
$ npm run doc
The documentation is generated in the ./docs directory.