lbry-sdk/lbrynet/extras/daemon/json_response_encoder.py

233 lines
9.9 KiB
Python
Raw Normal View History

import logging
2018-08-16 01:23:06 +02:00
from decimal import Decimal
from binascii import hexlify
from datetime import datetime
from json import JSONEncoder
2019-04-29 06:38:58 +02:00
from google.protobuf.message import DecodeError
2019-03-20 22:31:00 +01:00
from lbrynet.schema.claim import Claim
2019-04-06 21:33:07 +02:00
from lbrynet.wallet.ledger import MainNetLedger, Account
2019-03-20 06:46:23 +01:00
from lbrynet.wallet.transaction import Transaction, Output
from lbrynet.wallet.dewies import dewies_to_lbc
2019-04-06 21:33:07 +02:00
from lbrynet.stream.managed_stream import ManagedStream
2018-08-16 01:23:06 +02:00
log = logging.getLogger(__name__)
2019-04-06 21:33:07 +02:00
def encode_txo_doc():
return {
'txid': "hash of transaction in hex",
'nout': "position in the transaction",
2019-04-20 07:12:43 +02:00
'height': "block where transaction was recorded",
2019-04-06 21:33:07 +02:00
'amount': "value of the txo as a decimal",
'address': "address of who can spend the txo",
2019-04-20 07:12:43 +02:00
'confirmations': "number of confirmed blocks",
'is_change': "payment to change address, only available when it can be determined",
'is_mine': "payment to one of your accounts, only available when it can be determined",
'type': "one of 'claim', 'support' or 'payment'",
'name': "when type is 'claim' or 'support', this is the claim name",
'claim_id': "when type is 'claim' or 'support', this is the claim id",
'claim_op': "when type is 'claim', this determines if it is 'create' or 'update'",
'value': "when type is 'claim' or 'support' with payload, this is the decoded protobuf payload",
'value_type': "determines the type of the 'value' field: 'channel', 'stream', etc",
'protobuf': "hex encoded raw protobuf version of 'value' field",
2019-04-20 07:12:43 +02:00
'permanent_url': "when type is 'claim' or 'support', this is the long permanent claim URL",
'signing_channel': "for signed claims only, metadata of signing channel",
'is_channel_signature_valid': "for signed claims only, whether signature is valid",
2019-04-06 21:33:07 +02:00
}
def encode_tx_doc():
return {
'txid': "hash of transaction in hex",
'height': "block where transaction was recorded",
'inputs': [encode_txo_doc()],
'outputs': [encode_txo_doc()],
'total_input': "sum of inputs as a decimal",
'total_output': "sum of outputs, sans fee, as a decimal",
'total_fee': "fee amount",
'hex': "entire transaction encoded in hex",
}
def encode_account_doc():
return {
'id': 'account_id',
'is_default': 'this account is used by default',
'ledger': 'name of crypto currency and network',
'name': 'optional account name',
'seed': 'human friendly words from which account can be recreated',
'encrypted': 'if account is encrypted',
'private_key': 'extended private key',
'public_key': 'extended public key',
'address_generator': 'settings for generating addresses',
'modified_on': 'date of last modification to account settings'
}
def encode_file_doc():
return {
'streaming_url': '(str) url to stream the file using range requests',
2019-04-06 21:33:07 +02:00
'completed': '(bool) true if download is completed',
'file_name': '(str) name of file',
'download_directory': '(str) download directory',
'points_paid': '(float) credit paid to download file',
'stopped': '(bool) true if download is stopped',
'stream_hash': '(str) stream hash of file',
'stream_name': '(str) stream name',
'suggested_file_name': '(str) suggested file name',
'sd_hash': '(str) sd hash of file',
'download_path': '(str) download path of file',
'mime_type': '(str) mime type of file',
'key': '(str) key attached to file',
'total_bytes_lower_bound': '(int) lower bound file size in bytes',
'total_bytes': '(int) file upper bound size in bytes',
'written_bytes': '(int) written size in bytes',
'blobs_completed': '(int) number of fully downloaded blobs',
'blobs_in_stream': '(int) total blobs on stream',
'blobs_remaining': '(int) total blobs remaining to download',
'status': '(str) downloader status',
'claim_id': '(str) None if claim is not found else the claim id',
'txid': '(str) None if claim is not found else the transaction id',
'nout': '(int) None if claim is not found else the transaction output index',
'outpoint': '(str) None if claim is not found else the tx and output',
'metadata': '(dict) None if claim is not found else the claim metadata',
'channel_claim_id': '(str) None if claim is not found or not signed',
'channel_name': '(str) None if claim is not found or not signed',
'claim_name': '(str) None if claim is not found else the claim name'
}
2018-08-16 01:23:06 +02:00
class JSONResponseEncoder(JSONEncoder):
def __init__(self, *args, ledger: MainNetLedger, include_protobuf=False, **kwargs):
2018-08-16 01:23:06 +02:00
super().__init__(*args, **kwargs)
self.ledger = ledger
self.include_protobuf = include_protobuf
2018-08-16 01:23:06 +02:00
2018-08-16 17:24:22 +02:00
def default(self, obj): # pylint: disable=method-hidden
2019-04-06 21:33:07 +02:00
if isinstance(obj, Account):
return self.encode_account(obj)
if isinstance(obj, ManagedStream):
return self.encode_file(obj)
2018-08-16 01:23:06 +02:00
if isinstance(obj, Transaction):
return self.encode_transaction(obj)
if isinstance(obj, Output):
return self.encode_output(obj)
2019-03-20 22:31:00 +01:00
if isinstance(obj, Claim):
2019-04-20 07:12:43 +02:00
return self.encode_claim(obj)
2018-08-16 01:23:06 +02:00
if isinstance(obj, datetime):
return obj.strftime("%Y%m%dT%H:%M:%S")
if isinstance(obj, Decimal):
return float(obj)
2018-08-16 21:55:33 +02:00
if isinstance(obj, bytes):
return obj.decode()
2018-08-16 01:23:06 +02:00
return super().default(obj)
def encode_transaction(self, tx):
return {
'txid': tx.id,
'height': tx.height,
2018-08-16 01:23:06 +02:00
'inputs': [self.encode_input(txo) for txo in tx.inputs],
'outputs': [self.encode_output(txo) for txo in tx.outputs],
2018-10-03 22:38:47 +02:00
'total_input': dewies_to_lbc(tx.input_sum),
'total_output': dewies_to_lbc(tx.input_sum - tx.fee),
'total_fee': dewies_to_lbc(tx.fee),
2018-08-16 01:23:06 +02:00
'hex': hexlify(tx.raw).decode(),
}
def encode_output(self, txo, check_signature=True):
tx_height = txo.tx_ref.height
best_height = self.ledger.headers.height
output = {
2018-09-19 15:58:50 +02:00
'txid': txo.tx_ref.id,
2018-08-16 01:23:06 +02:00
'nout': txo.position,
2019-04-20 07:12:43 +02:00
'height': tx_height,
2018-10-03 22:38:47 +02:00
'amount': dewies_to_lbc(txo.amount),
2018-09-19 15:58:50 +02:00
'address': txo.get_address(self.ledger),
'confirmations': (best_height+1) - tx_height if tx_height > 0 else tx_height,
'timestamp': self.ledger.headers[tx_height]['timestamp'] if tx_height > 0 else None
2018-08-16 01:23:06 +02:00
}
if txo.is_change is not None:
output['is_change'] = txo.is_change
2018-10-05 15:02:02 +02:00
if txo.is_my_account is not None:
output['is_mine'] = txo.is_my_account
2019-04-20 07:12:43 +02:00
if txo.script.is_claim_name:
output['type'] = 'claim'
output['claim_op'] = 'create'
elif txo.script.is_update_claim:
output['type'] = 'claim'
output['claim_op'] = 'update'
elif txo.script.is_support_claim:
output['type'] = 'support'
else:
output['type'] = 'payment'
2018-10-05 15:02:02 +02:00
if txo.script.is_claim_involved:
output.update({
'name': txo.claim_name,
2019-04-29 06:38:58 +02:00
'normalized': txo.normalized_name,
2018-10-05 15:02:02 +02:00
'claim_id': txo.claim_id,
'permanent_url': txo.permanent_url,
2019-05-05 05:24:41 +02:00
'meta': self.encode_claim_meta(txo.meta)
2018-10-05 15:02:02 +02:00
})
if txo.script.is_claim_name or txo.script.is_update_claim:
2019-04-29 06:38:58 +02:00
try:
output['value'] = txo.claim
output['value_type'] = txo.claim.claim_type
if self.include_protobuf:
output['protobuf'] = hexlify(txo.claim.to_bytes())
if txo.channel is not None:
output['signing_channel'] = {
'name': txo.channel.claim_name,
'normalized': txo.channel.normalized_name,
'claim_id': txo.channel.claim_id,
'value': txo.channel.claim,
2019-05-05 05:24:41 +02:00
'meta': self.encode_claim_meta(txo.channel.meta)
2019-04-29 06:38:58 +02:00
}
if check_signature and txo.claim.is_signed:
output['is_channel_signature_valid'] = False
if txo.channel:
2019-04-29 06:38:58 +02:00
output['is_channel_signature_valid'] = txo.is_signed_by(txo.channel, self.ledger)
except DecodeError:
pass
return output
2018-08-16 01:23:06 +02:00
2019-05-05 05:24:41 +02:00
def encode_claim_meta(self, meta):
if isinstance(meta.get('effective_amount'), int):
meta['effective_amount'] = dewies_to_lbc(meta['effective_amount'])
if isinstance(meta.get('trending_amount'), int):
meta['trending_amount'] = dewies_to_lbc(meta['trending_amount'])
return meta
2018-08-16 01:23:06 +02:00
def encode_input(self, txi):
return self.encode_output(txi.txo_ref.txo, False) if txi.txo_ref.txo is not None else {
'txid': txi.txo_ref.tx_ref.id,
'nout': txi.txo_ref.position
}
2019-04-06 21:33:07 +02:00
def encode_account(self, account):
result = account.to_dict()
result['id'] = account.id
result.pop('certificates', None)
result['is_default'] = self.ledger.accounts[0] == account
return result
def encode_file(self, managed_stream):
file = managed_stream.as_dict()
tx_height = managed_stream.stream_claim_info.height
best_height = self.ledger.headers.height
file.update({
'height': tx_height,
'confirmations': (best_height+1) - tx_height if tx_height > 0 else tx_height,
'timestamp': self.ledger.headers[tx_height]['timestamp'] if tx_height > 0 else None
})
return file
2019-04-20 07:12:43 +02:00
@staticmethod
def encode_claim(claim):
return getattr(claim, claim.claim_type).to_dict()