ocean.js/test/unit/Nft.test.ts

import { assert } from 'chai'
import { deployContracts, Addresses } from '../TestContractHandler'
import sha256 from 'crypto-js/sha256'
import { web3 } from '../config'
import { NftFactory, NftCreateData, Nft, ZERO_ADDRESS } from '../../src'
import { MetadataAndTokenURI } from '../../src/@types'

describe('NFT', () => {
  let nftOwner: string
  let user1: string
  let user2: string
  let user3: string
  let contracts: Addresses
  let nftDatatoken: Nft
  let nftFactory: NftFactory
  let nftAddress: string

  const nftData: NftCreateData = {
    name: 'NFTName',
    symbol: 'NFTSymbol',
    templateIndex: 1,
    tokenURI: 'https://oceanprotocol.com/nft/',
    transferable: true,
    owner: null
  }

  before(async () => {
    const accounts = await web3.eth.getAccounts()
    nftOwner = accounts[0]
    user1 = accounts[1]
    user2 = accounts[2]
    user3 = accounts[3]

    nftData.owner = nftOwner
  })

  it('should deploy contracts', async () => {
    contracts = await deployContracts(web3, nftOwner)
  })

  it('should initialize NFTFactory instance and create a new NFT', async () => {
    nftFactory = new NftFactory(contracts.nftFactoryAddress, web3, 8996)

    nftAddress = await nftFactory.createNFT(nftOwner, nftData)
    nftDatatoken = new Nft(web3, 8996)
  })

  it('#getTokenURI', async () => {
    const tokenURI = await nftDatatoken.getTokenURI(nftAddress, 1)
    assert(tokenURI === nftData.tokenURI)
  })

  it('#createDatatoken - should create a new ERC20 Datatoken from NFT contract', async () => {
    const dtAddress = await nftDatatoken.createDatatoken(
      nftAddress,
      nftOwner,
      nftOwner,
      user1,
      user2,
      ZERO_ADDRESS,
      '0',
      '10000',
      nftData.name,
      nftData.symbol,
      1
    )
    assert(dtAddress !== null)
  })

  it('#createDatatoken - should fail to create a new ERC20 Datatoken if not DatatokenDeployer', async () => {
    try {
      await nftDatatoken.createDatatoken(
        nftAddress,
        user1,
        nftOwner,
        user1,
        user2,
        ZERO_ADDRESS,
        '0',
        '10000',
        nftData.name,
        nftData.symbol,
        1
      )
      assert(false)
    } catch (e) {
      assert(e.message === 'Caller is not DatatokenDeployer')
    }
  })

  // Manager
  it('#addManager - should add a new Manager', async () => {
    assert((await nftDatatoken.getNftPermissions(nftAddress, user1)).manager === false)

    await nftDatatoken.addManager(nftAddress, nftOwner, user1)

    assert((await nftDatatoken.getNftPermissions(nftAddress, user1)).manager === true)
  })

  it('#addManager - should fail to add a new Manager, if NOT NFT Owner', async () => {
    try {
      await nftDatatoken.addManager(nftAddress, user1, user1)
      assert(false)
    } catch (e) {
      assert(e.message === 'Caller is not NFT Owner')
    }
  })

  it('#removeManager - should remove a Manager', async () => {
    assert((await nftDatatoken.getNftPermissions(nftAddress, user1)).manager === true)

    await nftDatatoken.removeManager(nftAddress, nftOwner, user1)

    assert((await nftDatatoken.getNftPermissions(nftAddress, user1)).manager === false)
  })

  it('#removeManager - should fail to remove a new Manager, if NOT NFT Owner', async () => {
    try {
      await nftDatatoken.removeManager(nftAddress, user1, nftOwner)
      assert(false)
    } catch (e) {
      assert(e.message === 'Caller is not NFT Owner')
    }
  })

  // DatatokenDeployer
  it('#addDatatokenDeployer -should add DatatokenDeployer if Manager', async () => {
    assert((await nftDatatoken.isDatatokenDeployer(nftAddress, user1)) === false)

    await nftDatatoken.addDatatokenDeployer(nftAddress, nftOwner, user1)

    assert((await nftDatatoken.isDatatokenDeployer(nftAddress, user1)) === true)
  })

  it('#addDatatokenDeployer - should fail to add DatatokenDeployer if NOT Manager', async () => {
    try {
      await nftDatatoken.addDatatokenDeployer(nftAddress, user1, user1)
      assert(false)
    } catch (e) {
      assert(e.message === 'Caller is not Manager')
    }
  })

  it('#removeDatatokenDeployer - remove DatatokenDeployer if Manager', async () => {
    assert((await nftDatatoken.isDatatokenDeployer(nftAddress, user1)) === true)

    await nftDatatoken.removeDatatokenDeployer(nftAddress, nftOwner, user1)

    assert((await nftDatatoken.isDatatokenDeployer(nftAddress, user1)) === false)
  })

  it('#removeDatatokenDeployer - should fail and remove DatatokenDeployer if NOT Manager nor himself an DatatokenDeployer', async () => {
    await nftDatatoken.addDatatokenDeployer(nftAddress, nftOwner, user1)
    assert((await nftDatatoken.isDatatokenDeployer(nftAddress, user1)) === true)
    try {
      await nftDatatoken.removeDatatokenDeployer(nftAddress, user1, user1)
      assert(false)
    } catch (e) {
      assert(e.message === 'Caller is not Manager nor DatatokenDeployer')
    }
    assert((await nftDatatoken.isDatatokenDeployer(nftAddress, user1)) === true)
  })

  it('#removeDatatokenDeployer - should fail to remove himself as an DatatokenDeployer', async () => {
    assert((await nftDatatoken.isDatatokenDeployer(nftAddress, user1)) === true)
    try {
      await nftDatatoken.removeDatatokenDeployer(nftAddress, user1, user1)
      assert(false)
    } catch (e) {
      assert(e.message === 'Caller is not Manager nor DatatokenDeployer')
    }
    assert((await nftDatatoken.isDatatokenDeployer(nftAddress, user1)) === true)
  })

  //  MetadataUpdate
  it('#addMetadataUpdate - should add to remove Metadata Updater if Manager', async () => {
    assert(
      (await nftDatatoken.getNftPermissions(nftAddress, user1)).updateMetadata === false
    )

    await nftDatatoken.addMetadataUpdater(nftAddress, nftOwner, user1)

    assert(
      (await nftDatatoken.getNftPermissions(nftAddress, user1)).updateMetadata === true
    )
  })

  it('#addMetadataUpdate - should fail to add Metadata Updater if NOT Manager', async () => {
    try {
      await nftDatatoken.addMetadataUpdater(nftAddress, user1, user1)
      assert(false)
    } catch (e) {
      assert(e.message === 'Caller is not Manager')
    }
  })

  it('#removeMetadataUpdate - remove Metadata Updater if Manager', async () => {
    assert(
      (await nftDatatoken.getNftPermissions(nftAddress, user1)).updateMetadata === true
    )

    await nftDatatoken.removeMetadataUpdater(nftAddress, nftOwner, user1)

    assert(
      (await nftDatatoken.getNftPermissions(nftAddress, user1)).updateMetadata === false
    )
  })

  it('#removeMetadataUpdate - should fail to remove Metadata Updater if NOT Manager', async () => {
    try {
      await nftDatatoken.removeMetadataUpdater(nftAddress, user1, user1)
      assert(false)
    } catch (e) {
      assert(e.message === 'Caller is not Manager nor Metadata Updater')
    }
  })

  // StoreUpdater
  it('#addStoreUpdater - should add to remove Store Updater if Manager', async () => {
    assert((await nftDatatoken.getNftPermissions(nftAddress, user1)).store === false)

    await nftDatatoken.addStoreUpdater(nftAddress, nftOwner, user1)

    assert((await nftDatatoken.getNftPermissions(nftAddress, user1)).store === true)
  })

  it('#addStoreUpdater - should fail to add Store Updater if NOT Manager', async () => {
    try {
      await nftDatatoken.addStoreUpdater(nftAddress, user1, user1)
      assert(false)
    } catch (e) {
      assert(e.message === 'Caller is not Manager')
    }
  })

  it('#removeStoreUpdater - remove Metadata Updater if Manager', async () => {
    assert((await nftDatatoken.getNftPermissions(nftAddress, user1)).store === true)

    await nftDatatoken.removeStoreUpdater(nftAddress, nftOwner, user1)

    assert((await nftDatatoken.getNftPermissions(nftAddress, user1)).store === false)
  })

  it('#removeStoreUpdater - should fail to remove Metadata Updater if NOT Manager', async () => {
    try {
      await nftDatatoken.removeStoreUpdater(nftAddress, user1, user1)
      assert(false)
    } catch (e) {
      assert(e.message === `Caller is not Manager nor storeUpdater`)
    }
  })

  // Transfer test
  it('#transferNFT - should fail to transfer the NFT and clean all permissions, if NOT NFT Owner', async () => {
    assert((await nftDatatoken.getNftOwner(nftAddress)) !== user1)

    try {
      await nftDatatoken.transferNft(nftAddress, user1, user1, 1)
      assert(false)
    } catch (e) {
      assert(e.message === 'Caller is not NFT Owner')
    }
  })

  it('#transferNFT - should transfer the NFT and clean all permissions, set new owner as manager', async () => {
    await nftDatatoken.addManager(nftAddress, nftOwner, user2)
    await nftDatatoken.addDatatokenDeployer(nftAddress, user2, user1)
    assert((await nftDatatoken.isDatatokenDeployer(nftAddress, user1)) === true)

    assert((await nftDatatoken.getNftOwner(nftAddress)) === nftOwner)
    await nftDatatoken.transferNft(nftAddress, nftOwner, user1, 1)
    assert((await nftDatatoken.getNftOwner(nftAddress)) === user1)

    assert((await nftDatatoken.isDatatokenDeployer(nftAddress, nftOwner)) === false)
    assert((await nftDatatoken.isDatatokenDeployer(nftAddress, user2)) === false)
  })

  // Safe transfer test
  it('#safeTransferNft - should fail to transfer the NFT and clean all permissions, if NOT NFT Owner', async () => {
    // return the nft to nftOwner to repeat transfer tests
    await nftDatatoken.transferNft(nftAddress, user1, nftOwner, 1)

    assert((await nftDatatoken.getNftOwner(nftAddress)) !== user1)

    try {
      await nftDatatoken.safeTransferNft(nftAddress, user1, user1, 1)
      assert(false)
    } catch (e) {
      assert(e.message === 'Caller is not NFT Owner')
    }
  })

  it('#safeTransferNft - should transfer the NFT and clean all permissions, set new owner as manager', async () => {
    await nftDatatoken.addManager(nftAddress, nftOwner, user2)
    await nftDatatoken.addDatatokenDeployer(nftAddress, user2, user1)
    assert((await nftDatatoken.isDatatokenDeployer(nftAddress, user1)) === true)

    assert((await nftDatatoken.getNftOwner(nftAddress)) === nftOwner)
    await nftDatatoken.safeTransferNft(nftAddress, nftOwner, user1, 1)
    assert((await nftDatatoken.getNftOwner(nftAddress)) === user1)
  })

  // Clear permisions
  it('#cleanPermissions - should fail to cleanPermissions if NOT NFTOwner', async () => {
    try {
      await nftDatatoken.cleanPermissions(nftAddress, user2)
      assert(false)
    } catch (e) {
      assert(e.message === 'Caller is not NFT Owner')
    }
  })

  it('#cleanPermissions - should cleanPermissions if NFTOwner', async () => {
    await nftDatatoken.addManager(nftAddress, user1, user1)
    await nftDatatoken.addDatatokenDeployer(nftAddress, user1, user2)
    assert((await nftDatatoken.isDatatokenDeployer(nftAddress, user2)) === true)

    await nftDatatoken.cleanPermissions(nftAddress, user1)

    assert((await nftDatatoken.isDatatokenDeployer(nftAddress, user2)) === false)
    assert((await nftDatatoken.getNftPermissions(nftAddress, nftOwner)).manager === false)
  })

  it('#setMetaData - should succeed to update metadata if metadataUpdater', async () => {
    await nftDatatoken.addManager(nftAddress, user1, user1)
    await nftDatatoken.addMetadataUpdater(nftAddress, user1, user1)
    assert(
      (await nftDatatoken.getNftPermissions(nftAddress, user1)).updateMetadata === true
    )
    await nftDatatoken.setMetadata(
      nftAddress,
      user1,
      1,
      'http://myprovider:8030',
      '0x123',
      web3.utils.asciiToHex(user2),
      web3.utils.asciiToHex(user2),
      '0x' + sha256(web3.utils.asciiToHex(user2)).toString()
    )

    const metadata = await nftDatatoken.getMetadata(nftAddress)
    assert(metadata[0] === 'http://myprovider:8030')
    assert(metadata[1] === '0x123')
  })

  it('#setMetaData - should fail to update metadata if NOT metadataUpdater', async () => {
    assert(
      (await nftDatatoken.getNftPermissions(nftAddress, user3)).updateMetadata === false
    )
    try {
      await nftDatatoken.setMetadata(
        nftAddress,
        user3,
        1,
        'http://myprovider:8030',
        '0x123',
        web3.utils.asciiToHex(user2),
        web3.utils.asciiToHex(user2),
        '0x' + sha256(web3.utils.asciiToHex(user2)).toString()
      )
      assert(false)
    } catch (e) {
      assert(e.message === 'Caller is not Metadata updater')
    }
    assert(
      (await nftDatatoken.getNftPermissions(nftAddress, user3)).updateMetadata === false
    )
  })

  it('#setMetaDataState - should succeed to update MetadataState if metadataUpdater', async () => {
    await nftDatatoken.addManager(nftAddress, user1, user1)
    await nftDatatoken.addMetadataUpdater(nftAddress, user1, user1)
    let metadata = await nftDatatoken.getMetadata(nftAddress)

    assert(metadata[2] === '1')
    assert(
      (await nftDatatoken.getNftPermissions(nftAddress, user1)).updateMetadata === true
    )

    await nftDatatoken.setMetadataState(nftAddress, user1, 2)

    metadata = await nftDatatoken.getMetadata(nftAddress)
    assert(metadata[2] === '2')
  })

  it('#setMetaDataState - should fail to update MetadataState if NOT metadataUpdater', async () => {
    let metadata = await nftDatatoken.getMetadata(nftAddress)
    assert(metadata[2] === '2')
    assert(
      (await nftDatatoken.getNftPermissions(nftAddress, user3)).updateMetadata === false
    )
    try {
      await nftDatatoken.setMetadataState(nftAddress, user3, 1)
      assert(false)
    } catch (e) {
      assert(e.message === 'Caller is not Metadata updater')
    }
    metadata = await nftDatatoken.getMetadata(nftAddress)
    assert(metadata[2] === '2')
  })

  it('#setTokenURI - should update TokenURI', async () => {
    const tx = await nftDatatoken.setTokenURI(nftAddress, user1, 'test')
    assert(tx.events.TokenURIUpdate)
  })

  it('#setMetaDataAndTokenURI - should update tokenURI and set metadata', async () => {
    const data = web3.utils.asciiToHex(user2)
    const metadataAndTokenURI: MetadataAndTokenURI = {
      metaDataState: 1,
      metaDataDecryptorUrl: 'http://myprovider:8030',
      metaDataDecryptorAddress: '0x123',
      flags: web3.utils.asciiToHex(user1),
      data: web3.utils.asciiToHex(user1),
      metaDataHash: '0x' + sha256(data).toString(),
      tokenId: 1,
      tokenURI: 'https://anothernewurl.com/nft/',
      metadataProofs: []
    }
    assert(
      (await nftDatatoken.getNftPermissions(nftAddress, user1)).updateMetadata === true
    )

    const tx = await nftDatatoken.setMetadataAndTokenURI(
      nftAddress,
      user1,
      metadataAndTokenURI
    )
    assert(tx.events.TokenURIUpdate)
    assert(tx.events.MetadataUpdated)

    const metadata = await nftDatatoken.getMetadata(nftAddress)
    assert(metadata[0] === metadataAndTokenURI.metaDataDecryptorUrl)
    assert(metadata[1] === metadataAndTokenURI.metaDataDecryptorAddress)
  })

  it('#setData - should FAIL to set a value into 725Y standard, if Caller has NOT store updater permission', async () => {
    const key = 'KEY'
    const data = 'NewData'
    assert((await nftDatatoken.getNftPermissions(nftAddress, user1)).store === false)

    try {
      await nftDatatoken.setData(nftAddress, user1, key, data)
      assert(false)
    } catch (e) {
      assert(e.message === 'User is not ERC20 store updater')
    }
    assert((await nftDatatoken.getData(nftAddress, key)) === null)
  })

  it('#setData - should set a value into 725Y standard, if Caller has store updater permission', async () => {
    const key = 'KEY'
    const data = 'NewData'

    // add store updater permission
    await nftDatatoken.addStoreUpdater(nftAddress, user1, user1)
    assert((await nftDatatoken.getNftPermissions(nftAddress, user1)).store === true)

    await nftDatatoken.setData(nftAddress, user1, key, data)

    assert((await nftDatatoken.getData(nftAddress, key)) === data)
  })
})