Merge pull request #35 from agatsoh/proxies_extended

Adding proxy API's for etherscan

Author: corpetty

etherscan/client.py

@@ -114,7 +114,8 @@ def connect(self):
             # Check for empty response
             if req.text:
                 data = req.json()
-                if data.get('status') == '1':
+                status = data.get('status')
+                if status == '1' or self.check_keys_api(data):
                     return data
                 else:
                     raise EmptyResponse(data.get('message', 'no message'))
@@ -125,3 +126,7 @@ def check_and_get_api(self):
             pass
         else:
             self.url_dict[self.API_KEY] = input('Please type your EtherScan.io API key: ')
+
+    def check_keys_api(self, data):
+        return all (k in data for k in ('jsonrpc', 'id', 'result'))
+    

etherscan/proxies.py

@@ -1,4 +1,5 @@
 from .client import Client
+from typing import Union
 
 
 class Proxies(Client):
@@ -11,3 +12,62 @@ def get_most_recent_block(self):
         self.build_url()
         req = self.connect()
         return req['result']
+    
+    def get_block_by_number(self, block_number: Union[str, int]):
+        self.url_dict[self.ACTION] = 'eth_getBlockByNumber'
+        self.url_dict[self.TAG] = block_number if type(block_number) is str else hex(block_number)
+        self.url_dict[self.BOOLEAN] = 'true'
+        self.build_url()
+        req = self.connect()
+        return req['result']
+
+    def get_uncle_by_blocknumber_index(self,
+        block_number: Union[str, int],
+        index: Union[str, int]):
+        self.url_dict[self.ACTION] = 'eth_getUncleByBlockNumberAndIndex'
+        self.url_dict[self.TAG] = block_number if type(block_number) is str else hex(block_number)
+        self.url_dict[self.INDEX] = index if type(index) is str else hex(index)
+        self.build_url()
+        req = self.connect()
+        return req['result']
+
+    def get_block_transaction_count_by_number(self, block_number: Union[str, int]):
+        self.url_dict[self.ACTION] = 'eth_getBlockTransactionCountByNumber'
+        self.url_dict[self.TAG] = block_number if type(block_number) is str else hex(block_number)
+        self.build_url()
+        req = self.connect()
+        return req['result']
+
+    def get_transaction_by_hash(self, tx_hash: str):
+        self.url_dict[self.ACTION] = 'eth_getTransactionByHash'
+        self.url_dict[self.TXHASH] = tx_hash
+        self.build_url()
+        req = self.connect()
+        return req['result']
+
+    def get_transaction_by_blocknumber_index(self,
+        block_number: Union[str, int],
+        index: Union[str, int]):
+        self.url_dict[self.ACTION] = 'eth_getTransactionByBlockNumberAndIndex'
+        self.url_dict[self.TAG] = block_number if type(block_number) is str else hex(block_number)
+        self.url_dict[self.INDEX] = index if type(index) is str else hex(index)
+        self.build_url()
+        req = self.connect()
+        return req['result']
+
+    def get_transaction_count(self, address: str):
+        self.url_dict[self.ACTION] = 'eth_getTransactionCount'
+        self.url_dict[self.ADDRESS] = address
+        self.url_dict[self.TAG] = 'latest'
+        self.build_url()
+        req = self.connect()
+        return req['result']
+
+    def get_transaction_receipt(self, tx_hash: str):
+        self.url_dict[self.ACTION] = 'eth_getTransactionReceipt'
+        self.url_dict[self.TXHASH] = tx_hash
+        self.build_url()
+        req = self.connect()
+        return req['result']
+
+

examples/proxies/get_block_by_number.py

@@ -0,0 +1,10 @@
+from  etherscan.proxies import Proxies
+import json
+
+with open('../../api_key.json', mode='r') as key_file:
+    key = json.loads(key_file.read())['key']
+
+
+api = Proxies(api_key=key)
+block = api.get_block_by_number(5747732)
+print(block['number'])

examples/proxies/get_block_transaction_count_by_number.py

@@ -0,0 +1,10 @@
+from  etherscan.proxies import Proxies
+import json
+
+with open('../../api_key.json', mode='r') as key_file:
+    key = json.loads(key_file.read())['key']
+
+
+api = Proxies(api_key=key)
+tx_count = api.get_block_transaction_count_by_number(block_number='0x10FB78')
+print(int(tx_count, 16))

examples/proxies/get_most_recent_block.py

@@ -0,0 +1,9 @@
+from  etherscan.proxies import Proxies
+import json
+
+with open('../../api_key.json', mode='r') as key_file:
+    key = json.loads(key_file.read())['key']
+    
+api = Proxies(api_key=key)
+block = api.get_most_recent_block()
+print(int(block, 16))

examples/proxies/get_transaction_by_blocknumber_index.py

@@ -0,0 +1,10 @@
+from  etherscan.proxies import Proxies
+import json
+
+with open('../../api_key.json', mode='r') as key_file:
+    key = json.loads(key_file.read())['key']
+
+
+api = Proxies(api_key=key)
+transaction = api.get_transaction_by_blocknumber_index(block_number='0x57b2cc', index='0x2')
+print(transaction['transactionIndex'])

examples/proxies/get_transaction_by_hash.py

@@ -0,0 +1,10 @@
+from  etherscan.proxies import Proxies
+import json
+
+with open('../../api_key.json', mode='r') as key_file:
+    key = json.loads(key_file.read())['key']
+    
+api = Proxies(api_key=key)
+transaction = api.get_transaction_by_hash(
+	tx_hash='0x1e2910a262b1008d0616a0beb24c1a491d78771baa54a33e66065e03b1f46bc1')
+print(transaction['hash'])

examples/proxies/get_transaction_count.py

@@ -0,0 +1,10 @@
+from  etherscan.proxies import Proxies
+import json
+
+with open('../../api_key.json', mode='r') as key_file:
+    key = json.loads(key_file.read())['key']
+
+
+api = Proxies(api_key=key)
+count = api.get_transaction_count('0x6E2446aCfcec11CC4a60f36aFA061a9ba81aF7e0')
+print(int(count, 16))

examples/proxies/get_transaction_receipt.py

@@ -0,0 +1,9 @@
+from  etherscan.proxies import Proxies
+import json
+
+with open('../../api_key.json', mode='r') as key_file:
+    key = json.loads(key_file.read())['key']
+
+api = Proxies(api_key=key)
+receipt = api.get_transaction_receipt('0xb03d4625fd433ad05f036abdc895a1837a7d838ed39f970db69e7d832e41205d')
+print(receipt)

examples/proxies/get_uncle_by_blocknumber_index.py

@@ -0,0 +1,9 @@
+from  etherscan.proxies import Proxies
+import json
+
+with open('../../api_key.json', mode='r') as key_file:
+    key = json.loads(key_file.read())['key']
+
+api = Proxies(api_key=key)
+uncles = api.get_uncle_by_blocknumber_index(block_number='0x210A9B', index='0x0')
+print(uncles['uncles'])