From fd7bb6ae1c27ffe5d41f3a818ee9034d9bb76138 Mon Sep 17 00:00:00 2001
From: Mateusz Franik <47059999+Im-Beast@users.noreply.github.com>
Date: Wed, 16 Oct 2024 07:55:11 +0200
Subject: feat: wownero typescript bindings, regression tests (#71)

* regression tests
* ci: move regression_check to full_check workflow, reuse artifact build
* feat: support wownero in monero.ts bindings
* ci: test wownero regressions as well
* extract wownero-cli as wownero
* actually load wownero when specified
* fix: commitUR not being a symbol in wownero
---
 impls/monero.ts/README.md | 17 ++++++++++++-----
 1 file changed, 12 insertions(+), 5 deletions(-)

(limited to 'impls/monero.ts/README.md')

diff --git a/impls/monero.ts/README.md b/impls/monero.ts/README.md
index e3b20f6..fe06467 100644
--- a/impls/monero.ts/README.md
+++ b/impls/monero.ts/README.md
@@ -7,13 +7,20 @@
 This library does not ship with `monero_c` libraries.\
 To use these bindings you have to bring your own `monero_c` libraries.\
 There are at least two ways to do so:
+
 - Ahead-of-time, during builds where you only ship necessary library for a given platform.\
-  See [monero-tui](https://github.com/Im-Beast/monero-tui/blob/main/.github/workflows/dev-build.yml) build workflow as an example of doing so.
+  See [monero-tui](https://github.com/Im-Beast/monero-tui/blob/main/.github/workflows/dev-build.yml) build workflow as
+  an example of doing so.
   ```ts
-  import { loadDylib, Wallet, WalletManager } from "https://raw.githubusercontent.com/MrCyjaneK/monero_c/master/impls/monero.ts/mod.ts";
+  import {
+    loadMoneroDylib,
+    Wallet,
+    WalletManager,
+  } from "https://raw.githubusercontent.com/MrCyjaneK/monero_c/master/impls/monero.ts/mod.ts";
 
   // Try to load dylib from the default lib/* path
-  loadDylib();
+  // You can also use loadWowneroDylib for Wownero
+  loadMoneroDylib();
 
   const wm = await WalletManager.new();
   const wallet = await Wallet.create(wm, "./my_wallet", "password");
@@ -27,11 +34,11 @@ There are at least two ways to do so:
   ```ts
   import { dlopen } from "jsr:@denosaurs/plug";
   // It's recommened to put the monero.ts github link into your import_map to reduce the url clutter
-  import { loadDylib, symbols, Wallet, WalletManager } from "https://raw.githubusercontent.com/MrCyjaneK/monero_c/master/impls/monero.ts/mod.ts";
+  import { loadMoneroDylib, symbols, Wallet, WalletManager } from "https://raw.githubusercontent.com/MrCyjaneK/monero_c/master/impls/monero.ts/mod.ts";
 
   // Load dylib loaded by plug
   const lib = await dlopen(..., symbols);
-  loadDylib(lib);
+  loadMoneroDylib(lib);
 
   const wm = await WalletManager.new();
   const wallet = await Wallet.create(wm, "./my_wallet", "password");
-- 
cgit v1.2.3