/node-red-contrib-xrpl

XRP Ledger, Node-Red Integration

Primary LanguageHTMLMIT LicenseMIT


Redefining the future one integration at a time

The XRP Ledger nodes for Node-Red


NPM Version GitHub last commit DeepScan grade Open Issues

These nodes will allow you to:

  • Fully interact with the XRP Ledger directly from Node-Red.
    • Generate new XRP accounts using Family Seeds, Mnemonics or even Secret Numbers!!
    • Get account transactions
    • Subscribe to account transactions
    • Get account information and settings
    • Send XRP with invoiceID, Memo and Destination Tag support!!!
    • Prepare custom transactions to set account settings such as domain and email fields.
    • Prepare (including generating crypto-conditions), execute and cancel escrows!
    • Multisign!!!
    • Generate QR Codes for XRP Addresses

  • Connect the XRP ledger to any Web API!!
  • Setup regular XRP payments (think of standing orders or direct debits).
  • Create custom digital wallets.
  • Create custom XRP Dashboards.
  • Use XRPL features to create and sign transactions offline!
  • Monitor XRP accounts and auto transfer from one to the other on certain conditions. (Think hot/cold wallets).
  • Smart device integration!!!!! (Alexa, Google Home, Bluetooth Presence Detection, Zigbee, Zwave).
    • Click a wireless smart button to send XRP.
    • Change the colour of your smart bulbs depending on your account balance.
    • Flash your bulbs when you receive a payment.
    • Have Alexa announce incoming transactions to your account (or anyone else's for the matter).
    • Have a dog with a GPS collar and pay for dog walking? Why not automate it, let node-red auto transfer XRP straight to the walker as soon as the dog checks back in at home. You could even calculate the payment based on distance travelled and time walked.
  • Smart Home Integration!!!! (Home Assistant, Samsung SmartThings)
    • Display your XRP wallets on your smart home interfaces.
    • Combine incoming payments with smart home automations.
  • Get notified anyway you want, email, MQTT, google notifications, telegram, pushbullet, FB messenger, slack, twitter, bluetooth speaker (via text to speech - Polly).
  • Build a quick and easy Point of Sale system.
  • Create XRP Bots on most if not all social media platforms.
  • Auto record transactions straight to google spreadsheets.
  • Prototype apps quickly and easily using the XRP testnet.
  • Insert imagination here...

Check out the extensive library of flows and nodes shared by the community, you can get some real inspiration and create some awesome things.

Example flows will be added to this repo on a regular basis, in the meantime you can check out our quick examples here. Share your flows and lets build something great together. Feel free to submit PRs.

Regular Payments Example

Tutorials will be added to the blog on our site once we're ready so stay tuned.

These nodes are still fresh off the keyboard and although a lot of time and effort has gone into testing there is still more testing assurance work to be done. Please test your flows on the testnet before using real zerps and allows be sensible in how you approach this.

Installation Instructions

Node-Red can be installed on pretty much anything, from Raspberry Pis to Android Phones/Tablets, Windows PCs, Linux all the way up to cloud enterprise solutions.

Once you're up and running with Node-Red (see above link) then it's simple to add these set of XRP nodes.

To do this select Manage Palette from the menu (top right), and then select the install tab in the palette. Search for node-red-contrib-XRPL and click install.

After successful installation you will see the XRPL & XRPL Advanced sections added to your node palette.

Now you can begin to interact with the XRPL by dragging and dropping these nodes onto your workspace and wiring them together!

Support The Cause

This tool is provided by XRP Innovations free of charge with a hope to further support the ecosystem.

We're currently self funded and we're looking for funding to get other exciting XRP projects off the ground, if you could help then please drop us a line or alternatively if you'd like to buy us a beer then hit us up here:

XRP Address: rpC3xtJV8fXg4ZzMre3RhMD6ySQeSoXRpi

#XRPtheStandard

#DareToDream

About Us & Thanks

XRP Innovations goal is to support the growth of the blockchain ecosystem.

We are strong believers in distributed ledger technologies and we're so excited to see what's around the corner as this space is moving so quickly.

We'd like to give a big shout out and say thanks to the XRP Community, you truly are inspirational. Let's get creative and build a better, brighter future together.

These are exciting times!

A special thanks to WietseWind and the guys at XRL Labs for the recent support and their awesome tools.

Still to do

  • Add support for XUMM
  • Add a beta pallette for proposals or other test ideas that haven't made their was to the main net.
  • Add images / videos
  • Add example flows
  • Tidy up icons
  • Port to TypeScript
  • Add Unit tests

Done see changelog

  • Choose custom servers
  • Check outputs are consistent
  • Add node status to receiver node
  • Tidy up node descriptions

Legal Notice

This software is provided free of charge and used at your own risk. XRP Innovations cannot be held accountable or responsible for any loss or damage caused by this software.