Skip to content

Commit 7e84f1b

Browse files
authored
Release v1.3.1 (#179)
* chore: release v1.3.1 * update package.json
1 parent 5eb2e58 commit 7e84f1b

File tree

9 files changed

+67
-52
lines changed

9 files changed

+67
-52
lines changed

CHANGELOG.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,25 @@
11
# CHANGELOG
22

3+
## v1.3.1
4+
5+
This release builds on v1.3.0 with **enhanced security, improved code efficiency, and expanded test coverage**, while ensuring **workflow contract backward compatibility** and improving **permission handling**.
6+
7+
- Ensured **workflow contracts maintain backward compatibility** ([#165](https://github.com/storyprotocol/protocol-periphery-v1/pull/165), [#166](https://github.com/storyprotocol/protocol-periphery-v1/pull/166))
8+
- **Replaced permanent permission with transient permission** ([#176](https://github.com/storyprotocol/protocol-periphery-v1/pull/176))
9+
- **Other security fixes** ([#175](https://github.com/storyprotocol/protocol-periphery-v1/pull/175)):
10+
- Ensured `msg.sender` matches `signer` in workflow contracts
11+
- Used `safeERC20` in `SPGNFT`
12+
- Added initializers for **future-proofing**
13+
- Made `nonReentrant` modifier **precede all other modifiers** in `TokenizerModule`
14+
- Allowed setting `TotalLicenseTokenLimit` to `0` (no limit) in licensing hook
15+
- Replaced `_mint` with `_safeMint` in `SPGNFT`
16+
- **Refactored** `OrgStoryNFTFactory` contract to **reduce code redundancy** ([#156](https://github.com/storyprotocol/protocol-periphery-v1/pull/156))
17+
- **Added new integration tests** and fixed existing ones ([#162](https://github.com/storyprotocol/protocol-periphery-v1/pull/162), [#177](https://github.com/storyprotocol/protocol-periphery-v1/pull/177))
18+
- **Fixed typos and improved documentation/comments** ([#163](https://github.com/storyprotocol/protocol-periphery-v1/pull/163), [#164](https://github.com/storyprotocol/protocol-periphery-v1/pull/164), [#167](https://github.com/storyprotocol/protocol-periphery-v1/pull/167), [#168](https://github.com/storyprotocol/protocol-periphery-v1/pull/168), [#169](https://github.com/storyprotocol/protocol-periphery-v1/pull/169), [#173](https://github.com/storyprotocol/protocol-periphery-v1/pull/173))
19+
20+
21+
**Full Changelog**: [v1.3.0...v1.3.1](https://github.com/storyprotocol/protocol-periphery-v1/compare/v1.3.0...v1.3.1)
22+
323
## v1.3.0
424

525
- **Story NFT & Badge Enhancements**

README.md

Lines changed: 6 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,14 @@ For access to the core PoC contracts, please visit the [protocol-core-v1](https:
1818
>📘 **[Learn more about Story](https://docs.storyprotocol.xyz/)**
1919
2020
Story PoC Periphery combines multiple common independent interactions with the Story PoC Protocol into a single transaction.
21-
For example, this `mintAndRegisterIpAndAttachPILTerms` is one of the functions that allows you to mint an NFT, register it as an IP Asset, and attach License Terms to it all in one call.
21+
For example, this `mintAndRegisterIpAndAttachPILTerms` is one of the functions that allows you to mint an NFT, register it as an IP Asset, attach License Terms, and setting Licensing Configuration all in one call.
2222
```solidity
2323
function mintAndRegisterIpAndAttachPILTerms(
24-
address nftContract,
24+
address spgNftContract,
2525
address recipient,
26-
IPMetadata calldata ipMetadata,
27-
PILTerms calldata terms
26+
WorkflowStructs.IPMetadata calldata ipMetadata,
27+
WorkflowStructs.LicenseTermsData[] calldata licenseTermsData,
28+
bool allowDuplicates
2829
) external onlyCallerWithMinterRole(nftContract) returns (address ipId, uint256 tokenId, uint256 licenseTermsId)
2930
```
3031

@@ -36,19 +37,8 @@ Batch calling functions is supported both natively and through the `Multicall3`
3637

3738
### Deployed Contracts
3839

39-
[![Version](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fraw.githubusercontent.com%2Fstoryprotocol%2Fprotocol-periphery-v1%2Fmain%2Fpackage.json&query=%24.version&label=PoC%20Periphery)](https://github.com/storyprotocol/protocol-periphery-v1/releases) contracts are deployed on Story Testnet at the following addresses:
40+
[![Version](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fraw.githubusercontent.com%2Fstoryprotocol%2Fprotocol-periphery-v1%2Fmain%2Fpackage.json&query=%24.version&label=PoC%20Periphery)](https://github.com/storyprotocol/protocol-periphery-v1/releases) contracts are deployed on Story. The contract addresses can be found in [deployment-1315.json](./deploy-out/deployment-1315.json) (Story Aeneid Testnet) and [deployment-1514.json](./deploy-out/deployment-1514.json) (Story Homer Mainnet).
4041

41-
```json
42-
{
43-
"DerivativeWorkflows": "0xE0e1d222E024bF14B1e0A4b48fC6e6B6F8ebaEB3",
44-
"GroupingWorkflows": "0xfAa9CCd49DCDfB9a950CBF036cD6082e623a6bcC",
45-
"LicenseAttachmentWorkflows": "0xC7A40c41Cbe44C6B326447081877d69F98127C59",
46-
"RegistrationWorkflows": "0x8D8E0d24E7B6420d3209EfA185Fa451c95D8316A",
47-
"RoyaltyWorkflows": "0x19E435b1C0857375F9423C8ba508203054CE1d9F",
48-
"SPGNFTBeacon": "0xD753c698aE69194C851d60BF759d537DE7477696",
49-
"SPGNFTImpl": "0xA12e66a4429c9B7f38893c9b00E80646e0e76446"
50-
}
51-
```
5242

5343
## Quick Start
5444

deploy-out/deployment-11155111.json

Lines changed: 0 additions & 7 deletions
This file was deleted.

deploy-out/deployment-1315.json

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"main": {
3+
"DerivativeWorkflows": "0x9e2d496f72C547C2C535B167e06ED8729B374a4f",
4+
"GroupingWorkflows": "0xD7c0beb3aa4DCD4723465f1ecAd045676c24CDCd",
5+
"LicenseAttachmentWorkflows": "0xcC2E862bCee5B6036Db0de6E06Ae87e524a79fd8",
6+
"LockLicenseHook": "0x5D874d4813c4A8A9FB2AB55F30cED9720AEC0222",
7+
"OwnableERC20Beacon": "0x9a81C447C0b4C47d41d94177AEea3511965d3Bc9",
8+
"OwnableERC20Template": "0x37DbEbcFe991901C4F255E7a3C4F7D3B45EAEDe9",
9+
"RegistrationWorkflows": "0xbe39E1C756e921BD25DF86e7AAa31106d1eb0424",
10+
"RoyaltyTokenDistributionWorkflows": "0xa38f42B8d33809917f23997B8423054aAB97322C",
11+
"RoyaltyWorkflows": "0x9515faE61E0c0447C6AC6dEe5628A2097aFE1890",
12+
"SPGNFTBeacon": "0xD2926B9ecaE85fF59B6FB0ff02f568a680c01218",
13+
"SPGNFTImpl": "0xc09e3788Fdfbd3dd8CDaa2aa481B52CcFAb74a42",
14+
"TokenizerModule": "0x7e14cD9833E8A0c649bCF4AB6768f62D57febbd3",
15+
"TotalLicenseTokenLimitHook": "0xba8E30d9EB784Badc2aF610F56d99d212BC2A90c"
16+
}
17+
}

deploy-out/deployment-1513.json

Lines changed: 0 additions & 11 deletions
This file was deleted.

deploy-out/deployment-1514.json

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"main": {
3+
"DerivativeWorkflows": "0x9e2d496f72C547C2C535B167e06ED8729B374a4f",
4+
"GroupingWorkflows": "0xD7c0beb3aa4DCD4723465f1ecAd045676c24CDCd",
5+
"LicenseAttachmentWorkflows": "0xcC2E862bCee5B6036Db0de6E06Ae87e524a79fd8",
6+
"LockLicenseHook": "0x5D874d4813c4A8A9FB2AB55F30cED9720AEC0222",
7+
"OwnableERC20Beacon": "0x9a81C447C0b4C47d41d94177AEea3511965d3Bc9",
8+
"OwnableERC20Template": "0xE6505ffc5A7C19B68cEc2311Cc35BC02d8f7e0B1",
9+
"RegistrationWorkflows": "0xbe39E1C756e921BD25DF86e7AAa31106d1eb0424",
10+
"RoyaltyTokenDistributionWorkflows": "0xa38f42B8d33809917f23997B8423054aAB97322C",
11+
"RoyaltyWorkflows": "0x9515faE61E0c0447C6AC6dEe5628A2097aFE1890",
12+
"SPGNFTBeacon": "0xD2926B9ecaE85fF59B6FB0ff02f568a680c01218",
13+
"SPGNFTImpl": "0x6Cfa03Bc64B1a76206d0Ea10baDed31D520449F5",
14+
"TokenizerModule": "0xAC937CeEf893986A026f701580144D9289adAC4C",
15+
"TotalLicenseTokenLimitHook": "0xB72C9812114a0Fc74D49e01385bd266A75960Cda"
16+
}
17+
}

deploy-out/deployment-1516.json

Lines changed: 0 additions & 11 deletions
This file was deleted.

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@story-protocol/protocol-periphery",
3-
"version": "v1.3.0",
3+
"version": "v1.3.1",
44
"description": "Story Proof-of-Creativity protocol periphery smart contracts",
55
"main": "",
66
"directories": {
@@ -39,7 +39,7 @@
3939
"dependencies": {
4040
"@openzeppelin/contracts": "5.2.0",
4141
"@openzeppelin/contracts-upgradeable": "5.2.0",
42-
"@story-protocol/protocol-core": "github:storyprotocol/protocol-core-v1#main",
42+
"@story-protocol/protocol-core": "github:storyprotocol/protocol-core-v1#v1.3.1",
4343
"erc6551": "^0.3.1",
4444
"solady": "^0.0.281"
4545
}

yarn.lock

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -416,9 +416,9 @@
416416
resolved "https://registry.yarnpkg.com/@solidity-parser/parser/-/parser-0.19.0.tgz#37a8983b2725af9b14ff8c4a475fa0e98d773c3f"
417417
integrity sha512-RV16k/qIxW/wWc+mLzV3ARyKUaMUTBy9tOLMzFhtNSKYeTAanQ3a5MudJKf/8arIFnA2L27SNjarQKmFg0w/jA==
418418

419-
"@story-protocol/protocol-core@github:storyprotocol/protocol-core-v1#main":
419+
"@story-protocol/protocol-core@github:storyprotocol/protocol-core-v1#v1.3.1":
420420
version "1.1.0"
421-
resolved "https://codeload.github.com/storyprotocol/protocol-core-v1/tar.gz/a10c179c93cc7d360bcd9a290cd159c1574928f2"
421+
resolved "https://codeload.github.com/storyprotocol/protocol-core-v1/tar.gz/a0cddb1d712566a550fcaca2f8df1f4f67f095ad"
422422
dependencies:
423423
"@openzeppelin/contracts" "5.2.0"
424424
"@openzeppelin/contracts-upgradeable" "5.2.0"
@@ -2138,9 +2138,9 @@ reduce-flatten@^2.0.0:
21382138
integrity sha512-EJ4UNY/U1t2P/2k6oqotuX2Cc3T6nxJwsM0N0asT7dhrtH1ltUxDn4NalSYmPE2rCkVpcf/X6R0wDwcFpzhd4w==
21392139

21402140
registry-auth-token@^5.0.1:
2141-
version "5.0.3"
2142-
resolved "https://registry.yarnpkg.com/registry-auth-token/-/registry-auth-token-5.0.3.tgz#417d758c8164569de8cf5cabff16cc937902dcc6"
2143-
integrity sha512-1bpc9IyC+e+CNFRaWyn77tk4xGG4PPUyfakSmA6F6cvUDjrm58dfyJ3II+9yb10EDkHoy1LaPSmHaWLOH3m6HA==
2141+
version "5.1.0"
2142+
resolved "https://registry.yarnpkg.com/registry-auth-token/-/registry-auth-token-5.1.0.tgz#3c659047ecd4caebd25bc1570a3aa979ae490eca"
2143+
integrity sha512-GdekYuwLXLxMuFTwAPg5UKGLW/UXzQrZvH/Zj791BQif5T05T0RsaLfHc9q3ZOKi7n+BoprPD9mJ0O0k4xzUlw==
21442144
dependencies:
21452145
"@pnpm/npm-conf" "^2.1.0"
21462146

0 commit comments

Comments
 (0)