An IP Royalty Vault is where all monetary inflows related to an IP Asset are stored. This revenue is then claimed with Royalty Tokens.
IP Royalty Vault

IPRoyaltyVault.sol

View the smart contract for the IP Royalty Vault.

​
Royalty Tokens

When an IP Asset receives revenue, it is deposited into its IP Royalty Vault. In order to claim revenue from this vault, you must have the associated Royalty Tokens. Every vault has 100 Royalty Tokens associated with it. If an address owns these tokens, it is entitled to that % (% of the total supply of Royalty Tokens owned) of any future revenue in the IP Royalty Vault. The IP Royalty Vault contract is also the ERC-20 contract for the Royalty Tokens of each IP Asset. This means the address of the IP Royalty Vault for an IP Asset is also the ERC-20 token address of the Royalty Tokens.

​
Whitelisted Payment Tokens

An ERC-20 token must be whitelisted by our protocol in the RoyaltyModule.sol contract to be used for making payments. Here are the whitelisted tokens:
TokenContract AddressExplorerMint
WIP0x1514000000000000000000000000000000000000View here ↗️N/A
MERC200xF2104833d386a2734a4eB3B8ad6FC6812F29E38EView here ↗️Mint ↗️

​
How to obtain Royalty Tokens?

There are two ways that trigger the IP Royalty Vault deployment and make the initial Royalty Token distribution - whichever comes first:
  1. A License Token is minted from an IP for the first time.
  2. A derivative is registered under the IP.
In each case, the associated IP Account, which is the IP itself, receives 100% of the Royalty Tokens. Because Royalty Tokens are ERC-20, they can be transferred like any other token. Thus, the IP Account could send them to someone else, or even put them up for sale on the secondary market. Once they are transferred, the new owner now has the right to claim x% of the revenue from the royalty vault.

​
Examples

Let’s look at some examples of royalty flow from the IP Royalty Vault to Royalty Token holders.

​
Default Case

By default, when the royalty vault is deployed, the IP Account (which is the IP itself) receives 100% of the Royalty Tokens. Let’s look at an example where the IP Account is the full owner of the Royalty Tokens, and a payment is received into the IP Royalty Vault.
Royalty Tokens Default
As you can see, each IP claims the full amount from its royalty vault because it has 100% of the royalty tokens.

​
Multiple Royalty Token Destinations

Now let’s look at a case where the IP Asset 2 has distributed 5% of its Royalty Tokens to another address. Maybe this is because they sold them on the secondary market, or maybe it’s because they gave them to a friend.
Multiple Royalty Token Destinations
As you can see, IP Asset 1 claims its full 10 $WIP. But IP Asset 2 only claims 9.5 $WIP. The other 0.5 $WIP is claimed by the address that owns the 5% of the Royalty Tokens.

​
Distributing Royalty Tokens

One of the most common questions is: “Why does royalty end up in the IP Account? Shouldn’t it end up in the IP owner’s wallet?” While the IP Account is the initial owner of 100% of the Royalty Tokens, remember that as the IP owner, you can transfer them to whoever. An easy solution is to transfer 100% of the Royalty Tokens to the IP owner’s wallet, so that when revenue is received to the IP Royalty Vault, revenue can be claimed directly to the wallet.

Working Code Example

View a working code example of transferring Royalty Tokens to an external wallet (like the IP owner’s wallet). Remember, Royalty Tokens are simple ERC-20s!
Royalty Tokens Transferred