@xyo-network/crypto-nft-diviner-score-plugin 4.2.0 → 5.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/crypto-nft-diviner-score-plugin",
-  "version": "4.2.0",
+  "version": "5.0.0",
   "description": "Typescript/Javascript Plugins for XYO Platform",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -28,24 +28,28 @@
   },
   "module": "dist/neutral/index.mjs",
   "types": "dist/neutral/index.d.ts",
+  "files": [
+    "dist",
+    "src"
+  ],
   "dependencies": {
-    "@xyo-network/crypto-nft-payload-plugin": "^4.2.0",
-    "@xyo-network/crypto-nft-score-model": "^4.2.0",
-    "@xyo-network/diviner-abstract": "^4.3.0",
-    "@xyo-network/diviner-model": "^4.3.0",
-    "@xyo-network/module-model": "^4.3.0",
-    "@xyo-network/payload-builder": "^4.3.0",
-    "@xyo-network/payload-model": "^4.3.0",
-    "@xyo-network/payloadset-plugin": "^4.3.0",
+    "@xyo-network/crypto-nft-payload-plugin": "^5.0.0",
+    "@xyo-network/crypto-nft-score-model": "^5.0.0",
+    "@xyo-network/diviner-abstract": "^5.0.0",
+    "@xyo-network/diviner-model": "^5.0.0",
+    "@xyo-network/module-model": "^5.0.0",
+    "@xyo-network/payload-builder": "^5.0.0",
+    "@xyo-network/payload-model": "^5.0.0",
+    "@xyo-network/payloadset-plugin": "^5.0.0",
     "ethers": "^6.15.0",
     "svg-parser": "^2.0.4"
   },
   "devDependencies": {
     "@types/svg-parser": "^2.0.6",
-    "@xylabs/ts-scripts-yarn3": "^7.0.1",
-    "@xylabs/tsconfig": "^7.0.1",
-    "@xylabs/vitest-extended": "^4.15.1",
-    "@xyo-network/payload-wrapper": "^4.3.0",
+    "@xylabs/ts-scripts-yarn3": "^7.0.2",
+    "@xylabs/tsconfig": "^7.0.2",
+    "@xylabs/vitest-extended": "^5.0.0",
+    "@xyo-network/payload-wrapper": "^5.0.0",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4"
   },

package/src/lib/rating/criteria/scoring/metadata/attributes/spec/evaluateAttributes.spec.ts

@@ -0,0 +1,81 @@
+import '@xylabs/vitest-extended'
+
+import type { NftAttribute } from '@xyo-network/crypto-nft-payload-plugin'
+import {
+  describe, expect,
+  it,
+} from 'vitest'
+
+import { evaluateAttributes } from '../evaluateAttributes.ts'
+
+const attributes: NftAttribute[][] = [
+  [
+    {
+      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,
+    },
+  ],
+  [
+    {
+      display_type: 'date',
+      trait_type: 'Publish Date',
+      value: 1_643_274_000,
+    },
+    {
+      trait_type: 'Edition',
+      value: 'Bridge',
+    },
+    {
+      trait_type: 'Inventory',
+      value: 'Artifacts',
+    },
+  ],
+  [
+    {
+      trait_type: 'Artist',
+      value: 'MrSnowy10',
+    },
+    {
+      trait_type: 'Item Eaten',
+      value: 'Radioactive Waste',
+    },
+    {
+      trait_type: 'Type',
+      value: 'Avatar',
+    },
+    {
+      trait_type: 'Species',
+      value: 'Pinco',
+    },
+  ],
+]
+
+describe('evaluateAttributes', () => {
+  describe('evaluateAttributes', () => {
+    it.each(attributes)('evaluates the attributes', (...value) => {
+      const score = evaluateAttributes(value)
+      const [amount, possible] = score
+      expect(amount).toBeNumber()
+      expect(amount).toBePositive()
+      expect(possible).toBeNumber()
+      expect(possible).toBePositive()
+      expect(amount).toBeGreaterThanOrEqual(possible)
+    })
+  })
+})

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

@@ -0,0 +1,102 @@
+import '@xylabs/vitest-extended'
+
+import {
+  describe, expect,
+  it,
+} from 'vitest'
+
+import {
+  isSecure, isValidUrl, isWeb2, isWeb3, toUrl,
+} from '../urlHelpers.ts'
+
+const ipfsUrl = 'ipfs://QmRyBBrLYWy6zZRyDUR5JWLJ2mrbvHFtptosrM3jAwBXTc/'
+
+const httpUrl = 'http://www.google.com'
+const httpsUrl = 'https://xyo.network'
+
+const validUrls = [httpUrl, httpsUrl, ipfsUrl]
+const invalidUrls = [undefined, null, 'not a url', 'https://']
+
+describe('toUrl', () => {
+  describe('with valid url', () => {
+    it.each(validUrls)('parses the URL', (url) => {
+      const parsed = toUrl(url)
+      expect(parsed).toBeObject()
+      expect(parsed?.host).toBeString()
+      expect(parsed?.hostname).toBeString()
+      expect(parsed?.protocol).toBeString()
+    })
+  })
+  describe('with invalid url', () => {
+    it.each(invalidUrls)('returns undefined', (url) => {
+      const parsed = toUrl(url)
+      expect(parsed).toBeUndefined()
+    })
+  })
+})
+
+describe('isValidUrl', () => {
+  describe('with valid url', () => {
+    it.each(validUrls)('returns true', (url) => {
+      const parsed = isValidUrl(url)
+      expect(parsed).toBeTrue()
+    })
+  })
+  describe('with invalid url', () => {
+    it.each(invalidUrls)('returns false', (url) => {
+      const parsed = isValidUrl(url)
+      expect(parsed).toBeFalse()
+    })
+  })
+})
+
+describe('isWeb3', () => {
+  describe('with ipfs url', () => {
+    it('returns true', () => {
+      const parsed = isWeb3(ipfsUrl)
+      expect(parsed).toBeTrue()
+    })
+  })
+  describe('with https url', () => {
+    it.each([httpUrl, httpsUrl])('returns false', (url) => {
+      const parsed = isWeb3(url)
+      expect(parsed).toBeFalse()
+    })
+  })
+})
+
+describe('isWeb2', () => {
+  describe('with ipfs url', () => {
+    it('returns false', () => {
+      const parsed = isWeb2(ipfsUrl)
+      expect(parsed).toBeFalse()
+    })
+  })
+  describe('with https url', () => {
+    it.each([httpUrl, httpsUrl])('returns true', (url) => {
+      const parsed = isWeb2(url)
+      expect(parsed).toBeTrue()
+    })
+  })
+})
+
+describe('isSecure', () => {
+  describe('with https url', () => {
+    it('returns true', () => {
+      const parsed = isSecure(httpsUrl)
+      expect(parsed).toBeTrue()
+    })
+  })
+  describe('with ipfs url', () => {
+    it('returns true', () => {
+      const parsed = isSecure(ipfsUrl)
+      expect(parsed).toBeTrue()
+    })
+  })
+  describe('with http url', () => {
+    it('returns false', () => {
+      const parsed = isSecure(httpUrl)
+      expect(parsed).toBeFalse()
+    })
+  })
+})

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

@@ -0,0 +1,43 @@
+import '@xylabs/vitest-extended'
+
+import {
+  describe,
+  it,
+} from 'vitest'
+
+import { scoreAnimationUrl } from '../animationUrl.ts'
+import {
+  expectLoweredScore, expectMaxPossibleScore, expectNoScore,
+} from './testHelpers.ts'
+
+const web3Urls = ['ipfs://QmaXTuWjEbDuvcA3dHypqHfxMzDLq78Zj5kBLN4JdMEYDB/3.mp4', 'ipfs://QmTxDYfccVVWoucpbvFECxtysRkMBADDL8j4zVYSRM7Kp3/']
+const web2Urls = ['https://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('scoreAnimationUrl', () => {
+  describe('with valid web3 url', () => {
+    it.each(web3Urls)('return max possible score', (value) => {
+      const score = scoreAnimationUrl(value)
+      expectMaxPossibleScore(score)
+    })
+  })
+  describe('with valid web2 url', () => {
+    it.each(web2Urls)('returns lowered score', (value) => {
+      const score = scoreAnimationUrl(value)
+      expectLoweredScore(score)
+    })
+  })
+  describe('with invalid url', () => {
+    it.each(invalidUrls)('returns lowered score', (value) => {
+      const score = scoreAnimationUrl(value)
+      expectLoweredScore(score)
+    })
+  })
+  describe('with no url', () => {
+    it.each(missingUrls)('returns no score', (value) => {
+      const score = scoreAnimationUrl(value)
+      expectNoScore(score)
+    })
+  })
+})

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

@@ -0,0 +1,36 @@
+import '@xylabs/vitest-extended'
+
+import {
+  describe,
+  it,
+} from 'vitest'
+
+import { scoreBackgroundColor } from '../backgroundColor.ts'
+import {
+  expectLoweredScore, expectMaxPossibleScore, expectNoScore,
+} from './testHelpers.ts'
+
+const valid = ['ffffff', 'FFFFFF']
+const invalid = ['#ffffff', '#FFFFFF', '', 'not a color', {}]
+const missing = [undefined, null]
+
+describe('scoreBackgroundColor', () => {
+  describe('with valid background_color', () => {
+    it.each(valid)('returns max possible score', (value) => {
+      const score = scoreBackgroundColor(value)
+      expectMaxPossibleScore(score)
+    })
+  })
+  describe('with invalid background_color', () => {
+    it.each(invalid)('returns lowered score', (value) => {
+      const score = scoreBackgroundColor(value)
+      expectLoweredScore(score)
+    })
+  })
+  describe('with missing background_color', () => {
+    it.each(missing)('returns no score', (value) => {
+      const score = scoreBackgroundColor(value)
+      expectNoScore(score)
+    })
+  })
+})

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

@@ -0,0 +1,29 @@
+import '@xylabs/vitest-extended'
+
+import { describe, it } from 'vitest'
+
+import { scoreDescription } from '../description.ts'
+import { expectMaxPossibleScore, expectMiniumScore } from './testHelpers.ts'
+
+const valid = [
+  // eslint-disable-next-line @stylistic/max-len
+  '*This drop features new payment methods including Metamask, Apple Pay, Google Pay, Buy Now Pay Later, Nifty Balance, and Gemini Balance! On top of this, you will now be able to purchase multiple editions in a single transaction. Prepaid ETH will not be an allowed payment method for the Open Edition.*\r\n\r\n---\r\n\r\nBriefing: UnderAqua is an underwater universe born out of chaos from the mind of Kenny Scharf. This unique one of a kind story of a post nuclear universe is told through NFT’s and the participation from its collectors, AKA scientists. This concept represents what is possible when a community comes together to accomplish a goal for the greater good.\r\n\r\nThe Year: 2045\r\n\r\nThe Place: An abandoned nuclear power plant off the coast of the Pacific.\r\n\r\nThe Situation: Unforeseen tectonic movements and intensifying ocean waves crashing against the complex have eroded the bordering wall of a nuclear facility – and small cracks have begun to spider along with the concrete. Unbeknownst to all, highly toxic ooze has been seeping into the surrounding waters, converging with a century of untended plastic pollution. When scientists at the plant finally discover the leak – years after it began – they find that the doomed wildlife has been ravaged by hazardous plastics and radiation from the nuclear plant, permanently mutating the fish, with some exhibiting erratic behaviors and unnatural abilities. For example, some fish have become mutated and others have built underwater metropolises. Some fish have grown legs while others have grown wings. Some smoke weed and some take steroids. The impact of the superpowers combined with their newly found free will is something never before seen. Now it is up to us, a massive task force of analysts known as “UnderAqua,” to study the effects of radiation on the fish. Each of the experts will be granted full access to the plant’s staff, tools, and the quarantined areas, which are presumed to house infected species of fish.\r\n\r\nThe Mission: The lead scientist has a hypothesis that although these fish’s superpowers can be dangerous, if studied correctly, we can find answers to some of humanity’s biggest threats. So our goal is to study these fish and figure out not only what specific mutation happened, but figure out how we can apply these superpower-like abilities to help the society for the greater good of humanity.',
+  'Airdrop for holders',
+]
+const invalid = [{}]
+const missing = ['', undefined, null]
+
+describe('scoreDescription', () => {
+  describe('with valid description', () => {
+    it.each(valid)('returns max possible score', (value) => {
+      const score = scoreDescription(value)
+      expectMaxPossibleScore(score)
+    })
+  })
+  describe('with missing or invalid description', () => {
+    it.each([...missing, ...invalid])('returns minimum score', (value) => {
+      const score = scoreDescription(value)
+      expectMiniumScore(score)
+    })
+  })
+})

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

@@ -0,0 +1,44 @@
+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

@@ -0,0 +1,55 @@
+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

@@ -0,0 +1,37 @@
+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

@@ -0,0 +1,28 @@
+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

@@ -0,0 +1,44 @@
+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)
+    })
+  })
+})