Migrate Account to component

.github/workflows/test.yml

@@ -18,7 +18,7 @@ jobs:
     - uses: actions/checkout@v3
     - uses: software-mansion/setup-scarb@v1
       with:
-        scarb-version: "2.3.0-rc1"
+        scarb-version: "2.3.0"
     - name: Markdown lint
       uses: DavidAnson/markdownlint-cli2-action@5b7c9f74fec47e6b15667b2cc23c63dff11e449e # v9
       with:

Scarb.lock

@@ -0,0 +1,6 @@
+# Code generated by scarb DO NOT EDIT.
+version = 1
+
+[[package]]
+name = "openzeppelin"
+version = "0.7.0"

Scarb.toml

@@ -1,7 +1,7 @@
 [package]
 name = "openzeppelin"
 version = "0.7.0"
-cairo-version = "2.3.0-rc0"
+cairo-version = "2.3.0"
 authors = ["OpenZeppelin Community <maintainers@openzeppelin.org>"]
 description = "OpenZeppelin Contracts written in Cairo for StarkNet, a decentralized ZK Rollup"
 documentation = "https://docs.openzeppelin.com/contracts-cairo"
@@ -11,7 +11,7 @@ license-file = "LICENSE"
 keywords = ["openzeppelin", "starknet", "cairo", "contracts", "security", "standards"]
 
 [dependencies]
-starknet = "=2.3.0-rc0"
+starknet = "2.3.0"
 
 [lib]
 

docs/modules/ROOT/pages/api/account.adoc

@@ -71,7 +71,7 @@ Returns the short string `'VALID'` if valid, otherwise it reverts.
 ```javascript
 use openzeppelin::account::Account;
 ```
-Account component extending xref:ISRC6[`ISRC6`].
+Account component implementing xref:ISRC6[`ISRC6`].
 
 [.contract-index]
 .Embeddable Functions

docs/modules/ROOT/pages/index.adoc

@@ -103,7 +103,9 @@ mod MyAccount {
     #[event]
     #[derive(Drop, starknet::Event)]
     enum Event {
+        #[flat]
         AccountEvent: account_component::Event,
+        #[flat]
         SRC5Event: src5_component::Event
     }
 

src/account.cairo

@@ -1,9 +1,8 @@
 mod account;
 mod dual_account;
 mod interface;
+mod presets;
 
 use account::Account;
 use interface::AccountABIDispatcher;
 use interface::AccountABIDispatcherTrait;
-use interface::AccountCamelABIDispatcher;
-use interface::AccountCamelABIDispatcherTrait;

src/account/account.cairo

@@ -102,32 +102,36 @@ mod Account {
         }
     }
 
-    /// Adds camelCase support for `ISRC6`.
-    #[embeddable_as(SRC6CamelOnlyImpl)]
-    impl SRC6CamelOnly<
+    #[embeddable_as(DeclarerImpl)]
+    impl Declarer<
         TContractState,
         +HasComponent<TContractState>,
         +SRC5::HasComponent<TContractState>,
         +Drop<TContractState>
-    > of interface::ISRC6CamelOnly<ComponentState<TContractState>> {
-        fn isValidSignature(
-            self: @ComponentState<TContractState>, hash: felt252, signature: Array<felt252>
+    > of interface::IDeclarer<ComponentState<TContractState>> {
+        /// Verifies the validity of the signature for the current transaction.
+        /// This function is used by the protocol to verify `declare` transactions.
+        fn __validate_declare__(
+            self: @ComponentState<TContractState>, class_hash: felt252
         ) -> felt252 {
-            self.is_valid_signature(hash, signature)
+            self.validate_transaction()
         }
     }
 
-    #[embeddable_as(DeclarerImpl)]
-    impl Declarer<
+    #[embeddable_as(DeployableImpl)]
+    impl Deployable<
         TContractState,
         +HasComponent<TContractState>,
         +SRC5::HasComponent<TContractState>,
         +Drop<TContractState>
-    > of interface::IDeclarer<ComponentState<TContractState>> {
+    > of interface::IDeployable<ComponentState<TContractState>> {
         /// Verifies the validity of the signature for the current transaction.
-        /// This function is used by the protocol to verify `declare` transactions.
-        fn __validate_declare__(
-            self: @ComponentState<TContractState>, class_hash: felt252
+        /// This function is used by the protocol to verify `deploy_account` transactions.
+        fn __validate_deploy__(
+            self: @ComponentState<TContractState>,
+            class_hash: felt252,
+            contract_address_salt: felt252,
+            public_key: felt252
         ) -> felt252 {
             self.validate_transaction()
         }
@@ -153,6 +157,21 @@ mod Account {
         }
     }
 
+    /// Adds camelCase support for `ISRC6`.
+    #[embeddable_as(SRC6CamelOnlyImpl)]
+    impl SRC6CamelOnly<
+        TContractState,
+        +HasComponent<TContractState>,
+        +SRC5::HasComponent<TContractState>,
+        +Drop<TContractState>
+    > of interface::ISRC6CamelOnly<ComponentState<TContractState>> {
+        fn isValidSignature(
+            self: @ComponentState<TContractState>, hash: felt252, signature: Array<felt252>
+        ) -> felt252 {
+            self.is_valid_signature(hash, signature)
+        }
+    }
+
     /// Adds camelCase support for `PublicKeyTrait`.
     #[embeddable_as(PublicKeyCamelImpl)]
     impl PublicKeyCamel<
@@ -170,25 +189,6 @@ mod Account {
         }
     }
 
-    #[embeddable_as(DeployableImpl)]
-    impl Deployable<
-        TContractState,
-        +HasComponent<TContractState>,
-        +SRC5::HasComponent<TContractState>,
-        +Drop<TContractState>
-    > of interface::IDeployable<ComponentState<TContractState>> {
-        /// Verifies the validity of the signature for the current transaction.
-        /// This function is used by the protocol to verify `deploy_account` transactions.
-        fn __validate_deploy__(
-            self: @ComponentState<TContractState>,
-            class_hash: felt252,
-            contract_address_salt: felt252,
-            public_key: felt252
-        ) -> felt252 {
-            self.validate_transaction()
-        }
-    }
-
     #[generate_trait]
     impl InternalImpl<
         TContractState,

src/account/interface.cairo

@@ -30,31 +30,39 @@ trait IDeployable<TState> {
     ) -> felt252;
 }
 
+//
+// Account ABI
+//
+
 #[starknet::interface]
 trait AccountABI<TState> {
+    // ISRC6
     fn __execute__(self: @TState, calls: Array<Call>) -> Array<Span<felt252>>;
     fn __validate__(self: @TState, calls: Array<Call>) -> felt252;
+    fn is_valid_signature(self: @TState, hash: felt252, signature: Array<felt252>) -> felt252;
+
+    // ISRC5
+    fn supports_interface(self: @TState, interface_id: felt252) -> bool;
+
+    // IDeclarer
     fn __validate_declare__(self: @TState, class_hash: felt252) -> felt252;
+
+    // DeployerTrait
     fn __validate_deploy__(
-        self: @TState, class_hash: felt252, contract_address_salt: felt252, public_key: felt252
+        self: @TState, class_hash: felt252, contract_address_salt: felt252, _public_key: felt252
     ) -> felt252;
+
+    // PublicKeyTrait
     fn set_public_key(ref self: TState, new_public_key: felt252);
     fn get_public_key(self: @TState) -> felt252;
-    fn is_valid_signature(self: @TState, hash: felt252, signature: Array<felt252>) -> felt252;
-    fn supports_interface(self: @TState, interface_id: felt252) -> bool;
-}
 
-// Entry points case-convention is enforced by the protocol
-#[starknet::interface]
-trait AccountCamelABI<TState> {
-    fn __execute__(self: @TState, calls: Array<Call>) -> Array<Span<felt252>>;
-    fn __validate__(self: @TState, calls: Array<Call>) -> felt252;
-    fn __validate_declare__(self: @TState, classHash: felt252) -> felt252;
-    fn __validate_deploy__(
-        self: @TState, classHash: felt252, contractAddressSalt: felt252, publicKey: felt252
-    ) -> felt252;
-    fn setPublicKey(ref self: TState, newPublicKey: felt252);
-    fn getPublicKey(self: @TState) -> felt252;
+    // ISRC6CamelOnly
     fn isValidSignature(self: @TState, hash: felt252, signature: Array<felt252>) -> felt252;
+
+    // ISRC5Camel
     fn supportsInterface(self: @TState, interfaceId: felt252) -> bool;
+
+    // PublicKeyCamelTrait
+    fn setPublicKey(ref self: TState, newPublicKey: felt252);
+    fn getPublicKey(self: @TState) -> felt252;
 }

src/account/presets.cairo

@@ -0,0 +1,3 @@
+mod account;
+
+use account::Account;

src/account/presets/account.cairo

@@ -0,0 +1,55 @@
+// SPDX-License-Identifier: MIT
+// OpenZeppelin Contracts for Cairo v0.7.0 (account/presets/account.cairo)
+
+/// # Account Preset
+///
+/// Openzeppelin's account contract.
+#[starknet::contract]
+mod Account {
+    use openzeppelin::account::Account as account_component;
+    use openzeppelin::introspection::src5::SRC5 as src5_component;
+
+    component!(path: account_component, storage: account, event: AccountEvent);
+    component!(path: src5_component, storage: src5, event: SRC5Event);
+
+    // Account
+    #[abi(embed_v0)]
+    impl SRC6Impl = account_component::SRC6Impl<ContractState>;
+    #[abi(embed_v0)]
+    impl SRC6CamelOnlyImpl = account_component::SRC6CamelOnlyImpl<ContractState>;
+    #[abi(embed_v0)]
+    impl PublicKeyImpl = account_component::PublicKeyImpl<ContractState>;
+    #[abi(embed_v0)]
+    impl PublicKeyCamelImpl = account_component::PublicKeyCamelImpl<ContractState>;
+    #[abi(embed_v0)]
+    impl DeclarerImpl = account_component::DeclarerImpl<ContractState>;
+    #[abi(embed_v0)]
+    impl DeployableImpl = account_component::DeployableImpl<ContractState>;
+    impl AccountInternalImpl = account_component::InternalImpl<ContractState>;
+
+    // SRC5
+    #[abi(embed_v0)]
+    impl SRC5Impl = src5_component::SRC5Impl<ContractState>;
+
+    #[storage]
+    struct Storage {
+        #[substorage(v0)]
+        account: account_component::Storage,
+        #[substorage(v0)]
+        src5: src5_component::Storage
+    }
+
+    #[event]
+    #[derive(Drop, starknet::Event)]
+    enum Event {
+        #[flat]
+        AccountEvent: account_component::Event,
+        #[flat]
+        SRC5Event: src5_component::Event
+    }
+
+    #[constructor]
+    fn constructor(ref self: ContractState, public_key: felt252) {
+        self.account.initializer(public_key);
+    }
+}

src/tests.cairo

@@ -2,6 +2,7 @@ mod access;
 mod account;
 mod introspection;
 mod mocks;
+mod presets;
 mod security;
 mod token;
 mod upgrades;

src/tests/account/test_account.cairo

@@ -1,4 +1,4 @@
-use openzeppelin::account::Account::{InternalTrait, OwnerAdded, OwnerRemoved};
+use openzeppelin::account::Account::{InternalTrait, OwnerAdded, OwnerRemoved, SRC6CamelOnlyImpl};
 use openzeppelin::account::Account::{PublicKeyCamelImpl, PublicKeyImpl};
 use openzeppelin::account::Account::{TRANSACTION_VERSION, QUERY_VERSION};
 use openzeppelin::account::Account;
@@ -48,10 +48,10 @@ fn ACCOUNT_ADDRESS() -> ContractAddress {
 fn SIGNED_TX_DATA() -> SignedTransactionData {
     SignedTransactionData {
         private_key: 1234,
-        public_key: 883045738439352841478194533192765345509759306772397516907181243450667673002,
-        transaction_hash: 2717105892474786771566982177444710571376803476229898722748888396642649184538,
-        r: 3068558690657879390136740086327753007413919701043650133111397282816679110801,
-        s: 3355728545224320878895493649495491771252432631648740019139167265522817576501
+        public_key: 0x1f3c942d7f492a37608cde0d77b884a5aa9e11d2919225968557370ddb5a5aa,
+        transaction_hash: 0x601d3d2e265c10ff645e1554c435e72ce6721f0ba5fc96f0c650bfc6231191a,
+        r: 0x6c8be1fb0fb5c730fbd7abaecbed9d980376ff2e660dfcd157e158d2b026891,
+        s: 0x76b4669998eb933f44a59eace12b41328ab975ceafddf92602b21eb23e22e35
     }
 }
 
@@ -137,10 +137,10 @@ fn test_isValidSignature() {
 
     state.account.set_public_key(data.public_key);
 
-    let is_valid = Account::SRC6CamelOnlyImpl::isValidSignature(@state, hash, good_signature);
+    let is_valid = state.account.isValidSignature(hash, good_signature);
     assert(is_valid == starknet::VALIDATED, 'Should accept valid signature');
 
-    let is_valid = Account::SRC6CamelOnlyImpl::isValidSignature(@state, hash, bad_signature);
+    let is_valid = state.account.isValidSignature(hash, bad_signature);
     assert(is_valid == 0, 'Should reject invalid signature');
 }
 

src/tests/account/test_dual_account.cairo

@@ -1,6 +1,5 @@
 use openzeppelin::account::dual_account::{DualCaseAccountABI, DualCaseAccount};
 use openzeppelin::account::{AccountABIDispatcherTrait, AccountABIDispatcher};
-use openzeppelin::account::{AccountCamelABIDispatcherTrait, AccountCamelABIDispatcher};
 use openzeppelin::introspection::interface::ISRC5_ID;
 use openzeppelin::tests::account::test_account::SIGNED_TX_DATA;
 use openzeppelin::tests::mocks::account_mocks::{
@@ -24,12 +23,12 @@ fn setup_snake() -> (DualCaseAccount, AccountABIDispatcher) {
     )
 }
 
-fn setup_camel() -> (DualCaseAccount, AccountCamelABIDispatcher) {
+fn setup_camel() -> (DualCaseAccount, AccountABIDispatcher) {
     let mut calldata = array![PUBKEY];
     let target = utils::deploy(CamelAccountMock::TEST_CLASS_HASH, calldata);
     (
         DualCaseAccount { contract_address: target },
-        AccountCamelABIDispatcher { contract_address: target }
+        AccountABIDispatcher { contract_address: target }
     )
 }
 
@@ -242,4 +241,3 @@ fn test_dual_supportsInterface_exists_and_panics() {
     let (_, dispatcher) = setup_account_panic();
     dispatcher.supports_interface(ISRC5_ID);
 }
-