Story Protocol核心SDK 1.3.0版本升级详解

Story Protocol核心SDK 1.3.0版本升级详解

sdk Story Protocol TypeScript SDK 项目地址: https://gitcode.com/gh_mirrors/sdk28/sdk

项目简介

Story Protocol是一个专注于知识产权(IP)资产管理的区块链协议，其核心SDK为开发者提供了在区块链上创建、管理和交易IP资产的工具集。最新发布的1.3.0版本带来了多项重要更新，特别是在IP资产管理、版权支付和争议处理等方面进行了显著增强。

主要更新内容

1. 许可配置优化

1.3.0版本对IP资产注册时的许可配置进行了简化。现在，当注册带有PIL(Protocol IP License)条款的IP资产时，许可配置变为可选参数。如果开发者不提供，SDK将自动使用默认配置：

{
  "isSet": false,
  "mintingFee": 0,
  "licensingHook": "0x0000000000000000000000000000000000000000",
  "hookData": "0x0000000000000000000000000000000000000000",
  "commercialRevShare": 0,
  "disabled": false,
  "expectMinimumGroupRewardShare": 0,
  "expectGroupRewardPool": "0x0000000000000000000000000000000000000000"
}

这一改变显著降低了开发者的使用门槛，特别是在快速原型开发阶段。

2. 衍生IP资产注册简化

对于衍生IP资产的注册，1.3.0版本将多个参数设为可选：

• maxMintingFee：默认值为0，表示不设最大铸造费用限制
• maxRts：默认值为100,000,000
• maxRevenueShare：默认值为100(表示100%)

特别需要注意的是，maxRevenueShare在内部会被转换为基于100,000,000个版权代币的绝对值。例如，50%会转换为50,000,000。

3. 争议处理功能增强

新版本引入了两个强大的争议处理方法：

tagIfRelatedIpInfringed方法：当父IP或群组成员IP被标记为侵权时，可以自动标记相关衍生IP或群组IP。该方法支持多调用(Multicall)优化，能显著降低gas费用。

disputeAssertion方法：允许IP所有者通过提供反证来反驳争议。开发者需要先将反证材料(如文档、图片)上传至IPFS，然后将对应的CID传递给该方法。

4. 版权收益管理改进

新增的batchClaimAllRevenue方法支持批量处理多个版权收益申领请求，极大简化了版权收益管理流程。该方法能自动处理以下操作：

1. 从指定的祖先IP的子IP中申领所有收益
2. 将货币代币从IP账户转移到申领者钱包
3. 自动将WIP代币转换为IP代币

该方法支持灵活的配置选项，开发者可以根据需要禁用自动转账或代币转换功能。

5. WIP代币功能增强

WIP(Wrapper IP Tokens)客户端新增了两个方法：

• transfer：将指定数量的WIP代币转移到接收方
• transferForm：在两个账户之间转移指定数量的WIP代币

同时，NFT客户端新增了getMintFeeToken和getMintFee方法，帮助开发者确定铸造SPG NFT集合所需的WIP或其他ERC20代币数量。

6. 自动ERC20批准功能

payRoyaltyOnBehalf方法现在支持自动批准ERC20代币用于版权支付，而不仅限于WIP代币。这一改进简化了版权支付流程，开发者不再需要手动处理代币批准操作。

7. IP元数据标准更新

1.3.0版本对IP元数据处理进行了多项改进：

• generateCreatorMetadata不再为未提供的属性设置空默认值
• generateIpMetadata的请求类型已更新，以符合最新的IPA元数据标准
• IpRelationship中的type属性从字符串改为枚举类型，所有支持的值现在都已明确定义

升级建议

对于从1.2.x版本升级的开发者，建议先参考1.3.0-beta.2版本的迁移指南。从1.3.0-beta.3升级到1.3.0-rc.1时，主要需要注意IP元数据请求类型和IP关系类型的变更。

新版本通过简化配置、增强功能和优化流程，显著提升了开发体验。特别是批量处理和自动批准等功能的加入，将帮助开发者更高效地构建基于Story Protocol的应用。

sdk Story Protocol TypeScript SDK 项目地址: https://gitcode.com/gh_mirrors/sdk28/sdk