mx
ae6c80f0cd
* fixed rebase conflict with cargo.lock * shared cleanup * moved returncode to shared * first pass at Go binding structure * minor cleanup * working on custom type udl * trying to get LDFLAG script working * commit before changing alias -> proper types * converted CCallbacks from aliases to Struct * cleanup comments * temp * push to share * cleanup * trait Lift not implemented for *const i8 issue * test of refactor: * move c-specific var casting out of shared/ into cpp/ * error returning in go/ over ffi boundary with uniffi * _internal functions ffi wrapper agnostic * moved lang-specific type conversions to cpp / go bindings and out of shared * got send_message working in c/c++ & go * split out c/c++-specific types to mod * cont. with making _internal fns lang agnostic * working on final fn for C and shared (listening for incoming messages) * fixed return err on listen_for_incoming * got full example run running again after shared/ refactor * removed unused struct * code comments * got first runthrough of go example code * script cleanup * clean up readme instructions * clippy * removed unused imports * rustfmt * Update sdk/ffi/go/README.md with link to example file Co-authored-by: Mark Sinclair <14054343+mmsinclair@users.noreply.github.com> * updated readme with extra build and usage info * renamed binding outer directory for nicer path * moved example file from ffi/main.go -> ./example.go * updated README with new example file name --------- Co-authored-by: mfahampshire <mfahampshire@pm.me> Co-authored-by: Mark Sinclair <14054343+mmsinclair@users.noreply.github.com>
Go FFI
⚠️ This is an initial version of this library in order to give developers something to experiment with. If you use this code to begin testing out Mixnet integration and run into issues, errors, or have feedback, please feel free to open an issue; feedback from developers trying to use it will help us improve it. If you have questions feel free to reach out via our Matrix channel.
This repo contains:
lib.rs: an initial version of bindings for interacting with the Mixnet via the Rust SDK from Go. These are essentially match statemtns wrapping imported functions from thenym-ffi-sharedlib.ffi/: a directory containing:- the
bindings/files generated usinguniffi-bindgen-go example.go: an example of using this library.
- the
The example.go file is an example flow of:
- setting up Nym client logging
- creating an ephemeral Nym client (no key storage / persistent address - this will come in a future iteration)
- getting its Nym address
- using that address to send a message to yourself via the Mixnet
- listen for and parse the incoming message for the
sender_tagused for anonymous replies with SURBs - send a reply to yourself using SURBs
Useage - Consuming the Library
You can import the bindings as normal and interact with them as shown in the example file. This example imports the bindings from the this repository (hence the go.mod and go.sum in the crate root) but you can import them remotely as usual.
Useage - Developing on the Library
If you want to fork and add new features/functions to this library use the following instructions to rebuild the Go bindings.
Rust functions exposed to the Go binding library are in ./src/lib.rs.
The build.sh script in the root of the repository speeds up the task of building and linking the Rust and Go code.
- if want to quickly recompile your code run it as-is with
./build.sh - if you want to clean build both the Rust and Go code after removing existing compiled binaries run it with the optional
cleanargument:./build.sh clean.
Make sure to run the script from the root of the project directory, and that your LD PATH is set first!
RUST_BINARIES=target/release echo 'export LD_LIBRARY_PATH=${LD_LIBRARY_PATH}:'${RUST_BINARIES} >> ~/.zshrc source ~/.zshrc
This script will:
- (optionally if called with
cleanargument) remove existing Rust and Go artifacts - build
lib.rswith the--releaseflag - compile the Go bindings
WIP you need to manually add the following cgo flags to the generated bindings immediately underneath LN3 (// #include <bindings.h). In the future this will be automated in build.sh:
// #cgo LDFLAGS: -L../../target/release -lnym_go_ffi