- Register a book series as an IP collection
- Register a book as an IP asset
This quickstart is under development as new features are added to the Story Protocol daily.
Preparation Steps
1
Create a Developer Account and Project
To get started, create a developer account in the Crossmint Staging Console. Open that link, sign in, and accept the dialog to continue.
Crossmint offers two consoles: staging, for development and testing, and
production.
2
Get an API Key
Create a server-side API key with these scopes:
collection.create
,
collection.update
,
collection.read
,
nfts.create
,
nfts.read
.This allows your API key to perform any kind of asset registration action.Register a Book Series
1
Create an IP Collection
This quickstart will register the Harry Potter book series as an IP collection.Customize the collection’s metadata according to your needs and run the script:
Register a Book
1
Register an IP Asset
Every written work may have different contributors and metadata. When defining an IP asset you can:Now, run the script:
- Specify multiple contributors (like authors, illustrators, and publishers) with their respective revenue shares
- Attach relevant media files
- Include important metadata like creation dates and identifiers
Retrieve Your IP Asset
1
Get IP Asset Details
After registering your IP asset, you can retrieve its details to verify the information or display it in your application.Replace
{collectionId}
with your collection ID and {ipAssetId}
with the IP asset ID returned when you registered the asset. Then run the script:Confirm Book Registration
1
Get Action Status
You can easily check the IP asset registration status to ensure the action has completed before proceeding.Use the action ID returned in any of the previous steps and run the script: