Completed Code

All of this page is covered in this working code example.

This section demonstrates how to register an IP Asset as a derivative of another.

​
Prerequisites

There are a few steps you have to complete before you can start the tutorial.

  1. Complete the TypeScript SDK Setup

​
1. Before We Start

There are a lot of ways to register an IP Asset as a derivative of another. Below, we will help you figure out what function you should use.

Have no idea? It is best to figure out which SDK function to use based on what is easiest for you. But if you have no idea, simply continue to the next section.

By the way we recognize this is confusing and are releasing an update to our SDK soon to combine all of these into 1 simple function. :)

Do you already have a License Token you can use?

​
1a. Why would I ever use a License Token if it’s not needed?

There are a few times when you would need a License Token to register a derivative:

  • The License Token contains private license terms, so you would only be able to register as a derivative if you had the License Token that was manually minted by the owner. More on that here.
  • The License Token (which is an NFT) costs a mintingFee to mint, and you were able to buy it on a marketplace for a cheaper price. Then it makes more sense to simply register with the License Token then have to pay the more expensive defaultMintingFee.

​
2. Register Derivative

This is just an example. You are encouraged to figure out the best derivative function to use based on the survey above. However, if you don’t know and want to be walked through one solution, this next part is for you.

We’re going to assume you have ❌ no license tokens, ❌ the derivative IP is not yet registered, and ❌ you don’t have your own NFT contract or an already minted NFT.

Follow steps 1-4 of Register an IP Asset. Note you can skip step 4 if you already have an SPG NFT Collection. Then, come back here.

Modify your code such that…

  1. Instead of using mintAndRegisterIp, use mintAndRegisterIpAndMakeDerivative
  2. Add a derivData field, where:
    • parentIpIds is the ipIds of the parents you want to become a derivative of. NOTE: Once you become a derivative, you cannot add more parents
    • licenseTermIds is an array of license terms you want to register under. These are the terms your derivative must abide by

Now we can call the function like so:

Associated Docs: ipAsset.mintAndRegisterIpAndMakeDerivative

main.ts
import { IpMetadata, DerivativeData } from "@story-protocol/core-sdk";
import { client } from "./utils";
import { uploadJSONToIPFS } from "./uploadToIpfs";
import { createHash } from "crypto";
import { Address } from "viem";

async function main() {
  // previous code here ...

  const derivData: DerivativeData = {
    // TODO: insert the parent's ipId
    parentIpIds: [PARENT_IP_ID],
    // TODO: insert the licenseTermsId attached to parent IpId
    licenseTermsIds: [LICENSE_TERMS_ID],
  };

  const response = await client.ipAsset.mintAndRegisterIpAndMakeDerivative({
    // TODO: insert your NFT contract address created by the SPG
    spgNftContract: SPG_NFT_CONTRACT_ADDRESS as Address,
    derivData,
    ipMetadata: {
      ipMetadataURI: `https://ipfs.io/ipfs/${ipIpfsHash}`,
      ipMetadataHash: `0x${ipHash}`,
      nftMetadataURI: `https://ipfs.io/ipfs/${nftIpfsHash}`,
      nftMetadataHash: `0x${nftHash}`,
    },
    txOptions: { waitForTransaction: true },
  });

  console.log(
    `Completed at transaction hash ${response.txHash}, IPA ID: ${response.ipId}, Token ID: ${response.tokenId}`
  );
}

​
3. View Completed Code

Congratulations, you registered a derivative IP Asset!

Completed Code

All of this page is covered in this working code example.

​
4. Paying and Claiming Revenue

Now that we have established parent-child IP relationships, we can begin to explore payments and automated revenue share based on the license terms. We’ll cover that in the upcoming pages.