* Lowering the entry barrier for new consumers by providing a medium to experience at low cost and then make the buying decision
* Simplifying asset management for institutional holders such as gaming guilds, and DAOs by enabling private rentals. They can simply whitelist the beneficiary's address ( Scholars, etc. ). **🌟 Supported Chains -** Solana, Ethereum, Polygon, Hedera, Mantle, Telos, & more coming soon ( Pipeline - Avalanche, Arbitrum, Scroll, etc. )
{% tabs %} {% tab title="Rentals on EVM" %} NFTs on EVM are not inherently lockable, therefore StreamNFT has proposed [ERC7066](https://eips.ethereum.org/EIPS/eip-7066) to enable escrowless financialization tools on EVM. StreamNFT currently supports ERC721, ERC1155 and ERC7066 NFTs. Integration steps for these can be found [here](broken://pages/g0wSoDdR7yv3kZsjOuOk). ### Features: Projects can customize own rental solutions using provided features: 1. **Asset Receipt** * Smart Registry: Low cost solution where smart contract stores the token states * Wrapped Token: Mint an [ERC7066](https://eips.ethereum.org/EIPS/eip-7066) wrapped token as receipt (an extension of ERC721 and supports all ERC721 functions). [ERC7066](https://eips.ethereum.org/EIPS/eip-7066) copy of token is transferred and locked to user wallet. Only one token is minted for each NFT and all subsequent rentals lock/unlock and transfer the wrapped token using [ERC7066](https://eips.ethereum.org/EIPS/eip-7066) capabilities, thus making the solution gas optimal. 2. **Private Rental**\ Configure rental within a specific guild or targeted user base 3. **Custom Payment Token**\ Configure rental payment in chain native token or your own ERC20 token 4. **Partner Fee**\ Project/Collection can configure their fee, which shall be processed to partner treasury on each successful rental 5. **Reward sharing**\ Reward NFT holders in native tokens or any ERC20 token, which gets distributed to NFT owner and NFT rentee as per configurable reward share 6. **Trials**\ Project can choose to list NFTs on trial for no cost. Incentivising users to experience projects and NFT utilities for free. {% endtab %} {% tab title="Rentals on Solana" %} StreamNFT brings truly decentralized and no-collateralization rental protocol, enabling digital asset owners and projects to make their NFTs rentable. Borrowers can own digital assets for their utility for a specified duration without locking up capital or exposing themselves to volatility by just paying small fees. **Supported Standard :** Metaplex Editions, pNFT ### Features: 1. **Decentralized and Escrowless**\ NFT never leaves your wallet. While renting out or on loan, NFT stays within your wallet. Enabling users to exercise utility of NFT. NFT successful rental transfers NFT to rentee and locks the NFT in the wallet. 2. **Integration require 0 line of code**\ StreamNFT moves NFTs to user wallets and enabling rental for your project require 0 development efforts 3. **Time Based and Use Based Rentals**\ NFT rental expiry can be configured based on time. Optionally with 2 lines of code on-chain / off-chain use based expiry can be configured. 4. **Private Rental**\ Configure rental within a specific guild or targeted user base 5. **Custom Payment Token**\ Configure rental payment in chain native token or your own SPL token 6. **Partner Fee**\ Project/Collection can configure their fee, which shall be processed to partner treasury on each successful rental 7. **Reward sharing**\ Reward NFT holders in native tokens or any SPL token, which gets distributed to NFT owner and NFT rentee as per configurable reward share 8. **Trials**\ Project can choose to list NFTs on trial for no cost. Incentivising users to experience projects and NFT utilities for free. {% endtab %} {% endtabs %}
Rental Protocol Flow
* Maximizing returns for institutional holders such as gaming guilds, and DAOs by letting them act as lenders ## How does StreamNFT do it? Short-term borrowing usually has high interest, so lenders can earn good returns for their risk in a short amount of time. NFT Owners may have an immediate need for cash now to sweep new mint. We connect the Lender and Borrower, and they both get a good deal. Even in the case where the Borrower fails to pay the loan back, the Lender is still protected because the NFT is worth more than what they paid to offer the loan. Make sense?
Loan Protocol Flow
* We believe in instant loans since you don't have the time to haggle over the loan price. The opportunity may pass or the value of the NFT can change if it takes too long. Traditional Peer-to-peer lending models suffer this downside
* We respect your degen knowledge and it becomes powerful when the community decides on fair loan offers that make protocol truly decentralized # How does a loan work? The owner of the NFT can **initialize** a smart contract and Program derived address ( PDA ) is created from the mint key of the NFT to store specific data including **interest, duration, transferability,** and **state** (issued, transferred, or terminated). * Lender interacts with protocol to offer capital to the collection-specific pool with defined interest & duration. * Lender can choose to cancel the offer bid anytime if an order doesn't fill for longer.
* Owner agrees to the best offer for a specific collection pool and the protocol locks NFT in the owner's wallet.
* If the loan is repaid with interest within the specified loan duration then NFT is unfreeze.
* If the loan is not repaid within the specified loan duration then NFT is transferred to the lender. \ The lifecycle of the offer is completed upon cancellation, or necessary payments are settled, and the token is returned back to the right owner. ## How NFT can be used for its utility while on loan? StreamNFT locks NFT in your wallet during the loan, despite using it as collateral. We want to bring same benefit with your NFTs as real-world financing. If you take a bank loan against a house, you still get to live inside it and retain conditional ownership unless the loan defaults. You can remain in your DAO, vote in governance, get airdrops, and get in-game utility for gaming NFTs. During the loan period, the lender cannot transfer the NFT as it is locked in the wallet. If the borrower doesn’t pay back, it will be transferred to the lender automatically. If the borrower does, then NFT is unlocked & freed. ## Things to consider * Each collection has multiple sub-pools with variable interest & duration. So, lenders can access their risk appetite and opt for better-suited sub-pool
* NFTs in a collection are regarded as equal at the moment, so you don’t need to pick your super rare NFT as collateral. Rather, you can pick an NFT you’re comfortable parting with. That way, in the unlikely event of a default, you don’t lose a sentimental NFT
* The main risk Lenders have to consider, is the event of the NFT’s value dropping below the loan offer. If you think the NFT is worth 50 SOL/ETH/HBAR, but tomorrow you think the value is now 45 SOL/ETH/HBAR, then if the Borrower defaults, you lose money. This is why Lenders often choose to over-collateralize, meaning they offer lower than what they think the NFT is worth. It’s up to you and your bullishness on a project. Maybe you think the value would go up, and no chance of it going down.
* In the case of a default, you get the NFT instead of your loan payment. So you should be comfortable with your loan offer in exchange for the NFT. You want to pay as low of a cost as possible for this consideration.
* The reason you shouldn’t offer 0.001 SOL/ETH/HBAR, is that it’s a terrible deal for the Borrower, and they may not ever take your offer. If your offer is always lower than what other Lenders offer, then it could be a long time, if ever, before your loan is accepted. # Utility Protocol Offer utility, rewards or any value to holders post mint to increase engagement In the dynamic landscape of Non-Fungible Tokens (NFTs), the benefit protocol emerges as a groundbreaking initiative aimed at enhancing post-mint NFT experiences and fostering collaboration among diverse stakeholders within the NFT ecosystem. Its primary objective is to establish an infrastructure that allows NFT collections, brands, GameFi projects, and DAOs to offer tangible benefits to any NFT collection, while enabling retail and investor holders to easily access and redeem these benefits. **Unveiling the Assumptions** Recognizing the multifaceted nature of utility, the benefit protocol operates on the premise that some aspects will remain on-chain, while others may extend into the off-chain realm. This strategic approach enables a flexible and inclusive utility framework that accommodates a wide range of offerings. The envisioned benefits include both tangible and intangible elements, such as physical products, exclusive access to events, promo codes, services like consultations, and voting rights. These utilities are designed to enrich the NFT experience and create tangible value for both creators and holders. **Examples of On-chain and Off-chain Benefits**: 1. ***Physical Products Exclusive Access*****:** Merchandise that extends the NFT experience into the physical realm. 2. ***Promo or Discount Codes*****:** Providing holders with exclusive discounts on associated products or services. 3. ***Services like 1-1 Consultations*****:** NFT holders gain access to personalized consultations. 4. ***Access to Events ( IRL/Digital ), Communities, and Digital Content*****:** Exclusive entry to real-world events and virtual engagements, fostering a sense of community. Unlocking premium digital content as an exclusive benefit for NFT holders. 5. ***Voting Rights (On-chain)*****:** Empowering NFT holders with decision-making capabilities within the ecosystem. 6. ***Opportunities for New Projects*****:** NFT collections serve as gateways for new projects to gain exposure and engagement. **What Value Benefit Protocol Adds?** In a crowded NFT landscape, simply minting unique artwork is no longer enough to guarantee long-term success. Post-mint benefits serves as a powerful tool to: * ***Increase engagement***: By providing exclusive access to content, experiences, or communities, NFT holders are incentivized to stay involved with the project. * ***Boost perceived value***: The addition of ongoing utility strengthens the perception of an NFT's value, potentially leading to price appreciation and increased demand. * ***Foster community***: Shared utility can create a sense of belonging and community among NFT holders, fostering a more loyal and invested user base. **How does it assist different Stakeholders?** \ \ Benefit protocol brings together a diverse set of stakeholders, each playing a pivotal role in shaping the collaborative landscape: * ***NFT Collections*****:** Entities with limited utility within their NFTs, seeking to enhance the value proposition for their holders. * ***Brands*****:** Eager to promote their utility offerings through collaboration with NFT collections or games. * ***GameFi*****:** Seeking to expand its reach by distributing games among new audiences through NFT partnerships. Allow NFT holders to use their NFTs as avatars within a gamified space exploration experience, earning rewards and unlocking new content. * ***DAOs*****:** Attracting specific collection holders to participate in decentralized decision-making and governance. * ***Retail/Investor Holders*****:** End users who stand to benefit directly by redeeming the utilities embedded within their NFT holdings. # How does it work? In the ever-evolving landscape of Non-Fungible Tokens (NFTs), the Protocol stands as a revolutionary framework designed to enhance the utility and engagement of NFTs post-mint. By integrating a dynamic and modular approach, the Protocol enables seamless interaction between various stakeholders, including NFT creators, brands, GameFi projects, DAOs, and individual holders. This document provides a comprehensive overview of how the Protocol functions and the benefits it brings to the NFT ecosystem. #### Core Components of the Protocol 1. **Smart Contracts**: At the heart of the Protocol are smart contracts, which ensure secure, transparent, and automated execution of benefit functions. These contracts are deployed on-chain and can interact with multiple blockchain networks, enabling cross-chain operability among benefits. 2. **Utility Portal**: The Utility Portal serves as the interface where stakeholders can create, manage, and redeem utilities. It acts as a hub for all activities related to post-mint NFT utility, providing a user-friendly experience for both creators and holders. 3. **Modular Utility Framework**: The protocol is designed to be modular, allowing for the easy addition and customization of utilities. This framework supports various utilities, from physical product redemption to exclusive digital content access and governance participation across chains. #### Workflow of the Product Protocol **1. Creation of Utilities** * **On-chain benefits**: NFT creators, brands, and other stakeholders can offer tangible benefits and post them on-chain with the Benefits protocol. They can define various benefits such as discounts, event access, consultations, etc. * **Smart Contract Deployment**: Each utility is encoded into a smart contract, ensuring that terms and conditions are immutable and transparent. These contracts are deployed on across the blockchain, making them accessible to all relevant parties. **2. Utility Management** * **Dashboard Access**: Stakeholders access a centralized dashboard on the Utility Portal to manage their benefits. This includes updating offerings, setting redemption conditions, and monitoring engagement metrics. * **Interoperability**: The modular framework allows utilities to be interoperable across different NFT collections and blockchain networks, enhancing the scope and reach of each offering. **3. Utility Redemption** * **Holder Interaction**: NFT holders can browse available benefits through the Utility Portal. They can see detailed information about each benefit, including how to redeem it and any associated conditions. * **Redemption Process**: When an NFT holder chooses to redeem a benefit, the corresponding smart contract is triggered. This ensures the utility is provided in a secure and automated manner, whether it’s shipping a physical product, granting access to an event, or unlocking digital content. **4. Tracking and Reporting** * **Real-Time Analytics**: The Utility Portal provides real-time analytics and reporting tools. Stakeholders can track the performance of their offerings, monitor engagement levels, and adjust their strategies accordingly. #### Benefits of the Protocol \ **1. For Retail/Investor Holders** * **Value Appreciation**: The ongoing utility can increase the perceived value and market demand for their NFTs. * **Tangible Benefits**: NFT holders gain access to a wide range of tangible and intangible benefits, enhancing the overall ownership experience. 2. **For NFT Creators and Collections** * **Enhanced Value Proposition**: By offering diverse and engaging utilities, NFT creators can significantly enhance the value proposition of their collections. * **Increased Engagement**: Continuous interaction with holders through utilities fosters a loyal and active community. 3. **For Brands and Partners** * **New Marketing Channels**: Brands can leverage the Product Protocol to reach targeted audiences within the NFT ecosystem, offering exclusive promotions and experiences. * **Collaborative Opportunities**: Partnerships with NFT projects can lead to innovative collaborations, expanding brand presence in the digital space. 4. **For GameFi Projects** * **Expanded Reach**: GameFi projects can integrate NFT utilities to attract new players and enhance in-game experiences. * **Reward Mechanisms**: NFTs can be used as avatars or items within games, providing additional rewards and engagement opportunities for players. 5. **For DAOs and Communities** * **Governance Participation**: DAOs can use the protocol to grant voting rights and other governance utilities to specific NFT holders, promoting decentralized decision-making. * **Community Building**: Shared utilities can strengthen community bonds and foster active participation in DAO activities. #### Conclusion The Benefit Protocol is a game-changer in the NFT space, transforming static digital assets into dynamic and value-rich experiences. By fostering collaboration among various stakeholders and providing a robust infrastructure for utility management, the protocol ensures that NFTs continue to offer value long after the initial mint. This not only enhances the NFT ecosystem but also paves the way for innovative applications and sustainable growth. # Web3 Gaming Services StreamNFT is building web2/web3 gaming backend services, enabling games to simplify their development needs. Providing scalable infrastructure with few lines of code instead of building from scratch.\ \ Stay tuned for upcoming features! # Matchmaking # Token Gated Matchmaking Ways to enable token gated matchmaking with tokens as NFT rewards:\ \ 1\. ERC721: tokens are moved to an escrow account, afterwards a match room is created. Tokens are moved to match winners after match completion.\ \ 2\. [ERC7066](https://eips.ethereum.org/EIPS/eip-7066): tokens are locked in user wallets to create a match room and transferred to the match winner. {% hint style="success" %} Added advantage of using ERC7066 is project access to integration-less [NFT liquidity solutions](broken://pages/OvkUgzieeQScDlie319V) requiring **0 dev efforts**. {% endhint %} Steps:
1. Get signer ```javascript // function to get user signer from wallet user.signer=streamSDK.getWalletSigner() ``` ```javascript // function to get user signer from privatekey user.signer=streamSDK.getSigner(privateKey) ``` 2. Join room ```javascript // function to create/join a room // @param user.id is userId of player // @param user.address user wallet address // @param tokenAddress contract address of NFT // @param tokenId token Id owned by user // @param user.signer provides a wallet instance to sign txn // @param roomSize number of players needed to create a room // @returns userId of winner await streamSDK.joinRoom(user.id, user.address, tokenAddress, tokenId, user.signer, roomSize) returns {roomId,userId} ``` 3. Claim match reward ```javascript // function to share winnings to winner // @param roomId roomId of match // @param user.address user wallet address await streamSDK.winnerClaim(roomId, user.address); ``` # ERC-7066 Interface for enabling locking of ERC-721 using locker and approved ### Abstract An extension of [ERC-721](https://eips.ethereum.org/EIPS/eip-721), this standard incorporates `locking` features into NFTs, allowing for various uses while preventing sale or transfer. The token’s `owner` can `lock` it, setting up locker address (either an EOA or a contract) that exclusively holds the power to unlock the token. Owner can also provide approval for tokenId, enabling ability to lock asset while address holds the token approval. Token can also be locked by `approved`, assigning locker to itself. Upon token transfer, these rights get purged. ### Backwards Compatibility This standard is compatible with [ERC-721](https://eips.ethereum.org/EIPS/eip-721) standards. Existing Upgradedable [ERC-721](https://eips.ethereum.org/EIPS/eip-721) can upgrade to this standard, enabling locking capability inherently and unlock underlying liquidity features. ### Motivation [ERC-721](https://eips.ethereum.org/EIPS/eip-721) has sparked an unprecedented surge in demand for NFTs. However, despite this tremendous success, NFT economy suffers from secondary liquidity where it remains Illiquid in owner’s wallet. There are projects such as NFTfi, Paraspace which aims to address the liquidity challenge, but they entail below mentioned inconveniences and risks for owners as they necessitate transferring the participating NFTs to the projects’ contracts. * **Loss of utility**: The utility value of NFTs diminishes when they are transferred to an escrow account, no longer remaining under the direct custody of the owners. * **Lack of composability**: The market could benefit from increased liquidity if NFT owners had access to multiple financial tools, such as leveraging loans and renting out their assets for maximum returns. Composability serves as the missing piece in creating a more efficient market. * **Smart contract vulnerabilities**: NFTs are susceptible to loss or theft due to potential bugs or vulnerabilities present in the smart contracts they rely on. The aforementioned issues contribute to a poor user experience (UX), and we propose enhancing the [ERC-721](https://eips.ethereum.org/EIPS/eip-721) standard by implementing a native locking mechanism: Rather than being transferred to a smart contract, an NFT remains securely stored in self-custody but is locked. During the lock period, the NFT’s transfer is restricted while its other properties remain unchanged. NFT Owner retains the ability to use or distribute it’s utility. ### Use-Cases NFTs have numerous use cases where the NFT must remain within the owner’s wallet, even when it serves as collateral for a loan. Whether it’s authorizing access to a Discord server, or utilizing NFT within a play-to-earn (P2E) game, owner should have the freedom to do so throughout the lending period. Just as real estate owner can continue living in their mortgaged house, take personal loan or keep tenants to generate passive income, these functionalities should be available to NFT owners to bring more investors in NFT economy. Lockable NFTs enable the following use cases : * **NFT-collateralized loans**: Utilize NFT as collateral for a loan without locking it on the lending protocol contract. Instead, lock it within owner’s wallet while still enjoying all the utility of NFT. * **No collateral rentals of NFTs**: Borrow an NFT for a fee without the need for significant collateral. Renter can use the NFT but not transfer it, ensuring the lender’s safety. The borrowing service contract automatically returns the NFT to the lender once the borrowing period expires. * **Buy Now Pay Later**: The buyer receives the locked NFT and can immediately begin using it. However, they are unable to sell the NFT until all installments are paid. Failure to complete the full payment results in the NFT returning to the seller, along with a fee. * **Composability**: Maximize liquidity by having access to multiple financial tools. Imagine taking a loan against NFT and putting it on rentals to generate passive income. * **Primary sales**: Mint an NFT for a partial payment and settle the remaining amount once owner is satisfied with the collection’s progress. * **Soulbound**: Organization can mint and self-assign `locker`, send token to user and lock the asset. * **Safety**: Safely and conveniently use exclusive blue chip NFTs. Lockable extension allows owner to lock NFT and designate secure cold wallet as the unlocker. This way, owner can keep NFT on MetaMask and easily use it, even if a hacker gains access to MetaMask account. Without access to the cold wallet, the hacker cannot transfer NFT, ensuring its safety. # Overview [ERC-721](https://eips.ethereum.org/EIPS/eip-721) compliant contracts MAY implement this EIP to provide standard methods of locking and unlocking the token at its current owner address. Token owner MAY `lock` the token and assign `locker` to some `address` using `lock(uint256 tokenId, address _locker)` function, this MUST set `locker` to `_locker`. Token owner or approved MAY `lock` the token using `lock(uint256 tokenId)` function, this MUST set `locker` to `msg.sender`. Token MAY be `unlocked` by `locker` using `unlock` function. `unlock` function MUST delete `locker` mapping and default to `address(0)`. If the token is `locked`, the `lockerOf` function MUST return an address that is `locker` and can `unlock` the token. For tokens that are not `locked`, the `lockerOf` function MUST return `address(0)`. `lock` function MUST revert if token is not already locked. `unlock` function MUST revert if token is not locked. ERC-721 `approve` function MUST revert if token is locked. ERC-721 `_tansfer` function MUST revert if token is locked. ERC-721 `_transfer` function MUST pass if token is locked and `msg.sender` is `approved` and `locker` both. After ERC-721 `_transfer`, values of `locker` and `approved` MUST be purged. Token MAY be transferred and `locked`, and OPTIONAL setup `approval` to `locker` using `transferAndLock` function. This is RECOMMENDED for use-cases where Token transfer and subsequent revocation is REQUIRED. #### INTERFACE ``` // SPDX-License-Identifier: CC0-1.0 pragma solidity >=0.7.0 <0.9.0; /// @title Lockable Extension for ERC721 /// @dev Interface for the Lockable extension /// @author StreamNFT interface IERC7066{ /** * @dev Emitted when tokenId is locked */ event Lock (uint256 indexed tokenId, address _locker); /** * @dev Emitted when tokenId is unlocked */ event Unlock (uint256 indexed tokenId); /** * @dev Lock the tokenId if msg.sender is owner or approved and set locker to msg.sender */ function lock(uint256 tokenId) external; /** * @dev Lock the tokenId if msg.sender is owner and set locker to _locker */ function lock(uint256 tokenId, address _locker) external; /** * @dev Unlocks the tokenId if msg.sender is locker */ function unlock(uint256 tokenId) external; /** * @dev Tranfer and lock the token if the msg.sender is owner or approved. * Lock the token and set locker to caller * Optionally approve caller if bool setApprove flag is true */ function transferAndLock(uint256 tokenId, address from, address to, bool setApprove) external; /** * @dev Returns the wallet, that is stated as unlocking wallet for the tokenId. * If address(0) returned, that means token is not locked. Any other result means token is locked. */ function lockerOf(uint256 tokenId) external view returns (address); } ``` # NFT Rentals Owner can transfer NFT to a borrower with zero collateral **No Collateral NFT Rentals:** NFT renting is a way of granting temporary access to an NFT for a fee. Users get to enjoy the utility and benefits of an NFT without owning it permanently and allows NFT owners to earn passive income from their NFTs without selling them. #### Case Study {% tabs %} {% tab title="Gaming" %} **No Collateral NFT Rentals of In-game Assets:** Enables NFT holders to lend their one-of-a-kind in-game assets to other gamers, thus enabling them access for a specific time. Games can attract wider participation by removing entry barriers i.e. insufficient capital or non-availability of NFT. Our 10+ demand channel partners (i.e. Guilds, Wallets, Communities) amplify the distribution of rentable NFTs\ \ **Features**: Guild Onboarding, Private Rentals, Custom Payment Token, Partner Fees #### Case Study : \ The NFT rental case study explores the innovative application of non-fungible tokens (NFTs) in the GameFi rental industry, highlighting the benefits and challenges associated with this emerging trend\ \ **Problem :** * *High Entry Barriers*: The exorbitant prices of NFTs create a significant barrier for student gamers and those from developing nations. * *Low Asset Utilization*: The concentrated distribution of assets limits the NFTs' contribution to the game economy, with a considerable percentage of holders remaining inactive. * *Monetization Challenges*: The lack of avenues for monetization from the secondary market hampers the full potential of NFT mechanics. **Solution** : Implementing a decentralized peer-to-peer (P2P) NFT sharing model aims to address these challenges, allowing gamers to earn passive income from idle NFTs. * *Monetization*: Projects can earn royalties from a secondary NFT sharing model by setting up partner fees * *Accessible Ownership*: NFT rentals allow individuals to experience ownership of high-value assets without the financial burden * *Increased Engagement and Distribution*: NFT sharing lets more gamers interact with rare experiences, creating a long tail of gamers who would buy NFTs that might result in high buy pressure * *Custom Payment Token*: Integration with in-game tokens enables a custom payment feature, potentially appreciating the value of tokens through transactions during rentals. * *Increased Liquidity*: Enables owners to unlock liquidity by renting out assets without selling them **Features** : * *Guild Onboarding*: Distributing rental NFTs through guilds broadens the distribution reach, engaging a wider audience * *Private Rentals*: NFT sharing among whitelisted addresses allows guilds to collaborate with scholars and individual gamers to form micro guilds for NFT sharing **Conclusion**: The NFT rental case study underscores the potential to enhance engagement and financial inclusivity within the gaming community. It not only offers a solution to entry barriers but also provides game developers with a novel approach to distributing assets widely and introduces additional layers of monetization. The combined benefits of increased liquidity, accessible ownership, and streamlined processes make NFT rentals a promising frontier for ongoing exploration and innovation in the gaming industry {% endtab %} {% tab title="NFT" %} Artists may rent out their digital artworks to be exhibited, game producers can sublet in-game stuff, and landlords of digital land can allow temporary access to its virtual spaces.\ \ **UseCases:** Domain Rentals, RWA assets Rentals, Virtual Ad Spaces, Virtual Land, etc.\ \ **Problems**:\ \ ***UnderUtilization***: Virtual real estate and digital spaces may remain underutilized if ownership barriers are high.\ \ Traditional licensing models may be restrictive and lack transparency.\ \ Limited engagement options for brands and sponsors in virtual events.\ \ **Solutions**:\ \ NFT rentals enable art enthusiasts to temporarily possess and display digital art, fostering wider access to the art market.\ \ NFT rentals allow individuals and businesses to lease virtual spaces, enabling temporary use without the need for substantial upfront investments.\ \ NFT rentals provide a flexible sponsorship model, allowing brands to lease virtual goods or spaces within events, fostering interactive and immersive experiences.\ \ NFT rentals offer a transparent and decentralized way for creators to license their intellectual property, allowing temporary use and compensating creators directly through smart contracts.\ \ **Conclusion**: NFT rentals are expanding beyond the gaming industry, demonstrating their versatility and potential in various non-gaming sectors. This case study highlights the opportunities for increased accessibility, flexible licensing, and novel revenue streams through the application of NFT rentals in art, real estate, intellectual property, and event spaces. As the concept continues to evolve, businesses and creators need to explore innovative ways to leverage NFT rentals. {% endtab %} {% endtabs %} ## # Ephemeral / Consumable NFTs Introduce Ephemeral/Trial utility NFTs that grant access for a limited duration or after specific usage thresholds Developers have the option to introduce Ephemeral/Trial utility NFTs that grant access for a limited duration or after specific usage thresholds. Particularly suitable for Free-to-Play games, this approach can enhance financial inclusion by capitalizing on the 'Try before Buy' concept.\ \ **Features**: Time-Based Expiry, Use Based Expiry\ \ **Case Study** :\ \ Ephemeral Utility NFTs represent a groundbreaking concept wherein developers introduce NFTs with disposable attributes, enabling access for a limited time or after specific usage conditions are met. This case study delves into the innovative realm of Ephemeral Utility NFTs, examining their impact on user engagement, financial dynamics, and the broader implications for digital ecosystems.\ \ **Problem** : * *Limited Access and Exclusivity*: Traditional NFTs often lack a dynamic aspect, leading to a static sense of ownership without considering the evolving nature of digital content. * *Risk in 'Try before Buy' Scenarios*: Users may be hesitant to purchase non-fungible tokens without experiencing the associated digital content, leading to potential dissatisfaction and financial risks. * *Monetization in Free-to-Play Models*: Free-to-play models often face challenges in monetizing user engagement effectively, as not all users are willing to make upfront purchases. * *Creating Scarcity in Digital Assets*: Scarcity is a fundamental driver of value, and digital assets often lack the scarcity element that physical assets inherently possess. **Solution** :\ The introduction of Consumable/Ephemeral NFTs aims to address these challenges by redefining the concept of permanence. Unlike traditional NFTs, these tokens come with an expiration date or limited use, introducing a temporal element to digital ownership. This model opens the door for unique experiences and time-bound content within the NFT ecosystem. * *Enhanced User Engagement*: Ephemeral NFTs introduce limited-time access, creating a sense of exclusivity and urgency. This dynamic feature encourages users to actively engage with the content during the specified period, enhancing the overall user experience. * *Financial Inclusion*: The 'Try before Buy' concept allows users to experience premium features without committing to a full purchase, fostering a more inclusive environment for individuals with varying financial capacities. * *Monetization*: Ephemeral NFTs provide a monetization strategy by offering temporary access to premium features. Users can opt to extend or enhance their experience through microtransactions, creating a revenue stream that caters to a broader user base. * *Creating Scarcity in Digital Assets*: Ephemeral NFTs introduce a time-bound aspect to digital ownership, mimicking scarcity by limiting access. This scarcity can increase the perceived value of the NFT and encourage engagement. **UseCases**: {% tabs %} {% tab title="Gaming" %} ***Free-to-Play Games***: Consider a Free-to-Play game that implements Ephemeral Utility NFTs to provide temporary access to premium in-game items, characters, or features. Users can engage with these exclusive elements for a limited time, enticing them to explore the game's full potential. The 'Try before Buy' approach leads to increased in-game transactions and a more inclusive gaming community. {% endtab %} {% tab title="Art/Culture" %} Consider an artist, Mia, who mints a series of Consumable NFTs tied to an exclusive virtual concert experience. Each NFT provides the owner with access to the concert for a limited time, say 24 hours. Collectors are not just acquiring a static piece of digital art but a ticket to a unique, time-bound event. As the concert approaches, the value and demand for Mia's Consumable NFTs surge, creating a dynamic and time-sensitive market. ***Token Gated NFTs*** : * Provide NFT-controlled access to the community, voting, file storage, etc. * Mint membership, subscription NFTs for your users that expire over time or after certain usage. * Mint tickets for your events, concerts, etc. {% endtab %} {% endtabs %} \ \ **Conclusion**: Ephemeral Utility NFTs have the potential to reshape how users interact with digital content, offering a unique blend of exclusivity and accessibility. As demonstrated by the case study, these tokens can foster enhanced user engagement, create novel revenue streams, and promote financial inclusion in various industries, with the gaming sector serving as a compelling example of successful implementation. However, careful consideration of user experience and monetization strategies is crucial for maximizing the benefits of Ephemeral Utility NFTs.
# NFT Mandates Mandates when NFT is to be transferred later, but the commitment is to be made now As the NFT ecosystem expands, the need arises for mechanisms that enable commitments to transfer NFTs at a later date, contingent on specific conditions or events. NFT Mandates address this by allowing users to make commitments for future transfers, opening up a range of use cases beyond immediate ownership. **Problem**:\ \ Traditional NFT transfers are immediate and unconditional, limiting the scope of applications where conditional transfers based on future events or circumstances are required. The absence of a structured framework for such commitments hinders the development of innovative use cases in the NFT space. **Solution**:\ \ NFT Mandates are introduced as a solution to address this gap. These mandates allow for commitments to transfer NFTs at a later time, under predefined conditions. This approach expands the utility of NFTs beyond static ownership, facilitating dynamic interactions and applications in various scenarios.\ \ ***Smart Contract Automation***: Smart contracts play a central role in the implementation of NFT Mandates, automating the execution of transfers when the specified conditions are met, ensuring transparency and reliability.\ \ **Key Features**: * *Conditional Transfers*: NFT Mandates enable conditional transfers based on predefined criteria, such as the occurrence of a specific event, the completion of a task, or the fulfillment of contractual agreements. * *Token-Gating*: Mandated Transfers are utilized for token-gating scenarios, where access to specific content, events, or features is granted only upon the completion of certain conditions or criteria. * *Matchmaking and Wagers*: NFT Mandates find application in matchmaking scenarios, where the transfer of NFTs is contingent on specific criteria being met between two parties. Additionally, they can be employed in wagering situations, with NFTs acting as collateral based on the outcome of an event. **Case Study Scenario**:\ \ Consider a gaming platform that uses NFT Mandates for token-gating. Users commit to transferring specific in-game items (NFTs) to other players upon achieving certain milestones or completing challenges. The smart contract associated with the NFT Mandate ensures that the transfer occurs automatically once the conditions are met, creating a dynamic and engaging gaming experience. **Conclusion**:\ \ The utilization of NFT Mandates for conditional transfers in future use cases showcases the adaptability and versatility of blockchain technology in the NFT space. By enabling commitments for transfers contingent on specific events or conditions, NFT Mandates pave the way for innovative applications such as token-gating, matchmaking, wagers, and more. As the NFT landscape evolves, the implementation of Mandated Transfers offers a glimpse into the future possibilities of dynamic and interactive digital asset ownership.
# Post-Mint Utility Provide value to holders post mint to increase engagement Post-mint utility refers to the value and benefits that are introduced to an NFT collection after the initial minting process. This goes beyond the inherent value associated with the digital artwork itself and instead focuses on creating ongoing engagement and rewarding ownership.\ \ **Why is Post-Mint Utility Important?**\ \ In a crowded NFT landscape, simply minting unique artwork is no longer enough to guarantee long-term success. Post-mint utility serves as a powerful tool to: * *Increase engagement*: By providing exclusive access to content, experiences, or communities, NFT holders are incentivized to stay involved with the project. * *Boost perceived value*: The addition of ongoing utility strengthens the perception of an NFT's value, potentially leading to price appreciation and increased demand. * *Foster community*: Shared utility can create a sense of belonging and community among NFT holders, fostering a more loyal and invested user base. **Examples of Post-Mint Utility in Action:**\ \ The article explores various examples of post-mint utility, and here are a few noteworthy ones: * *Exclusive content*: Granting NFT holders access to gated Discord channels, early previews of new artwork, or private AMAs with creators. * *Physical merchandise*: Offering limited-edition merchandise or collectibles redeemable with NFTs, blurring the lines between the digital and physical worlds. * *Discounted access*: Providing discounts on future NFT drops, merchandise, or even real-world events and experiences. * *Governance rights*: Enabling NFT holders to vote on project decisions or participate in shaping the future of the community. **Implementing Post-Mint Utility: A Case Study**\ \ Imagine a hypothetical NFT project centered around a collection of space-themed artwork. To implement post-mint utility, the creators could: * *Collaborate with the interactive online game*: Allow NFT holders to use their NFTs as avatars within a gamified space exploration experience, earning rewards and unlocking new content. * *Partner with Brands*: Offer exclusive discounts on merchandise to NFT holders. **Conclusion:**\ \ By strategically implementing a post-mint utility, NFT projects can move beyond the initial hype and cultivate a thriving community around their offerings. The key lies in understanding the needs and interests of the target audience and then crafting unique and engaging experiences that leverage the power of NFTs in innovative ways.\ \ This case study serves as a starting point for exploring the vast potential of post-mint utility. By embracing creativity and a commitment to long-term engagement, NFT projects can unlock new levels of value and success.
# Partial Payment at Mint The owner can get instant liquidity from a lender while the lender earns > 50% APY This case study explores the innovative concept of Partial Payment NFT Mint during primary sales, analyzing its impact on democratizing access to digital assets, fostering wider community engagement, and redefining the traditional model of NFT acquisition. **Problem:**\ \ As the popularity of NFTs surged, a significant barrier to entry emerged for many enthusiasts who couldn't afford the upfront cost of purchasing high-value or limited edition NFTs during primary sales. The traditional model required full payment at the time of minting, limiting the accessibility of these digital assets to a select group of buyers.\ \ It is difficult for unrecognized artists to sell out at Mint and a barrier to developing trust among high-end collectors.\ \ **Solution:** The introduction of Partial Payment NFT Mint at Primary Sales seeks to address the financial barriers associated with acquiring NFTs. This model allows buyers to make partial payments during the minting process, securing a stake in the NFT without the need for immediate full payment. This innovative approach aims to make NFTs more inclusive and accessible to a broader audience.\ \ It can also inculcate behavior where buyers acquire NFT with partial payment and pay the remaining amount based on the collection owner’s progress. **Key Features:** * *Partial Payment Options*: Buyers have the flexibility to choose partial payment plans, allowing them to secure NFTs at a fraction of the total cost during the primary sales event. * *Smart Contract Automation*: The use of smart contracts facilitates the automation of partial payments, ensuring a secure and transparent process without the need for intermediaries. * *Tiered Ownership*: Depending on the level of partial payment made, buyers may receive tiered ownership benefits, such as early access to additional content, exclusive events, or governance rights within the NFT community. * *Community Engagement*: The model encourages a more diverse and engaged community by lowering the financial barrier to entry, enabling a wider range of participants to become stakeholders in the NFT ecosystem. **Case Study Scenario:** Imagine an artist, Alex, launching a limited edition NFT collection with a total minting cost of 1 ETH per NFT. With Partial Payment NFT Mint, buyers can choose to make a 0.2 ETH partial payment during the minting process, securing their ownership stake in the NFT. The remaining balance can be paid over a specified period or before a set deadline. As a result, Alex's NFT collection attracts a more diverse group of buyers who may not have been able to participate in traditional sales due to financial constraints.
**Conclusion:** Partial Payment NFT Mint at Primary Sales presents a paradigm shift in the NFT market, fostering inclusivity and expanding access to digital assets. By allowing buyers to secure NFTs with partial payments, this model opens the door for a more diverse community of collectors and enthusiasts. As the NFT space continues to evolve, the impact of this innovative approach on democratizing ownership and fostering community engagement could redefine the future dynamics of primary NFT sales. # NFT Rental **NFT Rental Integration Overview** Projects have the flexibility to choose between hosting a rental marketplace on the StreamNFT Dapp or seamlessly integrating it into their game or project environment. Integrate Rentals and host on StreamNFT Marketplace in **10 mins**
Benefits of Hosting Rental marketplace with StreamNFT
* Get live in 5 mins * No need to incur hefty cloud infra hosting cost * Cross promotion of NFTs who are engaged with other games * Customize your own protocol treasury, protocol fee percentage, and payment token * Marketplace can be deployed on project specific sub domain with brand specific guidelines ( Example : darkforest.streamnft.tech )Onboard Your Project
StreamNFT brings customisation to collection owner to define: protocol treasury, protocol fee percentage, and payment token type.\ \ To get started with renting your project or collection through StreamNFT hosted Dapp. please complete the onboarding process by filling out the form at the following link: [Onboard Your Project](https://tally.so/r/mVQDxE).\ \ *Onboarding Automation Coming Soon on Application*| API Reference | ||
| SDK Reference | ||
| On-Chain Reference |
Benefits of Hosting Rental marketplace with StreamNFT
* Get live in 5 mins * No need to incur hefty cloud infra hosting cost * Cross promotion of NFTs who are engaged with other games * Marketplace can be deployed on project specific sub domain with brand specific guidelines ( Example : darkforest.streamnft.tech )| EVM | On-Chain calls Data Indexer | |
| Solana Integration |
UtilitySchema
```json { "utilityId": { "type": "String", "required": true, "unique": true }, "utilityIndex": "Number", "provider": "String", "winners": [ "String" ], "participants": [ "String" ], "chainId": "Number", "utilityType": { "type": "String", "required": true }, "usage": { "expiryOrUsage": "Number", "startOnClaim": "Boolean" }, "raffle": { "totalEntries": { "type": "Number", "default": 0 }, "participants": [ "String" ], "winners": [ "String" ], "maxEntries": "Number", "winnersMerkle": "String", "claimDate": "Date" }, "target": [ { "collection": "String", "chainId": "String", "name": "String", "eligibleType": { "type": "String", "required": true }, "traits": [ { "key": "String", "value": "String" } ] } ], "eligible": { "type": "Map", "of": { "eligibleType": { "type": "String", "required": true }, "participants": [ "String" ], "externalService": { "type": "String" }, "traits": [ { "key": "String", "value": "String" } ], "numberOfEntries": "Number", "collectionImage": "String", "collectionName": "String", "chainId": "String", "collectionAddress": "String", "taskDetails": [ { "taskInfo": "String", "serviceTarget": "String", "targetURL": "String", "numberOfEntries": "Number", "mandatory": "Boolean" } ] }, "default": {} }, "partner": "String", "selectionType": { "type": "String", "required": true }, "title": "String", "category": "String", "image_url": "String", "reward": { "value": "String", "estimatedValue": "String", "mintPrice": "Number", "details": [ "String" ], "image": "String", "type": { "type": "String", "required": true }, "currency": { "type": "String", "default": "USD" }, "count": "Number", "expiry": "String", "chainId": "Number", "secret": { "value": "String", "details": [ { "value": "String", "claimed": "Boolean" } ] }, "congratulationText": "String" }, "createdAt": "Date", "description": "String", "startDate": "Date", "endDate": "Date" } ```const tokenAddress = "TOKEN_ADDRESS";
const tokenId = "TOKEN_ID";
stream.getAssetManager(tokenAddress, tokenId, chainId)
.then((result) => {
// Handle the result (asset manager details)
})
.catch((error) => {
// Handle the error
});
These examples demonstrate how to use the SDK functions to interact with the smart contract. You can integrate them into your application logic and handle the results and errors accordingly. # Solana SDK optional parameters: | | true | false | | --------- | ---------------------- | ---------------------------- | | secretKey | sign using secret key | sign using wallet adapter | | raw | return raw transaction | execute transaction on-chain | ### Initialize Initializes NFT rental {% tabs %} {% tab title="JS" %} ```javascript stream.initRent( rate: BN, // rent price per minute in lamport offerDurationInMinutes: BN, // lend offer duration in minutes fixedDurationInMinutes: BN, // fixed rent duration in minutes rentIsFixed: boolean, // if a lender decides to define fixed rent duration ownerRevenue: BN, // owner share for revenue trialType: TrialType | null, // not null if not on trial trialFee: BN | null, // not null if on trial mint: PublicKey, // mint address of NFT whiteList?: PublicKey, //optional secretKey?: string, //Optional (providing secret send on-chain transaction) raw?: boolean //Optional (return raw transaction) ) ``` {% endtab %} {% endtabs %} ### \[Process] Processes NFT rental {% tabs %} {% tab title="JS" %} ```javascript processRent( timeInMinutes: BN, // rental duration in minutes nftMint: PublicKey, // mint address of NFT secretKey?: string, //Optional (providing secret send on-chain transaction) raw?: boolean //Optional (return raw transaction) ) ``` {% endtab %} {% endtabs %} ### \[Cancel] Cancels the nft rental {% tabs %} {% tab title="JS" %} ```javascript cancelRent( nftMint: PublicKey, // mint address of NFT secretKey?: string, //Optional (providing secret send on-chain transaction) raw?: boolean ) ``` {% endtab %} {% endtabs %} ### \[Expire] Expire NFT rental. This gets triggered by our revocation system. {% tabs %} {% tab title="JS" %} ```javascript expireRent( nftMint: PublicKey, // mint address of NFT secretKey?: string, raw?: boolean ) ``` {% endtab %} {% endtabs %} # Loan Integration # EVM **1. Initialize a bid pool:** To create a bid pool for your NFT collection, follow the steps below: * `tokenAddress`: The address of the ERC721 token representing your NFT collection. * `loanDurationInMinutes`: The duration of the loan period in minutes. * `gracePeriodInMinutes`: The grace period in minutes before the loan expires. * `interestRateLender`: The interest rate for the lender, specified in percentage. {% tabs %} {% tab title="JS" %} ```javascript const tokenAddress = "TOKEN_ADDRESS"; // ERC721 Token address const loanDurationInMinutes = 60; const gracePeriodInMinutes = 10; const interestRateLender = 5; // in percentage stream.createLoanPool( tokenAddress, loanDurationInMinutes, gracePeriodInMinutes, interestRateLender, chainId, signer ) .then((result) => { // Handle the result }) .catch((error) => { // Handle the error }); ``` {% endtab %} {% endtabs %} By following these steps, you can create a bid pool for your NFT collection and manage various loan-related operations efficiently using the SDK. Remember to replace the placeholder `TOKEN_ADDRESS` with the actual address of your ERC721 token. **2. Get bid pool details by bidPoolIndex:** To retrieve the bidding pool for your NFT collection, you can use the following method: * `bidPoolIndex`: The index of the bid pool. {% tabs %} {% tab title="JS" %} ```javascript const bidPoolIndex = 0; // Index of the bid pool strean.getBidPoolByIndex(bidPoolIndex, chainId) .then((result) => { // Handle the result }) .catch((error) => { // Handle the error }); ``` {% endtab %} {% endtabs %} ```javascript Response object of bid pool : { initializerKey: the address of the administrator, tokenAddress: the address of the token (e.g., 'xyz'), loanDurationInMinutes: the duration of the loan (e.g., 30 days), gracePeriodInMinutes: the grace period of the loan, apy: the annual percentage yield (e.g., 20%), interestRateLender: the interest rate for the lender, interestRateProtocol: the interest rate for the protocol, totalBidManager: the total bids managed, lastBidAmount: the amount of the last bid, bidNftFloorPrice: the minimum bid price for the NFT, } ``` This code snippet demonstrates how to use and handle the returned data from the `getBidPools` function, as well as provides descriptions of the properties in the BidPool data structure. By executing this code snippet, you will receive the details and information associated with the bid pool for your NFT collection. Remember to replace the `bidPoolIndex` with the actual index of the bid pool you want to retrieve. **3. Get the length of the bid pool:** To retrieve the length of the bidding pool for your NFT collection, you can use the following method: chainId: The identifier of the blockchain where the NFTs reside. {% tabs %} {% tab title="JS" %} ```javascript getBidPoolLength(chainId) .then((result) => { // Handle the result // Result will be the length of the bid pool on the specified chain }) .catch((error) => { // Handle the error }); ``` {% endtab %} {% endtabs %} By executing this code snippet, you will receive the total number of bid pools associated with your NFT collection on the specified blockchain. Remember to replace the `chainId` with the actual identifier of the blockchain where your NFTs are located. **4. Get all bid pools:** To retrieve all the bidding pools for your NFT collection, you can use the following method: chainId: The identifier of the blockchain where the NFTs reside. {% tabs %} {% tab title="JS" %} ```javascript getBidPools(chainId) .then((result) => { // Handle the result // Result will be an array of all the bid pools on the specified chain }) .catch((error) => { // Handle the error }); ``` {% endtab %} {% endtabs %} ```javascript Response object of bid pool List : [{ initializerKey: the address of the administrator, tokenAddress: the address of the token (e.g., 'xyz'), loanDurationInMinutes: the duration of the loan (e.g., 30 days), gracePeriodInMinutes: the grace period of the loan, apy: the annual percentage yield (e.g., 20%), interestRateLender: the interest rate for the lender, interestRateProtocol: the interest rate for the protocol, totalBidManager: the total bids managed, lastBidAmount: the amount of the last bid, bidNftFloorPrice: the minimum bid price for the NFT, }] ``` This code snippet demonstrates how to use and handle the returned data from the `getBidPools` function, as well as provides descriptions of the properties in the BidPool data structure. By executing this code snippet, you will receive a list of all the bid pools associated with your NFT collection on the specified blockchain. Remember to replace the `chainId` with the actual identifier of the blockchain where your NFTs are located. **5. Creating a Bid Manager:** To create a bid manager, you can use the following function: * Provide the index of the bid pool, bid amount, total number of bids, chainId, and signer. {% tabs %} {% tab title="JS" %}
const bidPoolIndex = 0; // Index of the bid pool
const bidAmount = 100; // Amount of the bid
const totalBids = 10; // Total number of bids
stream.addLoanOffer(bidPoolIndex, bidAmount, totalBids, chainId, signer)
.then((result) => {
// Handle the result
})
.catch((error) => {
// Handle the error
});
const bidPoolIndex = 0; // Index of the bid pool
const bidManagerIndex = 0; // Index of the bid manager
stream.cancelManager(bidPoolIndex, bidManagerIndex, chainId, signer)
.then((result) => {
// Handle the result
})
.catch((error) => {
// Handle the error
});
These examples demonstrate how to use the SDK functions to interact with the smart contract. You can integrate them into your application logic and handle the results and errors accordingly. # Solana **1. Initialize a bid pool:** To create a bid pool for your NFT collection, follow the steps below: * `tokenAddress`: The address of the ERC721 token representing your NFT collection. * `loanDurationInMinutes`: The duration of the loan period in minutes. * `gracePeriodInMinutes`: The grace period in minutes before the loan expires. * `interestRateLender`: The interest rate for the lender, specified in percentage. {% tabs %} {% tab title="JS" %} ```javascript const tokenAddress = "TOKEN_ADDRESS"; // ERC721 Token address const loanDurationInMinutes = 60; const gracePeriodInMinutes = 10; const interestRateLender = 5; // in percentage stream.createLoanPool( tokenAddress, loanDurationInMinutes, gracePeriodInMinutes, interestRateLender, chainId, signer ) .then((result) => { // Handle the result }) .catch((error) => { // Handle the error }); ``` {% endtab %} {% endtabs %} By following these steps, you can create a bid pool for your NFT collection and manage various loan-related operations efficiently using the SDK. Remember to replace the placeholder `TOKEN_ADDRESS` with the actual address of your ERC721 token. **2. Get bid pool details by bidPoolIndex:** To retrieve the bidding pool for your NFT collection, you can use the following method: * `bidPoolIndex`: The index of the bid pool. {% tabs %} {% tab title="JS" %} ```javascript const bidPoolIndex = 0; // Index of the bid pool strean.getBidPoolByIndex(bidPoolIndex, chainId) .then((result) => { // Handle the result }) .catch((error) => { // Handle the error }); ``` {% endtab %} {% endtabs %} ```javascript Response object of bid pool : { initializerKey: the address of the administrator, tokenAddress: the address of the token (e.g., 'xyz'), loanDurationInMinutes: the duration of the loan (e.g., 30 days), gracePeriodInMinutes: the grace period of the loan, apy: the annual percentage yield (e.g., 20%), interestRateLender: the interest rate for the lender, interestRateProtocol: the interest rate for the protocol, totalBidManager: the total bids managed, lastBidAmount: the amount of the last bid, bidNftFloorPrice: the minimum bid price for the NFT, } ``` This code snippet demonstrates how to use and handle the returned data from the `getBidPools` function, as well as provides descriptions of the properties in the BidPool data structure. By executing this code snippet, you will receive the details and information associated with the bid pool for your NFT collection. Remember to replace the `bidPoolIndex` with the actual index of the bid pool you want to retrieve. **3. Get the length of the bid pool:** To retrieve the length of the bidding pool for your NFT collection, you can use the following method: chainId: The identifier of the blockchain where the NFTs reside. {% tabs %} {% tab title="JS" %} ```javascript getBidPoolLength(chainId) .then((result) => { // Handle the result // Result will be the length of the bid pool on the specified chain }) .catch((error) => { // Handle the error }); ``` {% endtab %} {% endtabs %} By executing this code snippet, you will receive the total number of bid pools associated with your NFT collection on the specified blockchain. Remember to replace the `chainId` with the actual identifier of the blockchain where your NFTs are located. **4. Get all bid pools:** To retrieve all the bidding pools for your NFT collection, you can use the following method: chainId: The identifier of the blockchain where the NFTs reside. {% tabs %} {% tab title="JS" %} ```javascript getBidPools(chainId) .then((result) => { // Handle the result // Result will be an array of all the bid pools on the specified chain }) .catch((error) => { // Handle the error }); ``` {% endtab %} {% endtabs %} ```javascript Response object of bid pool List : [{ initializerKey: the address of the administrator, tokenAddress: the address of the token (e.g., 'xyz'), loanDurationInMinutes: the duration of the loan (e.g., 30 days), gracePeriodInMinutes: the grace period of the loan, apy: the annual percentage yield (e.g., 20%), interestRateLender: the interest rate for the lender, interestRateProtocol: the interest rate for the protocol, totalBidManager: the total bids managed, lastBidAmount: the amount of the last bid, bidNftFloorPrice: the minimum bid price for the NFT, }] ``` This code snippet demonstrates how to use and handle the returned data from the `getBidPools` function, as well as provides descriptions of the properties in the BidPool data structure. By executing this code snippet, you will receive a list of all the bid pools associated with your NFT collection on the specified blockchain. Remember to replace the `chainId` with the actual identifier of the blockchain where your NFTs are located. **5. Creating a Bid Manager:** To create a bid manager, you can use the following function: * Provide the index of the bid pool, bid amount, total number of bids, chainId, and signer. {% tabs %} {% tab title="JS" %}
const bidPoolIndex = 0; // Index of the bid pool
const bidAmount = 100; // Amount of the bid
const totalBids = 10; // Total number of bids
stream.addLoanOffer(bidPoolIndex, bidAmount, totalBids, chainId, signer)
.then((result) => {
// Handle the result
})
.catch((error) => {
// Handle the error
});
const bidPoolIndex = 0; // Index of the bid pool
const bidManagerIndex = 0; // Index of the bid manager
stream.cancelManager(bidPoolIndex, bidManagerIndex, chainId, signer)
.then((result) => {
// Handle the result
})
.catch((error) => {
// Handle the error
});
These examples demonstrate how to use the SDK functions to interact with the smart contract. You can integrate them into your application logic and handle the results and errors accordingly. # Marketplace # On-Chain Reference EVM If your project uses on-chain calls for `token owner`, replace them with streamNFT contract calls using the streamNFT ABI
StreamNFT ABI for NFT State calls
```json [ { "inputs": [ { "internalType": "uint256", "name": "tokenId", "type": "uint256" } ], "name": "ownerOf", "outputs": [ { "internalType": "address", "name": "", "type": "address" } ], "stateMutability": "view", "type": "function" }, { "inputs": [ { "internalType": "address", "name": "tokenAddress", "type": "address" }, { "internalType": "uint256", "name": "tokenId", "type": "uint256" }, { "internalType": "address", "name": "user", "type": "address" } ], "name": "balanceOf", "outputs": [ { "internalType": "uint256", "name": "", "type": "uint256" } ], "stateMutability": "view", "type": "function" }, { "inputs": [ { "internalType": "address", "name": "tokenAddress", "type": "address" }, { "internalType": "address", "name": "user", "type": "address" } ], "name": "balanceOf", "outputs": [ { "internalType": "uint256", "name": "", "type": "uint256" } ], "stateMutability": "view", "type": "function" } ] ``````javascript (ERC721) ownerOf(tokenId) -> (streamNFT) ownerOf(tokenAddress,tokenId) (ERC721) balanceOf(user) -> (streamNFT) balanceOf(tokenAddress,user) ``` 2. For ERC1155 token, you need to update on-chain call with ```javascript (ERC1155) balanceOf(tokenId,user) -> (streamNFT) balanceOf(tokenAddress,tokenId,user) ``` # Wallet Provider Reference # Rental The Custom Integration provides developers with the flexibility to fully integrate our functionalities within wallets. This guide walkthrough JS based SDK calls which interact with both on-chain and streamNFT indexers. {% hint style="info" %} This is required for wallets who are interesting in implementing rental/loan infrastructure within their own ecosystem. {% endhint %} {% hint style="info" %} For enabling rentals directly using [StreamNFT hosted application](https://rent.streamnft.tech/) check [quick guide](broken://pages/g0wSoDdR7yv3kZsjOuOk). {% endhint %} # EVM To integrate the SDK with your repository, follow the steps below. The following code snippets provide examples of how to use the SDK functions to interact with the smart contract. ``` Testnet SDK: streamnft-evm-test Mainnet SDK: streamnft-evm ``` **1. Get Rented NFTs By Wallet:** To retrieve the details of a specific user asset, you can use the following function: * Specify the user's public address and the index of the user asset. * Provide the chainId ```javascript const stream = require('streamnft-evm-test'); stream.getRentedNFTs(wallet.address, chainId) .then((result) => { // Handle the result }) .catch((error) => { // Handle the error }); ``` Example Response:
{ success: true, data:
[
{
"rentee": "0x000000000000000000000000000000000020e8fe",
"rent_expiry": "1710344564",
"initializer": "0x00000000000000000000000000000000003621e2",
"state": "RENT",
"token_address": "0x000000000000000000000000000000000030b248",
"token_id": "46"
},
{
"rentee": "0x000000000000000000000000000000000020e8fe",
"rent_expiry": "1709029643",
"initializer": "0x000000000000000000000000000000000020e8fe",
"state": "RENT",
"token_address": "0x000000000000000000000000000000000020e948",
"token_id": "6"
}
]
}
**3. Initialize Rent for a Specific Asset:** To initiate a rent for a specific asset, you can use the following function: * Provide the token address of the asset, the token ID, and other required parameters such as the rate per minute, validity duration, fixed/variable rent, owner share, and whitelist. * Specify the chainId and signer information. ```javascript const stream = require('streamnft-evm-test'); const tokenAddress = "TOKEN_ADDRESS"; const tokenId = "TOKEN_ID"; const ratePerMinute = 10; const validityMinutes = 60; const isFixed = false; const fixedMinutes = 0; const doMint=false; // receipt type: smart registry, true=> mint wrapped token const ownerShare = 80; // in percentage const whitelist = []; // Array of whitelisted addresses stream.lendToken( tokenAddress, tokenId, ratePerMinute, validityMinutes, isFixed, fixedMinutes, doMint, ownerShare, whitelist, chainId, signer ) .then((result) => { // Handle the result }) .catch((error) => { // Handle the error }); ``` **Example Response:** ```json { success: true, data:
const stream = require('streamnft-evm-test');
const tokenAddress = "TOKEN_ADDRESS";
const tokenId = "TOKEN_ID";
stream.getAssetManager(tokenAddress, tokenId, chainId)
.then((result) => {
// Handle the result (asset manager details)
})
.catch((error) => {
// Handle the error
});
const stream = require('streamnft-evm-test');
const tokenAddress = "TOKEN_ADDRESS";
const tokenId = "TOKEN_ID";
stream.cancelRent(tokenAddress, tokenId, chainId, signer)
.then((result) => {
// Handle the result
})
.catch((error) => {
// Handle the error
});
**Example Response:** ```json { success: true, data: [ { "id": 240, "initializer": "0x000000000000000000000000000000000009be43", "loan_pool_index": "4", "loan_offer_index": "9", "state": "PRE_LOAN", "loan_expiry": "1708598493", "provider": "0x000000000000000000000000000000000009be43", "rate": null, "validity_expiry": null, "is_fixed": null, "fixed_minutes": null, "rent_expiry": null, "rentee": null, "private_rental": null, "owner_share": null, "whitelist": null, "chain_id": "296", "contract_address": "0xeB90f41DeAAe8D3Af051196E280ECfD2fedC293e", "token_address": "0x000000000000000000000000000000000020e948", "token_id": "1", "metadata_uri": "QmfDDKu2VhN9GMiYDdoQVZx7wkAp9gRdvJkxBMeJgHehpS", "metadata_link": "https://hashpack.b-cdn.net/ipfs/QmfDDKu2VhN9GMiYDdoQVZx7wkAp9gRdvJkxBMeJgHehpS", "name": "SIWAS by Kabila", "image": "https://hashpack.b-cdn.net/ipfs/QmXJqZH6NMaJh9LfLTn2SPkPVnf4LBs2RaHfrUqBnpnSrc", "profit": null, "rental_type": null, "domint": null, "loan_expiry_utc": null, "rent_expiry_utc": null, "validity_expiry_utc": null, "loan_amount": "1200000000", "tx_hash": null, "version": null, "ERC1155_index": null, "index": null }, { "id": 267, "initializer": "0x000000000000000000000000000000000009be43", "loan_pool_index": "1", "loan_offer_index": "1", "state": "LOAN", "loan_expiry": "1709828808", "provider": "0x000000000000000000000000000000000020e8fe", "rate": "0", "validity_expiry": null, "is_fixed": false, "fixed_minutes": "0", "rent_expiry": "0", "rentee": "0x0000000000000000000000000000000000000000", "private_rental": null, "owner_share": "0", "whitelist": "", "chain_id": "296", "contract_address": "0xeB90f41DeAAe8D3Af051196E280ECfD2fedC293e", "token_address": "0x000000000000000000000000000000000020e948", "token_id": "51", "metadata_uri": "QmfDDKu2VhN9GMiYDdoQVZx7wkAp9gRdvJkxBMeJgHehpS", "metadata_link": "https://hashpack.b-cdn.net/ipfs/QmfDDKu2VhN9GMiYDdoQVZx7wkAp9gRdvJkxBMeJgHehpS", "name": "SIWAS by Kabila", "image": "https://hashpack.b-cdn.net/ipfs/QmXJqZH6NMaJh9LfLTn2SPkPVnf4LBs2RaHfrUqBnpnSrc", "profit": "0", "rental_type": null, "domint": null, "loan_expiry_utc": null, "rent_expiry_utc": null, "validity_expiry_utc": null, "loan_amount": "10000000000", "tx_hash": null, "version": null, "ERC1155_index": null, "index": null } ]} ``` ```json { success: false, data:
| Network | Chain ID |
|---|---|
| Skale Nebula | 1482601649 |
| Hedera | 295 |
