Story Protocol SDK v1.3.0 技术解析与升级指南

Story Protocol SDK v1.3.0 技术解析与升级指南

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

Story Protocol 是一个专注于数字内容创作与管理的区块链协议，其 SDK 为开发者提供了便捷的接口来构建基于区块链的内容应用。最新发布的 v1.3.0 版本带来了多项重要改进，特别是在许可证管理、争议解决机制和开发者体验方面有显著提升。

核心功能增强

许可证令牌铸造规则强化

在 mintLicenseTokens 方法中，新版本加强了对许可证条款附加规则的执行。特别值得注意的是，系统现在会为默认条款和IP所有者创建例外情况。这一改进确保了在特殊情况下也能正确执行许可证的发放，同时不会影响正常的业务逻辑。

争议模块保证金机制优化

争议解决模块现在引入了最低保证金要求（0.1 IP），并且将保证金参数设为可选，默认使用最低要求值。这一变化既保证了争议解决的经济安全性，又简化了开发者的调用流程。同时，取消和解决争议方法中的数据字段现在变为可选参数，提高了接口的灵活性。

衍生客户端地址获取

BIP32工具模块新增了 getDerivedStoryClient 方法，现在不仅返回客户端实例，还会返回对应的地址信息。这一改进使得开发者能够更方便地管理多个衍生账户。

重要问题修复

多数据条目处理修正

修复了 tagIfRelatedIpInfringed 方法在 useMulticallWhenPossible 设为 false 时处理多个数据条目的问题。原版本在非多调用模式下仅测试了单条目情况，导致并发执行时可能出现 nonce 冲突。新版本确保了在各种配置下都能正确处理多个数据条目。

衍生作品注册授权修复

修正了 registerDerivative 方法中授权对象错误分配的问题，将原本错误的 royaltyTokenDistributionWorkflows 更正为 royaltyModule。这一修复确保了版税分配的授权能够正确执行。

争议模块交易等待机制

争议模块中的 approve 交易现在会被正确等待完成后再继续后续操作，避免了潜在的竞态条件问题。这一改进显著提升了模块的可靠性。

开发者体验优化

测试覆盖率提升

新版本大幅增加了对争议、许可证和版税模块的集成测试覆盖率。特别是针对 batchClaimAllRevenue 方法的行为验证，新增了多个测试用例，确保其在各种边界条件下的表现符合预期。

文档改进

代码注释得到了全面增强，特别是在客户端和争议模块部分。配置文件文档也进行了优化，提高了可读性和可维护性。项目文档结构也进行了调整，将设置和测试说明移到了专门的贡献指南文件中，使主文档更加简洁明了。

升级建议

对于从 v1.2.x 版本升级的用户，建议重点关注以下方面：

1. 争议模块的最低保证金要求变更
2. 许可证管理接口的参数调整
3. 衍生客户端方法的返回值变化

新版本在保持向后兼容性的同时，提供了更健壮的功能实现和更完善的开发者工具。建议所有用户尽快升级以获得最佳体验。

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