> For the complete documentation index, see [llms.txt](https://docs.transientlabs.xyz/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.transientlabs.xyz/story-inscriptions/smart-contract-documentation.md). # Smart Contract Documentation ```solidity // SPDX-License-Identifier: MIT pragma solidity ^0.8.20; /// @title Transient Labs Story Inscriptions Interface /// @dev Interface id: 0x2464f17b /// @dev Previous interface id that is still supported: 0x0d23ecb9 /// @author transientlabs.xyz /// @custom:version 6.0.0 interface IStory { /*////////////////////////////////////////////////////////////////////////// Events //////////////////////////////////////////////////////////////////////////*/ /// @notice Event describing a collection story getting added to a contract /// @dev This event stories creator stories on chain in the event log that apply to an entire collection /// @param creatorAddress The address of the creator of the collection /// @param creatorName String representation of the creator's name /// @param story The story written and attached to the collection event CollectionStory(address indexed creatorAddress, string creatorName, string story); /// @notice Event describing a creator story getting added to a token /// @dev This events stores creator stories on chain in the event log /// @param tokenId The token id to which the story is attached /// @param creatorAddress The address of the creator of the token /// @param creatorName String representation of the creator's name /// @param story The story written and attached to the token id event CreatorStory(uint256 indexed tokenId, address indexed creatorAddress, string creatorName, string story); /// @notice Event describing a collector story getting added to a token /// @dev This events stores collector stories on chain in the event log /// @param tokenId The token id to which the story is attached /// @param collectorAddress The address of the collector of the token /// @param collectorName String representation of the collectors's name /// @param story The story written and attached to the token id event Story(uint256 indexed tokenId, address indexed collectorAddress, string collectorName, string story); /*////////////////////////////////////////////////////////////////////////// Story Functions //////////////////////////////////////////////////////////////////////////*/ /// @notice Function to let the creator add a story to the collection they have created /// @dev Depending on the implementation, this function may be restricted in various ways, such as /// limiting the number of times the creator may write a story. /// @dev This function MUST emit the CollectionStory event each time it is called /// @dev This function MUST implement logic to restrict access to only the creator /// @param creatorName String representation of the creator's name /// @param story The story written and attached to the token id function addCollectionStory(string calldata creatorName, string calldata story) external; /// @notice Function to let the creator add a story to any token they have created /// @dev Depending on the implementation, this function may be restricted in various ways, such as /// limiting the number of times the creator may write a story. /// @dev This function MUST emit the CreatorStory event each time it is called /// @dev This function MUST implement logic to restrict access to only the creator /// @dev This function MUST revert if a story is written to a non-existent token /// @param tokenId The token id to which the story is attached /// @param creatorName String representation of the creator's name /// @param story The story written and attached to the token id function addCreatorStory(uint256 tokenId, string calldata creatorName, string calldata story) external; /// @notice Function to let collectors add a story to any token they own /// @dev Depending on the implementation, this function may be restricted in various ways, such as /// limiting the number of times a collector may write a story. /// @dev This function MUST emit the Story event each time it is called /// @dev This function MUST implement logic to restrict access to only the owner of the token /// @dev This function MUST revert if a story is written to a non-existent token /// @param tokenId The token id to which the story is attached /// @param collectorName String representation of the collectors's name /// @param story The story written and attached to the token id function addStory(uint256 tokenId, string calldata collectorName, string calldata story) external; } ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.transientlabs.xyz/story-inscriptions/smart-contract-documentation.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.