Addition of Transactions module

Author: RichHorrocks

README.md

@@ -35,6 +35,7 @@ Currently, only the following Etherscan.io API modules are available:
 - tokens
 - proxies
 - blocks
+- transactions
 
 The remaining available modules provided by Etherscan.io will be added eventually...
 

etherscan/transactions.py

@@ -0,0 +1,21 @@
+from .client import Client
+
+
+class Transactions(Client):
+    def __init__(self, api_key='YourApiKeyToken'):
+        Client.__init__(self, address='', api_key=api_key)
+        self.url_dict[self.MODULE] = 'transaction'
+
+    def get_status(self, tx_hash: str):
+        self.url_dict[self.ACTION] = 'getstatus'
+        self.url_dict[self.TXHASH] = tx_hash
+        self.build_url()
+        req = self.connect()
+        return req['result']
+
+    def get_tx_receipt_status(self, tx_hash: str):
+        self.url_dict[self.ACTION] = 'gettxreceiptstatus'
+        self.url_dict[self.TXHASH] = tx_hash
+        self.build_url()
+        req = self.connect()
+        return req['result']

examples/blocks/__init__.py

@@ -0,0 +1 @@
+__author__ = 'Corey Petty'

examples/transactions/Transactions Examples Notebook.ipynb

@@ -0,0 +1,175 @@
+{
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "%load_ext autoreload\n",
+    "%autoreload 2\n",
+    "import etherscan.transactions as transactions\n",
+    "import json"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Import our api_key"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "The JSON keyfile being read in has only one line in the format:\n",
+    "    \n",
+    "    {\"key\" : \"YourApiKey\" }"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "with open('../../api_key.json', mode='r') as key_file:\n",
+    "    key = json.loads(key_file.read())['key']"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Set up API"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 8,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "api = transactions.Transactions(api_key=key)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Get the transaction status and transaction receipt status"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 9,
+   "metadata": {
+    "scrolled": false
+   },
+   "outputs": [],
+   "source": [
+    "TX_HASH = '0x15f8e5ea1079d9a0bb04a4c58ae5fe7654b5b2b4463375ff7ffb490aa0032f3a'\n",
+    "status = api.get_status(tx_hash=TX_HASH)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 10,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "{'isError': '1', 'errDescription': 'Bad jump destination'}"
+      ]
+     },
+     "execution_count": 10,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "status"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 11,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "TX_HASH = '0x513c1ba0bebf66436b5fed86ab668452b7805593c05073eb2d51d3a52f480a76'\n",
+    "receipt_status = api.get_tx_receipt_status(tx_hash=TX_HASH)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 12,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "{'status': '1'}"
+      ]
+     },
+     "execution_count": 12,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "receipt_status"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.7.0"
+  },
+  "latex_envs": {
+   "bibliofile": "biblio.bib",
+   "cite_by": "apalike",
+   "current_citInitial": 1,
+   "eqLabelWithNumbers": true,
+   "eqNumInitial": 0
+  },
+  "toc": {
+   "nav_menu": {
+    "height": "121px",
+    "width": "252px"
+   },
+   "navigate_menu": true,
+   "number_sections": true,
+   "sideBar": true,
+   "threshold": 4,
+   "toc_cell": false,
+   "toc_section_display": "block",
+   "toc_window_display": false
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

examples/transactions/__init__.py

@@ -0,0 +1 @@
+__author__ = 'Corey Petty'

examples/transactions/get_status.py

@@ -0,0 +1,10 @@
+from etherscan.transactions import Transactions
+import json
+
+with open('../../api_key.json', mode='r') as key_file:
+    key = json.loads(key_file.read())['key']
+
+TX_HASH = '0x15f8e5ea1079d9a0bb04a4c58ae5fe7654b5b2b4463375ff7ffb490aa0032f3a'
+api = Transactions(api_key=key)
+status = api.get_status(tx_hash=TX_HASH)
+print(status)

examples/transactions/get_tx_receipt_status.py

@@ -0,0 +1,10 @@
+from etherscan.transactions import Transactions
+import json
+
+with open('../../api_key.json', mode='r') as key_file:
+    key = json.loads(key_file.read())['key']
+
+TX_HASH = '0x513c1ba0bebf66436b5fed86ab668452b7805593c05073eb2d51d3a52f480a76'
+api = Transactions(api_key=key)
+receipt_status = api.get_tx_receipt_status(tx_hash=TX_HASH)
+print(receipt_status)

setup.py

@@ -4,7 +4,7 @@
     name='py_etherscan_api',
     version='0.8.0',
     packages=['examples', 'examples.stats', 'examples.tokens',
-              'examples.accounts', 'examples.blocks', 'etherscan'],
+              'examples.accounts', 'examples.blocks', 'examples.transactions',  'etherscan'],
     url='https://github.com/corpetty/py-etherscan-api',
     license='MIT',
     author='coreypetty',

tests/test_transactions.py

@@ -0,0 +1,21 @@
+import unittest
+
+from etherscan.transactions import Transactions
+
+API_KEY = 'YourAPIkey'
+TX_HASH_1 = '0x15f8e5ea1079d9a0bb04a4c58ae5fe7654b5b2b4463375ff7ffb490aa0032f3a'
+TX_HASH_2 = '0x513c1ba0bebf66436b5fed86ab668452b7805593c05073eb2d51d3a52f480a76'
+ERROR_STRING = 'Bad jump destination'
+
+class TransactionsTestCase(unittest.TestCase):
+
+    def test_get_status(self):
+        api = Transactions(api_key=(API_KEY))
+        status = api.get_status(TX_HASH_1)
+        self.assertEqual(status['isError'], '1')
+        self.assertEqual(status['errDescription'], ERROR_STRING)
+
+    def test_get_tx_receipt_status(self):
+        api = Transactions(api_key=(API_KEY))
+        receipt_status = api.get_tx_receipt_status(TX_HASH_2)
+        self.assertEqual(receipt_status['status'], '1')