Skip to content
This repository has been archived by the owner on Mar 17, 2022. It is now read-only.

Java version of ripple-lib (work in progress)

License

Notifications You must be signed in to change notification settings

xpring-eng/ripple-lib-java

 
 

Repository files navigation

The Ripple Java Library CircleCI codecov Dependabot Status

THIS LIBRARY HAS NOT BEEN USED IN PRODUCTION FOR PROCESSING REAL MONEY. DO NOT USE UNLESS YOU KNOW WHAT YOU ARE DOING.

Yes, ripple-lib-java is Java code for working with... ripple.

I (@sublimator) wrote this haphazardly over the years while working at ripple, firstly as a weekend project to learn the protocol, and given my acquaintance, it was my goto tool when processing millions of old transactions, looking for transactions that violated implicit invariants. The nodejs ripple-lib has very slow binary support, and no out of the box threading.

The Java client is crude, and the async model used is basically a port of nodejs EventEmitter, with on(key, callback) handlers, and keeping to a single thread. It is not very a nice API, and could do with modernizing to use RxJava etc.

Likewise, the Transaction/LedgerEntry objects are merely wrappers around TreeMap<Field, SerializedType> and don't make good use of libraries like Jackson to auto populate fields.

See: ripple-lib-java-sucks

Current status

  • Binary serialization/parsing/shamap
  • Crude implementation of a high level client
    • Single threaded
    • High level helper classes
      • AccountTxPager (wraps account_tx)
      • PaymentFlow (wraps path_find)
    • Automatic transaction resubmission
      • Resubmits transactions in manner resilient to poor network conditions
        • !!!NEEDS TESTING AGAINST LATEST RIPPLED!!!
  • Api client choice of WebSocket transport
  • Test suite for core types
  • Signing / Verification
  • KeyPair creation

Docs

TODO

  • See the issues!
  • Documentation
  • Complete test coverage

Examples

  • See in ripple-examples/ folder

About

Java version of ripple-lib (work in progress)

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Java 89.8%
  • Kotlin 10.1%
  • Other 0.1%