Skip to content

feat: deprecate legacy IP asset methods in favor of unified entry points#654

Merged
bonnie57 merged 2 commits intomainfrom
TSSDK-122
Nov 4, 2025
Merged

feat: deprecate legacy IP asset methods in favor of unified entry points#654
bonnie57 merged 2 commits intomainfrom
TSSDK-122

Conversation

@bonnie57
Copy link
Contributor

@bonnie57 bonnie57 commented Nov 3, 2025

Description

This PR suggests deprecating specific registration methods in favor of unified entry point methods (registerIpAsset, registerDerivativeIpAsset) to simplify the API surface and improve developer experience. The current naming scheme, while descriptive, results in method names up to 71 characters long that are difficult to remember and type.

Key Strategy:

  • Deprecate verbose methods - Methods like mintAndRegisterIpAndMakeDerivative will be deprecated
  • Promote unified entry points - Direct users to registerIpAsset() ,linkDerivative and registerDerivativeIpAsset()

Methods To Be Deprecated

1. Basic Registration Methods → Covered by registerIpAsset()

Current Method Name Covered By registerIpAsset()
mintAndRegisterIp registerIpAsset()
mintAndRegisterIpAssetWithPilTerms registerIpAsset()
registerIpAndAttachPilTerms registerIpAsset()
mintAndRegisterIpAndAttachPilTermsAndDistributeRoyaltyTokens registerIpAsset()
registerIPAndAttachLicenseTermsAndDistributeRoyaltyTokens registerIpAsset()

2. Derivative Methods → Covered by registerDerivativeIpAsset()

Current Method Name Covered By
mintAndRegisterIpAndMakeDerivative registerDerivativeIpAsset()
registerDerivativeIp registerDerivativeIpAsset()
mintAndRegisterIpAndMakeDerivativeAndDistributeRoyaltyTokens registerDerivativeIpAsset()
registerDerivativeIpAndAttachLicenseTermsAndDistributeRoyaltyTokens registerDerivativeIpAsset()
mintAndRegisterIpAndMakeDerivativeWithLicenseTokens registerDerivativeIpAsset()
registerIpAndMakeDerivativeWithLicenseTokens registerDerivativeIpAsset()

3. Link Derivative Methods → Covered by linkDerivative()

Current Method Name Covered By
registerDerivativeWithLicenseTokens linkDerivative()
registerDerivative linkDerivative()

@bonnie57 bonnie57 merged commit d8ee21e into main Nov 4, 2025
16 of 17 checks passed
@bonnie57 bonnie57 deleted the TSSDK-122 branch November 20, 2025 07:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants