Shielded TRC20

Shielded TRC20 is only available on Nile Testnet for now.

A ShieldedTRC20 wrapper can be acquired by get_contract_as_shielded_trc20() call.

A full set of shielded address keys can be acquired by generate_zkey() call.

Generate shielded address

>>> from tronpy import Tron
>>> client = Tron(network='nile')

>>> client.generate_zkey()
{'ak': 'd06c283d7c9a189710c323058a27d9c96e4b21fbd7a0fbabecb5d605d1190fe0',
'ask': 'e6268e981533004ea6ce05dcb68d74258962142e8e10246d22f07f2ef08d8b0c',
'd': '1c1348babd32e8b1fb556b',
'ivk': '4f8757ec009325e3a4ead1988986cc6ad078951caa6e948534d4a3ca77e64903',
'nk': '82e3f4028a019f8e2510e95f2109e9ce0401ceb37c3f8288b84a9c796c9f7913',
'nsk': '298b8ef945c1aa04a81fe04c5cd44ca674c6393053078bc6b3200414544ac109',
'ovk': 'd82520ba6aedd623ff831ca89bba9cc9d78a44eabf4d5099922386a7e5ee4dc1',
'payment_address': 'ztron1rsf53w4axt5tr764dvh035tsgfmwjga66v3g9dulazq2jzxnk63t2dupvl7ufca0fnjdj98xqqg',
'pkD': '2ef8d1704276e923bad32282b79fe880a908d3b6a2b5378167fdc4e3af4ce4d9',
'sk': '.........................omitted.......................'}

Transfer shielded TRC20 tokens

There are 3 types of shielded transfer:

• mint: from T-address to z-address
• transfer: from z-address to z-address
• burn: from z-address to T-address

To use the ShieldedTRC20 wrapper:

TEkQTDyZmbY6hngxdAsxzxy9r3bUNhRjdS is the ShieldedTRC20 of JST token(TF17BgPaZYbz8oxbjhriubPDsA7ArKoLX3) on Nile, which can be acquired via [Nile Testnet Faucet](http://nileex.io/join/getJoinPage). The scaling factor is 18.

client = Tron(network='nile')
shielded_trc20 = client.get_contract_as_shielded_trc20('TEkQTDyZmbY6hngxdAsxzxy9r3bUNhRjdS')

taddr = 'TJRabPrwbZy45sbavfcjinPJC18kjpRTv8'
priv_key = PrivateKey(bytes.fromhex("................omitted.............................."))

# check allowance
print('Allowance:', shielded_trc20.trc20.functions.allowance(taddr, shielded_trc20.shielded.contract_address))

# or approve transferFrom
# shielded_trc20.trc20.functions.approve(taddr, 1 * 10 ** 18).with_owner(taddr).build().sign(priv_key).broadcast().wait()

txn = (
    shielded_trc20.mint(taddr, zkey['payment_address'], 1 * 10 ** 18, 'The Memo').fee_limit(5_000_000).build().sign(priv_key)
)
print(txn.broadcast().wait())

# from z-addr to z-addr
# note is acquired via scan_incoming_notes, where is_spent == False
note = {
    'index': 0,
    'is_spent': False,
    'note': {
        'memo': '546865204d656d6f',
        'payment_address': 'ztron1dt62eetht5e50rm5g......omitted......v7hmskm7rhx0dv5gyec8sn',
        'rcm': 'fd39a0c1e298d88ad35893d4......omitted......57bffefdd076a521d70d',
        'value': 1,
    },
    'position': 0,
    'txid': 'e191f1114cbd8cbe43452b2c3141326ae4c2aba22a82ba195c9573895cbbfd84',
}

# transfer value unit is in shielded token, original TRC20 divided by scaling factor
txn = (
    shielded_trc20.transfer(zkey1, note, (zkey2['payment_address'], 1, "oh yeah"))
    .with_owner('TJRabPrwbZy45sbavfcjinPJC18kjpRTv8')
    .fee_limit(5_000000)
    .build()
    .sign(priv_key)
)
print(txn.txid)
print(txn.broadcast().result())

# from z-addr to T-addr
# note is acquired via scan_incoming_notes, where is_spent == False

note = {
    'note': {
        'payment_address': 'ztron1nf7ducycjl4nm4507jmv......omitted......9j66kczw0n4r7wlvkrfjtcz',
        'memo': '6f682079656168',
        'value': 1,
        'rcm': '86ced3a38ddf7e2bfa4f8......omitted......958ec860ff63da7f4608',
    },
    'txid': 'f9f8e9368d5ff34d4a923c46a8c53eb648a02da99089d6d60a6a3b57a27f9add',
    'index': 0,
    'position': 1,
    'is_spent': False,
}

txn = (
    shielded_trc20.burn(zkey2, note, "TVjsyZ7fYF3qLF6BQgPmTEZy1xrNNyVAAA")
    .with_owner('TJRabPrwbZy45sbavfcjinPJC18kjpRTv8')
    .fee_limit(5_000000)
    .build()
    .sign(priv_key)
)
print(txn.txid)
print(txn.broadcast().result())

Scan notes

notes = shielded_trc20.scan_incoming_notes(zkey, 6587490)

# or
notes = shielded_trc20.scan_incoming_notes(zkey, client.get_latest_block_number() - 100)

API reference

class tronpy.contract.ShieldedTRC20

Shielded TRC20 Wrapper.

burn(zkey: dict, note: dict, *to) → tronpy.tron.TransactionBuilder

Burn, transfer from z-address to T-address.

is_note_spent(zkey: dict, note: dict) → bool

Is a note spent.

mint(taddr: str, zaddr: str, amount: int, memo: str = '') → tronpy.tron.TransactionBuilder

Mint, transfer from T-address to z-address.

scale_factor

Scaling factor of the shielded contract.

scan_incoming_notes(zkey: dict, start_block_number: int, end_block_number: int = None) → list

Scan incoming notes using ivk, ak, nk.

scan_outgoing_notes(zkey_or_ovk: Union[dict, str], start_block_number: int, end_block_number: int = None) → list

Scan outgoing notes using ovk.

shielded = None

Thi shielded TRC20 contract.

transfer(zkey: dict, notes: Union[list, dict], *to) → tronpy.tron.TransactionBuilder

Transfer from z-address to z-address.

trc20

The corresponding TRC20 contract.