breez-sdk-liquid/packages/wasm/DEVELOPMENT.md

Development guide - Wasm package

When developing, it can be useful to work with a locally built version of the Breez Liquid SDK instead of relying on what is published already. To do this, you first need to build the Breez Liquid SDK bindings locally and then point the examples to make use of the locally built Breez Liquid SDK Wasm package.

All the following commands can be run in the packages/wasm directory.

Prerequisites

To build some dependencies you need to first install

• Protobuf
• Emscripten for compiling to Wasm
• Firefox for testing Wasm

brew install protobuf emscripten

On first usage you will need to run:

make init

Build

To build the Wasm code run:

make build

This will generate the following artifacts:

• Bundle - suitable for use with bundlers like Webpack

• bundle/package.json
• bundle/breez_sdk_liquid_wasm.d.ts
• bundle/breez_sdk_liquid_wasm.js
• bundle/breez_sdk_liquid_wasm_bg.js
• bundle/breez_sdk_liquid_wasm_bg.wasm
• bundle/breez_sdk_liquid_wasm_bg.wasm.d.ts

• Deno - ES module for use with Deno

• deno/breez_sdk_liquid_wasm.d.ts
• deno/breez_sdk_liquid_wasm.js
• deno/breez_sdk_liquid_wasm_bg.wasm
• deno/breez_sdk_liquid_wasm_bg.wasm.d.ts

• Node - CommonJS module for use with Node.js

• node/package.json
• node/breez_sdk_liquid_wasm.d.ts
• node/breez_sdk_liquid_wasm.js
• node/breez_sdk_liquid_wasm_bg.wasm
• node/breez_sdk_liquid_wasm_bg.wasm.d.ts

• Web - ES module for use in browsers

• web/package.json
• web/breez_sdk_liquid_wasm.d.ts
• web/breez_sdk_liquid_wasm.js
• web/breez_sdk_liquid_wasm_bg.wasm
• web/breez_sdk_liquid_wasm_bg.wasm.d.ts

Testing with the examples

To test locally built bindings in the examples, the npm dependencies need to be updated to use the local package.

    "@breeztech/breez-sdk-liquid": "file:../../",