feat: end implementing service metadata, rework storage provider

Author: Arondondon

snet/sdk/__init__.py

@@ -33,7 +33,7 @@
 )
 from snet.sdk.service_client import ServiceClient
 from snet.sdk.registry.storage_provider import StorageProvider
-from snet.sdk.custom_typing import ModuleName, ServiceStub
+from snet.sdk.types import ModuleName, ServiceStub
 from snet.sdk.utils.utils import (
     find_file_by_keyword,
     get_we3_object,

snet/sdk/custom_typing.py

@@ -0,0 +1,92 @@
+from dataclasses import dataclass
+from enum import Enum
+from typing import Union
+
+from snet.sdk.utils.utils import bytes32_to_str
+
+
+@dataclass
+class RawOrgData:
+    org_id: bytes
+    metadata_uri: bytes
+    owner: str
+    members: list[str]
+    services: list[bytes]  # IDs
+
+
+@dataclass
+class RawServiceData:
+    service_id: bytes
+    metadata_uri: bytes
+
+
+class StorageType(Enum):
+    IPFS = "ipfs"
+    FILECOIN = "filecoin"
+
+
+@dataclass
+class FileURI:
+    storage_type: StorageType
+    uri_hash: str
+
+    @classmethod
+    def from_raw_uri(cls, string_uri: Union[str, bytes]) -> "FileURI":
+        if not string_uri:
+            raise ValueError("'string_uri' cannot be empty!")
+
+        if isinstance(string_uri, bytes):
+            string_uri = string_uri.rstrip(b"\0").decode("ascii")
+
+        try:
+            s_t_str, u_h = string_uri.split("://")
+        except ValueError:
+            s_t_str = "ipfs"
+            u_h = string_uri
+
+        s_t = StorageType(s_t_str)
+
+        return cls(s_t, u_h)
+
+    def __str__(self) -> str:
+        return f"{self.storage_type.value}://{self.uri_hash}"
+
+    @classmethod
+    def normalize_string_uri(cls, string_uri: str) -> str:
+        return str(FileURI.from_raw_uri(string_uri))
+
+
+@dataclass
+class OrgData:
+    org_id: str
+    metadata_uri: FileURI
+    owner: str
+    members: list[str]
+    services: list[str]  # IDs
+
+    @classmethod
+    def from_raw_data(cls, raw_org_data: RawOrgData) -> "OrgData":
+        return cls(
+            org_id=bytes32_to_str(raw_org_data.org_id),
+            metadata_uri=FileURI.from_raw_uri(raw_org_data.metadata_uri),
+            owner=raw_org_data.owner,
+            members=raw_org_data.members,
+            services=list(map(bytes32_to_str, raw_org_data.services)),
+        )
+
+
+@dataclass
+class ServiceData:
+    org_id: str
+    service_id: str
+    metadata_uri: FileURI
+
+    @classmethod
+    def from_raw_data(
+        cls, raw_service_data: RawServiceData, org_id: Union[str, bytes]
+    ) -> "ServiceData":
+        return cls(
+            org_id=bytes32_to_str(org_id) if isinstance(org_id, bytes) else org_id,
+            service_id=bytes32_to_str(raw_service_data.service_id),
+            metadata_uri=FileURI.from_raw_uri(raw_service_data.metadata_uri),
+        )

snet/sdk/registry/models.py

@@ -4,13 +4,11 @@
 
 from snet.sdk.account import Account
 from snet.sdk.config import config
-from snet.sdk.types import RawOrgData, OrgData, ServiceData, RawServiceData
+from snet.sdk.registry.models import RawOrgData, OrgData, ServiceData, RawServiceData
 from snet.sdk.utils.utils import (
     type_converter,
     bytes32_to_str,
     get_we3_object,
-    convert_raw_service_data,
-    convert_raw_org_data,
 )
 
 
@@ -29,7 +27,7 @@ def get_org(self, org_id: str) -> OrgData:
             # TODO: configure exceptions
             raise Exception()
 
-        return convert_raw_org_data(
+        return OrgData.from_raw_data(
             RawOrgData(
                 org_id=found_org_id,
                 metadata_uri=org_metadata_uri,
@@ -49,7 +47,7 @@ def get_service(self, org_id: str, service_id: str) -> ServiceData:
             # TODO: configure exceptions
             raise Exception()
 
-        return convert_raw_service_data(
+        return ServiceData.from_raw_data(
             RawServiceData(service_id=found_service_id, metadata_uri=service_metadata_uri),
             org_id=org_id,
         )

snet/sdk/registry/registry_contract.py

@@ -47,6 +47,7 @@
 
 from pydantic import BaseModel, Field, model_validator, ValidationInfo
 
+from snet.sdk.registry.models import FileURI
 from snet.sdk.utils.utils import is_valid_endpoint
 
 
@@ -67,46 +68,76 @@ def is_single_value(asset_type):
             return True
 
 
+class FileType(Enum):
+    IMAGE = "image"
+    VIDEO = "video"
+    ARCHIVE = "archive"
+
+
+# class AssetType(Enum):
+#     HERO_IMAGE = "hero_image"
+#     PROTO_FILE = "proto_file"
+#     DEMO_COMPONENT = "demo_component"
+
+
+class ServiceType(Enum):
+    GRPC = "grpc"
+    HTTP = "http"
+    JSONRPC = "jsonrpc"
+
+
 def generate_group_id() -> str:
     return base64.b64encode(secrets.token_bytes(32)).decode()
 
 
 class Pricing(BaseModel):
     price_model: Literal["fixed_price", "method_price"] = Field(default="fixed_price")
-    price_in_cogs: int = Field(ge=1)
+    price_in_cogs: int = Field(ge=1, default=1)
     default: bool = Field(default=True)
 
 
 class Group(BaseModel):
     group_name: str = Field(min_length=1, default="default_group")
     group_id: str = Field(default_factory=generate_group_id, init=False)
-    free_calls: int = Field(ge=1)
-    free_call_signer_address: str
-    daemon_addresses: list[str]
+    free_calls: int = Field(ge=1, default=3)
+    free_call_signer_address: str = Field(default="")
+    daemon_addresses: list[str] = Field(default=[])
+    endpoints: list[str] = Field(default=[])
+    pricing: list[Pricing] = Field(default=[])
 
 
-class ServiceDescription(BaseModel): ...
+class ServiceDescription(BaseModel):
+    url: str = Field(default="")
+    short_description: str = Field(default="")
+    description: str = Field(default="")
 
 
-class Media(BaseModel): ...
+class Media(BaseModel):
+    order: int = Field(ge=1, default=1)
+    url: str = Field(min_length=1)
+    file_type: FileType
+    alt_text: str = Field(default="")
+    asset_type: AssetType
 
 
-class Contributor(BaseModel): ...
+class Contributor(BaseModel):
+    name: str = Field(min_length=1)
+    email_id: str = Field(default="")
 
 
 class ServiceMetadata(BaseModel):
     version: int = Field(ge=1, default=1)
-    display_name: str
+    display_name: str = Field(min_length=1)
     encoding: Literal["proto", "json"] = Field(default="proto")
     service_type: Literal["grpc", "http", "jsonrpc"]
-    service_api_source: Optional[str] = Field(min_length=1, default=None, init=False)
+    service_api_source: Optional[str] = Field(default=None, init=False)
     model_ipfs_hash: Optional[str] = Field(min_length=1, default=None, init=False, deprecated=True)
-    mpe_address: str
-    groups: list[Group]
-    service_description: ServiceDescription
-    media: list[Media]
-    contributors: list[Contributor]
-    tags: list[str]
+    mpe_address: Optional[str] = Field(default=None, init=False)
+    groups: list[Group] = Field(default=[])
+    service_description: Optional[ServiceDescription] = Field(default=None)
+    media: list[Media] = Field(default=[])
+    contributors: list[Contributor] = Field(default=[])
+    tags: list[str] = Field(default=[])
 
     @model_validator(mode="before")
     @classmethod
@@ -117,7 +148,6 @@ def restrict_deprecated_fields(cls, data: Any, info: ValidationInfo) -> Any:
         is_fetching = info.context and info.context.get("from_storage") is True
 
         if not is_fetching and data.get("model_ipfs_hash"):
-            # TODO: configure exceptions
             raise ValueError(
                 "The 'model_ipfs_hash' field is deprecated and cannot be used "
                 "to create new metadata. Please use 'service_api_source' instead."
@@ -128,10 +158,22 @@ def restrict_deprecated_fields(cls, data: Any, info: ValidationInfo) -> Any:
     def generate_final_json(self):
         if self.service_api_source is None:
             if self.model_ipfs_hash is None:
-                # TODO: configure exceptions
                 raise ValueError("The 'service_api_source' field is missing!")
             else:
-                self.service_api_source, self.model_ipfs_hash = self.model_ipfs_hash, None
+                self.service_api_source = FileURI.normalize_string_uri(self.model_ipfs_hash)
+                self.model_ipfs_hash = None
+
+        if not self.mpe_address:
+            raise ValueError("The 'mpe_address' field is missing!")
+
+        if len(self.groups) == 0:
+            raise ValueError("There must be one item in 'groups' field at least!")
+
+        if len(self.contributors) == 0:
+            raise ValueError("There must be one item in 'contributors' field at least!")
+
+        if not self.service_description:
+            raise ValueError("The 'mpe_address' field is missing!")
 
         return self.model_dump_json(indent=2, exclude_none=True)