Skip to content

Latest commit

 

History

History
67 lines (50 loc) · 4.13 KB

WORKFLOWS.md

File metadata and controls

67 lines (50 loc) · 4.13 KB
Raw

PoC Periphery Supported Workflows

📚 For full contract interfaces, check out contracts/interfaces/workflows.

Registration Workflows

  • createCollection:
    • Creates a SPGNFT Collection
  • registerIp:
    • Registers an IP
  • mintAndRegisterIp:
    • Mints a NFT → Registers it as an IP

License Attachment Workflows

  • registerPILTermsAndAttach:
    • Registers multiple PIL terms → Attaches them to an IP → Sets the licensing configuration for each of the attached PIL terms
  • registerIpAndAttachPILTerms:
    • Registers an IP → Registers multiple PIL terms → Attaches them to the IP → Sets the licensing configuration for each of the attached PIL terms
  • mintAndRegisterIpAndAttachPILTerms:
    • Mints a NFT → Registers it as an IP → Registers multiple PIL terms → Attaches them to the IP → Sets the licensing configuration for each of the attached PIL terms

Derivative Workflows

  • registerIpAndMakeDerivative:
    • Registers an IP → Registers it as a derivative of another IP
  • mintAndRegisterIpAndMakeDerivative:
    • Mints a NFT → Registers it as an IP → Registers the IP as a derivative of another IP
  • registerIpAndMakeDerivativeWithLicenseTokens:
    • Registers an IP → Registers the IP as a derivative of another IP using the license tokens
  • mintAndRegisterIpAndMakeDerivativeWithLicenseTokens:
    • Mints a NFT → Registers it as an IP → Registers the IP as a derivative of another IP using the license tokens

Grouping Workflows

  • mintAndRegisterIpAndAttachLicenseAndAddToGroup:
    • Mints a NFT → Registers it as an IP → Attaches the given license terms to the IP → Adds the IP to a group IP
  • registerIpAndAttachLicenseAndAddToGroup:
    • Registers an IP → Attaches the given license terms to the IP → Sets the licensing configuration for the attached license terms → Adds the IP to a group IP
  • registerGroupAndAttachLicense:
    • Registers a group IP → Attaches the given license terms to the group IP → Sets the licensing configuration for the attached license terms
  • registerGroupAndAttachLicenseAndAddIps:
    • Registers a group IP → Attaches the given license terms to the group IP → Sets the licensing configuration for the attached license terms → Adds existing IPs to the group IP
  • collectRoyaltiesAndClaimReward:
    • Collects revenue tokens to the group's reward pool → Distributes the rewards to each given member IP's royalty vault

Royalty Workflows

  • claimAllRevenue:
    • Transfers all avaiable royalties from various royalty policies to the royalty vault of the ancestor IP -> Claims all the revenue in each currency token from the ancestor IP's royalty vault to the claimer.

Royalty Token Distribution Workflows

  • mintAndRegisterIpAndAttachPILTermsAndDistributeRoyaltyTokens:

    • Mints a NFT → Registers it as an IP → Attaches PIL terms to the IP → Sets the licensing configuration for the attached PIL terms → Distributes specified amounts of royalty tokens to recipients

  • mintAndRegisterIpAndMakeDerivativeAndDistributeRoyaltyTokens:

    • Mints a NFT → Registers it as an IP → Registers the IP as a derivative of another IP → Triggers the deployment of the IP's royalty vault → Distributes specified amounts of royalty tokens to recipients

  • registerIpAndAttachPILTermsAndDeployRoyaltyVault:

    • Registers an IP → Attaches PIL terms to the IP → Sets the licensing configuration for the attached PIL terms → Triggers the deployment of the IP's royalty vault

  • registerIpAndMakeDerivativeAndDeployRoyaltyVault:

    • Registers an IP → Registers the IP as a derivative of another IP → Triggers the deployment of the IP's royalty vault

  • distributeRoyaltyTokens:

    • Distributes specified amounts of royalty tokens to recipients