Init

Author: devstein

.gitignore

@@ -0,0 +1,160 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

README.md

@@ -0,0 +1,4 @@
+# picket-python
+
+The official Python library for the Picket API
+

picket.py

@@ -0,0 +1,158 @@
+import os
+
+from dataclasses import dataclass
+from typing import Dict
+
+import requests
+from requests.auth import HTTPBasicAuth
+from requests.exceptions import JSONDecodeError
+
+API_VERSION = "v1"
+API_BASE_URL = os.path.join("https://picketapi.com/api/", API_VERSION)
+
+
+def is_successful_status_code(status_code):
+    return status_code >= 200 and status_code < 300
+
+
+class PicketAPIException(Exception):
+    def __init__(self, msg: str, code: str):
+        super().__init__(msg)
+        self.msg = msg
+        self.code = code
+
+    def __str__(self):
+        return self.msg
+
+
+@dataclass
+class NonceResponse:
+    nonce: str
+    statement: str
+    format: str
+
+    @classmethod
+    def from_dict(cls, d):
+        return cls(d["nonce"], d["statement"], d["format"])
+
+
+TokenBalances = Dict[str, Dict[str, str]]
+
+
+@dataclass
+class AuthorizedUser:
+    chain: str
+    wallet_address: str
+    display_name: str
+    token_balances: TokenBalances
+
+    @classmethod
+    def from_dict(cls, d):
+        return cls(
+            d["chain"], d["wallet_address"], d["display_name"], d["token_balances"]
+        )
+
+
+@dataclass
+class AuthResponse:
+    access_token: str
+    user: AuthorizedUser
+
+    @classmethod
+    def from_dict(cls, d):
+        user = AuthorizedUser.from_dict(d["user"])
+        return cls(d["accessToken"], user)
+
+
+@dataclass
+class TokenOwnershipResponse:
+    allowed: bool
+    walletAddress: str
+    token_balances: TokenBalances
+
+    @classmethod
+    def from_dict(cls, d):
+        return cls(d["allowed"], d["walletAddress"], d["token_balances"])
+
+
+class Picket:
+    def __init__(self, api_key: str, **kwargs):
+        self.api_key = api_key
+        # Base URL for API
+        # Configurable for testing
+        self.base_url = kwargs.get("base_url", API_BASE_URL)
+
+    def headers(self):
+        return {
+            "User-Agent": "Picket Python Client",
+            "Content-Type": "application/json",
+        }
+
+    def post_request(self, path: str, **kwargs):
+        url = os.path.join(self.base_url, path)
+        auth = HTTPBasicAuth(self.api_key, "")
+        headers = self.headers()
+
+        req = requests.post(url, auth=auth, headers=headers, data=kwargs)
+        try:
+            data = req.json()
+        except JSONDecodeError:
+            raise Exception(req.text)
+
+        if not is_successful_status_code(req.status_code):
+            raise PicketAPIException(data["msg"], data["code"])
+
+        return data
+
+    # nonce
+    def nonce(
+        self, chain: str, wallet_address: str, locale: str = "en-US"
+    ) -> NonceResponse:
+        data = self.post_request(
+            "auth/nonce", chain=chain, wallet_address=wallet_address, locale=locale
+        )
+        return NonceResponse.from_dict(data)
+
+    def auth(
+        self,
+        chain: str,
+        wallet_address: str,
+        signature: str,
+        requirements: dict = {},
+        context: dict = {},
+    ) -> AuthResponse:
+        data = self.post_request(
+            "auth",
+            chain=chain,
+            wallet_address=wallet_address,
+            signature=signature,
+            requirements=requirements,
+            context=context,
+        )
+        return AuthResponse.from_dict(data)
+
+    def authz(
+        self, access_token: str, requirements: dict, revalidate: bool = False
+    ) -> AuthResponse:
+        data = self.post_request(
+            "authz",
+            access_token=access_token,
+            requirements=requirements,
+            revalidate=revalidate,
+        )
+        return AuthResponse.from_dict(data)
+
+    def validate(self, access_token: str, requirements: dict = {}) -> AuthorizedUser:
+        data = self.post_request(
+            "auth/validate", access_token=access_token, requirements=requirements
+        )
+        return AuthorizedUser.from_dict(data)
+
+    def token_ownesrhip(
+        self, chain: str, wallet_address: str, **kwargs
+    ) -> TokenOwnershipResponse:
+        path = os.path.join(
+            "chains", chain, "wallets", wallet_address, "tokenOwnership"
+        )
+        data = self.post_request(path, **kwargs)
+        return TokenOwnershipResponse.from_dict(data)