Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.story.foundation/llms.txt

Use this file to discover all available pages before exploring further.

In this section, we will briefly go over the 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.

​
Smart Contract Tutorial

Completed Code

Skip the tutorial and view the completed code. Follow the README instructions to run the tests, or go to the /test folder to view all of the example contracts.
If you want to set things up from scratch, then continue with the following tutorials, starting with the Setup Your Own Project step.

​
Our Smart Contracts

As of the current version, our Proof-of-Creativity 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. This is mostly handled through the SPG.

​
Deploy & Verify Contracts on Story

The approach to deploy & verify contracts comes from the Blockscout official documentation.
Verify a contract with Blockscout right after deployment (make sure you add “/api/” to the end of the Blockscout homepage explorer URL): 
forge create \
  --rpc-url <rpc_https_endpoint> \
  --private-key $PRIVATE_KEY \
  <contract_file>:<contract_name> \
  --verify \
  --verifier blockscout \
  --verifier-url <blockscout_homepage_explorer_url>/api/
Or if using foundry scripts: 
forge script <script_file> \
  --rpc-url <rpc_https_endpoint> \
  --private-key $PRIVATE_KEY \
  --broadcast \
  --verify \
  --verifier blockscout \
  --verifier-url <blockscout_homepage_explorer_url>/api/
Do not use RANDAO for pseudo-randomness, instead use onchain VRF (Pyth or Gelato). Currently, RANDAO value is set as the parent block hash and thus is not random for X-1 block.