Skip to main content

Ripple ledger extractor

This project has been archived.

The maintainers of this project have marked this project as archived. No new releases are expected.

Project description

Download the Ripple ledger from rippled.

Grapple extracts the ledger from rippled via websocket. It starts at the current ledger index, and walks backwards until it reaches the genesis ledger. The genesis ledger index is set by default to 152370, but is adjustable.

Grapple can collect data from a local or remote rippled instance. If you have a local rippled instance running that has downloaded all or most of the ledger, I strongly recommend doing local data collection. Fetching data from Ripple’s public websocket is very slow!

Also resamples the transaction time series to create “Open-Hi-Lo-Close” data, which can be useful for statistical tests, or simply for drawing charts.

Installation

The easiest way to install Grapple is using pip:

pip install grapple

Grapple is designed to integrate with PostgreSQL, using connection information in config.py. By default, it assumes that your database is located on localhost (127.0.0.1), and that your database username, password, and password are all “grapple”.

(While this is certainly not the most secure setup, it may be convenient for people who install Grapple via pip, and do not wish to edit its source code.)

Usage

Grapple can be used as a Python module:

from grapple import Grapple

grapple = Grapple()
grapple.download()

The Grapple constructor accepts the following keyword arguments:

socket_url (str):

rippled websocket URL (default=”ws://127.0.0.1:6006/”)

full (bool):

True if downloading the full ledger (starting from the current ledger and walking back to the genesis ledger). False if the download should stop at the last current ledger (i.e., the last time grapple was run). (default=True)

genesis (int):

Genesis block index. If full=True, this is where the download ends; otherwise, this value is ignored. (default=152370)

quiet (bool):

If True, suppress console output. (default=True)

resampling_frequencies (tuple):

Resampling frequencies, using pandas frequency codes. If None, then resampling is disabled. (default=(‘D’,) or daily)

It can also be run as a script:

python grapple.py [-flags]

Optional flags:

-w, --websocket [websocket url]:
    Specify the rippled websocket url. (default=ws://127.0.0.1:6006/)

-p, --public:
    Use Ripple Labs' public websocket, wss://s1.ripple.com:51233.

-f, --full:
    Download the full Ripple ledger.  Automatic on your first run.

-g, --genesis [ledger index]:
    Halting point for full downloads; ignored for partial downloads.

-q, --quiet:
    Suppress command line output.

Copyright 2014, Dyffy Inc. License: MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

grapple-0.1.2.tar.gz (8.3 kB view details)

Uploaded Source

File details

Details for the file grapple-0.1.2.tar.gz.

File metadata

  • Download URL: grapple-0.1.2.tar.gz
  • Upload date:
  • Size: 8.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for grapple-0.1.2.tar.gz
Algorithm Hash digest
SHA256 b637771c9f2febe8df725a605685a239d43072abaa3af2a5f0e8c40464a9b6a4
MD5 0fb5dcef416d7579b21d2839ca6563d0
BLAKE2b-256 5dac17d0405688ee92aa52900c668121f2ac6a9cf02a63fdde6ef288398c2779

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page