Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(backwards-compatibility): rename functions to avoid overloading conflicts #165

Merged
merged 1 commit into from
Jan 13, 2025
Merged

fix(backwards-compatibility): rename functions to avoid overloading conflicts #165

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions contracts/interfaces/workflows/IDerivativeWorkflows.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ interface IDerivativeWorkflows {

/// @notice Mint an NFT from a SPGNFT collection and register it as a derivative IP without license tokens.
/// @notice THIS VERSION OF THE FUNCTION IS DEPRECATED, WILL BE REMOVED IN V1.4
function mintAndRegisterIpAndMakeDerivative(
function mintAndRegisterIpAndMakeDerivative_deprecated(
address spgNftContract,
WorkflowStructs.MakeDerivativeDEPR calldata derivData,
WorkflowStructs.IPMetadata calldata ipMetadata,
Expand All @@ -97,7 +97,7 @@ interface IDerivativeWorkflows {

/// @notice Register the given NFT as a derivative IP with metadata without license tokens.
/// @notice THIS VERSION OF THE FUNCTION IS DEPRECATED, WILL BE REMOVED IN V1.4
function registerIpAndMakeDerivative(
function registerIpAndMakeDerivative_deprecated(
address nftContract,
uint256 tokenId,
WorkflowStructs.MakeDerivativeDEPR calldata derivData,
Expand All @@ -108,7 +108,7 @@ interface IDerivativeWorkflows {

/// @notice Mint an NFT from a SPGNFT collection and register it as a derivative IP using license tokens.
/// @notice THIS VERSION OF THE FUNCTION IS DEPRECATED, WILL BE REMOVED IN V1.4
function mintAndRegisterIpAndMakeDerivativeWithLicenseTokens(
function mintAndRegisterIpAndMakeDerivativeWithLicenseTokens_deprecated(
address spgNftContract,
uint256[] calldata licenseTokenIds,
bytes calldata royaltyContext,
Expand All @@ -118,7 +118,7 @@ interface IDerivativeWorkflows {

/// @notice Register the given NFT as a derivative IP using license tokens.
/// @notice THIS VERSION OF THE FUNCTION IS DEPRECATED, WILL BE REMOVED IN V1.4
function registerIpAndMakeDerivativeWithLicenseTokens(
function registerIpAndMakeDerivativeWithLicenseTokens_deprecated(
address nftContract,
uint256 tokenId,
uint256[] calldata licenseTokenIds,
Expand Down
10 changes: 5 additions & 5 deletions contracts/interfaces/workflows/IGroupingWorkflows.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ interface IGroupingWorkflows {
/// @notice Mint an NFT from a SPGNFT collection, register it with metadata as an IP,
/// attach license terms to the registered IP, and add it to a group IP.
/// @notice THIS VERSION OF THE FUNCTION IS DEPRECATED, WILL BE REMOVED IN V1.4
function mintAndRegisterIpAndAttachLicenseAndAddToGroup(
function mintAndRegisterIpAndAttachLicenseAndAddToGroup_deprecated(
address spgNftContract,
address groupId,
address recipient,
Expand All @@ -104,7 +104,7 @@ interface IGroupingWorkflows {
/// @notice THIS VERSION OF THE FUNCTION IS DEPRECATED, WILL BE REMOVED IN V1.4
/// @dev UPDATE REQUIRED: The sigMetadataAndAttachAndConfig permission signature data must be updated and include permissions for
/// metadata setting, license attachment, and licensing configuration permissions
function registerIpAndAttachLicenseAndAddToGroup(
function registerIpAndAttachLicenseAndAddToGroup_deprecated(
address nftContract,
uint256 tokenId,
address groupId,
Expand All @@ -117,7 +117,7 @@ interface IGroupingWorkflows {

/// @notice Register a group IP with a group reward pool and attach license terms to the group IP
/// @notice THIS VERSION OF THE FUNCTION IS DEPRECATED, WILL BE REMOVED IN V1.4
function registerGroupAndAttachLicense(
function registerGroupAndAttachLicense_deprecated(
address groupPool,
address licenseTemplate,
uint256 licenseTermsId
Expand All @@ -126,7 +126,7 @@ interface IGroupingWorkflows {
/// @notice Register a group IP with a group reward pool, attach license terms to the group IP,
/// and add individual IPs to the group IP.
/// @notice THIS VERSION OF THE FUNCTION IS DEPRECATED, WILL BE REMOVED IN V1.4
function registerGroupAndAttachLicenseAndAddIps(
function registerGroupAndAttachLicenseAndAddIps_deprecated(
address groupPool,
address[] calldata ipIds,
address licenseTemplate,
Expand All @@ -135,7 +135,7 @@ interface IGroupingWorkflows {

/// @notice Collect royalties for the entire group and distribute the rewards to each member IP's royalty vault
/// @notice THIS VERSION OF THE FUNCTION IS DEPRECATED, WILL BE REMOVED IN V1.4
function collectRoyaltiesAndClaimReward(
function collectRoyaltiesAndClaimReward_deprecated(
address groupIpId,
address[] calldata currencyTokens,
uint256[] calldata groupSnapshotIds,
Expand Down
12 changes: 6 additions & 6 deletions contracts/interfaces/workflows/ILicenseAttachmentWorkflows.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ interface ILicenseAttachmentWorkflows {

/// @notice Register Programmable IP License Terms (if unregistered) and attach it to IP.
/// @notice THIS VERSION OF THE FUNCTION IS DEPRECATED, WILL BE REMOVED IN V1.4
function registerPILTermsAndAttach(
function registerPILTermsAndAttach_deprecated(
address ipId,
PILTerms[] calldata terms,
WorkflowStructs.SignatureData calldata sigAttach
Expand All @@ -72,7 +72,7 @@ interface ILicenseAttachmentWorkflows {
/// @notice Mint an NFT from a SPGNFT collection, register it with metadata as an IP,
/// register Programmable IPLicense
/// @notice THIS VERSION OF THE FUNCTION IS DEPRECATED, WILL BE REMOVED IN V1.4
function mintAndRegisterIpAndAttachPILTerms(
function mintAndRegisterIpAndAttachPILTerms_deprecated(
address spgNftContract,
address recipient,
WorkflowStructs.IPMetadata calldata ipMetadata,
Expand All @@ -81,7 +81,7 @@ interface ILicenseAttachmentWorkflows {

/// @notice Register a given NFT as an IP and attach Programmable IP License Terms.
/// @notice THIS VERSION OF THE FUNCTION IS DEPRECATED, WILL BE REMOVED IN V1.4
function registerIpAndAttachPILTerms(
function registerIpAndAttachPILTerms_deprecated(
address nftContract,
uint256 tokenId,
WorkflowStructs.IPMetadata calldata ipMetadata,
Expand All @@ -92,7 +92,7 @@ interface ILicenseAttachmentWorkflows {

/// @notice Register Programmable IP License Terms (if unregistered) and attach it to IP.
/// @notice THIS VERSION OF THE FUNCTION IS DEPRECATED, WILL BE REMOVED IN V1.4
function registerPILTermsAndAttach(
function registerPILTermsAndAttach_deprecated(
address ipId,
PILTerms calldata terms,
WorkflowStructs.SignatureData calldata sigAttach
Expand All @@ -101,7 +101,7 @@ interface ILicenseAttachmentWorkflows {
/// Mint an NFT from a SPGNFT collection, register it with metadata as an IP,
/// register Programmable IPLicense
/// @notice THIS VERSION OF THE FUNCTION IS DEPRECATED, WILL BE REMOVED IN V1.4
function mintAndRegisterIpAndAttachPILTerms(
function mintAndRegisterIpAndAttachPILTerms_deprecated(
address spgNftContract,
address recipient,
WorkflowStructs.IPMetadata calldata ipMetadata,
Expand All @@ -110,7 +110,7 @@ interface ILicenseAttachmentWorkflows {

/// @notice Register a given NFT as an IP and attach Programmable IP License Terms.
/// @notice THIS VERSION OF THE FUNCTION IS DEPRECATED, WILL BE REMOVED IN V1.4
function registerIpAndAttachPILTerms(
function registerIpAndAttachPILTerms_deprecated(
address nftContract,
uint256 tokenId,
WorkflowStructs.IPMetadata calldata ipMetadata,
Expand Down
2 changes: 1 addition & 1 deletion contracts/interfaces/workflows/IRegistrationWorkflows.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ interface IRegistrationWorkflows {

/// @notice Mint an NFT from a SPGNFT collection and register it with metadata as an IP.
/// @notice THIS VERSION OF THE FUNCTION IS DEPRECATED, WILL BE REMOVED IN V1.4
function mintAndRegisterIp(
function mintAndRegisterIp_deprecated(
address spgNftContract,
address recipient,
WorkflowStructs.IPMetadata calldata ipMetadata
Expand Down
4 changes: 2 additions & 2 deletions contracts/interfaces/workflows/IRoyaltyTokenDistributionWorkflows.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ interface IRoyaltyTokenDistributionWorkflows {

/// @notice Mint an NFT and register the IP, attach PIL terms, and distribute royalty tokens.
/// @dev THIS VERSION OF THE FUNCTION IS DEPRECATED, WILL BE REMOVED IN V1.4
function mintAndRegisterIpAndAttachPILTermsAndDistributeRoyaltyTokens(
function mintAndRegisterIpAndAttachPILTermsAndDistributeRoyaltyTokens_deprecated(
address spgNftContract,
address recipient,
WorkflowStructs.IPMetadata calldata ipMetadata,
Expand All @@ -106,7 +106,7 @@ interface IRoyaltyTokenDistributionWorkflows {

/// @notice Register an IP, attach PIL terms, and deploy a royalty vault.
/// @dev THIS VERSION OF THE FUNCTION IS DEPRECATED, WILL BE REMOVED IN V1.4
function registerIpAndAttachPILTermsAndDeployRoyaltyVault(
function registerIpAndAttachPILTermsAndDeployRoyaltyVault_deprecated(
address nftContract,
uint256 tokenId,
WorkflowStructs.IPMetadata calldata ipMetadata,
Expand Down
8 changes: 4 additions & 4 deletions contracts/workflows/DerivativeWorkflows.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,7 @@ contract DerivativeWorkflows is

/// @notice Mint an NFT from a SPGNFT collection and register it as a derivative IP without license tokens.
/// @notice THIS VERSION OF THE FUNCTION IS DEPRECATED, WILL BE REMOVED IN V1.4
function mintAndRegisterIpAndMakeDerivative(
function mintAndRegisterIpAndMakeDerivative_deprecated(
address spgNftContract,
WorkflowStructs.MakeDerivativeDEPR calldata derivData,
WorkflowStructs.IPMetadata calldata ipMetadata,
Expand Down Expand Up @@ -320,7 +320,7 @@ contract DerivativeWorkflows is

/// @notice Register the given NFT as a derivative IP with metadata without license tokens.
/// @notice THIS VERSION OF THE FUNCTION IS DEPRECATED, WILL BE REMOVED IN V1.4
function registerIpAndMakeDerivative(
function registerIpAndMakeDerivative_deprecated(
address nftContract,
uint256 tokenId,
WorkflowStructs.MakeDerivativeDEPR calldata derivData,
Expand Down Expand Up @@ -368,7 +368,7 @@ contract DerivativeWorkflows is

/// @notice Mint an NFT from a collection and register it as a derivative IP using license tokens
/// @notice THIS VERSION OF THE FUNCTION IS DEPRECATED, WILL BE REMOVED IN V1.4
function mintAndRegisterIpAndMakeDerivativeWithLicenseTokens(
function mintAndRegisterIpAndMakeDerivativeWithLicenseTokens_deprecated(
address spgNftContract,
uint256[] calldata licenseTokenIds,
bytes calldata royaltyContext,
Expand Down Expand Up @@ -399,7 +399,7 @@ contract DerivativeWorkflows is

/// @notice Register the given NFT as a derivative IP using license tokens.
/// @notice THIS VERSION OF THE FUNCTION IS DEPRECATED, WILL BE REMOVED IN V1.4
function registerIpAndMakeDerivativeWithLicenseTokens(
function registerIpAndMakeDerivativeWithLicenseTokens_deprecated(
address nftContract,
uint256 tokenId,
uint256[] calldata licenseTokenIds,
Expand Down
12 changes: 7 additions & 5 deletions contracts/workflows/GroupingWorkflows.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -325,7 +325,7 @@ contract GroupingWorkflows is
/// @notice Mint an NFT from a SPGNFT collection, register it with metadata as an IP, attach
/// license terms to the registered IP, and add it to a group IP.
/// @notice THIS VERSION OF THE FUNCTION IS DEPRECATED, WILL BE REMOVED IN V1.4
function mintAndRegisterIpAndAttachLicenseAndAddToGroup(
function mintAndRegisterIpAndAttachLicenseAndAddToGroup_deprecated(
address spgNftContract,
address groupId,
address recipient,
Expand Down Expand Up @@ -366,7 +366,7 @@ contract GroupingWorkflows is
/// @notice THIS VERSION OF THE FUNCTION IS DEPRECATED, WILL BE REMOVED IN V1.4
/// @dev UPDATE REQUIRED: The sigMetadataAndAttachAndConfig permission signature data must be updated and include permissions for
/// metadata setting, license attachment, and licensing configuration permissions
function registerIpAndAttachLicenseAndAddToGroup(
function registerIpAndAttachLicenseAndAddToGroup_deprecated(
address nftContract,
uint256 tokenId,
address groupId,
Expand Down Expand Up @@ -414,7 +414,7 @@ contract GroupingWorkflows is

/// @notice Register a group IP with a group reward pool and attach license terms to the group IP
/// @notice THIS VERSION OF THE FUNCTION IS DEPRECATED, WILL BE REMOVED IN V1.4
function registerGroupAndAttachLicense(
function registerGroupAndAttachLicense_deprecated(
address groupPool,
address licenseTemplate,
uint256 licenseTermsId
Expand All @@ -429,7 +429,7 @@ contract GroupingWorkflows is
/// @notice Register a group IP with a group reward pool, attach license terms to the group IP,
/// and add individual IPs to the group IP.
/// @notice THIS VERSION OF THE FUNCTION IS DEPRECATED, WILL BE REMOVED IN V1.4
function registerGroupAndAttachLicenseAndAddIps(
function registerGroupAndAttachLicenseAndAddIps_deprecated(
address groupPool,
address[] calldata ipIds,
address licenseTemplate,
Expand All @@ -446,7 +446,7 @@ contract GroupingWorkflows is

/// @notice Collect royalties for the entire group and distribute the rewards to each member IP's royalty vault
/// @notice THIS VERSION OF THE FUNCTION IS DEPRECATED, WILL BE REMOVED IN V1.4
function collectRoyaltiesAndClaimReward(
function collectRoyaltiesAndClaimReward_deprecated(
address groupIpId,
address[] calldata currencyTokens,
uint256[] calldata groupSnapshotIds,
Expand Down Expand Up @@ -482,6 +482,7 @@ contract GroupingWorkflows is
}
}

/// @notice THIS FUNCTION IS DEPRECATED, WILL BE REMOVED IN V1.4
function _prepConfigAndAttachLicenseAndSetConfig(
address ipId,
address groupId,
Expand All @@ -507,6 +508,7 @@ contract GroupingWorkflows is
_attachLicensesAndSetConfigs(ipId, licensesData);
}

/// @notice THIS FUNCTION IS DEPRECATED, WILL BE REMOVED IN V1.4
function _prepConfigAndAttachLicenseAndSetConfigForGroup(
address groupId,
address groupRewardPool,
Expand Down
14 changes: 7 additions & 7 deletions contracts/workflows/LicenseAttachmentWorkflows.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,7 @@ contract LicenseAttachmentWorkflows is

/// @notice Register Programmable IP License Terms (if unregistered) and attach it to IP.
/// @notice THIS VERSION OF THE FUNCTION IS DEPRECATED, WILL BE REMOVED IN V1.4
function registerPILTermsAndAttach(
function registerPILTermsAndAttach_deprecated(
address ipId,
PILTerms[] calldata terms,
WorkflowStructs.SignatureData calldata sigAttach
Expand All @@ -232,7 +232,7 @@ contract LicenseAttachmentWorkflows is
/// @notice Mint an NFT from a SPGNFT collection, register it with metadata as an IP,
/// register Programmable IP License Terms (if unregistered), and attach it to the registered IP.
/// @notice THIS VERSION OF THE FUNCTION IS DEPRECATED, WILL BE REMOVED IN V1.4
function mintAndRegisterIpAndAttachPILTerms(
function mintAndRegisterIpAndAttachPILTerms_deprecated(
address spgNftContract,
address recipient,
WorkflowStructs.IPMetadata calldata ipMetadata,
Expand Down Expand Up @@ -261,7 +261,7 @@ contract LicenseAttachmentWorkflows is

/// @notice Register a given NFT as an IP and attach Programmable IP License Terms.
/// @notice THIS VERSION OF THE FUNCTION IS DEPRECATED, WILL BE REMOVED IN V1.4
function registerIpAndAttachPILTerms(
function registerIpAndAttachPILTerms_deprecated(
address nftContract,
uint256 tokenId,
WorkflowStructs.IPMetadata calldata ipMetadata,
Expand Down Expand Up @@ -293,7 +293,7 @@ contract LicenseAttachmentWorkflows is

/// @notice Register Programmable IP License Terms (if unregistered) and attach it to IP.
/// @notice THIS VERSION OF THE FUNCTION IS DEPRECATED, WILL BE REMOVED IN V1.4
function registerPILTermsAndAttach(
function registerPILTermsAndAttach_deprecated(
address ipId,
PILTerms calldata terms,
WorkflowStructs.SignatureData calldata sigAttach
Expand All @@ -317,7 +317,7 @@ contract LicenseAttachmentWorkflows is
/// @notice Mint an NFT from a SPGNFT collection, register it with metadata as an IP,
/// register Programmable IP License Terms (if unregistered), and attach it to the registered IP.
/// @notice THIS VERSION OF THE FUNCTION IS DEPRECATED, WILL BE REMOVED IN V1.4
function mintAndRegisterIpAndAttachPILTerms(
function mintAndRegisterIpAndAttachPILTerms_deprecated(
address spgNftContract,
address recipient,
WorkflowStructs.IPMetadata calldata ipMetadata,
Expand Down Expand Up @@ -345,7 +345,7 @@ contract LicenseAttachmentWorkflows is

/// @notice Register a given NFT as an IP and attach Programmable IP License Terms.
/// @notice THIS VERSION OF THE FUNCTION IS DEPRECATED, WILL BE REMOVED IN V1.4
function registerIpAndAttachPILTerms(
function registerIpAndAttachPILTerms_deprecated(
address nftContract,
uint256 tokenId,
WorkflowStructs.IPMetadata calldata ipMetadata,
Expand Down Expand Up @@ -378,7 +378,7 @@ contract LicenseAttachmentWorkflows is
);
}

/// @notice THIS VERSION OF THE FUNCTION IS DEPRECATED, WILL BE REMOVED IN V1.4
/// @notice THIS FUNCTION IS DEPRECATED, WILL BE REMOVED IN V1.4
function _registerMultiplePILTermsAndAttach(
address ipId,
PILTerms[] calldata terms
Expand Down
2 changes: 1 addition & 1 deletion contracts/workflows/RegistrationWorkflows.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ contract RegistrationWorkflows is
////////////////////////////////////////////////////////////////////////////
/// @notice Mint an NFT from a SPGNFT collection and register it with metadata as an IP.
/// @notice THIS VERSION OF THE FUNCTION IS DEPRECATED, WILL BE REMOVED IN V1.4
function mintAndRegisterIp(
function mintAndRegisterIp_deprecated(
address spgNftContract,
address recipient,
WorkflowStructs.IPMetadata calldata ipMetadata
Expand Down
8 changes: 4 additions & 4 deletions contracts/workflows/RoyaltyTokenDistributionWorkflows.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -433,7 +433,7 @@ contract RoyaltyTokenDistributionWorkflows is

/// @notice Mint an NFT and register the IP, attach PIL terms, and distribute royalty tokens.
/// @dev THIS VERSION OF THE FUNCTION IS DEPRECATED, WILL BE REMOVED IN V1.4
function mintAndRegisterIpAndAttachPILTermsAndDistributeRoyaltyTokens(
function mintAndRegisterIpAndAttachPILTermsAndDistributeRoyaltyTokens_deprecated(
address spgNftContract,
address recipient,
WorkflowStructs.IPMetadata calldata ipMetadata,
Expand Down Expand Up @@ -468,7 +468,7 @@ contract RoyaltyTokenDistributionWorkflows is

/// @notice Register an IP, attach PIL terms, and deploy a royalty vault.
/// @dev THIS VERSION OF THE FUNCTION IS DEPRECATED, WILL BE REMOVED IN V1.4
function registerIpAndAttachPILTermsAndDeployRoyaltyVault(
function registerIpAndAttachPILTermsAndDeployRoyaltyVault_deprecated(
address nftContract,
uint256 tokenId,
WorkflowStructs.IPMetadata calldata ipMetadata,
Expand Down Expand Up @@ -499,7 +499,7 @@ contract RoyaltyTokenDistributionWorkflows is
}

/// @dev Deploys a royalty vault for the IP.
/// @dev THIS VERSION OF THE FUNCTION IS DEPRECATED, WILL BE REMOVED IN V1.4
/// @dev THIS FUNCTION IS DEPRECATED, WILL BE REMOVED IN V1.4
function _deployRoyaltyVaultDEPR(
address ipId,
address licenseTemplate,
Expand Down Expand Up @@ -537,7 +537,7 @@ contract RoyaltyTokenDistributionWorkflows is
if (ipRoyaltyVault == address(0)) revert Errors.RoyaltyTokenDistributionWorkflows__RoyaltyVaultNotDeployed();
}

/// @notice THIS VERSION OF THE FUNCTION IS DEPRECATED, WILL BE REMOVED IN V1.4
/// @notice THIS FUNCTION IS DEPRECATED, WILL BE REMOVED IN V1.4
function _registerMultiplePILTermsAndAttach(
address ipId,
PILTerms[] calldata terms
Expand Down
Loading
Loading