summaryrefslogtreecommitdiff
path: root/impls/monero.ts/README.md
diff options
context:
space:
mode:
authorcyan <cyjan@mrcyjanek.net>2024-10-21 11:30:40 +0200
committerGitHub <noreply@github.com>2024-10-21 11:30:40 +0200
commitd54c9023bdf089489468d86b3aedd017e8973252 (patch)
tree39d96db065dfb35cd995968ee21bff00ea836a99 /impls/monero.ts/README.md
parentf956f6b78164412c60ba6e7e368afc17635ae7ce (diff)
parentd04dcf67ec042fca76b48ffc09ea9d2ea4b5106e (diff)
Merge branch 'master' into ledgerledger
Diffstat (limited to 'impls/monero.ts/README.md')
-rw-r--r--impls/monero.ts/README.md17
1 files changed, 12 insertions, 5 deletions
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");