Roadmap to supporting React Native

[alexlwn123]

Thanks to our terrific Summer of Bitcoin interns (@MrImmortal09, @Harshdev098), most of the groundwork has already been laid out for supporting react native. Most of this work lives off master in large unmerged PRs. At this point, we believe it will be easier to selectively merge in narrow chunks of features instead of doing it all at once. This way, we can maintain tests & validate correctness as we go.

TODOs (high level):

• Create an abstraction to separate "platform-dependent" logic (wasm vs native module, logging, etc) from common code. (services, rpc logic, etc). Alex/abstract transport refactor #180
• Merge in multi-federation support (bump wasm, redb via opfs), mostly done.
• Merge in "basic" WalletDirector abstraction Basic Wallet director #182
• Split Wasm/Web transport into a different pacakge (preparing for react-native) Split transports out of the core lib package #184
• Build React-Native transport package

---

Gritty TODOs

• Generic Transports
  • add logging then done...
• Bumping wasm to include RPC call
  • version 0.9...
  • you can't have multiple wallets without the fedimint-client-rpc crate
  • need this for multiplexing
  • Implement redb, opfs support
• Implement "Stateless" Wallet Director (pt 1)
  • Multi-client support (all the rust transport logic)
  • Adding WalletDirector class... Same level as FedimintWallet currently is
    • Consumes a TransportClient (1 to 1 with WalletDirector)
    • Instantiates FedimintWallets
  • Won't track the list of wallets ...yet.
    • On first open, pass in the invite code + wallet uuid
    • On later opens, pass in JUST the wallet uuid
  • JUST initialize & createWallet functions
    • move the ownership of transport client to the director (dependency injection down to the wallet)
    • createWallet calls the constructor of FedimintWallet and returns the wallet
• Implement "Stateful" Wallet Director (pt 2)
  • Update: Plan is to move wallet "management" (list, get, open, close) to rust.
    • Consolidate to only one database (instead of two)
    • Simplify complexity of the library
    • Consolidate Library states
      • ALL IS READY or NONE IS READY (including opening/initializing all wallets). Includes pure functions (parse invoice, previewFederation, etc.)
  • Put in the Director/TransportClient
    • listWallets, joinFederation, getWallet, etc.
      - [ ] Add to Transport Interface
      - [ ] k/v store (in the transport interface)
      - [ ] browser storage (localstorage for web)?
      • TODO: Ask @maan2003 if this should be in rust vs js?
        - [ ] If in rust, how much logic should we move OUT of the director and into rust (list wallets)
        • What does the RUST interface look like to the JS
          - [ ] arbitrary k/v store? (list wallet logic lives in js)
          • full methods (list wallets, get open wallet, etc.)
            - [ ] Leaning towards putting it in JS
            - [ ] interface WONT change for the end user if we "upgrade" to rust.
            - [ ] Reduces additional complexity on the rust
            - [ ] Avoids "Half-initialized state"
            - [ ] Leaves more code untouched.
            - [ ] TransportClient
            - [ ] wraps getItem, setItem...
• Split Web transport into it's own package (to avoid pulling in wasm to a react-native environment)
  • details TBD
• Create react-native transport
  • ideally using uniffi: https://github.com/jhugman/uniffi-bindgen-react-native

[alexlwn123]

@fedimint/core-web has been renamed to @fedimint/core.

If you use @fedimint/core-web it'll still work, but will show this warning.

@fedimin/core-web has also been marked as deprecated on npmjs