edge-currency-plugins 2.6.1 → 3.0.0

package/README.md

@@ -1,3 +1,62 @@
-# edge-currency-plugins 
+# Edge Currency Plugin for UTXO-Based currencies
 
-> Plugins for edge-core-js to support various cryptocurrencies such as bitcoin, bitcoin cash, and litecoin, 
+> Plugins for [edge-core-js](https://github.com/EdgeApp/edge-core-js), to support various cryptocurrencies such as bitcoin, bitcoin cash, and litecoin,
+
+## Installing
+
+First, add this library to your project:
+
+```sh
+npm i -s edge-currency-plugins
+```
+
+### Node.js
+
+For Node.js, you should call `addEdgeCorePlugins` to register these plugins with edge-core-js:
+
+```js
+const { addEdgeCorePlugins, lockEdgeCorePlugins } = require("edge-core-js");
+const plugins = require("edge-currency-plugins");
+
+addEdgeCorePlugins(plugins);
+
+// Once you are done adding plugins, call this:
+lockEdgeCorePlugins();
+```
+
+You can also add plugins individually if you want to be more picky:
+
+```js
+addEdgeCorePlugins({
+  bitcoin: plugins.bitcoin,
+});
+```
+
+### Browser
+
+The bundle located in `dist/edge-currency-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-currency-plugins.js'>
+```
+
+If you want to debug this project, run `yarn start` to start a Webpack server,
+and then adjust your script URL to http://localhost:8081/edge-currency-plugins.js.
+
+### React Native
+
+The `edge-currency-plugins` 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, makePluginIo } from "edge-currency-plugins";
+<MakeEdgeContext
+  nativeIo={{
+    "edge-currency-plugins": makePluginIo(),
+  }}
+  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`.

package/android/build.gradle

@@ -0,0 +1,45 @@
+buildscript {
+  repositories {
+    google()
+    mavenCentral()
+  }
+
+  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
+
+android {
+  namespace "app.edge.reactnative.currencyplugins"
+
+  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
+  }
+}
+
+repositories {
+}
+
+dependencies {
+  implementation 'com.facebook.react:react-native:+'
+}

package/android/src/main/AndroidManifest.xml

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