@story-protocol/core-sdk v1.3.2

Story Protocol SDK

Welcome to the Story Protocol SDK - a comprehensive toolkit for building applications on Story Protocol. This SDK empowers developers to seamlessly interact with intellectual property (IP) assets on the blockchain through an intuitive API interface.

Key Features:

• IP Asset Module: Register, and manage intellectual property assets on-chain
• License Module: Create customizable license terms, attach them to IP assets, and mint transferable license tokens
• Royalty Module: Claim royalties, and manage payment distributions
• Dispute Module: Initiate, manage and resolve IP-related disputes through on-chain governance
• Group Module: Create IP collections with shared revenue pools
• WIP Module: Wrap native IP into ERC-20 tokens for DeFi integrations
• NFT Client Module: Mint a new SPG collection for use with Story Protocol.

The SDK provides robust support for the following networks:

• aeneid - A dedicated testnet environment for development and testing
• mainnet - The production network for live deployments

Documentation

For more detailed information on using the SDK, refer to the TypeScript SDK Guide.

The documentation is divided into the following sections:

• Overview
• Setup
• Register an IP Asset
• Attach Terms to an IPA
• Mint a License Token
• Register a Derivative
• Pay an IPA
• Claim Revenue
• Raise a Dispute

Release

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. Details see: CONTRIBUTING

Please make sure to update tests as appropriate.

License

Copyright (c) 2023-Present Story Protocol Inc.