Migrate to multiple packages (workspace)

.github/workflows/test.yml

@@ -2,8 +2,6 @@ name: Lint and test
 
 on:
   pull_request:
-    branches:
-    - main
   push:
     branches:
     - main
@@ -21,13 +19,23 @@ jobs:
     - uses: software-mansion/setup-scarb@v1
       with:
         scarb-version: ${{ env.SCARB_VERSION }}
+    - name: Extract foundry version
+      run: |
+        FOUNDRY_VERSION=$(grep 'snforge_std = ' Scarb.toml | sed 's/snforge_std = .\+ tag = "v\(.*\)".*/\1/')
+        echo "FOUNDRY_VERSION=$FOUNDRY_VERSION" >> "$GITHUB_ENV"
+    - uses: foundry-rs/setup-snfoundry@v3
+      with:
+        starknet-foundry-version: ${{ env.FOUNDRY_VERSION }}
     - name: Markdown lint
       uses: DavidAnson/markdownlint-cli2-action@b4c9feab76d8025d1e83c653fa3990936df0e6c8 # v16
       with:
         globs: |
           *.md
           !PULL_REQUEST_TEMPLATE.md
     - name: Cairo lint
-      run: scarb fmt --check
+      run: scarb fmt --check --workspace
+    - name: Temporary USC manually install
+      run: |
+        curl -L https://raw.githubusercontent.com/software-mansion/universal-sierra-compiler/master/scripts/install.sh | sh -s -- v2.2.0-rc.1
     - name: Cairo test
-      run: scarb test
+      run: snforge test --workspace

.gitignore

@@ -6,6 +6,9 @@ corelib/
 # Scarb
 target/
 
+# Starknet Foundry
+.snfoundry_cache/
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

CHANGELOG.md

@@ -12,6 +12,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - TimelockController component (#996)
 - HashCall implementation (#996)
+- Separated package for each submodule (#1065)
+  - `openzeppelin_access`
+  - `openzeppelin_account`
+  - `openzeppelin_governance`
+  - `openzeppelin_introspection`
+  - `openzeppelin_presets`
+  - `openzeppelin_security`
+  - `openzeppelin_token`
+  - `openzeppelin_upgrades`
+  - `openzeppelin_utils`
 
 ### Changed
 

README.md

@@ -46,6 +46,13 @@ Edit `scarb.toml` and add:
 openzeppelin = { git = "https://github.com/OpenZeppelin/cairo-contracts.git", tag = "v0.15.0-rc.0" }
 ```
 
+The previous example would import the entire library. we can also add each package as a separated dependency to improve the time for building by not including modules that won't be used:
+
+```toml
+[dependencies]
+openzeppelin_token = { git = "https://github.com/OpenZeppelin/cairo-contracts.git", tag = "v0.15.0-rc.0" }
+```
+
 Build the project to download it:
 
 ```bash
@@ -65,6 +72,7 @@ For example, this is how to write an ERC20-compliant contract:
 ```cairo
 #[starknet::contract]
 mod MyToken {
+    // If only the token package was added as a dependency, use `openzeppelin_token::` instead
     use openzeppelin::token::erc20::{ERC20Component, ERC20HooksEmptyImpl};
     use starknet::ContractAddress;
 

Scarb.lock

@@ -4,3 +4,101 @@ version = 1
 [[package]]
 name = "openzeppelin"
 version = "0.15.0-rc.0"
+dependencies = [
+ "openzeppelin_access",
+ "openzeppelin_account",
+ "openzeppelin_governance",
+ "openzeppelin_introspection",
+ "openzeppelin_presets",
+ "openzeppelin_security",
+ "openzeppelin_token",
+ "openzeppelin_upgrades",
+ "openzeppelin_utils",
+ "snforge_std",
+]
+
+[[package]]
+name = "openzeppelin_access"
+version = "0.15.0-rc.0"
+dependencies = [
+ "openzeppelin_introspection",
+ "openzeppelin_utils",
+ "snforge_std",
+]
+
+[[package]]
+name = "openzeppelin_account"
+version = "0.15.0-rc.0"
+dependencies = [
+ "openzeppelin_introspection",
+ "openzeppelin_token",
+ "openzeppelin_utils",
+ "snforge_std",
+]
+
+[[package]]
+name = "openzeppelin_governance"
+version = "0.15.0-rc.0"
+dependencies = [
+ "openzeppelin_access",
+ "openzeppelin_introspection",
+ "openzeppelin_utils",
+ "snforge_std",
+]
+
+[[package]]
+name = "openzeppelin_introspection"
+version = "0.15.0-rc.0"
+dependencies = [
+ "snforge_std",
+]
+
+[[package]]
+name = "openzeppelin_presets"
+version = "0.15.0-rc.0"
+dependencies = [
+ "openzeppelin_access",
+ "openzeppelin_account",
+ "openzeppelin_introspection",
+ "openzeppelin_token",
+ "openzeppelin_upgrades",
+ "snforge_std",
+]
+
+[[package]]
+name = "openzeppelin_security"
+version = "0.15.0-rc.0"
+dependencies = [
+ "openzeppelin_utils",
+ "snforge_std",
+]
+
+[[package]]
+name = "openzeppelin_token"
+version = "0.15.0-rc.0"
+dependencies = [
+ "openzeppelin_account",
+ "openzeppelin_governance",
+ "openzeppelin_introspection",
+ "snforge_std",
+]
+
+[[package]]
+name = "openzeppelin_upgrades"
+version = "0.15.0-rc.0"
+dependencies = [
+ "openzeppelin_utils",
+ "snforge_std",
+]
+
+[[package]]
+name = "openzeppelin_utils"
+version = "0.15.0-rc.0"
+dependencies = [
+ "snforge_std",
+]
+
+[[package]]
+name = "snforge_std"
+version = "0.26.0"
+source = "git+https://github.com/foundry-rs/starknet-foundry.git?tag=v0.26.0#50eb589db65e113efe4f09241feb59b574228c7e"

Scarb.toml

@@ -1,5 +1,21 @@
+[workspace]
+members = [
+    "packages/access",
+    "packages/account",
+    "packages/governance",
+    "packages/introspection",
+    "packages/presets",
+    "packages/security",
+    "packages/token",
+    "packages/upgrades",
+    "packages/utils",
+]
+
 [package]
 name = "openzeppelin"
+version.workspace = true
+
+[workspace.package]
 version = "0.15.0-rc.0"
 edition = "2023_11"
 cairo-version = "2.7.0-rc.3"
@@ -10,13 +26,33 @@ documentation = "https://docs.openzeppelin.com/contracts-cairo"
 readme = "README.md"
 repository = "https://github.com/OpenZeppelin/cairo-contracts"
 license-file = "LICENSE"
-keywords = ["openzeppelin", "starknet", "cairo", "contracts", "security", "standards"]
+keywords = [
+    "openzeppelin",
+    "starknet",
+    "cairo",
+    "contracts",
+    "security",
+    "standards",
+]
 
-[dependencies]
+[workspace.dependencies]
 starknet = "2.7.0-rc.3"
+snforge_std = { git = "https://github.com/foundry-rs/starknet-foundry.git", tag = "v0.26.0" }
+
+[dependencies]
+starknet.workspace = true
+openzeppelin_access = { path = "packages/access" }
+openzeppelin_account = { path = "packages/account" }
+openzeppelin_governance = { path = "packages/governance" }
+openzeppelin_introspection = { path = "packages/introspection" }
+openzeppelin_presets = { path = "packages/presets" }
+openzeppelin_security = { path = "packages/security" }
+openzeppelin_token = { path = "packages/token" }
+openzeppelin_upgrades = { path = "packages/upgrades" }
+openzeppelin_utils = { path = "packages/utils" }
 
 [dev-dependencies]
-cairo_test = "2.7.0-rc.3"
+snforge_std.workspace = true
 
 [lib]
 
@@ -25,5 +61,8 @@ allowed-libfuncs-list.name = "experimental"
 sierra = true
 casm = false
 
-[tool.fmt]
+[workspace.tool.fmt]
 sort-module-level-items = true
+
+[tool]
+fmt.workspace = true

docs/modules/ROOT/pages/accounts.adoc

@@ -204,7 +204,6 @@ Here’s an example of a basic contract:
 mod MyEthAccount {
     use openzeppelin::account::EthAccountComponent;
     use openzeppelin::account::interface::EthPublicKey;
-    use openzeppelin::account::utils::secp256k1::Secp256k1PointSerde;
     use openzeppelin::introspection::src5::SRC5Component;
     use starknet::ClassHash;
 
@@ -389,7 +388,6 @@ First, let's take the example account we created before and deploy it:
 mod MyEthAccount {
     use openzeppelin::account::EthAccountComponent;
     use openzeppelin::account::interface::EthPublicKey;
-    use openzeppelin::account::utils::secp256k1::Secp256k1PointSerde;
     use openzeppelin::introspection::src5::SRC5Component;
 
     component!(path: EthAccountComponent, storage: eth_account, event: EthAccountEvent);

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

@@ -3,7 +3,7 @@
 :deploy_syscall: link:https://docs.starknet.io/documentation/architecture_and_concepts/Smart_Contracts/system-calls-cairo1/#deploy[deploy_syscall]
 
 The following documentation provides reasoning and examples for functions and constants found in `openzeppelin::utils`
-and `openzeppelin::tests::utils`.
+and `use openzeppelin::utils::test_utils;`.
 
 CAUTION: Expect this module to evolve (as it has already done).
 
@@ -387,7 +387,7 @@ xref:/guides/snip12.adoc[SNIP12 and Typed Messages] guide.
 === `++utils++`
 
 ```cairo
-use openzeppelin::tests::utils;
+use openzeppelin::utils::test_utils;
 ```
 
 Module containing utilities for testing the library.
@@ -420,14 +420,14 @@ Usage example:
 
 ```cairo
 use openzeppelin::presets::AccountUpgradeable;
-use openzeppelin::tests::utils;
+use openzeppelin::utils::test_utils;
 use starknet::ContractAddress;
 
 const PUBKEY: felt252 = 'PUBKEY';
 
 fn deploy_test_contract() -> ContractAddress {
     let calldata = array![PUBKEY];
-    utils::deploy(AccountUpgradeable::TEST_CLASS_HASH, calldata)
+    test_utils::deploy(AccountUpgradeable::TEST_CLASS_HASH, calldata)
 }
 ```
 
@@ -459,15 +459,15 @@ Requirements:
 Usage example:
 
 ```cairo
-use openzeppelin::tests::utils;
+use openzeppelin::utils::test_utils;
 use openzeppelin::token::erc20::ERC20Component;
 use openzeppelin::token::erc20::ERC20Component::Transfer;
 use starknet::ContractAddress;
 
 fn assert_emitted_event(
     target: ContractAddress, from: ContractAddress, to: ContractAddress, value: u256
 ) {
-    let event = utils::pop_log::<ERC20Component::Event>(target).unwrap();
+    let event = test_utils::pop_log::<ERC20Component::Event>(target).unwrap();
     let expected = ERC20Component::Event::Transfer(Transfer { from, to, value });
     assert!(event == expected);
 }

packages/access/Scarb.toml

@@ -0,0 +1,31 @@
+[package]
+name = "openzeppelin_access"
+version.workspace = true
+edition.workspace = true
+cairo-version.workspace = true
+scarb-version.workspace = true
+authors.workspace = true
+description.workspace = true
+documentation.workspace = true
+readme.workspace = true
+repository.workspace = true
+license-file.workspace = true
+keywords.workspace = true
+
+[tool]
+fmt.workspace = true
+
+[dependencies]
+starknet.workspace = true
+openzeppelin_introspection = { path = "../introspection" }
+openzeppelin_utils = { path = "../utils" }
+
+[dev-dependencies]
+snforge_std.workspace = true
+
+[lib]
+
+[[target.starknet-contract]]
+allowed-libfuncs-list.name = "experimental"
+sierra = true
+casm = false

src/access/accesscontrol/accesscontrol.cairo → packages/access/src/accesscontrol/accesscontrol.cairo

@@ -7,10 +7,10 @@
 /// Roles are referred to by their `felt252` identifier.
 #[starknet::component]
 pub mod AccessControlComponent {
-    use openzeppelin::access::accesscontrol::interface;
-    use openzeppelin::introspection::src5::SRC5Component::InternalImpl as SRC5InternalImpl;
-    use openzeppelin::introspection::src5::SRC5Component::SRC5Impl;
-    use openzeppelin::introspection::src5::SRC5Component;
+    use openzeppelin_access::accesscontrol::interface;
+    use openzeppelin_introspection::src5::SRC5Component::InternalImpl as SRC5InternalImpl;
+    use openzeppelin_introspection::src5::SRC5Component::SRC5Impl;
+    use openzeppelin_introspection::src5::SRC5Component;
     use starknet::ContractAddress;
     use starknet::get_caller_address;
     use starknet::storage::Map;

src/access/accesscontrol/dual_accesscontrol.cairo → packages/access/src/accesscontrol/dual_accesscontrol.cairo

@@ -1,10 +1,10 @@
 // SPDX-License-Identifier: MIT
 // OpenZeppelin Contracts for Cairo v0.15.0-rc.0 (access/accesscontrol/dual_accesscontrol.cairo)
 
-use openzeppelin::utils::UnwrapAndCast;
-use openzeppelin::utils::selectors;
-use openzeppelin::utils::serde::SerializedAppend;
-use openzeppelin::utils::try_selector_with_fallback;
+use openzeppelin_utils::selectors;
+use openzeppelin_utils::serde::SerializedAppend;
+use openzeppelin_utils::try_selector_with_fallback;
+use openzeppelin_utils::unwrap_and_cast::UnwrapAndCast;
 use starknet::ContractAddress;
 use starknet::SyscallResultTrait;
 use starknet::syscalls::call_contract_syscall;

src/access.cairo → packages/access/src/lib.cairo

@@ -1,2 +1,4 @@
 pub mod accesscontrol;
 pub mod ownable;
+
+pub mod tests;