summaryrefslogtreecommitdiff
path: root/impls/monero.ts/README.md
diff options
context:
space:
mode:
authorcyan <cyjan@mrcyjanek.net>2024-09-19 10:59:07 +0200
committerGitHub <noreply@github.com>2024-09-19 10:59:07 +0200
commitd1940944943cd79ce1f2b2080456dd28bec5c36f (patch)
tree8a2a29c5de6cec47ccefff3472f38a8ecb9fb8af /impls/monero.ts/README.md
parent0b91e91d19d4a11d753f9bdda56398bcfcdb4260 (diff)
feat: deno ffi bindings (#40)
* initial ts commit * monero.ts improvements * test on latest, build on debian:bookworm * feat: upstream changes to bindings * chore: update checksums * feat: allow manually loading dylib * chore: add readme * fix: free strings after being read to prevent potential memory leaks * fix: load dylib * fix: checksum checks segfaulting because of freeing const variables --------- Co-authored-by: Mateusz Franik <47059999+Im-Beast@users.noreply.github.com> Co-authored-by: Im-Beast <franik.mateusz@gmail.com>
Diffstat (limited to 'impls/monero.ts/README.md')
-rw-r--r--impls/monero.ts/README.md42
1 files changed, 42 insertions, 0 deletions
diff --git a/impls/monero.ts/README.md b/impls/monero.ts/README.md
new file mode 100644
index 0000000..e3b20f6
--- /dev/null
+++ b/impls/monero.ts/README.md
@@ -0,0 +1,42 @@
+# monero.ts
+
+`monero_c` bindings for Deno.
+
+## Usage
+
+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.
+ ```ts
+ import { loadDylib, 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();
+
+ const wm = await WalletManager.new();
+ const wallet = await Wallet.create(wm, "./my_wallet", "password");
+
+ console.log(await wallet.address());
+
+ await wallet.store();
+ ```
+- Just-in-time, where you download and cache the library at runtime.\
+ You can use something like [plug](https://jsr.io/@denosaurs/plug) to achieve the result.
+ ```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";
+
+ // Load dylib loaded by plug
+ const lib = await dlopen(..., symbols);
+ loadDylib(lib);
+
+ const wm = await WalletManager.new();
+ const wallet = await Wallet.create(wm, "./my_wallet", "password");
+
+ console.log(await wallet.address());
+
+ await wallet.store();
+ ```