Tracking: React Native SDK v1.0

[nplasterer]

Requirements

Create a xmtp-react-native that mirrors xmtp-js functionality and demonstrate core functionality in a React Native sample app.

Prerequisites

• ios-xmtp as a cocoapod
  • swift-gRPC does not support cocoapods so needs to be replaced with rust
  • GigaBitcoin/secp256k1 does not support cocoapods so needs to be replaced with rust
  • SwiftNIO does not support cocoapods so needs to be replaced with rust

Developer Preview

• Create a native bridge to iOS and Android
  • Add authentication to match xmtp-js
  • Wrap xmtp in axmtp.Client (like xmtp-js)
  • Reproduce utility classes/methods
    • Client
      • createRandom()
      • create()
      • canMessage()
      • more clientOptions
    • Conversations
      • list()
      • stream()
      • newConversation()
      • streamAllMessages()
    • Conversation
      • messages()
        • paginate messages
      • send()
      • streamMessages()
      • peerAddress
      • decodeEnvelope
    • DecodedMessage
    • EnvelopeBuilder
  • Publish npm library
• Publish repo README covering Dev Preview features and with Dev Preview badge

GA

• Integrated with a third party app
  • Successfully received push notifications
• Publish repo README with GA badge
• Reference docs for SDK GA

Nice to have

• Write tests
• Clean up streams
• Clean up exports
• Create example app
  • Use xmtp-react-native to demonstrate SDK
    • Initialize client with a signer
    • List conversations
    • List messages
    • Send messages
    • Stream conversations
    • Stream messages
    • Wallet Connect
    • Push notifications
    • Local DB Caching

Decision log

[April 12, 2023]

• In an effort to move the xmpt-iOS SDK into a cocoapod to support the native bridge we will be making an effort to pull unsupported cocoapod support into a rust library. You can read more about React Native Bridge and Swift Package Manager here: Add support for Swift Package Manager (SPM) as the dependency manager for iOS react-native-community/discussions-and-proposals#587
• As a stop gap we will be releasing a new react native quick starter app that shows a simple webview implementation that calls through to xmpt-js.

[nplasterer]

Released publicly October 24th 2023.