opinion-clob-sdk 0.1.12__py3-none-any.whl → 0.1.13__py3-none-any.whl

opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/chain/contracts/erc20.py

@@ -0,0 +1,111 @@
+abi = """
+[
+  {
+    "type": "function",
+    "name": "allowance",
+    "inputs": [
+      { "name": "owner", "type": "address", "internalType": "address" },
+      { "name": "spender", "type": "address", "internalType": "address" }
+    ],
+    "outputs": [{ "name": "", "type": "uint256", "internalType": "uint256" }],
+    "stateMutability": "view"
+  },
+  {
+    "type": "function",
+    "name": "approve",
+    "inputs": [
+      { "name": "spender", "type": "address", "internalType": "address" },
+      { "name": "value", "type": "uint256", "internalType": "uint256" }
+    ],
+    "outputs": [{ "name": "", "type": "bool", "internalType": "bool" }],
+    "stateMutability": "nonpayable"
+  },
+  {
+    "type": "function",
+    "name": "balanceOf",
+    "inputs": [
+      { "name": "account", "type": "address", "internalType": "address" }
+    ],
+    "outputs": [{ "name": "", "type": "uint256", "internalType": "uint256" }],
+    "stateMutability": "view"
+  },
+  {
+    "type": "function",
+    "name": "totalSupply",
+    "inputs": [],
+    "outputs": [{ "name": "", "type": "uint256", "internalType": "uint256" }],
+    "stateMutability": "view"
+  },
+  {
+    "type": "function",
+    "name": "transfer",
+    "inputs": [
+      { "name": "to", "type": "address", "internalType": "address" },
+      { "name": "value", "type": "uint256", "internalType": "uint256" }
+    ],
+    "outputs": [{ "name": "", "type": "bool", "internalType": "bool" }],
+    "stateMutability": "nonpayable"
+  },
+  {
+    "type": "function",
+    "name": "transferFrom",
+    "inputs": [
+      { "name": "from", "type": "address", "internalType": "address" },
+      { "name": "to", "type": "address", "internalType": "address" },
+      { "name": "value", "type": "uint256", "internalType": "uint256" }
+    ],
+    "outputs": [{ "name": "", "type": "bool", "internalType": "bool" }],
+    "stateMutability": "nonpayable"
+  },
+  {
+    "type": "event",
+    "name": "Approval",
+    "inputs": [
+      {
+        "name": "owner",
+        "type": "address",
+        "indexed": true,
+        "internalType": "address"
+      },
+      {
+        "name": "spender",
+        "type": "address",
+        "indexed": true,
+        "internalType": "address"
+      },
+      {
+        "name": "value",
+        "type": "uint256",
+        "indexed": false,
+        "internalType": "uint256"
+      }
+    ],
+    "anonymous": false
+  },
+  {
+    "type": "event",
+    "name": "Transfer",
+    "inputs": [
+      {
+        "name": "from",
+        "type": "address",
+        "indexed": true,
+        "internalType": "address"
+      },
+      {
+        "name": "to",
+        "type": "address",
+        "indexed": true,
+        "internalType": "address"
+      },
+      {
+        "name": "value",
+        "type": "uint256",
+        "indexed": false,
+        "internalType": "uint256"
+      }
+    ],
+    "anonymous": false
+  }
+]
+"""

opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/chain/exception.py

@@ -0,0 +1,11 @@
+class BalanceNotEnough(Exception):
+    pass
+
+
+class NoPositionsToRedeem(Exception):
+    pass
+
+
+class InsufficientGasBalance(Exception):
+    """Raised when the signer doesn't have enough gas tokens to execute a transaction"""
+    pass

opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/chain/py_order_utils/builders/base_builder.py

@@ -0,0 +1,41 @@
+from ..signer import Signer
+from ..utils import normalize_address, prepend_zx
+from poly_eip712_structs import make_domain, EIP712Struct
+from eth_utils import keccak
+
+
+class BaseBuilder:
+    def __init__(
+        self, exchange_address: str, chain_id: int, signer: Signer, salt_generator
+    ):
+        self.contract_address = normalize_address(exchange_address)
+        self.signer = signer
+        self.chain_id = chain_id
+        self.domain_separator = self._get_domain_separator(
+            self.chain_id, self.contract_address
+        )
+        self.salt_generator = salt_generator
+
+    def _get_domain_separator(
+        self, chain_id: int, verifying_contract: str
+    ) -> EIP712Struct:
+        return make_domain(
+            name="OLAB CTF Exchange",
+            version="1",
+            chainId=str(chain_id),
+            verifyingContract=verifying_contract,
+        )
+
+    def _create_struct_hash(self, order: EIP712Struct):
+        """
+        Creates an EIP712 compliant struct hash for the Order
+        """
+        return prepend_zx(
+            keccak(order.signable_bytes(domain=self.domain_separator)).hex()
+        )
+
+    def sign(self, struct_hash):
+        """
+        Signs the struct hash
+        """
+        return self.signer.sign(struct_hash)

opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/chain/py_order_utils/builders/exception.py

@@ -0,0 +1,2 @@
+class ValidationException(Exception):
+    pass

opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/chain/py_order_utils/builders/order_builder.py

@@ -0,0 +1,90 @@
+from ..signer import Signer
+from .base_builder import BaseBuilder
+from .exception import ValidationException
+from ..utils import generate_seed, normalize_address, prepend_zx
+from ..model.order import Order, SignedOrder, OrderData
+from ..model.sides import BUY, SELL, OrderSide
+from ..model.signatures import EOA, POLY_GNOSIS_SAFE, POLY_PROXY
+
+
+class OrderBuilder(BaseBuilder):
+    """
+    Order builder
+    """
+
+    def __init__(
+        self,
+        exchange_address: str,
+        chain_id: int,
+        signer: Signer,
+        salt_generator=generate_seed,
+    ):
+        super().__init__(exchange_address, chain_id, signer, salt_generator)
+
+    def build_order(self, data: OrderData) -> Order:
+        """
+        Builds an order
+        """
+        if not self._validate_inputs(data):
+            raise ValidationException("Invalid order inputs")
+
+        if data.signer is None:
+            data.signer = data.maker
+
+        if data.signer != self.signer.address():
+            raise ValidationException("Signer does not match")
+
+        if data.expiration is None:
+            data.expiration = "0"
+
+        if data.signatureType is None:
+            data.signatureType = EOA
+
+        return Order(
+            salt=int(self.salt_generator()),
+            maker=normalize_address(data.maker),
+            signer=normalize_address(data.signer),
+            taker=normalize_address(data.taker),
+            tokenId=int(data.tokenId),
+            makerAmount=int(data.makerAmount),
+            takerAmount=int(data.takerAmount),
+            expiration=int(data.expiration),
+            nonce=int(data.nonce),
+            feeRateBps=int(data.feeRateBps),
+            side=int(data.side.value),  # Ensure 'side' is converted to int
+            signatureType=int(data.signatureType),
+        )
+
+    def build_order_signature(self, _order: Order) -> str:
+        """
+        Signs the order
+        """
+        return prepend_zx(self.sign(self._create_struct_hash(_order)))
+
+    def build_signed_order(self, data: OrderData) -> SignedOrder:
+        """
+        Helper function to build and sign a order
+        """
+        order = self.build_order(data)
+        sig = self.build_order_signature(order)
+
+        return SignedOrder(order, sig)
+
+    def _validate_inputs(self, data: OrderData) -> bool:
+        return not (
+            # ensure required values exist
+            data.maker is None
+            or data.tokenId is None
+            or data.makerAmount is None
+            or data.takerAmount is None
+            or data.side is None
+            or data.side not in [BUY, SELL]
+            or not data.feeRateBps.isnumeric()
+            or int(data.feeRateBps) < 0
+            or not data.nonce.isnumeric()
+            or int(data.nonce) < 0
+            or not data.expiration.isnumeric()
+            or int(data.expiration) < 0
+            or data.signatureType is None
+            or data.signatureType not in [EOA, POLY_GNOSIS_SAFE, POLY_PROXY]
+        )

opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/chain/py_order_utils/builders/order_builder_test.py

@@ -0,0 +1,40 @@
+import unittest
+from .order_builder import OrderBuilder
+from ..model.order import OrderData
+from ..model.sides import BUY
+from ..model import signatures
+from ..constants import ZERO_ADDRESS
+from ..signer import Signer
+import json
+
+
+class TestInterfaces(unittest.TestCase):
+    def test_sign_order(self):
+        exchange_address = "0xF0aebf65490374a477100351291c736c73c11D9F"
+        chain_id = 8453
+        # Test private key, please do not use the key in production env.
+        signer = Signer("0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80")
+        builder = OrderBuilder(exchange_address, chain_id, signer, lambda: 1)
+
+        print('signer address: {}'.format(signer.address()))
+        self.assertEqual(signer.address(), '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266', "invalid signer address")
+        # Create and sign the order
+        order = builder.build_signed_order(
+            OrderData(
+                maker='0x8edbd5d17f368a50a7f8c0b1bbc0c9fcd0c2ccb3',
+                taker=ZERO_ADDRESS,
+                tokenId='102955147056674320605625831094933410586073394253729381009399467166952809400644',
+                makerAmount='50',
+                takerAmount='100',
+                side=BUY,
+                feeRateBps='0',
+                signer=signer.address(),
+                signatureType=signatures.POLY_GNOSIS_SAFE,
+            )
+        )
+
+        # Generate the Order and Signature json to be sent to the CLOB API
+        print('order: {}'.format(json.dumps(order.dict())))
+        expected_signature = '0x4e2fbeb4959ddee243c682d2ebce61785cb03c1accb6b13a058df62d935ddf4941226aaa28dd1d71f150dc1708e9bfc22aab0bbb77690609e5692d2b7fd8ef3d1c'
+        self.assertEqual(order.signature, expected_signature, 'unexpected signature')
+

opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/chain/py_order_utils/constants.py

@@ -0,0 +1,2 @@
+ZX = "0x"
+ZERO_ADDRESS = "0x0000000000000000000000000000000000000000"

opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/chain/py_order_utils/model/order.py

@@ -0,0 +1,254 @@
+from dataclasses import dataclass
+
+from ..constants import ZERO_ADDRESS
+from .signatures import EOA
+from poly_eip712_structs import Address, EIP712Struct, Uint
+
+
+@dataclass
+class OrderDataInput:
+    marketId: int = None
+    """
+    MarketId / TopicId of Given Market
+    """
+
+    tokenId: str = None
+    """
+    Token Id of the CTF ERC1155 asset to be bought or sold.
+    If BUY, this is the tokenId of the asset to be bought, i.e the makerAssetId
+    If SELL, this is the tokenId of the asset to be sold, i.e the  takerAssetId
+    """
+
+    makerAmount: str = None
+    """
+    Maker amount, i.e the max amount of tokens to be sold
+    """
+
+    price: str = None
+    """
+    Price of the token, 2 digits allowed. i.e 0.5 for 50c of token price or 0.49 for 49c of token price
+    """
+
+    side: int = None
+    """
+    The side of the order, BUY or SELL
+    """
+
+    orderType: int = None
+    """
+    1 for Market Order, 2 for Limit Order
+    """
+
+@dataclass
+class PlaceOrderDataInput:
+    marketId: int = None
+    """
+    MarketId / TopicId of Given Market
+    """
+
+    tokenId: str = None
+    """
+    Token Id of the CTF ERC1155 asset to be bought or sold.
+    If BUY, this is the tokenId of the asset to be bought, i.e the makerAssetId
+    If SELL, this is the tokenId of the asset to be sold, i.e the  takerAssetId
+    """
+
+    makerAmountInQuoteToken: str = None
+    """
+    Maker amount of quote/collateral token, i.e 500 usdc
+    """
+    
+    makerAmountInBaseToken: str = None
+    """
+    Maker amount of base/conditional token, i.e 500 yes token
+    """
+
+    price: str = None
+    """
+    Price of the token, 2 digits allowed. i.e 0.5 for 50c of token price or 0.49 for 49c of token price
+    """
+
+    side: int = None
+    """
+    The side of the order, BUY or SELL
+    """
+
+    orderType: int = None
+    """
+    1 for Market Order, 2 for Limit Order
+    """
+
+@dataclass
+class OrderData:
+    """
+    Inputs to generate orders
+    """
+
+    maker: str = None
+    """
+    Maker of the order, i.e the source of funds for the order
+    """
+
+    taker: str = ZERO_ADDRESS
+    """
+    Address of the order taker. The zero address is used to indicate a public order
+    """
+
+    tokenId: str = None
+    """
+    Token Id of the CTF ERC1155 asset to be bought or sold.
+    If BUY, this is the tokenId of the asset to be bought, i.e the makerAssetId
+    If SELL, this is the tokenId of the asset to be sold, i.e the  takerAssetId
+    """
+
+    makerAmount: str = None
+    """
+    Maker amount, i.e the max amount of tokens to be sold
+    """
+
+    takerAmount: str = None
+    """
+    Taker amount, i.e the minimum amount of tokens to be received
+    """
+
+    side: int = None
+    """
+    The side of the order, BUY or SELL
+    """
+
+    feeRateBps: str = None
+    """
+    Fee rate, in basis points, charged to the order maker, charged on proceeds
+    """
+
+    nonce: str = "0"
+    """
+    Nonce used for onchain cancellations
+    """
+
+    signer: str = None
+    """
+    Signer of the order. Optional, if it is not present the signer is the maker of the order.
+    """
+
+    expiration: str = "0"
+    """
+    Timestamp after which the order is expired.
+    Optional, if it is not present the value is '0' (no expiration)
+    """
+
+    signatureType: int = EOA
+    """
+    Signature type used by the Order. Default value 'EOA'
+    """
+
+
+class Order(EIP712Struct):
+    """
+    Order
+    """
+
+    # NOTE: Important to keep in mind, fields are ordered
+
+    salt = Uint(256)
+    """
+    Unique salt to ensure entropy
+    """
+
+    maker = Address()
+    """
+    Maker of the order, i.e the source of funds for the order
+    """
+
+    signer = Address()
+    """
+    Signer of the order
+    """
+
+    taker = Address()
+    """
+    Address of the order taker. The zero address is used to indicate a public order
+    """
+
+    tokenId = Uint(256)
+    """
+    Token Id of the CTF ERC1155 asset to be bought or sold.
+    If BUY, this is the tokenId of the asset to be bought, i.e the makerAssetId
+    If SELL, this is the tokenId of the asset to be sold, i.e the  takerAssetId
+    """
+
+    makerAmount = Uint(256)
+    """
+    Maker amount, i.e the max amount of tokens to be sold
+    """
+
+    takerAmount = Uint(256)
+    """
+    Taker amount, i.e the minimum amount of tokens to be received
+    """
+
+    expiration = Uint(256)
+    """
+    Timestamp after which the order is expired
+    """
+
+    nonce = Uint(256)
+    """
+    Nonce used for onchain cancellations
+    """
+
+    feeRateBps = Uint(256)
+    """
+    Fee rate, in basis points, charged to the order maker, charged on proceeds
+    """
+
+    side = Uint(8)
+    """
+    The side of the order, BUY or SELL
+    """
+
+    signatureType = Uint(8)
+    """
+    Signature type used by the Order
+    """
+
+    def dict(self):
+        return {
+            "salt": self["salt"],
+            "maker": self["maker"],
+            "signer": self["signer"],
+            "taker": self["taker"],
+            "tokenId": self["tokenId"],
+            "makerAmount": self["makerAmount"],
+            "takerAmount": self["takerAmount"],
+            "expiration": self["expiration"],
+            "nonce": self["nonce"],
+            "feeRateBps": self["feeRateBps"],
+            "side": self["side"],
+            "signatureType": self["signatureType"],
+        }
+
+
+@dataclass
+class SignedOrder:
+    """
+    Order + Signature
+    """
+
+    order: Order
+    signature: str
+
+    def dict(self):
+        d = self.order.dict()
+        d["signature"] = self.signature
+        if d["side"] == 0:
+            d["side"] = "BUY"
+        else:
+            d["side"] = "SELL"
+        d["expiration"] = str(d["expiration"])
+        d["nonce"] = str(d["nonce"])
+        d["feeRateBps"] = str(d["feeRateBps"])
+        d["makerAmount"] = str(d["makerAmount"])
+        d["takerAmount"] = str(d["takerAmount"])
+        d["tokenId"] = str(d["tokenId"])
+        return d

opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/chain/py_order_utils/model/order_type.py

@@ -0,0 +1,9 @@
+from enum import IntEnum  # Changed from Enum to IntEnum
+
+class OrderType(IntEnum):  # Inherits from IntEnum
+    MARKET_ORDER = 1
+    LIMIT_ORDER = 2
+
+LIMIT_ORDER = 2
+MARKET_ORDER = 1
+

opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/chain/py_order_utils/model/sides.py

@@ -0,0 +1,8 @@
+from enum import IntEnum  # Changed from Enum to IntEnum
+
+class OrderSide(IntEnum):  # Inherits from IntEnum
+    BUY = 0
+    SELL = 1
+
+BUY = OrderSide.BUY
+SELL = OrderSide.SELL

opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/chain/py_order_utils/model/signatures.py

@@ -0,0 +1,8 @@
+# ECDSA EIP712 signatures signed by EOAs
+EOA = 0
+
+# EIP712 signatures signed by EOAs that own Polymarket Proxy wallets
+POLY_PROXY = 1
+
+# EIP712 signatures signed by EOAs that own Polymarket Gnosis safes
+POLY_GNOSIS_SAFE = 2

opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/opinion_clob_sdk/chain/py_order_utils/signer.py

@@ -0,0 +1,20 @@
+from eth_account import Account
+
+
+class Signer:
+    """
+    Signs orders using a private key
+    """
+
+    def __init__(self, key: str):
+        self._key = key
+        self.account = Account.from_key(key)
+
+    def sign(self, struct_hash) -> str:
+        """
+        Signs an EIP712 struct hash
+        """
+        return Account._sign_hash(struct_hash, self._key).signature.hex()
+
+    def address(self) -> str:
+        return self.account.address