# thor-request.py
VeChain for humans.
This library enables you to talk to VeChain blockchain without hassle.
- Covers most topic on contract interaction, vet transfer, vtho transfer and transaction debug.
- Automatically estimate gas and decode events/revert reasons for you.
## Installation
Pypi package: https://pypi.org/project/thor-requests/
```
pip3 install -U thor-requests
```
# Quick Start
```python
from thor_requests.connect import Connect
connector = Connect("https://testnet.veblocks.net")
# ... Now you can access VeChain
```
## API Reference
```python
from thor_requests.connect import Connect
from thor_requests.wallet import Wallet
from thor_requests.contract import Contract
# Wallet
wallet = Wallet.fromPrivate(priv=b'')
wallet = Wallet.fromMnemonic(words=[])
wallet = Wallet.fromKeyStore(ks=dict, password='')
wallet = Wallet.newWallet() # Create a random wallet
# Contract
contract = Contract(meta_dict=dict)
contract = Contract.fromFile(meta_file_path='')
# Connect
connector = Connect(node_url='')
connector.get_chainTag()
connector.get_account(address='')
connector.get_block(block_id='')
connector.get_tx(tx_id='')
connector.get_tx_receipt(tx_id='')
connector.wait_for_tx_receipt(tx_id='', time_out=20)
connector.replay_tx(tx_id='')
# Ticker
for block in connector.ticker():
....do things
# Deploy a smart contract
connector.deploy(wallet, contract)
# Call a contract function (won't spend gas)
connector.call(caller, contract, func_name, func_params, to, value=0, gas=None)
# Execute a contract fucntion (spend real gas)
connector.transact(wallet, contract, func_name, func_params, to, value=0, gas=None)
# Multi clauses support (MTT)
clause1 = connector.clause(contract, func_name, func_params, to, value=0)
clause2 = connector.clause(contract, func_name, func_params, to, value=0)
# Call them (won't spend gas)
connector.call_multi(caller, clauses=[clause1, clause2])
# Or execute them
connector.transact_multi(wallet, clauses=[clause1, clause2])
```
# Examples (Blockchain)
## Get Tx/Block/Account/Receipt
```python
from thor_requests.connect import Connect
connector = Connect("https://testnet.veblocks.net")
# Account
connector.get_account('0x7567d83b7b8d80addcb281a71d54fc7b3364ffed')
# >>> {'balance': '0x21671d16fd19254d67', 'energy': '0xf809f75231563b5f1d', 'hasCode': False}
# Block
connector.get_block('0x0084f21562e046b1ae9aa70b6cd3b7bc2e8312f3961716ee3fcd58ce8bcb7392')
# >>> {'number': 8712725, 'id': '0x0084f21562e046b1ae9aa70b6cd3b7bc2e8312f3961716ee3fcd58ce8bcb7392', 'size': 243, 'parentID': '0x0084f214dd0b96059a142b5ac33668a3bb56245bde62d72a7874dc5a842c89e7', 'timestamp': 1617158500, 'gasLimit': 281323205, 'beneficiary': '0xb4094c25f86d628fdd571afc4077f0d0196afb48', 'gasUsed': 0, 'totalScore': 33966653, 'txsRoot': '0x45b0cfc220ceec5b7c1c62c4d4193d38e4eba48e8815729ce75f9c0ab0e4c1c0', 'txsFeatures': 1, 'stateRoot': '0xfe32d569f127a9a1d6f690bb83dae1c91fee31cac6596ae573ad3fa76c209670', 'receiptsRoot': '0x45b0cfc220ceec5b7c1c62c4d4193d38e4eba48e8815729ce75f9c0ab0e4c1c0', 'signer': '0x39218d415dc252a50823a3f5600226823ba4716e', 'isTrunk': True, 'transactions': []}
# Transaction
connector.get_tx("0xda2ce6bddfb3bd32541c999e81ef56019a6314a23c90a466896aeefca33aebc1")
# >>> {'id': '0xda2ce6bddfb3bd32541c999e81ef56019a6314a23c90a466896aeefca33aebc1', 'chainTag': 39, 'blockRef': '0x00825266c5688208', 'expiration': 18, 'clauses': [{'to': '0x0000000000000000000000000000456e65726779', 'value': '0x0', 'data': '0xa9059cbb0000000000000000000000007567d83b7b8d80addcb281a71d54fc7b3364ffed0000000000000000000000000000000000000000000000056bc75e2d63100000'}], 'gasPriceCoef': 0, 'gas': 51582, 'origin': '0xfa6e63168115a9202dcd834f6c20eabf48f18ba7', 'delegator': None, 'nonce': '0x32c31a501fcd9752', 'dependsOn': None, 'size': 190, 'meta': {'blockID': '0x0082526895631e850b6cae1ba0a05deb24b8719b6896b69437cea87ee939bf3d', 'blockNumber': 8540776, 'blockTimestamp': 1615439010}}
# Transaction receipt
connector.get_tx_receipt('0xda2ce6bddfb3bd32541c999e81ef56019a6314a23c90a466896aeefca33aebc1')
# >>> {'gasUsed': 36582, 'gasPayer': '0xfa6e63168115a9202dcd834f6c20eabf48f18ba7', 'paid': '0x1fbad5f2e25570000', 'reward': '0x984d9c8dd8008000', 'reverted': False, 'meta': {'blockID': '0x0082526895631e850b6cae1ba0a05deb24b8719b6896b69437cea87ee939bf3d', 'blockNumber': 8540776, 'blockTimestamp': 1615439010, 'txID': '0xda2ce6bddfb3bd32541c999e81ef56019a6314a23c90a466896aeefca33aebc1', 'txOrigin': '0xfa6e63168115a9202dcd834f6c20eabf48f18ba7'}, 'outputs': [{'contractAddress': None, 'events': [{'address': '0x0000000000000000000000000000456e65726779', 'topics': ['0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef', '0x000000000000000000000000fa6e63168115a9202dcd834f6c20eabf48f18ba7', '0x0000000000000000000000007567d83b7b8d80addcb281a71d54fc7b3364ffed'], 'data': '0x0000000000000000000000000000000000000000000000056bc75e2d63100000'}], 'transfers': []}]}
# Chain Tag
connector.get_chainTag()
# >>> 39
```
## Debug a Failed Transaction
This operation will yield pretty revert reason if any.
```python
from thor_requests.connect import Connect
connector = Connect("https://testnet.veblocks.net")
connector.replay_tx("0x1d05a502db56ba46ccd258a5696b9b78cd83de6d0d67f22b297f37e710a72bb5")
# Notice: Revert Reason is decoded for you.
# [{
# 'data': '0x08c379a00000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000001c7472616e7366657220746f20746865207a65726f206164647265737300000000',
# 'events': [],
# 'transfers': [],
# 'gasUsed': 659,
# 'reverted': True,
# 'vmError': 'evm: execution reverted',
# 'decoded': {
# 'revertReason': 'transfer to the zero address'
# }
# }]
```
# Examples (Smart Contract)
## Deploy a Smart Contract
```python
from thor_requests.connect import Connect
from thor_requests.wallet import Wallet
from thor_requests.contract import Contract
connector = Connect("https://testnet.veblocks.net")
# wallet address: 0x7567d83b7b8d80addcb281a71d54fc7b3364ffed
_wallet = Wallet.fromPrivateKey(bytes.fromhex("dce1443bd2ef0c2631adc1c67e5c93f13dc23a41c18b536effbbdcbcdb96fb65"))
_contract = Contract.fromFile("/path/to/solc/compiled/smart_contract.json")
res = connector.deploy(_wallet, _contract)
print(res)
# >>> {'id': '0xa670ae6fc053f3e63e9a944947d1e2eb9f53dc613fd305552ee00af987a6d140'}
```
## Call a Function (won't spend gas, emulate only)
```python
from thor_requests.connect import Connect
from thor_requests.contract import Contract
connector = Connect("https://testnet.veblocks.net")
_contract_addr = '0x535b9a56c2f03a3658fc8787c44087574eb381fd'
_contract = Contract.fromFile("/path/to/solc/compiled/smart_contract.json")
# Emulate the "balanceOf()" function
res = connector.call(
caller='0x....', # fill in your caller address or all zero address
contract=_contract,
func_name="balanceOf",
func_params=['0x7567d83b7b8d80addcb281a71d54fc7b3364ffed'],
to=_contract_addr,
)
print(res)
# Notice: The return value is decoded for you.
# {
# 'data': '0x0000000000000000000000000000000000000000000000006124fee993bc0004',
# 'events': [],
# 'transfers': [],
# 'gasUsed': 557,
# 'reverted': False,
# 'vmError': '',
# 'decoded': {
# '0': 7000000000000000004
# }
# }
# Emulate the "deposit()" function
res = connector.call(
caller='0x7567d83b7b8d80addcb281a71d54fc7b3364ffed',
contract=_contract,
func_name="deposit",
func_params=[],
to=_contract_addr,
value=4
)
print(res)
# Notice the Event is decoded for you.
# {
# 'data': '0x',
# 'events': [{
# 'address': '0x535b9a56c2f03a3658fc8787c44087574eb381fd',
# 'topics': ['0xe1fffcc4923d04b559f4d29a8bfc6cda04eb5b0d3c460751c2402c5c5cc9109c', '0x0000000000000000000000007567d83b7b8d80addcb281a71d54fc7b3364ffed'],
# 'data': '0x0000000000000000000000000000000000000000000000000000000000000004',
# 'decoded': {
# '0': '0x7567d83b7b8d80addcb281a71d54fc7b3364ffed',
# 'dst': '0x7567d83b7b8d80addcb281a71d54fc7b3364ffed',
# '1': 4,
# 'wad': 4
# },
# 'name': 'Deposit'
# }],
# 'transfers': [{
# 'sender': '0x7567d83b7b8d80addcb281a71d54fc7b3364ffed',
# 'recipient': '0x535b9a56c2f03a3658fc8787c44087574eb381fd',
# 'amount': '0x4'
# }],
# 'gasUsed': 6902,
# 'reverted': False,
# 'vmError': ''
# }
```
## Execute a Function (spend real gas)
```python
from thor_requests.connect import Connect
from thor_requests.wallet import Wallet
from thor_requests.contract import Contract
connector = Connect("https://testnet.veblocks.net")
# wallet address: 0x7567d83b7b8d80addcb281a71d54fc7b3364ffed
_wallet = Wallet.fromPrivateKey(bytes.fromhex("dce1443bd2ef0c2631adc1c67e5c93f13dc23a41c18b536effbbdcbcdb96fb65"))
_contract_addr = '0x535b9a56c2f03a3658fc8787c44087574eb381fd'
_contract = Contract.fromFile("/path/to/solc/compiled/metadata.json")
# Execute the "deposit()" function. (will pay gas)
# Send along 5 VET with the tx
res = connector.transact(_wallet, _contract, "deposit", [], to=_contract_addr, value=5 * (10 ** 18))
print(res)
# >>> {'id': '0x51222328b7395860cb9cc6d69d822cf31056851b5694eeccc9f243021eecd547'}
```
## Send VET and VTHO (or any vip180 token)
```python
from thor_requests.connect import Connect
from thor_requests.wallet import Wallet
connector = Connect("https://testnet.veblocks.net")
# wallet address: 0x7567d83b7b8d80addcb281a71d54fc7b3364ffed
_wallet = Wallet.fromPrivateKey(bytes.fromhex("dce1443bd2ef0c2631adc1c67e5c93f13dc23a41c18b536effbbdcbcdb96fb65"))
# Transfer 3 VET to 0x0000000000000000000000000000000000000000
connector.transfer_vet(
_wallet,
to='0x0000000000000000000000000000000000000000',
value=3 * (10 ** 18)
)
# Transfer 3 VTHO to 0x0000000000000000000000000000000000000000
connector.transfer_vtho(
_wallet,
to='0x0000000000000000000000000000000000000000',
vtho_in_wei=3 * (10 ** 18)
)
# Transfer 3 OCE to 0x0000000000000000000000000000000000000000
connector.transfer_token(
_wallet,
to='0x0000000000000000000000000000000000000000',
token_contract_addr='0x0ce6661b4ba86a0ea7ca2bd86a0de87b0b860f14', # OCE smart contract
amount_in_wei=3 * (10 ** 18)
)
# Check VET or VTHO balance of an address: 0x0000000000000000000000000000000000000000
amount_vet = connector.get_vet_balance('0x0000000000000000000000000000000000000000')
amount_vtho = connector.get_vtho_balance('0x0000000000000000000000000000000000000000')
```
## VIP-191 Fee Delegation Feature (I)
```python
# Sign a local transaction if you have:
# 1) Wallet to originate the transaction
# 2) Wallet to pay for the gas fee
from thor_requests.connect import Connect
from thor_requests.wallet import Wallet
from thor_requests.contract import Contract
connector = Connect("https://testnet.veblocks.net")
# wallet 1: The transaction sender
_sender = Wallet.fromMnemonic(words=['...', '...', ... ])
# wallet 2: The transaction fee payer
_payer = Wallet.fromPrivateKey(bytes.fromhex("dce1443bd2ef0c2631adc1c67e5c93f13dc23a41c18b536effbbdcbcdb96fb65"))
# Smart contract
_contract_addr = '0x535b9a56c2f03a3658fc8787c44087574eb381fd'
_contract = Contract.fromFile("/path/to/solc/compiled/metadata.json")
# For example,
# "The sender" execute the "deposit()" function on the smart contract, with 5 VET within the transaction
# Transaction paid by "the payer".
res = connector.transact(
_sender,
_contract,
"deposit",
[],
to=_contract_addr,
value=5 * (10 ** 18),
gas_payer=_payer
)
print(res)
# >>> {'id': '0x51222328b7395860cb9cc6d69d822cf31056851b5694eeccc9f243021eecd547'}
```
## VIP-191 Fee Delegation Feature (II)
```python
# Sign a remotely received raw transaction if you have:
# 1) A judgment function to decide if you want to sign the raw tx or not.
# 2) A sponsor wallet to pay for the gas fee
# On user's side, create a transaction body
delegated_body = {
"chainTag": 1,
"blockRef": "0x00000000aabbccdd",
"expiration": 32,
"clauses": [
{
"to": "0x7567d83b7b8d80addcb281a71d54fc7b3364ffed",
"value": 10000,
"data": "0x000000606060"
}
],
"gasPriceCoef": 128,
"gas": 21000,
"dependsOn": None,
"nonce": 12345678,
"reserved": {
"features": 1
}
}
delegated_tx = transaction.Transaction(delegated_body)
raw_tx = '0x' + delegated_tx.encode().hex()
# We give an example judgment function that allows all transaction to be signed
def allPass(tx_payer:str, tx_origin:str, transaction):
''' Run analyze on the given params, shall return bool, error_message '''
return True, ''
your_sponsor_wallet = ... # your local sponsor wallet
tx_origin_address = ... # '0x...' string, the transaction's originator
# Sign it with a local sponsor wallet
result = utils.sign_delegated_tx(your_sponsor_wallet, tx_origin_address, raw_tx, False, allPass)
print(result['signature']) # This is the sponsor signature you are looking for
```
## VIP-191 Fee Delegation Feature (III)
```python
# Quickly send VET or VTHO using fee delegation
from thor_requests.connect import Connect
from thor_requests.wallet import Wallet
connector = Connect("https://testnet.veblocks.net")
# sender wallet
_sender = Wallet.fromMnemonic(words=['...', '...', ... ])
# gas payer wallet
_payer = Wallet.fromPrivateKey(bytes.fromhex("dce1443bd2ef0c2631adc1c67e5c93f13dc23a41c18b536effbbdcbcdb96fb65"))
# Transfer 3 VET from _sender to 0x0000000000000000000000000000000000000000
connector.transfer_vet(
_sender,
to='0x0000000000000000000000000000000000000000',
value=3 * (10 ** 18),
gas_payer=_payer
)
# Transfer 3 VTHO from _sender to 0x0000000000000000000000000000000000000000
connector.transfer_vtho(
_sender,
to='0x0000000000000000000000000000000000000000',
vtho_in_wei=3 * (10 ** 18),
gas_payer=_payer
)
```
## Ticker to track block mining
```python
from thor_requests.connect import Connect
c = Connect("https://testnet.veblocks.net")
for block in c.ticker():
... do something with new block
```
Raw data
{
"_id": null,
"home_page": "https://github.com/laalaguer/thor-requests",
"name": "thor-requests",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "vechain thor blockchain sdk requests",
"author": "laalaguer",
"author_email": "laalaguer@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/f1/fd/3c2f060aa3e011f2b9044ae28c8e6dd86857ab105ae852d5040f11603a94/thor-requests-1.2.4.tar.gz",
"platform": null,
"description": "# thor-request.py\nVeChain for humans.\n\nThis library enables you to talk to VeChain blockchain without hassle.\n\n- Covers most topic on contract interaction, vet transfer, vtho transfer and transaction debug.\n\n- Automatically estimate gas and decode events/revert reasons for you.\n\n## Installation\n\nPypi package: https://pypi.org/project/thor-requests/\n\n```\npip3 install -U thor-requests\n```\n\n# Quick Start\n```python\nfrom thor_requests.connect import Connect\n\nconnector = Connect(\"https://testnet.veblocks.net\")\n\n# ... Now you can access VeChain\n```\n\n## API Reference\n\n```python\nfrom thor_requests.connect import Connect\nfrom thor_requests.wallet import Wallet\nfrom thor_requests.contract import Contract\n\n# Wallet\nwallet = Wallet.fromPrivate(priv=b'')\nwallet = Wallet.fromMnemonic(words=[])\nwallet = Wallet.fromKeyStore(ks=dict, password='')\nwallet = Wallet.newWallet() # Create a random wallet\n\n# Contract\ncontract = Contract(meta_dict=dict)\ncontract = Contract.fromFile(meta_file_path='')\n\n# Connect\nconnector = Connect(node_url='')\nconnector.get_chainTag()\nconnector.get_account(address='')\nconnector.get_block(block_id='')\nconnector.get_tx(tx_id='')\nconnector.get_tx_receipt(tx_id='')\nconnector.wait_for_tx_receipt(tx_id='', time_out=20)\nconnector.replay_tx(tx_id='')\n\n# Ticker\nfor block in connector.ticker():\n ....do things\n\n# Deploy a smart contract\nconnector.deploy(wallet, contract)\n\n# Call a contract function (won't spend gas)\nconnector.call(caller, contract, func_name, func_params, to, value=0, gas=None)\n\n# Execute a contract fucntion (spend real gas)\nconnector.transact(wallet, contract, func_name, func_params, to, value=0, gas=None)\n\n# Multi clauses support (MTT)\nclause1 = connector.clause(contract, func_name, func_params, to, value=0)\nclause2 = connector.clause(contract, func_name, func_params, to, value=0)\n\n# Call them (won't spend gas)\nconnector.call_multi(caller, clauses=[clause1, clause2])\n\n# Or execute them\nconnector.transact_multi(wallet, clauses=[clause1, clause2])\n```\n\n# Examples (Blockchain)\n## Get Tx/Block/Account/Receipt\n```python\nfrom thor_requests.connect import Connect\n\nconnector = Connect(\"https://testnet.veblocks.net\")\n\n# Account\nconnector.get_account('0x7567d83b7b8d80addcb281a71d54fc7b3364ffed')\n\n# >>> {'balance': '0x21671d16fd19254d67', 'energy': '0xf809f75231563b5f1d', 'hasCode': False}\n\n# Block\nconnector.get_block('0x0084f21562e046b1ae9aa70b6cd3b7bc2e8312f3961716ee3fcd58ce8bcb7392')\n\n# >>> {'number': 8712725, 'id': '0x0084f21562e046b1ae9aa70b6cd3b7bc2e8312f3961716ee3fcd58ce8bcb7392', 'size': 243, 'parentID': '0x0084f214dd0b96059a142b5ac33668a3bb56245bde62d72a7874dc5a842c89e7', 'timestamp': 1617158500, 'gasLimit': 281323205, 'beneficiary': '0xb4094c25f86d628fdd571afc4077f0d0196afb48', 'gasUsed': 0, 'totalScore': 33966653, 'txsRoot': '0x45b0cfc220ceec5b7c1c62c4d4193d38e4eba48e8815729ce75f9c0ab0e4c1c0', 'txsFeatures': 1, 'stateRoot': '0xfe32d569f127a9a1d6f690bb83dae1c91fee31cac6596ae573ad3fa76c209670', 'receiptsRoot': '0x45b0cfc220ceec5b7c1c62c4d4193d38e4eba48e8815729ce75f9c0ab0e4c1c0', 'signer': '0x39218d415dc252a50823a3f5600226823ba4716e', 'isTrunk': True, 'transactions': []}\n\n# Transaction\nconnector.get_tx(\"0xda2ce6bddfb3bd32541c999e81ef56019a6314a23c90a466896aeefca33aebc1\")\n\n# >>> {'id': '0xda2ce6bddfb3bd32541c999e81ef56019a6314a23c90a466896aeefca33aebc1', 'chainTag': 39, 'blockRef': '0x00825266c5688208', 'expiration': 18, 'clauses': [{'to': '0x0000000000000000000000000000456e65726779', 'value': '0x0', 'data': '0xa9059cbb0000000000000000000000007567d83b7b8d80addcb281a71d54fc7b3364ffed0000000000000000000000000000000000000000000000056bc75e2d63100000'}], 'gasPriceCoef': 0, 'gas': 51582, 'origin': '0xfa6e63168115a9202dcd834f6c20eabf48f18ba7', 'delegator': None, 'nonce': '0x32c31a501fcd9752', 'dependsOn': None, 'size': 190, 'meta': {'blockID': '0x0082526895631e850b6cae1ba0a05deb24b8719b6896b69437cea87ee939bf3d', 'blockNumber': 8540776, 'blockTimestamp': 1615439010}}\n\n# Transaction receipt\nconnector.get_tx_receipt('0xda2ce6bddfb3bd32541c999e81ef56019a6314a23c90a466896aeefca33aebc1')\n\n# >>> {'gasUsed': 36582, 'gasPayer': '0xfa6e63168115a9202dcd834f6c20eabf48f18ba7', 'paid': '0x1fbad5f2e25570000', 'reward': '0x984d9c8dd8008000', 'reverted': False, 'meta': {'blockID': '0x0082526895631e850b6cae1ba0a05deb24b8719b6896b69437cea87ee939bf3d', 'blockNumber': 8540776, 'blockTimestamp': 1615439010, 'txID': '0xda2ce6bddfb3bd32541c999e81ef56019a6314a23c90a466896aeefca33aebc1', 'txOrigin': '0xfa6e63168115a9202dcd834f6c20eabf48f18ba7'}, 'outputs': [{'contractAddress': None, 'events': [{'address': '0x0000000000000000000000000000456e65726779', 'topics': ['0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef', '0x000000000000000000000000fa6e63168115a9202dcd834f6c20eabf48f18ba7', '0x0000000000000000000000007567d83b7b8d80addcb281a71d54fc7b3364ffed'], 'data': '0x0000000000000000000000000000000000000000000000056bc75e2d63100000'}], 'transfers': []}]}\n\n# Chain Tag\nconnector.get_chainTag()\n# >>> 39\n```\n## Debug a Failed Transaction\n\nThis operation will yield pretty revert reason if any.\n\n```python\nfrom thor_requests.connect import Connect\n\nconnector = Connect(\"https://testnet.veblocks.net\")\nconnector.replay_tx(\"0x1d05a502db56ba46ccd258a5696b9b78cd83de6d0d67f22b297f37e710a72bb5\")\n\n# Notice: Revert Reason is decoded for you.\n\n# [{\n# 'data': '0x08c379a00000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000001c7472616e7366657220746f20746865207a65726f206164647265737300000000',\n# 'events': [],\n# 'transfers': [],\n# 'gasUsed': 659,\n# 'reverted': True,\n# 'vmError': 'evm: execution reverted',\n# 'decoded': {\n# 'revertReason': 'transfer to the zero address'\n# }\n# }]\n```\n# Examples (Smart Contract)\n\n## Deploy a Smart Contract\n\n```python\nfrom thor_requests.connect import Connect\nfrom thor_requests.wallet import Wallet\nfrom thor_requests.contract import Contract\n\nconnector = Connect(\"https://testnet.veblocks.net\")\n\n# wallet address: 0x7567d83b7b8d80addcb281a71d54fc7b3364ffed\n_wallet = Wallet.fromPrivateKey(bytes.fromhex(\"dce1443bd2ef0c2631adc1c67e5c93f13dc23a41c18b536effbbdcbcdb96fb65\")) \n\n_contract = Contract.fromFile(\"/path/to/solc/compiled/smart_contract.json\")\n\nres = connector.deploy(_wallet, _contract)\nprint(res)\n# >>> {'id': '0xa670ae6fc053f3e63e9a944947d1e2eb9f53dc613fd305552ee00af987a6d140'}\n```\n\n## Call a Function (won't spend gas, emulate only)\n\n```python\nfrom thor_requests.connect import Connect\nfrom thor_requests.contract import Contract\n\nconnector = Connect(\"https://testnet.veblocks.net\")\n\n_contract_addr = '0x535b9a56c2f03a3658fc8787c44087574eb381fd'\n_contract = Contract.fromFile(\"/path/to/solc/compiled/smart_contract.json\")\n\n# Emulate the \"balanceOf()\" function\nres = connector.call(\n caller='0x....', # fill in your caller address or all zero address\n contract=_contract,\n func_name=\"balanceOf\",\n func_params=['0x7567d83b7b8d80addcb281a71d54fc7b3364ffed'],\n to=_contract_addr,\n)\nprint(res)\n\n# Notice: The return value is decoded for you.\n\n# {\n# 'data': '0x0000000000000000000000000000000000000000000000006124fee993bc0004',\n# 'events': [],\n# 'transfers': [],\n# 'gasUsed': 557,\n# 'reverted': False,\n# 'vmError': '',\n# 'decoded': {\n# '0': 7000000000000000004\n# }\n# }\n\n# Emulate the \"deposit()\" function\nres = connector.call(\n caller='0x7567d83b7b8d80addcb281a71d54fc7b3364ffed',\n contract=_contract,\n func_name=\"deposit\",\n func_params=[],\n to=_contract_addr,\n value=4\n)\nprint(res)\n\n# Notice the Event is decoded for you.\n\n# {\n# 'data': '0x',\n# 'events': [{\n# 'address': '0x535b9a56c2f03a3658fc8787c44087574eb381fd',\n# 'topics': ['0xe1fffcc4923d04b559f4d29a8bfc6cda04eb5b0d3c460751c2402c5c5cc9109c', '0x0000000000000000000000007567d83b7b8d80addcb281a71d54fc7b3364ffed'],\n# 'data': '0x0000000000000000000000000000000000000000000000000000000000000004',\n# 'decoded': {\n# '0': '0x7567d83b7b8d80addcb281a71d54fc7b3364ffed',\n# 'dst': '0x7567d83b7b8d80addcb281a71d54fc7b3364ffed',\n# '1': 4,\n# 'wad': 4\n# },\n# 'name': 'Deposit'\n# }],\n# 'transfers': [{\n# 'sender': '0x7567d83b7b8d80addcb281a71d54fc7b3364ffed',\n# 'recipient': '0x535b9a56c2f03a3658fc8787c44087574eb381fd',\n# 'amount': '0x4'\n# }],\n# 'gasUsed': 6902,\n# 'reverted': False,\n# 'vmError': ''\n# }\n```\n\n## Execute a Function (spend real gas)\n\n```python\nfrom thor_requests.connect import Connect\nfrom thor_requests.wallet import Wallet\nfrom thor_requests.contract import Contract\n\nconnector = Connect(\"https://testnet.veblocks.net\")\n\n# wallet address: 0x7567d83b7b8d80addcb281a71d54fc7b3364ffed\n_wallet = Wallet.fromPrivateKey(bytes.fromhex(\"dce1443bd2ef0c2631adc1c67e5c93f13dc23a41c18b536effbbdcbcdb96fb65\")) \n_contract_addr = '0x535b9a56c2f03a3658fc8787c44087574eb381fd'\n_contract = Contract.fromFile(\"/path/to/solc/compiled/metadata.json\")\n\n# Execute the \"deposit()\" function. (will pay gas)\n# Send along 5 VET with the tx\nres = connector.transact(_wallet, _contract, \"deposit\", [], to=_contract_addr, value=5 * (10 ** 18))\nprint(res)\n\n# >>> {'id': '0x51222328b7395860cb9cc6d69d822cf31056851b5694eeccc9f243021eecd547'}\n```\n\n## Send VET and VTHO (or any vip180 token)\n```python\nfrom thor_requests.connect import Connect\nfrom thor_requests.wallet import Wallet\n\nconnector = Connect(\"https://testnet.veblocks.net\")\n\n# wallet address: 0x7567d83b7b8d80addcb281a71d54fc7b3364ffed\n_wallet = Wallet.fromPrivateKey(bytes.fromhex(\"dce1443bd2ef0c2631adc1c67e5c93f13dc23a41c18b536effbbdcbcdb96fb65\")) \n\n# Transfer 3 VET to 0x0000000000000000000000000000000000000000\nconnector.transfer_vet(\n _wallet,\n to='0x0000000000000000000000000000000000000000',\n value=3 * (10 ** 18)\n)\n\n# Transfer 3 VTHO to 0x0000000000000000000000000000000000000000\nconnector.transfer_vtho(\n _wallet, \n to='0x0000000000000000000000000000000000000000',\n vtho_in_wei=3 * (10 ** 18)\n)\n\n# Transfer 3 OCE to 0x0000000000000000000000000000000000000000\nconnector.transfer_token(\n _wallet, \n to='0x0000000000000000000000000000000000000000',\n token_contract_addr='0x0ce6661b4ba86a0ea7ca2bd86a0de87b0b860f14', # OCE smart contract\n amount_in_wei=3 * (10 ** 18)\n)\n\n# Check VET or VTHO balance of an address: 0x0000000000000000000000000000000000000000\namount_vet = connector.get_vet_balance('0x0000000000000000000000000000000000000000')\namount_vtho = connector.get_vtho_balance('0x0000000000000000000000000000000000000000')\n```\n\n## VIP-191 Fee Delegation Feature (I)\n```python\n# Sign a local transaction if you have:\n# 1) Wallet to originate the transaction\n# 2) Wallet to pay for the gas fee\n\nfrom thor_requests.connect import Connect\nfrom thor_requests.wallet import Wallet\nfrom thor_requests.contract import Contract\n\nconnector = Connect(\"https://testnet.veblocks.net\")\n\n# wallet 1: The transaction sender\n_sender = Wallet.fromMnemonic(words=['...', '...', ... ]) \n\n# wallet 2: The transaction fee payer\n_payer = Wallet.fromPrivateKey(bytes.fromhex(\"dce1443bd2ef0c2631adc1c67e5c93f13dc23a41c18b536effbbdcbcdb96fb65\")) \n\n# Smart contract\n_contract_addr = '0x535b9a56c2f03a3658fc8787c44087574eb381fd'\n_contract = Contract.fromFile(\"/path/to/solc/compiled/metadata.json\")\n\n# For example, \n# \"The sender\" execute the \"deposit()\" function on the smart contract, with 5 VET within the transaction\n# Transaction paid by \"the payer\".\nres = connector.transact(\n _sender,\n _contract,\n \"deposit\",\n [],\n to=_contract_addr,\n value=5 * (10 ** 18),\n gas_payer=_payer\n)\nprint(res)\n# >>> {'id': '0x51222328b7395860cb9cc6d69d822cf31056851b5694eeccc9f243021eecd547'}\n```\n\n## VIP-191 Fee Delegation Feature (II)\n```python\n# Sign a remotely received raw transaction if you have:\n# 1) A judgment function to decide if you want to sign the raw tx or not.\n# 2) A sponsor wallet to pay for the gas fee\n\n# On user's side, create a transaction body\ndelegated_body = {\n \"chainTag\": 1,\n \"blockRef\": \"0x00000000aabbccdd\",\n \"expiration\": 32,\n \"clauses\": [\n {\n \"to\": \"0x7567d83b7b8d80addcb281a71d54fc7b3364ffed\",\n \"value\": 10000,\n \"data\": \"0x000000606060\"\n }\n ],\n \"gasPriceCoef\": 128,\n \"gas\": 21000,\n \"dependsOn\": None,\n \"nonce\": 12345678,\n \"reserved\": {\n \"features\": 1\n }\n}\n\ndelegated_tx = transaction.Transaction(delegated_body)\nraw_tx = '0x' + delegated_tx.encode().hex()\n\n# We give an example judgment function that allows all transaction to be signed\ndef allPass(tx_payer:str, tx_origin:str, transaction):\n ''' Run analyze on the given params, shall return bool, error_message '''\n return True, ''\n\nyour_sponsor_wallet = ... # your local sponsor wallet\ntx_origin_address = ... # '0x...' string, the transaction's originator\n# Sign it with a local sponsor wallet\nresult = utils.sign_delegated_tx(your_sponsor_wallet, tx_origin_address, raw_tx, False, allPass)\nprint(result['signature']) # This is the sponsor signature you are looking for\n```\n\n\n## VIP-191 Fee Delegation Feature (III)\n\n```python\n# Quickly send VET or VTHO using fee delegation\n\nfrom thor_requests.connect import Connect\nfrom thor_requests.wallet import Wallet\n\nconnector = Connect(\"https://testnet.veblocks.net\")\n\n# sender wallet\n_sender = Wallet.fromMnemonic(words=['...', '...', ... ])\n\n# gas payer wallet\n_payer = Wallet.fromPrivateKey(bytes.fromhex(\"dce1443bd2ef0c2631adc1c67e5c93f13dc23a41c18b536effbbdcbcdb96fb65\")) \n\n# Transfer 3 VET from _sender to 0x0000000000000000000000000000000000000000\nconnector.transfer_vet(\n _sender,\n to='0x0000000000000000000000000000000000000000',\n value=3 * (10 ** 18),\n gas_payer=_payer\n)\n\n# Transfer 3 VTHO from _sender to 0x0000000000000000000000000000000000000000\nconnector.transfer_vtho(\n _sender, \n to='0x0000000000000000000000000000000000000000',\n vtho_in_wei=3 * (10 ** 18),\n gas_payer=_payer\n)\n```\n\n## Ticker to track block mining\n```python\nfrom thor_requests.connect import Connect\n\nc = Connect(\"https://testnet.veblocks.net\")\n\nfor block in c.ticker():\n ... do something with new block\n```\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Simple network VeChain SDK for human to interact with the blockchain",
"version": "1.2.4",
"project_urls": {
"Documentation": "https://github.com/laalaguer/thor-requests",
"Homepage": "https://github.com/laalaguer/thor-requests",
"Issue Tracker": "https://github.com/laalaguer/thor-requests/issues",
"Source": "https://github.com/laalaguer/thor-requests"
},
"split_keywords": [
"vechain",
"thor",
"blockchain",
"sdk",
"requests"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1b9e6d8d7b920cfbeb122deaaa99b0b22d228a814ce1f78444b0727bec09002d",
"md5": "698456056d67511acead42a2169aea3d",
"sha256": "e3d37d64fb87457d470b35edc9d3db14fff9c509c4d66fe38fb4a16d62cf2d85"
},
"downloads": -1,
"filename": "thor_requests-1.2.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "698456056d67511acead42a2169aea3d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 38446,
"upload_time": "2023-07-20T08:37:00",
"upload_time_iso_8601": "2023-07-20T08:37:00.760470Z",
"url": "https://files.pythonhosted.org/packages/1b/9e/6d8d7b920cfbeb122deaaa99b0b22d228a814ce1f78444b0727bec09002d/thor_requests-1.2.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f1fd3c2f060aa3e011f2b9044ae28c8e6dd86857ab105ae852d5040f11603a94",
"md5": "c62b5e5d7b7d0fe96bea42a6f7eb58cd",
"sha256": "0bfd8feb379f090ed2dc5304ef38a35f8f2e36754ef8719f0f9115133b835a0a"
},
"downloads": -1,
"filename": "thor-requests-1.2.4.tar.gz",
"has_sig": false,
"md5_digest": "c62b5e5d7b7d0fe96bea42a6f7eb58cd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 37254,
"upload_time": "2023-07-20T08:37:03",
"upload_time_iso_8601": "2023-07-20T08:37:03.155582Z",
"url": "https://files.pythonhosted.org/packages/f1/fd/3c2f060aa3e011f2b9044ae28c8e6dd86857ab105ae852d5040f11603a94/thor-requests-1.2.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-20 08:37:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "laalaguer",
"github_project": "thor-requests",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "thor-requests"
}
JSON
