Add identity model

Author: tupui

pyproject.toml

@@ -45,6 +45,8 @@ classifiers = [
 
 dependencies = [
     "stellar-sdk",
+    "pydantic",
+    "pydantic-settings",
 ]
 
 [project.optional-dependencies]

src/soroban/__init__.py

@@ -0,0 +1 @@
+from soroban.models import *

src/soroban/models.py

@@ -0,0 +1,24 @@
+from pydantic import model_validator
+from pydantic_settings import BaseSettings, SettingsConfigDict
+from stellar_sdk import Keypair
+
+__all__ = ["Identity"]
+
+
+class Identity(BaseSettings):
+    secret_key: str | None = None
+    public_key: str | None = None
+    keypair: Keypair | None = None
+
+    model_config = SettingsConfigDict(env_file="identity.toml")
+
+    @model_validator(mode='after')
+    def load_keys(self) -> 'UserModel':
+        if self.keypair is None and self.secret_key is None:
+            raise ValueError("Either provide a secret key or a Keypair object.")
+        if self.keypair is not None:
+            self.secret_key = self.keypair.secret
+        else:
+            self.keypair = Keypair.from_secret(self.secret_key)
+        self.public_key = self.keypair.public_key
+        return self

tests/alice.toml

@@ -0,0 +1 @@
+secret_key = "SDTZV5HD6WBU2LZKVUGFCUUR3JTOJHDHEXO2TSYVITMSH6RCY433HEYB"

tests/test_models.py

@@ -0,0 +1,25 @@
+import pathlib
+
+import pytest
+import soroban
+from stellar_sdk import Keypair
+
+
+class TestIdentity:
+
+    def test_file(self):
+        alice_fname = pathlib.Path(__file__).parent
+        soroban.Identity(_env_file=alice_fname / "alice.toml")
+
+    def test_from_pk(self):
+        keypair = Keypair.random()
+        soroban.Identity(secret_key=keypair.secret)
+        soroban.Identity(keypair=keypair)
+
+    def test_raises(self):
+        with pytest.raises(ValueError, match="provide a secret key or a Keypair"):
+            soroban.Identity()
+
+        keypair = Keypair.random()
+        with pytest.raises(ValueError, match="provide a secret key or a Keypair"):
+            soroban.Identity(public_key=keypair.public_key)