nitowa 50fa056fe3 add more utility functions and improved tests		vor 1 Jahr
src	add more utility functions and improved tests	vor 1 Jahr
test	add more utility functions and improved tests	vor 1 Jahr
.drone.yml	remove test step from done	vor 2 Jahren
.gitignore	fix doc generation	vor 2 Jahren
.npmignore	remove picture and blacklist ripple-lib bindings from npm	vor 2 Jahren
LICENSE.md	rebase to npm-packages, add README and LICENSE	vor 2 Jahren
README.md	update README	vor 2 Jahren
package-lock.json	update deps and fix vulns	vor 1 Jahr
package.json	add more utility functions and improved tests	vor 1 Jahr
tsconfig.json	update testnet node address because it moved	vor 3 Jahren

Overview

xrpio is a library that allows you to write and read arbitrary data in the ripple blockchain.

How to install

npm i xrpio

How it works

Transactions on the ripple blockchain are allowed to carry up to 1kB of arbitrary data via the memo field. We can use this to store data of any size by building a tree of references between these transactions that can then be reassembled by reading them back from the blockchain. In order to generate these transactions xrpio sends payments with the minimum denomination between two wallets controlled by the user.

xrpio automatically takes care of the logistics behind this technique as well as compression of the data.

Highly simplified, you can visualize the process like this:

In practice each node does of course store significantly more data.

Caution

This library is in an early stage of development and breaking changes may occur spontaneously and without regard of semantic versioning until the v1.0.0 release.

Operation on the main-net is untested and should not be used in production! If you want to deploy this library with the main-net please download the sources and modify them to your needs.

Quickstart

import { xrpIO } from "xrpio"

const api = new xrpIO("wss://some_ripple_node.net:51233")
await api.connect()

txHash = await api.treeWrite("arbitrary text 123", receiveWallet.address, sendWallet.secret)
data = await api.treeRead([txHash])

console.log(data) //"arbitrary text 123"

Known Bugs

When using large data (>300kB) and public nodes, the writing process may fail due to rate limits. xrpio will attempt to mitigate this, but success is inconsistent.

README.md