Merge pull request #297 from EdgeApp/william/native-build

Add native build

.eslintignore

@@ -1,4 +1,4 @@
-/lib/
-/node_modules/
-/.nyc_output/
+/android/src/main/assets/edge-exchange-plugins/
 /coverage/
+/dist/
+/lib/

.gitignore

@@ -1,12 +1,19 @@
-# Javascript:
-lib/
+# Build output:
+/.nyc_output/
+/android/.gradle
+/android/*.jar
+/android/src/main/assets/edge-exchange-plugins/
+/coverage/
+/dist/
+/lib/
+
+# Package managers:
 node_modules/
+npm-debug.log
 package-lock.json
+yarn-error.log
 
 # Editors:
+.DS_Store
 .idea/
 .vscode/
-
-# Test results:
-.nyc_output/
-/coverage/

.nycrc.json

@@ -1,6 +1,5 @@
 {
-  "include": ["src/**/*.ts"],
   "extension": [".ts"],
-  "require": ["sucrase/register"],
-  "all": true
-}
+  "include": ["src/**/*.ts"],
+  "require": ["sucrase/register"]
+}

CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ## Unreleased
 
+- changed: Simplify our React Native integration.
+- removed: Delete all rate plugins.
+
 ## 0.22.0 (2023-10-24)
 
 - changed: Thorchain quotes to estimate rate

README.md

@@ -2,32 +2,63 @@
 
 This library exports a collection of exchange-rate & swap plugins for use with [`edge-core-js`](https://github.com/EdgeApp/edge-core-js).
 
-Use it like this:
+Please see [index.js](./src/index.js) for the list of plugins in this repo. These are compatible with edge-core-js v0.19.31 or later.
+
+## Installing
+
+Fist, add this library to your project:
+
+```sh
+yarn add edge-exchange-plugins
+```
+
+### Node.js
+
+For Node.js, you should call `addEdgeCorePlugins` to register these plugins with edge-core-js:
 
 ```js
-import {
-  addEdgeCorePlugins,
-  lockEdgeCorePlugins,
-  makeEdgeContext
-} from 'edge-core-js'
-import exchangePlugins from 'edge-exchange-plugins'
-
-addEdgeCorePlugins(exchangePlugins)
+const { addEdgeCorePlugins, lockEdgeCorePlugins } = require('edge-core-js')
+const plugins = require('edge-exchange-plugins')
+
+addEdgeCorePlugins(plugins)
+
+// Once you are done adding plugins, call this:
 lockEdgeCorePlugins()
+```
 
-makeEdgeContext({
-  apiKey: '',
-  appId: '',
-  plugins: {
-    // Plugin names from edge-exchange-plugins:
-    coinbase: true,
-    shapeshift: true
-  }
+You can also add plugins individually if you want to be more picky:
+
+```js
+addEdgeCorePlugins({
+  thorchain: plugins.thorchain
 })
+```
+
+### Browser
+
+The bundle located in `dist/edge-exchange-plugins.js` will automatically register itself with edge-core-js. Just serve the entire `dist` directory along with your app, and then load the script:
 
+```html
+<script src='https://example.com/app/dist/edge-exchange-plugins.js'>
 ```
 
-Please see [index.js](./src/index.js) for the list of plugins in this repo.
+If you want to debug this project, run `yarn start` to start a Webpack server,
+and then adjust your script URL to http://localhost:8083/edge-exchange-plugins.js.
+
+### React Native
+
+This package will automatically install itself using React Native autolinking. To integrate the plugins with edge-core-js, add its URI to the context component:
+
+```jsx
+import { pluginUri } from 'edge-exchange-plugins'
+
+<MakeEdgeContext
+  pluginUris={[pluginUri]}
+  // Plus other props as required...
+/>
+```
+
+To debug this project, run `yarn start` to start a Webpack server, and then use `debugUri` instead of `pluginUri`.
 
 ## edge-react-gui
 
@@ -39,16 +70,17 @@ To test your exchange plugin, build the full application at [`edge-react-gui`](h
 
 Clone this repo as a peer in the same directory as `edge-react-gui`. Then run
 
-```
+```sh
 yarn
 yarn prepare
 ```
 
 From within the `edge-react-gui`
 
-```
+```sh
 yarn updot edge-exchange-plugins
 yarn prepare
+yarn prepare.ios # For iPhone development
 ```
 
 Make appropriate changes to `edge-react-gui` to include your plugin. Search `edge-react-gui` for the string `changelly` and make similar changes for your plugin.

android/build.gradle

@@ -0,0 +1,34 @@
+buildscript {
+  repositories {
+    google()
+    mavenCentral()
+  }
+
+  dependencies {
+    classpath "com.android.tools.build:gradle:7.3.1"
+  }
+}
+
+apply plugin: 'com.android.library'
+
+def safeExtGet(prop, fallback) {
+  rootProject.ext.has(prop) ? rootProject.ext.get(prop) : fallback
+}
+
+android {
+  compileSdkVersion safeExtGet('compileSdkVersion', 28)
+  defaultConfig {
+    minSdkVersion safeExtGet('minSdkVersion', 19)
+    targetSdkVersion safeExtGet('targetSdkVersion', 27)
+  }
+  lintOptions {
+    abortOnError false
+  }
+}
+
+repositories {
+}
+
+dependencies {
+  implementation 'com.facebook.react:react-native:+'
+}

android/format-java.sh

@@ -0,0 +1,19 @@
+#!/usr/bin/env sh
+
+here=$(dirname $0)
+
+formatJava() {
+  tool="google-java-format-1.7-all-deps.jar"
+  url="https://github.com/google/google-java-format/releases/download/google-java-format-1.7/$tool"
+  jar="$here/$tool"
+
+  # If the tool is missing, grab it from GitHub:
+  if [ ! -e "$jar" ]; then
+    curl -L -o "$jar" "$url"
+  fi
+
+  echo $(find "$here/src" -name "*.java")
+  java -jar "$jar" --replace $(find "$here/src" -name "*.java")
+}
+
+formatJava

android/src/main/AndroidManifest.xml

@@ -0,0 +1,3 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+          package="app.edge.reactnative.exchange">
+</manifest>

android/src/main/java/app/edge/reactnative/exchange/EdgeExchangePluginsModule.java

@@ -0,0 +1,26 @@
+package app.edge.reactnative.exchange;
+
+import com.facebook.react.bridge.ReactApplicationContext;
+import com.facebook.react.bridge.ReactContextBaseJavaModule;
+import java.util.HashMap;
+import java.util.Map;
+
+public class EdgeExchangePluginsModule extends ReactContextBaseJavaModule {
+  EdgeExchangePluginsModule(ReactApplicationContext context) {
+    super(context);
+  }
+
+  @Override
+  public Map<String, Object> getConstants() {
+    final Map<String, Object> constants = new HashMap<>();
+    constants.put(
+        "sourceUri",
+        "file:///android_asset/edge-exchange-plugins/edge-exchange-plugins.js");
+    return constants;
+  }
+
+  @Override
+  public String getName() {
+    return "EdgeExchangePluginsModule";
+  }
+}

android/src/main/java/app/edge/reactnative/exchange/EdgeExchangePluginsPackage.java

@@ -0,0 +1,24 @@
+package app.edge.reactnative.exchange;
+
+import androidx.annotation.NonNull;
+import com.facebook.react.ReactPackage;
+import com.facebook.react.bridge.NativeModule;
+import com.facebook.react.bridge.ReactApplicationContext;
+import com.facebook.react.uimanager.ViewManager;
+import java.util.Collections;
+import java.util.List;
+
+public class EdgeExchangePluginsPackage implements ReactPackage {
+  @NonNull
+  @Override
+  public List<NativeModule> createNativeModules(@NonNull ReactApplicationContext reactContext) {
+    return Collections.<NativeModule>singletonList(
+        new EdgeExchangePluginsModule(reactContext));
+  }
+
+  @NonNull
+  @Override
+  public List<ViewManager> createViewManagers(@NonNull ReactApplicationContext reactContext) {
+    return Collections.emptyList();
+  }
+}

edge-exchange-plugins.d.ts

@@ -0,0 +1,18 @@
+import { EdgeCorePluginOptions, EdgeCurrencyPlugin } from 'edge-core-js/types'
+
+/* Debug-mode URI to use on React Native. */
+export const debugUri: string
+
+/* Regular URI to use on React Native. */
+export const pluginUri: string
+
+type EdgeCorePluginFactory = (env: EdgeCorePluginOptions) => EdgeCurrencyPlugin
+
+/**
+ * The Node.js default export.
+ */
+declare const plugins: {
+  [pluginId: string]: EdgeCorePluginFactory
+}
+
+export default plugins

edge-exchange-plugins.podspec

@@ -0,0 +1,28 @@
+require "json"
+
+package = JSON.parse(File.read(File.join(__dir__, "package.json")))
+
+Pod::Spec.new do |s|
+  s.name         = package['name']
+  s.version      = package['version']
+  s.summary      = package['description']
+  s.homepage     = package['homepage']
+  s.license      = package['license']
+  s.authors      = package['author']
+
+  s.platform     = :ios, "9.0"
+  s.requires_arc = true
+  s.source = {
+    :git => "https://github.com/EdgeApp/edge-exchange-plugins.git",
+    :tag => "v#{s.version}"
+  }
+  s.source_files =
+    "ios/EdgeExchangePluginsModule.swift",
+    "ios/EdgeExchangePluginsModule.m"
+
+  s.resource_bundles = {
+    "edge-exchange-plugins" => "android/src/main/assets/edge-exchange-plugins/*.js"
+  }
+
+  s.dependency "React-Core"
+end

ios/EdgeExchangePluginsModule.m

@@ -0,0 +1,4 @@
+#import <React/RCTBridgeModule.h>
+
+@interface RCT_EXTERN_MODULE(EdgeExchangePluginsModule, NSObject)
+@end

ios/EdgeExchangePluginsModule.swift

@@ -0,0 +1,20 @@
+@objc(EdgeExchangePluginsModule) class EdgeExchangePluginsModule: NSObject {
+  @objc static func requiresMainQueueSetup() -> Bool { return false }
+
+  @objc func constantsToExport() -> NSDictionary {
+    return ["sourceUri": sourceUri() ?? ""]
+  }
+
+  func sourceUri() -> String? {
+    if let bundleUrl = Bundle.main.url(
+      forResource: "edge-exchange-plugins",
+      withExtension: "bundle"
+    ),
+      let bundle = Bundle(url: bundleUrl),
+      let script = bundle.url(forResource: "edge-exchange-plugins", withExtension: "js")
+    {
+      return script.absoluteString
+    }
+    return nil
+  }
+}

ios/edge-exchange-plugins/project.pbxproj

@@ -0,0 +1 @@
+// Placeholder so react-native autolinking can find us.