edge-currency-accountbased

Edge currency plugin for account based currencies

Usage no npm install needed!

<script type="module">
  import edgeCurrencyAccountbased from 'https://cdn.skypack.dev/edge-currency-accountbased';
</script>

README

Edge Currency Plugin for Account-Based currencies

Build Status NPM version Dependency Status

js-standard-style

Implements Bitcoin send/receive functionality per the spec for crypto currency plugins for edge-core-js

Installing

npm i edge-currency-accountbased -s

import { stellarCurrencyPluginFactory } from `edge-currency-accountbased`
import { rippleCurrencyPluginFactory } from `edge-currency-accountbased`

Now you can pass plugins to edge-core-js.

const plugins = [
    stellarCurrencyPluginFactory,
    rippleCurrencyPluginFactory
]
const context = makeEdgeContext({
  apiKey: YOUR_API_KEY,
  plugins
})

Contributing

You'll need to install Yarn 1.3.2 globally on your machine

To run a local version of this repo inside the full Edge Wallet app, clone this repo at the same level as edge-react-gui

git clone git@github.com:EdgeApp/edge-currency-accountbased.git`
cd edge-currency-accountbased
yarn

Run npm run test to run the unit tests.

To use the local cloned version of this repo, cd edge-react-gui and run

npm run updot edge-currency-accountbased
npm run postinstall

This will copy the necessary files from edge-currency-accountbased into the edge-react-gui/node_modules/edge-currency-accountbased replacing the npm installed version. This needs to be done after any modifications to edge-currency-accountbased

Adding a New Blockchain / Currency

Please note that our team considers (but does not guarantee) PR's to add new currencies / blockchains to this repo's master branch (included into production version of Edge Wallet). Among other requirements the code must satisfy the following guidelines:

License

BSD 3