forked from andelf/tronpy
-
Notifications
You must be signed in to change notification settings - Fork 0
/
tron.py
876 lines (712 loc) · 32.5 KB
/
tron.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
import time
import json
from pprint import pprint
from decimal import Decimal
from typing import Union, Tuple, Optional
from wallet.tronpy import keys
from wallet.tronpy.contract import Contract, ShieldedTRC20, ContractMethod
from wallet.tronpy.keys import PrivateKey
from wallet.tronpy.providers import HTTPProvider
from wallet.tronpy.abi import tron_abi
from wallet.tronpy.defaults import conf_for_name
from wallet.tronpy.exceptions import (
BadSignature,
BadKey,
BadHash,
BlockNotFound,
AssetNotFound,
TaposError,
UnknownError,
TransactionError,
ValidationError,
ApiError,
AddressNotFound,
TransactionNotFound,
TvmError,
BugInJavaTron,
)
TAddress = str
DEFAULT_CONF = {
'fee_limit': 10_000_000,
'timeout': 10.0, # in second
}
def current_timestamp() -> int:
return int(time.time() * 1000)
class TransactionRet(dict):
def __init__(self, iterable, client: "Tron", method: ContractMethod = None):
super().__init__(iterable)
self._client = client
self._txid = self["txid"]
self._method = method
@property
def txid(self):
"""The transaction id in hex."""
return self._txid
def wait(self, timeout=30, interval=1.6, solid=False) -> dict:
"""Wait the transaction to be on chain.
:returns: TransactionInfo
"""
get_transaction_info = self._client.get_transaction_info
if solid:
get_transaction_info = self._client.get_solid_transaction_info
end_time = time.time() + timeout
while time.time() < end_time:
try:
return get_transaction_info(self._txid)
except TransactionNotFound:
time.sleep(interval)
raise TransactionNotFound("timeout and can not find the transaction")
def result(self, timeout=30, interval=1.6, solid=False) -> dict:
"""Wait the contract calling result.
:returns: Result of contract method
"""
if self._method is None:
raise TypeError("Not a smart contract call")
receipt = self.wait(timeout, interval, solid)
if receipt.get('result', None) == 'FAILED':
msg = receipt.get('resMessage', receipt['result'])
if receipt['receipt']['result'] == 'REVERT':
try:
result = receipt.get('contractResult', [])
if result and len(result[0]) > (4 + 32) * 2:
error_msg = tron_abi.decode_single('string', bytes.fromhex(result[0])[4 + 32 :])
msg = "{}: {}".format(msg, error_msg)
except Exception:
pass
raise TvmError(msg)
return self._method.parse_output(receipt['contractResult'][0])
class Transaction(object):
"""The Transaction object, signed or unsigned."""
def __init__(self, raw_data: dict, client: "Tron" = None, method: ContractMethod = None,
txid: str = "", permission: dict = None, signature: list = None):
self._raw_data: dict = raw_data
self._signature: list = signature or []
self._client = client
self._method = method
self.txid: str = txid
"""The transaction id in hex."""
self._permission: Optional[dict] = permission
if not self.txid or not self._permission:
sign_weight = self._client.get_sign_weight(self)
if "transaction" not in sign_weight:
self._client._handle_api_error(sign_weight)
return # unreachable
self.txid = sign_weight["transaction"]["transaction"]["txID"]
# when account not exist on-chain
self._permission = sign_weight.get("permission", None)
def to_json(self) -> dict:
return {
"txID": self.txid, "raw_data": self._raw_data,
"signature": self._signature, "permission": self._permission
}
@classmethod
def from_json(cls, data: Union[str, dict], client: "Tron" = None):
if isinstance(json, str):
data = json.loads(data)
return cls(
client=client,
txid=data['txID'], permission=data['permission'],
raw_data=data['raw_data'], signature=data['signature']
)
def inspect(self) -> "Transaction":
pprint(self.to_json())
return self
def sign(self, priv_key: PrivateKey) -> "Transaction":
"""Sign the transaction with a private key."""
assert self.txid, "txID not calculated"
assert self.is_expired is False, 'expired'
if self._permission is not None:
addr_of_key = priv_key.public_key.to_hex_address()
for key in self._permission["keys"]:
if key["address"] == addr_of_key:
break
else:
raise BadKey(
"provided private key is not in the permission list",
"provided {}".format(priv_key.public_key.to_base58check_address()),
"required {}".format(self._permission),
)
sig = priv_key.sign_msg_hash(bytes.fromhex(self.txid))
self._signature.append(sig.hex())
return self
def broadcast(self) -> TransactionRet:
"""Broadcast the transaction to TRON network."""
return TransactionRet(self._client.broadcast(self), client=self._client, method=self._method)
@property
def is_expired(self) -> bool:
return current_timestamp() >= self._raw_data['expiration']
def update(self):
"""update Transaction, change ref_block and txID, remove all signature"""
self._raw_data["timestamp"] = current_timestamp()
self._raw_data["expiration"] = self._raw_data["timestamp"] + 60_000
ref_block_id = self._client.get_latest_solid_block_id()
# last 2 byte of block number part
self._raw_data["ref_block_bytes"] = ref_block_id[12:16]
# last half part of block hash
self._raw_data["ref_block_hash"] = ref_block_id[16:32]
self.txid = ""
self._permission = None
self._signature = []
sign_weight = self._client.get_sign_weight(self)
if "transaction" not in sign_weight:
self._client._handle_api_error(sign_weight)
return # unreachable
self.txid = sign_weight["transaction"]["transaction"]["txID"]
# when account not exist on-chain
self._permission = sign_weight.get("permission", None)
# remove all _signature
self._signature = []
def __str__(self):
return json.dumps(self.to_json(), indent=2)
class TransactionBuilder(object):
"""TransactionBuilder, to build a :class:`~Transaction` object."""
def __init__(self, inner: dict, client: "Tron", method: ContractMethod = None):
self._client = client
self._raw_data = {
"contract": [inner],
"timestamp": current_timestamp(),
"expiration": current_timestamp() + 60_000,
"ref_block_bytes": None,
"ref_block_hash": None,
}
if inner.get('type', None) in ['TriggerSmartContract', 'CreateSmartContract']:
self._raw_data["fee_limit"] = self._client.conf['fee_limit']
self._method = method
def with_owner(self, addr: TAddress) -> "TransactionBuilder":
"""Set owner of the transaction."""
if "owner_address" in self._raw_data["contract"][0]["parameter"]["value"]:
self._raw_data["contract"][0]["parameter"]["value"]["owner_address"] = keys.to_hex_address(addr)
else:
raise TypeError("can not set owner")
return self
def permission_id(self, perm_id: int) -> "TransactionBuilder":
"""Set permission_id of the transaction."""
self._raw_data["contract"][0]["Permission_id"] = perm_id
return self
def memo(self, memo: Union[str, bytes]) -> "TransactionBuilder":
"""Set memo of the transaction."""
data = memo.encode() if isinstance(memo, (str,)) else memo
self._raw_data["data"] = data.hex()
return self
def fee_limit(self, value: int) -> "TransactionBuilder":
"""Set fee_limit of the transaction, in `SUN`."""
self._raw_data["fee_limit"] = value
return self
def build(self, options=None, **kwargs) -> Transaction:
"""Build the transaction."""
ref_block_id = self._client.get_latest_solid_block_id()
# last 2 byte of block number part
self._raw_data["ref_block_bytes"] = ref_block_id[12:16]
# last half part of block hash
self._raw_data["ref_block_hash"] = ref_block_id[16:32]
if self._method:
return Transaction(self._raw_data, client=self._client, method=self._method)
return Transaction(self._raw_data, client=self._client)
class Trx(object):
"""The Trx(transaction) API."""
def __init__(self, tron):
self._tron = tron
@property
def client(self) -> "Tron":
return self._tron
def _build_transaction(self, type_: str, obj: dict, *, method: ContractMethod = None) -> TransactionBuilder:
inner = {
"parameter": {"value": obj, "type_url": "type.googleapis.com/protocol.{}".format(type_)},
"type": type_,
}
if method:
return TransactionBuilder(inner, client=self.client, method=method)
return TransactionBuilder(inner, client=self.client)
def transfer(self, from_: TAddress, to: TAddress, amount: int) -> TransactionBuilder:
"""Transfer TRX. ``amount`` in `SUN`."""
return self._build_transaction(
"TransferContract",
{"owner_address": keys.to_hex_address(from_), "to_address": keys.to_hex_address(to), "amount": amount},
)
# TRC10 asset
def asset_transfer(self, from_: TAddress, to: TAddress, amount: int, token_id: int) -> TransactionBuilder:
"""Transfer TRC10 tokens."""
return self._build_transaction(
"TransferAssetContract",
{
"owner_address": keys.to_hex_address(from_),
"to_address": keys.to_hex_address(to),
"amount": amount,
"asset_name": str(token_id).encode().hex(),
},
)
def asset_issue(
self,
owner: TAddress,
abbr: str,
total_supply: int,
*,
url: str,
name: str = None,
description: str = "",
start_time: int = None,
end_time: int = None,
precision: int = 6,
frozen_supply: list = None,
trx_num: int = 1,
num: int = 1,
) -> TransactionBuilder:
"""Issue a TRC10 token.
Almost all parameters have resonable defaults.
"""
if name is None:
name = abbr
if start_time is None:
# use default expiration
start_time = current_timestamp() + 60_000
if end_time is None:
# use default expiration
end_time = current_timestamp() + 60_000 + 1
if frozen_supply is None:
frozen_supply = []
return self._build_transaction(
"AssetIssueContract",
{
"owner_address": keys.to_hex_address(owner),
"abbr": abbr.encode().hex(),
"name": name.encode().hex(),
"total_supply": total_supply,
"precision": precision,
"url": url.encode().hex(),
"description": description.encode().hex(),
"start_time": start_time,
"end_time": end_time,
"frozen_supply": frozen_supply,
"trx_num": trx_num,
"num": num,
"public_free_asset_net_limit": 0,
"free_asset_net_limit": 0,
},
)
# Account
def account_permission_update(self, owner: TAddress, perm: dict) -> "TransactionBuilder":
"""Update account permission.
:param owner:
:param perm: Permission dict from :meth:`~tronpy.Tron.get_account_permission`
"""
if 'owner' in perm:
for key in perm['owner']['keys']:
key['address'] = keys.to_hex_address(key['address'])
if 'actives' in perm:
for act in perm['actives']:
for key in act['keys']:
key['address'] = keys.to_hex_address(key['address'])
if perm.get('witness', None):
for key in perm['witness']['keys']:
key['address'] = keys.to_hex_address(key['address'])
return self._build_transaction(
"AccountPermissionUpdateContract", dict(owner_address=keys.to_hex_address(owner), **perm),
)
def account_update(self, owner: TAddress, name: str) -> "TransactionBuilder":
"""Update account name. An account can only set name once."""
return self._build_transaction(
"UpdateAccountContract", {"owner_address": keys.to_hex_address(owner), "account_name": name.encode().hex()},
)
def freeze_balance(
self, owner: TAddress, amount: int, resource: str = "ENERGY", *, receiver: TAddress = None
) -> "TransactionBuilder":
"""Freeze balance to get energy or bandwidth, for 3 days.
:param owner:
:param amount:
:param resource: Resource type, can be ``"ENERGY"`` or ``"BANDWIDTH"``
:param receiver:
"""
payload = {
"owner_address": keys.to_hex_address(owner),
"frozen_balance": amount,
"frozen_duration": 3,
"resource": resource,
}
if receiver is not None:
payload["receiver_address"] = keys.to_hex_address(receiver)
return self._build_transaction("FreezeBalanceContract", payload)
def unfreeze_balance(
self, owner: TAddress, resource: str = "ENERGY", receiver: TAddress = None
) -> "TransactionBuilder":
"""Unfreeze balance to get TRX back.
:param owner:
:param resource: Resource type, can be ``"ENERGY"`` or ``"BANDWIDTH"``
:param receiver:
"""
payload = {
"owner_address": keys.to_hex_address(owner),
"resource": resource,
}
if receiver is not None:
payload["receiver_address"] = keys.to_hex_address(receiver)
return self._build_transaction("UnfreezeBalanceContract", payload)
# Witness
def create_witness(self, owner: TAddress, url: str) -> "TransactionBuilder":
"""Create a new witness, will consume 1_000 TRX."""
payload = {"owner_address": keys.to_hex_address(owner), "url": url.encode().hex()}
return self._build_transaction("WitnessCreateContract", payload)
def vote_witness(self, owner: TAddress, *votes: Tuple[TAddress, int]) -> "TransactionBuilder":
"""Vote for witnesses. Empty ``votes`` to clean voted."""
votes = [dict(vote_address=keys.to_hex_address(addr), vote_count=count) for addr, count in votes]
payload = {"owner_address": keys.to_hex_address(owner), "votes": votes}
return self._build_transaction("VoteWitnessContract", payload)
# Contract
def deploy_contract(self, owner: TAddress, contract: Contract) -> "TransactionBuilder":
"""Deploy a new contract on chain."""
contract._client = self.client
contract.owner_address = owner
contract.origin_address = owner
contract.contract_address = None
return contract.deploy()
class Tron(object):
"""The TRON API Client.
:param provider: An :class:`~tronpy.providers.HTTPProvider` object, can be configured to use private node
:param network: Which network to connect, one of ``"mainnet"``, ``"shasta"``, ``"nile"``, or ``"tronex"``
"""
# Address API
is_address = staticmethod(keys.is_address)
"""Is object a TRON address, both hex format and base58check format."""
is_base58check_address = staticmethod(keys.is_base58check_address)
"""Is object an address in base58check format."""
is_hex_address = staticmethod(keys.is_hex_address)
"""Is object an address in hex str format."""
to_base58check_address = staticmethod(keys.to_base58check_address)
"""Convert address of any format to a base58check format."""
to_hex_address = staticmethod(keys.to_hex_address)
"""Convert address of any format to a hex format."""
to_canonical_address = staticmethod(keys.to_base58check_address)
def __init__(self, provider: HTTPProvider = None, *, network: str = "mainnet", conf: dict = None):
self.conf = DEFAULT_CONF
"""The config dict."""
if conf is not None:
self.conf = dict(DEFAULT_CONF, **conf)
if provider is not None and self.conf['timeout'] != DEFAULT_CONF['timeout']:
raise ValueError("timeout value should be set in provider")
if provider is None:
self.provider = HTTPProvider(conf_for_name(network), self.conf['timeout'])
elif isinstance(provider, (HTTPProvider,)):
self.provider = provider
else:
raise TypeError("provider is not a HTTPProvider")
self._trx = Trx(self)
@property
def trx(self) -> Trx:
"""
Helper object to send various transactions.
:type: Trx
"""
return self._trx
def _handle_api_error(self, payload: dict):
if payload.get("result", None) is True:
return
if "Error" in payload:
# class java.lang.NullPointerException : null
raise ApiError(payload["Error"])
if "code" in payload:
try:
msg = bytes.fromhex(payload["message"]).decode()
except Exception:
msg = payload.get("message", str(payload))
if payload["code"] == "SIGERROR":
raise BadSignature(msg)
elif payload["code"] == "TAPOS_ERROR":
raise TaposError(msg)
elif payload["code"] in ["TRANSACTION_EXPIRATION_ERROR", "TOO_BIG_TRANSACTION_ERROR"]:
raise TransactionError(msg)
elif payload["code"] == "CONTRACT_VALIDATE_ERROR":
raise ValidationError(msg)
raise UnknownError(msg, payload["code"])
if "result" in payload and isinstance(payload["result"], (dict,)):
return self._handle_api_error(payload["result"])
# Address utilities
def generate_address(self, priv_key=None) -> dict:
"""Generate a random address."""
if priv_key is None:
priv_key = PrivateKey.random()
return {
"base58check_address": priv_key.public_key.to_base58check_address(),
"hex_address": priv_key.public_key.to_hex_address(),
"private_key": priv_key.hex(),
"public_key": priv_key.public_key.hex(),
}
def get_address_from_passphrase(self, passphrase: str) -> dict:
"""Get an address from a passphrase, compatiable with `wallet/createaddress`."""
priv_key = PrivateKey.from_passphrase(passphrase.encode())
return self.generate_address(priv_key)
def generate_zkey(self) -> dict:
"""Generate a random shielded address."""
return self.provider.make_request("wallet/getnewshieldedaddress")
def get_zkey_from_sk(self, sk: str, d: str = None) -> dict:
"""Get the shielded address from sk(spending key) and d(diversifier)."""
if len(sk) != 64:
raise BadKey("32 byte sk required")
if d and len(d) != 22:
raise BadKey("11 byte d required")
esk = self.provider.make_request("wallet/getexpandedspendingkey", {"value": sk})
ask = esk["ask"]
nsk = esk["nsk"]
ovk = esk["ovk"]
ak = self.provider.make_request("wallet/getakfromask", {"value": ask})["value"]
nk = self.provider.make_request("wallet/getnkfromnsk", {"value": nsk})["value"]
ivk = self.provider.make_request("wallet/getincomingviewingkey", {"ak": ak, "nk": nk})["ivk"]
if d is None:
d = self.provider.make_request("wallet/getdiversifier")["d"]
ret = self.provider.make_request("wallet/getzenpaymentaddress", {"ivk": ivk, "d": d})
pkD = ret["pkD"]
payment_address = ret["payment_address"]
return dict(
sk=sk, ask=ask, nsk=nsk, ovk=ovk, ak=ak, nk=nk, ivk=ivk, d=d, pkD=pkD, payment_address=payment_address,
)
# Account query
def get_account(self, addr: TAddress) -> dict:
"""Get account info from an address."""
ret = self.provider.make_request(
"wallet/getaccount", {"address": keys.to_base58check_address(addr), "visible": True}
)
if ret:
return ret
else:
raise AddressNotFound("account not found on-chain")
def get_account_resource(self, addr: TAddress) -> dict:
"""Get resource info of an account."""
ret = self.provider.make_request(
"wallet/getaccountresource", {"address": keys.to_base58check_address(addr), "visible": True},
)
if ret:
return ret
else:
raise AddressNotFound("account not found on-chain")
def get_account_balance(self, addr: TAddress) -> Decimal:
"""Get TRX balance of an account. Result in `TRX`."""
info = self.get_account(addr)
return Decimal(info.get("balance", 0)) / 1_000_000
def get_account_asset_balances(self, addr: TAddress) -> dict:
"""Get all TRC10 token balances of an account."""
info = self.get_account(addr)
return {p['key']: p['value'] for p in info.get("assetV2", {}) if p['value'] > 0}
def get_account_asset_balance(self, addr: TAddress, token_id: Union[int, str]) -> int:
"""Get TRC10 token balance of an account. Result is in raw amount."""
if int(token_id) < 1000000 or int(token_id) > 1999999:
raise ValueError("invalid token_id range")
balances = self.get_account_asset_balances(addr)
return balances.get(str(token_id), 0)
def get_account_permission(self, addr: TAddress) -> dict:
"""Get account's permission info from an address. Can be used in `account_permission_update`."""
addr = keys.to_base58check_address(addr)
# will check account existence
info = self.get_account(addr)
# For old accounts prior to AccountPermissionUpdate, these fields are not set.
# So default permission is for backward compatibility.
default_witness = None
if info.get("is_witness", None):
default_witness = {
"type": "Witness",
"id": 1,
"permission_name": "witness",
"threshold": 1,
"keys": [{"address": addr, "weight": 1}],
}
return {
"owner": info.get(
"owner_permission",
{"permission_name": "owner", "threshold": 1, "keys": [{"address": addr, "weight": 1}]},
),
"actives": info.get(
"active_permission",
[
{
"type": "Active",
"id": 2,
"permission_name": "active",
"threshold": 1,
"operations": "7fff1fc0033e0100000000000000000000000000000000000000000000000000",
"keys": [{"address": addr, "weight": 1}],
}
],
),
"witness": info.get("witness_permission", default_witness),
}
# Block query
def get_latest_solid_block(self) -> dict:
return self.provider.make_request("walletsolidity/getnowblock")
def get_latest_solid_block_id(self) -> str:
"""Get latest solid block id in hex."""
info = self.provider.make_request("wallet/getnodeinfo")
return info["solidityBlock"].split(",ID:", 1)[-1]
def get_latest_solid_block_number(self) -> int:
"""Get latest solid block number. Implemented via `wallet/getnodeinfo`,
which is faster than `walletsolidity/getnowblock`."""
info = self.provider.make_request("wallet/getnodeinfo")
return int(info["solidityBlock"].split(",ID:", 1)[0].replace("Num:", "", 1))
def get_latest_block(self) -> dict:
"""Get latest block."""
return self.provider.make_request("wallet/getnowblock", {"visible": True})
def get_latest_block_id(self) -> str:
"""Get latest block id in hex."""
info = self.provider.make_request("wallet/getnodeinfo")
return info["block"].split(",ID:", 1)[-1]
def get_latest_block_number(self) -> int:
"""Get latest block number. Implemented via `wallet/getnodeinfo`, which is faster than `wallet/getnowblock`."""
info = self.provider.make_request("wallet/getnodeinfo")
return int(info["block"].split(",ID:", 1)[0].replace("Num:", "", 1))
def get_block(self, id_or_num: Union[None, str, int] = None, *, visible: bool = True) -> dict:
"""Get block from a block id or block number.
:param id_or_num: Block number, or Block hash(id), or ``None`` (default) to get the latest block.
:param visible: Use ``visible=False`` to get non-base58check addresses and strings instead of hex strings.
"""
if isinstance(id_or_num, (int,)):
block = self.provider.make_request("wallet/getblockbynum", {"num": id_or_num, "visible": visible})
elif isinstance(id_or_num, (str,)):
block = self.provider.make_request("wallet/getblockbyid", {"value": id_or_num, "visible": visible})
elif id_or_num is None:
block = self.provider.make_request("wallet/getnowblock", {"visible": visible})
else:
raise TypeError("can not infer type of {}".format(id_or_num))
if 'Error' in (block or {}):
raise BugInJavaTron(block)
elif block:
return block
else:
raise BlockNotFound
def get_transaction(self, txn_id: str) -> dict:
"""Get transaction from a transaction id."""
if len(txn_id) != 64:
raise BadHash("wrong transaction hash length")
ret = self.provider.make_request("wallet/gettransactionbyid", {"value": txn_id, "visible": True})
self._handle_api_error(ret)
if ret:
return ret
raise TransactionNotFound
def get_transaction_info(self, txn_id: str) -> dict:
"""Get transaction receipt info from a transaction id."""
if len(txn_id) != 64:
raise BadHash("wrong transaction hash length")
ret = self.provider.make_request("wallet/gettransactioninfobyid", {"value": txn_id, "visible": True})
self._handle_api_error(ret)
if ret:
return ret
raise TransactionNotFound
def get_solid_transaction_info(self, txn_id: str) -> dict:
"""Get transaction receipt info from a transaction id, must be in solid block."""
if len(txn_id) != 64:
raise BadHash("wrong transaction hash length")
ret = self.provider.make_request("walletsolidity/gettransactioninfobyid", {"value": txn_id, "visible": True})
self._handle_api_error(ret)
if ret:
return ret
raise TransactionNotFound
# Chain parameters
def list_witnesses(self) -> list:
"""List all witnesses, including SR, SRP, and SRC."""
# NOTE: visible parameter is ignored
ret = self.provider.make_request("wallet/listwitnesses", {"visible": True})
witnesses = ret.get("witnesses", [])
for witness in witnesses:
witness["address"] = keys.to_base58check_address(witness["address"])
return witnesses
def list_nodes(self) -> list:
"""List all nodes that current API node is connected to."""
# NOTE: visible parameter is ignored
ret = self.provider.make_request("wallet/listnodes", {"visible": True})
nodes = ret.get("nodes", [])
for node in nodes:
node["address"]["host"] = bytes.fromhex(node["address"]["host"]).decode()
return nodes
def get_node_info(self) -> dict:
"""Get current API node' info."""
return self.provider.make_request("wallet/getnodeinfo", {"visible": True})
def get_chain_parameters(self) -> dict:
"""List all chain parameters, values that can be changed via proposal."""
return self.provider.make_request("wallet/getchainparameters", {"visible": True}).get("chainParameter", [])
# Asset (TRC10)
def get_asset(self, id: int = None, issuer: TAddress = None) -> dict:
"""Get TRC10(asset) info by asset's id or issuer."""
if id and issuer:
return ValueError("either query by id or issuer")
if id:
return self.provider.make_request("wallet/getassetissuebyid", {"value": id, "visible": True})
else:
return self.provider.make_request(
"wallet/getassetissuebyaccount", {"address": keys.to_base58check_address(issuer), "visible": True},
)
def get_asset_from_name(self, name: str) -> dict:
"""Get asset info from its abbr name, might fail if there're duplicates."""
assets = [asset for asset in self.list_assets() if asset['abbr'] == name]
if assets:
if len(assets) == 1:
return assets[0]
raise ValueError("duplicated assets with the same name", [asset['id'] for asset in assets])
raise AssetNotFound
def list_assets(self) -> list:
"""List all TRC10 tokens(assets)."""
ret = self.provider.make_request("wallet/getassetissuelist", {"visible": True})
assets = ret["assetIssue"]
for asset in assets:
asset["id"] = int(asset["id"])
asset["owner_address"] = keys.to_base58check_address(asset["owner_address"])
asset["name"] = bytes.fromhex(asset["name"]).decode()
if "abbr" in asset:
asset["abbr"] = bytes.fromhex(asset["abbr"]).decode()
else:
asset["abbr"] = ""
asset["description"] = bytes.fromhex(asset["description"]).decode("utf8", "replace")
asset["url"] = bytes.fromhex(asset["url"]).decode()
return assets
# Smart contract
def get_contract(self, addr: TAddress) -> Contract:
"""Get a contract object."""
addr = keys.to_base58check_address(addr)
info = self.provider.make_request("wallet/getcontract", {"value": addr, "visible": True})
try:
self._handle_api_error(info)
except ApiError:
# your java's null pointer exception sucks
raise AddressNotFound("contract address not found")
cntr = Contract(
addr=addr,
bytecode=info.get("bytecode", ''),
name=info.get("name", ""),
abi=info.get("abi", {}).get("entrys", []),
origin_energy_limit=info.get("origin_energy_limit", 0),
user_resource_percent=info.get("consume_user_resource_percent", 100),
client=self,
)
return cntr
def get_contract_as_shielded_trc20(self, addr: TAddress) -> ShieldedTRC20:
"""Get a Shielded TRC20 Contract object."""
contract = self.get_contract(addr)
return ShieldedTRC20(contract)
def trigger_const_smart_contract_function(
self, owner_address: TAddress, contract_address: TAddress, function_selector: str, parameter: str,
) -> str:
ret = self.provider.make_request(
"wallet/triggerconstantcontract",
{
"owner_address": keys.to_base58check_address(owner_address),
"contract_address": keys.to_base58check_address(contract_address),
"function_selector": function_selector,
"parameter": parameter,
"visible": True,
},
)
self._handle_api_error(ret)
if 'message' in ret.get('result', {}):
msg = ret['result']['message']
result = ret.get('constant_result', [])
try:
if result and len(result[0]) > (4 + 32) * 2:
error_msg = tron_abi.decode_single('string', bytes.fromhex(result[0])[4 + 32 :])
msg = "{}: {}".format(msg, error_msg)
except Exception:
pass
raise TvmError(msg)
return ret["constant_result"][0]
# Transaction handling
def broadcast(self, txn: Transaction) -> dict:
payload = self.provider.make_request("wallet/broadcasttransaction", txn.to_json())
self._handle_api_error(payload)
if payload.get('txid') is None:
payload['txid'] = txn.txid
return payload
def get_sign_weight(self, txn: Transaction) -> dict:
return self.provider.make_request("wallet/getsignweight", txn.to_json())