You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
379 lines
9.8 KiB
379 lines
9.8 KiB
from .request import (
|
|
rpc_request
|
|
)
|
|
|
|
|
|
_default_endpoint = 'http://localhost:9500'
|
|
_default_timeout = 30
|
|
|
|
|
|
#########################
|
|
# Transaction Pool RPCs #
|
|
#########################
|
|
def get_pending_transactions(endpoint=_default_endpoint, timeout=_default_timeout) -> list:
|
|
"""
|
|
Get list of pending transactions
|
|
|
|
Parameters
|
|
----------
|
|
endpoint: :obj:`str`, optional
|
|
Endpoint to send request to
|
|
timeout: :obj:`int`, optional
|
|
Timeout in seconds
|
|
|
|
Returns
|
|
-------
|
|
list
|
|
# TODO: Add link to reference RPC documentation
|
|
"""
|
|
return rpc_request('hmy_pendingTransactions', endpoint=endpoint, timeout=timeout)['result']
|
|
|
|
|
|
####################
|
|
# Transaction RPCs #
|
|
####################
|
|
def get_transaction_by_hash(tx_hash, endpoint=_default_endpoint, timeout=_default_timeout) -> dict:
|
|
"""
|
|
Get transaction by hash
|
|
|
|
Parameters
|
|
----------
|
|
tx_hash: str
|
|
Transaction hash to fetch
|
|
endpoint: :obj:`str`, optional
|
|
Endpoint to send request to
|
|
timeout: :obj:`int`, optional
|
|
Timeout in seconds
|
|
|
|
Returns
|
|
-------
|
|
dict
|
|
# TODO: Add link to reference RPC documentation
|
|
"""
|
|
params = [
|
|
tx_hash
|
|
]
|
|
return rpc_request('hmy_getTransactionByHash', params=params, endpoint=endpoint, timeout=timeout)['result']
|
|
|
|
|
|
def get_transaction_by_block_hash_and_index(block_hash, tx_index,
|
|
endpoint=_default_endpoint, timeout=_default_timeout
|
|
) -> dict:
|
|
"""
|
|
Get transaction based on index in list of transactions in a block by block hash
|
|
|
|
Parameters
|
|
----------
|
|
block_hash: str
|
|
Block hash for transaction
|
|
tx_index: int
|
|
Transaction index to fetch
|
|
endpoint: :obj:`str`, optional
|
|
Endpoint to send request to
|
|
timeout: :obj:`int`, optional
|
|
Timeout in seconds
|
|
|
|
Returns
|
|
-------
|
|
dict
|
|
# TODO: Add link to reference RPC documentation
|
|
"""
|
|
params = [
|
|
block_hash,
|
|
str(hex(tx_index))
|
|
]
|
|
return rpc_request('hmy_getTransactionByBlockHashAndIndex', params=params, endpoint=endpoint, timeout=timeout)['result']
|
|
|
|
|
|
def get_transaction_by_block_number_and_index(block_num, tx_index,
|
|
endpoint=_default_endpoint, timeout=_default_timeout
|
|
) -> dict:
|
|
"""
|
|
Get transaction based on index in list of transactions in a block by block number
|
|
|
|
Parameters
|
|
----------
|
|
block_num: int
|
|
Block number for transaction
|
|
tx_index: int
|
|
Transaction index to fetch
|
|
endpoint: :obj:`str`, optional
|
|
Endpoint to send request to
|
|
timeout: :obj:`int`, optional
|
|
Timeout in seconds
|
|
|
|
Returns
|
|
-------
|
|
dict
|
|
# TODO: Add link to reference RPC documentation
|
|
"""
|
|
params = [
|
|
str(hex(block_num)),
|
|
str(hex(tx_index))
|
|
]
|
|
return rpc_request('hmy_getTransactionByBlockNumberAndIndex', params=params, endpoint=endpoint, timeout=timeout)['result']
|
|
|
|
|
|
def get_transaction_receipt(tx_receipt, endpoint=_default_endpoint, timeout=_default_timeout) -> dict:
|
|
"""
|
|
Get transaction receipt
|
|
|
|
Parameters
|
|
----------
|
|
tx_receipt: str
|
|
Transaction receipt to fetch
|
|
endpoint: :obj:`str`, optional
|
|
Endpoint to send request to
|
|
timeout: :obj:`int`, optional
|
|
Timeout in seconds
|
|
|
|
Returns
|
|
-------
|
|
dict
|
|
# TODO: Add link to reference RPC documentation
|
|
"""
|
|
params = [
|
|
tx_receipt
|
|
]
|
|
return rpc_request('hmy_getTransactionReceipt', params=params, endpoint=endpoint, timeout=timeout)['result']
|
|
|
|
|
|
def get_transaction_error_sink(endpoint=_default_endpoint, timeout=_default_timeout) -> list:
|
|
"""
|
|
Get transaction error sink
|
|
|
|
Parameters
|
|
----------
|
|
endpoint: :obj:`str`, optional
|
|
Endpoint to send request to
|
|
timeout: :obj:`int`, optional
|
|
Timeout in seconds
|
|
|
|
Returns
|
|
-------
|
|
list
|
|
# TODO: Add link to reference RPC documentation
|
|
"""
|
|
return rpc_request('hmy_getCurrentTransactionErrorSink', endpoint=endpoint, timeout=timeout)['result']
|
|
|
|
|
|
def send_raw_transaction(raw_tx, endpoint=_default_endpoint, timeout=_default_timeout) -> str:
|
|
"""
|
|
Send signed transaction
|
|
|
|
Parameters
|
|
----------
|
|
raw_tx: str
|
|
Hex representation of signed transaction
|
|
endpoint: :obj:`str`, optional
|
|
Endpoint to send request to
|
|
timeout: :obj:`int`, optional
|
|
Timeout in seconds
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
Transaction hash
|
|
"""
|
|
params = [
|
|
raw_tx
|
|
]
|
|
return rpc_request('hmy_sendRawTransaction', params=params, endpoint=endpoint, timeout=timeout)['result']
|
|
|
|
|
|
###############################
|
|
# CrossShard Transaction RPCs #
|
|
###############################
|
|
def get_pending_cx_receipts(endpoint=_default_endpoint, timeout=_default_timeout) -> list:
|
|
"""
|
|
Get list of pending cross shard transactions
|
|
|
|
Parameters
|
|
----------
|
|
endpoint: :obj:`str`, optional
|
|
Endpoint to send request to
|
|
timeout: :obj:`int`, optional
|
|
Timeout in seconds
|
|
|
|
Returns
|
|
-------
|
|
list
|
|
# TODO: Add link to reference RPC documentation
|
|
"""
|
|
return rpc_request('hmy_getPendingCXReceipts', endpoint=endpoint, timeout=timeout)['result']
|
|
|
|
|
|
def get_cx_receipt_by_hash(cx_hash, endpoint = _default_endpoint, timeout = _default_timeout) -> dict:
|
|
"""
|
|
Get cross shard receipt by hash
|
|
|
|
Parameters
|
|
----------
|
|
cx_hash: str
|
|
Hash of cross shard transaction receipt
|
|
endpoint: :obj:`str`, optional
|
|
Endpoint to send request to
|
|
timeout: :obj:`int`, optional
|
|
Timeout in seconds
|
|
|
|
Returns
|
|
-------
|
|
dict
|
|
# TODO: Add link to reference RPC documentation
|
|
"""
|
|
params = [
|
|
cx_hash
|
|
]
|
|
return rpc_request('hmy_getCXReceiptByHash', params=params, endpoint=endpoint, timeout=timeout)['result']
|
|
|
|
|
|
def resend_cx_receipt(cx_receipt, endpoint=_default_endpoint, timeout=_default_timeout) -> bool:
|
|
"""
|
|
Send cross shard receipt
|
|
|
|
Parameters
|
|
----------
|
|
cx_hash: str
|
|
Hash of cross shard transaction receipt
|
|
endpoint: :obj:`str`, optional
|
|
Endpoint to send request to
|
|
timeout: :obj:`int`, optional
|
|
Timeout in seconds
|
|
|
|
Returns
|
|
-------
|
|
bool
|
|
If the receipt transactions was succesfully resent
|
|
"""
|
|
params = [
|
|
cx_receipt
|
|
]
|
|
return rpc_request('hmy_resendCx', params=params, endpoint=endpoint, timeout=timeout)['result']
|
|
|
|
|
|
############################
|
|
# Staking Transaction RPCs #
|
|
############################
|
|
def get_staking_transaction_by_hash(tx_hash, endpoint=_default_endpoint, timeout=_default_timeout) -> dict:
|
|
"""
|
|
Get staking transaction by hash
|
|
|
|
Parameters
|
|
----------
|
|
tx_hash: str
|
|
Hash of staking transaction to fetch
|
|
endpoint: :obj:`str`, optional
|
|
Endpoint to send request to
|
|
timeout: :obj:`int`, optional
|
|
Timeout in seconds
|
|
|
|
Returns
|
|
-------
|
|
dict
|
|
# TODO: Add link to reference RPC documentation
|
|
"""
|
|
params = [
|
|
tx_hash
|
|
]
|
|
return rpc_request('hmy_getStakingTransactionByHash', params=params, endpoint=endpoint, timeout=timeout)['result']
|
|
|
|
|
|
def get_staking_transaction_by_block_hash_and_index(block_hash, tx_index,
|
|
endpoint=_default_endpoint, timeout=_default_timeout
|
|
) -> dict:
|
|
"""
|
|
Get staking transaction based on index in list of staking transactions for a block by block hash
|
|
|
|
Parameters
|
|
----------
|
|
block_hash: str
|
|
Block hash for staking transaction
|
|
tx_index: int
|
|
Staking transaction index to fetch
|
|
endpoint: :obj:`str`, optional
|
|
Endpoint to send request to
|
|
timeout: :obj:`int`, optional
|
|
Timeout in seconds
|
|
|
|
Returns
|
|
-------
|
|
dict
|
|
# TODO: Add link to reference RPC documentation
|
|
"""
|
|
params = [
|
|
block_hash,
|
|
str(hex(tx_index))
|
|
]
|
|
return rpc_request('hmy_getStakingTransactionByBlockHashAndIndex', params=params, endpoint=endpoint, timeout=timeout)['result']
|
|
|
|
|
|
def get_staking_transaction_by_block_number_and_index(block_num, tx_index,
|
|
endpoint=_default_endpoint, timeout=_default_timeout
|
|
) -> dict:
|
|
"""
|
|
Get staking transaction based on index in list of staking transactions for a block by block number
|
|
|
|
Parameters
|
|
----------
|
|
block_num: int
|
|
Block number for staking transaction
|
|
tx_index: int
|
|
Staking transaction index to fetch
|
|
endpoint: :obj:`str`, optional
|
|
Endpoint to send request to
|
|
timeout: :obj:`int`, optional
|
|
Timeout in seconds
|
|
|
|
Returns
|
|
-------
|
|
dict
|
|
# TODO: Add link to reference RPC documentation
|
|
"""
|
|
params = [
|
|
str(hex(block_num)),
|
|
str(hex(tx_index))
|
|
]
|
|
return rpc_request('hmy_getStakingTransactionByBlockNumberAndIndex', params=params, endpoint=endpoint, timeout=timeout)['result']
|
|
|
|
|
|
def get_staking_transaction_error_sink(endpoint=_default_endpoint, timeout=_default_timeout) -> list:
|
|
"""
|
|
Get staking transaction error sink
|
|
|
|
Parameters
|
|
----------
|
|
endpoint: :obj:`str`, optional
|
|
Endpoint to send request to
|
|
timeout: :obj:`int`, optional
|
|
Timeout in seconds
|
|
|
|
Returns
|
|
-------
|
|
list
|
|
# TODO: Add link to reference RPC documentation
|
|
"""
|
|
return rpc_request('hmy_getCurrentStakingErrorSink', endpoint=endpoint, timeout=timeout)['result']
|
|
|
|
|
|
def send_raw_staking_transaction(raw_tx, endpoint=_default_endpoint, timeout=_default_timeout) -> str:
|
|
"""
|
|
Send signed staking transaction
|
|
|
|
Parameters
|
|
----------
|
|
raw_tx: str
|
|
Hex representation of signed staking transaction
|
|
endpoint: :obj:`str`, optional
|
|
Endpoint to send request to
|
|
timeout: :obj:`int`, optional
|
|
Timeout in seconds
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
Staking transaction hash
|
|
"""
|
|
params = [
|
|
raw_tx
|
|
]
|
|
return rpc_request('hmy_sendRawStakingTransaction', params=params, endpoint=endpoint, timeout=timeout)['result']
|
|
|