v1.3.2

SDK v1.3.2 Release Notes

Version 1.3.2 introduces support for new license types, standardizes dispute handling, and simplifies transaction flows with auto-await behavior. It also includes key architectural improvements, such as unified option handling and stricter chainId typing. Some changes require updates to existing implementations. See the Migration Guide below for details.

Features & Enhancements

• Adds the registerCreativeCommonsAttributionPIL function to the License module. PR(#515)
• Refactored the License module to support the registration of multiple license types by extracting shared logic into a common registerPILTermsHelper method. PR(#515)
• The Royalty module now returns claimedTokens when claimAllRevenue is called from a non-owner account PR(#526)
• All transactions are now automatically awaited; waitForTransaction is no longer supported or required. This simplifies transaction handling, avoids issues with multi-TX flows, and improves the default developer experience. PR(#548)

Breaking Changes

• Updates the RaiseDisputeRequest enum in the Dispute module so it can be used instead of a string for the targetTag property. PR(#521)
• In the Royalty module, royaltyVaultIpId was renamed to ipId. PR(#523)
• Improves chainId handling by changing its type from string to number and updating how getPermissionSignature and getSignature retrieve it. PR(#527)
• The txHash field in all modules has changed from string to Hash. PR(#545)
• Consolidates all option parameters (e.g., wipOptions, erc20Options) into a single optional options object. All public client methods that accept options now use this unified property. PR(#547)

Migration Guide

Migrating from v1.2.x

• Please refer to the 1.3.0-rc.1 release notes.

Migration from v1.3.x

• Change the chainId parameter type to ChainIds in the getPermissionSignature and getSignature methods, replacing the previous string | number | bigint type.
• Update the ChainIds definition from string literals ("1315" | "1514") to numeric literals (1315 | 1514) when initializing the Story client.
• In the Royalty module, when using the ClaimableRevenueRequest the royaltyVaultIpId field should now be ipId.

Old Syntax:

const x = await client.royalty.claimableRevenue({
        royaltyVaultIpId: PARENT_IP_ID,
        claimer: PARENT_IP_ID,
        token: WIP_TOKEN_ADDRESS,
    })

New Syntax:

const x = await client.royalty.claimableRevenue({
        ipId: PARENT_IP_ID,
        claimer: PARENT_IP_ID,
        token: WIP_TOKEN_ADDRESS,
    })

• Developers must now move wipOptions and erc20Options into the unified options object when using client methods. Example:

Old syntax:

await client.ipAsset.batchRegisterIpAssetsWithOptimizedWorkflows({
        requests: requests,
        wipOptions: {
          useMulticallWhenPossible: false,
        },
      });

New syntax:

 await client.ipAsset.batchRegisterIpAssetsWithOptimizedWorkflows({
        requests: requests,
        options: {
          wipOptions: {
            useMulticallWhenPossible: false,
          },
        },
      });

• In all modules, the txHash field must be changed from a string to a Hex.