add topup_account to api

Author: billbsing

convex_api/convex_api.py

@@ -123,6 +123,28 @@ def request_funds(self, amount, account):
             raise ValueError(f'request_funds: returned account is not correct {result["address"]}')
         return result['amount']
 
+    def topup_account(self, account, min_balance=1000000, retry_count=2):
+        """
+        Topup an account from the block chain faucet, so that the balance of the account is above or equal to
+        the `min_balanace`.
+
+        :param number amount: The amount of funds to request
+        :param Account account: The account to receive funds for
+        :param number min_balance: Minimum account balance that will allowed before a topup occurs
+        :Param number retry_count: The number of times the faucet will be called to get above or equal to the  `min_balance`
+
+        :returns: The amount transfered to the account
+
+        """
+
+        request_amount = min(9000000, min_balance)
+        retry_count = min(5, retry_count)
+        transfer_amount = 0
+        while min_balance > self.get_balance(account) and retry_count > 0:
+            transfer_amount += self.request_funds(request_amount, account)
+            retry_count -= 1
+        return transfer_amount
+
     def get_address(self, function_name, address_account):
         """
 

tests/conftest.py

@@ -11,8 +11,6 @@
 from convex_api.account import Account
 from convex_api.convex_api import ConvexAPI
 
-from tests.helpers import auto_topup_account
-
 logging.basicConfig(level=logging.DEBUG)
 logging.getLogger('urllib3').setLevel(logging.INFO)
 
@@ -59,5 +57,5 @@ def convex(convex_url):
 @pytest.fixture(scope='module')
 def other_account(convex):
     account = Account.create_new()
-    auto_topup_account(convex, account)
+    convex.topup_account(account)
     return account

tests/helpers.py

@@ -39,6 +39,17 @@ def test_convex_api_request_funds(convex_url, test_account):
     request_amount = convex.request_funds(amount, test_account)
     assert(request_amount == amount)
 
+def test_convex_api_topup_account(convex_url):
+    convex = ConvexAPI(convex_url)
+    account = Account.create_new()
+    topup_amount = TEST_FUNDING_AMOUNT
+    amount = convex.topup_account(account, topup_amount)
+    assert(amount >= topup_amount)
+
+    account = Account.create_new()
+    amount = convex.topup_account(account)
+    assert(amount >= 0)
+
 def test_convex_get_account_info(convex_url, test_account):
     convex = ConvexAPI(convex_url)
     info = convex.get_account_info(test_account)

tests/intergration/test_convex_api.py

@@ -10,8 +10,6 @@
 from eth_utils import add_0x_prefix
 
 
-from tests.helpers import auto_topup_account
-
 from convex_api.account import Account
 from convex_api.convex_api import ConvexAPI
 from convex_api.exceptions import ConvexAPIError
@@ -35,7 +33,7 @@ def test_convex_recursion(convex, test_account):
     )
 )
 """
-        auto_topup_account(convex, test_account)
+        convex.topup_account(test_account)
         result = convex.send(contract, test_account)
         address_list.append(add_0x_prefix(result['value']))
     for index in range(0, chain_length):
@@ -81,12 +79,12 @@ def test_schedule_transfer(convex, test_account, other_account):
 """
 # (call contract-address (tx-to to-address amount))
 
-    auto_topup_account(convex, test_account)
-    auto_topup_account(convex, other_account)
+    convex.topup_account(test_account)
+    convex.topup_account(other_account, 8000000)
     result = convex.send(contract, test_account)
     contract_address = add_0x_prefix(result['value'])
-    convex.transfer(contract_address, 8000000, other_account)
-    auto_topup_account(convex, test_account)
+    convex.transfer(contract_address, 800000, other_account)
+    convex.topup_account(test_account)
     result = convex.send(f'(call {contract_address} (tx-delay {other_account.address} 1000))', test_account)
     print(result)
     result = convex.send(f'(call {contract_address} (show-schedule))', test_account)

tests/intergration/test_convex_break.py

@@ -10,8 +10,6 @@
 from convex_api.convex_api import ConvexAPI
 from convex_api.exceptions import ConvexAPIError
 
-from tests.helpers import auto_topup_account
-
 def process_on_convex(convex, test_account):
     values = []
     inc_values = []
@@ -33,7 +31,7 @@ def test_convex_api_multi_thread(convex_url, test_account):
 
     process_count = 4
     convex = ConvexAPI(convex_url)
-    auto_topup_account(convex, test_account)
+    convex.topup_account(test_account)
     process_list = []
     for index in range(process_count):
         proc = Process(target=process_on_convex, args=(convex, test_account))