feature: release

Author: PsicoThePato

src/torusdk/_common.py

@@ -9,7 +9,10 @@
 
 from torusdk.types.types import Ss58Address
 
-IPFS_REGEX = re.compile(r"^Qm[1-9A-HJ-NP-Za-km-z]{44}$")
+IPFS_REGEX = re.compile(r"^Qm[1-9A-HJ-NP-Za-km-z]{44}$|bafk[1-7a-z]{52}$/i")
+CID_REGEX = re.compile(
+    r"^(?:ipfs://)?(?P<cid>Qm[1-9A-HJ-NP-Za-km-z]{44,}|b[A-Za-z2-7]{58,}|B[A-Z2-7]{58,}|z[1-9A-HJ-NP-Za-km-z]{48,}|F[0-9A-F]{50,})(?:/[\d\w.]+)*$"
+)
 SS58_FORMAT = 42
 
 

src/torusdk/cli/_common.py

@@ -13,7 +13,7 @@
 from torustrateinterface import Keypair
 from typer import Context
 
-from torusdk._common import IPFS_REGEX, TorusSettings, get_node_url
+from torusdk._common import CID_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
@@ -54,10 +54,10 @@ def merge_models(model_a: T, model_b: BaseModel) -> T:
 
 
 def extract_cid(value: str):
-    cid_hash = re.match(IPFS_REGEX, value)
+    cid_hash = re.match(CID_REGEX, value)
     if not cid_hash:
         raise typer.BadParameter(f"CID provided is invalid: {value}")
-    return cid_hash.group()
+    return cid_hash.group("cid")
 
 
 def input_to_rems(value: float | None):
@@ -277,23 +277,86 @@ def print_table_from_plain_dict(
     console.print(table)
 
 
+def render_pydantic_subtable(value: BaseModel | dict[Any, Any]) -> Table:
+    """
+    Renders a subtable for a nested Pydantic object or dictionary.
+
+    Args:
+        value: A nested Pydantic object or dictionary.
+
+    Returns:
+        A rich Table object representing the subtable.
+    """
+    subtable = Table(
+        show_header=False,
+        padding=(0, 0, 0, 0),
+        border_style="bright_black",
+    )
+    if isinstance(value, BaseModel):
+        for subfield_name, _ in value.model_fields.items():
+            subfield_value = getattr(value, subfield_name)
+            subtable.add_row(f"{subfield_name}: {subfield_value}")
+    else:
+        for subfield_name, subfield_value in value.items():  # type: ignore
+            subtable.add_row(f"{subfield_name}: {subfield_value}")
+    return subtable
+
+
+def render_single_pydantic_object(
+    obj: BaseModel, console: Console, title: str = ""
+) -> None:
+    """
+    Renders a rich table from a single Pydantic object.
+
+    Args:
+        obj: A single Pydantic object.
+        console: The rich Console object.
+        title: Optional title for the table.
+    """
+    table = Table(
+        title=title,
+        show_header=True,
+        header_style="bold magenta",
+        title_style="bold magenta",
+    )
+
+    table.add_column("Field", style="white", vertical="middle")
+    table.add_column("Value", style="white", vertical="middle")
+
+    for field_name, _ in obj.model_fields.items():
+        value = getattr(obj, field_name)
+        if isinstance(value, BaseModel):
+            subtable = render_pydantic_subtable(value)
+            table.add_row(field_name, subtable)
+        else:
+            table.add_row(field_name, str(value))
+
+    console.print(table)
+    console.print("\n")
+
+
 def render_pydantic_table(
-    objects: list[T],
+    objects: T | list[T],
     console: Console,
     title: str = "",
     ignored_columns: list[str] = [],
 ) -> None:
     """
-    Renders a rich table from a list of Pydantic objects.
+    Renders a rich table from a list of Pydantic objects or a single Pydantic object.
 
     Args:
-        objects: A list of Pydantic objects.
+        objects: A list of Pydantic objects or a single Pydantic object.
         console: The rich Console object.
         title: Optional title for the table.
+        ignored_columns: List of column names to ignore.
     """
     if not objects:
         return
 
+    if isinstance(objects, BaseModel):
+        render_single_pydantic_object(objects, console, title)
+        return
+
     table = Table(
         title=title,
         show_header=True,
@@ -313,14 +376,7 @@ def render_pydantic_table(
                 continue
             value = getattr(obj, field_name)
             if isinstance(value, BaseModel):
-                subtable = Table(
-                    show_header=False,
-                    padding=(0, 0, 0, 0),
-                    border_style="bright_black",
-                )
-                for subfield_name, _ in value.model_fields.items():
-                    subfield_value = getattr(value, subfield_name)
-                    subtable.add_row(f"{subfield_name}: {subfield_value}")
+                subtable = render_pydantic_subtable(value)
                 row_data.append(subtable)
             else:
                 row_data.append(str(value))

src/torusdk/cli/agent.py

@@ -1,19 +1,23 @@
 from typing import Any, Optional, cast
 
 import typer
+from pydantic import ValidationError
 from typer import Context
 
 from torusdk._common import intersection_update
 from torusdk.balance import from_rems
 from torusdk.cli._common import (
     HIDE_FEATURES,
+    extract_cid,
     make_custom_context,
     print_module_info,
     print_table_from_plain_dict,
     render_pydantic_table,
 )
 from torusdk.errors import ChainTransactionError
 from torusdk.misc import get_governance_config, get_map_modules
+from torusdk.types.types import AgentMetadata
+from torusdk.util import get_json_from_cid
 
 agent_app = typer.Typer(no_args_is_help=True)
 
@@ -26,19 +30,29 @@ def register(
     name: str,
     key: str,
     url: str,
-    metadata: str,
+    metadata: str = typer.Argument(..., callback=extract_cid),
 ):
     """
     Registers an agent.
     """
     context = make_custom_context(ctx)
     client = context.com_client()
-
-    if metadata and len(metadata) > 59:
-        raise ValueError("Metadata must be less than 60 characters")
-
+    data = get_json_from_cid(metadata)
+    try:
+        _ = AgentMetadata.model_validate(data)
+    except ValidationError:
+        context.error(
+            "Your ipfs file is invalid. "
+            "You can find the schema definition "
+            "at https://docs.torus.network/agents/register-a-agent"
+        )
+        exit(1)
     resolved_key = context.load_key(key, None)
-
+    burn = client.get_burn()
+    if not context.confirm(
+        f"{from_rems(burn)} tokens will be burned. Do you want to continue?"
+    ):
+        raise typer.Abort()
     with context.progress_status(f"Registering Agent {name}..."):
         response = client.register_agent(
             resolved_key,
@@ -60,7 +74,6 @@ def list_applications(ctx: Context):
     """
     context = make_custom_context(ctx)
     client = context.com_client()
-
     with context.progress_status("Getting applications..."):
         applications = client.query_map_applications()
     if len(applications) == 0:
@@ -140,9 +153,20 @@ def update(
     context = make_custom_context(ctx)
     client = context.com_client()
 
-    if metadata and len(metadata) > 59:
-        raise ValueError("Metadata must be less than 60 characters")
-
+    # if metadata and len(metadata) > 59:
+    #     raise ValueError("Metadata must be less than 60 characters")
+    # TODO: create a validator for agent metadata
+    if metadata:
+        data = get_json_from_cid(metadata)
+        try:
+            _ = AgentMetadata.model_validate(data)
+        except ValidationError:
+            context.error(
+                "Your ipfs file is invalid. "
+                "You can find the schema definition "
+                "at https://docs.torus.network/agents/register-a-agent"
+            )
+            exit(1)
     resolved_key = context.load_key(key)
 
     agents = get_map_modules(client, include_balances=False)

src/torusdk/cli/network.py

@@ -1,11 +1,9 @@
 import typer
 from typer import Context
 
-import torusdk.balance as c_balance
 from torusdk.cli._common import (
     make_custom_context,
-    print_table_from_plain_dict,
-    tranform_network_params,
+    render_pydantic_table,
 )
 from torusdk.misc import (
     get_global_params,
@@ -42,27 +40,4 @@ def params(ctx: Context):
 
     with context.progress_status("Getting global network params ..."):
         global_params = get_global_params(client)
-    global_params = global_params.model_dump()
-    printable_params = tranform_network_params(global_params)
-    print_table_from_plain_dict(
-        printable_params, ["Global params", "Value"], context.console
-    )
-
-
-@network_app.command()
-def registration_burn(
-    ctx: Context,
-    netuid: int,
-):
-    """
-    Appraises the cost of registering a agent on the torus network.
-    """
-
-    context = make_custom_context(ctx)
-    client = context.com_client()
-
-    burn = client.get_burn()
-    registration_cost = c_balance.from_rems(burn)
-    context.info(
-        f"The cost to register on a netuid: {netuid} is: {registration_cost} $TORUS"
-    )
+    render_pydantic_table(global_params, context.console)

src/torusdk/cli/proposal.py

@@ -5,7 +5,7 @@
 from rich.progress import track
 from typer import Context
 
-from torusdk._common import IPFS_REGEX
+from torusdk._common import CID_REGEX
 from torusdk.balance import to_rems
 from torusdk.cli._common import (
     CustomCtx,
@@ -103,7 +103,7 @@ def add_custom_proposal(ctx: Context, key: str, cid: str):
     Adds a custom proposal.
     """
     context = make_custom_context(ctx)
-    if not re.match(IPFS_REGEX, cid):
+    if not re.match(CID_REGEX, cid):
         context.error(f"CID provided is invalid: {cid}")
         exit(1)
     else:
@@ -221,6 +221,7 @@ def propose_emission(
     cid: str = typer.Argument(..., callback=extract_cid),
     recycling_percentage: Optional[int] = typer.Option(None),
     treasury_percentage: Optional[int] = typer.Option(None),
+    incentives_ratio: Optional[int] = typer.Option(None),
 ):
     local_variables = locals()
     proposal_args = OptionalEmission.model_validate(local_variables)
@@ -231,3 +232,4 @@ def propose_emission(
     proposal = merge_models(emission_params, proposal_args)
     kp = context.load_key(key)
     client.add_emission_proposal(kp, proposal, cid)
+    context.info("Proposal added.")

src/torusdk/client.py

@@ -1181,7 +1181,7 @@ def update_agent(
 
         params = {
             "name": name,
-            "address": url,
+            "url": url,
             "metadata": metadata,
             "staking_fee": staking_fee,
             "weight_control_fee": weight_control_fee,

src/torusdk/misc.py

@@ -113,6 +113,7 @@ def get_emission_params(c_client: TorusClient):
         {
             "Emission0": [
                 ("EmissionRecyclingPercentage", []),
+                ("IncentivesRatio", []),
             ],
             "Governance": [
                 ("TreasuryEmissionFee", []),
@@ -122,12 +123,24 @@ def get_emission_params(c_client: TorusClient):
     raw_emission = {
         "recycling_percentage": query_all["EmissionRecyclingPercentage"],
         "treasury_percentage": query_all["TreasuryEmissionFee"],
+        "incentives_ratio": query_all["IncentivesRatio"],
     }
     emission_params = Emission.model_validate(raw_emission)
 
     return emission_params
 
 
+def get_fees(c_client: TorusClient):
+    fees = c_client.query_batch(
+        {
+            "Torus0": [
+                ("FeeConstraints", []),
+            ],
+        }
+    )["FeeConstraints"]
+    return MinFee.model_validate(fees)
+
+
 def get_global_params(c_client: TorusClient):
     """
     Returns global parameters of the whole commune ecosystem

src/torusdk/types/proposal.py

@@ -97,6 +97,7 @@ class OptionalEmission(BaseModel):
 class Emission(BaseModel):
     recycling_percentage: int = Field(..., ge=0, le=100)
     treasury_percentage: int = Field(..., ge=0, le=100)
+    incentives_ratio: int = Field(..., ge=0, le=100)
 
 
 class GlobalCustom(BaseModel):
@@ -164,7 +165,9 @@ def extract_value(data: Any, key_to_extract: str):
     if not data.get(key_to_extract):
         raise ValueError("Data must contain a 'data' key")
     if not isinstance(data[key_to_extract], dict):
-        raise ValueError("Extracted key must contain a dictionary")
+        value = data[key_to_extract]
+        data[key_to_extract] = {key_to_extract: value}
+        return data
     if len(data.get(key_to_extract)) != 1:
         raise ValueError("Data must contain only one key")
     data[key_to_extract] = [*data[key_to_extract].values()][0]