🛠️ TypeScript SDK Guide
For TypeScript developers who want to build with Story.
The best way to get started is to get your hands dirty and start building.
Working Code Examples
Extremely easy & straightforward working code examples for all of the following tutorials.
Video Tutorial
Watch a video tutorial overviewing an example script.
In the following series of tutorials, you will learn how to build IP applications with Story SDK and the concepts we mentioned in the Architecture Overview of Story Protocol.
Navigating Around the SDK Docs
Before you begin, make sure to read the TypeScript SDK Setup.
Because there are a lot of functions to interact with the 📜 Licensing Module, we have broken them down into a helpful chart so you can identify what you're looking for, and then find the associated docs.
| Function | Mint an NFT | Register IPA | Create License Terms | Attach License Terms | Mint License Token | Register as Derivative |
|---|---|---|---|---|---|---|
| register | ✓ | |||||
| mintAndRegisterIp | ✓ | ✓ | ||||
| registerPILTerms | ✓ | |||||
| attachLicenseTerms | ✓ | |||||
| registerIpAndAttachPilTerms | ✓ | ✓ | ✓ | |||
| registerPilTermsAndAttach | ✓ | ✓ | ||||
| mintAndRegisterIpAssetWithPilTerms | ✓ | ✓ | ✓ | ✓ | ||
| mintLicenseTokens | ✓ | |||||
| registerDerivative | ✓ | |||||
| registerDerivativeWithLicenseTokens | ✓ | |||||
| registerDerivativeIp | ✓ | ✓ | ||||
| registerIpAndMakeDerivativeWithLicenseTokens | ✓ | ✓ | ||||
| mintAndRegisterIpAndMakeDerivative | ✓ | ✓ | ✓ | |||
| mintAndRegisterIpAndMakeDerivativeWithLicenseTokens | ✓ | ✓ | ✓ |
- Purple: Register an IP Asset
- Green: Register License Terms
- Red: Attach Terms to an IPA
- Blue: Mint a License Token
- Orange: Register a Derivative
You can also check out Pay an IPA and Claim Revenue to interact with the 💸 Royalty Module with the SDK.
Updated 16 days ago