Remote Procedure Call (RPC)¶
Bitcoin remote procedure call.
-
shuttle.providers.bitcoin.rpc.
decoded_transaction_raw
(transaction_raw, network='testnet', timeout=60)¶ Get decoded transaction raw.
- Parameters
transaction_raw (str) – bitcoin transaction raw.
network (str) – bitcoin network, defaults to testnet.
timeout (int) – request timeout, default to 15.
- Returns
dict – bitcoin decoded transaction raw.
>>> from shuttle.providers.bitcoin.rpc import decoded_transaction_raw >>> decoded_transaction_raw(transaction_raw, "testnet") {...}
-
shuttle.providers.bitcoin.rpc.
get_balance
(address, network='testnet', timeout=60)¶ Get bitcoin balance.
- Parameters
address (str) – bitcoin address.
network (str) – bitcoin network, defaults to testnet.
timeout (int) – request timeout, default to 15.
- Returns
int – bitcoin balance.
>>> from shuttle.providers.bitcoin.rpc import get_balance >>> get_balance(bitcoin_address, "mainnet") 25800000
-
shuttle.providers.bitcoin.rpc.
get_transaction_detail
(transaction_id, network='testnet', timeout=60)¶ Get transaction detail.
- Parameters
transaction_id (str) – bitcoin transaction hash or transaction id.
network (str) – bitcoin network, defaults to testnet.
timeout (int) – request timeout, default to 15.
- Returns
dict – bitcoin transaction detail.
>>> from shuttle.providers.bitcoin.rpc import get_transaction_detail >>> get_transaction_detail(transaction_id, "testnet") {...}
-
shuttle.providers.bitcoin.rpc.
get_unspent_transactions
(address, network='testnet', include_script=True, limit=15, timeout=60)¶ Get bitcoin unspent transaction output (UTXO).
- Parameters
address (str) – bitcoin address.
network (str) – bitcoin network, defaults to testnet.
include_script (bool) – bitcoin include script, defaults to True.
limit (int) – bitcoin utxo’s limit, defaults to 15.
timeout (int) – request timeout, default to 15.
- Returns
list – bitcoin utxo’s.
>>> from shuttle.providers.bitcoin.rpc import get_unspent_transactions >>> get_unspent_transactions(bitcoin_address, "testnet") [...]
-
shuttle.providers.bitcoin.rpc.
submit_payment
(tx_raw, network='testnet', timeout=60)¶ Submit transaction raw to Bitcoin blockchain.
- Parameters
tx_raw (str) – bitcoin transaction raw.
network (str) – bitcoin network, defaults to testnet.
timeout (int) – request timeout, default to 15.
- Returns
dict – bitcoin decoded transaction raw.
>>> from shuttle.providers.bitcoin.rpc import submit_payment >>> submit_payment(transaction_raw, "testnet") {...}