Get Started with the Smart Contracts

For smart contract developers who wish to build on top of Story Protocol directly.

Suggest Edits

In this section, we will briefly go over the core protocol contracts and then guide you through how to start building on top of the protocol. If you haven't yet familiarized yourself with the overall architecture, we recommend first going over the Architecture Overview section.

🚧

Story Protocol Contracts are undergoing audits.

The v1 release of Story Protocol is currently undergoing audits, which means that we could change the smart contracts at any time without warning to address the audit findings. When the contracts are fully audited, we will remove this warning and ensure regular updates to this document with formal notice.

Story Protocol Smart Contracts

As of the current version, Story Protocol is compatible with all EVM chains and is written as a set of Smart Contracts in Solidity. There are two repositories that you may interact with as a developer:

  • Story Protocol Core - This repository contains the core protocol logic, consisting of a thin IP registry (the "IP Asset Registry"), a set of modules defining logic around Licensing, Royalty, Dispute, metadata, and a module manager for administering module and user access control.
  • Story Protocol Periphery- Whereas the core contracts deal with the underlying protocol logic, the periphery contracts deal with protocol extensions that greatly increase UX and simplify IPA management. Most importantly, this includes management of IP as NFTs, pre-defined licensing and royalties abstractions, and wrappers around module permissions that make management and transferring of IPAs simpler to deal with. For most common use cases, we recommend using the periphery repository.

Start Coding

📘

Completed Boilerplate

If you want to install a completed boilerplate repository containing all of the following tutorials, do the following:

  1. Install Foundry
  2. Install yarn
  3. git clone https://github.com/storyprotocol/story-protocol-boilerplate
  4. cd story-protocol-boilerplate
  5. yarn
  6. forge test --fork-url "<your preferred sepolia rpc url>"

If you want to set things up from scratch, then continue with the following tutorials, starting with the Setup Your Own Project step.

Updated 2 months ago