request-vm-on-golem 0.1.40__py3-none-any.whl → 0.1.41__py3-none-any.whl

{request_vm_on_golem-0.1.40.dist-info → request_vm_on_golem-0.1.41.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: request-vm-on-golem
-Version: 0.1.40
+Version: 0.1.41
 Summary: VM on Golem Requestor CLI - Create and manage virtual machines on the Golem Network
 Keywords: golem,vm,cloud,decentralized,cli
 Author: Phillip Jensen
@@ -119,6 +119,64 @@ The SSH connection process:
 2. The provider's proxy system forwards your SSH connection to the VM
 3. All traffic is securely routed through the allocated port
 
+## Streaming Payments (Polygon GLM)
+
+This requestor integrates with an on‑chain StreamPayment contract to enable “pay‑as‑you‑go” rentals.
+
+Flow:
+
+1. Fetch provider info:
+   - `GET http://{provider}:7466/api/v1/provider/info` → `provider_id`, `stream_payment_address`, `glm_token_address`.
+2. Compute `ratePerSecond` from provider pricing and requested VM resources.
+3. Ensure `deposit >= ratePerSecond * 3600` (≥ 1 hour runway recommended/minimum).
+4. Create a stream (approve + `createStream(GLM, provider_id, deposit, ratePerSecond)`), capture `stream_id`.
+5. Create VM: `POST /api/v1/vms` with `stream_id` included.
+6. Top‑up over time with `topUp(stream_id, amount)` to extend stopTime and keep the VM running indefinitely.
+7. On stop/destroy: the requestor will best‑effort `withdraw` / `terminate` to settle.
+
+CLI helpers
+
+- Open a stream for a planned VM (computes rate from provider pricing):
+
+```bash
+poetry run golem vm stream open \
+  --provider-id 0xProvider \
+  --cpu 2 --memory 4 --storage 20 \
+  --hours 1
+# prints { stream_id, rate_per_second_wei, deposit_wei }
+```
+
+- Top up an existing stream:
+
+```bash
+# Add 3 hours at prior rate
+poetry run golem vm stream topup --stream-id 123 --hours 3
+
+# Or specify exact GLM amount
+poetry run golem vm stream topup --stream-id 123 --glm 25.0
+```
+
+- Create a VM and attach an existing stream:
+
+```bash
+poetry run golem vm create my-vm \
+  --provider-id 0xProvider \
+  --cpu 2 --memory 4 --storage 20 \
+  --stream-id 123
+```
+
+Environment (env prefix `GOLEM_REQUESTOR_`):
+
+- `polygon_rpc_url` — Polygon PoS RPC URL
+- `stream_payment_address` — StreamPayment address
+- `glm_token_address` — GLM ERC20 address
+- `provider_eth_address` — optional helper for development; in production always use `/provider/info`
+
+Efficiency tips:
+
+- Batch top‑ups (e.g., add several hours at once) to reduce on‑chain calls.
+- Withdrawals are typically executed by providers; requestors don’t need to withdraw.
+
 ## Installation
 
 ```bash

{request_vm_on_golem-0.1.40.dist-info → request_vm_on_golem-0.1.41.dist-info}/RECORD

@@ -1,24 +1,25 @@
 requestor/__init__.py,sha256=OqSUAh1uZBMx7GW0MoSMg967PVdmT8XdPJx3QYjwkak,116
 requestor/api/main.py,sha256=7utCzFNbh5Ol-vsBWeSwT4lXeHD7zdA-GFZuS3rHMWc,2180
 requestor/cli/__init__.py,sha256=e3E4oEGxmGj-STPtFkQwg_qIWhR0JAiAQdw3G1hXciU,37
-requestor/cli/commands.py,sha256=sCodN_skF24IkWo6x73H3SeahdE1uFlzjJ2BpMfiLrs,28991
-requestor/config.py,sha256=O39E-Wa-ewqdC9XP5nvj3zkOs52mevvFMyQGtHaqANk,4668
+requestor/cli/commands.py,sha256=b9_Vy30rf3hpoBb_9Gu9z4mPWF3_oBjUjd-5pX2bVvU,33277
+requestor/config.py,sha256=suWN2-4AL0Pphu2t-_WiTKIFG-0_cJjWwR_CIOW1c24,5320
 requestor/db/__init__.py,sha256=Gm5DfWls6uvCZZ3HGGnyRHswbUQdeA5OGN8yPwH0hc8,88
 requestor/db/sqlite.py,sha256=l5pWbx2qlHuar1N_a0B9tVnmumLJY1w5rp3yZ7jmsC0,4146
 requestor/errors.py,sha256=wVpHBuYgQx5pTe_SamugfK-k768noikY1RxvPOjQGko,665
+requestor/payments/blockchain_service.py,sha256=w9ONdKVf2E7BCEgDRiTeEqwdNTr8SqZiXHKdV5JH2ZQ,5757
 requestor/provider/__init__.py,sha256=fmW23aYUVciF8-gmBZkG-PLhn22upmcDzdPfAOLHG6g,103
-requestor/provider/client.py,sha256=OUP7CoOCCtKD6DB9eqFkOXK6A2BLFdM4DWSkoulJQxg,3213
+requestor/provider/client.py,sha256=WXCm-1bytcgsuHEZzpg7RjjDOTuaXC9cj0Mrm7e6DSw,3676
 requestor/run.py,sha256=GqOG6n34szt8Sp3SEqjRV6huWm737yCN6YnBqoiwI-U,1785
 requestor/services/__init__.py,sha256=1qSn_6RMn0KB0A7LCnY2IW6_tC3HBQsdfkFeV-h94eM,172
 requestor/services/database_service.py,sha256=GlSrzzzd7PSYQJNup00sxkB-B2PMr1__04K8k5QSWvs,2996
 requestor/services/provider_service.py,sha256=auUc5XSHWbtOzyLHFqJ4RF337rCNYThzb7TjvUaK_uo,14542
 requestor/services/ssh_service.py,sha256=tcOCtk2SlB9Uuv-P2ghR22e7BJ9kigQh5b4zSGdPFns,4280
-requestor/services/vm_service.py,sha256=LhNBf9V5-m0ssPGikEM8R2K0vwwFDPQ8KIgCM6vX0XI,6817
+requestor/services/vm_service.py,sha256=UPPj7aD0b7nCyNH6I-b35xdsqAkRUiQlpQBVGK4B7ms,8858
 requestor/ssh/__init__.py,sha256=hNgSqJ5s1_AwwxVRyFjUqh_LTBpI4Hmzq0F-f_wXN9g,119
 requestor/ssh/manager.py,sha256=3jQtbbK7CVC2yD1zCO88jGXh2fBcuv3CzWEqDLuaQVk,9758
 requestor/utils/logging.py,sha256=oFNpO8pJboYM8Wp7g3HOU4HFyBTKypVdY15lUiz1a4I,3721
 requestor/utils/spinner.py,sha256=PUHJdTD9jpUHur__01_qxXy87WFfNmjQbD_sLG-KlGo,2459
-request_vm_on_golem-0.1.40.dist-info/METADATA,sha256=eyg8EzOeDCRq_wZKZw1KgGN89HvxMhHYCfWr49SxyHc,9944
-request_vm_on_golem-0.1.40.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-request_vm_on_golem-0.1.40.dist-info/entry_points.txt,sha256=Z-skRNpJ8aZcIl_En9mEm1ygkp9FKy0bzQoL3zO52-0,44
-request_vm_on_golem-0.1.40.dist-info/RECORD,,
+request_vm_on_golem-0.1.41.dist-info/METADATA,sha256=znwTKJHh21R9DsDgeHeaKFwxZFFC95vOTj-kScsc2Tc,11924
+request_vm_on_golem-0.1.41.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+request_vm_on_golem-0.1.41.dist-info/entry_points.txt,sha256=Z-skRNpJ8aZcIl_En9mEm1ygkp9FKy0bzQoL3zO52-0,44
+request_vm_on_golem-0.1.41.dist-info/RECORD,,

requestor/cli/commands.py

@@ -173,9 +173,10 @@ async def list_providers(cpu: Optional[int], memory: Optional[int], storage: Opt
 @click.option('--cpu', type=int, required=True, help='Number of CPU cores')
 @click.option('--memory', type=int, required=True, help='Memory in GB')
 @click.option('--storage', type=int, required=True, help='Disk in GB')
+@click.option('--stream-id', type=int, default=None, help='Optional StreamPayment stream id to fund this VM')
 @click.option('--yes', is_flag=True, help='Do not prompt for confirmation')
 @async_command
-async def create_vm(name: str, provider_id: str, cpu: int, memory: int, storage: int, yes: bool):
+async def create_vm(name: str, provider_id: str, cpu: int, memory: int, storage: int, stream_id: int | None, yes: bool):
     """Create a new VM on a specific provider."""
     try:
         # Show configuration details
@@ -232,7 +233,8 @@ async def create_vm(name: str, provider_id: str, cpu: int, memory: int, storage:
                         memory=memory,
                         storage=storage,
                         provider_ip=provider_ip,
-                        ssh_key=key_pair.public_key_content
+                        ssh_key=key_pair.public_key_content,
+                        stream_id=stream_id
                     )
 
                     # Get access info from config
@@ -281,6 +283,88 @@ async def create_vm(name: str, provider_id: str, cpu: int, memory: int, storage:
         raise click.Abort()
 
 
+@vm.group(name='stream')
+def vm_stream():
+    """Streaming payments helpers"""
+    pass
+
+
+@vm_stream.command('open')
+@click.option('--provider-id', required=True, help='Provider ID to use')
+@click.option('--cpu', type=int, required=True, help='CPU cores for rate calc')
+@click.option('--memory', type=int, required=True, help='Memory (GB) for rate calc')
+@click.option('--storage', type=int, required=True, help='Storage (GB) for rate calc')
+@click.option('--hours', type=int, default=1, help='Deposit coverage in hours (default 1)')
+@async_command
+async def stream_open(provider_id: str, cpu: int, memory: int, storage: int, hours: int):
+    """Create a GLM stream for a planned VM rental."""
+    from ..payments.blockchain_service import StreamPaymentClient, StreamPaymentConfig
+    try:
+        provider_service = ProviderService()
+        async with provider_service:
+            provider = await provider_service.verify_provider(provider_id)
+            est = provider_service.compute_estimate(provider, (cpu, memory, storage))
+            if not est or est.get('glm_per_month') is None:
+                raise RequestorError('Provider does not advertise GLM pricing; cannot compute ratePerSecond')
+            glm_month = est['glm_per_month']
+            glm_per_second = float(glm_month) / (730.0 * 3600.0)
+            rate_per_second_wei = int(glm_per_second * (10**18))
+
+            provider_ip = 'localhost' if config.environment == "development" else provider.get('ip_address')
+            if not provider_ip and config.environment == "production":
+                raise RequestorError("Provider IP address not found in advertisement")
+            provider_url = config.get_provider_url(provider_ip)
+            async with ProviderClient(provider_url) as client:
+                info = await client.get_provider_info()
+                recipient = info['provider_id']
+
+            deposit_wei = rate_per_second_wei * int(hours) * 3600
+            spc = StreamPaymentConfig(
+                rpc_url=config.polygon_rpc_url,
+                contract_address=config.stream_payment_address,
+                glm_token_address=config.glm_token_address,
+                private_key=config.ethereum_private_key,
+            )
+            sp = StreamPaymentClient(spc)
+            stream_id = sp.create_stream(recipient, deposit_wei, rate_per_second_wei)
+            click.echo(json.dumps({"stream_id": stream_id, "rate_per_second_wei": rate_per_second_wei, "deposit_wei": deposit_wei}, indent=2))
+    except Exception as e:
+        logger.error(f"Failed to open stream: {e}")
+        raise click.Abort()
+
+
+@vm_stream.command('topup')
+@click.option('--stream-id', type=int, required=True)
+@click.option('--glm', type=float, required=False, help='GLM amount to add')
+@click.option('--hours', type=int, required=False, help='Hours of coverage to add at prior rate')
+@async_command
+async def stream_topup(stream_id: int, glm: float | None, hours: int | None):
+    """Top up a stream. Provide either --glm or --hours (using prior rate)."""
+    from ..payments.blockchain_service import StreamPaymentClient, StreamPaymentConfig
+    try:
+        spc = StreamPaymentConfig(
+            rpc_url=config.polygon_rpc_url,
+            contract_address=config.stream_payment_address,
+            glm_token_address=config.glm_token_address,
+            private_key=config.ethereum_private_key,
+        )
+        sp = StreamPaymentClient(spc)
+        add_wei: int
+        if glm is not None:
+            add_wei = int(float(glm) * (10**18))
+        elif hours is not None:
+            # naive: use last known rate by reading on-chain stream
+            rate = sp.contract.functions.streams(int(stream_id)).call()[5]  # ratePerSecond
+            add_wei = int(rate) * int(hours) * 3600
+        else:
+            raise RequestorError('Provide either --glm or --hours')
+        tx = sp.top_up(stream_id, add_wei)
+        click.echo(json.dumps({"stream_id": stream_id, "topped_up_wei": add_wei, "tx": tx}, indent=2))
+    except Exception as e:
+        logger.error(f"Failed to top up stream: {e}")
+        raise click.Abort()
+
+
 @vm.command(name='ssh')
 @click.argument('name')
 @async_command

requestor/config.py

@@ -94,6 +94,24 @@ class RequestorConfig(BaseSettings):
         description="Private key for Golem Base"
     )
     
+    # Polygon / Payments
+    polygon_rpc_url: str = Field(
+        default="https://polygon-rpc.com",
+        description="Polygon PoS RPC URL for GLM payments"
+    )
+    stream_payment_address: str = Field(
+        default="0x0000000000000000000000000000000000000000",
+        description="Deployed StreamPayment contract address"
+    )
+    glm_token_address: str = Field(
+        default="0x0000000000000000000000000000000000000000",
+        description="GLM ERC20 token address on target network"
+    )
+    provider_eth_address: str = Field(
+        default="",
+        description="Optional provider Ethereum address for test/dev streaming"
+    )
+
     # Base Directory
     base_dir: Path = Field(
         default_factory=lambda: Path.home() / ".golem" / "requestor",

requestor/payments/blockchain_service.py

@@ -0,0 +1,148 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import Optional, Any, Dict
+
+from web3 import Web3
+from eth_account import Account
+
+
+STREAM_PAYMENT_ABI = [
+    {
+        "inputs": [
+            {"internalType": "address", "name": "token", "type": "address"},
+            {"internalType": "address", "name": "recipient", "type": "address"},
+            {"internalType": "uint256", "name": "deposit", "type": "uint256"},
+            {"internalType": "uint128", "name": "ratePerSecond", "type": "uint128"},
+        ],
+        "name": "createStream",
+        "outputs": [{"internalType": "uint256", "name": "streamId", "type": "uint256"}],
+        "stateMutability": "nonpayable",
+        "type": "function",
+    },
+    {
+        "inputs": [{"internalType": "uint256", "name": "streamId", "type": "uint256"}],
+        "name": "withdraw",
+        "outputs": [],
+        "stateMutability": "nonpayable",
+        "type": "function",
+    },
+    {
+        "inputs": [{"internalType": "uint256", "name": "streamId", "type": "uint256"}],
+        "name": "terminate",
+        "outputs": [],
+        "stateMutability": "nonpayable",
+        "type": "function",
+    },
+    {
+        "anonymous": False,
+        "inputs": [
+            {"indexed": True, "internalType": "uint256", "name": "streamId", "type": "uint256"},
+            {"indexed": True, "internalType": "address", "name": "sender", "type": "address"},
+            {"indexed": True, "internalType": "address", "name": "recipient", "type": "address"},
+            {"indexed": False, "internalType": "address", "name": "token", "type": "address"},
+            {"indexed": False, "internalType": "uint256", "name": "deposit", "type": "uint256"},
+            {"indexed": False, "internalType": "uint256", "name": "ratePerSecond", "type": "uint256"},
+            {"indexed": False, "internalType": "uint256", "name": "startTime", "type": "uint256"},
+            {"indexed": False, "internalType": "uint256", "name": "stopTime", "type": "uint256"},
+        ],
+        "name": "StreamCreated",
+        "type": "event",
+    },
+]
+
+ERC20_ABI = [
+    {
+        "name": "approve",
+        "type": "function",
+        "stateMutability": "nonpayable",
+        "inputs": [
+            {"name": "spender", "type": "address"},
+            {"name": "amount", "type": "uint256"},
+        ],
+        "outputs": [{"name": "", "type": "bool"}],
+    }
+]
+
+
+@dataclass
+class StreamPaymentConfig:
+    rpc_url: str
+    contract_address: str
+    glm_token_address: str
+    private_key: str
+
+
+class StreamPaymentClient:
+    def __init__(self, cfg: StreamPaymentConfig):
+        self.web3 = Web3(Web3.HTTPProvider(cfg.rpc_url))
+        self.account = Account.from_key(cfg.private_key)
+        self.web3.eth.default_account = self.account.address
+
+        self.contract = self.web3.eth.contract(
+            address=Web3.to_checksum_address(cfg.contract_address), abi=STREAM_PAYMENT_ABI
+        )
+        self.erc20 = self.web3.eth.contract(
+            address=Web3.to_checksum_address(cfg.glm_token_address), abi=ERC20_ABI
+        )
+
+    def _send(self, fn) -> Dict[str, Any]:
+        tx = fn.build_transaction(
+            {
+                "from": self.account.address,
+                "nonce": self.web3.eth.get_transaction_count(self.account.address),
+            }
+        )
+        # In production, sign and send raw; in tests, Account may be a dummy without signer
+        if hasattr(self.account, "sign_transaction"):
+            signed = self.account.sign_transaction(tx)
+            tx_hash = self.web3.eth.send_raw_transaction(signed.rawTransaction)
+        else:
+            tx_hash = self.web3.eth.send_transaction(tx)
+        receipt = self.web3.eth.wait_for_transaction_receipt(tx_hash)
+        return {"transactionHash": tx_hash.hex(), "status": receipt.status, "logs": receipt.logs}
+
+    def create_stream(self, provider_address: str, deposit_wei: int, rate_per_second_wei: int) -> int:
+        # 1) Approve deposit for the StreamPayment contract
+        approve = self.erc20.functions.approve(self.contract.address, int(deposit_wei))
+        self._send(approve)
+
+        # 2) Create stream
+        fn = self.contract.functions.createStream(
+            self.erc20.address,
+            Web3.to_checksum_address(provider_address),
+            int(deposit_wei),
+            int(rate_per_second_wei),
+        )
+        receipt = self._send(fn)
+
+        # Try to parse StreamCreated event for streamId
+        try:
+            for log in receipt["logs"]:
+                # very naive filter: topic0 = keccak256(StreamCreated(...))
+                # When ABI is attached to contract, use contract.events
+                ev = self.contract.events.StreamCreated().process_log(log)
+                return int(ev["args"]["streamId"])
+        except Exception:
+            pass
+        # As a fallback, cannot easily fetch return value from a tx; caller should query later
+        raise RuntimeError("create_stream: could not parse streamId from receipt")
+
+    def withdraw(self, stream_id: int) -> str:
+        fn = self.contract.functions.withdraw(int(stream_id))
+        receipt = self._send(fn)
+        return receipt["transactionHash"]
+
+    def terminate(self, stream_id: int) -> str:
+        fn = self.contract.functions.terminate(int(stream_id))
+        receipt = self._send(fn)
+        return receipt["transactionHash"]
+
+    def top_up(self, stream_id: int, amount_wei: int) -> str:
+        # Approve first
+        approve = self.erc20.functions.approve(self.contract.address, int(amount_wei))
+        self._send(approve)
+        # Top up
+        fn = self.contract.functions.topUp(int(stream_id), int(amount_wei))
+        receipt = self._send(fn)
+        return receipt["transactionHash"]

requestor/provider/client.py

@@ -21,26 +21,37 @@ class ProviderClient:
         cpu: int,
         memory: int,
         storage: int,
-        ssh_key: str
+        ssh_key: str,
+        stream_id: int | None = None,
     ) -> Dict:
         """Create a VM on the provider."""
+        payload = {
+            "name": name,
+            "resources": {
+                "cpu": cpu,
+                "memory": memory,
+                "storage": storage
+            },
+            "ssh_key": ssh_key
+        }
+        if stream_id is not None:
+            payload["stream_id"] = int(stream_id)
         async with self.session.post(
             f"{self.provider_url}/api/v1/vms",
-            json={
-                "name": name,
-                "resources": {
-                    "cpu": cpu,
-                    "memory": memory,
-                    "storage": storage
-                },
-                "ssh_key": ssh_key
-            }
+            json=payload
         ) as response:
             if not response.ok:
                 error_text = await response.text()
                 raise Exception(f"Failed to create VM: {error_text}")
             return await response.json()
 
+    async def get_provider_info(self) -> Dict:
+        async with self.session.get(f"{self.provider_url}/api/v1/provider/info") as response:
+            if not response.ok:
+                error_text = await response.text()
+                raise Exception(f"Failed to fetch provider info: {error_text}")
+            return await response.json()
+
     async def add_ssh_key(self, vm_id: str, key: str) -> None:
         """Add SSH key to VM."""
         async with self.session.post(

requestor/services/vm_service.py

@@ -14,11 +14,13 @@ class VMService:
         self,
         db_service: DatabaseService,
         ssh_service: SSHService,
-        provider_client: Optional[ProviderClient] = None
+        provider_client: Optional[ProviderClient] = None,
+        blockchain_client: Optional[object] = None,
     ):
         self.db = db_service
         self.ssh_service = ssh_service
         self.provider_client = provider_client
+        self.blockchain_client = blockchain_client
 
     async def create_vm(
         self,
@@ -27,7 +29,8 @@ class VMService:
         memory: int,
         storage: int,
         provider_ip: str,
-        ssh_key: str
+        ssh_key: str,
+        stream_id: int | None = None,
     ) -> Dict:
         """Create a new VM with validation and error handling."""
         try:
@@ -42,18 +45,42 @@ class VMService:
                 cpu=cpu,
                 memory=memory,
                 storage=storage,
-                ssh_key=ssh_key
+                ssh_key=ssh_key,
+                stream_id=stream_id
             )
 
             # Get VM access info
             access_info = await self.provider_client.get_vm_access(vm['id'])
 
+            # Optionally create a GLM stream (if configured)
+            from ..config import config as app_config
+            stream_id = None
+            try:
+                if (
+                    self.blockchain_client
+                    and app_config.stream_payment_address != "0x0000000000000000000000000000000000000000"
+                    and app_config.glm_token_address != "0x0000000000000000000000000000000000000000"
+                    and app_config.provider_eth_address
+                ):
+                    # Simple heuristic: deposit for 1 hour at a nominal rate
+                    rate_per_second = 10**18  # 1 GLM / second (example)
+                    deposit = rate_per_second * 3600  # 1 hour worth
+                    stream_id = self.blockchain_client.create_stream(
+                        app_config.provider_eth_address,
+                        deposit,
+                        rate_per_second,
+                    )
+            except Exception:
+                # Do not fail VM creation if streaming setup fails
+                stream_id = None
+
             # Save VM details to database
             config = {
                 'cpu': cpu,
                 'memory': memory,
                 'storage': storage,
-                'ssh_port': access_info['ssh_port']
+                'ssh_port': access_info['ssh_port'],
+                **({"stream_id": stream_id} if stream_id is not None else {}),
             }
             await self.db.save_vm(
                 name=name,
@@ -88,6 +115,15 @@ class VMService:
                 if "Not Found" not in str(e):
                     raise
 
+            # Attempt to terminate stream if present
+            try:
+                stream_id = vm.get('config', {}).get('stream_id')
+                if stream_id is not None and self.blockchain_client:
+                    self.blockchain_client.terminate(stream_id)
+            except Exception:
+                # Best-effort: do not block deletion on chain failure
+                pass
+
             # Remove from database
             await self.db.delete_vm(name)
 
@@ -125,6 +161,14 @@ class VMService:
             # Update status in database
             await self.db.update_vm_status(name, "stopped")
 
+            # Best-effort withdraw on stop
+            try:
+                stream_id = vm.get('config', {}).get('stream_id')
+                if stream_id is not None and self.blockchain_client:
+                    self.blockchain_client.withdraw(stream_id)
+            except Exception:
+                pass
+
         except Exception as e:
             raise VMError(f"Failed to stop VM: {str(e)}")