buyProtectedData

Method to buy a protected data that is for sale.

"Buying" here means to get ownership of the protected data.

After buying a protected data, you'll be free to distribute it again at your own terms, or to keep it for yourself.

Usage

const { txHash } = await dataProtectorSharing.buyProtectedData({
  protectedData: '0x123abc...',
  price: 1,
});

Parameters

import { type BuyProtectedDataParams } from '@iexec/dataprotector';

protectedData Required *

Type: AddressOrENS

Address of the protected data you'd like to buy.

const { txHash } = await dataProtectorSharing.buyProtectedData({
  protectedData: '0x123abc...',
  price: 1,
});

price Required *

Type: number

Price of the protected data that you expect to buy. This parameter ensures that you will not be front-run by the owner of the protected data. The unit is in nano RLC (nRLC).

const { txHash } = await dataProtectorSharing.buyProtectedData({
  protectedData: '0x123abc...',
  price: 1,
});

addToCollectionId Optional

Type: number

Collection ID to which you'd like to transfer the ownership of the protected data.
The Data Sharing smart contract will still be the technical owner of the protected data, but you'll fully own it as you own the collection to which it'll transferred. If you use this param the addOnlyAppWhitelist is mandatory because you must specify which addOnlyAppWhitelist will be able to consume your protected data.

const { txHash } = await dataProtectorSharing.buyProtectedData({
  protectedData: '0x123abc...',
  price: 1,
  addToCollectionId: 12,
  addOnlyAppWhitelist: '0xdef456...',
});

addOnlyAppWhitelist Optional

Type: AddressOrENS

Address of the whitelist smart contract that contains applications allowed to consume the protected data.

const { txHash } = await dataProtectorSharing.buyProtectedData({
  protectedData: '0x123abc...',
  price: 1,
  addToCollectionId: 12,
  addOnlyAppWhitelist: '0xdef456...',
});

TIP

For this addOnlyAppWhitelist, you are free to use 0x256bcd881c33bdf9df952f2a0148f27d439f2e64 that contains apps created for the purpose of Content Creator usecase-demo. This addOnlyAppWhitelist is managed by iExec.

For more details on how to create and manage appsWhitelist, see Apps whitelist.

Return value

import { type SuccessWithTransactionHash } from '@iexec/dataprotector';

See SuccessWithTransactionHash