@xyo-network/crypto-nft-diviner-score-plugin 5.1.3 → 5.1.5

package/src/lib/rating/criteria/scoring/metadata/spec/externalUrl.spec.ts

@@ -1,44 +0,0 @@
-import '@xylabs/vitest-extended'
-
-import {
-  describe,
-  it,
-} from 'vitest'
-
-import { scoreExternalUrl } from '../externalUrl.ts'
-import {
-  expectLoweredScore, expectMaxPossibleScore, expectMiniumScore,
-} from './testHelpers.ts'
-
-const secure = ['https://lostpoets.xyz/']
-
-const insecure = ['http://lvcidia.xyz/']
-const invalid = ['', 'not a url', {}]
-const missing = [undefined, null]
-
-describe('scoreExternalUrl', () => {
-  describe('with secure url', () => {
-    it.each(secure)('returns max possible score', (value) => {
-      const score = scoreExternalUrl(value)
-      expectMaxPossibleScore(score)
-    })
-  })
-  describe('with valid url', () => {
-    it.each(insecure)('returns lowered score', (value) => {
-      const score = scoreExternalUrl(value)
-      expectLoweredScore(score)
-    })
-  })
-  describe('with invalid url', () => {
-    it.each(invalid)('returns minium score', (value) => {
-      const score = scoreExternalUrl(value)
-      expectMiniumScore(score)
-    })
-  })
-  describe('with no url', () => {
-    it.each(missing)('returns minimum score', (value) => {
-      const score = scoreExternalUrl(value)
-      expectMiniumScore(score)
-    })
-  })
-})

package/src/lib/rating/criteria/scoring/metadata/spec/image.spec.ts

@@ -1,55 +0,0 @@
-import '@xylabs/vitest-extended'
-
-import {
-  describe,
-  it,
-} from 'vitest'
-
-import { scoreImage } from '../image.ts'
-import {
-  expectLoweredScore, expectMaxPossibleScore, expectMiniumScore,
-} from './testHelpers.ts'
-
-const web3Urls = ['ipfs://QmaXTuWjEbDuvcA3dHypqHfxMzDLq78Zj5kBLN4JdMEYDB/3.mp4', 'ipfs://QmTxDYfccVVWoucpbvFECxtysRkMBADDL8j4zVYSRM7Kp3/']
-const secureWeb2Urls = [
-  'https://media.niftygateway.com/video/upload/v1659986036/Julian/KennyScharfWestinghouse/WESTINGHOUSE_20-26X44.5X4.5B_x2mz3r.mp4',
-]
-const insecureWeb2Urls = [
-
-  'http://media.niftygateway.com/video/upload/v1659986036/Julian/KennyScharfWestinghouse/WESTINGHOUSE_20-26X44.5X4.5B_x2mz3r.mp4',
-]
-const invalidUrls = ['', 'not a url', {}]
-const missingUrls = [undefined, null]
-
-describe('scoreImage', () => {
-  describe('with web3 url', () => {
-    it.each(web3Urls)('return max possible score', (value) => {
-      const score = scoreImage(value)
-      expectMaxPossibleScore(score)
-    })
-  })
-  describe('with valid secure url', () => {
-    it.each(secureWeb2Urls)('returns lowered score', (value) => {
-      const score = scoreImage(value)
-      expectLoweredScore(score)
-    })
-  })
-  describe('with valid insecure url', () => {
-    it.each(insecureWeb2Urls)('returns lowered score', (value) => {
-      const score = scoreImage(value)
-      expectLoweredScore(score)
-    })
-  })
-  describe('with invalid url', () => {
-    it.each(invalidUrls)('returns lowered score', (value) => {
-      const score = scoreImage(value)
-      expectMiniumScore(score)
-    })
-  })
-  describe('with no url', () => {
-    it.each(missingUrls)('returns no score', (value) => {
-      const score = scoreImage(value)
-      expectMiniumScore(score)
-    })
-  })
-})

package/src/lib/rating/criteria/scoring/metadata/spec/imageData.spec.ts

@@ -1,37 +0,0 @@
-import '@xylabs/vitest-extended'
-
-import {
-  describe,
-  it,
-} from 'vitest'
-
-import { scoreImageData } from '../imageData.ts'
-import { expectMaxPossibleScore, expectMiniumScore } from './testHelpers.ts'
-
-const valid = [
-  // eslint-disable-next-line @stylistic/max-len
-  "<svg xmlns='http://www.w3.org/2000/svg' version='1.1' width='2000' height='2000'><style>.m1 #c{fill: #fff;}.m1 #r{fill: #000;}.m2 #c{fill: #fc3;}.m2 #r{fill: #000;}.m3 #c{fill: #fff;}.m3 #r{fill: #33f;}.m4 #c{fill: #fff;}.m4 #r{fill: #f33;}.a #c{fill: #000 !important;}.a #r{fill: #fff !important;}</style><g class='m1 c3'><rect id='r' width='2000' height='2000'/><circle id='c' cx='1000' cy='1000' r='146.2449'/></g></svg>",
-]
-const invalid = ['<svg>\n\t\t<path\td=" class="" />\n</svg>', '<svg></svg', '<svg></', '<html></html>', '', 'not an SVG', {}]
-const missing = [undefined, null]
-
-describe('scoreImageData', () => {
-  describe('with valid image data', () => {
-    it.each(valid)('return max possible score', (value) => {
-      const score = scoreImageData(value)
-      expectMaxPossibleScore(score)
-    })
-  })
-  describe('with invalid image data', () => {
-    it.each(invalid)('returns minimum score', (value) => {
-      const score = scoreImageData(value)
-      expectMiniumScore(score)
-    })
-  })
-  describe('with no image data', () => {
-    it.each(missing)('returns minimum score', (value) => {
-      const score = scoreImageData(value)
-      expectMiniumScore(score)
-    })
-  })
-})

package/src/lib/rating/criteria/scoring/metadata/spec/name.spec.ts

@@ -1,28 +0,0 @@
-import '@xylabs/vitest-extended'
-
-import {
-  describe,
-  it,
-} from 'vitest'
-
-import { scoreName } from '../name.ts'
-import { expectMaxPossibleScore, expectMiniumScore } from './testHelpers.ts'
-
-const valid = ['Foo Friends #3042', '🔥 Fire & Such']
-const invalid = [{}]
-const missing = ['', undefined, null]
-
-describe('scoreName', () => {
-  describe('with valid name', () => {
-    it.each(valid)('returns max possible score', (value) => {
-      const score = scoreName(value)
-      expectMaxPossibleScore(score)
-    })
-  })
-  describe('with missing or invalid name', () => {
-    it.each([...missing, ...invalid])('returns minimum score', (value) => {
-      const score = scoreName(value)
-      expectMiniumScore(score)
-    })
-  })
-})

package/src/lib/rating/criteria/scoring/metadata/spec/youtubeUrl.spec.ts

@@ -1,44 +0,0 @@
-import '@xylabs/vitest-extended'
-
-import {
-  describe,
-  it,
-} from 'vitest'
-
-import { scoreYoutubeUrl } from '../youtubeUrl.ts'
-import {
-  expectLoweredScore, expectMaxPossibleScore, expectMiniumScore, expectNoScore,
-} from './testHelpers.ts'
-
-const secure = ['https://lostpoets.xyz/']
-
-const insecure = ['http://lvcidia.xyz/']
-const invalid = ['', 'not a url', {}]
-const missing = [undefined, null]
-
-describe('scoreYoutubeUrl', () => {
-  describe('with secure url', () => {
-    it.each(secure)('returns max possible score', (value) => {
-      const score = scoreYoutubeUrl(value)
-      expectMaxPossibleScore(score)
-    })
-  })
-  describe('with valid url', () => {
-    it.each(insecure)('returns lowered score', (value) => {
-      const score = scoreYoutubeUrl(value)
-      expectLoweredScore(score)
-    })
-  })
-  describe('with invalid url', () => {
-    it.each(invalid)('returns minium score', (value) => {
-      const score = scoreYoutubeUrl(value)
-      expectMiniumScore(score)
-    })
-  })
-  describe('with no url', () => {
-    it.each(missing)('returns no score', (value) => {
-      const score = scoreYoutubeUrl(value)
-      expectNoScore(score)
-    })
-  })
-})

package/src/lib/rating/spec/evaluateNft.spec.ts

@@ -1,140 +0,0 @@
-/* eslint-disable @stylistic/max-len */
-import '@xylabs/vitest-extended'
-
-import type { NftInfoFields } from '@xyo-network/crypto-nft-payload-plugin'
-import {
-  describe, expect, it,
-} from 'vitest'
-
-import { analyzeNft } from '../analyzeNft.ts'
-
-const nfts: NftInfoFields[] = [
-  {
-    address: '0x57f1887a8bf19b14fc0df6fd9b2acc9af147ea85',
-    chainId: 1,
-    metadata: {
-      attributes: [
-        {
-          display_type: 'date',
-          trait_type: 'Created Date',
-          value: null,
-        },
-        {
-          display_type: 'number',
-          trait_type: 'Length',
-          value: 8,
-        },
-        {
-          display_type: 'date',
-          trait_type: 'Registration Date',
-          value: 1_640_668_437_000,
-        },
-        {
-          display_type: 'date',
-          trait_type: 'Expiration Date',
-          value: 1_956_237_957_000,
-        },
-      ],
-      background_image: 'https://metadata.ens.domains/mainnet/avatar/💩happens.eth',
-      description: '💩happens.eth, an ENS name.',
-      image_url:
-        'https://metadata.ens.domains/mainnet/0x57f1887a8bf19b14fc0df6fd9b2acc9af147ea85/0x727cff87562fe62e86e8147c31e567da501307ce220e074ec61eb51b6afc8e7a/image',
-      is_normalized: true,
-      name: '💩happens.eth',
-      name_length: 8,
-      url: 'https://app.ens.domains/name/💩happens.eth',
-      version: 0,
-    },
-    supply: '1',
-    tokenId: '51784517368512681240378652206490798036726342785538345603107759690694088494714',
-    type: 'ERC721',
-  },
-  {
-    address: '0x8eaaabe11896bd09fb852d3a5248004ec44bc793',
-    chainId: 1,
-    metadata: {
-      animation_url:
-        'https://refractions.azureedge.net/refractions/metadata/refractions/0000000000000000000000000000000000000000000000000000000000000007/prism.mp4',
-      attributes: [
-        {
-          display_type: 'date',
-          trait_type: 'Publish Date',
-          value: 1_643_274_000,
-        },
-        {
-          trait_type: 'Edition',
-          value: 'Bridge',
-        },
-        {
-          trait_type: 'Inventory',
-          value: 'Artifacts',
-        },
-      ],
-      description:
-        '🜂🜃🜁🜄 [Prism](https://refractions.xyz/prism) The Lighthouse  \r\n  Airdropped to all [BAYC](https://opensea.io/collection/boredapeyachtclub) and [CryptoFish](https://cryptofish.io/) members by [Captain Murray #9671](https://opensea.io/muratsayginer).   \r\n  \r\n  **Introducing [refractions.xyz](https://refractions.xyz/)** / _This is a new yet familiar territory. A dimension where metaphors rule physics and fiction builds reality…_  \r\n  \r\n  [#apefollowape](https://twitter.com/muratsayginer)',
-      external_url: 'https://refractions.xyz/',
-      image:
-        'https://refractions.azureedge.net/refractions/metadata/refractions/0000000000000000000000000000000000000000000000000000000000000007/prism_placeholder.gif',
-      name: 'Prism',
-    },
-    supply: '1',
-    tokenId: '7',
-    type: 'ERC1155',
-  },
-  {
-    address: '0x0369edc7646948e2f36f9f85baf297bb99843054',
-    chainId: 1,
-    metadata: {
-      attributes: [
-        {
-          trait_type: 'Artist',
-          value: 'MrSnowy10',
-        },
-        {
-          trait_type: 'Item Eaten',
-          value: 'Radioactive Waste',
-        },
-        {
-          trait_type: 'Type',
-          value: 'Avatar',
-        },
-        {
-          trait_type: 'Species',
-          value: 'Pinco',
-        },
-      ],
-      created_by: 'MrSnowy10',
-      description: 'Alien Pinco\n\nPinco "Alien"',
-      external_url: 'https://www.thepincovillage.com/',
-      image: 'https://arweave.net/0-R-VFX6VxkK4Cr70gnq50A2Rd6qXge0sHAQqGPqI4E',
-      image_details: {
-        bytes: 2_459_769,
-        format: 'PNG',
-        height: 1500,
-        sha256: 'f5cc400e767fe9a5c75c32745faf472ca35863b0ff48662923d7f3c9bae13edd',
-        width: 1200,
-      },
-      image_url: 'https://arweave.net/0-R-VFX6VxkK4Cr70gnq50A2Rd6qXge0sHAQqGPqI4E',
-      name: 'Pinco "Alien"',
-    },
-    supply: '1',
-    tokenId: '27',
-    type: 'ERC1155',
-  },
-]
-
-describe('evaluateNft', () => {
-  it.each(nfts)('evaluates the NFT', async (nft) => {
-    const rating = await analyzeNft(nft)
-    expect(rating).toBeObject()
-    for (let [key, score] of Object.entries(rating)) {
-      expect(key).toBeString()
-      const [total, possible] = score
-      expect(total).toBeNumber()
-      expect(total).not.toBeNegative()
-      expect(possible).toBeNumber()
-      expect(possible).not.toBeNegative()
-      expect(total).toBeLessThanOrEqual(possible)
-    }
-  })
-})

package/src/spec/Diviner.spec.ts

@@ -1,41 +0,0 @@
-import '@xylabs/vitest-extended'
-
-import { readFile } from 'node:fs/promises'
-import Path from 'node:path'
-
-import type { NftInfo } from '@xyo-network/crypto-nft-payload-plugin'
-import { isNftInfo } from '@xyo-network/crypto-nft-payload-plugin'
-import { PayloadWrapper } from '@xyo-network/payload-wrapper'
-import {
-  beforeAll,
-  describe, expect, test,
-} from 'vitest'
-
-import { isNftScore, NftScoreDiviner } from '../Diviner.ts'
-
-describe('NftScoreDiviner', () => {
-  let data: NftInfo[]
-  beforeAll(async () => {
-    const filePath = Path.join(__dirname, 'testData.json')
-    const fileContents = await readFile(filePath, 'utf8')
-    const nfts = JSON.parse(fileContents)
-    expect(nfts).toBeArray()
-    if (Array.isArray(nfts)) {
-      data = nfts.filter(isNftInfo)
-    }
-  })
-  test('divine', async () => {
-    const diviner = await NftScoreDiviner.create({ account: 'random' })
-    const scores = (await diviner.divine(data)).filter(isNftScore)
-    expect(scores).toBeArrayOfSize(data.length)
-    for (const [i, score] of scores.entries()) {
-      const wrapped = PayloadWrapper.wrap(score)
-      expect(await wrapped.getValid()).toBe(true)
-      const payload = wrapped.payload
-      expect(payload?.sources).toBeArrayOfSize(1)
-      expect(payload?.sources?.[0]).toBeString()
-      const sourceHash = await PayloadWrapper.wrap(data[i]).dataHash()
-      expect(payload?.sources?.[0]).toBe(sourceHash)
-    }
-  })
-})

package/src/spec/Plugin.spec.ts

@@ -1,17 +0,0 @@
-import '@xylabs/vitest-extended'
-
-import { PayloadSetPluginResolver } from '@xyo-network/payloadset-plugin'
-import {
-  describe, expect,
-  test,
-} from 'vitest'
-
-import { NftScoreDivinerPlugin } from '../Plugin.ts'
-
-describe('NftScoreDivinerPlugin', () => {
-  test('Add to Resolver', async () => {
-    const plugin = NftScoreDivinerPlugin()
-    const resolver = await new PayloadSetPluginResolver().register(plugin)
-    expect(resolver.resolve(plugin.set)).toBeDefined()
-  })
-})