Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release v0.19.0 #1204

Merged
merged 2 commits into from
Nov 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## Unreleased

## 0.19.0 (2024-11-08)

### Added

- Multisig component (#1193)
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,14 +43,14 @@ Edit `scarb.toml` and add:

```toml
[dependencies]
openzeppelin = "0.18.0"
openzeppelin = "0.19.0"
```

The previous example would import the entire library. We can also add each package as a separate dependency to improve the building time by not including modules that won't be used:

```toml
[dependencies]
openzeppelin_token = "0.18.0"
openzeppelin_token = "0.19.0"
```

Build the project to download it:
Expand Down
28 changes: 14 additions & 14 deletions Scarb.lock
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ version = 1

[[package]]
name = "openzeppelin"
version = "0.18.0"
version = "0.19.0"
dependencies = [
"openzeppelin_access",
"openzeppelin_account",
Expand All @@ -23,7 +23,7 @@ dependencies = [

[[package]]
name = "openzeppelin_access"
version = "0.18.0"
version = "0.19.0"
dependencies = [
"openzeppelin_introspection",
"openzeppelin_test_common",
Expand All @@ -34,7 +34,7 @@ dependencies = [

[[package]]
name = "openzeppelin_account"
version = "0.18.0"
version = "0.19.0"
dependencies = [
"openzeppelin_introspection",
"openzeppelin_test_common",
Expand All @@ -45,7 +45,7 @@ dependencies = [

[[package]]
name = "openzeppelin_finance"
version = "0.18.0"
version = "0.19.0"
dependencies = [
"openzeppelin_access",
"openzeppelin_test_common",
Expand All @@ -56,7 +56,7 @@ dependencies = [

[[package]]
name = "openzeppelin_governance"
version = "0.18.0"
version = "0.19.0"
dependencies = [
"openzeppelin_access",
"openzeppelin_account",
Expand All @@ -70,22 +70,22 @@ dependencies = [

[[package]]
name = "openzeppelin_introspection"
version = "0.18.0"
version = "0.19.0"
dependencies = [
"openzeppelin_test_common",
"snforge_std",
]

[[package]]
name = "openzeppelin_merkle_tree"
version = "0.18.0"
version = "0.19.0"
dependencies = [
"snforge_std",
]

[[package]]
name = "openzeppelin_presets"
version = "0.18.0"
version = "0.19.0"
dependencies = [
"openzeppelin_access",
"openzeppelin_account",
Expand All @@ -101,7 +101,7 @@ dependencies = [

[[package]]
name = "openzeppelin_security"
version = "0.18.0"
version = "0.19.0"
dependencies = [
"openzeppelin_test_common",
"openzeppelin_testing",
Expand All @@ -110,7 +110,7 @@ dependencies = [

[[package]]
name = "openzeppelin_test_common"
version = "0.18.0"
version = "0.19.0"
dependencies = [
"openzeppelin_access",
"openzeppelin_account",
Expand All @@ -127,14 +127,14 @@ dependencies = [

[[package]]
name = "openzeppelin_testing"
version = "0.18.0"
version = "0.19.0"
dependencies = [
"snforge_std",
]

[[package]]
name = "openzeppelin_token"
version = "0.18.0"
version = "0.19.0"
dependencies = [
"openzeppelin_access",
"openzeppelin_account",
Expand All @@ -147,7 +147,7 @@ dependencies = [

[[package]]
name = "openzeppelin_upgrades"
version = "0.18.0"
version = "0.19.0"
dependencies = [
"openzeppelin_test_common",
"openzeppelin_testing",
Expand All @@ -156,7 +156,7 @@ dependencies = [

[[package]]
name = "openzeppelin_utils"
version = "0.18.0"
version = "0.19.0"
dependencies = [
"openzeppelin_test_common",
"openzeppelin_testing",
Expand Down
2 changes: 1 addition & 1 deletion Scarb.toml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ version.workspace = true
keywords.workspace = true

[workspace.package]
version = "0.18.0"
version = "0.19.0"
edition = "2024_07"
cairo-version = "2.8.4"
scarb-version = "2.8.4"
Expand Down
2 changes: 1 addition & 1 deletion docs/antora.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: contracts-cairo
title: Contracts for Cairo
version: 0.18.0
version: 0.19.0
nav:
- modules/ROOT/nav.adoc
asciidoc:
Expand Down
6 changes: 3 additions & 3 deletions docs/modules/ROOT/pages/api/access.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ assigned each to multiple accounts.

[.contract]
[[OwnableComponent]]
=== `++OwnableComponent++` link:https://github.com/OpenZeppelin/cairo-contracts/blob/release-v0.18.0/packages/access/src/ownable/ownable.cairo[{github-icon},role=heading-link]
=== `++OwnableComponent++` link:https://github.com/OpenZeppelin/cairo-contracts/blob/release-v0.19.0/packages/access/src/ownable/ownable.cairo[{github-icon},role=heading-link]

```cairo
use openzeppelin_access::ownable::OwnableComponent;
Expand Down Expand Up @@ -255,7 +255,7 @@ Emitted when the ownership is transferred.

[.contract]
[[IAccessControl]]
=== `++IAccessControl++` link:https://github.com/OpenZeppelin/cairo-contracts/blob/release-v0.18.0/packages/access/src/accesscontrol/interface.cairo[{github-icon},role=heading-link]
=== `++IAccessControl++` link:https://github.com/OpenZeppelin/cairo-contracts/blob/release-v0.19.0/packages/access/src/accesscontrol/interface.cairo[{github-icon},role=heading-link]

:grant_role: xref:#IAccessControl-grant_role[grant_role]
:revoke_role: xref:#IAccessControl-revoke_role[revoke_role]
Expand Down Expand Up @@ -388,7 +388,7 @@ Emitted when `account` is revoked `role`.

[.contract]
[[AccessControlComponent]]
=== `++AccessControlComponent++` link:https://github.com/OpenZeppelin/cairo-contracts/blob/release-v0.18.0/packages/access/src/accesscontrol/accesscontrol.cairo[{github-icon},role=heading-link]
=== `++AccessControlComponent++` link:https://github.com/OpenZeppelin/cairo-contracts/blob/release-v0.19.0/packages/access/src/accesscontrol/accesscontrol.cairo[{github-icon},role=heading-link]

:assert_only_role: xref:#AccessControlComponent-assert_only_role
:grant_role: xref:#AccessControlComponent-grant_role[grant_role]
Expand Down
14 changes: 7 additions & 7 deletions docs/modules/ROOT/pages/api/account.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ include::../utils/_common.adoc[]

[.contract]
[[ISRC6]]
=== `++ISRC6++` link:https://github.com/OpenZeppelin/cairo-contracts/blob/release-v0.18.0/packages/account/src/interface.cairo[{github-icon},role=heading-link]
=== `++ISRC6++` link:https://github.com/OpenZeppelin/cairo-contracts/blob/release-v0.19.0/packages/account/src/interface.cairo[{github-icon},role=heading-link]

```cairo
use openzeppelin_account::interface::ISRC6;
Expand Down Expand Up @@ -67,7 +67,7 @@ Returns the short string `'VALID'` if valid, otherwise it reverts.

[.contract]
[[AccountComponent]]
=== `++AccountComponent++` link:https://github.com/OpenZeppelin/cairo-contracts/blob/release-v0.18.0/packages/account/src/account.cairo[{github-icon},role=heading-link]
=== `++AccountComponent++` link:https://github.com/OpenZeppelin/cairo-contracts/blob/release-v0.19.0/packages/account/src/account.cairo[{github-icon},role=heading-link]

:OwnerAdded: xref:AccountComponent-OwnerAdded[OwnerAdded]
:OwnerRemoved: xref:AccountComponent-OwnerRemoved[OwnerRemoved]
Expand Down Expand Up @@ -317,7 +317,7 @@ Emitted when a `public_key` is removed.

[.contract]
[[EthAccountComponent]]
=== `++EthAccountComponent++` link:https://github.com/OpenZeppelin/cairo-contracts/blob/release-v0.18.0/packages/account/src/eth_account.cairo[{github-icon},role=heading-link]
=== `++EthAccountComponent++` link:https://github.com/OpenZeppelin/cairo-contracts/blob/release-v0.19.0/packages/account/src/eth_account.cairo[{github-icon},role=heading-link]

:OwnerAdded: xref:EthAccountComponent-OwnerAdded[OwnerAdded]
:OwnerRemoved: xref:EthAccountComponent-OwnerRemoved[OwnerRemoved]
Expand Down Expand Up @@ -572,7 +572,7 @@ Emitted when a `public_key` is removed.

[.contract]
[[ISRC9_V2]]
=== `++ISRC9_V2++` link:https://github.com/OpenZeppelin/cairo-contracts/blob/release-v0.18.0/packages/account/src/extensions/src9/interface.cairo[{github-icon},role=heading-link]
=== `++ISRC9_V2++` link:https://github.com/OpenZeppelin/cairo-contracts/blob/release-v0.19.0/packages/account/src/extensions/src9/interface.cairo[{github-icon},role=heading-link]

```cairo
use openzeppelin_account::extensions::src9::ISRC9_V2;
Expand Down Expand Up @@ -622,7 +622,7 @@ Get the status of a given nonce. `true` if the nonce is available to use.

[.contract]
[[SRC9Component]]
=== `++SRC9Component++` link:https://github.com/OpenZeppelin/cairo-contracts/blob/release-v0.18.0/packages/account/src/extensions/src9/src9.cairo[{github-icon},role=heading-link]
=== `++SRC9Component++` link:https://github.com/OpenZeppelin/cairo-contracts/blob/release-v0.19.0/packages/account/src/extensions/src9/src9.cairo[{github-icon},role=heading-link]

```cairo
use openzeppelin_account::extensions::SRC9Component;
Expand Down Expand Up @@ -698,7 +698,7 @@ Initializes the account by registering the `ISRC9_V2` interface Id.

[.contract]
[[AccountUpgradeable]]
=== `++AccountUpgradeable++` link:https://github.com/OpenZeppelin/cairo-contracts/blob/release-v0.18.0/packages/presets/src/account.cairo[{github-icon},role=heading-link]
=== `++AccountUpgradeable++` link:https://github.com/OpenZeppelin/cairo-contracts/blob/release-v0.19.0/packages/presets/src/account.cairo[{github-icon},role=heading-link]

```cairo
use openzeppelin_presets::AccountUpgradeable;
Expand Down Expand Up @@ -759,7 +759,7 @@ Requirements:

[.contract]
[[EthAccountUpgradeable]]
=== `++EthAccountUpgradeable++` link:https://github.com/OpenZeppelin/cairo-contracts/blob/release-v0.18.0/packages/presets/src/eth_account.cairo[{github-icon},role=heading-link]
=== `++EthAccountUpgradeable++` link:https://github.com/OpenZeppelin/cairo-contracts/blob/release-v0.19.0/packages/presets/src/eth_account.cairo[{github-icon},role=heading-link]

```cairo
use openzeppelin_presets::EthAccountUpgradeable;
Expand Down
12 changes: 6 additions & 6 deletions docs/modules/ROOT/pages/api/erc1155.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ TIP: For an overview of ERC1155, read our xref:erc1155.adoc[ERC1155 guide].

[.contract]
[[IERC1155]]
=== `++IERC1155++` link:https://github.com/OpenZeppelin/cairo-contracts/blob/release-v0.18.0/packages/token/src/erc1155/interface.cairo[{github-icon},role=heading-link]
=== `++IERC1155++` link:https://github.com/OpenZeppelin/cairo-contracts/blob/release-v0.19.0/packages/token/src/erc1155/interface.cairo[{github-icon},role=heading-link]

[.hljs-theme-dark]
```cairo
Expand Down Expand Up @@ -126,7 +126,7 @@ Emitted when the token URI is updated to `value` for the `id` token.

[.contract]
[[IERC1155MetadataURI]]
=== `++IERC1155MetadataURI++` link:https://github.com/OpenZeppelin/cairo-contracts/blob/release-v0.18.0/packages/token/src/erc1155/interface.cairo[{github-icon},role=heading-link]
=== `++IERC1155MetadataURI++` link:https://github.com/OpenZeppelin/cairo-contracts/blob/release-v0.19.0/packages/token/src/erc1155/interface.cairo[{github-icon},role=heading-link]

[.hljs-theme-dark]
```cairo
Expand Down Expand Up @@ -156,7 +156,7 @@ Returns the Uniform Resource Identifier (URI) for the `token_id` token.

[.contract]
[[ERC1155Component]]
=== `++ERC1155Component++` link:https://github.com/OpenZeppelin/cairo-contracts/blob/release-v0.18.0/packages/token/src/erc1155/erc1155.cairo[{github-icon},role=heading-link]
=== `++ERC1155Component++` link:https://github.com/OpenZeppelin/cairo-contracts/blob/release-v0.19.0/packages/token/src/erc1155/erc1155.cairo[{github-icon},role=heading-link]

[.hljs-theme-dark]
```cairo
Expand Down Expand Up @@ -543,7 +543,7 @@ See <<IERC1155-URI,IERC1155::URI>>.

[.contract]
[[IERC1155Receiver]]
=== `++IERC1155Receiver++` link:https://github.com/OpenZeppelin/cairo-contracts/blob/release-v0.18.0/packages/token/src/erc1155/interface.cairo[{github-icon},role=heading-link]
=== `++IERC1155Receiver++` link:https://github.com/OpenZeppelin/cairo-contracts/blob/release-v0.19.0/packages/token/src/erc1155/interface.cairo[{github-icon},role=heading-link]

[.hljs-theme-dark]
```cairo
Expand Down Expand Up @@ -583,7 +583,7 @@ via <<IERC1155-safe_batch_transfer_from,IERC1155::safe_batch_transfer_from>> by

[.contract]
[[ERC1155ReceiverComponent]]
=== `++ERC1155ReceiverComponent++` link:https://github.com/OpenZeppelin/cairo-contracts/blob/release-v0.18.0/packages/token/src/erc1155/erc1155_receiver.cairo[{github-icon},role=heading-link]
=== `++ERC1155ReceiverComponent++` link:https://github.com/OpenZeppelin/cairo-contracts/blob/release-v0.19.0/packages/token/src/erc1155/erc1155_receiver.cairo[{github-icon},role=heading-link]

[.hljs-theme-dark]
```cairo
Expand Down Expand Up @@ -660,7 +660,7 @@ Registers the `IERC1155Receiver` interface ID as supported through introspection

[.contract]
[[ERC1155Upgradeable]]
=== `++ERC1155Upgradeable++` link:https://github.com/OpenZeppelin/cairo-contracts/blob/release-v0.18.0/packages/presets/src/erc1155.cairo[{github-icon},role=heading-link]
=== `++ERC1155Upgradeable++` link:https://github.com/OpenZeppelin/cairo-contracts/blob/release-v0.19.0/packages/presets/src/erc1155.cairo[{github-icon},role=heading-link]

```cairo
use openzeppelin_presets::ERC1155;
Expand Down
10 changes: 5 additions & 5 deletions docs/modules/ROOT/pages/api/erc20.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ TIP: For an overview of ERC20, read our {erc20-guide}.

[.contract]
[[IERC20]]
=== `++IERC20++` link:https://github.com/OpenZeppelin/cairo-contracts/blob/release-v0.18.0/packages/token/src/erc20/interface.cairo[{github-icon},role=heading-link]
=== `++IERC20++` link:https://github.com/OpenZeppelin/cairo-contracts/blob/release-v0.19.0/packages/token/src/erc20/interface.cairo[{github-icon},role=heading-link]

[.hljs-theme-dark]
```cairo
Expand Down Expand Up @@ -117,7 +117,7 @@ Emitted when the allowance of a `spender` for an `owner` is set.

[.contract]
[[IERC20Metadata]]
=== `++IERC20Metadata++` link:https://github.com/OpenZeppelin/cairo-contracts/blob/release-v0.18.0/packages/token/src/erc20/interface.cairo#L19[{github-icon},role=heading-link]
=== `++IERC20Metadata++` link:https://github.com/OpenZeppelin/cairo-contracts/blob/release-v0.19.0/packages/token/src/erc20/interface.cairo#L19[{github-icon},role=heading-link]

[.hljs-theme-dark]
```cairo
Expand Down Expand Up @@ -165,7 +165,7 @@ NOTE: This information is only used for _display_ purposes: it in no way affects

[.contract]
[[ERC20Component]]
=== `++ERC20Component++` link:https://github.com/OpenZeppelin/cairo-contracts/blob/release-v0.18.0/packages/token/src/erc20/erc20.cairo[{github-icon},role=heading-link]
=== `++ERC20Component++` link:https://github.com/OpenZeppelin/cairo-contracts/blob/release-v0.19.0/packages/token/src/erc20/erc20.cairo[{github-icon},role=heading-link]

[.hljs-theme-dark]
```cairo
Expand Down Expand Up @@ -516,7 +516,7 @@ See <<IERC20-Approval,IERC20::Approval>>.

[.contract]
[[IERC20Permit]]
=== `++IERC20Permit++` link:https://github.com/OpenZeppelin/cairo-contracts/blob/release-v0.18.0/packages/token/src/erc20/interface.cairo#L19[{github-icon},role=heading-link]
=== `++IERC20Permit++` link:https://github.com/OpenZeppelin/cairo-contracts/blob/release-v0.19.0/packages/token/src/erc20/interface.cairo#L19[{github-icon},role=heading-link]

[.hljs-theme-dark]
```cairo
Expand Down Expand Up @@ -560,7 +560,7 @@ The domain hashing logic follows the {snip-12} standard.

[.contract]
[[ERC20Upgradeable]]
=== `++ERC20Upgradeable++` link:https://github.com/OpenZeppelin/cairo-contracts/blob/release-v0.18.0/packages/presets/src/erc20.cairo[{github-icon},role=heading-link]
=== `++ERC20Upgradeable++` link:https://github.com/OpenZeppelin/cairo-contracts/blob/release-v0.19.0/packages/presets/src/erc20.cairo[{github-icon},role=heading-link]

```cairo
use openzeppelin_presets::ERC20Upgradeable;
Expand Down
Loading