From 3ceeecc3bc0213622efa7b6135f442ff2da14286 Mon Sep 17 00:00:00 2001 From: sneurlax Date: Thu, 10 Oct 2024 21:30:28 -0500 Subject: /monero_rust -> /monero.rs just to match the style in impls and sneurlax/monero_c -> MrCyjaneK/monero_c --- impls/monero.rs/README.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 impls/monero.rs/README.md (limited to 'impls/monero.rs/README.md') diff --git a/impls/monero.rs/README.md b/impls/monero.rs/README.md new file mode 100644 index 0000000..fbac577 --- /dev/null +++ b/impls/monero.rs/README.md @@ -0,0 +1,46 @@ +# `monero_rust` +Proof of concept `monero_c` bindings for Rust. + +## Getting started + +### Build `monero_c` +Build the monero_c library for your architecture. Follow the upstream docs at +https://github.com/MrCyjaneK/monero_c and +place the library at `monero_c/impls/monero_rust/lib/libwallet2_api_c.so` or use +the provided script: +``` +cd scripts +./build_monero_c.sh +``` + +or build it manually as in: +``` +git clone https://git.mrcyjanek.net/MrCyjaneK/monero_c --branch rust +cd monero_c +git submodule update --init --recursive +rm -rf monero wownero release # Clean any previous builds. +git submodule update --init --recursive --force +./apply_patches.sh monero +./build_single.sh monero x86_64-linux-gnu -j$(nproc) + +# Adjust the commands below for your arch. +unxz -f release/monero/x86_64-linux-gnu_libwallet2_api_c.so.xz +mv release/monero/x86_64-linux-gnu_libwallet2_api_c.so ../lib/libwallet2_api_c.so +# The library should be at monero_c/impls/monero_rust/lib/libwallet2_api_c.so. +``` + +### Run `monero_rust` demo +From `monero_c/impls/monero_rust`: +``` +cargo run +``` + +## Using `monero_rust` in your own crate +Refer to the `example` folder. `libwallet2_api_c.so` must be in the same +directory as the binary (*eg.* at `example/target/debug/libwallet2_api_c.so`). -- cgit v1.2.3