bittensor.core.extrinsics.transfer

bittensor.core.extrinsics.transfer#

Functions#

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

Transfers funds from this wallet to the destination public key address.

Module Contents#

bittensor.core.extrinsics.transfer.transfer_extrinsic(subtensor, wallet, destination_ss58, amount, keep_alive=True, transfer_all=False, period=None, raise_error=False, wait_for_inclusion=True, wait_for_finalization=True)[source]#

Transfers funds from this wallet to the destination public key address.

Parameters:

  • subtensor (bittensor.core.subtensor.Subtensor) – the Subtensor object used for transfer

  • wallet (bittensor_wallet.Wallet) – The wallet to sign the extrinsic.

  • destination_ss58 (str) – Destination public key address (ss58_address or ed25519) of recipient.

  • amount (Optional[bittensor.utils.balance.Balance]) – Amount to stake as Bittensor balance. None if transferring all.

  • transfer_all (bool) – Whether to transfer all funds from this wallet to the destination address.

  • keep_alive (bool) – If set, keeps the account alive by keeping the balance above the existential deposit.

  • period (Optional[int]) – The number of blocks during which the transaction will remain valid after it’s submitted. If the transaction is not included in a block within that number of blocks, it will expire and be rejected. You can think of it as an expiration date for the transaction.

  • raise_error (bool) – Raises a relevant exception rather than returning False if unsuccessful.

  • wait_for_inclusion (bool) – Whether to wait for the inclusion of the transaction.

  • wait_for_finalization (bool) – Whether to wait for the finalization of the transaction.

Returns:

True if the subnet registration was successful, False otherwise.

Return type:

bool