bittensor.core.extrinsics.root#

Functions#

`claim_root_extrinsic`(subtensor, wallet, netuids[, ...])	Claims the root emissions for a coldkey.
`root_register_extrinsic`(subtensor, wallet[, period, ...])	Registers the neuron to the root network.
`set_root_claim_type_extrinsic`(subtensor, wallet, ...)	Sets the root claim type for the coldkey in provided wallet.

Module Contents#

bittensor.core.extrinsics.root.claim_root_extrinsic(subtensor, wallet, netuids, period=None, raise_error=False, wait_for_inclusion=True, wait_for_finalization=True)#

Claims the root emissions for a coldkey.

Parameters:

subtensor (bittensor.core.subtensor.Subtensor) – Subtensor instance to interact with the blockchain.
wallet (bittensor_wallet.Wallet) – Bittensor Wallet instance.
netuids (bittensor.core.types.UIDs) – The netuids to claim root emissions for.
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:

The result object of the extrinsic execution.

Return type:

ExtrinsicResponse

bittensor.core.extrinsics.root.root_register_extrinsic(subtensor, wallet, period=None, raise_error=False, wait_for_inclusion=True, wait_for_finalization=True)[source]#

Registers the neuron to the root network.

Parameters:

subtensor (bittensor.core.subtensor.Subtensor) – Subtensor instance to interact with the blockchain.
wallet (bittensor_wallet.Wallet) – Bittensor Wallet instance.
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:

The result object of the extrinsic execution.

Return type:

ExtrinsicResponse

bittensor.core.extrinsics.root.set_root_claim_type_extrinsic(subtensor, wallet, new_root_claim_type, period=None, raise_error=False, wait_for_inclusion=True, wait_for_finalization=True)#

Sets the root claim type for the coldkey in provided wallet.

Parameters:

subtensor (bittensor.core.subtensor.Subtensor) – Subtensor instance to interact with the blockchain.
wallet (bittensor_wallet.Wallet) – Bittensor Wallet instance.
new_root_claim_type (Literal['Swap', 'Keep']) – The new root claim type to set. Could be either “Swap” or “Keep”.
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:

The result object of the extrinsic execution.

Return type:

ExtrinsicResponse