lwk_node 0.11.0 → 0.12.0

package/README.md

@@ -102,4 +102,59 @@ Rename the package to `lwk_node` so that we can publish it to npm.
 
 ```shell
 sed -i 's/"lwk_wasm"/"lwk_node"/g' pkg_node/package.json
-```
+```
+
+### Test node js examples
+
+Requirement:
+
+* having built node pkg like shown in previous paragraph
+* having node and npm installed
+
+```shell
+cd lwk_wasm/tests/node
+npm install
+node network.js
+```
+
+## Javascript code conventions
+
+### String
+
+For object that have a string representation we implement `std::fmt::Display` and we expose them like that
+
+```rust
+#[wasm_bindgen(js_name = toString)]
+pub fn to_string_js(&self) -> String {
+    self.to_string()
+}
+```
+
+### JSON
+
+For objects that have a json representation, like the balance we provide a `toJSON()` method that must work when the caller use for example `JSON.stringify(object)`
+Unfortunately `JSON.stringify` cannot serialize big integers  by default, thus we use string representation for `BigInt`.
+
+### Entries
+
+Since JSON doesn't support `BigInt` some object expose also the js standard `entries()` method so that the following code is possible
+
+```js
+const balance = wallet.balance();
+
+// 1. Create a Map
+const balanceMap = new Map(balance.entries());
+
+// 2. Iterate directly in a for...of loop
+for (const [currency, amount] of balance.entries()) {
+  console.log(`${currency}: ${amount}`);
+}
+
+// 3. Convert to a plain object
+const balanceObject = Object.fromEntries(balance.entries());
+```
+
+## Documentation
+
+Documentation of this crate should not use link to rust types such as [`Transaction`] because they are not usable in end-user javascript packages.
+Many types are wrappers of types in lwk crates, in this cases we mostly duplicate the original documentation with context adjustment.