afp-sdk 0.5.3__py3-none-any.whl → 0.6.0__py3-none-any.whl

afp/bindings/facade.py

@@ -5,14 +5,15 @@ from eth_typing.evm import ChecksumAddress
 from web3 import Web3
 
 from . import (
-    auctioneer_facet,
-    bankruptcy_facet,
+    admin_facet,
     clearing_facet,
     final_settlement_facet,
+    margin_account_facet,
     margin_account_registry,
     mark_price_tracker_facet,
     oracle_provider,
     product_registry,
+    product_registry_facet,
     system_viewer,
 )
 from ..constants import defaults
@@ -23,21 +24,23 @@ from ..constants import defaults
 
 CLEARING_DIAMOND_ABI = list(
     chain(
-        auctioneer_facet.ABI,
-        bankruptcy_facet.ABI,
+        admin_facet.ABI,
         clearing_facet.ABI,
         final_settlement_facet.ABI,
+        margin_account_facet.ABI,
         mark_price_tracker_facet.ABI,
+        product_registry_facet.ABI,
     )
 )
 
 
 class ClearingDiamond(
-    auctioneer_facet.AuctioneerFacet,
-    bankruptcy_facet.BankruptcyFacet,
+    admin_facet.AdminFacet,
     clearing_facet.ClearingFacet,
     final_settlement_facet.FinalSettlementFacet,
+    margin_account_facet.MarginAccountFacet,
     mark_price_tracker_facet.MarkPriceTrackerFacet,
+    product_registry_facet.ProductRegistryFacet,
 ):
     """ClearingDiamond contract binding.
 

afp/bindings/final_settlement_facet.py

@@ -7,6 +7,7 @@ import typing
 import eth_typing
 import hexbytes
 import web3
+from web3 import types
 from web3.contract import contract
 
 
@@ -37,33 +38,44 @@ class FinalSettlementFacet:
         """Binding for `event FSPFinalized` on the FinalSettlementFacet contract."""
         return self._contract.events.FSPFinalized
 
+    @property
+    def FeeCollected(self) -> contract.ContractEvent:
+        """Binding for `event FeeCollected` on the FinalSettlementFacet contract."""
+        return self._contract.events.FeeCollected
+
+    @property
+    def FeeDispersed(self) -> contract.ContractEvent:
+        """Binding for `event FeeDispersed` on the FinalSettlementFacet contract."""
+        return self._contract.events.FeeDispersed
+
     @property
     def FinalSettlementCloseout(self) -> contract.ContractEvent:
         """Binding for `event FinalSettlementCloseout` on the FinalSettlementFacet contract."""
         return self._contract.events.FinalSettlementCloseout
 
-    def closeout_fee_rate(
-        self,
-    ) -> int:
-        """Binding for `CLOSEOUT_FEE_RATE` on the FinalSettlementFacet contract.
-
-        Returns
-        -------
-        int
-        """
-        return_value = self._contract.functions.CLOSEOUT_FEE_RATE().call()
-        return int(return_value)
+    @property
+    def PositionUpdated(self) -> contract.ContractEvent:
+        """Binding for `event PositionUpdated` on the FinalSettlementFacet contract."""
+        return self._contract.events.PositionUpdated
 
-    def closeout_reward_rate(
+    def final_settlement_id(
         self,
+        block_identifier: types.BlockIdentifier = "latest",
     ) -> int:
-        """Binding for `CLOSEOUT_REWARD_RATE` on the FinalSettlementFacet contract.
+        """Binding for `FINAL_SETTLEMENT_ID` on the FinalSettlementFacet contract.
+
+        Parameters
+        ----------
+        block_identifier : web3.types.BlockIdentifier
+            The block identifier, defaults to the latest block.
 
         Returns
         -------
         int
         """
-        return_value = self._contract.functions.CLOSEOUT_REWARD_RATE().call()
+        return_value = self._contract.functions.FINAL_SETTLEMENT_ID().call(
+            block_identifier=block_identifier
+        )
         return int(return_value)
 
     def finalize_fsp(
@@ -88,12 +100,15 @@ class FinalSettlementFacet:
     def get_fsp(
         self,
         product_id: hexbytes.HexBytes,
+        block_identifier: types.BlockIdentifier = "latest",
     ) -> typing.Tuple[int, bool]:
         """Binding for `getFsp` on the FinalSettlementFacet contract.
 
         Parameters
         ----------
         product_id : hexbytes.HexBytes
+        block_identifier : web3.types.BlockIdentifier
+            The block identifier, defaults to the latest block.
 
         Returns
         -------
@@ -102,12 +117,34 @@ class FinalSettlementFacet:
         """
         return_value = self._contract.functions.getFsp(
             product_id,
-        ).call()
+        ).call(block_identifier=block_identifier)
         return (
             int(return_value[0]),
             bool(return_value[1]),
         )
 
+    def get_fsp_finalization_time(
+        self,
+        product_id: hexbytes.HexBytes,
+        block_identifier: types.BlockIdentifier = "latest",
+    ) -> int:
+        """Binding for `getFspFinalizationTime` on the FinalSettlementFacet contract.
+
+        Parameters
+        ----------
+        product_id : hexbytes.HexBytes
+        block_identifier : web3.types.BlockIdentifier
+            The block identifier, defaults to the latest block.
+
+        Returns
+        -------
+        int
+        """
+        return_value = self._contract.functions.getFspFinalizationTime(
+            product_id,
+        ).call(block_identifier=block_identifier)
+        return int(return_value)
+
     def initiate_final_settlement(
         self,
         product_id: hexbytes.HexBytes,
@@ -133,12 +170,15 @@ class FinalSettlementFacet:
     def open_interest(
         self,
         product_id: hexbytes.HexBytes,
+        block_identifier: types.BlockIdentifier = "latest",
     ) -> int:
         """Binding for `openInterest` on the FinalSettlementFacet contract.
 
         Parameters
         ----------
         product_id : hexbytes.HexBytes
+        block_identifier : web3.types.BlockIdentifier
+            The block identifier, defaults to the latest block.
 
         Returns
         -------
@@ -146,7 +186,7 @@ class FinalSettlementFacet:
         """
         return_value = self._contract.functions.openInterest(
             product_id,
-        ).call()
+        ).call(block_identifier=block_identifier)
         return int(return_value)
 
 
@@ -154,169 +194,288 @@ ABI = typing.cast(
     eth_typing.ABI,
     [
         {
-            "inputs": [
-                {"internalType": "bytes32", "name": "productId", "type": "bytes32"}
-            ],
-            "name": "FSPAlreadyFinalized",
-            "type": "error",
+            "type": "function",
+            "name": "FINAL_SETTLEMENT_ID",
+            "inputs": [],
+            "outputs": [{"name": "", "type": "uint256", "internalType": "uint256"}],
+            "stateMutability": "view",
         },
         {
+            "type": "function",
+            "name": "finalizeFsp",
             "inputs": [
-                {"internalType": "bytes32", "name": "productId", "type": "bytes32"}
+                {"name": "productID", "type": "bytes32", "internalType": "bytes32"}
             ],
-            "name": "FSPNotFound",
-            "type": "error",
+            "outputs": [{"name": "", "type": "int256", "internalType": "int256"}],
+            "stateMutability": "nonpayable",
         },
         {
+            "type": "function",
+            "name": "getFsp",
             "inputs": [
-                {"internalType": "bytes32", "name": "productId", "type": "bytes32"},
-                {"internalType": "uint256", "name": "currentTime", "type": "uint256"},
-                {
-                    "internalType": "uint256",
-                    "name": "earliestFSPSubmissionTime",
-                    "type": "uint256",
-                },
+                {"name": "productId", "type": "bytes32", "internalType": "bytes32"}
             ],
-            "name": "FSPTimeNotReached",
-            "type": "error",
+            "outputs": [
+                {"name": "fsp", "type": "int256", "internalType": "int256"},
+                {"name": "finalized", "type": "bool", "internalType": "bool"},
+            ],
+            "stateMutability": "view",
         },
         {
+            "type": "function",
+            "name": "getFspFinalizationTime",
             "inputs": [
-                {"internalType": "address", "name": "fspAccount", "type": "address"}
+                {"name": "productId", "type": "bytes32", "internalType": "bytes32"}
             ],
-            "name": "InvalidFSPAccount",
-            "type": "error",
+            "outputs": [{"name": "", "type": "uint256", "internalType": "uint256"}],
+            "stateMutability": "view",
         },
         {
+            "type": "function",
+            "name": "initiateFinalSettlement",
             "inputs": [
-                {"internalType": "address", "name": "oracleAddress", "type": "address"}
+                {"name": "productID", "type": "bytes32", "internalType": "bytes32"},
+                {"name": "accounts", "type": "address[]", "internalType": "address[]"},
             ],
-            "name": "InvalidOracleAddress",
-            "type": "error",
+            "outputs": [],
+            "stateMutability": "nonpayable",
         },
         {
+            "type": "function",
+            "name": "openInterest",
             "inputs": [
-                {"internalType": "string", "name": "paramName", "type": "string"}
+                {"name": "productId", "type": "bytes32", "internalType": "bytes32"}
             ],
-            "name": "InvalidParameter",
-            "type": "error",
+            "outputs": [{"name": "", "type": "uint256", "internalType": "uint256"}],
+            "stateMutability": "view",
         },
         {
+            "type": "event",
+            "name": "FSPFinalized",
             "inputs": [
-                {"internalType": "int256", "name": "checksum", "type": "int256"},
                 {
-                    "internalType": "int256",
-                    "name": "expectedChecksum",
+                    "name": "productID",
+                    "type": "bytes32",
+                    "indexed": True,
+                    "internalType": "bytes32",
+                },
+                {
+                    "name": "fsp",
                     "type": "int256",
+                    "indexed": False,
+                    "internalType": "int256",
                 },
             ],
-            "name": "MismatchedFSPAccountQuantities",
-            "type": "error",
+            "anonymous": False,
         },
         {
+            "type": "event",
+            "name": "FeeCollected",
             "inputs": [
-                {"internalType": "bytes32", "name": "productId", "type": "bytes32"}
+                {
+                    "name": "marginAccountId",
+                    "type": "address",
+                    "indexed": True,
+                    "internalType": "address",
+                },
+                {
+                    "name": "capitalAmount",
+                    "type": "int256",
+                    "indexed": False,
+                    "internalType": "int256",
+                },
+                {
+                    "name": "id",
+                    "type": "uint256",
+                    "indexed": False,
+                    "internalType": "uint256",
+                },
             ],
-            "name": "ProductNotInFinalSettlement",
-            "type": "error",
+            "anonymous": False,
         },
         {
-            "anonymous": False,
+            "type": "event",
+            "name": "FeeDispersed",
             "inputs": [
                 {
+                    "name": "recipient",
+                    "type": "address",
                     "indexed": True,
-                    "internalType": "bytes32",
-                    "name": "productID",
-                    "type": "bytes32",
+                    "internalType": "address",
                 },
                 {
+                    "name": "capitalAmount",
+                    "type": "int256",
                     "indexed": False,
-                    "internalType": "uint256",
-                    "name": "fsp",
+                    "internalType": "int256",
+                },
+                {
+                    "name": "id",
                     "type": "uint256",
+                    "indexed": False,
+                    "internalType": "uint256",
                 },
             ],
-            "name": "FSPFinalized",
-            "type": "event",
+            "anonymous": False,
         },
         {
-            "anonymous": False,
+            "type": "event",
+            "name": "FinalSettlementCloseout",
             "inputs": [
                 {
-                    "indexed": True,
-                    "internalType": "bytes32",
                     "name": "productID",
                     "type": "bytes32",
+                    "indexed": True,
+                    "internalType": "bytes32",
                 },
                 {
-                    "indexed": False,
-                    "internalType": "uint256",
                     "name": "accountLength",
                     "type": "uint256",
+                    "indexed": False,
+                    "internalType": "uint256",
                 },
                 {
-                    "indexed": False,
-                    "internalType": "address",
                     "name": "closedBy",
                     "type": "address",
+                    "indexed": False,
+                    "internalType": "address",
                 },
             ],
-            "name": "FinalSettlementCloseout",
+            "anonymous": False,
+        },
+        {
             "type": "event",
+            "name": "PositionUpdated",
+            "inputs": [
+                {
+                    "name": "marginAccountId",
+                    "type": "address",
+                    "indexed": True,
+                    "internalType": "address",
+                },
+                {
+                    "name": "positionId",
+                    "type": "bytes32",
+                    "indexed": True,
+                    "internalType": "bytes32",
+                },
+                {
+                    "name": "costBasis",
+                    "type": "int256",
+                    "indexed": False,
+                    "internalType": "int256",
+                },
+                {
+                    "name": "price",
+                    "type": "int256",
+                    "indexed": False,
+                    "internalType": "int256",
+                },
+                {
+                    "name": "quantity",
+                    "type": "int256",
+                    "indexed": False,
+                    "internalType": "int256",
+                },
+                {
+                    "name": "id",
+                    "type": "uint256",
+                    "indexed": False,
+                    "internalType": "uint256",
+                },
+            ],
+            "anonymous": False,
         },
         {
-            "inputs": [],
-            "name": "CLOSEOUT_FEE_RATE",
-            "outputs": [{"internalType": "uint256", "name": "", "type": "uint256"}],
-            "stateMutability": "pure",
-            "type": "function",
+            "type": "error",
+            "name": "FSPAlreadyFinalized",
+            "inputs": [
+                {"name": "productId", "type": "bytes32", "internalType": "bytes32"}
+            ],
         },
         {
-            "inputs": [],
-            "name": "CLOSEOUT_REWARD_RATE",
-            "outputs": [{"internalType": "uint256", "name": "", "type": "uint256"}],
-            "stateMutability": "pure",
-            "type": "function",
+            "type": "error",
+            "name": "FSPNotFound",
+            "inputs": [
+                {"name": "productId", "type": "bytes32", "internalType": "bytes32"}
+            ],
         },
         {
+            "type": "error",
+            "name": "FSPTimeNotReached",
             "inputs": [
-                {"internalType": "bytes32", "name": "productID", "type": "bytes32"}
+                {"name": "productId", "type": "bytes32", "internalType": "bytes32"},
+                {"name": "currentTime", "type": "uint256", "internalType": "uint256"},
+                {
+                    "name": "earliestFSPSubmissionTime",
+                    "type": "uint256",
+                    "internalType": "uint256",
+                },
             ],
-            "name": "finalizeFsp",
-            "outputs": [{"internalType": "uint256", "name": "", "type": "uint256"}],
-            "stateMutability": "nonpayable",
-            "type": "function",
         },
         {
+            "type": "error",
+            "name": "InvalidFieldAccess",
             "inputs": [
-                {"internalType": "bytes32", "name": "productId", "type": "bytes32"}
+                {
+                    "name": "productType",
+                    "type": "uint8",
+                    "internalType": "enum ProductType",
+                },
+                {"name": "field", "type": "string", "internalType": "string"},
             ],
-            "name": "getFsp",
-            "outputs": [
-                {"internalType": "uint256", "name": "fsp", "type": "uint256"},
-                {"internalType": "bool", "name": "finalized", "type": "bool"},
+        },
+        {
+            "type": "error",
+            "name": "InvalidOracleAddress",
+            "inputs": [
+                {"name": "oracleAddress", "type": "address", "internalType": "address"}
             ],
-            "stateMutability": "view",
-            "type": "function",
         },
         {
+            "type": "error",
+            "name": "InvalidParameter",
             "inputs": [
-                {"internalType": "bytes32", "name": "productID", "type": "bytes32"},
-                {"internalType": "address[]", "name": "accounts", "type": "address[]"},
+                {"name": "paramName", "type": "string", "internalType": "string"}
             ],
-            "name": "initiateFinalSettlement",
-            "outputs": [],
-            "stateMutability": "nonpayable",
-            "type": "function",
         },
         {
+            "type": "error",
+            "name": "MAECheckFailed",
             "inputs": [
-                {"internalType": "bytes32", "name": "productId", "type": "bytes32"}
+                {"name": "marginAccount", "type": "address", "internalType": "address"}
             ],
-            "name": "openInterest",
-            "outputs": [{"internalType": "uint256", "name": "", "type": "uint256"}],
-            "stateMutability": "view",
-            "type": "function",
+        },
+        {
+            "type": "error",
+            "name": "MismatchedFSPAccountQuantities",
+            "inputs": [
+                {"name": "checksum", "type": "int256", "internalType": "int256"},
+                {
+                    "name": "expectedChecksum",
+                    "type": "int256",
+                    "internalType": "int256",
+                },
+            ],
+        },
+        {
+            "type": "error",
+            "name": "NotFound",
+            "inputs": [
+                {"name": "parameter", "type": "string", "internalType": "string"}
+            ],
+        },
+        {
+            "type": "error",
+            "name": "ProductNotInFinalSettlement",
+            "inputs": [
+                {"name": "productId", "type": "bytes32", "internalType": "bytes32"}
+            ],
+        },
+        {
+            "type": "error",
+            "name": "SafeCastOverflowedUintToInt",
+            "inputs": [{"name": "value", "type": "uint256", "internalType": "uint256"}],
         },
     ],
 )