XRPL Order Toolkit

This is a collection of scripts to manage XRPL orders. XRPL has a builtin decentralized exchange which natively supports limit order.

You can see the live orderbook for any currency pair on the following two websites:

• https://xrpcharts.ripple.com
• https://orderbook.xrp.ninja

Install dependencies

# npm install -g bignumber.js fs lodash ripple-lib ripple-lib-orderbook ripple-lib-value sprintf-js yargs

Configuration

Most of the scripts share a common config file which is specified by flag --secret_file whose default value is .secret.json. You need to create this file yourself. The format looks like:

{ 
  "account": "rxxx",
  "secret": "sxxx",
  "pair": {
    "base": {
      "currency": "XRP"
    },
    "counter": {
      "currency": "USD",
      "counterparty": "ryyy"
    }
  }
}

The base currency means the currency to buy or sell.

Example usage

The following example would work if you have a configuration file which looks like the one above.

• Place buy order

  • $ ./placeOrder.js -t buy -q 100 -p 0.3
  • This will place an order to spend 100 USD to buy XRP at price $0.3.
  • Please note that the quantity here is not in XRP but in USD.

• Place sell order

  • $ ./placeOrder.js -t sell -q 300 -p 0.35
  • This will place an order to sell 300 XRP for USD at price $0.35

• Move a buy order to a new price

  • $ ./moveOrder.js -t buy -o 0.3 -n 0.25
  • This will replace the buy order you placed at $0.3 with a new buy order which buys XRP with the same amount of USD at the new price $0.25.

• Move a sell order to a new price

  • $ ./moveOrder.js -t sell -o 0.35 -n 0.4
  • This will replace the sell order you placed at $0.35 with a new sell order which sells the same amount of XRP at the new price $0.4.

• Get existing orders

  • $ ./getOrders.js -t sell
  • This will print all sell orders. It will show the sequence of each order among other things.

• Cancel an existing order

  • $ ./cancelOrder.js -s 111
  • This will cancel the order whose sequence is 111.