initial commit

Author: PatrickAlphaC

CHANGELOG.md

@@ -1,2 +1,40 @@
 # alchemy_sdk_py
-An SDK to use the Alchemy API
+An SDK to use the [Alchemy API](https://www.alchemy.com/)
+
+
+# Getting Started
+
+## Requirements 
+
+- [Python](https://www.python.org/downloads/) 3.7 or higher
+    - You'll know you've done it right if you can run `python3 --version` in your terminal and see something like `Python 3.10.6`
+
+## Installation
+
+```bash
+pip3 install alchemy_sdk_py
+```
+
+## Quickstart
+
+### Get an API Key
+After [installing](#installation), you'll need to sign up for an API key and set it as an `ALCHEMY_API_KEY` environment variable. 
+
+If you're unfamiliar with environment variables, you can use the API to set the key directly using the SDK - please don't do this in production code. 
+
+```python
+import alchemy_sdk_py
+
+alchemy_sdk_py.set_api_key("YOUR_API_KEY")
+```
+
+This will make the key availible for the duration of your script. 
+
+### Useage 
+
+```python
+import alchemy_sdk_py as alchemy
+
+current_block = alchemy.get_current_block()
+print(current_block)
+```

CONTRIBUTING.md

@@ -0,0 +1,8 @@
+from .api import (
+    get_current_block,
+    get_asset_transfers,
+    get_transaction_receipt,
+    get_events,
+    get_block_datetime,
+    set_api_key,
+)

README.md

@@ -0,0 +1,6 @@
+__title__ = "alchemy_sdk_py"
+__description__ = "Python SDK for working with the Alchemy API."
+__version__ = "0.0.1"
+__author__ = "Alpha Chain"
+__license__ = "MIT"
+__copyright__ = "Copyright 2022 Alpha Chain"

alchemy_sdk_py/__init__.py

@@ -0,0 +1,139 @@
+import os
+import requests
+import json
+from decimal import Decimal
+from datetime import datetime
+
+API_KEY = os.getenv("ALCHEMY_API_KEY")
+BASE_URL = f"https://eth-mainnet.g.alchemy.com/v2/{API_KEY}"
+HEADERS = {"accept": "application/json", "content-type": "application/json"}
+
+
+def set_api_key(key: str):
+    """
+    params:
+        key: API key
+    returns:
+        None
+    """
+    os.environ["ALCHEMY_API_KEY"] = key
+
+
+def get_current_block() -> int:
+    """
+    params:
+        None
+    returns:
+        the current max block (INT)
+    """
+    payload = {"id": 1, "jsonrpc": "2.0", "method": "eth_blockNumber"}
+    response = requests.post(BASE_URL, json=payload, headers=HEADERS)
+    response = json.loads(response.text)
+    result = int(response["result"], 16)
+    return result
+
+
+def get_asset_transfers(node_address: str, block_start: int, block_end: int) -> list:
+    """
+    params:
+        node_address: wallet address associated with the OCR node
+        block_start: INT
+        block_end: INT
+    returns: A dictionary, internal/external asset transfers for the address
+    """
+    from_block = str(hex(block_start))
+    to_block = str(hex(block_end))
+    address = node_address.lower()
+    payload = {
+        "id": 1,
+        "jsonrpc": "2.0",
+        "method": "alchemy_getAssetTransfers",
+        "params": [
+            {
+                "fromBlock": from_block,
+                "toBlock": to_block,
+                "fromAddress": address,
+                "category": ["external", "internal"],
+                "excludeZeroValue": False,
+            }
+        ],
+    }
+    response = requests.post(BASE_URL, json=payload, headers=HEADERS)
+    response = json.loads(response.text)
+    result = response["result"]
+    transfers = result["transfers"]
+    return transfers
+
+
+def get_transaction_receipt(transaction_hash: str):
+    """
+    params:
+        transaction_hash: transaction hash to search for
+    returns:
+        transaction receipt data
+    """
+    payload = {
+        "id": 1,
+        "jsonrpc": "2.0",
+        "method": "eth_getTransactionReceipt",
+        "params": [transaction_hash],
+    }
+    response = requests.post(BASE_URL, json=payload, headers=HEADERS)
+    response = json.loads(response.text)
+    result = response["result"]
+    return result
+
+
+def get_events(contract_address, event_signature, block_start, block_end) -> dict:
+    """
+    params:
+        contract_address: LIST off addresses for which to search for events
+        event_signature: signature of the event to search for (TOPIC 0)
+        block_start: INT
+        block_end: INT
+    returns: A dictionary, result[block] = block_date
+    """
+    from_block = str(hex(block_start))
+    to_block = str(hex(block_end))
+    payload = {
+        "id": 1,
+        "jsonrpc": "2.0",
+        "method": "eth_getLogs",
+        "params": [
+            {
+                "address": contract_address,
+                "fromBlock": from_block,
+                "toBlock": to_block,
+                "topics": [event_signature],
+            }
+        ],
+    }
+    response = requests.post(BASE_URL, json=payload, headers=HEADERS)
+    response = json.loads(response.text)
+    result = response.get("result")
+    return result
+
+
+def get_block_datetime(blocks=None, block_start=None, block_end=None) -> dict:
+    """
+    params:
+            block_start as an INT
+            block_end as an INT
+    returns:
+            A dictionary, result[block] = block_date
+    """
+    blocks = list(range(block_start, block_end)) if blocks is None else blocks
+    result = {}
+    for block in blocks:
+        payload = {
+            "id": 1,
+            "jsonrpc": "2.0",
+            "method": "eth_getBlockByNumber",
+            "params": [hex(block), False],
+        }
+        response = requests.post(BASE_URL, json=payload, headers=HEADERS)
+        result_raw = json.loads(response.text)["result"]
+        block = int(result_raw["number"], 16)
+        block_date = datetime.fromtimestamp(int(result_raw["timestamp"], 16))
+        result[block] = block_date
+    return result

alchemy_sdk_py/__version__.py

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"

alchemy_sdk_py/api.py

@@ -0,0 +1,5 @@
+certifi==2022.12.7
+charset-normalizer==2.1.1
+idna==3.4
+requests==2.28.1
+urllib3==1.26.13

pyproject.toml

@@ -0,0 +1,3 @@
+[metadata]
+license_file = LICENSE
+description-file = README.md

requirements.txt

@@ -0,0 +1,40 @@
+from setuptools import setup
+import os
+
+
+here = os.path.abspath(os.path.dirname(__file__))
+with open("README.md", "r", "utf-8") as f:
+    readme = f.read()
+
+about = {}
+with open(os.path.join(here, "alchemy_sdk_py", "__version__.py"), "r", "utf-8") as f:
+    exec(f.read(), about)
+
+setup(
+    name=about["__title__"],
+    version=about["__version__"],
+    author=about["__author__"],
+    license=about["__license__"],
+    install_requires=[
+        "certifi",
+        "charset-normalizer",
+        "idna",
+        "requests",
+        "urllib3",
+    ],
+    packages=[about["__title__"]],
+    python_requires=">=3.7, <4",
+    url="https://github.com/alphachainio/alchemy_sdk_py",
+    long_description=readme,
+    long_description_content_type="text/markdown",
+    classifiers=[
+        "Development Status :: 2 - Pre-Alpha",
+        "Intended Audience :: Developers",
+        "License :: OSI Approved :: MIT License",
+        "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
+    ],
+    packages=["alchemy_sdk_py"],
+)