StoryProtocol SDK中关于royalty.payRoyaltyOnBehalf方法的优化建议

StoryProtocol SDK中关于royalty.payRoyaltyOnBehalf方法的优化建议

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

在StoryProtocol SDK的开发过程中，我们发现了一个关于royalty.payRoyaltyOnBehalf方法的潜在优化点。该方法用于代表其他IP资产支付版税，当前实现中对payerIpId参数进行了不必要的严格校验，这可能会限制某些合法使用场景。

当前实现的问题

在现有代码中，payRoyaltyOnBehalf方法会对传入的payerIpId进行严格校验，要求该ID必须是已注册的IP资产。这种校验逻辑源自IP资产注册表的isRegistered方法，该方法会执行多重验证：

1. 检查地址是否为0地址
2. 验证地址是否有代码
3. 检查是否支持IIPAccount接口
4. 验证token信息是否匹配
5. 确认NAME字段不为空

然而，在某些业务场景下，允许payerIpId为0地址是有实际意义的，比如当支付方不是特定IP资产而是普通账户时。

技术解决方案

更合理的实现应该是在校验payerIpId时增加对0地址的特殊处理。具体来说，可以修改为：

if(payerId !== address(0)){
    const isPayerRegistered = await this.ipAssetRegistryClient.isRegistered({
        id: getAddress(request.payerIpId, "request.payerIpId"),
    });
    if (!isPayerRegistered) {
        throw new Error(`The payer IP with id ${request.payerIpId} is not registered.`);
    }
}

这种修改保留了原有校验逻辑的严谨性，同时为0地址的特殊情况提供了灵活性。

设计考量

这种修改体现了几个重要的设计原则：

1. 向后兼容：不影响现有合法调用
2. 业务灵活性：支持更多支付场景
3. 安全性：仍然确保非0地址的payerIpId必须符合所有注册要求

实施建议

在实际开发中，建议：

1. 更新SDK代码中的校验逻辑
2. 同步更新相关文档，明确说明0地址的特殊含义
3. 在测试用例中增加对0地址场景的覆盖

这种改进将使SDK更加灵活，同时保持其安全性和可靠性，为开发者提供更好的使用体验。

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