Remove exclusions from Makefile because they will come from NatSpec docs

The functions to be excluded with be tagged with the @Custom:exclude
natspec tag, which are handled by pyabigen.

Author: szemate

Makefile

@@ -2,57 +2,40 @@ VERSION := $(shell cat AUTONITY_VERSION)
 AUTONITY := build/autonity
 ABIDIR := $(AUTONITY)/params/generated
 OUTDIR := autonity/contracts
-ABIGEN = hatch run generate:pyabigen \
-			--srcdir $(AUTONITY)/autonity/solidity/contracts \
-			--version $(VERSION) \
-			--userdoc $(word 2,$(1)) \
-			--devdoc $(word 3,$(1)) \
-			$(word 1,$(1))
 
-all: $(OUTDIR)/accountability.py \
-	 $(OUTDIR)/acu.py \
-	 $(OUTDIR)/autonity.py \
-	 $(OUTDIR)/ierc20.py \
-	 $(OUTDIR)/inflation_controller.py \
-	 $(OUTDIR)/liquid.py \
-	 $(OUTDIR)/non_stakable_vesting.py \
-	 $(OUTDIR)/oracle.py \
-	 $(OUTDIR)/stabilization.py \
-	 $(OUTDIR)/supply_control.py \
-	 $(OUTDIR)/upgrade_manager.py
+BINDINGS := $(OUTDIR)/accountability.py \
+	$(OUTDIR)/acu.py \
+	$(OUTDIR)/autonity.py \
+	$(OUTDIR)/ierc20.py \
+	$(OUTDIR)/inflation_controller.py \
+	$(OUTDIR)/liquid.py \
+	$(OUTDIR)/non_stakable_vesting.py \
+	$(OUTDIR)/oracle.py \
+	$(OUTDIR)/stabilization.py \
+	$(OUTDIR)/supply_control.py \
+	$(OUTDIR)/upgrade_manager.py
 
-$(OUTDIR)/accountability.py: $(addprefix $(ABIDIR)/Accountability,.abi .docuser .docdev)
-	$(call ABIGEN,$^) --exclude distributeRewards,finalize,setEpochPeriod >$@
+all: $(BINDINGS)
 
+$(OUTDIR)/accountability.py: $(addprefix $(ABIDIR)/Accountability,.abi .docuser .docdev)
 $(OUTDIR)/acu.py: $(addprefix $(ABIDIR)/ACU,.abi .docuser .docdev)
-	$(call ABIGEN,$^) --exclude setOperator,setOracle,update >$@
-
 $(OUTDIR)/autonity.py: $(addprefix $(ABIDIR)/Autonity,.abi .docuser .docdev)
-	$(call ABIGEN,$^) --exclude computeCommittee,finalize,finalizeInitialization >$@
-
 $(OUTDIR)/ierc20.py: $(addprefix $(ABIDIR)/IERC20,.abi .docuser .docdev)
-	$(call ABIGEN,$^) >$@
-
 $(OUTDIR)/inflation_controller.py: $(addprefix $(ABIDIR)/InflationController,.abi .docuser .docdev)
-	$(call ABIGEN,$^) >$@
-
 $(OUTDIR)/liquid.py: $(addprefix $(ABIDIR)/Liquid,.abi .docuser .docdev)
-	$(call ABIGEN,$^) --exclude burn,lock,mint,redistribute,setCommissionRate,unlock >$@
-
 $(OUTDIR)/non_stakable_vesting.py: $(addprefix $(ABIDIR)/NonStakableVesting,.abi .docuser .docdev)
-	$(call ABIGEN,$^) --exclude unlockTokens >$@
-
 $(OUTDIR)/oracle.py: $(addprefix $(ABIDIR)/Oracle,.abi .docuser .docdev)
-	$(call ABIGEN,$^) --exclude finalize,setOperator,setVoters >$@
-
 $(OUTDIR)/stabilization.py: $(addprefix $(ABIDIR)/Stabilization,.abi .docuser .docdev)
-	$(call ABIGEN,$^) --exclude setOperator,setOracle >$@
-
 $(OUTDIR)/supply_control.py: $(addprefix $(ABIDIR)/SupplyControl,.abi .docuser .docdev)
-	$(call ABIGEN,$^) --exclude setOperator >$@
-
 $(OUTDIR)/upgrade_manager.py: $(addprefix $(ABIDIR)/UpgradeManager,.abi .docuser .docdev)
-	$(call ABIGEN,$^) --exclude setOperator >$@
+
+$(BINDINGS):
+	hatch run generate:pyabigen \
+		--srcdir $(AUTONITY)/autonity/solidity/contracts \
+		--version $(VERSION) \
+		--userdoc $(word 2,$^) \
+		--devdoc $(word 3,$^) \
+		$(word 1,$^) >$@
 
 $(ABIDIR)/%.abi: $(AUTONITY) AUTONITY_VERSION
 	cd $< && \

autonity/contracts/accountability.py

@@ -218,6 +218,32 @@ def config(
             int(return_value[6]),
         )
 
+    def distribute_rewards(
+        self,
+        _validator: eth_typing.ChecksumAddress,
+        _ntn_reward: int,
+    ) -> contract.ContractFunction:
+        """Binding for `distributeRewards` on the Accountability contract.
+
+        called by the Autonity Contract at block finalization, to reward the reporter of
+        a valid proof.
+
+        Parameters
+        ----------
+        _validator : eth_typing.ChecksumAddress
+            validator account which got slashed.
+        _ntn_reward : int
+
+        Returns
+        -------
+        web3.contract.contract.ContractFunction
+            A contract function instance to be sent in a transaction.
+        """
+        return self._contract.functions.distributeRewards(
+            _validator,
+            _ntn_reward,
+        )
+
     def epoch_period(
         self,
     ) -> int:
@@ -262,6 +288,28 @@ def events(
             int(return_value[11]),
         )
 
+    def finalize(
+        self,
+        _epoch_end: bool,
+    ) -> contract.ContractFunction:
+        """Binding for `finalize` on the Accountability contract.
+
+        called by the Autonity Contract at block finalization, before processing reward
+        redistribution.
+
+        Parameters
+        ----------
+        _epoch_end : bool
+
+        Returns
+        -------
+        web3.contract.contract.ContractFunction
+            A contract function instance to be sent in a transaction.
+        """
+        return self._contract.functions.finalize(
+            _epoch_end,
+        )
+
     def get_validator_accusation(
         self,
         _val: eth_typing.ChecksumAddress,
@@ -361,6 +409,27 @@ def handle_event(
             ),
         )
 
+    def set_epoch_period(
+        self,
+        _new_period: int,
+    ) -> contract.ContractFunction:
+        """Binding for `setEpochPeriod` on the Accountability contract.
+
+        called by the Autonity Contract when the epoch period is updated.
+
+        Parameters
+        ----------
+        _new_period : int
+
+        Returns
+        -------
+        web3.contract.contract.ContractFunction
+            A contract function instance to be sent in a transaction.
+        """
+        return self._contract.functions.setEpochPeriod(
+            _new_period,
+        )
+
     def slashing_history(
         self,
         key0: eth_typing.ChecksumAddress,

autonity/contracts/acu.py

@@ -141,6 +141,52 @@ def scale_factor(
         return_value = self._contract.functions.scaleFactor().call()
         return int(return_value)
 
+    def set_operator(
+        self,
+        operator: eth_typing.ChecksumAddress,
+    ) -> contract.ContractFunction:
+        """Binding for `setOperator` on the ACU contract.
+
+        Set the Governance Operator account address. Only the Autonity Contract is
+        authorized to set the Governance Operator account address.
+
+        Parameters
+        ----------
+        operator : eth_typing.ChecksumAddress
+            Address of the new Governance Operator
+
+        Returns
+        -------
+        web3.contract.contract.ContractFunction
+            A contract function instance to be sent in a transaction.
+        """
+        return self._contract.functions.setOperator(
+            operator,
+        )
+
+    def set_oracle(
+        self,
+        oracle: eth_typing.ChecksumAddress,
+    ) -> contract.ContractFunction:
+        """Binding for `setOracle` on the ACU contract.
+
+        Set the Oracle Contract address that is used to retrieve prices. Only the
+        Autonity Contract is authorized to set the Oracle Contract address.
+
+        Parameters
+        ----------
+        oracle : eth_typing.ChecksumAddress
+            Address of the new Oracle Contract
+
+        Returns
+        -------
+        web3.contract.contract.ContractFunction
+            A contract function instance to be sent in a transaction.
+        """
+        return self._contract.functions.setOracle(
+            oracle,
+        )
+
     def symbols(
         self,
     ) -> typing.List[str]:
@@ -156,6 +202,25 @@ def symbols(
         return_value = self._contract.functions.symbols().call()
         return [str(elem) for elem in return_value]
 
+    def update(
+        self,
+    ) -> contract.ContractFunction:
+        """Binding for `update` on the ACU contract.
+
+        Compute the ACU value and store it. It retrieves the latest prices from the
+        Oracle Contract. If one or more prices are unavailable from the Oracle, it will
+        not compute the value for that round. This function is intended to be called by
+        the protocol during block finalization, after the Oracle Contract finalization
+        has completed. Only the Autonity Contract is authorized to trigger the
+        computation of the ACU.
+
+        Returns
+        -------
+        web3.contract.contract.ContractFunction
+            A contract function instance to be sent in a transaction.
+        """
+        return self._contract.functions.update()
+
     def value(
         self,
     ) -> int:

autonity/contracts/autonity.py

@@ -474,6 +474,21 @@ def complete_contract_upgrade(
         """
         return self._contract.functions.completeContractUpgrade()
 
+    def compute_committee(
+        self,
+    ) -> contract.ContractFunction:
+        """Binding for `computeCommittee` on the Autonity contract.
+
+        update the current committee by selecting top staking validators. Restricted to
+        the protocol.
+
+        Returns
+        -------
+        web3.contract.contract.ContractFunction
+            A contract function instance to be sent in a transaction.
+        """
+        return self._contract.functions.computeCommittee()
+
     def config(
         self,
     ) -> Config:
@@ -575,6 +590,34 @@ def epoch_total_bonded_stake(
         return_value = self._contract.functions.epochTotalBondedStake().call()
         return int(return_value)
 
+    def finalize(
+        self,
+    ) -> contract.ContractFunction:
+        """Binding for `finalize` on the Autonity contract.
+
+        finalize is the block state finalisation function. It is called each block after
+        processing every transactions within it. It must be restricted to the protocol
+        only.
+
+        Returns
+        -------
+        web3.contract.contract.ContractFunction
+            A contract function instance to be sent in a transaction.
+        """
+        return self._contract.functions.finalize()
+
+    def finalize_initialization(
+        self,
+    ) -> contract.ContractFunction:
+        """Binding for `finalizeInitialization` on the Autonity contract.
+
+        Returns
+        -------
+        web3.contract.contract.ContractFunction
+            A contract function instance to be sent in a transaction.
+        """
+        return self._contract.functions.finalizeInitialization()
+
     def get_block_period(
         self,
     ) -> int: