Make the Fedimint Web SDK Work with React Native

Scope overview: Enable the fedimint-client SDK to function within React Native environments, sharing library code with the existing web SDK.

Background

Our current SDK includes a WebAssembly (WASM) bundle that exposes the Rust-based fedimint-client to web applications. This setup allows web environments to interact seamlessly with the fedimint client.

However, React Native—a popular framework for building native/mobile apps using React—cannot directly leverage the existing WASM bundle due to environment differences between web and native mobile platforms.

Objective

Build React Native Compatibility:
Utilize UniFFI to generate bindings for the fedimint-client, making it compatible with React Native applications on both iOS and Android platforms.
Architect Shared Library Code:
Structure the React Native package to share as much library code as possible with the existing web SDK, minimizing code duplication and easing future maintenance.

Scope of Work

1. UniFFI Bindings for React Native

Generate UniFFI Bindings:
Configure the fedimint-client Rust codebase to produce UniFFI bindings suitable for React Native.
Ensure all necessary functionalities are exposed through these bindings.
Address any platform-specific issues on iOS and Android, ensuring smooth operation across devices.

2. Architecting Shared Library Code

Implement a modular architecture that allows both SDKs to import shared code without conflicts.

3. Testing and Validation

Ensure tests run successfully on both iOS and Android platforms.
(Optional but Preferred) Develop a sample React Native app demonstrating the SDK’s capabilities.

Deliverables

React Native Compatible SDK: A fully functional React Native package of the fedimint-client.
Sample App (Optional): A demo React Native application showcasing the SDK in action.

Acceptance Criteria

The React Native SDK must support all features currently available in the web SDK.
The SDK should work on both iOS and Android devices.
Shared code must be cleanly abstracted with no unnecessary duplication.

Additional Information

Coordinate with the maintainers of the existing web SDK (@alexlwn123) to ensure compatibility.

Challenges to Anticipate

Handling differences in threading models between Rust and React Native.
Managing asynchronous operations and callbacks across the FFI boundary.

References:

Note: This bounty aims to expand our SDK’s reach to mobile platforms via React Native, promoting broader adoption and community engagement. Your contribution will play a crucial role in achieving this goal.

alexlwn123 commented 1 month ago

@maan2003 take a look

maan2003 commented 3 weeks ago

fedimint react native is not going to be fun

we have to bundle rocksdb, and doing it as a library is not great :/ Maybe we can just force nix on all developers. But, forcing it for existing wallets is not great.

alexlwn123 commented 3 weeks ago

sad... any way around using rocks? Can we get a lighter-weight version of the DB with similar guarantees?

elsirion commented 3 weeks ago

we have to bundle rocksdb, and doing it as a library is not great :/

Is that a problem if we just leave it to the rust RocksDB crate? That is statically linking by default anyway, right? We only do dynamic linking because it avoids recompiling it all the time.