nado-protocol 0.1.0__py3-none-any.whl

nado_protocol/contracts/abis/MockERC20.json

@@ -0,0 +1,311 @@
+[
+  {
+    "inputs": [
+      {
+        "internalType": "string",
+        "name": "name_",
+        "type": "string"
+      },
+      {
+        "internalType": "string",
+        "name": "symbol_",
+        "type": "string"
+      },
+      {
+        "internalType": "uint8",
+        "name": "decimals_",
+        "type": "uint8"
+      }
+    ],
+    "stateMutability": "nonpayable",
+    "type": "constructor"
+  },
+  {
+    "anonymous": false,
+    "inputs": [
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "owner",
+        "type": "address"
+      },
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "spender",
+        "type": "address"
+      },
+      {
+        "indexed": false,
+        "internalType": "uint256",
+        "name": "value",
+        "type": "uint256"
+      }
+    ],
+    "name": "Approval",
+    "type": "event"
+  },
+  {
+    "anonymous": false,
+    "inputs": [
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "from",
+        "type": "address"
+      },
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "to",
+        "type": "address"
+      },
+      {
+        "indexed": false,
+        "internalType": "uint256",
+        "name": "value",
+        "type": "uint256"
+      }
+    ],
+    "name": "Transfer",
+    "type": "event"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "owner",
+        "type": "address"
+      },
+      {
+        "internalType": "address",
+        "name": "spender",
+        "type": "address"
+      }
+    ],
+    "name": "allowance",
+    "outputs": [
+      {
+        "internalType": "uint256",
+        "name": "",
+        "type": "uint256"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "spender",
+        "type": "address"
+      },
+      {
+        "internalType": "uint256",
+        "name": "amount",
+        "type": "uint256"
+      }
+    ],
+    "name": "approve",
+    "outputs": [
+      {
+        "internalType": "bool",
+        "name": "",
+        "type": "bool"
+      }
+    ],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "account",
+        "type": "address"
+      }
+    ],
+    "name": "balanceOf",
+    "outputs": [
+      {
+        "internalType": "uint256",
+        "name": "",
+        "type": "uint256"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [],
+    "name": "decimals",
+    "outputs": [
+      {
+        "internalType": "uint8",
+        "name": "",
+        "type": "uint8"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "spender",
+        "type": "address"
+      },
+      {
+        "internalType": "uint256",
+        "name": "subtractedValue",
+        "type": "uint256"
+      }
+    ],
+    "name": "decreaseAllowance",
+    "outputs": [
+      {
+        "internalType": "bool",
+        "name": "",
+        "type": "bool"
+      }
+    ],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "spender",
+        "type": "address"
+      },
+      {
+        "internalType": "uint256",
+        "name": "addedValue",
+        "type": "uint256"
+      }
+    ],
+    "name": "increaseAllowance",
+    "outputs": [
+      {
+        "internalType": "bool",
+        "name": "",
+        "type": "bool"
+      }
+    ],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "account",
+        "type": "address"
+      },
+      {
+        "internalType": "uint256",
+        "name": "amount",
+        "type": "uint256"
+      }
+    ],
+    "name": "mint",
+    "outputs": [],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "inputs": [],
+    "name": "name",
+    "outputs": [
+      {
+        "internalType": "string",
+        "name": "",
+        "type": "string"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [],
+    "name": "symbol",
+    "outputs": [
+      {
+        "internalType": "string",
+        "name": "",
+        "type": "string"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [],
+    "name": "totalSupply",
+    "outputs": [
+      {
+        "internalType": "uint256",
+        "name": "",
+        "type": "uint256"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "to",
+        "type": "address"
+      },
+      {
+        "internalType": "uint256",
+        "name": "amount",
+        "type": "uint256"
+      }
+    ],
+    "name": "transfer",
+    "outputs": [
+      {
+        "internalType": "bool",
+        "name": "",
+        "type": "bool"
+      }
+    ],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "from",
+        "type": "address"
+      },
+      {
+        "internalType": "address",
+        "name": "to",
+        "type": "address"
+      },
+      {
+        "internalType": "uint256",
+        "name": "amount",
+        "type": "uint256"
+      }
+    ],
+    "name": "transferFrom",
+    "outputs": [
+      {
+        "internalType": "bool",
+        "name": "",
+        "type": "bool"
+      }
+    ],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  }
+]

nado_protocol/contracts/deployments/deployment.test.json

@@ -0,0 +1,18 @@
+{
+  "nodeUrl": "http://0.0.0.0:8545",
+  "publicNodeUrl": "http://0.0.0.0:8545",
+  "explorerUrl": "",
+  "startBlock": 0,
+  "deployer": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
+  "quote": "0x5FbDB2315678afecb367f032d93F642f64180aa3",
+  "querier": "0x4ed7c70F96B99c776995fB64377f0d4aB3B0e1C1",
+  "feeCalculator": "0xB7f8BC63BbcaD18155201308C8f3540b07f84F5e",
+  "clearinghouse": "0xa513E6E4b8f2a923D98304ec87F64353C4D5C853",
+  "clearinghouseLiq": "0xDc64a140Aa3E981100a9becA4E685f962f0cF6C9",
+  "endpoint": "0x8A791620dd6260079BF849Dc5567aDC3F2FdC318",
+  "spotEngine": "0x0DCd1Bf9A1b36cE34237eEaFef220932846BCD82",
+  "perpEngine": "0x0B306BF915C4d645ff596e518fAf3F9669b97016",
+  "vrtxAirdrop": "0x0000000000000000000000000000000000000000",
+  "vrtxStaking": "0x0000000000000000000000000000000000000000",
+  "foundationRewardsAirdrop": "0x0000000000000000000000000000000000000000"
+}

nado_protocol/contracts/eip712/__init__.py

@@ -0,0 +1,16 @@
+from nado_protocol.contracts.eip712.domain import *
+from nado_protocol.contracts.eip712.sign import *
+from nado_protocol.contracts.eip712.types import *
+
+
+__all__ = [
+    "get_nado_eip712_domain",
+    "get_eip712_domain_type",
+    "build_eip712_typed_data",
+    "get_eip712_typed_data_digest",
+    "sign_eip712_typed_data",
+    "get_nado_eip712_type",
+    "EIP712Domain",
+    "EIP712Types",
+    "EIP712TypedData",
+]

nado_protocol/contracts/eip712/domain.py

@@ -0,0 +1,36 @@
+from nado_protocol.contracts.eip712.types import EIP712Domain
+
+
+def get_nado_eip712_domain(verifying_contract: str, chain_id: int) -> EIP712Domain:
+    """
+    Util to create an EIP712Domain instance specific to Nado.
+
+    Args:
+        verifying_contract (str): The address of the contract that will verify the EIP-712 signature.
+
+        chain_id (int): The chain ID of the originating network.
+
+    Returns:
+        EIP712Domain: An instance of EIP712Domain with name set to "Nado", version "0.0.1", and the provided verifying contract and chain ID.
+    """
+    return EIP712Domain(
+        name="Nado",
+        version="0.0.1",
+        verifyingContract=verifying_contract,
+        chainId=chain_id,
+    )
+
+
+def get_eip712_domain_type() -> list[dict[str, str]]:
+    """
+    Util to return the structure of an EIP712Domain as per EIP-712.
+
+    Returns:
+        dict: A list of dictionaries each containing the name and type of a field in EIP712Domain.
+    """
+    return [
+        {"name": "name", "type": "string"},
+        {"name": "version", "type": "string"},
+        {"name": "chainId", "type": "uint256"},
+        {"name": "verifyingContract", "type": "address"},
+    ]

nado_protocol/contracts/eip712/sign.py

@@ -0,0 +1,79 @@
+from eth_account.signers.local import LocalAccount
+from nado_protocol.contracts.eip712.domain import (
+    get_eip712_domain_type,
+    get_nado_eip712_domain,
+)
+from nado_protocol.contracts.eip712.types import (
+    EIP712TypedData,
+    EIP712Types,
+    get_nado_eip712_type,
+)
+from eth_account.messages import encode_structured_data, _hash_eip191_message
+
+from nado_protocol.contracts.types import NadoTxType
+
+
+def build_eip712_typed_data(
+    tx: NadoTxType, msg: dict, verifying_contract: str, chain_id: int
+) -> EIP712TypedData:
+    """
+    Util to build EIP712 typed data for Nado execution.
+
+    Args:
+        tx (NadoTxType): The Nado tx type being signed.
+
+        msg (dict): The message being signed.
+
+        verifying_contract (str): The contract that will verify the signature.
+
+        chain_id (int): The chain ID of the originating network.
+
+    Returns:
+        EIP712TypedData: A structured data object that adheres to the EIP-712 standard.
+    """
+    eip17_domain = get_nado_eip712_domain(verifying_contract, chain_id)
+    eip712_tx_type = get_nado_eip712_type(tx)
+    eip712_primary_type = list(eip712_tx_type.keys())[0]
+    eip712_types = EIP712Types(
+        **{
+            "EIP712Domain": get_eip712_domain_type(),
+            **eip712_tx_type,
+        }
+    )
+    return EIP712TypedData(
+        domain=eip17_domain,
+        primaryType=eip712_primary_type,
+        types=eip712_types,
+        message=msg,
+    )
+
+
+def get_eip712_typed_data_digest(typed_data: EIP712TypedData) -> str:
+    """
+    Util to get the EIP-712 typed data hash.
+
+    Args:
+        typed_data (EIP712TypedData): The EIP-712 typed data to hash.
+
+    Returns:
+        str: The hexadecimal representation of the hash.
+    """
+    encoded_data = encode_structured_data(typed_data.dict())
+    return f"0x{_hash_eip191_message(encoded_data).hex()}"
+
+
+def sign_eip712_typed_data(typed_data: EIP712TypedData, signer: LocalAccount) -> str:
+    """
+    Util to sign EIP-712 typed data using a local Ethereum account.
+
+    Args:
+        typed_data (EIP712TypedData): The EIP-712 typed data to sign.
+
+        signer (LocalAccount): The local Ethereum account to sign the data.
+
+    Returns:
+        str: The hexadecimal representation of the signature.
+    """
+    encoded_data = encode_structured_data(typed_data.dict())
+    typed_data_hash = signer.sign_message(encoded_data)
+    return typed_data_hash.signature.hex()

nado_protocol/contracts/eip712/types.py

@@ -0,0 +1,154 @@
+from pydantic import BaseModel
+from nado_protocol.contracts.types import NadoTxType
+
+
+class EIP712Domain(BaseModel):
+    """
+    Model that represents the EIP-712 Domain data structure.
+
+    Attributes:
+        name (str): The user-readable name of the signing domain, i.e., the name of the DApp or the protocol.
+        version (str): The current major version of the signing domain. Signatures from different versions are not compatible.
+        chainId (int): The chain ID of the originating network.
+        verifyingContract (str): The address of the contract that will verify the signature.
+    """
+
+    name: str
+    version: str
+    chainId: int
+    verifyingContract: str
+
+
+class EIP712Types(BaseModel):
+    """
+    Util to encapsulate the EIP-712 type data structure.
+
+    Attributes:
+        EIP712Domain (list[dict]): A list of dictionaries representing EIP-712 Domain data.
+    """
+
+    EIP712Domain: list[dict]
+
+    class Config:
+        arbitrary_types_allowed = True
+        extra = "allow"
+
+
+class EIP712TypedData(BaseModel):
+    """
+    Util to represent the EIP-712 Typed Data structure.
+
+    Attributes:
+        types (EIP712Types): EIP-712 type data.
+        primaryType (str): The primary type for EIP-712 message signing.
+        domain (EIP712Domain): The domain data of the EIP-712 typed message.
+        message (dict): The actual data to sign.
+    """
+
+    types: EIP712Types
+    primaryType: str
+    domain: EIP712Domain
+    message: dict
+
+
+def get_nado_eip712_type(tx: NadoTxType) -> dict:
+    """
+    Util that provides the EIP712 type information for Nado execute types.
+
+    Args:
+        tx (NadoTxType): The Nado transaction type for which to retrieve EIP712 type information.
+
+    Returns:
+        dict: A dictionary containing the EIP712 type information for the given execute type.
+    """
+    return {
+        NadoTxType.PLACE_ORDER: {
+            "Order": [
+                {"name": "sender", "type": "bytes32"},
+                {"name": "priceX18", "type": "int128"},
+                {"name": "amount", "type": "int128"},
+                {"name": "expiration", "type": "uint64"},
+                {"name": "nonce", "type": "uint64"},
+            ]
+        },
+        NadoTxType.PLACE_ISOLATED_ORDER: {
+            "IsolatedOrder": [
+                {"name": "sender", "type": "bytes32"},
+                {"name": "priceX18", "type": "int128"},
+                {"name": "amount", "type": "int128"},
+                {"name": "expiration", "type": "uint64"},
+                {"name": "nonce", "type": "uint64"},
+                {"name": "margin", "type": "int128"},
+            ]
+        },
+        NadoTxType.CANCEL_ORDERS: {
+            "Cancellation": [
+                {"name": "sender", "type": "bytes32"},
+                {"name": "productIds", "type": "uint32[]"},
+                {"name": "digests", "type": "bytes32[]"},
+                {"name": "nonce", "type": "uint64"},
+            ]
+        },
+        NadoTxType.CANCEL_PRODUCT_ORDERS: {
+            "CancellationProducts": [
+                {"name": "sender", "type": "bytes32"},
+                {"name": "productIds", "type": "uint32[]"},
+                {"name": "nonce", "type": "uint64"},
+            ],
+        },
+        NadoTxType.WITHDRAW_COLLATERAL: {
+            "WithdrawCollateral": [
+                {"name": "sender", "type": "bytes32"},
+                {"name": "productId", "type": "uint32"},
+                {"name": "amount", "type": "uint128"},
+                {"name": "nonce", "type": "uint64"},
+            ]
+        },
+        NadoTxType.LIQUIDATE_SUBACCOUNT: {
+            "LiquidateSubaccount": [
+                {"name": "sender", "type": "bytes32"},
+                {"name": "liquidatee", "type": "bytes32"},
+                {"name": "productId", "type": "uint32"},
+                {"name": "isEncodedSpread", "type": "bool"},
+                {"name": "amount", "type": "int128"},
+                {"name": "nonce", "type": "uint64"},
+            ],
+        },
+        NadoTxType.MINT_LP: {
+            "MintLp": [
+                {"name": "sender", "type": "bytes32"},
+                {"name": "productId", "type": "uint32"},
+                {"name": "amountBase", "type": "uint128"},
+                {"name": "quoteAmountLow", "type": "uint128"},
+                {"name": "quoteAmountHigh", "type": "uint128"},
+                {"name": "nonce", "type": "uint64"},
+            ]
+        },
+        NadoTxType.BURN_LP: {
+            "BurnLp": [
+                {"name": "sender", "type": "bytes32"},
+                {"name": "productId", "type": "uint32"},
+                {"name": "amount", "type": "uint128"},
+                {"name": "nonce", "type": "uint64"},
+            ]
+        },
+        NadoTxType.LINK_SIGNER: {
+            "LinkSigner": [
+                {"name": "sender", "type": "bytes32"},
+                {"name": "signer", "type": "bytes32"},
+                {"name": "nonce", "type": "uint64"},
+            ]
+        },
+        NadoTxType.AUTHENTICATE_STREAM: {
+            "StreamAuthentication": [
+                {"name": "sender", "type": "bytes32"},
+                {"name": "expiration", "type": "uint64"},
+            ]
+        },
+        NadoTxType.LIST_TRIGGER_ORDERS: {
+            "ListTriggerOrders": [
+                {"name": "sender", "type": "bytes32"},
+                {"name": "recvTime", "type": "uint64"},
+            ]
+        },
+    }[tx]

nado_protocol/contracts/loader.py

@@ -0,0 +1,55 @@
+import json
+from pathlib import Path
+from nado_protocol.contracts.types import (
+    NadoAbiName,
+    NadoDeployment,
+    NadoNetwork,
+)
+from nado_protocol.utils.model import ensure_data_type, parse_enum_value
+
+
+def load_abi(abi_name: NadoAbiName) -> list[dict]:
+    """
+    Load the Application Binary Interface (ABI) for a given contract.
+
+    Args:
+        abi_name (NadoAbiName): The name of the contract for which the ABI is loaded.
+
+    Returns:
+        list[dict]: A list of dictionaries representing the ABI of the contract.
+    """
+    file_path = Path(__file__).parent / "abis" / f"{parse_enum_value(abi_name)}.json"
+    return ensure_data_type(_load_json(file_path), list)
+
+
+def load_deployment(network: NadoNetwork) -> NadoDeployment:
+    """
+    Load the deployment data for a given network.
+
+    Args:
+        network (NadoNetwork): The network for which the deployment data is loaded.
+
+    Returns:
+        NadoDeployment: An instance of NadoDeployment containing the loaded deployment data.
+    """
+    file_path = (
+        Path(__file__).parent
+        / "deployments"
+        / f"deployment.{parse_enum_value(network)}.json"
+    )
+    return NadoDeployment(**_load_json(file_path))
+
+
+def _load_json(file_path: Path) -> dict:
+    """
+    Load a JSON file.
+
+    Args:
+        file_path (Path): The path to the JSON file.
+
+    Returns:
+        dict: The content of the JSON file as a dictionary.
+    """
+    with open(file_path, "r") as f:
+        data = json.load(f)
+    return data