README.md

cs_monero

A Melos monorepo for the cs_monero package, the cs_monero_flutter_libs package, and their dependencies.

About

• A simplified Flutter/Dart Monero (and Wownero) wallet library.
• Depends on https://github.com/MrCyjaneK/monero_c/
• Abstracts the wallet2 spaghetti.
• Refactored and organized version of flutter_libmonero based on https://github.com/cypherstack/flutter_libmonero/tree/heavy-refactor.

Getting started

Install Melos (dart pub global activate melos) and run melos bootstrap (or melos bs) in this root directory to get started.

Build libraries from source (optional but recommended)

By default, cs_monero_flutter_libs will automatically include and download the appropriate platform-specific binaries when you run flutter pub get. Use these at your own risk. To build the libraries yourself:

1. Add this repo as a git submodule to your project and add cs_moneroand cs_monero_flutter_libs to your pubspec.yaml as relative/path dependencies. If you're migrating from flutter_libmonero to cs_monero, also add compat.
2. Install Melos (dart pub global activate melos) and run melos bootstrap (or melos bs).
3. Build the platform you want using one of the following commands:
   • melos build:android
   • melos build:ios
   • melos build:linux
   • melos build:macos
   • melos build:windows
4. Run melos copyLibs to copy the binaries to where Flutter can find them.

Building notes

• This repo's build scripts are just wrappers around monero_c's build scripts. For details and requirements see https://github.com/MrCyjaneK/monero_c/
• To do a clean/fresh build, just the delete the top level build dir.
• Windows: Builds have been tested on Windows 11 with Ubuntu 20.04 in WSL2. Do not install Flutter via Snap, follow one of these guides instead: https://docs.flutter.dev/get-started/install/linux/desktop

TODO

• Tests? (at least what is possible)
• Accounts API?
• Use FFI project skeleton for libs vs Platform Plugin?
• Cleaner/more user friendly API