Skip to content

Add optional timeout to JSON-RPC daemon/wallet #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 29, 2019
Merged

Add optional timeout to JSON-RPC daemon/wallet #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e17fb2f
add timeout to JSON RPC backends
bitmario Apr 29, 2019
9ff4e9b
add timeout description to README
bitmario Apr 29, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ This fork contains the following changes:
* Dropped support for python 2.
* Added: ``get_unspent_outputs`` and ``get_incoming_transactions`` to the wallet.
* Added: ``address_index`` to instances of ``SubAddress``.
* Added: optional ``timeout`` to ``JSONRPCWallet`` and ``JSONRPCDaemon``. Please note that
a timeout does not mean that the underlying operation was not executed.

For documentation about how to use the package please check the original repository.

Expand Down
21 changes: 16 additions & 5 deletions monero/backends/jsonrpc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,19 @@ class JSONRPCDaemon(object):
:param host: host name or IP
:param port: port number
:param path: path for JSON RPC requests (should not be changed)
:param timeout: optional timeout for requests (seconds). Please note that
a timeout does not mean that the underlying operation was not executed.
"""
def __init__(self, protocol='http', host='127.0.0.1', port=18081, path='/json_rpc', user='', password=''):
def __init__(self, protocol='http', host='127.0.0.1', port=18081,
path='/json_rpc', user='', password='', timeout=None):
self.url = '{protocol}://{host}:{port}'.format(
protocol=protocol,
host=host,
port=port)
_log.debug("JSONRPC daemon backend URL: {url}".format(url=self.url))
self.user = user
self.password = password
self.timeout = timeout

def info(self):
info = self.raw_jsonrpc_request('get_info')
Expand Down Expand Up @@ -65,7 +69,8 @@ def raw_request(self, path, data):
_log.debug(u"Request: {path}\nData: {data}".format(
path=path,
data=json.dumps(data, indent=2, sort_keys=True)))
rsp = requests.post(self.url + path, headers=hdr, data=json.dumps(data))
rsp = requests.post(self.url + path, headers=hdr, data=json.dumps(data),
timeout=self.timeout)
if rsp.status_code != 200:
raise RPCError("Invalid HTTP status {code} for path {path}.".format(
code=rsp.status_code,
Expand All @@ -83,7 +88,8 @@ def raw_jsonrpc_request(self, method, params=None):
method=method,
params=json.dumps(params, indent=2, sort_keys=True)))
auth = requests.auth.HTTPDigestAuth(self.user, self.password)
rsp = requests.post(self.url + '/json_rpc', headers=hdr, data=json.dumps(data), auth=auth)
rsp = requests.post(self.url + '/json_rpc', headers=hdr, data=json.dumps(data),
auth=auth, timeout=self.timeout)
if rsp.status_code == 401:
raise Unauthorized("401 Unauthorized. Invalid RPC user name or password.")
elif rsp.status_code != 200:
Expand Down Expand Up @@ -115,11 +121,14 @@ class JSONRPCWallet(object):
:param path: path for JSON RPC requests (should not be changed)
:param user: username to authenticate with over RPC
:param password: password to authenticate with over RPC
:param timeout: optional timeout for requests (seconds). Please note that
a timeout does not mean that the underlying operation was not executed.
"""
_master_address = None
_addresses = None

def __init__(self, protocol='http', host='127.0.0.1', port=18088, path='/json_rpc', user='', password=''):
def __init__(self, protocol='http', host='127.0.0.1', port=18088,
path='/json_rpc', user='', password='', timeout=None):
self.url = '{protocol}://{host}:{port}/json_rpc'.format(
protocol=protocol,
host=host,
Expand All @@ -129,6 +138,7 @@ def __init__(self, protocol='http', host='127.0.0.1', port=18088, path='/json_rp
self.password = password
_log.debug("JSONRPC wallet backend auth: '{user}'/'{stars}'".format(
user=user, stars=('*' * len(password)) if password else ''))
self.timeout = timeout

def height(self):
return self.raw_request('getheight')['height']
Expand Down Expand Up @@ -401,7 +411,8 @@ def raw_request(self, method, params=None, squelch_error_logging=False):
method=method,
params=json.dumps(params, indent=2, sort_keys=True)))
auth = requests.auth.HTTPDigestAuth(self.user, self.password)
rsp = requests.post(self.url, headers=hdr, data=json.dumps(data), auth=auth)
rsp = requests.post(self.url, headers=hdr, data=json.dumps(data),
auth=auth, timeout=self.timeout)
if rsp.status_code == 401:
raise Unauthorized("401 Unauthorized. Invalid RPC user name or password.")
elif rsp.status_code != 200:
Expand Down