[KMS-ETH]- Miner class and methods, imagined as an Ursula mixin class.

nkms_eth/miner.py

@@ -1,3 +1,5 @@
+from typing import Tuple
+
 from .blockchain import Blockchain
 from .escrow import Escrow
 from .token import NuCypherKMSToken
@@ -6,40 +8,61 @@ from .token import NuCypherKMSToken
 class Miner:
     """Practically carrying a pickaxe"""
 
-    def __init__(self, blockchain: Blockchain, token: NuCypherKMSToken, escrow: Escrow):
+    def __init__(self, blockchain: Blockchain, token: NuCypherKMSToken, escrow: Escrow, address=None):
         self.blockchain = blockchain
-        self.escrow = escrow
         self.token = token
+        self.address = address or self.token.creator
 
-    def lock(self, amount: int, locktime: int, address: str=None):
-        """
-        Deposit and lock coins for mining.
-        Creating coins starts after it is done.
+        self.escrow = escrow
+        if not escrow.contract:
+            raise Exception('Escrow contract not deployed')
+        else:
+            escrow.miners.append(self)
 
-        :param amount:      Amount of coins to lock (in smallest  indivisible units)
-        :param locktime:    Locktime in periods
-        :param address:     Optional address to get coins from (accounts[0] by default)
-        """
+    def __del__(self):
+        self.escrow.miners.remove(self)
+        return None
 
-        address = address or self.token.creator
+    def lock(self, amount: int, locktime: int) -> Tuple[str, str, str]:
+        """Deposit and lock tokens for mining."""
 
-        tx = self.token.transact({'from': address}).approve(self.escrow.contract.address, amount)
-        self.blockchain.chain.wait.for_receipt(tx, timeout=self.blockchain.timeout)
+        approve_txhash = self.token.transact({'from': self.address}).approve(self.escrow.contract.address, amount)
+        self.blockchain.chain.wait.for_receipt(approve_txhash, timeout=self.blockchain.timeout)
 
-        tx = self.escrow.transact({'from': address}).deposit(amount, locktime)
-        self.blockchain.chain.wait.for_receipt(tx, timeout=self.blockchain.timeout)
+        deposit_txhash = self.escrow.transact({'from': self.address}).deposit(amount, locktime)
+        self.blockchain.chain.wait.for_receipt(deposit_txhash, timeout=self.blockchain.timeout)
 
-        tx = self.escrow.transact({'from': address}).switchLock()
-        self.blockchain.chain.wait.for_receipt(tx, timeout=self.blockchain.timeout)
+        lock_txhash = self.escrow.transact({'from': self.address}).switchLock()
+        self.blockchain.chain.wait.for_receipt(lock_txhash, timeout=self.blockchain.timeout)
 
-    def mine(self, address: str=None) -> str:
-        address = address or self.token.creator
-        tx = self.escrow.transact({'from': address}).mint()
-        self.blockchain.chain.wait.for_receipt(tx, timeout=self.blockchain.timeout)
-        return tx
+        return approve_txhash, deposit_txhash, lock_txhash
 
-    def withdraw(self, address: str=None) -> str:
-        address = address or self.token.creator
-        tx = self.escrow.transact({'from': address}).withdrawAll()
-        self.blockchain.chain.wait.for_receipt(tx, timeout=self.blockchain.timeout)
-        return tx
+    def mint(self) -> str:
+        """Computes and transfers tokens to the miner's account"""
+        txhash = self.escrow.transact({'from': self.address}).mint()
+        self.blockchain.chain.wait.for_receipt(txhash, timeout=self.blockchain.timeout)
+        return txhash
+
+    def add_dht_key(self, dht_id) -> str:
+        """Store a new DHT key"""
+        txhash = self.escrow.transact({'from': self.address}).publishDHTKey(dht_id)
+        self.blockchain.chain.wait.for_receipt(txhash)
+        return txhash
+
+    def get_dht_key(self) -> tuple:
+        """Retrieve all stored DHT keys for this miner"""
+        count = self.escrow().getDHTKeysCount(self.address)
+        dht_keys = tuple(self.escrow().getDHTKey(self.address, index) for index in range(count))
+        return dht_keys
+
+    def confirm_activity(self) -> str:
+        """Miner rewarded for every confirmed period"""
+        txhash = self.escrow.contract.transact({'from': self.address}).confirmActivity()
+        self.blockchain.chain.wait.for_receipt(txhash)
+        return txhash
+
+    def withdraw(self) -> str:
+        """withdraw rewarded tokens"""
+        txhash = self.escrow.transact({'from': self.address}).withdrawAll()
+        self.blockchain.chain.wait.for_receipt(txhash, timeout=self.blockchain.timeout)
+        return txhash