Add numbers module docs, describe transaction priorities
This commit is contained in:
parent
775e3bd7a4
commit
c729611c81
|
@ -24,6 +24,7 @@ Project homepage: https://github.com/emesik/monero-python
|
||||||
transactions
|
transactions
|
||||||
daemon
|
daemon
|
||||||
backends
|
backends
|
||||||
|
misc
|
||||||
exceptions
|
exceptions
|
||||||
license
|
license
|
||||||
authors
|
authors
|
||||||
|
|
|
@ -0,0 +1,8 @@
|
||||||
|
Miscellaneous functions, types and constants
|
||||||
|
============================================
|
||||||
|
|
||||||
|
API reference
|
||||||
|
-------------
|
||||||
|
|
||||||
|
.. automodule:: monero.numbers
|
||||||
|
:members:
|
|
@ -72,7 +72,9 @@ class Account(object):
|
||||||
|
|
||||||
:param address: destination :class:`Address <monero.address.Address>` or subtype
|
:param address: destination :class:`Address <monero.address.Address>` or subtype
|
||||||
:param amount: amount to send
|
:param amount: amount to send
|
||||||
:param priority: transaction priority (implies fee)
|
:param priority: transaction priority, implies fee. The priority can be a number
|
||||||
|
from 1 to 4 (unimportant, normal, elevated, priority) or a constant
|
||||||
|
from `monero.prio`.
|
||||||
:param ringsize: the ring size (mixin + 1)
|
:param ringsize: the ring size (mixin + 1)
|
||||||
:param payment_id: ID for the payment (must be None if
|
:param payment_id: ID for the payment (must be None if
|
||||||
:class:`IntegratedAddress <monero.address.IntegratedAddress>`
|
:class:`IntegratedAddress <monero.address.IntegratedAddress>`
|
||||||
|
@ -100,7 +102,9 @@ class Account(object):
|
||||||
|
|
||||||
:param destinations: a list of destination and amount pairs:
|
:param destinations: a list of destination and amount pairs:
|
||||||
[(:class:`Address <monero.address.Address>`, `Decimal`), ...]
|
[(:class:`Address <monero.address.Address>`, `Decimal`), ...]
|
||||||
:param priority: transaction priority (implies fee)
|
:param priority: transaction priority, implies fee. The priority can be a number
|
||||||
|
from 1 to 4 (unimportant, normal, elevated, priority) or a constant
|
||||||
|
from `monero.prio`.
|
||||||
:param ringsize: the ring size (mixin + 1)
|
:param ringsize: the ring size (mixin + 1)
|
||||||
:param payment_id: ID for the payment (must be None if
|
:param payment_id: ID for the payment (must be None if
|
||||||
:class:`IntegratedAddress <monero.address.IntegratedAddress>`
|
:class:`IntegratedAddress <monero.address.IntegratedAddress>`
|
||||||
|
|
|
@ -25,6 +25,15 @@ def as_monero(amount):
|
||||||
|
|
||||||
|
|
||||||
class PaymentID(object):
|
class PaymentID(object):
|
||||||
|
"""
|
||||||
|
A class that validates Monero payment ID.
|
||||||
|
|
||||||
|
Payment IDs can be used as str or int across the module, however this class
|
||||||
|
offers validation as well as simple conversion and comparison to those two
|
||||||
|
primitive types.
|
||||||
|
|
||||||
|
:param payment_id: the payment ID as integer or hexadecimal string
|
||||||
|
"""
|
||||||
_payment_id = None
|
_payment_id = None
|
||||||
|
|
||||||
def __init__(self, payment_id):
|
def __init__(self, payment_id):
|
||||||
|
@ -41,7 +50,7 @@ class PaymentID(object):
|
||||||
|
|
||||||
def is_short(self):
|
def is_short(self):
|
||||||
"""Returns True if payment ID is short enough to be included
|
"""Returns True if payment ID is short enough to be included
|
||||||
in Integrated Address."""
|
in :class:`IntegratedAddress <monero.address.IntegratedAddress>`."""
|
||||||
return self._payment_id.bit_length() <= 64
|
return self._payment_id.bit_length() <= 64
|
||||||
|
|
||||||
def __repr__(self):
|
def __repr__(self):
|
||||||
|
|
|
@ -157,7 +157,9 @@ class Wallet(object):
|
||||||
|
|
||||||
:param address: destination :class:`Address <monero.address.Address>` or subtype
|
:param address: destination :class:`Address <monero.address.Address>` or subtype
|
||||||
:param amount: amount to send
|
:param amount: amount to send
|
||||||
:param priority: transaction priority (implies fee)
|
:param priority: transaction priority, implies fee. The priority can be a number
|
||||||
|
from 1 to 4 (unimportant, normal, elevated, priority) or a constant
|
||||||
|
from `monero.prio`.
|
||||||
:param ringsize: the ring size (mixin + 1)
|
:param ringsize: the ring size (mixin + 1)
|
||||||
:param payment_id: ID for the payment (must be None if
|
:param payment_id: ID for the payment (must be None if
|
||||||
:class:`IntegratedAddress <monero.address.IntegratedAddress>`
|
:class:`IntegratedAddress <monero.address.IntegratedAddress>`
|
||||||
|
@ -185,7 +187,9 @@ class Wallet(object):
|
||||||
transactions.
|
transactions.
|
||||||
|
|
||||||
:param destinations: a list of destination and amount pairs: [(address, amount), ...]
|
:param destinations: a list of destination and amount pairs: [(address, amount), ...]
|
||||||
:param priority: transaction priority (implies fee)
|
:param priority: transaction priority, implies fee. The priority can be a number
|
||||||
|
from 1 to 4 (unimportant, normal, elevated, priority) or a constant
|
||||||
|
from `monero.prio`.
|
||||||
:param ringsize: the ring size (mixin + 1)
|
:param ringsize: the ring size (mixin + 1)
|
||||||
:param payment_id: ID for the payment (must be None if
|
:param payment_id: ID for the payment (must be None if
|
||||||
:class:`IntegratedAddress <monero.address.IntegratedAddress>`
|
:class:`IntegratedAddress <monero.address.IntegratedAddress>`
|
||||||
|
|
Loading…
Reference in New Issue