Skip to content

Commit a393319

Browse files
authored
chore: Update changelog for release (#251)
2 parents dfe5c97 + ed08f1c commit a393319

File tree

1 file changed

+78
-12
lines changed

1 file changed

+78
-12
lines changed

CHANGELOG.md

Lines changed: 78 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,101 @@
11
# Changelog
22

33
## vNEXT
4+
5+
## v6.0.0 - Diamond Proxy Pattern (ERC-2535)
6+
7+
### What's new?
8+
9+
#### 🚨 Breaking changes
10+
The proxy architecture has been migrated from [ERC-1538 Transparent Contract Standard](https://eips.ethereum.org/EIPS/eip-1538) to [ERC-2535 Diamond Standard](https://eips.ethereum.org/EIPS/eip-2535).
11+
12+
> **Impact:**
13+
> - **No changes** to on-chain business logic or contract interfaces used by regular clients.
14+
> - Existing integrations that interact with contract functions will **continue to work without modification**.
15+
> - **Breaking change** applies only to how the proxy’s upgrade mechanism works and how contract structure is exposed to **indexers, explorers, or tooling** that previously relied on ERC-1538’s upgrade API.
16+
17+
💡 **Versioning note:**
18+
Technically, since public APIs for business logic did not change, this could be a **minor release** under Semantic Versioning.
19+
However, because the upgrade proxy standard changed and this could impact **indexers and tooling**, releasing as a **major** version ensures better visibility of this architectural shift.
20+
21+
##### ❌ Removed functions and events (ERC-1538):
22+
23+
- `function totalFunctions(...)`
24+
- `function functionByIndex(...)`
25+
- `function functionById(...)`
26+
- `function functionExists(...)`
27+
- `function functionSignatures(...)`
28+
- `function delegateFunctionSignatures(...)`
29+
- `function delegateAddress(...)`
30+
- `function delegateAddresses(...)`
31+
- `function updateContract(...)`
32+
- `event CommitMessage(...)`
33+
- `event FunctionUpdate(...)`
34+
35+
##### ✨ New functions (ERC-2535)
36+
37+
- `function diamondCut(FacetCut[] calldata _diamondCut, address _init, bytes calldata _calldata)`
38+
- `function facets() external view returns (Facet[] memory)`
39+
- `function facetFunctionSelectors(address _facet) external view returns (bytes4[] memory)`
40+
- `function facetAddresses() external view returns (address[] memory)`
41+
- `function facetAddress(bytes4 _selector) external view returns (address)`
42+
- `event DiamondCut(FacetCut[] _diamondCut, address _init, bytes _calldata)`
43+
44+
### ✍️ Updated contracts
45+
All contracts have been updated (formatting, renaming, …) but **no breaking changes**
46+
have been introduced to the business logic.
47+
48+
### 🚀 Deployment & network support
49+
- The PoCo protocol is now available on **Arbitrum One Mainnet**.
50+
51+
### More details
52+
453
- Update docs and diagrams (#250)
5-
- Support Arbitrum One (#248)
6-
- Save IexecLibOrders_v5 in config file (#242)
7-
- Migrate proxy to Diamond pattern (ERC-2535):
8-
- Use lib as storage. (#243)
54+
- Deploy on Arbitrum Mainnet (#249)
55+
- Add support for Arbitrum Mainnet (#248)
56+
- Publish NPM package for version `v5.6.0-rc1` (#247)
57+
- Deploy on Arbitrum Sepolia (#246)
58+
- Set owner at deployment (#245)
59+
- Use lib as storage. (#243)
60+
- Save `IexecLibOrders_v5` in config file (#242)
61+
- Migrate proxy to **Diamond pattern - ERC-2535** (#241):
962
- Restore compatibility with iExec SDK. (#240)
1063
- Target latest EVM version (#239)
1164
- Adapt contracts file tree (#238)
1265
- Use namespaced storage (#236, #237)
1366
- Fix script folder (#235)
1467
- Format all solidity files (#233)
15-
- Rename ERC1538 architure to diamond Proxy architecture(#226, #229, #230, #234)
68+
- Replace ERC1538 wording by diamond Proxy wording (#229, #230, #234)
69+
- Update deployment CI (#228)
70+
- Format contracts (#227)
1671
- Remove ENS module (#225)
1772
- Add Diamond contract unit tests (#224)
1873
- Fix `fallback` and `receive` (#223)
19-
- Migrate contracts (#222)
20-
- Add Github Action CI in order to publish NPM package
74+
- Init contracts migration (#222)
75+
76+
## v5.5.1 - Fresh development environment
77+
78+
### What's new?
79+
80+
- Add some small optimizations to `IexecPoco2Delegate` contract (#167, #168).
81+
- Add support for CreateX factory.
82+
- Migrate to Ethers v6.
83+
- Migrate all Javascript files to Typescript.
84+
- Purge Truffle.
85+
- Migrate CI from Jenkins to Github Actions.
2186

2287
### Updated contracts
2388

2489
- [x] `IexecPoco2Delegate.sol`
2590

26-
### Features
27-
<!-- TODO update this with v5.5.1 release notes -->
91+
### More details
92+
93+
- Release v5.5.1 #220
2894
- Add gitub action workflow for deployment (#218)
29-
- Fix new testnets chain name (#217)
95+
- Rename Avalanche Fuji and Arbitrum Sepolia network configuration (#217)
3096
- Deploy on new testnet chains using CreateX factory (#216)
3197
- Add CreateX factory for new chain deployment (#215)
32-
- Support Arbitrum & Avalanche Fuji testnets (#215)
98+
- Add Github Action CI in order to publish NPM package (#214)
3399
- Housekeeping (#208)
34100
- Add Halborn "Poco v5.5 & Voucher v1.0" audit report (#205)
35101
- Refactor Factory deployer (#206)
@@ -80,7 +146,7 @@
80146
- kitty (#142, #144)
81147
- reopen (#135)
82148

83-
## v5.5.0
149+
## v5.5.0 - Deal sponsoring
84150

85151
### What's new?
86152

0 commit comments

Comments
 (0)