Add API doc for Daemon
This commit is contained in:
parent
c729611c81
commit
0aff11fc59
|
@ -1,14 +1,37 @@
|
||||||
class Daemon(object):
|
class Daemon(object):
|
||||||
|
"""Monero daemon.
|
||||||
|
|
||||||
|
Provides interface do a daemon instance.
|
||||||
|
|
||||||
|
:param backend: a daemon backend
|
||||||
|
"""
|
||||||
def __init__(self, backend):
|
def __init__(self, backend):
|
||||||
self._backend = backend
|
self._backend = backend
|
||||||
|
|
||||||
def info(self):
|
def info(self):
|
||||||
|
"""
|
||||||
|
Returns basic information about the daemon.
|
||||||
|
|
||||||
|
:rtype: dict
|
||||||
|
"""
|
||||||
return self._backend.info()
|
return self._backend.info()
|
||||||
|
|
||||||
def height(self):
|
def height(self):
|
||||||
|
"""
|
||||||
|
Return daemon's chain height.
|
||||||
|
|
||||||
|
:rtype: int
|
||||||
|
"""
|
||||||
return self._backend.info()['height']
|
return self._backend.info()['height']
|
||||||
|
|
||||||
def send_transaction(self, tx, relay=True):
|
def send_transaction(self, tx, relay=True):
|
||||||
|
"""
|
||||||
|
Sends a transaction generated by a :class:`Wallet <monero.wallet.Wallet>`.
|
||||||
|
|
||||||
|
:param tx: :class:`Transaction <monero.transaction.Transaction>`
|
||||||
|
:param relay: whether to relay the transaction to peers. If `False`, the daemon will have
|
||||||
|
to mine the transaction itself in order to have it included in the blockchain.
|
||||||
|
"""
|
||||||
return self._backend.send_transaction(tx.blob, relay=relay)
|
return self._backend.send_transaction(tx.blob, relay=relay)
|
||||||
|
|
||||||
def mempool(self):
|
def mempool(self):
|
||||||
|
|
Loading…
Reference in New Issue