@readyio/react-native-wallet 0.1.8

package/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2024 thinhnn
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,341 @@
+# @readyio/react-native-wallet
+
+React native ready wallet sdk for integrate with react native apps
+
+## Installation
+
+```sh
+npm install @readyio/react-native-wallet
+```
+OR
+```sh
+yarn add @readyio/react-native-wallet
+```
+
+## Peer dependencies
+
+```json
+{
+  "peerDependencies": {
+    "@gorhom/bottom-sheet": "^4",
+    "@nozbe/watermelondb": "^0.27.1",
+    "@react-native-async-storage/async-storage": "^1.17.10",
+    "@react-native-camera-roll/camera-roll": "5.2.0",
+    "@react-native-clipboard/clipboard": "^1.13.1",
+    "@react-native-community/blur": "^3.6.0",
+    "@react-native-community/checkbox": "^0.5.16",
+    "@react-native-community/datetimepicker": "^7.6.4",
+    "@react-native-community/netinfo": "6.0.0",
+    "@react-native-masked-view/masked-view": "^0.3.1",
+    "@react-navigation/bottom-tabs": "^6.5.12",
+    "@react-navigation/material-top-tabs": "^6.6.10",
+    "@react-navigation/native": "^6.1.7",
+    "@react-navigation/native-stack": "6.9.13",
+    "@sentry/react-native": "^4.2.4",
+    "@walletconnect/react-native-compat": "^2.11.0",
+    "@walletconnect/web3wallet": "^1.10.0",
+    "apisauce": "^1.1.1",
+    "i18n-js": "3.8.0",
+    "lodash": "^4.17.21",
+    "lottie-react-native": "^6.3.1",
+    "mobx": "6.10.2",
+    "mobx-react-lite": "4.0.5",
+    "mobx-state-tree": "5.3.0",
+    "moment": "^2.24.0",
+    "react": "*",
+    "react-native": "*",
+    "react-native-biometrics": "^3.0.1",
+    "react-native-camera": "^3.18.0",
+    "react-native-device-info": "^5.5.3",
+    "react-native-event-listeners": "^1.0.7",
+    "react-native-fast-image": "^8.6.3",
+    "react-native-fs": "^2.16.6",
+    "react-native-gesture-handler": "~2.12.0",
+    "react-native-hash": "^3.0.3",
+    "react-native-image-picker": "^5.6.1",
+    "react-native-keychain": "~8.1.2",
+    "react-native-linear-gradient": "^2.8.3",
+    "react-native-modal": "^13.0.1",
+    "react-native-pager-view": "7.0.0-rc.0",
+    "react-native-permissions": "^2.1.3",
+    "react-native-pie-chart": "^3.0.2",
+    "react-native-qrcode-scanner": "^1.5.5",
+    "react-native-qrcode-svg": "^6.0.3",
+    "react-native-reanimated": "3.5.4",
+    "react-native-safe-area-context": "^4.7.1",
+    "react-native-screens": "3.25.0",
+    "react-native-share": "^7.6.6",
+    "react-native-skeleton-placeholder": "^5.2.4",
+    "react-native-svg": "^13.14.0",
+    "react-native-tab-view": "^3.5.2",
+    "react-native-toast-message": "^2.2.0",
+    "react-native-uuid": "1.4.9",
+    "react-native-view-shot": "^3.8.0",
+    "react-native-webview": "^13.8.1"
+  },
+}
+```
+
+## Setting up Deeplink for connecting to Dapps by WalletConnect
+
+If **`Linking`** is not installed in your React Native project, consult the [documentation](https://reactnative.dev/docs/linking); otherwise, no additional configuration is required.
+
+## IOS
+
+1. WatermelonDB dependency
+
+```pod
+pod 'simdjson', path: '../node_modules/@nozbe/simdjson', modular_headers: true
+```
+
+2. `react-native-permissions@2.1.3`
+
+The Ready Wallet SDK requires access to the camera, photo and Face-ID on iOS. So, let's set up the pod file by following [this documentation](https://github.com/zoontek/react-native-permissions/tree/2.1.3)
+
+**Info.plist**
+
+```
+  <key>NSCameraUsageDescription</key>
+	<string>Our app uses the camera to scan crypto wallet or account QR code and capture photos for sharing in chat or used as avatar</string>
+	<key>NSFaceIDUsageDescription</key>
+	<string>Authentication</string>
+	<key>NSPhotoLibraryUsageDescription</key>
+	<string>Access to the photo library is used for media sharing in chat or setting profile picture</string>
+```
+3. Deeplink for connecting to Dapps by WalletConnect 
+
+```jsx
+  npx uri-scheme add readywallet --ios
+```
+
+4. Run IOS
+```sh
+cd ios && pod install
+yarn ios
+```
+
+## Android
+
+
+1.  Kotlin version
+- Add in `android/build.gradle`
+
+```jsx
+buildscript{
+  ...
+  kotlinVersion = '1.7.20'
+  ...
+}
+
+dependencies {
+  ...
+  classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlinVersion"
+ }
+```
+
+2. Sdk version
+- In `build.gradle` change `minSdkVersion` to `23`
+
+```jsx
+buildscript{
+  ...
+  minSdkVersion = 23
+}
+```
+
+3. Problem in `react-native-camera`
+- Add this code to `android/app/build.gradle`
+
+```jsx
+defaultConfig {
+  ...
+  missingDimensionStrategy 'react-native-camera', 'general'
+}
+```
+
+4. Problem with `bcprov-jdk15to18`
+- Add this code to `android/app/build.gradle`
+
+```jsx
+configurations {
+    all*.exclude module: 'bcprov-jdk15to18'
+}
+```
+
+5. Require permissions
+
+**AndroidManifest.xml**
+```
+  <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
+  <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
+  <uses-permission android:name="android.permission.CAMERA" />
+```
+
+6. Deeplink for connecting to Dapps by WalletConnect 
+
+```jsx
+npx uri-scheme add readywallet --android && npx uri-scheme add wc --android
+```
+
+## Simple Usage
+
+```js
+import ready from '@readyio/react-native-wallet';
+
+ready.openApp({
+  /* Configuration */
+})
+```
+
+Available configuration:
+
+| Key | Description | Value Type | Default | Required |
+| --- | --- | --- | --- | --- |
+| language | miniapp language | "en", "vi" | "vi" | NO |
+| deepLinkUrl | used to forward deeplink from superapp to miniapp | string | undefined | NO |
+
+
+## Deep Linking
+
+To handle deep links for using **WalletConnect** to connect with a **DApp** in MiniApp, here are the examples:
+
+1. Foreground (SuperApp is open)[](https://reactnative.dev/docs/linking?syntax=ios#1-if-the-app-is-already-open-the-app-is-foregrounded-and-a-linking-url-event-is-fired)
+
+You can handle these events with `Linking.addEventListener('url', callback)` - it calls `callback({url})` with the linked URL
+
+E.g
+
+```jsx
+import ready from '@readyio/react-native-wallet';
+
+useEffect(() => {
+  const handleUrl = (event) => {
+    let url = event.url;
+    //handle other deeplinks
+    if (url.startsWith('wc:') || url.startsWith('readywallet:')) {
+      ready.openApp({ deepLinkUrl: url })
+    }
+  };
+
+  Linking.addEventListener('url', handleUrl);
+
+  return () => {
+    Linking.removeEventListener('url', handleUrl);
+  };
+}, []);
+```
+
+2. Background (SuperApp is running in the background)[](https://reactnative.dev/docs/linking?syntax=ios#2-if-the-app-is-not-already-open-it-is-opened-and-the-url-is-passed-in-as-the-initialurl)
+
+```jsx
+import ready from '@readyio/react-native-wallet';
+
+useEffect(() => {
+  const handleUrl = async (url) => {
+	  //handle other deeplinks
+	  if (url.startsWith('wc:') || url.startsWith('readywallet:')) {
+      ready.openApp({ deepLinkUrl: url })
+    }
+  };
+
+  const getUrlAsync = async () => {
+    const initialUrl = await Linking.getInitialURL();
+    if (initialUrl) {
+      handleUrl(initialUrl);
+    }
+  };
+
+  const handleAppStateChange = (nextAppState) => {
+    if (nextAppState === 'active') {
+      getUrlAsync();
+    }
+  };
+
+  AppState.addEventListener('change', handleAppStateChange);
+
+  return () => {
+    AppState.removeEventListener('change', handleAppStateChange);
+  };
+}, []);
+```
+
+3. App is completely closed
+
+```jsx
+import ready from '@readyio/react-native-wallet';
+
+useEffect(() => {
+  const getUrlAsync = async () => {
+    const initialUrl = await Linking.getInitialURL();
+    if (initialUrl) {
+	    //handle other deeplinks
+      if (url.startsWith('wc:') || url.startsWith('readywallet:')) {
+	      ready.openApp({ deepLinkUrl: url })
+	    }
+    }
+  };
+
+  getUrlAsync();
+}, []);
+```
+
+## Push Notification
+
+### Register for Firebase Cloud Messaging with Ready
+
+Set up Ready miniapp push notification server by registering a Firebase Cloud Messaging API server key for Ready Team.
+
+![Firebase Server Key](./assets/firebase.png)
+
+### Config in client
+
+An example of setting up ready push notification using `@react-native-firebase/messaging`
+
+1. Setup device token
+```js
+  import ready from '@readyio/react-native-wallet';
+  import messaging from '@react-native-firebase/messaging'
+
+  // Setup FCM token
+  messaging().getToken().then((token) => {
+    ready.setDeviceToken(token)
+    // Do logic here
+  })
+
+```
+
+2. Setup handler
+
+```js
+  import ready from '@readyio/react-native-wallet';
+  import messaging from '@react-native-firebase/messaging'
+
+  // Forground handler
+  messaging().onMessage((message: FirebaseMessagingTypes.RemoteMessage) => {
+    if (ready.isReadyPush(message)) return
+
+    // Handle non-ready message
+  })
+
+  // Background handler
+  messaging().setBackgroundMessageHandler(async (message: FirebaseMessagingTypes.RemoteMessage) => {
+    if (ready.isReadyPush(message)) return
+
+    // Handle non-ready message
+  })
+
+```
+
+
+## Supported Versions
+
+The library version is stable and works without issues when using React Native version 0.71.8. If you encounter any errors during the installation process, please contact the Ready Team for support.
+
+## Contributing
+
+See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
+
+## License
+
+MIT
+

package/android/build.gradle

@@ -0,0 +1,117 @@
+buildscript {
+  repositories {
+    google()
+    mavenCentral()
+  }
+
+  dependencies {
+    classpath "com.android.tools.build:gradle:7.2.1"
+  }
+}
+
+def isNewArchitectureEnabled() {
+  return rootProject.hasProperty("newArchEnabled") && rootProject.getProperty("newArchEnabled") == "true"
+}
+
+apply plugin: "com.android.library"
+
+if (isNewArchitectureEnabled()) {
+  apply plugin: "com.facebook.react"
+}
+
+def getExtOrDefault(name) {
+  return rootProject.ext.has(name) ? rootProject.ext.get(name) : project.properties["ReadyWallet_" + name]
+}
+
+def getExtOrIntegerDefault(name) {
+  return rootProject.ext.has(name) ? rootProject.ext.get(name) : (project.properties["ReadyWallet_" + name]).toInteger()
+}
+
+def supportsNamespace() {
+  def parsed = com.android.Version.ANDROID_GRADLE_PLUGIN_VERSION.tokenize('.')
+  def major = parsed[0].toInteger()
+  def minor = parsed[1].toInteger()
+
+  // Namespace support was added in 7.3.0
+  return (major == 7 && minor >= 3) || major >= 8
+}
+
+android {
+  if (supportsNamespace()) {
+    namespace "com.readyio.ReadyWallet"
+
+    sourceSets {
+      main {
+        manifest.srcFile "src/main/AndroidManifestNew.xml"
+      }
+    }
+  }
+
+  compileSdkVersion getExtOrIntegerDefault("compileSdkVersion")
+
+  defaultConfig {
+    minSdkVersion getExtOrIntegerDefault("minSdkVersion")
+    targetSdkVersion getExtOrIntegerDefault("targetSdkVersion")
+    missingDimensionStrategy 'react-native-camera', 'general'
+  }
+
+  buildTypes {
+    release {
+      minifyEnabled false
+    }
+  }
+
+  lintOptions {
+    disable "GradleCompatible"
+  }
+
+  compileOptions {
+    sourceCompatibility JavaVersion.VERSION_1_8
+    targetCompatibility JavaVersion.VERSION_1_8
+  }
+}
+
+repositories {
+  mavenCentral()
+  google()
+}
+
+
+dependencies {
+  // For < 0.71, this will be from the local maven repo
+  // For > 0.71, this will be replaced by `com.facebook.react:react-android:$version` by react gradle plugin
+  //noinspection GradleDynamicVersion
+  implementation "com.facebook.react:react-native:+"
+
+  implementation('org.bitcoinj:bitcoinj-core:0.16.1') {
+    exclude group: 'net.jcip', module: 'jcip-annotations'
+  }
+  implementation 'org.whispersystems:curve25519-android:0.2.5'
+  implementation ('org.web3j:core:4.8.7-android')
+  implementation project(path: ':react-native-randombytes')
+  implementation project(path: ':react-native-gesture-handler')
+  implementation project(path: ':react-native-async-storage_async-storage')
+  implementation project(path: ':react-native-safe-area-context')
+  implementation project(path: ':react-native-community_netinfo')
+  implementation project(path: ':react-native-share')
+  implementation project(path: ':react-native-reanimated')
+  implementation project(path: ':react-native-clipboard_clipboard')
+  implementation project(path: ':react-native-fs')
+  implementation project(path: ':react-native-device-info')
+  implementation project(path: ':react-native-biometrics')
+  implementation project(path: ':react-native-get-random-values')
+  implementation project(path: ':nozbe_watermelondb')
+  implementation project(path: ':react-native-camera')
+  implementation project(path: ':react-native-svg')
+  implementation project(path: ':react-native-keychain')
+  implementation project(path: ':react-native-camera-roll_camera-roll')
+  implementation project(path: ':sentry_react-native')
+  implementation project(path: ':react-native-webview')
+  implementation project(path: ':walletconnect_react-native-compat')
+  implementation project(path: ':react-native-view-shot')
+  implementation project(path: ':react-native-community_datetimepicker')
+  implementation project(path: ':react-native-firebase_app')
+  implementation project(path: ':react-native-firebase_analytics')
+  implementation project(path: ':react-native-gzip')
+}
+

package/android/gradle.properties

@@ -0,0 +1,5 @@
+ReadyWallet__kotlinVersion=1.7.0
+ReadyWallet__minSdkVersion=21
+ReadyWallet__targetSdkVersion=31
+ReadyWallet__compileSdkVersion=31
+ReadyWallet__ndkversion=21.4.7075529

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1,3 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+          package="com.readyio.readywallet">
+</manifest>

package/android/src/main/AndroidManifestNew.xml

@@ -0,0 +1,2 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+</manifest>