from pydantic import BaseModel
from vertex_protocol.contracts.types import VertexTxType
[docs]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
[docs]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]
[docs] class Config:
arbitrary_types_allowed = True
extra = "allow"
[docs]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
[docs]def get_vertex_eip712_type(tx: VertexTxType) -> dict:
"""
Util that provides the EIP712 type information for Vertex execute types.
Args:
tx (VertexTxType): The Vertex transaction type for which to retrieve EIP712 type information.
Returns:
dict: A dictionary containing the EIP712 type information for the given execute type.
"""
return {
VertexTxType.PLACE_ORDER: {
"Order": [
{"name": "sender", "type": "bytes32"},
{"name": "priceX18", "type": "int128"},
{"name": "amount", "type": "int128"},
{"name": "expiration", "type": "uint64"},
{"name": "nonce", "type": "uint64"},
]
},
VertexTxType.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"},
]
},
VertexTxType.CANCEL_ORDERS: {
"Cancellation": [
{"name": "sender", "type": "bytes32"},
{"name": "productIds", "type": "uint32[]"},
{"name": "digests", "type": "bytes32[]"},
{"name": "nonce", "type": "uint64"},
]
},
VertexTxType.CANCEL_PRODUCT_ORDERS: {
"CancellationProducts": [
{"name": "sender", "type": "bytes32"},
{"name": "productIds", "type": "uint32[]"},
{"name": "nonce", "type": "uint64"},
],
},
VertexTxType.WITHDRAW_COLLATERAL: {
"WithdrawCollateral": [
{"name": "sender", "type": "bytes32"},
{"name": "productId", "type": "uint32"},
{"name": "amount", "type": "uint128"},
{"name": "nonce", "type": "uint64"},
]
},
VertexTxType.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"},
],
},
VertexTxType.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"},
]
},
VertexTxType.BURN_LP: {
"BurnLp": [
{"name": "sender", "type": "bytes32"},
{"name": "productId", "type": "uint32"},
{"name": "amount", "type": "uint128"},
{"name": "nonce", "type": "uint64"},
]
},
VertexTxType.LINK_SIGNER: {
"LinkSigner": [
{"name": "sender", "type": "bytes32"},
{"name": "signer", "type": "bytes32"},
{"name": "nonce", "type": "uint64"},
]
},
VertexTxType.AUTHENTICATE_STREAM: {
"StreamAuthentication": [
{"name": "sender", "type": "bytes32"},
{"name": "expiration", "type": "uint64"},
]
},
VertexTxType.LIST_TRIGGER_ORDERS: {
"ListTriggerOrders": [
{"name": "sender", "type": "bytes32"},
{"name": "recvTime", "type": "uint64"},
]
},
}[tx]