add new repo structure

.github/workflows/ci.yml

@@ -0,0 +1,82 @@
+---
+name: CI
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches: main 
+  release:
+    types: [released]
+
+jobs:
+  ci:
+    runs-on: ubuntu-22.04
+    strategy:
+      matrix:
+        python-version: [
+          "3.8", "3.9", "3.10", "3.11", "3.12",
+        ]
+    timeout-minutes: 10
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+      - name: Install Poetry
+        run: |
+          pipx install poetry
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: poetry
+          cache-dependency-path: poetry.lock
+
+      - name: Install dependencies
+        run: |
+          poetry install
+
+      - name: Typecheck
+        run: |
+          poetry run pyright .
+
+      - name: Lint
+        run: |
+          poetry run ruff check .
+
+      - name: Test
+        run: |
+          poetry run pytest tests/
+
+      - name: Build sdist
+        run: |
+          poetry build -f sdist
+
+      - name: Archive production artifacts
+        uses: actions/upload-artifact@v2
+        with:
+          name: wheels
+          path: |
+            dist
+
+      - name: Display structure of downloaded files
+        run: |
+          ls -R
+        working-directory: ./
+
+      - run: |
+          poetry config repositories.testpypi https://test.pypi.org/legacy/
+      - run: |
+          poetry config pypi-token.testpypi ${{ secrets.TEST_PYPI_TOKEN }}
+
+      - name: Publish package (test)
+        run: |
+          poetry publish --no-interaction --dry-run -r testpypi -vvv
+
+      - if: github.event_name == 'release'
+        run: poetry config pypi-token.pypi ${{ secrets.PYPI_TOKEN }}
+
+      - name: Publish package (prod)
+        if: github.event_name == 'release'
+        run: |
+          poetry publish --no-interaction -vvv

.gitignore

@@ -0,0 +1,164 @@
+##################################################################
+# https://github.com/github/gitignore/blob/main/Python.gitignore #
+##################################################################
+
+# 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/

.mergify.yml

@@ -0,0 +1,28 @@
+queue_rules:
+  - name: default
+
+pull_request_rules:
+  - name: automatic merge
+    conditions:
+      - "#approved-reviews-by>=1"
+      - "label=merge-queue"
+      - "base=main"
+    actions:
+      queue:
+        name: default
+        method: rebase
+
+  - name: delete head branch after merge
+    conditions:
+      - merged
+      - closed
+    actions:
+      delete_head_branch: {}
+
+  - name: remove from merge-queue after merge
+    conditions:
+      - merged
+    actions:
+      label:
+        remove:
+          - "merge-queue"

.pre-commit-config.yaml

@@ -0,0 +1,9 @@
+repos:
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  # Ruff version.
+  rev: v0.1.4
+  hooks:
+    # Run the linter.
+    - id: ruff
+    # Run the formatter.
+    - id: ruff-format

README.md

@@ -1,4 +1,5 @@
 # cow-py
+
 CoW Protocol Python SDK
 
 [Help the herd 🐮](https://snapshot.org/#/cowgrants.eth/proposal/0x29bde0a0789a15f2255e11bdff088b4ffdf491729250dbe93b8b0776beb7f999)

cow_py/common/chains/__init__.py

@@ -0,0 +1,29 @@
+from enum import Enum
+
+
+class Chain(Enum):
+    """
+    Supported chains and their respective `chainId` for the SDK.
+    """
+
+    MAINNET = 1
+    GNOSIS = 100
+    SEPOLIA = 11155111
+
+    def __init__(self, id) -> None:
+        self.id = id
+
+
+SUPPORTED_CHAINS = {Chain.MAINNET, Chain.GNOSIS, Chain.SEPOLIA}
+
+CHAIN_NAMES = {
+    Chain.MAINNET: "ethereum",
+    Chain.GNOSIS: "gnosis",
+    Chain.SEPOLIA: "sepolia",
+}
+
+CHAIN_SCANNER_MAP = {
+    Chain.MAINNET: "https://etherscan.io",
+    Chain.GNOSIS: "https://gnosisscan.io",
+    Chain.SEPOLIA: "https://sepolia.etherscan.io/",
+}

cow_py/common/chains/utils.py

@@ -0,0 +1,6 @@
+from cow_py.common.chains import CHAIN_SCANNER_MAP, Chain
+
+
+def get_explorer_link(chain: Chain, tx_hash: str) -> str:
+    """Return the scan link for the provided transaction hash."""
+    return f"{CHAIN_SCANNER_MAP[chain]}/tx/{tx_hash}"

cow_py/common/config.py

@@ -0,0 +1,7 @@
+from enum import Enum
+
+
+class IPFSConfig(Enum):
+    READ_URI = "https://gnosis.mypinata.cloud/ipfs"
+    WRITE_URI = "https://api.pinata.cloud"
+    # TODO: ensure pinata api key is somewhere?

cow_py/common/constants.py

@@ -0,0 +1,41 @@
+from enum import Enum
+from typing import Dict
+from .chains import Chain
+
+"""
+This module contains constants and functions related to the CoW Protocol. It provides mappings of 
+the main CoW contract addresses to CoW's supported networks.
+"""
+
+BUY_ETH_ADDRESS = "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE"
+
+
+class CowContractAddress(Enum):
+    VAULT_RELAYER = "0xC92E8bdf79f0507f65a392b0ab4667716BFE0110"
+    COMPOSABLE_COW = "0xfdaFc9d1902f4e0b84f65F49f244b32b31013b74"
+    SETTLEMENT_CONTRACT = "0x9008D19f58AAbD9eD0D60971565AA8510560ab41"
+    EXTENSIBLE_FALLBACK_HANDLER = "0x2f55e8b20D0B9FEFA187AA7d00B6Cbe563605bF5"
+
+
+def map_address_to_supported_networks(address) -> Dict[Chain, str]:
+    """
+    Maps a given address to all supported networks.
+
+    :param address: The address to be mapped.
+    :return: A dictionary mapping the address to each supported chain.
+    """
+    return {chain_id: address for chain_id in Chain}
+
+
+COW_PROTOCOL_SETTLEMENT_CONTRACT_CHAIN_ADDRESS_MAP = map_address_to_supported_networks(
+    CowContractAddress.SETTLEMENT_CONTRACT
+)
+COW_PROTOCOL_VAULT_RELAYER_CHAIN_ADDRESS_MAP = map_address_to_supported_networks(
+    CowContractAddress.VAULT_RELAYER
+)
+EXTENSIBLE_FALLBACK_HANDLER_CONTRACT_CHAIN_ADDRESS_MAP = (
+    map_address_to_supported_networks(CowContractAddress.EXTENSIBLE_FALLBACK_HANDLER)
+)
+COMPOSABLE_COW_CONTRACT_CHAIN_ADDRESS_MAP = map_address_to_supported_networks(
+    CowContractAddress.COMPOSABLE_COW
+)

cow_py/common/cow_error.py

@@ -0,0 +1,7 @@
+class CowError(Exception):
+    def __init__(self, message, error_code=None):
+        super().__init__(message)
+        self.error_code = error_code
+
+
+LOG_PREFIX = "cow-sdk:"

cow_py/contracts/__init__.py

@@ -0,0 +1,3 @@
+from cow_py.contracts import abis
+
+__all__ = ["abis"]