feature: emission proposal

Author: PsicoThePato

src/torusdk/_common.py

@@ -2,23 +2,17 @@
 import re
 import warnings
 from collections import defaultdict
-from enum import Enum
 from typing import Any, Callable, Mapping, TypeVar
 
 from pydantic import SecretStr
 from pydantic_settings import BaseSettings, SettingsConfigDict
 
-from torusdk.balance import from_rems
 from torusdk.types.types import Ss58Address
 
 IPFS_REGEX = re.compile(r"^Qm[1-9A-HJ-NP-Za-km-z]{44}$")
 SS58_FORMAT = 42
 
 
-def extract_ipfs():
-    pass
-
-
 def deprecated(func: Callable[..., Any]) -> Callable[..., Any]:
     def wrapper(*args: Any, **kwargs: Any) -> Any:
         warnings.warn(
@@ -66,27 +60,6 @@ def get_available_nodes(
     return node_urls
 
 
-class BalanceUnit(str, Enum):
-    joule = "rems"
-    j = "r"
-    nano = "torus"
-    n = "t"
-
-
-def format_balance(balance: int, unit: BalanceUnit = BalanceUnit.nano) -> str:
-    """
-    Formats a balance.
-    """
-
-    match unit:
-        case BalanceUnit.nano | BalanceUnit.n:
-            return f"{balance}"
-        case BalanceUnit.joule | BalanceUnit.j:
-            in_joules = from_rems(balance)
-            round_joules = round(in_joules, 4)
-            return f"{round_joules:,}" + " \u2653"
-
-
 K = TypeVar("K")
 V = TypeVar("V")
 Z = TypeVar("Z")

src/torusdk/balance.py

@@ -1,7 +1,8 @@
+from enum import Enum
 from typing import Any, TypeVar
 
 DECIMALS = 18
-UNIT_NAME = "Toids"
+UNIT_NAME = "Rems"
 
 
 def from_rems(amount: int) -> float:
@@ -20,12 +21,25 @@ def to_rems(amount: float) -> int:
     return int(amount * (10**DECIMALS))
 
 
-class Rem(int):
-    def __new__(cls, value: int):
-        return super().__new__(cls, value)
+class BalanceUnit(str, Enum):
+    joule = "rems"
+    j = "r"
+    nano = "torus"
+    n = "t"
 
-    def __mul__(self, other: int):
-        return Rem(super().__mul__(other))
+
+def format_balance(balance: int, unit: BalanceUnit = BalanceUnit.nano) -> str:
+    """
+    Formats a balance.
+    """
+
+    match unit:
+        case BalanceUnit.nano | BalanceUnit.n:
+            return f"{balance}"
+        case BalanceUnit.joule | BalanceUnit.j:
+            in_joules = from_rems(balance)
+            round_joules = round(in_joules, 4)
+            return f"{round_joules:,}" + " \u2653"
 
 
 def from_horus(amount: int, subnet_tempo: int = 100) -> float:
@@ -46,9 +60,6 @@ def repr_j(amount: int):
     return f"{from_rems(amount)} {UNIT_NAME}"
 
 
-breakpoint()
-
-
 T = TypeVar("T", str, int)
 
 

src/torusdk/cli/_common.py

@@ -1,3 +1,4 @@
+import re
 from dataclasses import dataclass
 from getpass import getpass
 from typing import Any, Callable, Mapping, TypeVar, cast
@@ -12,8 +13,8 @@
 from torustrateinterface import Keypair
 from typer import Context
 
-from torusdk._common import TorusSettings, get_node_url
-from torusdk.balance import dict_from_nano, from_rems
+from torusdk._common import IPFS_REGEX, TorusSettings, get_node_url
+from torusdk.balance import dict_from_nano, from_rems, to_rems
 from torusdk.client import TorusClient
 from torusdk.errors import InvalidPasswordError, PasswordNotProvidedError
 from torusdk.key import load_keypair, resolve_key_ss58
@@ -52,6 +53,19 @@ def merge_models(model_a: T, model_b: BaseModel) -> T:
     return model_a.__class__(**merged_dict)
 
 
+def extract_cid(value: str):
+    cid_hash = re.match(IPFS_REGEX, value)
+    if not cid_hash:
+        raise typer.BadParameter(f"CID provided is invalid: {value}")
+    return cid_hash.group()
+
+
+def input_to_rems(value: float | None):
+    if value is None:
+        return None
+    return to_rems(value)
+
+
 @dataclass
 class ExtraCtxData:
     output_json: bool

src/torusdk/cli/balance.py

@@ -3,8 +3,7 @@
 import typer
 from typer import Context
 
-from torusdk._common import BalanceUnit, format_balance
-from torusdk.balance import to_rems
+from torusdk.balance import BalanceUnit, format_balance, to_rems
 from torusdk.cli._common import (
     NOT_IMPLEMENTED_MESSAGE,
     make_custom_context,

src/torusdk/cli/key.py

@@ -8,7 +8,8 @@
 from typeguard import check_type
 from typer import Context
 
-from torusdk._common import SS58_FORMAT, BalanceUnit, format_balance
+from torusdk._common import SS58_FORMAT
+from torusdk.balance import BalanceUnit, format_balance
 from torusdk.cli._common import (
     make_custom_context,
     print_table_from_plain_dict,

src/torusdk/cli/misc.py

@@ -3,8 +3,7 @@
 import typer
 from typer import Context
 
-from torusdk._common import BalanceUnit, format_balance
-from torusdk.balance import from_rems
+from torusdk.balance import BalanceUnit, format_balance, from_rems
 from torusdk.cli._common import (
     HIDE_FEATURES,
     make_custom_context,

src/torusdk/cli/proposal.py

@@ -1,5 +1,5 @@
 import re
-from typing import Optional, Union
+from typing import Optional
 
 import typer
 from rich.progress import track
@@ -9,21 +9,29 @@
 from torusdk.balance import to_rems
 from torusdk.cli._common import (
     CustomCtx,
+    extract_cid,
+    input_to_rems,
     make_custom_context,
+    merge_models,
     render_pydantic_table,
 )
 from torusdk.client import TorusClient
 from torusdk.key import local_key_adresses
-from torusdk.misc import local_keys_to_stakedbalance, get_global_params
-from torusdk.types.types import OptionalNetworkParams
+from torusdk.misc import (
+    get_emission_params,
+    get_global_params,
+    local_keys_to_stakedbalance,
+)
 from torusdk.types.proposal import (
-    Proposal,
+    Emission,
     GlobalCustom,
     GlobalParams,
-    Emission,
+    OptionalEmission,
+    Proposal,
+    TransferDaoTreasury,
 )
+from torusdk.types.types import OptionalNetworkParams
 from torusdk.util import convert_cid_on_proposal
-from torusdk.cli._common import merge_models
 
 proposal_app = typer.Typer(no_args_is_help=True)
 
@@ -135,33 +143,31 @@ def list_proposals(ctx: Context, query_cid: bool = typer.Option(True)):
     emission_p = [
         *filter(lambda x: isinstance(x.data, Emission), parsed_proposals)
     ]
-
+    transfer_p = [
+        *filter(
+            lambda x: isinstance(x.data, TransferDaoTreasury), parsed_proposals
+        )
+    ]
     render_pydantic_table(
         custom_p, context.console, "Custom Proposals", ["data"]
     )
     render_pydantic_table(
         global_params_p, context.console, "Global Params Proposals"
     )
     render_pydantic_table(emission_p, context.console, "Emission Proposals")
+    render_pydantic_table(transfer_p, context.console, "Transfer Proposals")
 
 
 @proposal_app.command()
 def transfer_dao_funds(
     ctx: Context,
     signer_key: str,
     amount: float,
-    cid_hash: str,
     dest: str,
+    cid: str = typer.Argument(..., callback=extract_cid),
 ):
     context = make_custom_context(ctx)
 
-    if not re.match(IPFS_REGEX, cid_hash):
-        context.error(f"CID provided is invalid: {cid_hash}")
-        raise typer.Exit(code=1)
-
-    ipfs_prefix = "ipfs://"
-    cid = ipfs_prefix + cid_hash
-
     nano_amount = to_rems(amount)
     keypair = context.load_key(signer_key, None)
     dest = context.resolve_ss58(dest)
@@ -174,16 +180,20 @@ def transfer_dao_funds(
 def propose_globally(
     ctx: Context,
     key: str,
-    cid: str,
+    cid_hash: str = typer.Argument(..., callback=extract_cid),
     max_name_length: Optional[int] = None,
     min_name_length: Optional[int] = None,
     max_allowed_agents: Optional[int] = None,
     max_allowed_weights: Optional[int] = None,
     min_weight_stake: Optional[int] = None,
     min_weight_control_fee: Optional[int] = None,
-    min_staking_fee: Optional[int] = None,
+    min_staking_fee: Optional[float] = typer.Argument(
+        ..., callback=input_to_rems
+    ),
     dividends_participation_weight: Optional[int] = None,
-    proposal_cost: Optional[int] = None,
+    proposal_cost: Optional[float] = typer.Argument(
+        ..., callback=input_to_rems
+    ),
 ):
     local_variables = locals()
     proposal_args = OptionalNetworkParams.model_validate(local_variables)
@@ -194,18 +204,23 @@ def propose_globally(
     proposal = merge_models(global_params, proposal_args)
 
     kp = context.load_key(key)
-    cid_hash = re.match(IPFS_REGEX, cid)
-    if not cid_hash:
-        context.error(f"CID provided is invalid: {cid}")
-        raise typer.Exit(code=1)
-    client.add_global_proposal(kp, proposal, cid)
+    client.add_global_proposal(kp, proposal, cid_hash)
 
 
 @proposal_app.command()
 def propose_emission(
     ctx: Context,
     key: str,
-    recycling_percentage: Optional[int],
-    treasury_percentage: Optional[int],
+    cid: str = typer.Argument(..., callback=extract_cid),
+    recycling_percentage: Optional[int] = typer.Option(None),
+    treasury_percentage: Optional[int] = typer.Option(None),
 ):
-    pass
+    local_variables = locals()
+    proposal_args = OptionalEmission.model_validate(local_variables)
+
+    context = make_custom_context(ctx)
+    client = context.com_client()
+    emission_params = get_emission_params(client)
+    proposal = merge_models(emission_params, proposal_args)
+    kp = context.load_key(key)
+    client.add_emission_proposal(kp, proposal, cid)

src/torusdk/client.py

@@ -15,6 +15,7 @@
 
 from torusdk._common import transform_stake_dmap
 from torusdk.errors import ChainTransactionError, NetworkQueryError
+from torusdk.types.proposal import Emission
 from torusdk.types.types import (
     Agent,
     AgentApplication,
@@ -1714,6 +1715,43 @@ def add_global_proposal(
 
         return response
 
+    def add_emission_proposal(
+        self,
+        key: Keypair,
+        params: Emission,
+        cid: str,
+    ):
+        """
+        Submits a proposal for altering the emission parameters of the network.
+
+        Allows for the submission of a proposal to change the emission
+        parameters of the network, such as the block reward, emission curve,
+        and other emission-related settings.
+
+        Args:
+            key: The keypair used for signing the proposal transaction.
+            params: A dictionary containing emission parameters like the block
+                reward, emission curve, and other emission-related settings.
+
+        Returns:
+            A receipt of the emission proposal transaction.
+
+        Raises:
+            InvalidParameterError: If the provided emission parameters are invalid.
+            ChainTransactionError: If the transaction fails.
+        """
+
+        raw_emission = params.model_dump()
+        emission_params = {"data": cid, **raw_emission}
+        response = self.compose_call(
+            fn="add_emission_proposal",
+            params=emission_params,
+            key=key,
+            module="Governance",
+        )
+
+        return response
+
     def vote_on_proposal(
         self,
         key: Keypair,