What is HyperVIBES?

HyperVIBES is a public and multi-tenanted provenance mining protocol created by Rarible DAO.

What is provenance mining?

Provenance mining is a mechanism that allows an NFT to mine tokens over time that the owner of the NFT can claim. Unclaimed tokens stay within the NFT across sales or transfers.

How does HyperVIBES relate to Rarible?

It does not directly relate to the Rarible exchange protocol or rarible.com.

What is a realm?

A HyperVIBES realm is an isolated environment with a specific ERC-20 token and various configuration options. Anybody is free to create a realm for their own experiments, protocols, and projects.

How do I create a realm?

You can follow our getting started guide to launch your first realm on a testnet:

How do I integrate HyperVIBES into my protocol?

More direct integrations can be built by directly invoking the HyperVIBES smart contract from your protocol.

What is infusion?

Infusion is the act of taking tokens from your wallet and staking them inside of an NFT. Infused tokens are mined over time by the NFT, and are claimable by the owner of the NFT. Unclaimed tokens stay within the NFT across sales or transfers.

Infused tokens cannot be removed from the NFT except via the mining process.

How can I infuse an NFT?

What does it mean to claim infused tokens?

Claiming tokens is possible after an infused NFT has mined them over time. The owner of the NFT can claim tokens at any time, depending on realm configuration. Unclaimed tokens stay within the NFT across sales or transfers.

How do I claim infused tokens?

What NFTs can I infuse via HyperVIBES?

Any ERC-721 NFTs can be infused via the protocol, depending on realm configuration. ERC-1155s cannot be infused.

HyperVIBES is not a minting platform. It was designed to allow infusing tokens into NFTs minted on any platform.

What tokens can I infuse via HyperVIBES?

Any ERC-20 tokens can be used with HyperVIBES.

Each realm is configured with a single token.

What does it cost to use HyperVIBES?

HyperVIBES will always be 100% free to use, with zero fees, forever.

Is there a protocol or governance token?

No, there is no upgradeable functionality or fee extraction. There is nothing to govern on the protocol itself.

Peripheral communities may choose to launch a DAO / token.

What can I build with HyperVIBES?

Anything you want. The only limit is your imagination.

Can an NFT be infused with multiple tokens?

Yes, a single NFT could be infused across an infinite number of realms and mining several tokens simultaneously.

Depending on how a realm is configured, an NFT may be infused multiple times (from multiple agents) in the same realm.

Do you have to own the NFT to infuse it?

This depends on the realm configuration.

How can I contribute?

Infused tokens can be mined and claimed by the NFT owner over time.

Create a fully isolated and independently configured HyperVIBES realm to run your own experiments or protocols without having to deploy a smart contract.

HyperVIBES is:

• 🎁 Open Source

• 🥳 Massively Multiplayer

• 🌈 Public Infrastructure

• 🚀 Unstoppable and Censor-Proof

• 🌎 Multi-chain

• 💖 Free Forever

Feel free to use HyperVIBES in any way you want.

Getting Started

Want to jump into the deep end? Follow our Getting Started guide to practice launching a custom token, NFT contract, and HyperVIBES realm on the Goerli testnet:

Integrating

You can use HyperVIBES without having to write any code, but direct smart contract integrations can rapidly add infusion capabilities to your protocol or NFT project.

Contributing

HyperVIBES is an immutable and non-upgradeable protocol with no admin functionality, it will exist in its current state as long as the blockchain exists.

Welcome to HyperVIBES.

This step-by-step guide will walk you through using the HyperVIBES protocol on the Goerli Test Network:

• 🌈 Infuse your NFTs

Overview

HyperVIBES is a public and trustless protocol for infusing tokens inside of any NFT.

Infused tokens can be mined and claimed by the NFT owner over time.

Today, you're going to launch your own personal ERC-20 token and NFT contract using community-authored tools that are 100% free. Then, you're going to use the HyperVIBES protocol to create your own realm and infuse your NFTs with your token.

Steps

Claiming is the act of withdrawing mined tokens from an infused NFT to the NFT owner's wallet.

Only mined tokens can be claimed, while un-mined tokens stay staked within the NFT. Unclaimed tokens stay within the NFT across sales or transfers.

Claim

Select the CLAIM option from the top navigation menu of the HyperVIBES app, or select the far-right CLAIM card from the main landing page

Once there, you'll see a list of all realms:

Select a realm to browse the infused NFTs within that realm:

The Claim Tokens screen allows you to input any amount of tokens, up to the total currently mined within the NFT. Input the amount (or press MAX), and press the CLAIM button to claim your tokens.

Once the transaction submits, you'll have the tokens in your wallet:

If you haven't already, install MetaMask, an in-browser extension that allows you to connect to blockchain based decentralized applications, or "dApps":

MetaMask will allow you to interact with Ethereum-based networks and testnets, as well as networks like Polygon and Arbitrum.

Make sure you have selected the Goerli Test Network (or whatever testnet you prefer) from the network dropdown menu at the top of the MetaMask window.

HyperVIBES is a public and trustless protocol for infusing tokens inside of any NFT.

Anyone can create a realm, which is a fully configurable and isolated environment within the protocol. Depending on realm configuration, infused tokens may be claimed by the owner of the NFT over time.

Want to jump in head-first and start experimenting? Check out our complete walkthrough:

Or if you'd rather understand HyperVIBES via some concrete use cases:

Provenance Mining

The core mechanism at the heart of HyperVIBES is Provenance Mining.

ERC-20 tokens can be infused inside of any ERC-721 NFT. Infused tokens are mined over time based on realm configuration, and only the owner of the NFT can claim the currently mined tokens to their wallet.

If the NFT is sold or transferred to another owner, unclaimed tokens stay within the NFT.

Multi-Tenancy

This means that anybody can permissionlessly create a new realm, with any token they want, configured however they like... without having to fork or deploy a smart contract.

Realms are completely isolated and independent from one another. It's possible for a single NFT to have infused tokens from several different realms.

Permissionless

There is no gatekeeping or privileged authority within the HyperVIBES protocol.

• Anybody is free to create a realm without permission

• Anybody can infuse any NFT with any token without permission

While the protocol itself is not permissioned in any way, individual realms can be configured to limit what agents can infuse or what collections are allowed to be infused, along with several other realm constraints.

Trustless Infrastructure

There is no administrative functionality nor roles retained by Rarible DAO or any other agent, and the smart contract is non-upgradeable. This ensures that functionality will remain the same for as long as the blockchain exists.

All configured realms are fully sovereign and only modifiable by the admins specified during realm creation.

Extension and Composition

HyperVIBES was designed to be integrated with other protocols and composed within larger on-chain products.

A proxy approval system allows external agents to infuse-on-behalf of another address, ensuring that infusions can never be spoofed without explicit authorization while still allowing interesting extensions to the protocol beyond the supported constraints.

HyperVIBES is designed to be a flexible and low-level building block for the community to experiment with. A variety of applications are possible without having to even deploy a smart contract.

We're excited to see the use cases the community comes up with!

Curation Network

Curation protocols can create uniquely-configured token-based curation mechanisms.

Realm constraints allow for a wide amount of design-space, such as allowing fully open curation or more restrictive approaches. By tokenizing curatorial power, and allowing collectors to mine this token over time, a circular economy is created that incentivizes holding art and rewards collectors with the power to influence the curated direction of the network.

Token Distribution

Artists or tokenized individuals can turn any NFTs into portals that stream their social token to collectors and supporters.

Depending on realm configuration, this can be done after the NFTs have been distributed as a way of "turning on" the mechanism after the original NFT distribution.

If public infusion is allowed, the social token can be re-infused in new NFTs after being mined by the community, creating a decentralized and community-run network of token-streaming portals.

Gaming and Collectibles

Gaming platforms can infuse in-game resources inside of game NFTs that can be mined over time by players, or infuse art / community-created NFTs with an in-game currency as a promotional event.

Collectible projects can infuse a community governance token during the initial mint and sale via a direct smart contract integration to immediately start streaming tokens the moment an NFT is minted.

A syndicate of related or friendly 10K projects could all use the same token infused within their NFTs as a way of creating a larger meta-network and community.

Credentialing and Certification

Realm parameters can be locked down to only allow infusion from specific or trusted agents, creating a system of on-chain signaling and certification.

Artists or other prominent community members can "autograph" other people's NFTs with their social token. If the artist allows mining this token, the collector of the autographed NFT could re-sell the social token while still keeping the original NFT.

Minting Platforms

HyperVIBES is not a minting platform and requires not specific ERC-721 contract to be used, but existing minting platforms could implement infuse-on-mint functionality into their platforms.

Streamlined realm configuration and social token distribution would allow for community members who don't have development experience to create interesting personal protocols and experiments.

A minting platform could also distribute their own protocol token via HyperVIBES as a way of decentralizing network equity to end-users.

UI integrations could show infused tokens across all (or a specific subset) of realms.

Social Gamification

Distribute a ranking or signaling token to your community and allow them to infuse any NFTs based on some criteria or game.

Display "most infused" or "top token balance" NFTs in leaderboards and high score UIs.

Multiple realms and tokens could be used for multi-dimensional signaling for interesting crowdsourced mechanisms and games.

Allow users to infuse "upvote" tokens in content or media NFTs.

Governance

Users can "bring their own NFTs" for NFT-based governance participation by infusing a governance token into an NFT they already own.

Social and reputation scoring can be implemented via a reputation token that is infused into membership NFTs. As that member stays within the group, the mined tokens can be re-infused into others' NFTs to continue to distribute reputation to more people.

A testnet "faucet" is a simple app that will send you tokens and NFTs on various test blockchains.

You can skip this step if you already have tokens and have used the Goerli testnet before:

In order to prevent abuse, you must log in with Twitter. After logging in, provide your wallet address from your MetaMask in the input to deliver test funds to your account.

Explore

Select the EXPLORE option from the top navigation menu of the HyperVIBES app, or select bottom EXPLORE button on the app home screen:

Once there, you'll see a list of all realms:

Selecting a realm will take you to a page where all of the NFTs infused within a realm are visible:

Selecting an NFT will take you to the NFT detail page

Deploy your own ERC-721 via wemint.art.

If you already have minted NFTs or have your own contract, then you can skip this step.

Controlling your own contract is a powerful way of establishing provenance around the pieces you mint.

Deploy

Make sure to CONNECT your wallet to the wemint.art app via the button in the top right, and ensure you are still on the Goerli Test Network. Provide some basic info to deploy your ERC-721 contract:

Once the contract is deployed:

Mint

Select HOW TO in wemint.art for a basic walkthrough of getting artwork into IPFS. Alternatively, you can use the following example metadata URI:

• ipfs://ipfs/QmPVEKvFEm9CHPzrKBuj7CPiEML9jKRUap7Lbpxu4tC1ce

Once you have your metadata URI, select the MINT tab, provide the contract address and metadata URI:

Press MINT! and your NFT will be minted!

Example successful transaction following the initial mint:

Deploy your own ERC-20 token via CoinMechanic.

If you already have a token you'd like to use, you can skip this step.

This could be a social token, community token, governance token... or anything else you could imagine.

Deploy

Select Build Token from the CoinMechanic site, setup your token however you wish:

Once your token has been deployed, you can easily add it to your MetaMask. The initial supply will have been minted to your wallet:

Previously, you have:

• Created your own ERC-20 token and minted some initial supply of tokens to your wallet

• Created your own ERC-721 NFT contract and minted a single NFT to your wallet

Now it's time to setup a HyperVIBES realm:

A HyperVIBES realm is a completely isolated environment that can be setup with any ERC-20 token. Each project can set up their own realm, configured to meet their needs.

Creating your Realm

Ensure you are still on the Goerli Test Network (or whatever your preferred testnet is), and select the first card:

Create a realm by inputting all the various configuration information. How you configure your realm is up to you:

You can leave admin blank for now, there's no need to modify this realm. After press NEXT, add the NFT contract you deployed earlier as the Allowed Collection:

And set the TOKEN ADDRESS to the ERC-20 we deployed earlier (confirm the token symbol on the right of the input box):

By specifying your address for ALLOWED INFUSERS, and selected the second option above, you will be the only address that can infuse NFTs for this realm.

Provide additional configuration options:

Specify constraints around claiming tokens:

Once you press CREATE REALM, submit the transaction.

All documentation and source code is free to view, fork, or copy.

Source Code

All code is hosted in the r-group-devs GitHub organization:

Documentation

Beyond in-repo documentation and this docs site, Google Docs was used extensively during development:

Contract Addresses

All contracts are verified on their respective blockchain explorer apps.

Mainnet Deployments

• Ethereum - 0x26887a9f95e1794e52ae1b72bfa404c1562eed0e

• Polygon - 0x26887a9f95e1794e52ae1b72bfa404c1562eed0e

• Arbitrum - 0x26887a9f95e1794e52ae1b72bfa404c1562eed0e

• Fantom - 0x26887a9f95e1794e52ae1b72bfa404c1562eed0e

Testnet Deployments

• Ropsten - 0xcd181fB818aaAae8D34D6D5bBe7aD4c44ac8af98

• Rinkeby - 0xafb96b99a0A4eF348115C6BbD99A71d3d4F52Ff1

• Goerli - 0x26887a9F95e1794e52aE1B72Bfa404c1562Eed0E

• Mumbai - 0x57FBF9E899E17E23d46425e33eE191C8FaD27c28

• Arbitrum Rinkeby - 0x26887a9F95e1794e52aE1B72Bfa404c1562Eed0E

Subgraphs

On-chain data from HyperVIBES is indexed via TheGraph:

Mainnet Subgraphs

Testnet Subgraphs

Proxies are an advanced HyperVIBES mechanic that ensures that on-chain customization is possible for more complex integrations with the protocol.

This allows developers to launch a HyperVIBES realm with complete control over the infusion and claiming experience.

Overview

A HyperVIBES proxy is an address that an agent has delegated infusion and claiming functionality to for a specific realm.

Once an agent (the delegator) has delegated to a proxy, the proxy may now:

• Infuse tokens into an NFT on behalf of the delegator. Infused tokens must come from the proxy's address, and the delegator will be recorded as the infuser.

• Claim infused tokens from NFTs owned by the delegator. Claimed tokens are sent to the proxy's address.

Design Rationale

It can be useful to have a smart contract "frontend" to the infusion or claiming steps to add custom functionality for a realm beyond the built-in constraints.

However, we do not want to allow any contract to have the ability to attribute infusion nor claim tokens on behalf of an address without that address giving explicit authorization.

Allowing and Denying Proxies

The allowProxy and denyProxy functions on the HyperVIBES smart contract are used to add and remove proxies on behalf of the message sender.

From IHyperVIBES.sol:

These functions will allow or deny proxy the ability to infuse and claim on behalf of msg.sender.

You can view and query proxy information from the HyperVIBES subgraph.

HyperVIBES can be used entirely from the UI without having to write any code.

Deeper integration and customization is possible for developers and builders who wish to deploy their own smart contracts.

Client-side Integration

If you are wanting to display HyperVIBES data in your own web app such as:

• Infused and claimable token balances for a given NFT in a specific realm

• All NFTs infused within a specific realm

• All realms an NFT has been infused within

• All infused NFTs owned by a specific address

• All addresses that have infused a specific NFT

• All NFTs infused by a specific address

• All token claims executed by a specific address

The deployed subgraphs index all data and events from HyperVIBES, which can be queried client-side via GraphQL HTTP requests:

Smart Contract Integration

Smart contracts can directly integrate the HyperVIBES protocols to implement the following extensions:

• Custom infusion logic or constraints, such infusion-by-vote, reputation-based infusion access, shared infusion token pools, etc

• Infuse-on-mint functionality. Create a custom ERC-721 contract that will automatically create a realm on deployment and infuse all minted tokens in the same transaction they are created.

• Custom claim functionality, such as taking a fee during executed claims, splitting claims to several addresses, sophisticated and dynamic role-based claiming

Proxies

For custom infusion or claim functionality implemented as a smart contract frontend to HyperVIBES, infusion and claim power must be delegated explicitly to another address via the proxy approval step.

This is done to ensure it's impossible to attribute infusion or claim tokens on behalf of another address without their explicit approval.

Permissionless creation of realms allows anybody to build any protocol, experiment, or project on top of HyperVIBES without interfering with anybody else or asking for permission.

Realm Configuration

When a new realm is created, the following information is provided:

• name - Display name for the realm. Does not have to be unique across HyperVIBES.

• description - Description for the realm.

• ERC-20 token - The specific token that can be infused into NFTs for this realm.

• token daily mining rate - How many tokens per day each NFT will mine once infused.

• realm constraints - Configuration of the parameters of the realm. See below.

• admins - Addresses that are allowed to add or remove admins, infusers, claimers, or collections to the realm.

• infusers - Addresses that are allowed to infuse NFTs. Ignored if the allow public infusion constraint is true.

• claimers - Addresses that are allowed to claim mined tokens from an NFT. Ignored if the allow public claiming constraint is true.

• collections - NFT contract addresses that can be infused. Ignore if the allow all collections constraint is true.

Realm Constraints

Realm constraints determine the behavior around infusing, claiming, and token mining. By creating realms with different constraint configurations, a wide range of possible applications can be implemented.

• min infusion amount - An NFT must be infused with at least this amount of the token every time it's infused.

• max token balance - An NFT's infused balance cannot exceed this amount. If an infusion would result in exceeding the max token balance, amount transferred is clamped to the max.

• min claim amount - When claiming mined tokens, at least this much must be claimed at a time.

• require NFT is owned - If true, the infuser must own the NFT at time of infusion.

• allow multi infuse - If true, an NFT can be infused more than once in the same realm.

• allow public infusion - If true, anybody with enough tokens may infuse an NFT. If false, they must be on the infusers list

• allow public claiming - If true, anybody who owns an infused NFT may claim the mined tokens inside that NFT. If false, they must be on the claimers list.

• allow all collections - If true, NFTs from any ERC-721 contract can be infused. If false, the contract address must be on the collections list.

Realm constraints allow for a large range of possible mechanics and behaviors.

All on-chain data and events from HyperVIBES are indexed via TheGraph.

You can build HyperVIBES-based applications without ever having to deploy a smart contract by creating a realm and building a web3 dapp frontend.

A unique subgraph is deployed for each blockchain network HyperVIBES is on.

Examples Queries

Like all GraphQL APIs, you can use introspection to explore the schema, types, and queries available in the subgraph. Below are a few possible ways of using the subgraph:

List all realms

Get infusion info for an NFT across all realms

Get details and infused NFTs for a specific realm

Get details about a specific account (wallet / agent)

Once you've created your realm, you can now infuse the realm's ERC-20 token into your NFTs.

Infusion is the process of staking ERC-20 tokens inside of an NFT that mines tho tokens over time. The owner of the NFT can claim mined tokens, and unclaimed tokens stay inside the NFT across sales or transfers.

Infuse

Select the INFUSE option from the top navigation menu of the HyperVIBES app, or select the middle INFUSE card from the main landing page

Once there, you'll see a list of all realms that you can infuse NFTs in.

Select your realm, and then select your collection:

Then input any amount of tokens you want to infuse, based on how you've configured your realm previously.

These tokens will be transferred from your wallet into the NFT:

If this is your first infusion, you'll have to execute the APPROVE step as part of the standard ERC-20 approval flow:

Once the approval completes, you can infuse your NFT:

Your NFT is now infused!

Project Source Code

Provenance mining is a mechanism that allows an NFT to mine ERC-20 tokens over time that the owner of the NFT can claim. Unclaimed tokens stay within the NFT across sales or transfers.

Infusion

Infusion is the process of staking ERC-20 tokens from your wallet into an NFT via HyperVIBES.

Infused tokens are then mined by the NFT over time at a linear rate as configured in the realm. Mined tokens do not automatically go to the NFT owner's wallet, they must be "claimed" at some point (see below).

• Tokens immediately start mining on the same block they are infused.

• If the require NFT is owned constraint of the realm is true, the infuser must own the NFT being infused.

• If the allow public infusion constraint of the realm is false, the infuser must be on the list of allowed infusers for that realm.

• If the allow all collections constraint of the realm is false, the NFT being infused must be from a collection on the list of allowed collections for that realm.

• If the allow multi infuse constraint of the realm is false, an NFT can only be infused a single time for that realm.

• The amount being infused must be equal to or greater than the min infusion amount constraint set in the realm.

• If the infusion would result in a staked token balance for that NFT that is greater than the max token balance constraint for the realm, infused amount is clamped (limited) to the max token balance amount. If this clamped amount is less than min infusion amount, the infusion will fail.

Claiming

Claiming is the act of withdrawing mined tokens from an infused NFT to the NFT owner's wallet.

Only mined tokens can be claimed, while un-mined tokens stay staked within the NFT. Unclaimed tokens stay within the NFT across sales or transfers.

• The total amount being claimed must be equal to or greater than the min claim amount constraint set in the realm.

• It is possible to claim less than the total claimable amount if desired.

• If the allow public claiming constraint of the realm is false, the claimer must be on the list of allowed claimers for that realm.