bittensor.extrinsics.transfer#

Module Contents#

Functions#

transfer_extrinsic(subtensor, wallet, dest, amount[, ...])

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 :param wallet: Bittensor wallet object to make transfer from. :type wallet: bittensor.wallet :param dest: Destination public key address of reciever. :type dest: str, ss58_address or ed25519 :param amount: Amount to stake as bittensor balance, or float interpreted as Tao. :type amount: Union[Balance, int] :param wait_for_inclusion: If set, waits for the extrinsic to enter a block before returning true,

or returns false if the extrinsic fails to enter the block within the timeout.

Parameters:
  • wait_for_finalization (bool) – If set, waits for the extrinsic to be finalized on the chain before returning true, or returns false 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) –

  • wallet (bittensor.wallet) –

  • dest (str) –

  • amount (Union[bittensor.utils.balance.Balance, float]) –

  • wait_for_inclusion (bool) –

Returns:

Flag is true if extrinsic was finalized or uncluded in the block. If we did not wait for finalization / inclusion, the response is true.

Return type:

success (bool)