Story Protocol核心SDK v1.3.0-beta.2升级解析-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_01319/article/details/148551980

Story Protocol核心SDK v1.3.0-beta.2升级解析

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

Story Protocol是一个专注于数字内容资产管理的区块链协议，其核心SDK为开发者提供了便捷的接口来与协议交互。最新发布的v1.3.0-beta.2版本带来了多项重要更新，本文将深入解析这些技术改进及其应用场景。

测试网络迁移：从Homer到Aeneid

本次更新最显著的变化是测试网络的迁移。开发环境已从原有的Homer测试网切换至全新的Aeneid测试网。这一变更要求所有开发者在使用SDK时更新chainId配置：

StoryClient.newClient({
  chainId: "aeneid",
  transport: http(RPC),
});

测试网络的迁移通常伴随着底层基础设施的升级和优化，开发者需要特别注意这一变更，确保开发环境与新网络兼容。

Wrapped IP (WIP)客户端

新版本引入了WIP客户端，实现了IP资产与WIP代币之间的双向转换功能：

IP转WIP：通过deposit方法实现

await client.wipClient.deposit({
  amount,
  txOptions: { waitForTransaction: true },
});

WIP转IP：通过withdraw方法实现

await client.wipClient.withdraw({
  amount,
  txOptions: { waitForTransaction: true },
});

此外，新增的balanceOf方法允许查询特定地址的WIP余额：

await client.wipClient.balanceOf("0x...");

WIP机制为IP资产提供了更灵活的流动性，使IP资产能够更方便地参与各类DeFi应用。

增强版版税功能

claimAllRevenue方法

新增的claimAllRevenue方法极大地简化了版税收益的提取流程。该方法可以自动处理以下操作：

从指定IP资产的所有子IP中提取收益
自动将收益从IP账户转移到用户钱包
自动将WIP转换回IP（默认启用）

开发者可以通过配置选项灵活控制这些自动化行为：

await client.royalty.claimAllRevenue({
  claimOptions: {
    autoTransferAllClaimedTokensFromIp: false, // 禁用自动转账
    autoUnwrapIpTokens: false // 禁用自动WIP转IP
  }
});

智能IP-WIP转换机制

新版本引入了创新的IP-WIP自动转换系统，显著提升了用户体验：

自动转换流程

当用户钱包WIP余额不足时，SDK会自动执行以下操作：

将用户IP转换为WIP
授权SPG合约使用WIP
执行目标操作

为提高效率，SDK默认使用Multicall技术将这些操作打包为单笔交易。目前支持自动转换的主要方法包括：

license.mintLicenseTokens
ipAsset.mintAndRegisterIpAssetWithPilTerms
ipAsset.mintAndRegisterIpAndMakeDerivativeWithLicenseTokens
以及其他多个IP资产相关方法

自定义配置

开发者可以通过wipOptions精细控制转换行为：

client.ipAsset.registerDerivativeIp({
  wipOptions: {
    enableAutoWrapIp: false, // 禁用自动转换
    useMulticallWhenPossible: false, // 禁用Multicall
    enableAutoApprove: false // 禁用自动授权
  }
})