A Deep Dive into Reveel V2 SDK and Protocol- Exploring Technical Marvels, Boundless Capabilities, and Inspiring New Use Cases
July 10th, 2023

In the rapidly evolving realm of the internet, the emergence of Web3 has ushered in a plethora of prospects for creators, visionaries, and collectives to collaborate and partake in the value they jointly generate synergistically. In the vast landscape of emerging platforms within the decentralized era, Reveel shines as a truly transformative force.

Reveel
Reveel

Reveel is an innovative Revenue Share Protocol that seeks to disrupt the conventional methods of distributing earnings among collaborators within the Web3 ecosystem. Leveraging the core tenets of decentralization, gas optimization, and interoperability, Reveel offers a resilient framework for creators to effortlessly distribute earnings among their collaborators, all while reducing expenses and amplifying visibility.

One of the main strengths of Reveel resides in its unparalleled user interface and experience design, which epitomizes the pinnacle of Web3 expertise. Acknowledging the paramount significance of a seamless experience for creators, the platform provides an intuitive interface that adeptly navigates them through the intricacies of revenue sharing. Reveel provides a frictionless journey, encompassing the entire spectrum from user onboarding to the equitable distribution of earnings. This empowers creators to dedicate their energy towards honing their artistic prowess and fostering fruitful collaborations, unburdened by the intricacies of intricate technical frameworks. With the seamless integration of Reveel for everyday users, numerous functionalities are also extended to developers, enabling them to harness the platform's potential entirely. To facilitate convenient access to these capabilities, what options are available? It's R3vl SDK:(Software Development Kit). Before we embark on exploring the R3vl Software Development Kit (SDK), it is imperative to grasp the concept of an SDK.

• SDK:

An SDK, short for Software Development Kit, is a comprehensive collection of tools, libraries, and meticulously crafted documentation offered by a software company. Its primary purpose is to empower developers with the necessary resources and guidance to build cutting-edge applications tailored for a specific platform seamlessly. It encompasses a comprehensive suite of pre-assembled components, APIs, cutting-edge development tools, and meticulously crafted documentation, all meticulously designed to streamline and expedite the intricate process of software development. Software Development Kits (SDKs) empower developers to harness the full potential of platform-specific capabilities and seamlessly incorporate them into their applications, thereby augmenting the overall functionality of their software solutions.

Exploring The Technical Side: Understanding The Integration Methods For R3vl SDK

R3vl
R3vl

The R3vl SDK empowers frontend developers to integrate Reveel's smart contracts seamlessly using JavaScript integration. Web3 developers will have the privilege of selecting between two integration methodologies:

  1. React Hooks Library.

    React Hooks is an innovative addition to the React framework, first introduced in React version 16.8 which allows developers to leverage state and various other remarkable React features without needing to write traditional class components. This groundbreaking feature dramatically enhances the development experience and promotes more efficient and concise code. The R3vl SDK offers an exceptional React Hooks library that streamlines the integration process for React-based applications.

    By leveraging the React Hooks library, proficient developers are empowered to effortlessly import the essential hooks from the R3vl SDK and seamlessly integrate them into their functional components. These hooks offer a seamless interface for engaging with Reveel's smart contracts, facilitating essential functionalities like retrieving contract data, executing transactions, and subscribing to events.

    Developers can leverage the powerful "useContractData" hook to seamlessly retrieve and effectively handle data originating from a designated smart contract. This function accepts the contract address and the desired data fields as arguments and retrieves the current values of those fields. Developers can leverage this valuable data to seamlessly render their React components and enable automatic updates whenever there are modifications in the contract data. In essence, the React Hooks library streamlines the seamless incorporation of Reveel's smart contracts into React applications by offering a user-friendly API for effortlessly accessing contract data and engaging with the blockchain.

  2. Asynchronous JavaScript Functions.

    Asynchronous JavaScript Functions, or async functions, are a groundbreaking feature unveiled in ECMAScript 2017 (ES8). These functions empower developers to craft asynchronous code with utmost elegance and efficiency by leveraging the power of the async and await keywords. The R3vl SDK also offers an integrated approach leveraging asynchronous JavaScript functions.

    Web3 developers can seamlessly integrate the R3vl SDK into their JavaScript codebase, enabling them to leverage the power of asynchronous functions for seamless interaction with Reveel's intelligent contracts. These functions leverage the async keyword to establish asynchronous behaviour and the await keyword to patiently await the resolution of promises.

    Developers can define an asynchronous function to transmit a transaction to a smart contract by utilizing the "sendTransaction" method offered by the R3vl SDK. In this function, they can employ the await keyword to pause the code execution until the transaction has been verified on the blockchain, subsequently allowing the remaining code to be executed.

    By harnessing the power of asynchronous JavaScript functions, developers can craft elegant and easily comprehensible code, effectively managing asynchronous operations that closely resembles synchronous behaviour. This seamless integration of Reveel's intelligent contracts becomes more intuitive and manageable.

    Note:* To utilize the features mentioned above, it is imperative to possess Data API access. To obtain the API-Key token, kindly proceed here. *

    The R3VL Widget is an efficient solution for seamlessly incorporating the Reveel Protocol into your application with native integration capabilities. Leveraging the power of ReactJS, this cutting-edge solution can function as a Web Component and seamlessly integrates with any JavaScript framework. Achieve this by simply incorporating a personalized HTML tag.

    Functionalities.

    The Reveel R3vl SDK is an innovative JavaScript library meticulously crafted to streamline the seamless integration of Reveel's cutting-edge smart contracts into front-end applications. It aims to empower developers with a user-friendly toolkit that simplifies incorporating Reveel's advanced blockchain capabilities into their web-based projects. With a fundamental comprehension of these integration methods, let us delve into some of the functionalities they provide in the context of Web3.

    React Hook:

    One of the primary features offered by the SDK is the 'useCreateRevenuePath' function, empowering developers to establish a revenue path. This hook leverages the 'react-query' library internally and provides request parameters and response objects that mirror the capabilities of 'react-query'. Web3 developers can pass various parameters, including wallet lists, distribution mechanisms, tiers, names, and the option to enable mutability. These parameters play a crucial role in establishing an effective revenue path. The response object is equipped with essential properties such as data, isLoading, and isSuccess flags, which are instrumental in monitoring the progress and outcome of the request.

    Another crucial hook in the Web3 ecosystem is the 'useWithdraw' function, which is vital in enabling the seamless withdrawal of revenue from a revenue path. To proceed, one must provide the revenue path address, and if desired, the option to specify an ERC20 token address can be included. This hook seamlessly integrates with the underlying Web3 smart contracts and offers a mutate function that can be utilized to initiate the withdrawal process.

    The Software Development Kit (SDK) also encompasses hooks for obtaining revenue path balances (useBalances) and fetching revenue path tiers (useRevenuePathTiers). These hooks seamlessly interface with the smart contracts to fetch pertinent data. To retrieve the required information, web3 developers can furnish the essential parameters, including the revenue path address, user wallet address, and ERC20 token address. The response objects facilitate access to the fetched data, empowering developers to showcase it within their applications seamlessly.

    The Software Development Kit (SDK) offers the 'useUpdateRevenuePath' hook to enhance an existing revenue path. This smart contract enables the seamless modification of limits and the incorporation of revenue tiers. Web3 developers can seamlessly pass essential parameters, including tokens, updated limits, and tier details, to effectively modify the revenue path. The hook seamlessly interfaces with the smart contracts to execute the requisite updates.

    The Reveel R3vl SDK has been meticulously engineered to ensure seamless compatibility with a diverse range of cutting-edge blockchain networks, encompassing the likes of Ethereum, Polygon, Arbitrum, Optimism, and Aurora. Web3 developers can choose their preferred blockchain and fine-tune the provider and client settings to connect seamlessly with the targeted network.

    • Asynchronous JavaScript Functions:

    The code commences by importing the requisite modules, encompassing the R3vlClient from the Reveel Software Development Kit (SDK) and ethers for Ethereum-centric functionalities. Next, we have the definition of an interface called ICreateArgs, which outlines the essential parameters needed to create a revenue path. Next, a React component called CreatePathButton is defined, which takes createArgs as a prop. This component is designed to leverage the power of Web3 technology and enable users to create paths on the decentralized web easily. Bypassing the createArgs prop, users can customize and tailor the creation process to their needs. With the seamless integration of React and Web3, the CreatePathButton component empowers developers to build decentralized applications that are both user-friendly and technologically advanced. Within this component, we have an asynchronous handleSubmit function that leverages the power of R3vlClient to initiate the creation of a revenue path. This process is facilitated by passing the necessary arguments, known as createArgs, to the function. All errors are logged to the console, and a button is rendered to trigger the handleSubmit function.

    Withdrawing From Revenue Path:

    This leverages the R3vlClient and useAccount functions from the "wagmi" module, which are likely utilized for handling account-related data, along with the ethers library. Next, we define a React component named WithdrawRevenueButton. Within this decentralized application component exists a handleWithdraw function that instantiates the R3vlClient, a Web3 client library, and endeavours to initiate a revenue withdrawal process for the current account. The current account is obtained using the useAccount function, which retrieves the necessary account information. All errors are logged to the console, and a button is rendered to trigger the handleWithdraw function.

    Get Revenue Path Balances:

    This leverages the useBalances hook from the Reveel SDK, utilizes useAccount from "wagmi", integrates ethers, and includes other essential modules for seamless execution. Next, we establish an interface known as IBalances, which outlines the composition of revenue path balances. Next, a React component named DisplayBalances is defined. Within this component, we have implemented a useEffect hook that leverages the power of Web3 technology. It intelligently initializes the R3vlClient, a crucial component in the Web3 ecosystem. Furthermore, it diligently endeavours to fetch the withdrawn and withdrawable balances tailored explicitly for the current account. The computation of earnings is performed by aggregating the withdrawn and withdrawable balances, subsequently updating the state of the balances. All errors are logged to the console. The component efficiently renders the balances, displaying the aggregated total earnings, total withdrawn amount, and total withdrawable funds, if available.

    All the examples above were obtained from Wagmi functions in conjunction with the @r3vl/SDK, although it is not mandatory to use these tools.

    Exploring Protocol Capabilities: How To Fully Leverage on-chain Income Sharing

    Revenue Milestone:

Revenue Milestone
Revenue Milestone

On-chain income sharing facilitates the development of intricate revenue-sharing frameworks within decentralized protocols. In this instance, tarotsings.eth and adrienstern.eth have joined forces to collaborate on a project within the Web3 ecosystem. To foster adrienstern.eth's active involvement, a revenue milestone framework has been established.

So adrienstern.eth is granted a 5% entitlement to the initial 50 ETH generated by the project. If the project yields 50 ETH or less, adrienstern.eth will be entitled to a 5% allocation of the sum.

Once the project attains a significant milestone of 50 ETH, the revenue-sharing arrangement transforms. adrienstern.eth's stake is subsequently augmented to 10% of the forthcoming 100 ETH transacting within the project. Upon the achievement of the initial milestone, it is noted that adrienstern.eth shall be entitled to a more substantial share of the revenue from the subsequent 100 ETH.

Upon reaching the second milestone of 100 ETH, it is noteworthy that adrienstern.eth's share is augmented to 15% within the ultimate distribution tier. This implies that adrienstern.eth will be entitled to a 15% share of the revenue generated moving forward.

This revenue-sharing model aligns the interests of adrienstern.eth with the project's success, motivating their active contribution as the project attains different milestones and generates additional revenue, adrienstern.eth's proportionate stake in the income escalates, harmonizing their incentives with the project's overarching progress and expansion.

Recoupment + Splits:

Recoup
Recoup

In this particular use case, Tarotsings.eth effectively leverages on-chain income sharing for her music NFT project, seamlessly incorporating recoupment and splits to enhance the efficiency of revenue distribution.

Tarotsings.eth initiates her project by allocating an upfront investment of 10 ETH. By strategically incorporating tiers within the revenue-sharing framework, Tarotsings.eth can effectively recuperate the initial 10 ETH injected into the project. This implies that all proceeds from the undertaking will initially be allocated towards settling the 10 ETH advance until it is completely recovered.

After the initial 10 ETH advance has been recovered, the subsequent revenue is distributed based on the predetermined split structure. The splits play a crucial role in determining the equitable distribution of the remaining revenue among the various stakeholders involved in the ecosystem.

By seamlessly integrating recoupment and split functionalities into the on-chain income-sharing model, Tarotsings.eth effectively guarantees an equitable and fully transparent revenue allocation. The recoupment feature empowers Tarotsings.eth to reclaim her initial investment before distributing the revenue, thereby mitigating risk and guaranteeing a profitable return.

The splits component of the model empowers Tarotsings.eth to effectively distribute the residual revenue among the project's stakeholders under pre-established percentages or formulas. This guarantees an equitable distribution of the generated revenue among all stakeholders engaged in the music NFT initiative.

Cap Earnings:

cap earnings
cap earnings

Cap Earnings is a concept that entails the enforcement of a predetermined threshold on the quantum of profits or earnings that an individual or entity can amass within a given context or scenario. Once the predetermined threshold is attained, any additional profits or income exceeding the limit will no longer be assigned to the individual or entity. Instead, another party will redirect or retain them under the established payout structure. In this exemplary case, Tarotsings.eth and adrienstern.eth synergize their efforts in a music non-fungible token (NFT) endeavor, harnessing the power of on-chain income sharing to establish a symbiotic and advantageous partnership.

As per the agreement, Tarotsings.eth will allocate a 30% of the primary sales revenue to adrienstern.eth. In this decentralized ecosystem, it is essential to note that for every initial sale of the music non-fungible token (NFT), adrienstern.eth will be entitled to a 30% share of the revenue generated.

Nevertheless, there exists an exceptional intricacy to the revenue-sharing paradigm. Once the revenue path attains a pre-established threshold of 10 ETH, adrienstern.eth will be eliminated from the path. Henceforth, all subsequent transactions involving the NFTs shall exclusively contribute to the prosperity of Tarotsings.eth.

This decentralized framework enables adrienstern.eth to secure a just proportion of the proceeds in the early stages, guaranteeing remuneration for their invaluable input to the undertaking. Once the revenue surpasses the predetermined threshold, Tarotsings.eth will be the sole beneficiary of the revenue generated from subsequent sales, optimizing their financial gains.

Primary + Secondary Splits:

Primary Vs Secondary Sales
Primary Vs Secondary Sales

Tarotsings.eth effectively harnesses the power of on-chain income-sharing mechanisms to optimize the revenue distribution of her groundbreaking music NFT project, employing both primary and secondary splits for maximum efficiency and transparency.

Tarotsings.eth commences her groundbreaking venture by deploying music non-fungible tokens (NFTs) and judiciously opts to equitably distribute the proceeds generated from the initial sales among her esteemed team members. This implies that every member of her team will be entitled to an equitable portion of the revenue generated from direct sales. Implementing an equitable distribution model in this context cultivates a collaborative environment, guaranteeing that each team member receives compensation for their respective contributions.

Nevertheless, it is imperative to note that direct sales are subject to a predetermined cap. A novel payout structure is implemented once the revenue path attains a threshold of 20 ETH from direct sales. Henceforth, all proceeds from subsequent transactions will be channelled through the highest distribution layer.

The revised payout structure for secondary sales may exhibit variations compared to the primary distribution splits. The allocation methodology can be devised using various percentages, prioritising particular stakeholders, or considering additional factors. By leveraging the capabilities of Web3 technology, Tarotsings.eth gains the ability to dynamically adjust its revenue distribution strategy in response to the project's performance and ever-changing dynamics.

Future Potential: Additional Uses of On-chain Income Sharing

Reveel's groundbreaking advancements in this burgeoning market undoubtedly pave the way for exponential growth. In addition, the potential for future utilization of their on-chain income-sharing protocol is worth noting.

• Temporal Vesting:

Temporal Vesting is a cutting-edge mechanism that enables the gradual release of revenue shares over a predetermined time frame. In this particular scenario, Tarotsings.eth has implemented a mechanism where a fraction of the generated revenue is allocated for distribution among its team members. However, in a Web3 ecosystem, team members can only access their shares through smart contracts that enforce predetermined time locks. This methodology effectively aligns incentives for prolonged dedication and nurtures continuous cooperation by guaranteeing the ongoing engagement of team members in the project. Implementing a progressive distribution of revenue shares, effectively establishes a harmonious convergence between the objectives of the team members and the triumph of the project, thereby fostering a continuous commitment and unwavering dedication from them.

Dynamic Weighted Splits:

Dynamic Weighted Splits is an innovative revenue-sharing paradigm that leverages smart contracts to dynamically allocate distribution percentages among team members following their respective contributions. This model ensures a fair and transparent distribution of rewards, fostering a collaborative and meritocratic environment within the Web3 ecosystem. As an example, Tarotsings.eth has the potential to deploy a dynamic system that enables the adjustment of weightings allocated to team members' shares as time progresses. This adjustment can be influenced by the magnitude of their contributions, meeting specific milestones, or significant project events. In the context of Web3, it is crucial to consider these factors, as they play a pivotal role in determining the overall impact and success of decentralized projects. By employing a dynamic revenue allocation mechanism that considers individual contribution levels, this innovative approach ensures that team members are duly compensated in proportion to their diligent efforts. This incentivizes active participation and acknowledges the ever-changing dynamics within the project, aligning it with the principles of Web3.

Conclusion

Reveel's Revenue Share Protocol and its accompanying R3vl SDK epitomize a groundbreaking transformation in Web3 collaboration. Reveel, focusing on trustlessness, gas efficiency, and composability, provides creators and innovators with a resilient infrastructure to facilitate seamless revenue sharing. The intuitively designed interface of Reveel, coupled with the seamless integration mechanisms offered by the R3vl Software Development Kit (SDK), dramatically streamlines the workflow for content creators and software developers alike. The protocol's robust on-chain income-sharing capabilities facilitate a decentralized and transparent mechanism for equitable revenue distribution, effectively aligning the interests of all stakeholders involved. Reveel is strategically positioned to catalyze the expansion of Web3 through its adept utilization of collaborative mechanisms, enhanced transparency, and optimize revenue generation within the decentralized ecosystem. Become a part of the Reveel community and unlock the limitless possibilities of Web3 technology by joining today!

Subscribe to SUPERMAN
Receive the latest updates directly to your inbox.
Mint this entry as an NFT to add it to your collection.
Verification
This entry has been permanently stored onchain and signed by its creator.
More from SUPERMAN

Skeleton

Skeleton

Skeleton