@xyo-network/crypto-nft-diviner-score-plugin 2.70.0

package/dist/types/lib/rating/criteria/scoring/metadata/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../../src/lib/rating/criteria/scoring/metadata/lib/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA"}

package/dist/types/lib/rating/criteria/scoring/metadata/lib/urlHelpers.d.ts

@@ -0,0 +1,8 @@
+import { URL } from '@xylabs/url';
+export declare const web3Protocols: string[];
+export declare const toUrl: (url?: string | null) => URL | undefined;
+export declare const isValidUrl: (url?: string | null) => boolean;
+export declare const isWeb3: (url?: string | null) => boolean;
+export declare const isWeb2: (url?: string | null) => boolean;
+export declare const isSecure: (url?: string | null) => boolean;
+//# sourceMappingURL=urlHelpers.d.ts.map

package/dist/types/lib/rating/criteria/scoring/metadata/lib/urlHelpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"urlHelpers.d.ts","sourceRoot":"","sources":["../../../../../../../../src/lib/rating/criteria/scoring/metadata/lib/urlHelpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,aAAa,CAAA;AAEjC,eAAO,MAAM,aAAa,UAAmB,CAAA;AAE7C,eAAO,MAAM,KAAK,SAAU,MAAM,GAAG,IAAI,KAAG,GAAG,GAAG,SAOjD,CAAA;AAED,eAAO,MAAM,UAAU,SAAU,MAAM,GAAG,IAAI,KAAG,OAAmC,CAAA;AACpF,eAAO,MAAM,MAAM,SAAU,MAAM,GAAG,IAAI,KAAG,OAA8E,CAAA;AAC3H,eAAO,MAAM,MAAM,SAAU,MAAM,GAAG,IAAI,KAAG,OAAuB,CAAA;AACpE,eAAO,MAAM,QAAQ,SAAU,MAAM,GAAG,IAAI,KAAG,OAA2D,CAAA"}

package/dist/types/lib/rating/criteria/scoring/metadata/name.d.ts

@@ -0,0 +1,5 @@
+import { NftInfo, OpenSeaNftInfo } from '@xyo-network/crypto-nft-payload-plugin';
+import { ScaledScore } from '../../../score';
+export declare const scoreNftName: (nft: NftInfo | OpenSeaNftInfo) => ScaledScore;
+export declare const scoreName: (name: unknown) => ScaledScore;
+//# sourceMappingURL=name.d.ts.map

package/dist/types/lib/rating/criteria/scoring/metadata/name.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"name.d.ts","sourceRoot":"","sources":["../../../../../../../src/lib/rating/criteria/scoring/metadata/name.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,wCAAwC,CAAA;AAEhF,OAAO,EAAkB,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAE5D,eAAO,MAAM,YAAY,QAAS,OAAO,GAAG,cAAc,gBAEzD,CAAA;AACD,eAAO,MAAM,SAAS,SAAU,OAAO,gBAItC,CAAA"}

package/dist/types/lib/rating/criteria/scoring/metadata/youtubeUrl.d.ts

@@ -0,0 +1,5 @@
+import { NftInfo, OpenSeaNftInfo } from '@xyo-network/crypto-nft-payload-plugin';
+import { ScaledScore } from '../../../score';
+export declare const scoreNftYoutubeUrl: (nft: NftInfo | OpenSeaNftInfo) => ScaledScore;
+export declare const scoreYoutubeUrl: (youtube_url: unknown) => ScaledScore;
+//# sourceMappingURL=youtubeUrl.d.ts.map

package/dist/types/lib/rating/criteria/scoring/metadata/youtubeUrl.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"youtubeUrl.d.ts","sourceRoot":"","sources":["../../../../../../../src/lib/rating/criteria/scoring/metadata/youtubeUrl.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,wCAAwC,CAAA;AAEhF,OAAO,EAAwB,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAGlE,eAAO,MAAM,kBAAkB,QAAS,OAAO,GAAG,cAAc,gBAE/D,CAAA;AACD,eAAO,MAAM,eAAe,gBAAiB,OAAO,gBAOnD,CAAA"}

package/dist/types/lib/rating/criteria/scoring/supply.d.ts

@@ -0,0 +1,3 @@
+import { PassFailScoringFunction } from '../../score';
+export declare const scoreSupply: PassFailScoringFunction;
+//# sourceMappingURL=supply.d.ts.map

package/dist/types/lib/rating/criteria/scoring/supply.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"supply.d.ts","sourceRoot":"","sources":["../../../../../../src/lib/rating/criteria/scoring/supply.ts"],"names":[],"mappings":"AAEA,OAAO,EAAc,uBAAuB,EAAE,MAAM,aAAa,CAAA;AAGjE,eAAO,MAAM,WAAW,EAAE,uBASzB,CAAA"}

package/dist/types/lib/rating/criteria/scoring/tokenId.d.ts

@@ -0,0 +1,9 @@
+import { PassFailScoringFunction } from '../../score';
+/**
+ * Callers SHALL NOT assume that ID numbers have any specific pattern to them, and
+ * MUST treat the ID as a "black box"
+ * @param nft
+ * @returns
+ */
+export declare const scoreTokenId: PassFailScoringFunction;
+//# sourceMappingURL=tokenId.d.ts.map

package/dist/types/lib/rating/criteria/scoring/tokenId.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tokenId.d.ts","sourceRoot":"","sources":["../../../../../../src/lib/rating/criteria/scoring/tokenId.ts"],"names":[],"mappings":"AAEA,OAAO,EAAc,uBAAuB,EAAE,MAAM,aAAa,CAAA;AAGjE;;;;;GAKG;AACH,eAAO,MAAM,YAAY,EAAE,uBAS1B,CAAA"}

package/dist/types/lib/rating/criteria/scoring/type.d.ts

@@ -0,0 +1,3 @@
+import { PassFailScoringFunction } from '../../score';
+export declare const scoreType: PassFailScoringFunction;
+//# sourceMappingURL=type.d.ts.map

package/dist/types/lib/rating/criteria/scoring/type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"type.d.ts","sourceRoot":"","sources":["../../../../../../src/lib/rating/criteria/scoring/type.ts"],"names":[],"mappings":"AAEA,OAAO,EAAc,uBAAuB,EAAE,MAAM,aAAa,CAAA;AAEjE,eAAO,MAAM,SAAS,EAAE,uBAMvB,CAAA"}

package/dist/types/lib/rating/criteria/scoringCriteria.d.ts

@@ -0,0 +1,55 @@
+export declare const scoringCriteria: {
+    Attributes: {
+        score: (nft: import("@xyo-network/crypto-nft-payload-plugin").NftInfo | import("@xyo-network/crypto-nft-payload-plugin").OpenSeaNftInfo) => import("..").ScaledScore;
+        weight: number;
+    };
+    'Animation URL': {
+        score: (nft: import("@xyo-network/crypto-nft-payload-plugin").NftInfo | import("@xyo-network/crypto-nft-payload-plugin").OpenSeaNftInfo) => import("..").ScaledScore;
+        weight: number;
+    };
+    'Background Color': {
+        score: (nft: import("@xyo-network/crypto-nft-payload-plugin").NftInfo | import("@xyo-network/crypto-nft-payload-plugin").OpenSeaNftInfo) => import("..").ScaledScore;
+        weight: number;
+    };
+    Description: {
+        score: (nft: import("@xyo-network/crypto-nft-payload-plugin").NftInfo | import("@xyo-network/crypto-nft-payload-plugin").OpenSeaNftInfo) => import("..").ScaledScore;
+        weight: number;
+    };
+    'External Url': {
+        score: (nft: import("@xyo-network/crypto-nft-payload-plugin").NftInfo | import("@xyo-network/crypto-nft-payload-plugin").OpenSeaNftInfo) => import("..").ScaledScore;
+        weight: number;
+    };
+    Image: {
+        score: (nft: import("@xyo-network/crypto-nft-payload-plugin").NftInfo | import("@xyo-network/crypto-nft-payload-plugin").OpenSeaNftInfo) => import("..").ScaledScore;
+        weight: number;
+    };
+    'Image Data': {
+        score: (nft: import("@xyo-network/crypto-nft-payload-plugin").NftInfo | import("@xyo-network/crypto-nft-payload-plugin").OpenSeaNftInfo) => import("..").ScaledScore;
+        weight: number;
+    };
+    Name: {
+        score: (nft: import("@xyo-network/crypto-nft-payload-plugin").NftInfo | import("@xyo-network/crypto-nft-payload-plugin").OpenSeaNftInfo) => import("..").ScaledScore;
+        weight: number;
+    };
+    'YouTube URL': {
+        score: (nft: import("@xyo-network/crypto-nft-payload-plugin").NftInfo | import("@xyo-network/crypto-nft-payload-plugin").OpenSeaNftInfo) => import("..").ScaledScore;
+        weight: number;
+    };
+    'Contract Address': {
+        score: import("..").PassFailScoringFunction;
+        weight: number;
+    };
+    Supply: {
+        score: import("..").PassFailScoringFunction;
+        weight: number;
+    };
+    'Token Id': {
+        score: import("..").PassFailScoringFunction;
+        weight: number;
+    };
+    Type: {
+        score: import("..").PassFailScoringFunction;
+        weight: number;
+    };
+};
+//# sourceMappingURL=scoringCriteria.d.ts.map

package/dist/types/lib/rating/criteria/scoringCriteria.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scoringCriteria.d.ts","sourceRoot":"","sources":["../../../../../src/lib/rating/criteria/scoringCriteria.ts"],"names":[],"mappings":"AAgCA,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAM3B,CAAA"}

package/dist/types/lib/rating/index.d.ts

@@ -0,0 +1,3 @@
+export * from './analyzeNft';
+export * from './score';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/lib/rating/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/lib/rating/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA;AAC5B,cAAc,SAAS,CAAA"}

package/dist/types/lib/rating/score.d.ts

@@ -0,0 +1,18 @@
+import { NftInfo } from '@xyo-network/crypto-nft-payload-plugin';
+export type PassFailScore = [total: number, possible: 1];
+export declare const PASS: PassFailScore;
+export declare const FAIL: PassFailScore;
+export type ScaledScore = [total: number, possible: number];
+export declare const SKIP: ScaledScore;
+export type Score = ScaledScore | PassFailScore;
+export type PassFailScoringFunction = (nft: NftInfo) => PassFailScore | Promise<PassFailScore>;
+export type ScaledScoringFunction = (nft: NftInfo) => Score | Promise<Score>;
+export type ScoringFunction = PassFailScoringFunction | ScaledScoringFunction;
+export interface WeightedScoringCriteria {
+    score: ScoringFunction;
+    weight: number;
+}
+export declare const incrementTotal: (score: ScaledScore, by?: number) => ScaledScore;
+export declare const incrementPossible: (score: ScaledScore, by?: number) => ScaledScore;
+export declare const incrementTotalAndPossible: (score: ScaledScore, totalBy?: number, possibleBy?: number) => ScaledScore;
+//# sourceMappingURL=score.d.ts.map

package/dist/types/lib/rating/score.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"score.d.ts","sourceRoot":"","sources":["../../../../src/lib/rating/score.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,wCAAwC,CAAA;AAEhE,MAAM,MAAM,aAAa,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAA;AACxD,eAAO,MAAM,IAAI,EAAE,aAAsB,CAAA;AACzC,eAAO,MAAM,IAAI,EAAE,aAAsB,CAAA;AACzC,MAAM,MAAM,WAAW,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAA;AAC3D,eAAO,MAAM,IAAI,EAAE,WAAoB,CAAA;AACvC,MAAM,MAAM,KAAK,GAAG,WAAW,GAAG,aAAa,CAAA;AAE/C,MAAM,MAAM,uBAAuB,GAAG,CAAC,GAAG,EAAE,OAAO,KAAK,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC,CAAA;AAC9F,MAAM,MAAM,qBAAqB,GAAG,CAAC,GAAG,EAAE,OAAO,KAAK,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,CAAA;AAC5E,MAAM,MAAM,eAAe,GAAG,uBAAuB,GAAG,qBAAqB,CAAA;AAE7E,MAAM,WAAW,uBAAuB;IACtC,KAAK,EAAE,eAAe,CAAA;IACtB,MAAM,EAAE,MAAM,CAAA;CACf;AAED,eAAO,MAAM,cAAc,kDAG1B,CAAA;AAED,eAAO,MAAM,iBAAiB,kDAG7B,CAAA;AAED,eAAO,MAAM,yBAAyB,4EAIrC,CAAA"}

package/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "@xyo-network/crypto-nft-diviner-score-plugin",
+  "author": {
+    "email": "support@xyo.network",
+    "name": "XYO Development Team",
+    "url": "https://xyo.network"
+  },
+  "bugs": {
+    "email": "support@xyo.network",
+    "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
+  },
+  "dependencies": {
+    "@ethersproject/address": "^5.7.0",
+    "@xylabs/bignumber": "^2.9.3",
+    "@xylabs/url": "^2.9.3",
+    "@xyo-network/abstract-diviner": "~2.70.0",
+    "@xyo-network/core": "~2.70.0",
+    "@xyo-network/crypto-nft-payload-plugin": "~2.70.0",
+    "@xyo-network/diviner-model": "~2.70.0",
+    "@xyo-network/module": "~2.70.0",
+    "@xyo-network/payload-model": "~2.70.0",
+    "@xyo-network/payloadset-plugin": "~2.70.0",
+    "svg-parser": "^2.0.4"
+  },
+  "devDependencies": {
+    "@types/svg-parser": "^2.0.3",
+    "@xylabs/jest-helpers": "^2.9.3",
+    "@xylabs/ts-scripts-yarn3": "^2.19.0",
+    "@xylabs/tsconfig": "^2.19.0",
+    "ethers": "^5.7.2",
+    "jest": "^29.6.2",
+    "typescript": "^5.1.6"
+  },
+  "description": "Primary SDK for using XYO Protocol 2.0",
+  "browser": "dist/esm/index.js",
+  "docs": "dist/docs.json",
+  "exports": {
+    ".": {
+      "node": {
+        "import": "./dist/esm/index.js",
+        "require": "./dist/cjs/index.js"
+      },
+      "browser": {
+        "import": "./dist/esm/index.js",
+        "require": "./dist/cjs/index.js"
+      },
+      "default": "./dist/esm/index.js"
+    },
+    "./dist/docs.json": {
+      "default": "./dist/docs.json"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "homepage": "https://xyo.network",
+  "license": "LGPL-3.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
+  },
+  "sideEffects": false,
+  "types": "dist/types/index.d.ts",
+  "version": "2.70.0"
+}

package/src/Diviner.ts

@@ -0,0 +1,37 @@
+import { AbstractDiviner } from '@xyo-network/abstract-diviner'
+import { PayloadHasher } from '@xyo-network/core'
+import {
+  isNftInfoPayload,
+  NftScoreDivinerConfig,
+  NftScoreDivinerConfigSchema,
+  NftScorePayload,
+  NftScoreSchema,
+} from '@xyo-network/crypto-nft-payload-plugin'
+import { DivinerParams } from '@xyo-network/diviner-model'
+import { AnyConfigSchema } from '@xyo-network/module'
+import { Payload } from '@xyo-network/payload-model'
+
+import { analyzeNft, NftAnalysis } from './lib'
+
+export type NftScoreDivinerParams = DivinerParams<AnyConfigSchema<NftScoreDivinerConfig>>
+
+const toNftScorePayload = (rating: NftAnalysis): NftScorePayload => {
+  return { ...rating, schema: NftScoreSchema } as NftScorePayload
+}
+
+export const isNftScorePayload = (payload: Payload): payload is NftScorePayload => payload.schema === NftScoreSchema
+
+export class NftScoreDiviner<TParams extends NftScoreDivinerParams = NftScoreDivinerParams> extends AbstractDiviner<TParams> {
+  static override configSchemas = [NftScoreDivinerConfigSchema]
+
+  protected override divineHandler = async (payloads?: Payload[]): Promise<Payload[]> => {
+    const nfts = payloads?.filter(isNftInfoPayload) ?? []
+    const results = await Promise.all(
+      nfts.map<Promise<NftScorePayload>>(async (p) => {
+        const [score, sourceHash] = await Promise.all([toNftScorePayload(await analyzeNft(p)), PayloadHasher.hashAsync(p)])
+        return { ...score, sources: [sourceHash] }
+      }),
+    )
+    return results
+  }
+}

package/src/Plugin.ts

@@ -0,0 +1,16 @@
+import { NftSchema } from '@xyo-network/crypto-nft-payload-plugin'
+import { PayloadSetSchema } from '@xyo-network/payload-model'
+import { createPayloadSetDivinerPlugin } from '@xyo-network/payloadset-plugin'
+
+import { NftScoreDiviner } from './Diviner'
+
+export const NftScoreDivinerPlugin = () =>
+  createPayloadSetDivinerPlugin<NftScoreDiviner>(
+    { required: { [NftSchema]: 1 }, schema: PayloadSetSchema },
+    {
+      diviner: async (params) => {
+        const result = await NftScoreDiviner.create(params)
+        return result
+      },
+    },
+  )

package/src/index.ts

@@ -0,0 +1,9 @@
+import { NftScoreDivinerPlugin } from './Plugin'
+
+export * from './Diviner'
+export * from './lib'
+
+export { NftScoreDivinerPlugin }
+
+// eslint-disable-next-line import/no-default-export
+export default NftScoreDivinerPlugin

package/src/lib/index.ts

@@ -0,0 +1 @@
+export * from './rating'

package/src/lib/rating/analyzeNft.ts

@@ -0,0 +1,28 @@
+import { NftInfo } from '@xyo-network/crypto-nft-payload-plugin'
+
+import { scoringCriteria } from './criteria'
+import { Score } from './score'
+
+export type ScoringCriteriaKey = keyof typeof scoringCriteria & PropertyKey
+
+export type NftAnalysis = {
+  [key in ScoringCriteriaKey]: Score
+}
+
+export const analyzeNft = async (
+  /**
+   * The NFT to evaluate
+   */
+  nft: NftInfo,
+): Promise<NftAnalysis> => {
+  const result = Object.fromEntries(
+    await Promise.all(
+      Object.entries(scoringCriteria).map(async ([key, { score, weight }]) => {
+        const rawScore = await score(nft)
+        const weighted = rawScore.map((v) => v * weight) as Score
+        return [key, weighted] as const
+      }),
+    ),
+  ) as NftAnalysis
+  return result
+}

package/src/lib/rating/criteria/index.ts

@@ -0,0 +1 @@
+export * from './scoringCriteria'

package/src/lib/rating/criteria/scoring/contract.ts

@@ -0,0 +1,11 @@
+import { isAddress } from '@ethersproject/address'
+import { NftInfo } from '@xyo-network/crypto-nft-payload-plugin'
+
+import { FAIL, PASS, PassFailScoringFunction } from '../../score'
+
+export const scoreContractAddress: PassFailScoringFunction = (nft: NftInfo) => {
+  if (!nft.contract) return FAIL
+  if (typeof nft.contract !== 'string') return FAIL
+  if (!isAddress(nft.contract)) return FAIL
+  return PASS
+}

package/src/lib/rating/criteria/scoring/index.ts

@@ -0,0 +1,5 @@
+export * from './contract'
+export * from './metadata'
+export * from './supply'
+export * from './tokenId'
+export * from './type'

package/src/lib/rating/criteria/scoring/lib/index.ts

@@ -0,0 +1,2 @@
+export * from './isValidPositiveBigNumber'
+export * from './toBigNumber'

package/src/lib/rating/criteria/scoring/lib/isValidPositiveBigNumber.ts

@@ -0,0 +1,6 @@
+import { toBigNumber } from './toBigNumber'
+
+export const isValidPositiveBigNumber = (value: string): boolean => {
+  const num = toBigNumber(value)
+  return !num || num.isNeg() ? false : true
+}

package/src/lib/rating/criteria/scoring/lib/toBigNumber.ts

@@ -0,0 +1,9 @@
+import { BigNumber } from '@xylabs/bignumber'
+
+export const toBigNumber = (value: string): BigNumber | undefined => {
+  try {
+    return new BigNumber(value)
+  } catch (error) {
+    return undefined
+  }
+}

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

@@ -0,0 +1,22 @@
+import { NftInfo, OpenSeaNftInfo } from '@xyo-network/crypto-nft-payload-plugin'
+
+import { incrementPossible, incrementTotal, incrementTotalAndPossible, PASS, ScaledScore } from '../../../score'
+import { isSecure, isValidUrl, isWeb3 } from './lib'
+
+export const scoreNftAnimationUrl = (nft: NftInfo | OpenSeaNftInfo): ScaledScore => {
+  return scoreAnimationUrl(nft.metadata?.animation_url)
+}
+
+export const scoreAnimationUrl = (animation_url: unknown): ScaledScore => {
+  const score: ScaledScore = [0, 0]
+  if (animation_url === undefined || animation_url === null) return PASS
+  incrementPossible(score)
+  if (typeof animation_url !== 'string') return score
+  incrementTotalAndPossible(score)
+  if (!isValidUrl(animation_url)) return score
+  incrementTotalAndPossible(score)
+  if (!isSecure(animation_url)) return score
+  incrementTotalAndPossible(score)
+  if (!isWeb3(animation_url)) return score
+  return incrementTotal(score)
+}

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

@@ -0,0 +1,86 @@
+import { NftAttribute, NftInfo, OpenSeaNftAttribute, OpenSeaNftInfo } from '@xyo-network/crypto-nft-payload-plugin'
+
+import { incrementPossible, incrementTotal, incrementTotalAndPossible, ScaledScore } from '../../../../score'
+
+const isDate = (value: unknown): value is Date => {
+  if (isNumber(value)) {
+    try {
+      new Date(value)
+      return true
+    } catch (error) {
+      return false
+    }
+  }
+  return false
+}
+
+const isNumber = (value: unknown): value is number => typeof value === 'number'
+
+const isPercentage = (value: unknown): boolean => isNumber(value) && value >= 0 && value <= 100
+
+const isNonEmptyString = (value: unknown): value is string => typeof value === 'string' && value.length > 0
+
+const isNonEmptyStringOrNumber = (value: unknown): value is string | number => value === 'number' || isNonEmptyString(value)
+
+export const evaluateNftAttributes = (nft: NftInfo | OpenSeaNftInfo): ScaledScore =>
+  !nft?.metadata?.attributes ? [0, 1] : evaluateAttributes(nft?.metadata?.attributes)
+
+export const evaluateAttributes = (attributes: NftAttribute[] | OpenSeaNftAttribute[] | unknown): ScaledScore => {
+  if (!attributes || !Array.isArray(attributes) || attributes.length === 0) return [0, 1]
+  const score: ScaledScore = [0, 0]
+  for (const attribute of attributes) {
+    const [attributeTotal, attributePossible] = evaluateAttribute(attribute)
+    incrementTotalAndPossible(score, attributeTotal, attributePossible)
+  }
+  return [1, 1]
+}
+
+export const evaluateAttribute = (attribute: OpenSeaNftAttribute): ScaledScore => {
+  const score: ScaledScore = [0, 1]
+  const max_value = attribute?.max_value
+  const trait_type = attribute?.trait_type
+  const value = attribute?.value
+
+  // Validate trait_type & value
+  if (!attribute || typeof attribute !== 'object' || !isNonEmptyString(trait_type) || !isNonEmptyStringOrNumber(value)) return score
+  incrementTotal(score)
+
+  // Validate display_type
+  incrementPossible(score)
+  if (validDisplayType(attribute)) incrementTotal(score)
+
+  // Validate max_value
+  if (max_value !== undefined) {
+    incrementPossible(score)
+    if (isNumber(max_value) && isNumber(value) && value <= max_value) incrementTotal(score)
+  }
+
+  return score
+}
+
+const validDisplayType = (attribute: OpenSeaNftAttribute): boolean => {
+  switch (attribute?.display_type) {
+    case 'number':
+    case 'boost_number': {
+      if (isNumber(attribute?.value)) return true
+      break
+    }
+    case 'boost_percentage': {
+      if (isPercentage(attribute?.value)) return true
+      break
+    }
+    case 'date': {
+      if (isDate(attribute?.value)) return true
+      break
+    }
+    case 'string':
+    case undefined: {
+      if (isNonEmptyString(attribute?.value)) return true
+      break
+    }
+    default: {
+      break
+    }
+  }
+  return false
+}

package/src/lib/rating/criteria/scoring/metadata/attributes/index.ts

@@ -0,0 +1 @@
+export * from './evaluateAttributes'

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

@@ -0,0 +1,19 @@
+import { NftInfo, OpenSeaNftInfo } from '@xyo-network/crypto-nft-payload-plugin'
+
+import { incrementPossible, incrementTotal, incrementTotalAndPossible, PASS, ScaledScore } from '../../../score'
+
+const isHexColor = /^[0-9A-F]{6}$/i
+
+export const scoreNftBackgroundColor = (nft: NftInfo | OpenSeaNftInfo): ScaledScore => {
+  return scoreBackgroundColor(nft.metadata?.background_color)
+}
+
+export const scoreBackgroundColor = (background_color: unknown): ScaledScore => {
+  const score: ScaledScore = [0, 0]
+  if (background_color === undefined || background_color === null) return PASS
+  incrementPossible(score)
+  if (typeof background_color !== 'string') return score
+  incrementTotalAndPossible(score)
+  if (!background_color.toUpperCase().match(isHexColor)) return score
+  return incrementTotal(score)
+}

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

@@ -0,0 +1,13 @@
+import { NftInfo, OpenSeaNftInfo } from '@xyo-network/crypto-nft-payload-plugin'
+
+import { incrementTotal, ScaledScore } from '../../../score'
+
+export const scoreNftDescription = (nft: NftInfo | OpenSeaNftInfo): ScaledScore => {
+  return scoreDescription(nft.metadata?.description)
+}
+
+export const scoreDescription = (description: unknown): ScaledScore => {
+  const score: ScaledScore = [0, 1]
+  if (!description || typeof description !== 'string') return score
+  return incrementTotal(score)
+}

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

@@ -0,0 +1,15 @@
+import { NftInfo, OpenSeaNftInfo } from '@xyo-network/crypto-nft-payload-plugin'
+
+import { incrementTotal, ScaledScore } from '../../../score'
+import { isSecure, isValidUrl } from './lib'
+
+export const scoreNftExternalUrl = (nft: NftInfo | OpenSeaNftInfo): ScaledScore => {
+  return scoreExternalUrl(nft?.metadata?.external_url)
+}
+export const scoreExternalUrl = (external_url: unknown): ScaledScore => {
+  const score: ScaledScore = [0, 2]
+  if (external_url === undefined || external_url === null || typeof external_url !== 'string' || !isValidUrl(external_url)) return score
+  incrementTotal(score)
+  if (!isSecure(external_url)) return score
+  return incrementTotal(score)
+}

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

@@ -0,0 +1,27 @@
+import { NftInfo, OpenSeaNftInfo } from '@xyo-network/crypto-nft-payload-plugin'
+
+import { incrementTotal, PASS, ScaledScore } from '../../../score'
+import { isSecure, isValidUrl, isWeb3 } from './lib'
+
+const MaxPossibleImageScore = 3
+
+export const scoreNftImage = (nft: NftInfo | OpenSeaNftInfo): ScaledScore => {
+  // If there's no image data
+  if (!nft?.metadata?.image) {
+    // but there is image data, skip this scoring criteria, otherwise fail it completely
+    return nft.metadata?.image_data ? PASS : [0, MaxPossibleImageScore]
+  } else {
+    return scoreImage(nft.metadata?.image)
+  }
+}
+
+export const scoreImage = (image: unknown): ScaledScore => {
+  const score: ScaledScore = [0, MaxPossibleImageScore]
+  if (!image || typeof image !== 'string' || !isValidUrl(image)) return score
+  incrementTotal(score)
+  if (!isSecure(image)) return score
+  incrementTotal(score)
+  if (!isWeb3(image)) return score
+  incrementTotal(score)
+  return score
+}

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

@@ -0,0 +1,36 @@
+import { NftInfo, OpenSeaNftInfo } from '@xyo-network/crypto-nft-payload-plugin'
+import { parse } from 'svg-parser'
+
+import { PASS, ScaledScore } from '../../../score'
+
+const MaxPossibleImageDataScore = 1
+
+// NOTE: There is probably a deeper check we can do
+// here, but this is a good start
+const isValidImageData = (image_data: string): boolean => {
+  // If it doesn't start with an svg tag, it's not an svg
+  if (!image_data.startsWith('<svg')) return false
+  try {
+    // If it can't be parsed, it's not an svg
+    parse(image_data)
+    return true
+  } catch (error) {
+    return false
+  }
+}
+
+export const scoreNftImageData = (nft: NftInfo | OpenSeaNftInfo): ScaledScore => {
+  // If there's no image data
+  if (!nft?.metadata?.image_data) {
+    // but there is an image, skip this scoring criteria, otherwise fail it completely
+    return nft.metadata?.image ? PASS : [0, MaxPossibleImageDataScore]
+  } else {
+    return scoreImageData(nft.metadata?.image_data)
+  }
+}
+
+export const scoreImageData = (image_data: unknown): ScaledScore => {
+  return !image_data || typeof image_data !== 'string' || !isValidImageData(image_data)
+    ? [0, MaxPossibleImageDataScore]
+    : [MaxPossibleImageDataScore, MaxPossibleImageDataScore]
+}

package/src/lib/rating/criteria/scoring/metadata/index.ts

@@ -0,0 +1,9 @@
+export * from './animationUrl'
+export * from './attributes'
+export * from './backgroundColor'
+export * from './description'
+export * from './externalUrl'
+export * from './image'
+export * from './imageData'
+export * from './name'
+export * from './youtubeUrl'

package/src/lib/rating/criteria/scoring/metadata/lib/index.ts

@@ -0,0 +1 @@
+export * from './urlHelpers'

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

@@ -0,0 +1,17 @@
+import { URL } from '@xylabs/url'
+
+export const web3Protocols = ['ipfs:', 'ar:']
+
+export const toUrl = (url?: string | null): URL | undefined => {
+  if (!url) return undefined
+  try {
+    return new URL(url)
+  } catch (e) {
+    return undefined
+  }
+}
+
+export const isValidUrl = (url?: string | null): boolean => toUrl(url) !== undefined
+export const isWeb3 = (url?: string | null): boolean => web3Protocols.some((protocol) => protocol === toUrl(url)?.protocol)
+export const isWeb2 = (url?: string | null): boolean => !isWeb3(url)
+export const isSecure = (url?: string | null): boolean => isWeb3(url) || toUrl(url)?.protocol === 'https:'