Skip to main content

XRL Websocket Client

Project description

XRPL Websocket

Documentation Status https://badge.fury.io/py/xrpl-websocket.svg

Websocket client for rippled with reconnecting feature, support both python 2 and 3

Installation

Via pip:

pip install xrpl_websocket

Examples

Short-lived connection

Simple example to send a payload and wait for response

import json

from xrpl_websocket import Client

if __name__ == "__main__":
    # create instance
    client = Client()

    # connect to the websocket
    client.connect(nowait=False)

    # send server info command
    resp = client.send(command='server_info')

    print("Server Info:")
    print(json.dumps(resp, indent = 4))

    # close the connection
    client.disconnect()

More advanced: Custom class

You can also write your own class for the connection, if you want to handle the nitty-gritty details yourself.

class Example(Client):
    def __init__(self):
        super(self.__class__, self).__init__(
            log_level=logging.ERROR,
            server="wss://xrpl.ws"
        )

        # connect to the websocket
        self.connect()

    def on_transaction(self, data):
        print(json.dumps(data, indent = 4))

    def on_ledger(self,data):
        print('on_ledger')

    def on_open(self, connection):
        print("Connection is open")

        print("Subscribe to ledger transactions")
        self.subscribe_transactions()


    def on_close(self):
        print("on_close")

    def subscribe_transactions(self):
        self.send({
            'command': 'subscribe',
            'streams': ['transactions']
        })

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

xrpl_websocket-0.1.0rc3.tar.gz (11.5 kB view details)

Uploaded Source

File details

Details for the file xrpl_websocket-0.1.0rc3.tar.gz.

File metadata

  • Download URL: xrpl_websocket-0.1.0rc3.tar.gz
  • Upload date:
  • Size: 11.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.9.6

File hashes

Hashes for xrpl_websocket-0.1.0rc3.tar.gz
Algorithm Hash digest
SHA256 f2672b7d855e34ce448a053fa63ba709637b4fe0c5ecde22fcbbe5b58a9b18d8
MD5 fe8d87f374314241d3a961fb0e5d9358
BLAKE2b-256 7dba36aef5470332d50475449f8f901c85476922707f87fb7086f19f77ba2595

See more details on using hashes here.

Supported by

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