mfahampshire
cf3fd00350
* - standardise versions for all nym-sdk workspace dependencies - prepend sqlx-pool-guard with 'nym-' * Test remove nym-api from deps * Add oneliner to client_pool doc comments * Add note to commented out docs.rs link in sdk * remove nym-api from script * add publishing file * bring non-binary / contract / tools into workspace version * added more info to publishing.md * make deps workspace version * remove uploaded sphinx-types crate from script * remove erroueously included ignore-defaults * add zeroise to feature * chore: Release * add topology to batch * more cargo versioning * more cargo versioning - wasm utils * more cargo versioning - wasm utils * Add publish=false to manifest for cargo workspaces / crates.io publishing exclusion * remove script now switched to manifest based exclusion * rename import based on rename of contracts-common dep * Making workspace versions for publication + removing unnecessary crates from publication * Remove OOD info from publishing sdk guide * rename contract imports + remove package * temp commit: continuing with removal of path from cargo manifest and replacing with workspace version import for publication * continuing with cargo.toml updates * dryrun only erroring on known version problem crates * remove old published-crates file * Minor comment change * remove default features warning * Additional info on workspace dep comment re publish list * Add missing description to cargo.toml * Fix missing feature flags * Add missing descriptions * Fix remaining path import * Add workspace repo / homepage / documentation links to cargo.toml files * remove workspace version from excluded crate * Remove todo descriptions * Minor comment change * add homepage etc * move from bls git import to nym_bls_fork crate * Modify rest of imports from path to workspace import, excluding binaries * add directory/homepage info * fix cargo fmt * add notes to gitignore * better solution to contracts/ experiment * wasm -> nym_wasm crate renaming * fix fatfinger * add metadata to ecash cargo.toml * stub publishing guide * fix misrevolved netlink- version * Fixes and block publication of rebase re: LP * first pass @ workflows
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 the mixnet client functionality.proxy_example.go: an example of using the TcpProxy functionality.
- the
Useage - Consuming the Library
You can import the bindings as normal and interact with them as shown in the example files. These files import the bindings from 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