# The MIT License (MIT)
# Copyright © 2021 Yuma Rao
# Copyright © 2023 Opentensor Foundation
# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
# documentation files (the “Software”), to deal in the Software without restriction, including without limitation
# the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
# and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
# The above copyright notice and this permission notice shall be included in all copies or substantial portions of
# the Software.
# THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
# THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
# DEALINGS IN THE SOFTWARE.
import time
from rich.prompt import Confirm
import bittensor
from bittensor.utils import format_error_message
[docs]
def register_senate_extrinsic(
subtensor: "bittensor.subtensor",
wallet: "bittensor.wallet",
wait_for_inclusion: bool = False,
wait_for_finalization: bool = True,
prompt: bool = False,
) -> bool:
r"""Registers the wallet to chain for senate voting.
Args:
wallet (bittensor.wallet):
Bittensor wallet object.
wait_for_inclusion (bool):
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.
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.
prompt (bool):
If ``true``, the call waits for confirmation from the user before proceeding.
Returns:
success (bool):
Flag is ``true`` if extrinsic was finalized or included in the block. If we did not wait for finalization / inclusion, the response is ``true``.
"""
try:
wallet.coldkey # unlock coldkey
except bittensor.KeyFileError:
bittensor.__console__.print(
":cross_mark: [red]Keyfile is corrupt, non-writable, non-readable or the password used to decrypt is invalid[/red]:[bold white]\n [/bold white]"
)
return False
wallet.hotkey # unlock hotkey
if prompt:
# Prompt user for confirmation.
if not Confirm.ask(f"Register delegate hotkey to senate?"):
return False
with bittensor.__console__.status(":satellite: Registering with senate..."):
with subtensor.substrate as substrate:
# create extrinsic call
call = substrate.compose_call(
call_module="SubtensorModule",
call_function="join_senate",
call_params={"hotkey": wallet.hotkey.ss58_address},
)
extrinsic = substrate.create_signed_extrinsic(
call=call, keypair=wallet.coldkey
)
response = substrate.submit_extrinsic(
extrinsic,
wait_for_inclusion=wait_for_inclusion,
wait_for_finalization=wait_for_finalization,
)
# We only wait here if we expect finalization.
if not wait_for_finalization and not wait_for_inclusion:
return True
# process if registration successful
response.process_events()
if not response.is_success:
bittensor.__console__.print(
f":cross_mark: [red]Failed[/red]:{format_error_message(response.error_message)}"
)
time.sleep(0.5)
# Successful registration, final check for membership
else:
is_registered = wallet.is_senate_member(subtensor)
if is_registered:
bittensor.__console__.print(
":white_heavy_check_mark: [green]Registered[/green]"
)
return True
else:
# neuron not found, try again
bittensor.__console__.print(
":cross_mark: [red]Unknown error. Senate membership not found.[/red]"
)
[docs]
def leave_senate_extrinsic(
subtensor: "bittensor.subtensor",
wallet: "bittensor.wallet",
wait_for_inclusion: bool = False,
wait_for_finalization: bool = True,
prompt: bool = False,
) -> bool:
r"""Removes the wallet from chain for senate voting.
Args:
wallet (bittensor.wallet):
Bittensor wallet object.
wait_for_inclusion (bool):
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.
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.
prompt (bool):
If ``true``, the call waits for confirmation from the user before proceeding.
Returns:
success (bool):
Flag is ``true`` if extrinsic was finalized or included in the block. If we did not wait for finalization / inclusion, the response is ``true``.
"""
try:
wallet.coldkey # unlock coldkey
except bittensor.KeyFileError:
bittensor.__console__.print(
":cross_mark: [red]Keyfile is corrupt, non-writable, non-readable or the password used to decrypt is invalid[/red]:[bold white]\n [/bold white]"
)
return False
wallet.hotkey # unlock hotkey
if prompt:
# Prompt user for confirmation.
if not Confirm.ask(f"Remove delegate hotkey from senate?"):
return False
with bittensor.__console__.status(":satellite: Leaving senate..."):
with subtensor.substrate as substrate:
# create extrinsic call
call = substrate.compose_call(
call_module="SubtensorModule",
call_function="leave_senate",
call_params={"hotkey": wallet.hotkey.ss58_address},
)
extrinsic = substrate.create_signed_extrinsic(
call=call, keypair=wallet.coldkey
)
response = substrate.submit_extrinsic(
extrinsic,
wait_for_inclusion=wait_for_inclusion,
wait_for_finalization=wait_for_finalization,
)
# We only wait here if we expect finalization.
if not wait_for_finalization and not wait_for_inclusion:
return True
# process if registration successful
response.process_events()
if not response.is_success:
bittensor.__console__.print(
f":cross_mark: [red]Failed[/red]: {format_error_message(response.error_message)}"
)
time.sleep(0.5)
# Successful registration, final check for membership
else:
is_registered = wallet.is_senate_member(subtensor)
if not is_registered:
bittensor.__console__.print(
":white_heavy_check_mark: [green]Left senate[/green]"
)
return True
else:
# neuron not found, try again
bittensor.__console__.print(
":cross_mark: [red]Unknown error. Senate membership still found.[/red]"
)
[docs]
def vote_senate_extrinsic(
subtensor: "bittensor.subtensor",
wallet: "bittensor.wallet",
proposal_hash: str,
proposal_idx: int,
vote: bool,
wait_for_inclusion: bool = False,
wait_for_finalization: bool = True,
prompt: bool = False,
) -> bool:
r"""Votes ayes or nays on proposals.
Args:
wallet (bittensor.wallet):
Bittensor wallet object.
wait_for_inclusion (bool):
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.
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.
prompt (bool):
If ``true``, the call waits for confirmation from the user before proceeding.
Returns:
success (bool):
Flag is ``true`` if extrinsic was finalized or included in the block. If we did not wait for finalization / inclusion, the response is ``true``.
"""
wallet.coldkey # unlock coldkey
wallet.hotkey # unlock hotkey
if prompt:
# Prompt user for confirmation.
if not Confirm.ask("Cast a vote of {}?".format(vote)):
return False
with bittensor.__console__.status(":satellite: Casting vote.."):
with subtensor.substrate as substrate:
# create extrinsic call
call = substrate.compose_call(
call_module="SubtensorModule",
call_function="vote",
call_params={
"hotkey": wallet.hotkey.ss58_address,
"proposal": proposal_hash,
"index": proposal_idx,
"approve": vote,
},
)
extrinsic = substrate.create_signed_extrinsic(
call=call, keypair=wallet.coldkey
)
response = substrate.submit_extrinsic(
extrinsic,
wait_for_inclusion=wait_for_inclusion,
wait_for_finalization=wait_for_finalization,
)
# We only wait here if we expect finalization.
if not wait_for_finalization and not wait_for_inclusion:
return True
# process if vote successful
response.process_events()
if not response.is_success:
bittensor.__console__.print(
f":cross_mark: [red]Failed[/red]: {format_error_message(response.error_message)}"
)
time.sleep(0.5)
# Successful vote, final check for data
else:
vote_data = subtensor.get_vote_data(proposal_hash)
has_voted = (
vote_data["ayes"].count(wallet.hotkey.ss58_address) > 0
or vote_data["nays"].count(wallet.hotkey.ss58_address) > 0
)
if has_voted:
bittensor.__console__.print(
":white_heavy_check_mark: [green]Vote cast.[/green]"
)
return True
else:
# hotkey not found in ayes/nays
bittensor.__console__.print(
":cross_mark: [red]Unknown error. Couldn't find vote.[/red]"
)
