Remove NatSpec documentation comments that are under @dev tag

Author: szemate

autonity/contracts/__init__.py

@@ -1,6 +1,6 @@
 """Accountability contract binding and data structures."""
 
-# This module has been generated using pyabigen v0.2.8
+# This module has been generated using pyabigen v0.2.9
 
 import enum
 import typing
@@ -92,37 +92,22 @@ def __init__(
 
     @property
     def InnocenceProven(self) -> typing.Type[base_contract.BaseContractEvent]:
-        """Binding for `event InnocenceProven` on the Accountability contract.
-
-        Event emitted after receiving a proof-of-innocence cancelling an accusation.
-        """
+        """Binding for `event InnocenceProven` on the Accountability contract."""
         return self._contract.events.InnocenceProven
 
     @property
     def NewAccusation(self) -> typing.Type[base_contract.BaseContractEvent]:
-        """Binding for `event NewAccusation` on the Accountability contract.
-
-        Event emitted after receiving an accusation, the reported validator has a
-        certain amount of time to submit a proof-of-innocence, otherwise, he gets
-        slashed.
-        """
+        """Binding for `event NewAccusation` on the Accountability contract."""
         return self._contract.events.NewAccusation
 
     @property
     def NewFaultProof(self) -> typing.Type[base_contract.BaseContractEvent]:
-        """Binding for `event NewFaultProof` on the Accountability contract.
-
-        Event emitted when a fault proof has been submitted. The reported validator will
-        be silencied and slashed at the end of the current epoch.
-        """
+        """Binding for `event NewFaultProof` on the Accountability contract."""
         return self._contract.events.NewFaultProof
 
     @property
     def SlashingEvent(self) -> typing.Type[base_contract.BaseContractEvent]:
-        """Binding for `event SlashingEvent` on the Accountability contract.
-
-        Event emitted after a successful slashing.
-        """
+        """Binding for `event SlashingEvent` on the Accountability contract."""
         return self._contract.events.SlashingEvent
 
     def beneficiaries(

autonity/contracts/accountability.py

@@ -1,6 +1,6 @@
 """ACU contract binding and data structures."""
 
-# This module has been generated using pyabigen v0.2.8
+# This module has been generated using pyabigen v0.2.9
 
 import typing
 
@@ -15,7 +15,7 @@ class ACU:
     """ACU contract binding.
 
     Computes the value of the ACU, an optimal currency basket of 7 free-floating fiat
-    currencies. Intended to be deployed by the protocol at genesis.
+    currencies.
 
     Parameters
     ----------
@@ -60,8 +60,7 @@ def modify_basket(
     ) -> contract.ContractFunction:
         """Binding for `modifyBasket` on the ACU contract.
 
-        Modify the ACU symbols, quantites, or scale. Only the operator is authorized to
-        modify the basket.
+        Modify the ACU symbols, quantites, or scale.
 
         Parameters
         ----------

autonity/contracts/acu.py

@@ -1,6 +1,6 @@
 """Autonity contract binding and data structures."""
 
-# This module has been generated using pyabigen v0.2.8
+# This module has been generated using pyabigen v0.2.9
 
 import enum
 import typing
@@ -147,11 +147,7 @@ def AppliedUnbondingReverted(self) -> typing.Type[base_contract.BaseContractEven
 
     @property
     def Approval(self) -> typing.Type[base_contract.BaseContractEvent]:
-        """Binding for `event Approval` on the Autonity contract.
-
-        Emitted when the allowance of a `spender` for an `owner` is set by a call to
-        {approve}. `value` is the new allowance.
-        """
+        """Binding for `event Approval` on the Autonity contract."""
         return self._contract.events.Approval
 
     @property
@@ -181,11 +177,7 @@ def EpochPeriodUpdated(self) -> typing.Type[base_contract.BaseContractEvent]:
 
     @property
     def MinimumBaseFeeUpdated(self) -> typing.Type[base_contract.BaseContractEvent]:
-        """Binding for `event MinimumBaseFeeUpdated` on the Autonity contract.
-
-        Emitted when the Minimum Gas Price was updated and set to `gasPrice`. Note that
-        `gasPrice` may be zero.
-        """
+        """Binding for `event MinimumBaseFeeUpdated` on the Autonity contract."""
         return self._contract.events.MinimumBaseFeeUpdated
 
     @property
@@ -243,11 +235,7 @@ def Rewarded(self) -> typing.Type[base_contract.BaseContractEvent]:
 
     @property
     def Transfer(self) -> typing.Type[base_contract.BaseContractEvent]:
-        """Binding for `event Transfer` on the Autonity contract.
-
-        Emitted when `value` tokens are moved from one account (`from`) to another
-        (`to`). Note that `value` may be zero.
-        """
+        """Binding for `event Transfer` on the Autonity contract."""
         return self._contract.events.Transfer
 
     @property
@@ -257,10 +245,7 @@ def UnbondingRejected(self) -> typing.Type[base_contract.BaseContractEvent]:
 
     @property
     def UnlockingScheduleFailed(self) -> typing.Type[base_contract.BaseContractEvent]:
-        """Binding for `event UnlockingScheduleFailed` on the Autonity contract.
-
-        event to notify the failure in unlocking mechanism of the non-stakable schedules
-        """
+        """Binding for `event UnlockingScheduleFailed` on the Autonity contract."""
         return self._contract.events.UnlockingScheduleFailed
 
     def commission_rate_precision(
@@ -304,8 +289,6 @@ def allowance(
     ) -> int:
         """Binding for `allowance` on the Autonity contract.
 
-        See {IERC20-allowance}.
-
         Parameters
         ----------
         owner : eth_typing.ChecksumAddress
@@ -328,8 +311,6 @@ def approve(
     ) -> contract.ContractFunction:
         """Binding for `approve` on the Autonity contract.
 
-        See {IERC20-approve}. Requirements: - `spender` cannot be the zero address.
-
         Parameters
         ----------
         spender : eth_typing.ChecksumAddress
@@ -517,8 +498,6 @@ def decimals(
     ) -> int:
         """Binding for `decimals` on the Autonity contract.
 
-        ERC-20 Optional.
-
         Returns
         -------
         int
@@ -594,8 +573,7 @@ def get_committee(
     ) -> typing.List[CommitteeMember]:
         """Binding for `getCommittee` on the Autonity contract.
 
-        Returns the block committee. Current block committee if called before
-        finalize(), next block if called after.
+        Returns the block committee.
 
         Returns
         -------
@@ -692,9 +670,6 @@ def get_minimum_base_fee(
     ) -> int:
         """Binding for `getMinimumBaseFee` on the Autonity contract.
 
-        Autonity transaction's gas price must be greater or equal to the minimum gas
-        price.
-
         Returns
         -------
         int
@@ -1048,8 +1023,6 @@ def name(
     ) -> str:
         """Binding for `name` on the Autonity contract.
 
-        ERC-20 Optional.
-
         Returns
         -------
         str
@@ -1064,8 +1037,7 @@ def pause_validator(
     ) -> contract.ContractFunction:
         """Binding for `pauseValidator` on the Autonity contract.
 
-        Pause the validator and stop it accepting delegations. emit a
-        {DisabledValidator} event.
+        Pause the validator and stop it accepting delegations.
 
         Parameters
         ----------
@@ -1107,7 +1079,6 @@ def register_validator(
         Register a new validator in the system.  The validator might be selected to be
         part of consensus. This validator will have assigned to its treasury account the
         caller of this function. A new token "Liquid Stake" is deployed at this phase.
-        Emit a {RegisteredValidator} event.
 
         Parameters
         ----------
@@ -1330,8 +1301,7 @@ def set_minimum_base_fee(
     ) -> contract.ContractFunction:
         """Binding for `setMinimumBaseFee` on the Autonity contract.
 
-        Set the minimum gas price. Restricted to the operator account. Emit a
-        {MinimumBaseFeeUpdated} event.
+        Set the minimum gas price. Restricted to the operator account.
 
         Parameters
         ----------
@@ -1561,8 +1531,6 @@ def symbol(
     ) -> str:
         """Binding for `symbol` on the Autonity contract.
 
-        ERC-20 Optional.
-
         Returns
         -------
         str
@@ -1592,8 +1560,7 @@ def transfer(
     ) -> contract.ContractFunction:
         """Binding for `transfer` on the Autonity contract.
 
-        Moves `amount` NTN stake tokens from the caller's account to `recipient`. Emits
-        a {Transfer} event. Implementation of {IERC20 transfer}
+        Moves `amount` NTN stake tokens from the caller's account to `recipient`.
 
         Parameters
         ----------
@@ -1618,11 +1585,6 @@ def transfer_from(
     ) -> contract.ContractFunction:
         """Binding for `transferFrom` on the Autonity contract.
 
-        See {IERC20-transferFrom}. Emits an {Approval} event indicating the updated
-        allowance. Requirements: - `sender` and `recipient` must be allowed to hold
-        stake. - `sender` must have a balance of at least `amount`. - the caller must
-        have allowance for ``sender``'s tokens of at least `amount`.
-
         Parameters
         ----------
         _sender : eth_typing.ChecksumAddress

autonity/contracts/autonity.py

@@ -1,6 +1,6 @@
 """IERC20 contract binding and data structures."""
 
-# This module has been generated using pyabigen v0.2.8
+# This module has been generated using pyabigen v0.2.9
 
 import typing
 
@@ -14,8 +14,6 @@
 class IERC20:
     """IERC20 contract binding.
 
-    Interface of the ERC20 standard as defined in the EIP.
-
     Parameters
     ----------
     w3 : web3.Web3
@@ -37,20 +35,12 @@ def __init__(
 
     @property
     def Approval(self) -> typing.Type[base_contract.BaseContractEvent]:
-        """Binding for `event Approval` on the IERC20 contract.
-
-        Emitted when the allowance of a `spender` for an `owner` is set by a call to
-        {approve}. `value` is the new allowance.
-        """
+        """Binding for `event Approval` on the IERC20 contract."""
         return self._contract.events.Approval
 
     @property
     def Transfer(self) -> typing.Type[base_contract.BaseContractEvent]:
-        """Binding for `event Transfer` on the IERC20 contract.
-
-        Emitted when `value` tokens are moved from one account (`from`) to another
-        (`to`). Note that `value` may be zero.
-        """
+        """Binding for `event Transfer` on the IERC20 contract."""
         return self._contract.events.Transfer
 
     def allowance(
@@ -60,10 +50,6 @@ def allowance(
     ) -> int:
         """Binding for `allowance` on the IERC20 contract.
 
-        Returns the remaining number of tokens that `spender` will be allowed to spend
-        on behalf of `owner` through {transferFrom}. This is zero by default. This value
-        changes when {approve} or {transferFrom} are called.
-
         Parameters
         ----------
         owner : eth_typing.ChecksumAddress
@@ -86,15 +72,6 @@ def approve(
     ) -> contract.ContractFunction:
         """Binding for `approve` on the IERC20 contract.
 
-        Sets `amount` as the allowance of `spender` over the caller's tokens. Returns a
-        boolean value indicating whether the operation succeeded. IMPORTANT: Beware that
-        changing an allowance with this method brings the risk that someone may use both
-        the old and the new allowance by unfortunate transaction ordering. One possible
-        solution to mitigate this race condition is to first reduce the spender's
-        allowance to 0 and set the desired value afterwards:
-        https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729 Emits an
-        {Approval} event.
-
         Parameters
         ----------
         spender : eth_typing.ChecksumAddress
@@ -116,8 +93,6 @@ def balance_of(
     ) -> int:
         """Binding for `balanceOf` on the IERC20 contract.
 
-        Returns the amount of tokens owned by `account`.
-
         Parameters
         ----------
         account : eth_typing.ChecksumAddress
@@ -136,8 +111,6 @@ def total_supply(
     ) -> int:
         """Binding for `totalSupply` on the IERC20 contract.
 
-        Returns the amount of tokens in existence.
-
         Returns
         -------
         int
@@ -152,10 +125,6 @@ def transfer(
     ) -> contract.ContractFunction:
         """Binding for `transfer` on the IERC20 contract.
 
-        Moves `amount` tokens from the caller's account to `recipient`. Returns a
-        boolean value indicating whether the operation succeeded. Emits a {Transfer}
-        event.
-
         Parameters
         ----------
         recipient : eth_typing.ChecksumAddress
@@ -179,11 +148,6 @@ def transfer_from(
     ) -> contract.ContractFunction:
         """Binding for `transferFrom` on the IERC20 contract.
 
-        Moves `amount` tokens from `sender` to `recipient` using the allowance
-        mechanism. `amount` is then deducted from the caller's allowance. Returns a
-        boolean value indicating whether the operation succeeded. Emits a {Transfer}
-        event.
-
         Parameters
         ----------
         sender : eth_typing.ChecksumAddress

autonity/contracts/ierc20.py

@@ -1,6 +1,6 @@
 """InflationController contract binding and data structures."""
 
-# This module has been generated using pyabigen v0.2.8
+# This module has been generated using pyabigen v0.2.9
 
 import typing