bittensor.extrinsics.transfer
#
Module Contents#
Functions#
|
Transfers funds from this wallet to the destination public key address. |
- bittensor.extrinsics.transfer.transfer_extrinsic(subtensor, wallet, dest, amount, wait_for_inclusion=True, wait_for_finalization=False, keep_alive=True, prompt=False)#
Transfers funds from this wallet to the destination public key address.
- Parameters:
wallet (bittensor.wallet) – Bittensor wallet object to make transfer from.
dest (str, ss58_address or ed25519) – Destination public key address of reciever.
amount (Union[Balance, int]) – Amount to stake as Bittensor balance, or
float
interpreted as Tao.wait_for_inclusion (bool) – If set, waits for the extrinsic to enter a block before returning
true
, or returnsfalse
if the extrinsic fails to enter the block within the timeout.wait_for_finalization (bool) – If set, waits for the extrinsic to be finalized on the chain before returning
true
, or returnsfalse
if the extrinsic fails to be finalized within the timeout.keep_alive (bool) – If set, keeps the account alive by keeping the balance above the existential deposit.
prompt (bool) – If
true
, the call waits for confirmation from the user before proceeding.subtensor (bittensor.subtensor) –
- Returns:
Flag is
true
if extrinsic was finalized or uncluded in the block. If we did not wait for finalization / inclusion, the response istrue
.- Return type:
success (bool)