Introducing the Reveel SDK: facilitating custom on-chain revenue share agreements in decentralized applications.
We are thrilled to announce that the Reveel Protocol, previously only available to users on the Reveel app, is now fully open-source and available for any developer or development team to integrate natively. For the first time, core functions of the Reveel Protocol are now publicly available through the R3VL SDK, enabling developers and creators to build their own revenue sharing models on the Ethereum, Polygon, Optimism, Arbitrum and Aurora blockchains.
The R3VL SDK serves as the entry-point for developers & development teams to leverage the Reveel Protocol in their own decentralized applications. So what does the SDK look like, and how can it be implemented? Let’s take a look under the hood.
The R3VL SDK is designed for frontend developers to utilize Reveel's revenue share protocol with a seamless javascript integration. This can be done using React Hooks and asynchronous JavaScript.
Our React Hooks library utilizes react-query, so it should feel familiar to experienced React developers. Additionally, our SDK mimics the request parameter & response objects used by wagmi which should feel familiar to web3 devs.
The basic steps to integrate the R3VL SDK into your app are as follows:
Add @r3vl/sdk to your project using yarn, npm or your preferred package manager
Add a Reveel provider instance to your frontend (view an example here)
Integrate your desired functionality, which may include…
Creating your own revenue paths
Withdrawing from existing revenue paths
Updating existing revenue paths
Retrieving balances from existing revenue paths
Find a breakdown of the steps in our R3VL SDK Docs.
Once you have completed your integration, you are free to manage your revenue paths on our web app, or natively on your own.
Click here to view a live example of a basic implementation of the R3VL SDK.
For any questions feel free to join us in the #dev-support channel on Discord:
Discord - Group Chat That's All Fun & Games
Discord is great for playing games and chilling with friends, or even building a worldwide community. Customize your own space to talk, play, and hang out.
Let’s recap the core use cases of the Reveel Protocol:
Primary vs. secondary splits: The protocol allows for distinct splits for primary and secondary sales, allowing for more creative revenue agreements in a single smart contract.
Recouping advances: With Reveel, advances can be recouped through on-chain revenue sharing agreements, ensuring transparency in the distribution of funds and making it easy to track recoupment progress.
Revenue milestones: The protocol also allows developers and creators to set revenue milestones with different splits, so you can build the right incentives for your team.
Cap earnings: Remove individual collaborators from a revenue agreement when a specified amount of revenue is reached.
These functions mirror traditional revenue agreements in the web2 world, such as record deals. The key difference here is that all revenue paths created with Reveel are fully on-chain, ensuring transparency in the distribution of funds.
While we encourage folks to experiment with the above as core functions of their web3 releases, this is only a starting point. The Reveel Protocol is designed to be flexible and non-prescriptive, providing developers with the freedom to dream up their own unique revenue sharing models using the SDK.
VolDAO shares our values of transparency and innovation, and this is apparent in the design of Vol FM. The platform leverages the Reveel Protocol to give creators full control over all revenue generated from their releases on Vol. Vol FM also includes features like custom sale phases, open editions and royalty enforcement.
Are you a developer or part of a development team interested in providing creators greater control over their revenue? We invite you to register your interest below to ensure we can support your desired integration of the Reveel SDK!
To stay up-to-date on our latest developments or if you simply want to follow our journey, join our Discord and follow us on Twitter.