Skip to content

v1.4.2

Choose a tag to compare

@lucas2brh lucas2brh released this 20 Nov 12:25
· 22 commits to main since this release
34ff58a

TypeScript SDK v1.4.2 Release Notes

This patch release includes auto-approval for ERC‑20 and license tokens, deprecation of legacy IP asset methods, and fixes an outdated link in the License Template documentation.

Key Changes

Deprecation of Legacy IP Asset Methods (#654)

To simplify the API surface and keep method names memorable, the verbose IP asset workflows have been deprecated. They now surface deprecation warnings that point developers to the unified entry points introduced in v1.4.0 (registerIpAsset, registerDerivativeIpAsset, and linkDerivative). These deprecated methods will become internal soon, so please migrate using the mappings below.

Registration workflows → registerIpAsset:

  • mintAndRegisterIp
  • mintAndRegisterIpAssetWithPilTerms
  • registerIpAndAttachPilTerms
  • mintAndRegisterIpAndAttachPilTermsAndDistributeRoyaltyTokens
  • registerIPAndAttachLicenseTermsAndDistributeRoyaltyTokens

Derivative workflows → registerDerivativeIpAsset:

  • mintAndRegisterIpAndMakeDerivative
  • registerDerivativeIp
  • mintAndRegisterIpAndMakeDerivativeAndDistributeRoyaltyTokens
  • registerDerivativeIpAndAttachLicenseTermsAndDistributeRoyaltyTokens
  • mintAndRegisterIpAndMakeDerivativeWithLicenseTokens
  • registerIpAndMakeDerivativeWithLicenseTokens

Link workflows → linkDerivative:

  • registerDerivative
  • registerDerivativeWithLicenseTokens

All deprecated methods include migration examples inside their JSDoc comments, so TypeScript users get inline guidance during upgrades.

Auto-Approve ERC‑20 Tokens (#658)

The following methods now automatically approve ERC‑20 tokens for royalty payments and SPG mint fees when allowance is insufficient. Previously, auto-approval applied only to WIP tokens.

Note: Multicall is not supported for ERC‑20 auto-approval. When using multicall, msg.sender becomes the multicall contract address instead of the user's wallet, so it cannot approve tokens on behalf of the user.

Affected methods:

  • registerDerivative
  • mintAndRegisterIpAssetWithPilTerms
  • registerDerivativeIp
  • mintAndRegisterIpAndMakeDerivative
  • mintAndRegisterIp
  • mintAndRegisterIpAndMakeDerivativeWithLicenseTokens
  • registerDerivativeIpAndAttachLicenseTermsAndDistributeRoyaltyTokens
  • mintAndRegisterIpAndAttachPilTermsAndDistributeRoyaltyTokens
  • mintAndRegisterIpAndMakeDerivativeAndDistributeRoyaltyTokens
  • batchRegisterIpAssetsWithOptimizedWorkflows
  • registerIpAsset
  • registerDerivativeIpAsset
  • linkDerivative
  • mintLicenseTokens

Automatic License Token Approval (#663)

Added autoApproveLicenseTokens parameter (default: true) to simplify license token approval.

Applicable methods:

  • registerIpAndMakeDerivativeWithLicenseTokens
  • mintAndRegisterIpAndMakeDerivativeWithLicenseTokens
  • registerDerivativeIpAsset (calls the above two methods internally)

Other Changes

  • Fixed outdated links in the license template documentation to ensure all references are valid. (#666)

Migration from v1.3.x

If you are upgrading from v1.3.x, please refer to the migration guide.