Skip to content

Commit fece41a

Browse files
authored
Update packages READMEs links (#1551)
* feat: update CHANGELOG * feat: add script and update links * feat: update interfaces package * fix: extra spacing
1 parent 68e939e commit fece41a

File tree

15 files changed

+230
-107
lines changed

15 files changed

+230
-107
lines changed

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
99

1010
## Unreleased
1111

12+
## 3.0.0-alpha.3 (2025-10-9)
13+
1214
### Changed
1315

1416
- Decoupled openzeppelin_utils version from the umbrella package (#1531)

packages/access/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## Access Control
22

3-
> **NOTE:** This document is better viewed at [https://docs.openzeppelin.com/contracts-cairo/3.0.0-alpha.2/api/access](https://docs.openzeppelin.com/contracts-cairo/3.0.0-alpha.2/api/access)
3+
> **NOTE:** This document is better viewed at [https://docs.openzeppelin.com/contracts-cairo/api/access](https://docs.openzeppelin.com/contracts-cairo/alpha/api/access)
44
55
This crate provides ways to restrict who can access the functions of a contract or when they can do it.
66

@@ -12,9 +12,9 @@ and assigned each to multiple accounts.
1212

1313
### Interfaces
1414

15-
- [`IAccessControl`](https://docs.openzeppelin.com/contracts-cairo/3.0.0-alpha.2/api/access#IAccessControl)
15+
- [`IAccessControl`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/access#IAccessControl)
1616

1717
### Components
1818

19-
- [`OwnableComponent`](https://docs.openzeppelin.com/contracts-cairo/3.0.0-alpha.2/api/access#OwnableComponent)
20-
- [`AccessControlComponent`](https://docs.openzeppelin.com/contracts-cairo/3.0.0-alpha.2/api/access#AccessControlComponent)
19+
- [`OwnableComponent`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/access#OwnableComponent)
20+
- [`AccessControlComponent`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/access#AccessControlComponent)

packages/account/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## Account
22

3-
> **NOTE:** This document is better viewed at [https://docs.openzeppelin.com/contracts-cairo/3.0.0-alpha.2/api/account](https://docs.openzeppelin.com/contracts-cairo/3.0.0-alpha.2/api/account)
3+
> **NOTE:** This document is better viewed at [https://docs.openzeppelin.com/contracts-cairo/api/account](https://docs.openzeppelin.com/contracts-cairo/alpha/api/account)
44
55
This crate provides components to implement account contracts that can be used for interacting with the network.
66

@@ -12,11 +12,11 @@ This crate provides components to implement account contracts that can be used f
1212

1313
### Interfaces
1414

15-
- [`ISRC6`](https://docs.openzeppelin.com/contracts-cairo/3.0.0-alpha.2/api/account#ISRC6)
16-
- [`ISRC9_V2`](https://docs.openzeppelin.com/contracts-cairo/3.0.0-alpha.2/api/account#ISRC9_V2)
15+
- [`ISRC6`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/account#ISRC6)
16+
- [`ISRC9_V2`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/account#ISRC9_V2)
1717

1818
### Components
1919

20-
- [`AccountComponent`](https://docs.openzeppelin.com/contracts-cairo/3.0.0-alpha.2/api/account#AccountComponent)
21-
- [`EthAccountComponent`](https://docs.openzeppelin.com/contracts-cairo/3.0.0-alpha.2/api/account#EthAccountComponent)
22-
- [`SRC9Component`](https://docs.openzeppelin.com/contracts-cairo/3.0.0-alpha.2/api/account#SRC9Component)
20+
- [`AccountComponent`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/account#AccountComponent)
21+
- [`EthAccountComponent`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/account#EthAccountComponent)
22+
- [`SRC9Component`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/account#SRC9Component)

packages/finance/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
## Finance
22

3-
> **NOTE:** Documentation will soon be added to [https://docs.openzeppelin.com/contracts-cairo](https://docs.openzeppelin.com/contracts-cairo)
3+
> **NOTE:** Documentation will soon be added to [https://docs.openzeppelin.com/contracts-cairo/finance](https://docs.openzeppelin.com/contracts-cairo/alpha/finance)
44
55
This crate includes primitives for financial systems.
66

77
### Interfaces
88

9-
- `IVesting`
9+
- [`IVesting`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/finance#IVesting)
1010

1111
### Components
1212

13-
- `VestingComponent`
13+
- [`VestingComponent`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/finance#VestingComponent)

packages/governance/README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
11
## Governance
22

3-
> **NOTE:** This document is better viewed at [https://docs.openzeppelin.com/contracts-cairo/3.0.0-alpha.2/api/governance](https://docs.openzeppelin.com/contracts-cairo/3.0.0-alpha.2/api/governance)
3+
> **NOTE:** This document is better viewed at [https://docs.openzeppelin.com/contracts-cairo/api/governance](https://docs.openzeppelin.com/contracts-cairo/alpha/api/governance)
44
55
This crate includes primitives for on-chain governance.
66

77
### Interfaces
88

9-
- [`IGovernor`](https://docs.openzeppelin.com/contracts-cairo/3.0.0-alpha.2/api/governance#IGovernor)
10-
- [`IMultisig`](https://docs.openzeppelin.com/contracts-cairo/3.0.0-alpha.2/api/governance#IMultisig)
11-
- [`ITimelock`](https://docs.openzeppelin.com/contracts-cairo/3.0.0-alpha.2/api/governance#ITimelock)
12-
- [`IVotes`](https://docs.openzeppelin.com/contracts-cairo/3.0.0-alpha.2/api/governance#IVotes)
9+
- [`IGovernor`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/governance#IGovernor)
10+
- [`IMultisig`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/governance#IMultisig)
11+
- [`ITimelock`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/governance#ITimelock)
12+
- [`IVotes`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/governance#IVotes)
1313

1414
### Components
1515

16-
- [`GovernorComponent`](https://docs.openzeppelin.com/contracts-cairo/3.0.0-alpha.2/api/governance#GovernorComponent)
16+
- [`GovernorComponent`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/governance#GovernorComponent)
1717

18-
- [`TimelockControllerComponent`](https://docs.openzeppelin.com/contracts-cairo/3.0.0-alpha.2/api/governance#TimelockControllerComponent)
19-
- [`VotesComponent`](https://docs.openzeppelin.com/contracts-cairo/3.0.0-alpha.2/api/governance#VotesComponent)
18+
- [`TimelockControllerComponent`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/governance#TimelockControllerComponent)
19+
- [`VotesComponent`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/governance#VotesComponent)
2020

2121
#### Governor Extensions
2222

23-
- [`GovernorCoreExecutionComponent`](https://docs.openzeppelin.com/contracts-cairo/3.0.0-alpha.2/api/governance#GovernorCoreExecutionComponent)
24-
- [`GovernorCountingSimpleComponent`](https://docs.openzeppelin.com/contracts-cairo/3.0.0-alpha.2/api/governance#GovernorCountingSimpleComponent)
25-
- [`GovernorSettingsComponent`](https://docs.openzeppelin.com/contracts-cairo/3.0.0-alpha.2/api/governance#GovernorSettingsComponent)
26-
- [`GovernorVotesComponent`](https://docs.openzeppelin.com/contracts-cairo/3.0.0-alpha.2/api/governance#GovernorVotesComponent)
27-
- [`GovernorVotesQuorumFractionComponent`](https://docs.openzeppelin.com/contracts-cairo/3.0.0-alpha.2/api/governance#GovernorVotesQuorumFractionComponent)
28-
- [`GovernorTimelockExecutionComponent`](https://docs.openzeppelin.com/contracts-cairo/3.0.0-alpha.2/api/governance#GovernorTimelockExecutionComponent)
23+
- [`GovernorCoreExecutionComponent`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/governance#GovernorCoreExecutionComponent)
24+
- [`GovernorCountingSimpleComponent`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/governance#GovernorCountingSimpleComponent)
25+
- [`GovernorSettingsComponent`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/governance#GovernorSettingsComponent)
26+
- [`GovernorVotesComponent`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/governance#GovernorVotesComponent)
27+
- [`GovernorVotesQuorumFractionComponent`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/governance#GovernorVotesQuorumFractionComponent)
28+
- [`GovernorTimelockExecutionComponent`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/governance#GovernorTimelockExecutionComponent)

packages/interfaces/README.md

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ List of standardized interfaces, ABI traits and dispatchers.
44

55
### Standardized Interfaces
66

7-
- `IAccessControlDefaultAdminRules`
8-
- `IAccessControl`
9-
- `IAccessControlWithDelay`
7+
- [`IAccessControlDefaultAdminRules`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/access#IAccessControlDefaultAdminRules)
8+
- [`IAccessControl`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/access#IAccessControl)
9+
- [`IAccessControlWithDelay`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/access#IAccessControlWithDelay)
1010
- `IAccessControlCamel`
1111
- `IOwnable`
1212
- `IOwnableCamelOnly`
1313
- `IOwnableTwoStep`
1414
- `IOwnableTwoStepCamelOnly`
15-
- `ISRC6`
15+
- [`ISRC6`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/account#ISRC6)
1616
- `ISRC6CamelOnly`
1717
- `IDeclarer`
1818
- `IDeployable`
@@ -21,49 +21,49 @@ List of standardized interfaces, ABI traits and dispatchers.
2121
- `IEthDeployable`
2222
- `IEthPublicKey`
2323
- `IEthPublicKeyCamel`
24-
- `ISRC9_V2`
25-
- `IVesting`
24+
- [`ISRC9_V2`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/account#ISRC9_V2)
25+
- [`IVesting`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/finance#IVesting)
2626
- `IQuorumFraction`
2727
- `IVotesToken`
2828
- `ITimelocked`
2929
- `IGovernorSettingsAdmin`
30-
- `IGovernor`
31-
- `IMultisig`
32-
- `ITimelock`
33-
- `IVotes`
30+
- [`IGovernor`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/governance#IGovernor)
31+
- [`IMultisig`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/governance#IMultisig)
32+
- [`ITimelock`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/governance#ITimelock)
33+
- [`IVotes`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/governance#IVotes)
3434
- `IInitializable`
3535
- `IPausable`
36-
- `IERC20`
37-
- `IERC20Metadata`
36+
- [`IERC20`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/token/erc20#IERC20)
37+
- [`IERC20Metadata`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/token/erc20#IERC20Metadata)
3838
- `IERC20Camel`
3939
- `IERC20CamelOnly`
4040
- `IERC20Mixin`
41-
- `IERC20Permit`
42-
- `IERC721`
43-
- `IERC721Metadata`
41+
- [`IERC20Permit`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/erc20#IERC20Permit)
42+
- [`IERC721`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/erc721#IERC721)
43+
- [`IERC721Metadata`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/erc721#IERC721Metadata)
4444
- `IERC721CamelOnly`
4545
- `IERC721MetadataCamelOnly`
4646
- `IERC721Mixin`
47-
- `IERC721Receiver`
47+
- [`IERC721Receiver`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/erc721#IERC721Receiver)
4848
- `IERC721ReceiverCamel`
4949
- `ERC721ReceiverMixin`
50-
- `IERC721Enumerable`
51-
- `IERC1155`
52-
- `IERC1155MetadataURI`
50+
- [`IERC721Enumerable`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/erc721#IERC721Enumerable)
51+
- [`IERC1155`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/erc1155#IERC1155)
52+
- [`IERC1155MetadataURI`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/erc1155#IERC1155MetadataURI)
5353
- `IERC1155Camel`
54-
- `IERC1155Receiver`
54+
- [`IERC1155Receiver`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/erc1155#IERC1155Receiver)
5555
- `IERC1155ReceiverCamel`
56-
- `IERC2981`
57-
- `IERC2981Info`
58-
- `IERC2981Admin`
59-
- `IERC4626`
60-
- `IUniversalDeployer`
56+
- [`IERC2981`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/token_common#IERC2981)
57+
- [`IERC2981Info`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/token_common#IERC2981Info)
58+
- [`IERC2981Admin`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/token_common#IERC2981Admin)
59+
- [`IERC4626`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/erc20#IERC4626)
60+
- [`IUniversalDeployer`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/udc#IUniversalDeployer)
6161
- `IUniversalDeployerCamel`
6262
- `INonces`
6363
- `ISNIP12Metadata`
64-
- `ISRC5`
65-
- `IUpgradeable`
66-
- `IUpgradeAndCall`
64+
- [`ISRC5`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/introspection#ISRC5)
65+
- [`IUpgradeable`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/upgrades#IUpgradeable)
66+
- [`IUpgradeAndCall`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/upgrades#IUpgradeAndCall)
6767

6868

6969
### ABI Traits

packages/introspection/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
## Introspection
22

3-
> **NOTE:** This document is better viewed at [https://docs.openzeppelin.com/contracts-cairo/3.0.0-alpha.2/api/introspection](https://docs.openzeppelin.com/contracts-cairo/3.0.0-alpha.2/api/introspection)
3+
> **NOTE:** This document is better viewed at [https://docs.openzeppelin.com/contracts-cairo/api/introspection](https://docs.openzeppelin.com/contracts-cairo/alpha/api/introspection)
44
55
This crate handles [type introspection](https://en.wikipedia.org/wiki/Type_introspection) of contracts. In other words, it examines which functions can be called on a given contract. This is referred to as the contract's interface.
66

77
### Interfaces
88

9-
- [`ISRC5`](https://docs.openzeppelin.com/contracts-cairo/3.0.0-alpha.2/api/introspection#ISRC5)
9+
- [`ISRC5`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/introspection#ISRC5)
1010

1111
### Components
1212

13-
- [`SRC5Component`](https://docs.openzeppelin.com/contracts-cairo/3.0.0-alpha.2/api/introspection#SRC5Component)
13+
- [`SRC5Component`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/introspection#SRC5Component)

packages/macros/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
## Macros
22

3-
> **NOTE:** This document is better viewed at [https://docs.openzeppelin.com/contracts-cairo/3.0.0-alpha.2/macros](https://docs.openzeppelin.com/contracts-cairo/3.0.0-alpha.2/macros)
3+
> **NOTE:** This document is better viewed at [https://docs.openzeppelin.com/contracts-cairo/macros](https://docs.openzeppelin.com/contracts-cairo/alpha/macros)
44
55
This crate provides a collection of macros that streamline and simplify development with the OpenZeppelin library.
66

77
### Attribute macros
88

9-
- [`with_components(..)`](https://docs.openzeppelin.com/contracts-cairo/3.0.0-alpha.2/macros/with_components)
10-
- [`type_hash(..)`](https://docs.openzeppelin.com/contracts-cairo/3.0.0-alpha.2/macros/type_hash)
9+
- [`with_components(..)`](https://docs.openzeppelin.com/contracts-cairo/alpha/macros/with_components)
10+
- [`type_hash(..)`](https://docs.openzeppelin.com/contracts-cairo/alpha/macros/type_hash)

packages/merkle_tree/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## Merkle Tree
22

3-
> **NOTE:** This document is better viewed at [https://docs.openzeppelin.com/contracts-cairo/3.0.0-alpha.2/api/merkle-tree](https://docs.openzeppelin.com/contracts-cairo/3.0.0-alpha.2/api/merkle-tree)
3+
> **NOTE:** This document is better viewed at [https://docs.openzeppelin.com/contracts-cairo/api/merkle-tree](https://docs.openzeppelin.com/contracts-cairo/alpha/api/merkle-tree)
44
55
This crate provides a set of utilities for verifying Merkle Tree proofs on-chain. The tree and the proofs can be
66
generated using this [JavaScript library](https://github.com/ericnordelo/strk-merkle-tree) both for Pedersen and Poseidon

packages/presets/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## Presets
22

3-
> **NOTE:** This document is better viewed at [https://docs.openzeppelin.com/contracts-cairo/3.0.0-alpha.2/presets](https://docs.openzeppelin.com/contracts-cairo/3.0.0-alpha.2/presets)
3+
> **NOTE:** This document is better viewed at [https://docs.openzeppelin.com/contracts-cairo/presets](https://docs.openzeppelin.com/contracts-cairo/alpha/presets)
44
55
Presets are ready-to-deploy contracts provided by the library. Since presets are intended to be very simple and as
66
generic as possible, there’s no support for custom or complex contracts such as `ERC20Pausable` or `ERC721Mintable`.
@@ -10,9 +10,9 @@ For contract customization and combination of modules you can use
1010

1111
### Presets
1212

13-
- [`AccountUpgradeable`](https://docs.openzeppelin.com/contracts-cairo/3.0.0-alpha.2/api/account#AccountUpgradeable)
14-
- [`ERC20Upgradeable`](https://docs.openzeppelin.com/contracts-cairo/3.0.0-alpha.2/api/erc20#ERC20Upgradeable)
15-
- [`ERC721Upgradeable`](https://docs.openzeppelin.com/contracts-cairo/3.0.0-alpha.2/api/erc721#ERC721Upgradeable)
16-
- [`ERC1155Upgradeable`](https://docs.openzeppelin.com/contracts-cairo/3.0.0-alpha.2/api/erc1155#ERC1155Upgradeable)
17-
- [`EthAccountUpgradeable`](https://docs.openzeppelin.com/contracts-cairo/3.0.0-alpha.2/api/account#EthAccountUpgradeable)
18-
- [`UniversalDeployer`](https://docs.openzeppelin.com/contracts-cairo/3.0.0-alpha.2/api/udc#UniversalDeployer)
13+
- [`AccountUpgradeable`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/account#AccountUpgradeable)
14+
- [`ERC20Upgradeable`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/erc20#ERC20Upgradeable)
15+
- [`ERC721Upgradeable`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/erc721#ERC721Upgradeable)
16+
- [`ERC1155Upgradeable`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/erc1155#ERC1155Upgradeable)
17+
- [`EthAccountUpgradeable`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/account#EthAccountUpgradeable)
18+
- [`UniversalDeployer`](https://docs.openzeppelin.com/contracts-cairo/alpha/api/udc#UniversalDeployer)

0 commit comments

Comments
 (0)