edge-core-js 0.18.11 → 0.19.0

package/CHANGELOG.md

@@ -1,5 +1,36 @@
 # edge-core-js
 
+## v0.19.0 (2022-01-11)
+
+This release completely changes the way React Native works, both to improve performance and to make integration and debugging much easier.
+
+- changed: Simplify the React Native integration to "just work".
+  - Stop depending on external libraries such as react-native-fast-crypto, react-native-randombytes, or react-native-webview.
+  - Use React Native auto-linking to integrate all native code, HTML, and Javascript needed to run the core.
+  - Accept core plugins via a `pluginUris` prop to `MakeEdgeContext` or `MakeFakeEdgeWorld`.
+  - Allow core debugging by running `yarn start` in this repo to start a dev server, and then setting the `debug` prop to true.
+  - Accept an `allowDebugging` prop on Android to enable WebView debugging in general (useful for debugging plugins).
+- changed: Require `EdgeCurrencyEngine` methods to return promises.
+- changed: Mark methods as `readonly` in the TypeScript definitions, to match what Flow was already doing.
+
+## v0.18.14 (2021-01-06)
+
+- fixed: Allow logins with an appId to approve or reject vouchers.
+- added: Allow maximum swaps by passing "max" to `EdgeSwapRequest.quoteFor`.
+- added: Add an `EdgeCurrencyEngine.getMaxSpendable` method for native max-spend calculations.
+
+## v0.18.13 (2021-12-17)
+
+- added: `EdgeSpendTarget.memo`, which is a renamed version of `EdgeSpendTarget.uniqueIdentifier`.
+- added: `EdgeCurrencyInfo.memoType`, `EdgeCurrencyInfo.memoMaxLength`, `EdgeCurrencyInfo.memoMaxValue`. Use these to learn which currencies support memos.
+- added: `EdgeCurrencyTools.validateMemo` & `EdgeCurrencyWallet.validateMemo`. Use these to check memos for validity before sending.
+- deprecated: `EdgeSpendTarget.uniqueIdentifier`. Use `EdgeSpendTarget.memo` instead.
+
+## v0.18.12 (2021-12-10)
+
+- fixed: Gracefully handle errors while reading the exchange-rate hint cache.
+- fixed: Correctly match server-returned children with their on-disk stash entries. This produces more accurate errors if the server loses a child.
+
 ## v0.18.11 (2021-11-07)
 
 - fixed: onWcNewContractCall callback type

package/README.md

@@ -16,7 +16,9 @@ To quickly get up and running with the UI for account creation, login, and manag
 
 ## Setup
 
-Just use `npm install --save edge-core-js` to add this library to your project.
+Add this library to your project using `npm install --save edge-core-js`.
+
+### Node.js & Browsers
 
 To create an `EdgeContext` object, which provides various methods for logging in and creating account, do something like this:
 
@@ -45,32 +47,47 @@ addEdgeCorePlugins(currencyPlugins)
 lockEdgeCorePlugins()
 ```
 
-The above code sample works for Node.js. For the browser and React Native, plugins load using a `<script>` tag. The `lockEdgeCorePlugins` is necessary on all platforms, and must happen before login can proceed.
+If the core seems to hang forever when logging in, you probably forgot to call `lockEdgeCorePlugins`.
+
+Please note that edge-core-js uses modern JavaScript syntax features such as `async`, so you may need to run the library through [Babel](https://babeljs.io/) if you plan to run it in a browser. Node 10+ supports these features natively.
 
 ### React Native
 
-This library has React Native support. Starting at version 0.15.0, however, it achieves this support by running most of its logic inside a WebView component. This has several important advantages, including better performance, but it makes integration quite complicated. We are in the process of simplifying and documenting the necessary steps. In the mean time, please refer to the [edge-react-gui](https://github.com/EdgeApp/edge-react-gui) project for an example of what this integration looks like.
+Edge-core-js directly supports React Native v0.60+ with autolinking. Simply add edge-core-js to your application, and React Native will link the necessary native modules & assets.
 
-### Platform Requirements
+To create an `EdgeContext` object, you need to mount a component:
 
-This library uses modern Javascript syntax features from ES 2018. While these work fine in recent browsers, React Native, and Node 10+, you might need to run this library through [Babel](https://babeljs.io/) if you care about older systems.
+```jsx
+<MakeEdgeContext
+  // Get this from our support team:
+  apiKey="..."
+  appId="com.your-app"
 
-On the other hand, this library avoids modern run-time features from ES 2015 or later, so you don't need to provide polyfills. The only features we use from ES 2015 or later are:
+  // Configure currencies and swap providers you want to use:
+  plugins={{
+    'bitcoin': true
+  }}
+  pluginUris={[
+    "edge-currency-plugins.js",
+    "edge-exchange-plugins.js"
+  ]}
+
+  // Called when the core is done loading:
+  onLoad={edgeContext => {}}
+  onError={error => {}}
+/>
+```
 
-- `Object.assign`
-- `Promise`
-- `Uint8Array`
+The core itself runs inside a hidden WebView, which this `MakeEdgeContext` component mounts & manages.
 
-If you want to run in the browser, you must also have:
+The core creates a `<script>` tag for each source file in the `pluginUris` array. For this to work, you need to add these plugin files to your app's native asset bundle, which is located at `/android/app/src/main/assets/` on Android. For iOS, drag these files into the "Resources" section of your Xcode project.
 
-- `fetch`
-- `localStorage`
-- `Window.crypto.getRandomNumbers`
+To debug the core, run `yarn start` inside the edge-core-js project, and then pass a `debug={true}` property to the `MakeEdgeContext` component. This tells the WebView to load the core from a local development server.
 
 ## Contributing
 
-Run `yarn` to download dependencies and build the library, then run `yarn test` to run the unit tests, and `yarn flow` to check for type errors.
+Run `yarn` to download dependencies, and then run `yarn prepare` to build the library.
 
-All sources are in the [JavaScript Standard Style](http://standardjs.com/) + [Prettier](https://prettier.io/). We check files prior to each commit, so if you have formatting issues, you can run `yarn fix` to fix them automatically.
+Use `yarn verify` to run all our code-quality tools. All sources are in the [JavaScript Standard Style](http://standardjs.com/) + [Prettier](https://prettier.io/). We check files prior to each commit, so if you have formatting issues, you can run `yarn fix` to fix them automatically.
 
 If you use Visual Studio Code, consider installing the [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) extension. This will give you nice error highlighting as you work, along with quick fixes for formatting issues.

package/android/build.gradle

@@ -0,0 +1,52 @@
+buildscript {
+  repositories {
+    google()
+    jcenter()
+  }
+
+  dependencies {
+    classpath 'com.android.tools.build:gradle:3.6.0'
+  }
+}
+
+apply plugin: 'com.android.library'
+
+def safeExtGet(prop, fallback) {
+  rootProject.ext.has(prop) ? rootProject.ext.get(prop) : fallback
+}
+
+def DEFAULT_COMPILE_SDK_VERSION = 28
+def DEFAULT_BUILD_TOOLS_VERSION = '28.0.2'
+def DEFAULT_MIN_SDK_VERSION = 19
+def DEFAULT_TARGET_SDK_VERSION = 27
+def DEFAULT_WEBKIT_VERSION = '1.4.0'
+
+android {
+  compileSdkVersion safeExtGet('compileSdkVersion', DEFAULT_COMPILE_SDK_VERSION)
+  buildToolsVersion safeExtGet('buildToolsVersion', DEFAULT_BUILD_TOOLS_VERSION)
+
+  defaultConfig {
+    minSdkVersion safeExtGet('minSdkVersion', DEFAULT_MIN_SDK_VERSION)
+    targetSdkVersion safeExtGet('targetSdkVersion', DEFAULT_TARGET_SDK_VERSION)
+    versionCode 1
+    versionName '1.0'
+  }
+  lintOptions {
+    abortOnError false
+  }
+  externalNativeBuild {
+    cmake {
+      path "src/main/cpp/CMakeLists.txt"
+    }
+  }
+}
+
+repositories {
+}
+
+def webkit_version = safeExtGet('webkitVersion', DEFAULT_WEBKIT_VERSION)
+
+dependencies {
+  implementation "androidx.webkit:webkit:$webkit_version"
+  implementation 'com.facebook.react:react-native:+'
+}

package/android/src/main/AndroidManifest.xml

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