WORKFLOWS.md

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 PIL terms → Attaches them to an IP
• registerIpAndAttachPILTerms:
  • Registers an IP → Registers PIL terms → Attaches them to the IP
• mintAndRegisterIpAndAttachPILTerms:
  • Mints a NFT → Registers it as an IP → Registers PIL terms → Attaches them to the IP

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 → Adds the IP to a group IP
• registerGroupAndAttachLicense:
  • Registers a group IP → Attaches the given license terms to the group IP
• registerGroupAndAttachLicenseAndAddIps:
  • Registers a group IP → Attaches the given license terms to the group IP → 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

• transferToVaultAndClaimByTokenBatch:

  • Transfers specified amounts of 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.

• 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.