lbry-sdk/lbrynet/core/Wallet.py

1207 lines
46 KiB
Python
Raw Normal View History

import datetime
import logging
import json
import os
2015-08-20 17:27:15 +02:00
from twisted.internet import threads, reactor, defer, task
from twisted.python.failure import Failure
from twisted.enterprise import adbapi
2015-08-20 17:27:15 +02:00
from collections import defaultdict, deque
from zope.interface import implements
from jsonschema import ValidationError
2015-08-20 17:27:15 +02:00
from decimal import Decimal
from lbryum import SimpleConfig, Network
from lbryum.lbrycrd import COIN, RECOMMENDED_CLAIMTRIE_HASH_CONFIRMS
2016-09-26 03:54:15 +02:00
import lbryum.wallet
from lbryum.commands import known_commands, Commands
from lbrynet.core.sqlite_helpers import rerun_if_locked
from lbrynet.interfaces import IRequestCreator, IQueryHandlerFactory, IQueryHandler, IWallet
from lbrynet.core.client.ClientRequest import ClientRequest
2017-01-12 18:51:44 +01:00
from lbrynet.core.Error import (UnknownNameError, InvalidStreamInfoError, RequestCanceledError,
InsufficientFundsError)
2016-11-28 20:23:10 +01:00
from lbrynet.db_migrator.migrate1to2 import UNSET_NOUT
from lbrynet.metadata.Metadata import Metadata
2015-08-20 17:27:15 +02:00
2017-01-28 17:00:39 +01:00
log = logging.getLogger(__name__)
2015-08-20 17:27:15 +02:00
class ReservedPoints(object):
def __init__(self, identifier, amount):
self.identifier = identifier
self.amount = amount
class ClaimOutpoint(dict):
def __init__(self, txid, nout):
if len(txid) != 64:
raise TypeError('{} is not a txid'.format(txid))
self['txid'] = txid
2016-11-28 20:23:10 +01:00
self['nout'] = nout
def __repr__(self):
2016-11-28 20:23:10 +01:00
return "{}:{}".format(self['txid'], self['nout'])
def __eq__(self, compare):
2016-11-28 20:23:10 +01:00
if isinstance(compare, dict):
# TODO: lbryum returns nout's in dicts as "nOut" , need to fix this
2016-11-28 20:23:10 +01:00
if 'nOut' in compare:
return (self['txid'], self['nout']) == (compare['txid'], compare['nOut'])
elif 'nout' in compare:
return (self['txid'], self['nout']) == (compare['txid'], compare['nout'])
2017-03-07 23:03:07 +01:00
elif type(compare) in [str, unicode]:
return compare == self.__repr__()
else:
raise TypeError('cannot compare {}'.format(type(compare)))
2017-01-25 17:44:21 +01:00
def __ne__(self, compare):
2016-11-28 20:23:10 +01:00
return not self.__eq__(compare)
class MetaDataStorage(object):
def load(self):
return defer.succeed(True)
def clean_bad_records(self):
return defer.succeed(True)
def save_name_metadata(self, name, claim_outpoint, sd_hash):
return defer.succeed(True)
def get_claim_metadata_for_sd_hash(self, sd_hash):
return defer.succeed(True)
def update_claimid(self, claim_id, name, claim_outpoint):
return defer.succeed(True)
def get_claimid_for_tx(self, name, claim_outpoint):
return defer.succeed(True)
class InMemoryStorage(MetaDataStorage):
def __init__(self):
self.metadata = {}
self.claimids = {}
MetaDataStorage.__init__(self)
def save_name_metadata(self, name, claim_outpoint, sd_hash):
self.metadata[sd_hash] = (name, claim_outpoint)
return defer.succeed(True)
def get_claim_metadata_for_sd_hash(self, sd_hash):
try:
name, claim_outpoint = self.metadata[sd_hash]
return defer.succeed((name, claim_outpoint['txid'], claim_outpoint['nout']))
except KeyError:
return defer.succeed(None)
def update_claimid(self, claim_id, name, claim_outpoint):
self.claimids[(name, claim_outpoint['txid'], claim_outpoint['nout'])] = claim_id
return defer.succeed(True)
def get_claimid_for_tx(self, name, claim_outpoint):
try:
return defer.succeed(
self.claimids[(name, claim_outpoint['txid'], claim_outpoint['nout'])])
except KeyError:
return defer.succeed(None)
class SqliteStorage(MetaDataStorage):
def __init__(self, db_dir):
self.db_dir = db_dir
self.db = None
MetaDataStorage.__init__(self)
def load(self):
self.db = adbapi.ConnectionPool('sqlite3', os.path.join(self.db_dir, "blockchainname.db"),
check_same_thread=False)
def create_tables(transaction):
transaction.execute("create table if not exists name_metadata (" +
" name text, " +
" txid text, " +
" n integer, " +
" sd_hash text)")
transaction.execute("create table if not exists claim_ids (" +
" claimId text, " +
" name text, " +
" txid text, " +
" n integer)")
2017-01-25 17:44:21 +01:00
return self.db.runInteraction(create_tables)
def clean_bad_records(self):
d = self.db.runQuery("delete from name_metadata where length(txid) > 64 or txid is null")
return d
def save_name_metadata(self, name, claim_outpoint, sd_hash):
d = self.db.runQuery(
"delete from name_metadata where name=? and txid=? and n=? and sd_hash=?",
(name, claim_outpoint['txid'], claim_outpoint['nout'], sd_hash))
d.addCallback(
lambda _: self.db.runQuery(
"delete from name_metadata where name=? and txid=? and n=? and sd_hash=?",
(name, claim_outpoint['txid'], UNSET_NOUT, sd_hash)))
d.addCallback(
lambda _: self.db.runQuery(
"insert into name_metadata values (?, ?, ?, ?)",
(name, claim_outpoint['txid'], claim_outpoint['nout'], sd_hash)))
return d
@rerun_if_locked
def get_claim_metadata_for_sd_hash(self, sd_hash):
d = self.db.runQuery("select name, txid, n from name_metadata where sd_hash=?", (sd_hash,))
d.addCallback(lambda r: r[0] if r else None)
return d
def update_claimid(self, claim_id, name, claim_outpoint):
d = self.db.runQuery(
"delete from claim_ids where claimId=? and name=? and txid=? and n=?",
(claim_id, name, claim_outpoint['txid'], claim_outpoint['nout']))
d.addCallback(
lambda _: self.db.runQuery(
"delete from claim_ids where claimId=? and name=? and txid=? and n=?",
(claim_id, name, claim_outpoint['txid'], UNSET_NOUT)))
d.addCallback(
lambda r: self.db.runQuery(
"insert into claim_ids values (?, ?, ?, ?)",
(claim_id, name, claim_outpoint['txid'], claim_outpoint['nout'])))
d.addCallback(lambda _: claim_id)
return d
def get_claimid_for_tx(self, name, claim_outpoint):
d = self.db.runQuery(
"select claimId from claim_ids where name=? and txid=? and n=?",
(name, claim_outpoint['txid'], claim_outpoint['nout']))
d.addCallback(lambda r: r[0][0] if r else None)
return d
class Wallet(object):
"""This class implements the Wallet interface for the LBRYcrd payment system"""
implements(IWallet)
2015-08-20 17:27:15 +02:00
def __init__(self, storage):
if not isinstance(storage, MetaDataStorage):
raise ValueError('storage must be an instance of MetaDataStorage')
self._storage = storage
2015-08-20 17:27:15 +02:00
self.next_manage_call = None
self.wallet_balance = Decimal(0.0)
self.total_reserved_points = Decimal(0.0)
self.peer_addresses = {} # {Peer: string}
self.queued_payments = defaultdict(Decimal) # {address(string): amount(Decimal)}
self.expected_balances = defaultdict(Decimal) # {address(string): amount(Decimal)}
self.current_address_given_to_peer = {} # {Peer: address(string)}
2016-11-28 20:23:10 +01:00
# (Peer, address(string), amount(Decimal), time(datetime), count(int),
# incremental_amount(float))
self.expected_balance_at_time = deque()
2015-08-20 17:27:15 +02:00
self.max_expected_payment_time = datetime.timedelta(minutes=3)
self.stopped = True
self.manage_running = False
self._manage_count = 0
self._balance_refresh_time = 3
2016-03-18 02:55:06 +01:00
self._batch_count = 20
2015-08-20 17:27:15 +02:00
def start(self):
def start_manage():
self.stopped = False
self.manage()
return True
d = self._storage.load()
d.addCallback(lambda _: self._clean_bad_records())
d.addCallback(lambda _: self._start())
2015-08-20 17:27:15 +02:00
d.addCallback(lambda _: start_manage())
return d
def _clean_bad_records(self):
self._storage.clean_bad_records()
def _save_name_metadata(self, name, claim_outpoint, sd_hash):
return self._storage.save_name_metadata(name, claim_outpoint, sd_hash)
def _get_claim_metadata_for_sd_hash(self, sd_hash):
return self._storage.get_claim_metadata_for_sd_hash(sd_hash)
def _update_claimid(self, claim_id, name, claim_outpoint):
return self._storage.update_claimid(claim_id, name, claim_outpoint)
def _get_claimid_for_tx(self, name, claim_outpoint):
return self._storage.get_claimid_for_tx(name, claim_outpoint)
@staticmethod
def log_stop_error(err):
log.error("An error occurred stopping the wallet: %s", err.getTraceback())
def stop(self):
2016-11-03 20:42:45 +01:00
log.info("Stopping %s", self)
2015-08-20 17:27:15 +02:00
self.stopped = True
# If self.next_manage_call is None, then manage is currently running or else
# start has not been called, so set stopped and do nothing else.
if self.next_manage_call is not None:
self.next_manage_call.cancel()
self.next_manage_call = None
d = self.manage(do_full=True)
d.addErrback(self.log_stop_error)
d.addCallback(lambda _: self._stop())
d.addErrback(self.log_stop_error)
2015-08-20 17:27:15 +02:00
return d
def manage(self, do_full=False):
2015-08-20 17:27:15 +02:00
self.next_manage_call = None
have_set_manage_running = [False]
self._manage_count += 1
if self._manage_count % self._batch_count == 0:
self._manage_count = 0
do_full = True
2015-08-20 17:27:15 +02:00
def check_if_manage_running():
d = defer.Deferred()
def fire_if_not_running():
if self.manage_running is False:
self.manage_running = True
have_set_manage_running[0] = True
d.callback(True)
elif do_full is False:
d.callback(False)
2015-08-20 17:27:15 +02:00
else:
task.deferLater(reactor, 1, fire_if_not_running)
fire_if_not_running()
return d
d = check_if_manage_running()
def do_manage():
if do_full:
d = self._check_expected_balances()
d.addCallback(lambda _: self._send_payments())
else:
d = defer.succeed(True)
2015-08-20 17:27:15 +02:00
def log_error(err):
if isinstance(err, AttributeError):
log.warning("Failed to get an updated balance")
log.warning("Last balance update: %s", str(self.wallet_balance))
2017-01-12 18:51:44 +01:00
d.addCallbacks(lambda _: self.update_balance(), log_error)
return d
2015-08-20 17:27:15 +02:00
d.addCallback(lambda should_run: do_manage() if should_run else None)
2015-08-20 17:27:15 +02:00
def set_next_manage_call():
if not self.stopped:
self.next_manage_call = reactor.callLater(self._balance_refresh_time, self.manage)
2015-08-20 17:27:15 +02:00
d.addCallback(lambda _: set_next_manage_call())
def log_error(err):
2016-11-28 20:23:10 +01:00
log.error("Something went wrong during manage. Error message: %s",
err.getErrorMessage())
2015-08-20 17:27:15 +02:00
return err
d.addErrback(log_error)
def set_manage_not_running(arg):
if have_set_manage_running[0] is True:
self.manage_running = False
return arg
d.addBoth(set_manage_not_running)
return d
2017-01-12 18:51:44 +01:00
@defer.inlineCallbacks
def update_balance(self):
""" obtain balance from lbryum wallet and set self.wallet_balance
"""
balance = yield self._update_balance()
if self.wallet_balance != balance:
log.debug("Got a new balance: %s", balance)
self.wallet_balance = balance
def get_info_exchanger(self):
return LBRYcrdAddressRequester(self)
def get_wallet_info_query_handler_factory(self):
return LBRYcrdAddressQueryHandlerFactory(self)
2015-09-22 18:08:17 +02:00
def reserve_points(self, identifier, amount):
2016-11-28 20:23:10 +01:00
"""Ensure a certain amount of points are available to be sent as
payment, before the service is rendered
2015-08-20 17:27:15 +02:00
2015-09-22 18:08:17 +02:00
@param identifier: The peer to which the payment will ultimately be sent
2015-08-20 17:27:15 +02:00
@param amount: The amount of points to reserve
2016-11-28 20:23:10 +01:00
@return: A ReservedPoints object which is given to send_points
once the service has been rendered
2015-08-20 17:27:15 +02:00
"""
rounded_amount = Decimal(str(round(amount, 8)))
2017-01-12 18:51:44 +01:00
if self.get_balance() >= rounded_amount:
2015-08-20 17:27:15 +02:00
self.total_reserved_points += rounded_amount
2015-09-22 18:08:17 +02:00
return ReservedPoints(identifier, rounded_amount)
2015-08-20 17:27:15 +02:00
return None
def cancel_point_reservation(self, reserved_points):
"""
Return all of the points that were reserved previously for some ReservedPoints object
@param reserved_points: ReservedPoints previously returned by reserve_points
@return: None
"""
self.total_reserved_points -= reserved_points.amount
def send_points(self, reserved_points, amount):
"""
Schedule a payment to be sent to a peer
@param reserved_points: ReservedPoints object previously returned by reserve_points
@param amount: amount of points to actually send, must be less than or equal to the
amount reserved in reserved_points
@return: Deferred which fires when the payment has been scheduled
"""
rounded_amount = Decimal(str(round(amount, 8)))
peer = reserved_points.identifier
2017-01-25 17:44:21 +01:00
assert rounded_amount <= reserved_points.amount
assert peer in self.peer_addresses
2015-08-20 17:27:15 +02:00
self.queued_payments[self.peer_addresses[peer]] += rounded_amount
# make any unused points available
self.total_reserved_points -= (reserved_points.amount - rounded_amount)
log.debug("ordering that %s points be sent to %s", str(rounded_amount),
2017-01-25 17:44:21 +01:00
str(self.peer_addresses[peer]))
2015-08-20 17:27:15 +02:00
peer.update_stats('points_sent', amount)
return defer.succeed(True)
2015-09-22 18:08:17 +02:00
def send_points_to_address(self, reserved_points, amount):
"""
Schedule a payment to be sent to an address
@param reserved_points: ReservedPoints object previously returned by reserve_points
@param amount: amount of points to actually send. must be less than or equal to the
amount reselved in reserved_points
@return: Deferred which fires when the payment has been scheduled
"""
rounded_amount = Decimal(str(round(amount, 8)))
address = reserved_points.identifier
2017-01-25 17:44:21 +01:00
assert rounded_amount <= reserved_points.amount
2015-09-22 18:08:17 +02:00
self.queued_payments[address] += rounded_amount
self.total_reserved_points -= (reserved_points.amount - rounded_amount)
log.debug("Ordering that %s points be sent to %s", str(rounded_amount),
2017-01-25 17:44:21 +01:00
str(address))
2015-09-22 18:08:17 +02:00
return defer.succeed(True)
2015-08-20 17:27:15 +02:00
def add_expected_payment(self, peer, amount):
"""Increase the number of points expected to be paid by a peer"""
rounded_amount = Decimal(str(round(amount, 8)))
2017-01-25 17:44:21 +01:00
assert peer in self.current_address_given_to_peer
2015-08-20 17:27:15 +02:00
address = self.current_address_given_to_peer[peer]
log.debug("expecting a payment at address %s in the amount of %s",
2017-01-25 17:44:21 +01:00
str(address), str(rounded_amount))
2015-08-20 17:27:15 +02:00
self.expected_balances[address] += rounded_amount
expected_balance = self.expected_balances[address]
expected_time = datetime.datetime.now() + self.max_expected_payment_time
2016-11-28 20:23:10 +01:00
self.expected_balance_at_time.append(
(peer, address, expected_balance, expected_time, 0, amount))
2015-08-20 17:27:15 +02:00
peer.update_stats('expected_points', amount)
def update_peer_address(self, peer, address):
self.peer_addresses[peer] = address
def get_new_address_for_peer(self, peer):
def set_address_for_peer(address):
self.current_address_given_to_peer[peer] = address
return address
2017-01-25 17:44:21 +01:00
d = self.get_new_address()
2015-08-20 17:27:15 +02:00
d.addCallback(set_address_for_peer)
return d
def _send_payments(self):
payments_to_send = {}
for address, points in self.queued_payments.items():
2016-08-27 08:42:20 +02:00
if points > 0:
log.debug("Should be sending %s points to %s", str(points), str(address))
2016-08-27 08:42:20 +02:00
payments_to_send[address] = points
self.total_reserved_points -= points
else:
log.info("Skipping dust")
del self.queued_payments[address]
2016-08-27 08:42:20 +02:00
if payments_to_send:
log.debug("Creating a transaction with outputs %s", str(payments_to_send))
d = self._do_send_many(payments_to_send)
d.addCallback(lambda txid: log.debug("Sent transaction %s", txid))
return d
2017-01-12 18:51:44 +01:00
2016-08-23 01:56:42 +02:00
log.debug("There were no payments to send")
return defer.succeed(True)
def get_stream_info_for_name(self, name):
d = self._get_value_for_name(name)
d.addCallback(self._get_stream_info_from_value, name)
return d
2016-05-30 21:49:25 +02:00
def get_txid_for_name(self, name):
d = self._get_value_for_name(name)
d.addCallback(lambda r: None if 'txid' not in r else r['txid'])
return d
def get_stream_info_from_claim_outpoint(self, name, txid, nout):
2016-11-28 20:23:10 +01:00
claim_outpoint = ClaimOutpoint(txid, nout)
d = self.get_claims_from_tx(claim_outpoint['txid'])
def get_claim_for_name(claims):
for claim in claims:
2016-11-28 20:23:10 +01:00
if claim_outpoint == claim:
claim['txid'] = txid
return claim
2015-08-20 17:27:15 +02:00
return Failure(UnknownNameError(name))
d.addCallback(get_claim_for_name)
d.addCallback(self._get_stream_info_from_value, name)
2015-08-20 17:27:15 +02:00
return d
def _get_stream_info_from_value(self, result, name):
def _check_result_fields(r):
2017-03-07 18:30:16 +01:00
for k in ['value', 'txid', 'nout', 'height', 'amount']:
assert k in r, "getvalueforname response missing field %s" % k
2016-11-04 21:09:40 +01:00
def _log_success(claim_id):
log.debug("lbry://%s complies with %s, claimid: %s", name, metadata.version, claim_id)
return defer.succeed(None)
2017-01-25 17:44:21 +01:00
if 'error' in result:
log.warning("Got an error looking up lbry://%s: %s", name, result['error'])
return Failure(UnknownNameError(name))
_check_result_fields(result)
try:
2016-11-04 21:09:40 +01:00
metadata = Metadata(json.loads(result['value']))
except (TypeError, ValueError, ValidationError):
2016-11-04 21:09:40 +01:00
return Failure(InvalidStreamInfoError(name, result['value']))
sd_hash = metadata['sources']['lbry_sd_hash']
2017-03-07 18:30:16 +01:00
claim_outpoint = ClaimOutpoint(result['txid'], result['nout'])
d = self._save_name_metadata(name, claim_outpoint, sd_hash)
2017-03-07 18:30:16 +01:00
d.addCallback(lambda _: self.get_claimid(name, result['txid'], result['nout']))
d.addCallback(lambda cid: _log_success(cid))
d.addCallback(lambda _: metadata)
return d
2016-08-08 07:46:19 +02:00
def get_claim(self, name, claim_id):
d = self.get_claims_for_name(name)
d.addCallback(
lambda claims: next(
2017-03-07 18:30:16 +01:00
claim for claim in claims['claims'] if claim['claim_id'] == claim_id))
return d
def get_claimid(self, name, txid, nout):
def _get_id_for_return(claim_id):
if claim_id:
return defer.succeed(claim_id)
else:
d = self.get_claims_from_tx(txid)
d.addCallback(
lambda claims: next(
c for c in claims if c['name'] == name and
2017-03-07 18:30:16 +01:00
c['nout'] == claim_outpoint['nout']))
d.addCallback(
lambda claim: self._update_claimid(
2017-03-07 18:30:16 +01:00
claim['claim_id'], name, ClaimOutpoint(txid, claim['nout'])))
return d
2017-01-25 17:44:21 +01:00
2016-12-14 00:08:29 +01:00
claim_outpoint = ClaimOutpoint(txid, nout)
d = self._get_claimid_for_tx(name, claim_outpoint)
d.addCallback(_get_id_for_return)
return d
def get_my_claim(self, name):
def _get_claim_for_return(claim):
if not claim:
return False
2016-11-09 21:19:58 +01:00
claim['value'] = json.loads(claim['value'])
2016-12-05 23:17:17 +01:00
return claim
2016-09-22 04:10:19 +02:00
def _get_my_unspent_claim(claims):
for claim in claims:
is_unspent = (
claim['name'] == name and
2017-03-07 18:30:16 +01:00
not claim['is_spent'] and
not claim.get('supported_claimid', False)
)
if is_unspent:
2016-09-22 04:10:19 +02:00
return claim
return False
d = self.get_name_claims()
2016-09-22 04:10:19 +02:00
d.addCallback(_get_my_unspent_claim)
d.addCallback(_get_claim_for_return)
return d
def get_claim_info(self, name, txid=None, nout=None):
if txid is None or nout is None:
2016-08-08 07:46:19 +02:00
d = self._get_value_for_name(name)
2017-03-07 18:30:16 +01:00
d.addCallback(lambda r: self._get_claim_info(name, ClaimOutpoint(r['txid'], r['nout'])))
2016-11-28 20:23:10 +01:00
else:
d = self._get_claim_info(name, ClaimOutpoint(txid, nout))
2016-08-08 07:46:19 +02:00
d.addErrback(lambda _: False)
return d
def _format_claim_for_return(self, name, claim, metadata=None, meta_version=None):
result = {}
2017-03-07 18:30:16 +01:00
result['claim_id'] = claim['claim_id']
result['amount'] = claim['effective_amount']
result['height'] = claim['height']
result['name'] = name
result['txid'] = claim['txid']
2017-03-07 18:30:16 +01:00
result['nout'] = claim['nout']
result['value'] = metadata if metadata else json.loads(claim['value'])
result['supports'] = [
2017-03-07 18:30:16 +01:00
{'txid': support['txid'], 'nout': support['nout']} for support in claim['supports']]
result['meta_version'] = (
meta_version if meta_version else result['value'].get('ver', '0.0.1'))
return result
def _get_claim_info(self, name, claim_outpoint):
2016-08-08 07:46:19 +02:00
def _build_response(claim):
try:
metadata = Metadata(json.loads(claim['value']))
2016-08-16 00:13:36 +02:00
meta_ver = metadata.version
2016-08-08 07:46:19 +02:00
sd_hash = metadata['sources']['lbry_sd_hash']
d = self._save_name_metadata(name, claim_outpoint, sd_hash)
except (TypeError, ValueError, ValidationError):
2016-08-08 07:46:19 +02:00
metadata = claim['value']
meta_ver = "Non-compliant"
d = defer.succeed(None)
d.addCallback(lambda _: self._format_claim_for_return(name,
claim,
metadata=metadata,
meta_version=meta_ver))
log.info(
"get claim info lbry://%s metadata: %s, claimid: %s",
2017-03-07 18:30:16 +01:00
name, meta_ver, claim['claim_id'])
return d
2016-08-08 07:46:19 +02:00
d = self.get_claimid(name, claim_outpoint['txid'], claim_outpoint['nout'])
2016-08-08 07:46:19 +02:00
d.addCallback(lambda claim_id: self.get_claim(name, claim_id))
d.addCallback(_build_response)
return d
2016-08-08 07:42:37 +02:00
def get_claims_for_name(self, name):
d = self._get_claims_for_name(name)
return d
2016-08-07 22:13:47 +02:00
def update_metadata(self, new_metadata, old_metadata):
meta_for_return = old_metadata if isinstance(old_metadata, dict) else {}
for k in new_metadata:
meta_for_return[k] = new_metadata[k]
return defer.succeed(Metadata(meta_for_return))
2017-01-16 20:05:16 +01:00
def _process_claim_out(self, claim_out):
claim_out.pop('success')
claim_out['fee'] = float(claim_out['fee'])
return claim_out
@defer.inlineCallbacks
def claim_name(self, name, bid, metadata):
"""
Claim a name, or update if name already claimed by user
@param name: str, name to claim
@param bid: float, bid amount
@param metadata: Metadata compliant dict
@return: Deferred which returns a dict containing below items
txid - txid of the resulting transaction
nout - nout of the resulting claim
fee - transaction fee paid to make claim
claim_id - claim id of the claim
"""
2016-08-08 07:46:19 +02:00
_metadata = Metadata(metadata)
my_claim = yield self.get_my_claim(name)
if my_claim:
log.info("Updating claim")
if self.get_balance() < bid - Decimal(my_claim['amount']):
raise InsufficientFundsError()
new_metadata = yield self.update_metadata(_metadata, my_claim['value'])
2017-03-07 18:30:16 +01:00
old_claim_outpoint = ClaimOutpoint(my_claim['txid'], my_claim['nout'])
claim = yield self._send_name_claim_update(name, my_claim['claim_id'],
old_claim_outpoint, new_metadata, bid)
claim['claim_id'] = my_claim['claim_id']
else:
log.info("Making a new claim")
if self.get_balance() < bid:
raise InsufficientFundsError()
claim = yield self._send_name_claim(name, _metadata, bid)
if not claim['success']:
msg = 'Claim to name {} failed: {}'.format(name, claim['reason'])
raise Exception(msg)
claim = self._process_claim_out(claim)
claim_outpoint = ClaimOutpoint(claim['txid'], claim['nout'])
log.info("Saving metadata for claim %s %d", claim['txid'], claim['nout'])
yield self._save_name_metadata(name, claim_outpoint, _metadata['sources']['lbry_sd_hash'])
defer.returnValue(claim)
2017-02-13 20:17:53 +01:00
@defer.inlineCallbacks
def abandon_claim(self, txid, nout):
def _parse_abandon_claim_out(claim_out):
if not claim_out['success']:
2017-02-13 20:17:53 +01:00
msg = 'Abandon of {}:{} failed: {}'.format(txid, nout, claim_out['reason'])
raise Exception(msg)
2017-01-16 20:05:16 +01:00
claim_out = self._process_claim_out(claim_out)
2017-02-13 20:17:53 +01:00
log.info("Abandoned claim tx %s (n: %i) --> %s", txid, nout, claim_out)
return defer.succeed(claim_out)
claim_outpoint = ClaimOutpoint(txid, nout)
2017-02-13 20:17:53 +01:00
claim_out = yield self._abandon_claim(claim_outpoint)
result = yield _parse_abandon_claim_out(claim_out)
defer.returnValue(result)
2016-08-08 08:32:56 +02:00
def support_claim(self, name, claim_id, amount):
def _parse_support_claim_out(claim_out):
if not claim_out['success']:
msg = 'Support of {}:{} failed: {}'.format(name, claim_id, claim_out['reason'])
raise Exception(msg)
2017-01-16 20:05:16 +01:00
claim_out = self._process_claim_out(claim_out)
return defer.succeed(claim_out)
2017-01-12 18:51:44 +01:00
if self.get_balance() < amount:
raise InsufficientFundsError()
d = self._support_claim(name, claim_id, amount)
d.addCallback(lambda claim_out: _parse_support_claim_out(claim_out))
return d
2016-08-08 08:32:56 +02:00
2016-09-09 06:48:54 +02:00
def get_block_info(self, height):
d = self._get_blockhash(height)
return d
2016-08-19 04:15:49 +02:00
def get_history(self):
d = self._get_history()
return d
2016-09-02 07:27:30 +02:00
def address_is_mine(self, address):
d = self._address_is_mine(address)
return d
def get_transaction(self, txid):
d = self._get_transaction(txid)
return d
2016-10-03 22:37:27 +02:00
def get_claim_metadata_for_sd_hash(self, sd_hash):
return self._get_claim_metadata_for_sd_hash(sd_hash)
2017-01-12 18:51:44 +01:00
def get_balance(self):
return self.wallet_balance - self.total_reserved_points - sum(self.queued_payments.values())
def _check_expected_balances(self):
now = datetime.datetime.now()
balances_to_check = []
try:
while self.expected_balance_at_time[0][3] < now:
balances_to_check.append(self.expected_balance_at_time.popleft())
except IndexError:
pass
ds = []
for balance_to_check in balances_to_check:
log.debug("Checking balance of address %s", str(balance_to_check[1]))
d = self._get_balance_for_address(balance_to_check[1])
d.addCallback(lambda bal: bal >= balance_to_check[2])
ds.append(d)
dl = defer.DeferredList(ds)
def handle_checks(results):
from future_builtins import zip
for balance, (success, result) in zip(balances_to_check, results):
peer = balance[0]
if success is True:
if result is False:
if balance[4] <= 1: # first or second strike, give them another chance
2017-01-25 23:00:21 +01:00
new_expected_balance = (
balance[0],
balance[1],
balance[2],
datetime.datetime.now() + self.max_expected_payment_time,
balance[4] + 1,
balance[5]
)
self.expected_balance_at_time.append(new_expected_balance)
peer.update_score(-5.0)
else:
peer.update_score(-50.0)
else:
if balance[4] == 0:
peer.update_score(balance[5])
peer.update_stats('points_received', balance[5])
else:
log.warning("Something went wrong checking a balance. Peer: %s, account: %s,"
"expected balance: %s, expected time: %s, count: %s, error: %s",
str(balance[0]), str(balance[1]), str(balance[2]), str(balance[3]),
str(balance[4]), str(result.getErrorMessage()))
dl.addCallback(handle_checks)
return dl
2017-01-25 17:44:21 +01:00
# ======== Must be overridden ======== #
2017-01-12 18:51:44 +01:00
def _update_balance(self):
return defer.fail(NotImplementedError())
2015-08-20 17:27:15 +02:00
def get_new_address(self):
return defer.fail(NotImplementedError())
2015-08-20 17:27:15 +02:00
def get_block(self, blockhash):
return defer.fail(NotImplementedError())
def get_most_recent_blocktime(self):
return defer.fail(NotImplementedError())
def get_best_blockhash(self):
return defer.fail(NotImplementedError())
def get_name_claims(self):
return defer.fail(NotImplementedError())
2016-08-08 07:42:37 +02:00
def _get_claims_for_name(self, name):
return defer.fail(NotImplementedError())
def _send_name_claim(self, name, val, amount):
return defer.fail(NotImplementedError())
def _abandon_claim(self, claim_outpoint):
return defer.fail(NotImplementedError())
def _send_name_claim_update(self, name, claim_id, claim_outpoint, value, amount):
2016-06-28 20:28:59 +02:00
return defer.fail(NotImplementedError())
2016-08-08 08:32:56 +02:00
def _support_claim(self, name, claim_id, amount):
return defer.fail(NotImplementedError())
def _do_send_many(self, payments_to_send):
return defer.fail(NotImplementedError())
def _get_value_for_name(self, name):
return defer.fail(NotImplementedError())
def get_claims_from_tx(self, txid):
return defer.fail(NotImplementedError())
def _get_balance_for_address(self, address):
return defer.fail(NotImplementedError())
2016-08-19 04:15:49 +02:00
def _get_history(self):
return defer.fail(NotImplementedError())
2016-09-02 07:27:30 +02:00
def _address_is_mine(self, address):
return defer.fail(NotImplementedError())
def _start(self):
pass
def _stop(self):
pass
class LBRYumWallet(Wallet):
def __init__(self, storage, config=None):
Wallet.__init__(self, storage)
2016-10-04 20:58:44 +02:00
self._config = config
self.network = None
self.wallet = None
2017-01-03 20:13:01 +01:00
self.is_first_run = False
self.printed_retrieving_headers = False
self._start_check = None
self._catch_up_check = None
self._caught_up_counter = 0
self._lag_counter = 0
2017-01-03 20:13:01 +01:00
self.blocks_behind = 0
self.catchup_progress = 0
2017-01-28 17:06:29 +01:00
def _is_first_run(self):
return (not self.printed_retrieving_headers and
self.network.blockchain.retrieving_headers)
def _start(self):
network_start_d = defer.Deferred()
2017-01-28 19:55:59 +01:00
self.config = make_config(self._config)
def setup_network():
self.network = Network(self.config)
2017-01-28 17:00:39 +01:00
log.info("Loading the wallet")
return defer.succeed(self.network.start())
def check_started():
if self.network.is_connecting():
2017-01-28 17:06:29 +01:00
if self._is_first_run():
2017-01-28 17:00:39 +01:00
log.info("Running the wallet for the first time. This may take a moment.")
self.printed_retrieving_headers = True
return False
self._start_check.stop()
self._start_check = None
if self.network.is_connected():
network_start_d.callback(True)
else:
network_start_d.errback(ValueError("Failed to connect to network."))
self._start_check = task.LoopingCall(check_started)
2017-01-28 19:55:59 +01:00
d = setup_network()
2016-12-19 21:24:14 +01:00
d.addCallback(lambda _: self._load_wallet())
d.addCallback(self._save_wallet)
d.addCallback(lambda _: self._start_check.start(.1))
d.addCallback(lambda _: network_start_d)
2016-12-19 21:24:14 +01:00
d.addCallback(lambda _: self._load_blockchain())
return d
def _stop(self):
if self._start_check is not None:
self._start_check.stop()
self._start_check = None
if self._catch_up_check is not None:
if self._catch_up_check.running:
self._catch_up_check.stop()
self._catch_up_check = None
d = defer.Deferred()
def check_stopped():
2016-03-24 03:27:48 +01:00
if self.network:
if self.network.is_connected():
return False
stop_check.stop()
self.network = None
d.callback(True)
2016-03-24 03:27:48 +01:00
if self.network:
self.network.stop()
stop_check = task.LoopingCall(check_stopped)
stop_check.start(.1)
return d
def _load_wallet(self):
2016-12-19 21:24:14 +01:00
path = self.config.get_wallet_path()
storage = lbryum.wallet.WalletStorage(path)
wallet = lbryum.wallet.Wallet(storage)
if not storage.file_exists:
2017-01-03 20:13:01 +01:00
self.is_first_run = True
2016-12-19 21:24:14 +01:00
seed = wallet.make_seed()
wallet.add_seed(seed, None)
wallet.create_master_keys(None)
wallet.create_main_account()
wallet.synchronize()
self.wallet = wallet
2017-01-24 00:55:20 +01:00
self._check_large_wallet()
2016-12-19 21:24:14 +01:00
return defer.succeed(True)
2017-01-24 00:55:20 +01:00
def _check_large_wallet(self):
if len(self.wallet.addresses(include_change=False)) > 1000:
2017-01-28 17:06:29 +01:00
log.warning(("Your wallet is excessively large, please follow instructions here: ",
"https://github.com/lbryio/lbry/issues/437 to reduce your wallet size"))
2017-01-24 00:55:20 +01:00
2016-12-19 21:24:14 +01:00
def _load_blockchain(self):
blockchain_caught_d = defer.Deferred()
def on_update_callback(event, *args):
# This callback is called by lbryum when something chain
# related has happened
local_height = self.network.get_local_height()
remote_height = self.network.get_server_height()
updated_blocks_behind = self.network.get_blocks_behind()
log.info(
'Local Height: %s, remote height: %s, behind: %s',
local_height, remote_height, updated_blocks_behind)
self.blocks_behind = updated_blocks_behind
if local_height != remote_height:
2017-01-03 20:13:01 +01:00
return
assert self.blocks_behind == 0
self.network.unregister_callback(on_update_callback)
log.info("Wallet Loaded")
reactor.callFromThread(blockchain_caught_d.callback, True)
self.network.register_callback(on_update_callback, ['updated'])
2016-12-19 21:24:14 +01:00
d = defer.succeed(self.wallet.start_threads(self.network))
d.addCallback(lambda _: blockchain_caught_d)
return d
def _get_cmd_runner(self):
return Commands(self.config, self.wallet, self.network)
# run commands as a defer.succeed,
# lbryum commands should be run this way , unless if the command
# only makes a lbrum server query, use _run_cmd_as_defer_to_thread()
def _run_cmd_as_defer_succeed(self, command_name, *args):
cmd_runner = self._get_cmd_runner()
cmd = known_commands[command_name]
func = getattr(cmd_runner, cmd.name)
return defer.succeed(func(*args))
# run commands as a deferToThread, lbryum commands that only make
# queries to lbryum server should be run this way
# TODO: keep track of running threads and cancel them on `stop`
# otherwise the application will hang, waiting for threads to complete
def _run_cmd_as_defer_to_thread(self, command_name, *args):
cmd_runner = self._get_cmd_runner()
cmd = known_commands[command_name]
func = getattr(cmd_runner, cmd.name)
return threads.deferToThread(func, *args)
2017-01-12 18:51:44 +01:00
def _update_balance(self):
accounts = None
exclude_claimtrietx = True
d = self._run_cmd_as_defer_succeed('getbalance', accounts, exclude_claimtrietx)
2017-01-25 17:44:21 +01:00
d.addCallback(
lambda result: Decimal(result['confirmed']) + Decimal(result.get('unconfirmed', 0.0)))
return d
def get_new_address(self):
addr = self.wallet.get_unused_address(account=None)
if addr is None:
addr = self.wallet.create_new_address()
d = defer.succeed(addr)
d.addCallback(self._save_wallet)
return d
def get_block(self, blockhash):
return self._run_cmd_as_defer_to_thread('getblock', blockhash)
def get_most_recent_blocktime(self):
height = self.network.get_local_height()
if height < 0:
return defer.succeed(None)
header = self.network.get_header(self.network.get_local_height())
return defer.succeed(header['timestamp'])
def get_best_blockhash(self):
height = self.network.get_local_height()
if height < 0:
return defer.succeed(None)
header = self.network.blockchain.read_header(height)
return defer.succeed(self.network.blockchain.hash_header(header))
2016-09-09 06:48:54 +02:00
def _get_blockhash(self, height):
header = self.network.blockchain.read_header(height)
return defer.succeed(self.network.blockchain.hash_header(header))
2016-09-09 06:48:54 +02:00
def get_name_claims(self):
return self._run_cmd_as_defer_succeed('getnameclaims')
2016-08-08 07:42:37 +02:00
def _get_claims_for_name(self, name):
return self._run_cmd_as_defer_to_thread('getclaimsforname', name)
def _send_name_claim(self, name, val, amount):
broadcast = False
log.debug("Name claim %s %s %f", name, val, amount)
d = self._run_cmd_as_defer_succeed('claim', name, json.dumps(val), amount, broadcast)
d.addCallback(lambda claim_out: self._broadcast_claim_transaction(claim_out))
return d
2016-08-08 07:42:37 +02:00
def _send_name_claim_update(self, name, claim_id, claim_outpoint, value, amount):
metadata = json.dumps(value)
log.debug("Update %s %d %f %s %s '%s'", claim_outpoint['txid'], claim_outpoint['nout'],
2017-01-25 17:44:21 +01:00
amount, name, claim_id, metadata)
broadcast = False
d = self._run_cmd_as_defer_succeed('update', claim_outpoint['txid'], claim_outpoint['nout'],
2017-01-25 17:44:21 +01:00
name, claim_id, metadata, amount, broadcast)
d.addCallback(lambda claim_out: self._broadcast_claim_transaction(claim_out))
return d
def _abandon_claim(self, claim_outpoint):
log.debug("Abandon %s %s" % (claim_outpoint['txid'], claim_outpoint['nout']))
broadcast = False
2017-01-25 17:44:21 +01:00
d = self._run_cmd_as_defer_succeed('abandon', claim_outpoint['txid'],
claim_outpoint['nout'], broadcast)
d.addCallback(lambda claim_out: self._broadcast_claim_transaction(claim_out))
return d
2016-08-08 08:32:56 +02:00
def _support_claim(self, name, claim_id, amount):
log.debug("Support %s %s %f" % (name, claim_id, amount))
broadcast = False
d = self._run_cmd_as_defer_succeed('support', name, claim_id, amount, broadcast)
d.addCallback(lambda claim_out: self._broadcast_claim_transaction(claim_out))
2016-08-08 08:32:56 +02:00
return d
def _broadcast_claim_transaction(self, claim_out):
if 'success' not in claim_out:
raise Exception('Unexpected claim command output:{}'.format(claim_out))
if claim_out['success']:
d = self._broadcast_transaction(claim_out['tx'])
d.addCallback(lambda _: claim_out)
return d
else:
return defer.succeed(claim_out)
def _broadcast_transaction(self, raw_tx):
def _log_tx(r):
log.debug("Broadcast tx: %s", r)
return r
2017-01-25 17:44:21 +01:00
d = self._run_cmd_as_defer_to_thread('broadcast', raw_tx)
d.addCallback(_log_tx)
2016-10-27 20:28:56 +02:00
d.addCallback(
lambda r: r if len(r) == 64 else defer.fail(Exception("Transaction rejected")))
return d
def _do_send_many(self, payments_to_send):
def broadcast_send_many(paytomany_out):
if 'hex' not in paytomany_out:
raise Exception('Unepxected paytomany output:{}'.format(paytomany_out))
return self._broadcast_transaction(paytomany_out['hex'])
2017-01-25 17:44:21 +01:00
log.debug("Doing send many. payments to send: %s", str(payments_to_send))
d = self._run_cmd_as_defer_succeed('paytomany', payments_to_send.iteritems())
d.addCallback(lambda out: broadcast_send_many(out))
return d
def _get_value_for_name(self, name):
height_to_check = self.network.get_local_height() - RECOMMENDED_CLAIMTRIE_HASH_CONFIRMS + 1
if height_to_check < 0:
msg = "Height to check is less than 0, blockchain headers are likely not initialized"
raise Exception(msg)
block_header = self.network.blockchain.read_header(height_to_check)
block_hash = self.network.blockchain.hash_header(block_header)
d = self._run_cmd_as_defer_to_thread('requestvalueforname', name, block_hash)
2017-01-25 17:44:21 +01:00
d.addCallback(lambda response: Commands._verify_proof(name, block_header['claim_trie_root'],
response))
return d
def get_claims_from_tx(self, txid):
return self._run_cmd_as_defer_to_thread('getclaimsfromtx', txid)
def _get_balance_for_address(self, address):
2017-01-25 17:44:21 +01:00
return defer.succeed(Decimal(self.wallet.get_addr_received(address)) / COIN)
2016-02-22 20:24:49 +01:00
def get_nametrie(self):
return self._run_cmd_as_defer_to_thread('getclaimtrie')
2016-02-22 20:24:49 +01:00
2016-08-19 04:15:49 +02:00
def _get_history(self):
return self._run_cmd_as_defer_succeed('history')
2016-09-02 07:27:30 +02:00
def _address_is_mine(self, address):
return self._run_cmd_as_defer_succeed('ismine', address)
2016-09-02 07:27:30 +02:00
def get_pub_keys(self, wallet):
return self._run_cmd_as_defer_succeed('getpubkyes', wallet)
def _save_wallet(self, val):
self.wallet.storage.write()
return defer.succeed(val)
2015-08-20 17:27:15 +02:00
class LBRYcrdAddressRequester(object):
implements([IRequestCreator])
def __init__(self, wallet):
self.wallet = wallet
self._protocols = []
2017-01-25 17:44:21 +01:00
# ======== IRequestCreator ======== #
2015-08-20 17:27:15 +02:00
def send_next_request(self, peer, protocol):
if not protocol in self._protocols:
r = ClientRequest({'lbrycrd_address': True}, 'lbrycrd_address')
d = protocol.add_request(r)
d.addCallback(self._handle_address_response, peer, r, protocol)
d.addErrback(self._request_failed, peer)
self._protocols.append(protocol)
return defer.succeed(True)
else:
return defer.succeed(False)
2017-01-25 17:44:21 +01:00
# ======== internal calls ======== #
2015-08-20 17:27:15 +02:00
def _handle_address_response(self, response_dict, peer, request, protocol):
2017-01-28 17:06:29 +01:00
if request.response_identifier not in response_dict:
raise ValueError(
"Expected {} in response but did not get it".format(request.response_identifier))
2015-08-20 17:27:15 +02:00
assert protocol in self._protocols, "Responding protocol is not in our list of protocols"
address = response_dict[request.response_identifier]
self.wallet.update_peer_address(peer, address)
def _request_failed(self, err, peer):
if not err.check(RequestCanceledError):
log.warning("A peer failed to send a valid public key response. Error: %s, peer: %s",
err.getErrorMessage(), str(peer))
return err
2015-08-20 17:27:15 +02:00
class LBRYcrdAddressQueryHandlerFactory(object):
implements(IQueryHandlerFactory)
def __init__(self, wallet):
self.wallet = wallet
2017-01-25 17:44:21 +01:00
# ======== IQueryHandlerFactory ======== #
2015-08-20 17:27:15 +02:00
def build_query_handler(self):
q_h = LBRYcrdAddressQueryHandler(self.wallet)
return q_h
def get_primary_query_identifier(self):
return 'lbrycrd_address'
def get_description(self):
return "LBRYcrd Address - an address for receiving payments via LBRYcrd"
class LBRYcrdAddressQueryHandler(object):
implements(IQueryHandler)
def __init__(self, wallet):
self.wallet = wallet
self.query_identifiers = ['lbrycrd_address']
self.address = None
self.peer = None
2017-01-25 17:44:21 +01:00
# ======== IQueryHandler ======== #
2015-08-20 17:27:15 +02:00
def register_with_request_handler(self, request_handler, peer):
self.peer = peer
request_handler.register_query_handler(self, self.query_identifiers)
def handle_queries(self, queries):
def create_response(address):
self.address = address
fields = {'lbrycrd_address': address}
return fields
if self.query_identifiers[0] in queries:
d = self.wallet.get_new_address_for_peer(self.peer)
d.addCallback(create_response)
return d
if self.address is None:
log.warning("Expected a request for an address, but did not receive one")
2017-01-25 17:44:21 +01:00
return defer.fail(
Failure(ValueError("Expected but did not receive an address request")))
2015-08-20 17:27:15 +02:00
else:
return defer.succeed({})
2016-10-04 20:58:44 +02:00
def make_config(config=None):
if config is None:
config = {}
2017-01-25 17:44:21 +01:00
return SimpleConfig(config) if isinstance(config, dict) else config