Migrate ERC20Votes to component (#951)

* feat: add main logic * feat: docs * feat: add Nonces and tests * docs: finish v1 * feat: update CHANGELOG * fix: format * Update docs/modules/ROOT/pages/guides/snip12.adoc Co-authored-by: Andrew Fleming <[email protected]> * Update docs/modules/ROOT/pages/guides/snip12.adoc Co-authored-by: Andrew Fleming <[email protected]> * Update docs/modules/ROOT/pages/guides/snip12.adoc Co-authored-by: Andrew Fleming <[email protected]> * Update docs/modules/ROOT/pages/guides/snip12.adoc Co-authored-by: Andrew Fleming <[email protected]> * Update docs/modules/ROOT/pages/guides/snip12.adoc Co-authored-by: Andrew Fleming <[email protected]> * feat: apply update reviews * fix: tests * fix: linter * feat: finish main logic * feat: add tests * fix: tests * feat: update CHANGELOG * refactor: hooks names * fix: tests * feat: add overflow events to ERC20 * feat: bump scarb * feat: set scarb to 2.6.3 * fix: tests * Update src/utils/structs/checkpoint.cairo Co-authored-by: Andrew Fleming <[email protected]> * Update src/tests/presets/test_erc20_votes.cairo Co-authored-by: Andrew Fleming <[email protected]> * feat: apply review updates * feat: apply review updates * feat: apply review updates * fix: test * fix: comment --------- Co-authored-by: Andrew Fleming <[email protected]>
OpenZeppelin · Apr 12, 2024 · ec99fc3 · ec99fc3
1 parent bb15d2a
commit ec99fc3
Show file tree

Hide file tree

Showing 26 changed files with 1,413 additions and 100 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+### Added
+
+- before_update and after_update hooks to ERC20Component (#951)
+- INSUFFICIENT_BALANCE and INSUFFICIENT_ALLOWANCE errors to ERC20Component (#951)
+- ERC20Votes component (#951)
+
 ### Changed
 
 - Allow testing utilities to be importable (#963)

diff --git a/src/governance.cairo b/src/governance.cairo
@@ -0,0 +1 @@
+mod utils;
diff --git a/src/governance/utils.cairo b/src/governance/utils.cairo
@@ -0,0 +1 @@
+mod interfaces;
diff --git a/src/governance/utils/interfaces.cairo b/src/governance/utils/interfaces.cairo
@@ -0,0 +1,3 @@
+mod votes;
+
+use votes::IVotes;
diff --git a/src/governance/utils/interfaces/votes.cairo b/src/governance/utils/interfaces/votes.cairo
@@ -0,0 +1,34 @@
+use starknet::ContractAddress;
+
+/// Common interface for Votes-enabled contracts.
+#[starknet::interface]
+trait IVotes<TState> {
+    /// Returns the current amount of votes that `account` has.
+    fn get_votes(self: @TState, account: ContractAddress) -> u256;
+
+    /// Returns the amount of votes that `account` had at a specific moment in the past.
+    fn get_past_votes(self: @TState, account: ContractAddress, timepoint: u64) -> u256;
+
+    /// Returns the total supply of votes available at a specific moment in the past.
+    ///
+    /// NOTE: This value is the sum of all available votes, which is not necessarily the sum of all delegated votes.
+    /// Votes that have not been delegated are still part of total supply, even though they would not participate in a
+    /// vote.
+    fn get_past_total_supply(self: @TState, timepoint: u64) -> u256;
+
+    /// Returns the delegate that `account` has chosen.
+    fn delegates(self: @TState, account: ContractAddress) -> ContractAddress;
+
+    /// Delegates votes from the sender to `delegatee`.
+    fn delegate(ref self: TState, delegatee: ContractAddress);
+
+    /// Delegates votes from `delegator` to `delegatee`.
+    fn delegate_by_sig(
+        ref self: TState,
+        delegator: ContractAddress,
+        delegatee: ContractAddress,
+        nonce: felt252,
+        expiry: u64,
+        signature: Array<felt252>
+    );
+}
diff --git a/src/lib.cairo b/src/lib.cairo
@@ -1,5 +1,6 @@
 mod access;
 mod account;
+mod governance;
 mod introspection;
 mod presets;
 mod security;

diff --git a/src/presets/erc20.cairo b/src/presets/erc20.cairo
@@ -8,7 +8,7 @@
 /// set in the constructor.
 #[starknet::contract]
 mod ERC20 {
-    use openzeppelin::token::erc20::ERC20Component;
+    use openzeppelin::token::erc20::{ERC20Component, ERC20HooksEmptyImpl};
     use starknet::ContractAddress;
 
     component!(path: ERC20Component, storage: erc20, event: ERC20Event);

diff --git a/src/tests/mocks.cairo b/src/tests/mocks.cairo
@@ -3,6 +3,7 @@ mod account_mocks;
 mod erc1155_mocks;
 mod erc1155_receiver_mocks;
 mod erc20_mocks;
+mod erc20_votes_mocks;
 mod erc721_mocks;
 mod erc721_receiver_mocks;
 mod eth_account_mocks;

diff --git a/src/tests/mocks/erc20_mocks.cairo b/src/tests/mocks/erc20_mocks.cairo
@@ -1,6 +1,6 @@
 #[starknet::contract]
 mod DualCaseERC20Mock {
-    use openzeppelin::token::erc20::ERC20Component;
+    use openzeppelin::token::erc20::{ERC20Component, ERC20HooksEmptyImpl};
     use starknet::ContractAddress;
 
     component!(path: ERC20Component, storage: erc20, event: ERC20Event);
@@ -41,7 +41,7 @@ mod DualCaseERC20Mock {
 
 #[starknet::contract]
 mod SnakeERC20Mock {
-    use openzeppelin::token::erc20::ERC20Component;
+    use openzeppelin::token::erc20::{ERC20Component, ERC20HooksEmptyImpl};
     use starknet::ContractAddress;
 
     component!(path: ERC20Component, storage: erc20, event: ERC20Event);
@@ -80,7 +80,7 @@ mod SnakeERC20Mock {
 
 #[starknet::contract]
 mod CamelERC20Mock {
-    use openzeppelin::token::erc20::ERC20Component;
+    use openzeppelin::token::erc20::{ERC20Component, ERC20HooksEmptyImpl};
     use starknet::ContractAddress;
 
     component!(path: ERC20Component, storage: erc20, event: ERC20Event);

diff --git a/src/tests/mocks/erc20_votes_mocks.cairo b/src/tests/mocks/erc20_votes_mocks.cairo
@@ -0,0 +1,101 @@
+#[starknet::contract]
+mod DualCaseERC20VotesMock {
+    use openzeppelin::token::erc20::ERC20Component;
+    use openzeppelin::token::erc20::extensions::ERC20VotesComponent::InternalTrait as ERC20VotesInternalTrait;
+    use openzeppelin::token::erc20::extensions::ERC20VotesComponent;
+    use openzeppelin::utils::cryptography::nonces::NoncesComponent;
+    use openzeppelin::utils::cryptography::snip12::SNIP12Metadata;
+    use starknet::ContractAddress;
+
+    component!(path: ERC20VotesComponent, storage: erc20_votes, event: ERC20VotesEvent);
+    component!(path: ERC20Component, storage: erc20, event: ERC20Event);
+    component!(path: NoncesComponent, storage: nonces, event: NoncesEvent);
+
+    // ERC20Votes
+    #[abi(embed_v0)]
+    impl ERC20VotesComponentImpl =
+        ERC20VotesComponent::ERC20VotesImpl<ContractState>;
+
+    // ERC20Mixin
+    #[abi(embed_v0)]
+    impl ERC20MixinImpl = ERC20Component::ERC20MixinImpl<ContractState>;
+    impl InternalImpl = ERC20Component::InternalImpl<ContractState>;
+
+    // Nonces
+    #[abi(embed_v0)]
+    impl NoncesImpl = NoncesComponent::NoncesImpl<ContractState>;
+
+    #[storage]
+    struct Storage {
+        #[substorage(v0)]
+        erc20_votes: ERC20VotesComponent::Storage,
+        #[substorage(v0)]
+        erc20: ERC20Component::Storage,
+        #[substorage(v0)]
+        nonces: NoncesComponent::Storage
+    }
+
+    #[event]
+    #[derive(Drop, starknet::Event)]
+    enum Event {
+        #[flat]
+        ERC20VotesEvent: ERC20VotesComponent::Event,
+        #[flat]
+        ERC20Event: ERC20Component::Event,
+        #[flat]
+        NoncesEvent: NoncesComponent::Event
+    }
+
+    /// Required for hash computation.
+    impl SNIP12MetadataImpl of SNIP12Metadata {
+        fn name() -> felt252 {
+            'DAPP_NAME'
+        }
+        fn version() -> felt252 {
+            'DAPP_VERSION'
+        }
+    }
+
+    //
+    // Hooks
+    //
+
+    impl ERC20VotesHooksImpl<
+        TContractState,
+        impl ERC20Votes: ERC20VotesComponent::HasComponent<TContractState>,
+        impl HasComponent: ERC20Component::HasComponent<TContractState>,
+        +NoncesComponent::HasComponent<TContractState>,
+        +Drop<TContractState>
+    > of ERC20Component::ERC20HooksTrait<TContractState> {
+        fn before_update(
+            ref self: ERC20Component::ComponentState<TContractState>,
+            from: ContractAddress,
+            recipient: ContractAddress,
+            amount: u256
+        ) {}
+
+        fn after_update(
+            ref self: ERC20Component::ComponentState<TContractState>,
+            from: ContractAddress,
+            recipient: ContractAddress,
+            amount: u256
+        ) {
+            let mut erc20_votes_component = get_dep_component_mut!(ref self, ERC20Votes);
+            erc20_votes_component.transfer_voting_units(from, recipient, amount);
+        }
+    }
+
+    /// Sets the token `name` and `symbol`.
+    /// Mints `fixed_supply` tokens to `recipient`.
+    #[constructor]
+    fn constructor(
+        ref self: ContractState,
+        name: ByteArray,
+        symbol: ByteArray,
+        fixed_supply: u256,
+        recipient: ContractAddress
+    ) {
+        self.erc20.initializer(name, symbol);
+        self.erc20._mint(recipient, fixed_supply);
+    }
+}
diff --git a/src/tests/presets/test_erc20.cairo b/src/tests/presets/test_erc20.cairo
@@ -55,15 +55,15 @@ fn test_constructor() {
 
 #[test]
 fn test_total_supply() {
-    let mut dispatcher = setup_dispatcher();
+    let dispatcher = setup_dispatcher();
 
     assert_eq!(dispatcher.total_supply(), SUPPLY);
     assert_eq!(dispatcher.totalSupply(), SUPPLY);
 }
 
 #[test]
 fn test_balance_of() {
-    let mut dispatcher = setup_dispatcher();
+    let dispatcher = setup_dispatcher();
 
     assert_eq!(dispatcher.balance_of(OWNER()), SUPPLY);
     assert_eq!(dispatcher.balanceOf(OWNER()), SUPPLY);
@@ -133,7 +133,7 @@ fn test_transfer() {
 }
 
 #[test]
-#[should_panic(expected: ('u256_sub Overflow', 'ENTRYPOINT_FAILED'))]
+#[should_panic(expected: ('ERC20: insufficient balance', 'ENTRYPOINT_FAILED'))]
 fn test_transfer_not_enough_balance() {
     let mut dispatcher = setup_dispatcher();
     testing::set_contract_address(OWNER());
@@ -196,7 +196,7 @@ fn test_transfer_from_doesnt_consume_infinite_allowance() {
 }
 
 #[test]
-#[should_panic(expected: ('u256_sub Overflow', 'ENTRYPOINT_FAILED'))]
+#[should_panic(expected: ('ERC20: insufficient allowance', 'ENTRYPOINT_FAILED'))]
 fn test_transfer_from_greater_than_allowance() {
     let mut dispatcher = setup_dispatcher();
     testing::set_contract_address(OWNER());
@@ -219,7 +219,7 @@ fn test_transfer_from_to_zero_address() {
 }
 
 #[test]
-#[should_panic(expected: ('u256_sub Overflow', 'ENTRYPOINT_FAILED'))]
+#[should_panic(expected: ('ERC20: insufficient allowance', 'ENTRYPOINT_FAILED'))]
 fn test_transfer_from_from_zero_address() {
     let mut dispatcher = setup_dispatcher();
     dispatcher.transfer_from(Zeroable::zero(), RECIPIENT(), VALUE);
@@ -259,7 +259,7 @@ fn test_transferFrom_doesnt_consume_infinite_allowance() {
 }
 
 #[test]
-#[should_panic(expected: ('u256_sub Overflow', 'ENTRYPOINT_FAILED'))]
+#[should_panic(expected: ('ERC20: insufficient allowance', 'ENTRYPOINT_FAILED'))]
 fn test_transferFrom_greater_than_allowance() {
     let mut dispatcher = setup_dispatcher();
     testing::set_contract_address(OWNER());
@@ -282,7 +282,7 @@ fn test_transferFrom_to_zero_address() {
 }
 
 #[test]
-#[should_panic(expected: ('u256_sub Overflow', 'ENTRYPOINT_FAILED'))]
+#[should_panic(expected: ('ERC20: insufficient allowance', 'ENTRYPOINT_FAILED'))]
 fn test_transferFrom_from_zero_address() {
     let mut dispatcher = setup_dispatcher();
     dispatcher.transferFrom(Zeroable::zero(), RECIPIENT(), VALUE);

diff --git a/src/tests/token.cairo b/src/tests/token.cairo
@@ -6,5 +6,6 @@ mod test_dual721_receiver;
 mod test_erc1155;
 mod test_erc1155_receiver;
 mod test_erc20;
+mod test_erc20_votes;
 mod test_erc721;
 mod test_erc721_receiver;