@xyo-network/crypto-nft-collection-diviner-score-plugin 2.75.3 → 2.75.5

package/dist/browser/Diviner.js

@@ -1,3 +1,4 @@
+// src/Diviner.ts
 import { AbstractDiviner } from "@xyo-network/abstract-diviner";
 import { PayloadHasher } from "@xyo-network/core";
 import {
@@ -5,13 +6,103 @@ import {
   NftCollectionScoreDivinerConfigSchema,
   NftCollectionScoreSchema
 } from "@xyo-network/crypto-nft-collection-payload-plugin";
-import { analyzeNftCollection } from "./lib";
-const toNftCollectionScore = (nftCollectionInfo, scores) => {
+
+// src/lib/rating/criteria/scoring/metadata/scoreIndividualAttributes.ts
+import { normalize } from "@xyo-network/crypto-nft-score-model";
+var maxScore = 10;
+var scoreIndividualAttributes = (info) => {
+  const { attributes } = info.metrics.metadata;
+  const entries = Object.entries(attributes);
+  if (entries.length === 0)
+    return [0, maxScore];
+  const scores = Object.entries(attributes).map(([_trait, { values }]) => {
+    return Object.entries(values).map(([_traitValue, metrics]) => {
+      const rarity = Math.min(Math.round((1 - metrics.binomial.p) * maxScore), maxScore);
+      return [rarity, maxScore];
+    });
+  }).flat();
+  const total = scores.reduce(([a, b], [c, d]) => [a + c, b + d], [0, 0]);
+  return normalize(total, maxScore);
+};
+
+// src/lib/rating/criteria/scoring/metadata/scoreTotalAttributes.ts
+import { normalize as normalize2 } from "@xyo-network/crypto-nft-score-model";
+var maxScore2 = 10;
+var defaultMu = 0.15;
+var defaultSigma = 0.1;
+var gaussianProbabilityDensity = (x, mu = defaultMu, sigma = defaultSigma) => {
+  const sqrtTwoPi = Math.sqrt(2 * Math.PI);
+  const denominator = sigma * sqrtTwoPi;
+  const power = -0.5 * Math.pow((x - mu) / sigma, 2);
+  return 1 / denominator * Math.exp(power);
+};
+var maxProbabilityDensity = gaussianProbabilityDensity(defaultMu);
+var scoreTotalAttributes = (info) => {
+  const { attributes } = info.metrics.metadata;
+  const jointProbability = Object.entries(attributes).reduce((acc, [_trait, { metrics }]) => {
+    return acc * metrics.binomial.p;
+  }, 1);
+  const probabilityDensity = gaussianProbabilityDensity(jointProbability);
+  const score = [probabilityDensity, maxProbabilityDensity];
+  return normalize2(score, maxScore2);
+};
+
+// src/lib/rating/criteria/scoring/metadata/metadata.ts
+var attributeScoringCriteria = {
+  "Metadata Attributes Individual": { score: scoreIndividualAttributes, weight: 2 },
+  "Metadata Attributes Total": { score: scoreTotalAttributes, weight: 2 }
+};
+var scoreMetadata = {
+  ...attributeScoringCriteria
+};
+
+// src/lib/rating/criteria/scoring/total.ts
+import { normalize as normalize3 } from "@xyo-network/crypto-nft-score-model";
+var median = 810308398217352e-7;
+var defaultMu2 = Math.log(median);
+var defaultSigma2 = 3;
+var mode = Math.exp(defaultMu2 - Math.pow(defaultSigma2, 2));
+var logNormalProbabilityDensity = (x, mu = defaultMu2, sigma = defaultSigma2) => {
+  if (x <= 0)
+    return 0;
+  const logX = Math.log(x);
+  return 1 / (x * sigma * Math.sqrt(2 * Math.PI)) * Math.exp(-0.5 * Math.pow((logX - mu) / sigma, 2));
+};
+var maxProbabilityDensity2 = logNormalProbabilityDensity(mode);
+var maxScore3 = 10;
+var scoreTotal = (nft) => {
+  const density = logNormalProbabilityDensity(nft.total);
+  const score = [density, maxProbabilityDensity2];
+  return normalize3(score, maxScore3);
+};
+
+// src/lib/rating/criteria/index.ts
+var scoringCriteria = {
+  ...scoreMetadata,
+  Total: { score: scoreTotal, weight: 2 }
+};
+
+// src/lib/rating/analyzeNftCollection.ts
+var analyzeNftCollection = async (nft) => {
+  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);
+        return [key, weighted];
+      })
+    )
+  );
+  return result;
+};
+
+// src/Diviner.ts
+var toNftCollectionScore = (nftCollectionInfo, scores) => {
   const { name, symbol, address, chainId, type } = nftCollectionInfo;
   const metadata = { address, chainId, name, symbol, type };
   return { ...metadata, schema: NftCollectionScoreSchema, scores };
 };
-class NftCollectionScoreDiviner extends AbstractDiviner {
+var NftCollectionScoreDiviner = class extends AbstractDiviner {
   static configSchemas = [NftCollectionScoreDivinerConfigSchema];
   divineHandler = async (payloads) => {
     const nftCollectionInfos = payloads?.filter(isNftCollectionInfo) ?? [];
@@ -28,7 +119,7 @@ class NftCollectionScoreDiviner extends AbstractDiviner {
     );
     return results;
   };
-}
+};
 export {
   NftCollectionScoreDiviner
 };

package/dist/browser/Diviner.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/Diviner.ts"],"sourcesContent":["import { AbstractDiviner } from '@xyo-network/abstract-diviner'\nimport { PayloadHasher } from '@xyo-network/core'\nimport {\n  isNftCollectionInfo,\n  NftCollectionInfo,\n  NftCollectionMetadata,\n  NftCollectionScore,\n  NftCollectionScoreDivinerConfig,\n  NftCollectionScoreDivinerConfigSchema,\n  NftCollectionScoreSchema,\n} from '@xyo-network/crypto-nft-collection-payload-plugin'\nimport { DivinerParams } from '@xyo-network/diviner-model'\nimport { AnyConfigSchema } from '@xyo-network/module'\nimport { Payload } from '@xyo-network/payload-model'\n\nimport { analyzeNftCollection, NftCollectionAnalysis } from './lib'\n\nexport type NftCollectionScoreDivinerParams = DivinerParams<AnyConfigSchema<NftCollectionScoreDivinerConfig>>\n\nconst toNftCollectionScore = (nftCollectionInfo: NftCollectionInfo, scores: NftCollectionAnalysis): NftCollectionScore => {\n  const { name, symbol, address, chainId, type } = nftCollectionInfo\n  const metadata: NftCollectionMetadata = { address, chainId, name, symbol, type }\n  return { ...metadata, schema: NftCollectionScoreSchema, scores }\n}\n\nexport class NftCollectionScoreDiviner<\n  TParams extends NftCollectionScoreDivinerParams = NftCollectionScoreDivinerParams,\n> extends AbstractDiviner<TParams> {\n  static override configSchemas = [NftCollectionScoreDivinerConfigSchema]\n\n  protected override divineHandler = async (payloads?: Payload[]): Promise<Payload[]> => {\n    const nftCollectionInfos = payloads?.filter(isNftCollectionInfo) ?? []\n    const results = await Promise.all(\n      nftCollectionInfos.map<Promise<NftCollectionScore>>(async (nftCollectionInfo) => {\n        const [score, sourceHash] = await Promise.all([\n          // Get score\n          toNftCollectionScore(nftCollectionInfo, await analyzeNftCollection(nftCollectionInfo)),\n          // Hash sources\n          PayloadHasher.hashAsync(nftCollectionInfo),\n        ])\n        return { ...score, schema: NftCollectionScoreSchema, sources: [sourceHash] } as NftCollectionScore\n      }),\n    )\n    return results\n  }\n}\n"],"mappings":"AAAA,SAAS,uBAAuB;AAChC,SAAS,qBAAqB;AAC9B;AAAA,EACE;AAAA,EAKA;AAAA,EACA;AAAA,OACK;AAKP,SAAS,4BAAmD;AAI5D,MAAM,uBAAuB,CAAC,mBAAsC,WAAsD;AACxH,QAAM,EAAE,MAAM,QAAQ,SAAS,SAAS,KAAK,IAAI;AACjD,QAAM,WAAkC,EAAE,SAAS,SAAS,MAAM,QAAQ,KAAK;AAC/E,SAAO,EAAE,GAAG,UAAU,QAAQ,0BAA0B,OAAO;AACjE;AAEO,MAAM,kCAEH,gBAAyB;AAAA,EACjC,OAAgB,gBAAgB,CAAC,qCAAqC;AAAA,EAEnD,gBAAgB,OAAO,aAA6C;AACrF,UAAM,qBAAqB,UAAU,OAAO,mBAAmB,KAAK,CAAC;AACrE,UAAM,UAAU,MAAM,QAAQ;AAAA,MAC5B,mBAAmB,IAAiC,OAAO,sBAAsB;AAC/E,cAAM,CAAC,OAAO,UAAU,IAAI,MAAM,QAAQ,IAAI;AAAA;AAAA,UAE5C,qBAAqB,mBAAmB,MAAM,qBAAqB,iBAAiB,CAAC;AAAA;AAAA,UAErF,cAAc,UAAU,iBAAiB;AAAA,QAC3C,CAAC;AACD,eAAO,EAAE,GAAG,OAAO,QAAQ,0BAA0B,SAAS,CAAC,UAAU,EAAE;AAAA,MAC7E,CAAC;AAAA,IACH;AACA,WAAO;AAAA,EACT;AACF;","names":[]}
+{"version":3,"sources":["../../src/Diviner.ts","../../src/lib/rating/criteria/scoring/metadata/scoreIndividualAttributes.ts","../../src/lib/rating/criteria/scoring/metadata/scoreTotalAttributes.ts","../../src/lib/rating/criteria/scoring/metadata/metadata.ts","../../src/lib/rating/criteria/scoring/total.ts","../../src/lib/rating/criteria/index.ts","../../src/lib/rating/analyzeNftCollection.ts"],"sourcesContent":["import { AbstractDiviner } from '@xyo-network/abstract-diviner'\nimport { PayloadHasher } from '@xyo-network/core'\nimport {\n  isNftCollectionInfo,\n  NftCollectionInfo,\n  NftCollectionMetadata,\n  NftCollectionScore,\n  NftCollectionScoreDivinerConfig,\n  NftCollectionScoreDivinerConfigSchema,\n  NftCollectionScoreSchema,\n} from '@xyo-network/crypto-nft-collection-payload-plugin'\nimport { DivinerParams } from '@xyo-network/diviner-model'\nimport { AnyConfigSchema } from '@xyo-network/module'\nimport { Payload } from '@xyo-network/payload-model'\n\nimport { analyzeNftCollection, NftCollectionAnalysis } from './lib'\n\nexport type NftCollectionScoreDivinerParams = DivinerParams<AnyConfigSchema<NftCollectionScoreDivinerConfig>>\n\nconst toNftCollectionScore = (nftCollectionInfo: NftCollectionInfo, scores: NftCollectionAnalysis): NftCollectionScore => {\n  const { name, symbol, address, chainId, type } = nftCollectionInfo\n  const metadata: NftCollectionMetadata = { address, chainId, name, symbol, type }\n  return { ...metadata, schema: NftCollectionScoreSchema, scores }\n}\n\nexport class NftCollectionScoreDiviner<\n  TParams extends NftCollectionScoreDivinerParams = NftCollectionScoreDivinerParams,\n> extends AbstractDiviner<TParams> {\n  static override configSchemas = [NftCollectionScoreDivinerConfigSchema]\n\n  protected override divineHandler = async (payloads?: Payload[]): Promise<Payload[]> => {\n    const nftCollectionInfos = payloads?.filter(isNftCollectionInfo) ?? []\n    const results = await Promise.all(\n      nftCollectionInfos.map<Promise<NftCollectionScore>>(async (nftCollectionInfo) => {\n        const [score, sourceHash] = await Promise.all([\n          // Get score\n          toNftCollectionScore(nftCollectionInfo, await analyzeNftCollection(nftCollectionInfo)),\n          // Hash sources\n          PayloadHasher.hashAsync(nftCollectionInfo),\n        ])\n        return { ...score, schema: NftCollectionScoreSchema, sources: [sourceHash] } as NftCollectionScore\n      }),\n    )\n    return results\n  }\n}\n","import { NftCollectionAttributeMetrics } from '@xyo-network/crypto-nft-collection-payload-plugin'\nimport { normalize, Score } from '@xyo-network/crypto-nft-score-model'\n\nconst maxScore = 10\n\nexport const scoreIndividualAttributes = (info: NftCollectionAttributeMetrics): Score => {\n  const { attributes } = info.metrics.metadata\n  const entries = Object.entries(attributes)\n  if (entries.length === 0) return [0, maxScore]\n  const scores = Object.entries(attributes)\n    .map(([_trait, { values }]) => {\n      return Object.entries(values).map<Score>(([_traitValue, metrics]) => {\n        const rarity = Math.min(Math.round((1 - metrics.binomial.p) * maxScore), maxScore)\n        return [rarity, maxScore]\n      })\n    })\n    .flat()\n  const total = scores.reduce<Score>(([a, b], [c, d]) => [a + c, b + d], [0, 0])\n  return normalize(total, maxScore)\n}\n","import { NftCollectionAttributeMetrics } from '@xyo-network/crypto-nft-collection-payload-plugin'\nimport { normalize, Score } from '@xyo-network/crypto-nft-score-model'\n\nconst maxScore = 10\n\n/**\n * Mean: What value is the distribution centered around\n */\nconst defaultMu = 0.15\n\n/**\n * Standard Deviation: How spread out is the distribution\n */\nconst defaultSigma = 0.1\n\n/**\n * Calculates the Gaussian probability density\n * @param x\n * @param mu Mean\n * @param sigma Standard Deviation\n * @returns\n */\nconst gaussianProbabilityDensity = (x: number, mu: number = defaultMu, sigma: number = defaultSigma): number => {\n  const sqrtTwoPi = Math.sqrt(2 * Math.PI)\n  const denominator = sigma * sqrtTwoPi\n  const power = -0.5 * Math.pow((x - mu) / sigma, 2)\n  return (1 / denominator) * Math.exp(power)\n}\n\n/**\n * For a Gaussian distribution, the peak of the distribution is the mean\n */\nconst maxProbabilityDensity = gaussianProbabilityDensity(defaultMu)\n\n/**\n * We're working on some assumptions here:\n *\n * - If you have a 100% chance of getting a trait, everyone get's a trophy\n * - If you have a 50% chance of getting a trait, it's not rare\n * - If you have a 0% chance of getting a trait, it's not fun\n *\n * So we're looking for something Pareto-ish (somewhere between\n * 80/20 or 90/10) as that's a good & sustainable model for the\n * distribution of many traits in real life.\n * However, we also don't want to maximally reward collections\n * that have a lot of single attributes distributed uniformly\n * (basically a 0% trait probably) as that's perfectly entropic\n * but not very interesting (some overlap is desirable).\n * So we're using a Gaussian distribution to model the\n * probability density of the joint probability of all traits\n * centered around 15%.\n * @param info\n * @returns\n */\nexport const scoreTotalAttributes = (info: NftCollectionAttributeMetrics): Score => {\n  const { attributes } = info.metrics.metadata\n  // This has somewhat of a filtering function by causing anything with 100% probability to\n  // add no value to the end score\n  const jointProbability = Object.entries(attributes).reduce((acc, [_trait, { metrics }]) => {\n    return acc * metrics.binomial.p\n  }, 1)\n  const probabilityDensity = gaussianProbabilityDensity(jointProbability)\n  const score: Score = [probabilityDensity, maxProbabilityDensity]\n  return normalize(score, maxScore)\n}\n","import { NftCollectionInfo } from '@xyo-network/crypto-nft-collection-payload-plugin'\nimport { WeightedScoringCriteria } from '@xyo-network/crypto-nft-score-model'\n\nimport { scoreIndividualAttributes } from './scoreIndividualAttributes'\nimport { scoreTotalAttributes } from './scoreTotalAttributes'\n\nexport const attributeScoringCriteria: { [key: string]: WeightedScoringCriteria<NftCollectionInfo> } = {\n  'Metadata Attributes Individual': { score: scoreIndividualAttributes, weight: 2 },\n  'Metadata Attributes Total': { score: scoreTotalAttributes, weight: 2 },\n}\n\nexport const scoreMetadata: { [key: string]: WeightedScoringCriteria<NftCollectionInfo> } = {\n  ...attributeScoringCriteria,\n}\n","import { NftCollectionCount } from '@xyo-network/crypto-nft-collection-payload-plugin'\nimport { normalize, Score } from '@xyo-network/crypto-nft-score-model'\n\n/**\n * This \"magic\" value was obtained using Solver in Excel\n * to find the median, with mu/sigma fixed, which maximizes\n * the distribution (the mode for lognormal) at 10,000\n */\nconst median = 81030839.8217352\nconst defaultMu = Math.log(median)\nconst defaultSigma = 3\nconst mode = Math.exp(defaultMu - Math.pow(defaultSigma, 2))\n/**\n * Calculates the log-normal probability density\n * @param x the value at which you want to calculate the probability density\n * @param mu mean of the associated normal distribution\n * @param sigma standard deviation of the associated normal distribution\n * @returns\n */\nconst logNormalProbabilityDensity = (x: number, mu: number = defaultMu, sigma: number = defaultSigma): number => {\n  if (x <= 0) return 0\n  const logX = Math.log(x)\n  return (1 / (x * sigma * Math.sqrt(2 * Math.PI))) * Math.exp(-0.5 * Math.pow((logX - mu) / sigma, 2))\n}\n\n/**\n * For a lognormal distribution, the peak of the distribution is the mode\n */\nconst maxProbabilityDensity = logNormalProbabilityDensity(mode)\n\nconst maxScore = 10\n\n/**\n * We're working on some assumptions here:\n * - If there's < 1000 NFTs in your collection it starts becoming too niche\n * - If there's > 20,000 NFTs in your collection it starts becoming too broad\n * So there's a sweet spot somewhere between 2000 and 10,000\n * where a collection has enough NFTs to be interesting, but\n * not so many that it's teetering on a diluted money grab.\n * To model that we're using a log-normal distribution optimized\n * to maximally reward collections in the aforementioned range\n * @param nft\n * @returns\n */\nexport const scoreTotal = (nft: NftCollectionCount): Score => {\n  const density = logNormalProbabilityDensity(nft.total)\n  const score: Score = [density, maxProbabilityDensity]\n  return normalize(score, maxScore)\n}\n","import { NftCollectionInfo } from '@xyo-network/crypto-nft-collection-payload-plugin'\nimport { WeightedScoringCriteria } from '@xyo-network/crypto-nft-score-model'\n\nimport { scoreMetadata, scoreTotal } from './scoring'\n\nexport const scoringCriteria: { [key: string]: WeightedScoringCriteria<NftCollectionInfo> } = {\n  ...scoreMetadata,\n  Total: { score: scoreTotal, weight: 2 },\n}\n","import { NftCollectionInfo } from '@xyo-network/crypto-nft-collection-payload-plugin'\nimport { Score } from '@xyo-network/crypto-nft-score-model'\n\nimport { scoringCriteria } from './criteria'\n\nexport type ScoringCriteriaKey = keyof typeof scoringCriteria & PropertyKey\n\nexport type NftCollectionAnalysis = {\n  [key in ScoringCriteriaKey]: Score\n}\n\nexport const analyzeNftCollection = async (\n  /**\n   * The NFT to evaluate\n   */\n  nft: NftCollectionInfo,\n): Promise<NftCollectionAnalysis> => {\n  const result = Object.fromEntries(\n    await Promise.all(\n      Object.entries(scoringCriteria).map(async ([key, { score, weight }]) => {\n        const rawScore = await score(nft)\n        const weighted = rawScore.map((v) => v * weight) as Score\n        return [key, weighted] as const\n      }),\n    ),\n  ) as NftCollectionAnalysis\n  return result\n}\n"],"mappings":";AAAA,SAAS,uBAAuB;AAChC,SAAS,qBAAqB;AAC9B;AAAA,EACE;AAAA,EAKA;AAAA,EACA;AAAA,OACK;;;ACTP,SAAS,iBAAwB;AAEjC,IAAM,WAAW;AAEV,IAAM,4BAA4B,CAAC,SAA+C;AACvF,QAAM,EAAE,WAAW,IAAI,KAAK,QAAQ;AACpC,QAAM,UAAU,OAAO,QAAQ,UAAU;AACzC,MAAI,QAAQ,WAAW;AAAG,WAAO,CAAC,GAAG,QAAQ;AAC7C,QAAM,SAAS,OAAO,QAAQ,UAAU,EACrC,IAAI,CAAC,CAAC,QAAQ,EAAE,OAAO,CAAC,MAAM;AAC7B,WAAO,OAAO,QAAQ,MAAM,EAAE,IAAW,CAAC,CAAC,aAAa,OAAO,MAAM;AACnE,YAAM,SAAS,KAAK,IAAI,KAAK,OAAO,IAAI,QAAQ,SAAS,KAAK,QAAQ,GAAG,QAAQ;AACjF,aAAO,CAAC,QAAQ,QAAQ;AAAA,IAC1B,CAAC;AAAA,EACH,CAAC,EACA,KAAK;AACR,QAAM,QAAQ,OAAO,OAAc,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AAC7E,SAAO,UAAU,OAAO,QAAQ;AAClC;;;AClBA,SAAS,aAAAA,kBAAwB;AAEjC,IAAMC,YAAW;AAKjB,IAAM,YAAY;AAKlB,IAAM,eAAe;AASrB,IAAM,6BAA6B,CAAC,GAAW,KAAa,WAAW,QAAgB,iBAAyB;AAC9G,QAAM,YAAY,KAAK,KAAK,IAAI,KAAK,EAAE;AACvC,QAAM,cAAc,QAAQ;AAC5B,QAAM,QAAQ,OAAO,KAAK,KAAK,IAAI,MAAM,OAAO,CAAC;AACjD,SAAQ,IAAI,cAAe,KAAK,IAAI,KAAK;AAC3C;AAKA,IAAM,wBAAwB,2BAA2B,SAAS;AAsB3D,IAAM,uBAAuB,CAAC,SAA+C;AAClF,QAAM,EAAE,WAAW,IAAI,KAAK,QAAQ;AAGpC,QAAM,mBAAmB,OAAO,QAAQ,UAAU,EAAE,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,QAAQ,CAAC,MAAM;AACzF,WAAO,MAAM,QAAQ,SAAS;AAAA,EAChC,GAAG,CAAC;AACJ,QAAM,qBAAqB,2BAA2B,gBAAgB;AACtE,QAAM,QAAe,CAAC,oBAAoB,qBAAqB;AAC/D,SAAOD,WAAU,OAAOC,SAAQ;AAClC;;;AC1DO,IAAM,2BAA0F;AAAA,EACrG,kCAAkC,EAAE,OAAO,2BAA2B,QAAQ,EAAE;AAAA,EAChF,6BAA6B,EAAE,OAAO,sBAAsB,QAAQ,EAAE;AACxE;AAEO,IAAM,gBAA+E;AAAA,EAC1F,GAAG;AACL;;;ACZA,SAAS,aAAAC,kBAAwB;AAOjC,IAAM,SAAS;AACf,IAAMC,aAAY,KAAK,IAAI,MAAM;AACjC,IAAMC,gBAAe;AACrB,IAAM,OAAO,KAAK,IAAID,aAAY,KAAK,IAAIC,eAAc,CAAC,CAAC;AAQ3D,IAAM,8BAA8B,CAAC,GAAW,KAAaD,YAAW,QAAgBC,kBAAyB;AAC/G,MAAI,KAAK;AAAG,WAAO;AACnB,QAAM,OAAO,KAAK,IAAI,CAAC;AACvB,SAAQ,KAAK,IAAI,QAAQ,KAAK,KAAK,IAAI,KAAK,EAAE,KAAM,KAAK,IAAI,OAAO,KAAK,KAAK,OAAO,MAAM,OAAO,CAAC,CAAC;AACtG;AAKA,IAAMC,yBAAwB,4BAA4B,IAAI;AAE9D,IAAMC,YAAW;AAcV,IAAM,aAAa,CAAC,QAAmC;AAC5D,QAAM,UAAU,4BAA4B,IAAI,KAAK;AACrD,QAAM,QAAe,CAAC,SAASD,sBAAqB;AACpD,SAAOH,WAAU,OAAOI,SAAQ;AAClC;;;AC3CO,IAAM,kBAAiF;AAAA,EAC5F,GAAG;AAAA,EACH,OAAO,EAAE,OAAO,YAAY,QAAQ,EAAE;AACxC;;;ACGO,IAAM,uBAAuB,OAIlC,QACmC;AACnC,QAAM,SAAS,OAAO;AAAA,IACpB,MAAM,QAAQ;AAAA,MACZ,OAAO,QAAQ,eAAe,EAAE,IAAI,OAAO,CAAC,KAAK,EAAE,OAAO,OAAO,CAAC,MAAM;AACtE,cAAM,WAAW,MAAM,MAAM,GAAG;AAChC,cAAM,WAAW,SAAS,IAAI,CAAC,MAAM,IAAI,MAAM;AAC/C,eAAO,CAAC,KAAK,QAAQ;AAAA,MACvB,CAAC;AAAA,IACH;AAAA,EACF;AACA,SAAO;AACT;;;ANRA,IAAM,uBAAuB,CAAC,mBAAsC,WAAsD;AACxH,QAAM,EAAE,MAAM,QAAQ,SAAS,SAAS,KAAK,IAAI;AACjD,QAAM,WAAkC,EAAE,SAAS,SAAS,MAAM,QAAQ,KAAK;AAC/E,SAAO,EAAE,GAAG,UAAU,QAAQ,0BAA0B,OAAO;AACjE;AAEO,IAAM,4BAAN,cAEG,gBAAyB;AAAA,EACjC,OAAgB,gBAAgB,CAAC,qCAAqC;AAAA,EAEnD,gBAAgB,OAAO,aAA6C;AACrF,UAAM,qBAAqB,UAAU,OAAO,mBAAmB,KAAK,CAAC;AACrE,UAAM,UAAU,MAAM,QAAQ;AAAA,MAC5B,mBAAmB,IAAiC,OAAO,sBAAsB;AAC/E,cAAM,CAAC,OAAO,UAAU,IAAI,MAAM,QAAQ,IAAI;AAAA;AAAA,UAE5C,qBAAqB,mBAAmB,MAAM,qBAAqB,iBAAiB,CAAC;AAAA;AAAA,UAErF,cAAc,UAAU,iBAAiB;AAAA,QAC3C,CAAC;AACD,eAAO,EAAE,GAAG,OAAO,QAAQ,0BAA0B,SAAS,CAAC,UAAU,EAAE;AAAA,MAC7E,CAAC;AAAA,IACH;AACA,WAAO;AAAA,EACT;AACF;","names":["normalize","maxScore","normalize","defaultMu","defaultSigma","maxProbabilityDensity","maxScore"]}

package/dist/browser/Plugin.js

@@ -1,8 +1,133 @@
+// src/Plugin.ts
 import { NftSchema } from "@xyo-network/crypto-nft-payload-plugin";
 import { PayloadSetSchema } from "@xyo-network/payload-model";
 import { createPayloadSetDivinerPlugin } from "@xyo-network/payloadset-plugin";
-import { NftCollectionScoreDiviner } from "./Diviner";
-const NftCollectionScoreDivinerPlugin = () => createPayloadSetDivinerPlugin(
+
+// src/Diviner.ts
+import { AbstractDiviner } from "@xyo-network/abstract-diviner";
+import { PayloadHasher } from "@xyo-network/core";
+import {
+  isNftCollectionInfo,
+  NftCollectionScoreDivinerConfigSchema,
+  NftCollectionScoreSchema
+} from "@xyo-network/crypto-nft-collection-payload-plugin";
+
+// src/lib/rating/criteria/scoring/metadata/scoreIndividualAttributes.ts
+import { normalize } from "@xyo-network/crypto-nft-score-model";
+var maxScore = 10;
+var scoreIndividualAttributes = (info) => {
+  const { attributes } = info.metrics.metadata;
+  const entries = Object.entries(attributes);
+  if (entries.length === 0)
+    return [0, maxScore];
+  const scores = Object.entries(attributes).map(([_trait, { values }]) => {
+    return Object.entries(values).map(([_traitValue, metrics]) => {
+      const rarity = Math.min(Math.round((1 - metrics.binomial.p) * maxScore), maxScore);
+      return [rarity, maxScore];
+    });
+  }).flat();
+  const total = scores.reduce(([a, b], [c, d]) => [a + c, b + d], [0, 0]);
+  return normalize(total, maxScore);
+};
+
+// src/lib/rating/criteria/scoring/metadata/scoreTotalAttributes.ts
+import { normalize as normalize2 } from "@xyo-network/crypto-nft-score-model";
+var maxScore2 = 10;
+var defaultMu = 0.15;
+var defaultSigma = 0.1;
+var gaussianProbabilityDensity = (x, mu = defaultMu, sigma = defaultSigma) => {
+  const sqrtTwoPi = Math.sqrt(2 * Math.PI);
+  const denominator = sigma * sqrtTwoPi;
+  const power = -0.5 * Math.pow((x - mu) / sigma, 2);
+  return 1 / denominator * Math.exp(power);
+};
+var maxProbabilityDensity = gaussianProbabilityDensity(defaultMu);
+var scoreTotalAttributes = (info) => {
+  const { attributes } = info.metrics.metadata;
+  const jointProbability = Object.entries(attributes).reduce((acc, [_trait, { metrics }]) => {
+    return acc * metrics.binomial.p;
+  }, 1);
+  const probabilityDensity = gaussianProbabilityDensity(jointProbability);
+  const score = [probabilityDensity, maxProbabilityDensity];
+  return normalize2(score, maxScore2);
+};
+
+// src/lib/rating/criteria/scoring/metadata/metadata.ts
+var attributeScoringCriteria = {
+  "Metadata Attributes Individual": { score: scoreIndividualAttributes, weight: 2 },
+  "Metadata Attributes Total": { score: scoreTotalAttributes, weight: 2 }
+};
+var scoreMetadata = {
+  ...attributeScoringCriteria
+};
+
+// src/lib/rating/criteria/scoring/total.ts
+import { normalize as normalize3 } from "@xyo-network/crypto-nft-score-model";
+var median = 810308398217352e-7;
+var defaultMu2 = Math.log(median);
+var defaultSigma2 = 3;
+var mode = Math.exp(defaultMu2 - Math.pow(defaultSigma2, 2));
+var logNormalProbabilityDensity = (x, mu = defaultMu2, sigma = defaultSigma2) => {
+  if (x <= 0)
+    return 0;
+  const logX = Math.log(x);
+  return 1 / (x * sigma * Math.sqrt(2 * Math.PI)) * Math.exp(-0.5 * Math.pow((logX - mu) / sigma, 2));
+};
+var maxProbabilityDensity2 = logNormalProbabilityDensity(mode);
+var maxScore3 = 10;
+var scoreTotal = (nft) => {
+  const density = logNormalProbabilityDensity(nft.total);
+  const score = [density, maxProbabilityDensity2];
+  return normalize3(score, maxScore3);
+};
+
+// src/lib/rating/criteria/index.ts
+var scoringCriteria = {
+  ...scoreMetadata,
+  Total: { score: scoreTotal, weight: 2 }
+};
+
+// src/lib/rating/analyzeNftCollection.ts
+var analyzeNftCollection = async (nft) => {
+  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);
+        return [key, weighted];
+      })
+    )
+  );
+  return result;
+};
+
+// src/Diviner.ts
+var toNftCollectionScore = (nftCollectionInfo, scores) => {
+  const { name, symbol, address, chainId, type } = nftCollectionInfo;
+  const metadata = { address, chainId, name, symbol, type };
+  return { ...metadata, schema: NftCollectionScoreSchema, scores };
+};
+var NftCollectionScoreDiviner = class extends AbstractDiviner {
+  static configSchemas = [NftCollectionScoreDivinerConfigSchema];
+  divineHandler = async (payloads) => {
+    const nftCollectionInfos = payloads?.filter(isNftCollectionInfo) ?? [];
+    const results = await Promise.all(
+      nftCollectionInfos.map(async (nftCollectionInfo) => {
+        const [score, sourceHash] = await Promise.all([
+          // Get score
+          toNftCollectionScore(nftCollectionInfo, await analyzeNftCollection(nftCollectionInfo)),
+          // Hash sources
+          PayloadHasher.hashAsync(nftCollectionInfo)
+        ]);
+        return { ...score, schema: NftCollectionScoreSchema, sources: [sourceHash] };
+      })
+    );
+    return results;
+  };
+};
+
+// src/Plugin.ts
+var NftCollectionScoreDivinerPlugin = () => createPayloadSetDivinerPlugin(
   { required: { [NftSchema]: 1 }, schema: PayloadSetSchema },
   {
     diviner: async (params) => {

package/dist/browser/Plugin.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/Plugin.ts"],"sourcesContent":["import { NftSchema } from '@xyo-network/crypto-nft-payload-plugin'\nimport { PayloadSetSchema } from '@xyo-network/payload-model'\nimport { createPayloadSetDivinerPlugin } from '@xyo-network/payloadset-plugin'\n\nimport { NftCollectionScoreDiviner } from './Diviner'\n\nexport const NftCollectionScoreDivinerPlugin = () =>\n  createPayloadSetDivinerPlugin<NftCollectionScoreDiviner>(\n    { required: { [NftSchema]: 1 }, schema: PayloadSetSchema },\n    {\n      diviner: async (params) => {\n        const result = await NftCollectionScoreDiviner.create(params)\n        return result\n      },\n    },\n  )\n"],"mappings":"AAAA,SAAS,iBAAiB;AAC1B,SAAS,wBAAwB;AACjC,SAAS,qCAAqC;AAE9C,SAAS,iCAAiC;AAEnC,MAAM,kCAAkC,MAC7C;AAAA,EACE,EAAE,UAAU,EAAE,CAAC,SAAS,GAAG,EAAE,GAAG,QAAQ,iBAAiB;AAAA,EACzD;AAAA,IACE,SAAS,OAAO,WAAW;AACzB,YAAM,SAAS,MAAM,0BAA0B,OAAO,MAAM;AAC5D,aAAO;AAAA,IACT;AAAA,EACF;AACF;","names":[]}
+{"version":3,"sources":["../../src/Plugin.ts","../../src/Diviner.ts","../../src/lib/rating/criteria/scoring/metadata/scoreIndividualAttributes.ts","../../src/lib/rating/criteria/scoring/metadata/scoreTotalAttributes.ts","../../src/lib/rating/criteria/scoring/metadata/metadata.ts","../../src/lib/rating/criteria/scoring/total.ts","../../src/lib/rating/criteria/index.ts","../../src/lib/rating/analyzeNftCollection.ts"],"sourcesContent":["import { NftSchema } from '@xyo-network/crypto-nft-payload-plugin'\nimport { PayloadSetSchema } from '@xyo-network/payload-model'\nimport { createPayloadSetDivinerPlugin } from '@xyo-network/payloadset-plugin'\n\nimport { NftCollectionScoreDiviner } from './Diviner'\n\nexport const NftCollectionScoreDivinerPlugin = () =>\n  createPayloadSetDivinerPlugin<NftCollectionScoreDiviner>(\n    { required: { [NftSchema]: 1 }, schema: PayloadSetSchema },\n    {\n      diviner: async (params) => {\n        const result = await NftCollectionScoreDiviner.create(params)\n        return result\n      },\n    },\n  )\n","import { AbstractDiviner } from '@xyo-network/abstract-diviner'\nimport { PayloadHasher } from '@xyo-network/core'\nimport {\n  isNftCollectionInfo,\n  NftCollectionInfo,\n  NftCollectionMetadata,\n  NftCollectionScore,\n  NftCollectionScoreDivinerConfig,\n  NftCollectionScoreDivinerConfigSchema,\n  NftCollectionScoreSchema,\n} from '@xyo-network/crypto-nft-collection-payload-plugin'\nimport { DivinerParams } from '@xyo-network/diviner-model'\nimport { AnyConfigSchema } from '@xyo-network/module'\nimport { Payload } from '@xyo-network/payload-model'\n\nimport { analyzeNftCollection, NftCollectionAnalysis } from './lib'\n\nexport type NftCollectionScoreDivinerParams = DivinerParams<AnyConfigSchema<NftCollectionScoreDivinerConfig>>\n\nconst toNftCollectionScore = (nftCollectionInfo: NftCollectionInfo, scores: NftCollectionAnalysis): NftCollectionScore => {\n  const { name, symbol, address, chainId, type } = nftCollectionInfo\n  const metadata: NftCollectionMetadata = { address, chainId, name, symbol, type }\n  return { ...metadata, schema: NftCollectionScoreSchema, scores }\n}\n\nexport class NftCollectionScoreDiviner<\n  TParams extends NftCollectionScoreDivinerParams = NftCollectionScoreDivinerParams,\n> extends AbstractDiviner<TParams> {\n  static override configSchemas = [NftCollectionScoreDivinerConfigSchema]\n\n  protected override divineHandler = async (payloads?: Payload[]): Promise<Payload[]> => {\n    const nftCollectionInfos = payloads?.filter(isNftCollectionInfo) ?? []\n    const results = await Promise.all(\n      nftCollectionInfos.map<Promise<NftCollectionScore>>(async (nftCollectionInfo) => {\n        const [score, sourceHash] = await Promise.all([\n          // Get score\n          toNftCollectionScore(nftCollectionInfo, await analyzeNftCollection(nftCollectionInfo)),\n          // Hash sources\n          PayloadHasher.hashAsync(nftCollectionInfo),\n        ])\n        return { ...score, schema: NftCollectionScoreSchema, sources: [sourceHash] } as NftCollectionScore\n      }),\n    )\n    return results\n  }\n}\n","import { NftCollectionAttributeMetrics } from '@xyo-network/crypto-nft-collection-payload-plugin'\nimport { normalize, Score } from '@xyo-network/crypto-nft-score-model'\n\nconst maxScore = 10\n\nexport const scoreIndividualAttributes = (info: NftCollectionAttributeMetrics): Score => {\n  const { attributes } = info.metrics.metadata\n  const entries = Object.entries(attributes)\n  if (entries.length === 0) return [0, maxScore]\n  const scores = Object.entries(attributes)\n    .map(([_trait, { values }]) => {\n      return Object.entries(values).map<Score>(([_traitValue, metrics]) => {\n        const rarity = Math.min(Math.round((1 - metrics.binomial.p) * maxScore), maxScore)\n        return [rarity, maxScore]\n      })\n    })\n    .flat()\n  const total = scores.reduce<Score>(([a, b], [c, d]) => [a + c, b + d], [0, 0])\n  return normalize(total, maxScore)\n}\n","import { NftCollectionAttributeMetrics } from '@xyo-network/crypto-nft-collection-payload-plugin'\nimport { normalize, Score } from '@xyo-network/crypto-nft-score-model'\n\nconst maxScore = 10\n\n/**\n * Mean: What value is the distribution centered around\n */\nconst defaultMu = 0.15\n\n/**\n * Standard Deviation: How spread out is the distribution\n */\nconst defaultSigma = 0.1\n\n/**\n * Calculates the Gaussian probability density\n * @param x\n * @param mu Mean\n * @param sigma Standard Deviation\n * @returns\n */\nconst gaussianProbabilityDensity = (x: number, mu: number = defaultMu, sigma: number = defaultSigma): number => {\n  const sqrtTwoPi = Math.sqrt(2 * Math.PI)\n  const denominator = sigma * sqrtTwoPi\n  const power = -0.5 * Math.pow((x - mu) / sigma, 2)\n  return (1 / denominator) * Math.exp(power)\n}\n\n/**\n * For a Gaussian distribution, the peak of the distribution is the mean\n */\nconst maxProbabilityDensity = gaussianProbabilityDensity(defaultMu)\n\n/**\n * We're working on some assumptions here:\n *\n * - If you have a 100% chance of getting a trait, everyone get's a trophy\n * - If you have a 50% chance of getting a trait, it's not rare\n * - If you have a 0% chance of getting a trait, it's not fun\n *\n * So we're looking for something Pareto-ish (somewhere between\n * 80/20 or 90/10) as that's a good & sustainable model for the\n * distribution of many traits in real life.\n * However, we also don't want to maximally reward collections\n * that have a lot of single attributes distributed uniformly\n * (basically a 0% trait probably) as that's perfectly entropic\n * but not very interesting (some overlap is desirable).\n * So we're using a Gaussian distribution to model the\n * probability density of the joint probability of all traits\n * centered around 15%.\n * @param info\n * @returns\n */\nexport const scoreTotalAttributes = (info: NftCollectionAttributeMetrics): Score => {\n  const { attributes } = info.metrics.metadata\n  // This has somewhat of a filtering function by causing anything with 100% probability to\n  // add no value to the end score\n  const jointProbability = Object.entries(attributes).reduce((acc, [_trait, { metrics }]) => {\n    return acc * metrics.binomial.p\n  }, 1)\n  const probabilityDensity = gaussianProbabilityDensity(jointProbability)\n  const score: Score = [probabilityDensity, maxProbabilityDensity]\n  return normalize(score, maxScore)\n}\n","import { NftCollectionInfo } from '@xyo-network/crypto-nft-collection-payload-plugin'\nimport { WeightedScoringCriteria } from '@xyo-network/crypto-nft-score-model'\n\nimport { scoreIndividualAttributes } from './scoreIndividualAttributes'\nimport { scoreTotalAttributes } from './scoreTotalAttributes'\n\nexport const attributeScoringCriteria: { [key: string]: WeightedScoringCriteria<NftCollectionInfo> } = {\n  'Metadata Attributes Individual': { score: scoreIndividualAttributes, weight: 2 },\n  'Metadata Attributes Total': { score: scoreTotalAttributes, weight: 2 },\n}\n\nexport const scoreMetadata: { [key: string]: WeightedScoringCriteria<NftCollectionInfo> } = {\n  ...attributeScoringCriteria,\n}\n","import { NftCollectionCount } from '@xyo-network/crypto-nft-collection-payload-plugin'\nimport { normalize, Score } from '@xyo-network/crypto-nft-score-model'\n\n/**\n * This \"magic\" value was obtained using Solver in Excel\n * to find the median, with mu/sigma fixed, which maximizes\n * the distribution (the mode for lognormal) at 10,000\n */\nconst median = 81030839.8217352\nconst defaultMu = Math.log(median)\nconst defaultSigma = 3\nconst mode = Math.exp(defaultMu - Math.pow(defaultSigma, 2))\n/**\n * Calculates the log-normal probability density\n * @param x the value at which you want to calculate the probability density\n * @param mu mean of the associated normal distribution\n * @param sigma standard deviation of the associated normal distribution\n * @returns\n */\nconst logNormalProbabilityDensity = (x: number, mu: number = defaultMu, sigma: number = defaultSigma): number => {\n  if (x <= 0) return 0\n  const logX = Math.log(x)\n  return (1 / (x * sigma * Math.sqrt(2 * Math.PI))) * Math.exp(-0.5 * Math.pow((logX - mu) / sigma, 2))\n}\n\n/**\n * For a lognormal distribution, the peak of the distribution is the mode\n */\nconst maxProbabilityDensity = logNormalProbabilityDensity(mode)\n\nconst maxScore = 10\n\n/**\n * We're working on some assumptions here:\n * - If there's < 1000 NFTs in your collection it starts becoming too niche\n * - If there's > 20,000 NFTs in your collection it starts becoming too broad\n * So there's a sweet spot somewhere between 2000 and 10,000\n * where a collection has enough NFTs to be interesting, but\n * not so many that it's teetering on a diluted money grab.\n * To model that we're using a log-normal distribution optimized\n * to maximally reward collections in the aforementioned range\n * @param nft\n * @returns\n */\nexport const scoreTotal = (nft: NftCollectionCount): Score => {\n  const density = logNormalProbabilityDensity(nft.total)\n  const score: Score = [density, maxProbabilityDensity]\n  return normalize(score, maxScore)\n}\n","import { NftCollectionInfo } from '@xyo-network/crypto-nft-collection-payload-plugin'\nimport { WeightedScoringCriteria } from '@xyo-network/crypto-nft-score-model'\n\nimport { scoreMetadata, scoreTotal } from './scoring'\n\nexport const scoringCriteria: { [key: string]: WeightedScoringCriteria<NftCollectionInfo> } = {\n  ...scoreMetadata,\n  Total: { score: scoreTotal, weight: 2 },\n}\n","import { NftCollectionInfo } from '@xyo-network/crypto-nft-collection-payload-plugin'\nimport { Score } from '@xyo-network/crypto-nft-score-model'\n\nimport { scoringCriteria } from './criteria'\n\nexport type ScoringCriteriaKey = keyof typeof scoringCriteria & PropertyKey\n\nexport type NftCollectionAnalysis = {\n  [key in ScoringCriteriaKey]: Score\n}\n\nexport const analyzeNftCollection = async (\n  /**\n   * The NFT to evaluate\n   */\n  nft: NftCollectionInfo,\n): Promise<NftCollectionAnalysis> => {\n  const result = Object.fromEntries(\n    await Promise.all(\n      Object.entries(scoringCriteria).map(async ([key, { score, weight }]) => {\n        const rawScore = await score(nft)\n        const weighted = rawScore.map((v) => v * weight) as Score\n        return [key, weighted] as const\n      }),\n    ),\n  ) as NftCollectionAnalysis\n  return result\n}\n"],"mappings":";AAAA,SAAS,iBAAiB;AAC1B,SAAS,wBAAwB;AACjC,SAAS,qCAAqC;;;ACF9C,SAAS,uBAAuB;AAChC,SAAS,qBAAqB;AAC9B;AAAA,EACE;AAAA,EAKA;AAAA,EACA;AAAA,OACK;;;ACTP,SAAS,iBAAwB;AAEjC,IAAM,WAAW;AAEV,IAAM,4BAA4B,CAAC,SAA+C;AACvF,QAAM,EAAE,WAAW,IAAI,KAAK,QAAQ;AACpC,QAAM,UAAU,OAAO,QAAQ,UAAU;AACzC,MAAI,QAAQ,WAAW;AAAG,WAAO,CAAC,GAAG,QAAQ;AAC7C,QAAM,SAAS,OAAO,QAAQ,UAAU,EACrC,IAAI,CAAC,CAAC,QAAQ,EAAE,OAAO,CAAC,MAAM;AAC7B,WAAO,OAAO,QAAQ,MAAM,EAAE,IAAW,CAAC,CAAC,aAAa,OAAO,MAAM;AACnE,YAAM,SAAS,KAAK,IAAI,KAAK,OAAO,IAAI,QAAQ,SAAS,KAAK,QAAQ,GAAG,QAAQ;AACjF,aAAO,CAAC,QAAQ,QAAQ;AAAA,IAC1B,CAAC;AAAA,EACH,CAAC,EACA,KAAK;AACR,QAAM,QAAQ,OAAO,OAAc,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AAC7E,SAAO,UAAU,OAAO,QAAQ;AAClC;;;AClBA,SAAS,aAAAA,kBAAwB;AAEjC,IAAMC,YAAW;AAKjB,IAAM,YAAY;AAKlB,IAAM,eAAe;AASrB,IAAM,6BAA6B,CAAC,GAAW,KAAa,WAAW,QAAgB,iBAAyB;AAC9G,QAAM,YAAY,KAAK,KAAK,IAAI,KAAK,EAAE;AACvC,QAAM,cAAc,QAAQ;AAC5B,QAAM,QAAQ,OAAO,KAAK,KAAK,IAAI,MAAM,OAAO,CAAC;AACjD,SAAQ,IAAI,cAAe,KAAK,IAAI,KAAK;AAC3C;AAKA,IAAM,wBAAwB,2BAA2B,SAAS;AAsB3D,IAAM,uBAAuB,CAAC,SAA+C;AAClF,QAAM,EAAE,WAAW,IAAI,KAAK,QAAQ;AAGpC,QAAM,mBAAmB,OAAO,QAAQ,UAAU,EAAE,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,QAAQ,CAAC,MAAM;AACzF,WAAO,MAAM,QAAQ,SAAS;AAAA,EAChC,GAAG,CAAC;AACJ,QAAM,qBAAqB,2BAA2B,gBAAgB;AACtE,QAAM,QAAe,CAAC,oBAAoB,qBAAqB;AAC/D,SAAOD,WAAU,OAAOC,SAAQ;AAClC;;;AC1DO,IAAM,2BAA0F;AAAA,EACrG,kCAAkC,EAAE,OAAO,2BAA2B,QAAQ,EAAE;AAAA,EAChF,6BAA6B,EAAE,OAAO,sBAAsB,QAAQ,EAAE;AACxE;AAEO,IAAM,gBAA+E;AAAA,EAC1F,GAAG;AACL;;;ACZA,SAAS,aAAAC,kBAAwB;AAOjC,IAAM,SAAS;AACf,IAAMC,aAAY,KAAK,IAAI,MAAM;AACjC,IAAMC,gBAAe;AACrB,IAAM,OAAO,KAAK,IAAID,aAAY,KAAK,IAAIC,eAAc,CAAC,CAAC;AAQ3D,IAAM,8BAA8B,CAAC,GAAW,KAAaD,YAAW,QAAgBC,kBAAyB;AAC/G,MAAI,KAAK;AAAG,WAAO;AACnB,QAAM,OAAO,KAAK,IAAI,CAAC;AACvB,SAAQ,KAAK,IAAI,QAAQ,KAAK,KAAK,IAAI,KAAK,EAAE,KAAM,KAAK,IAAI,OAAO,KAAK,KAAK,OAAO,MAAM,OAAO,CAAC,CAAC;AACtG;AAKA,IAAMC,yBAAwB,4BAA4B,IAAI;AAE9D,IAAMC,YAAW;AAcV,IAAM,aAAa,CAAC,QAAmC;AAC5D,QAAM,UAAU,4BAA4B,IAAI,KAAK;AACrD,QAAM,QAAe,CAAC,SAASD,sBAAqB;AACpD,SAAOH,WAAU,OAAOI,SAAQ;AAClC;;;AC3CO,IAAM,kBAAiF;AAAA,EAC5F,GAAG;AAAA,EACH,OAAO,EAAE,OAAO,YAAY,QAAQ,EAAE;AACxC;;;ACGO,IAAM,uBAAuB,OAIlC,QACmC;AACnC,QAAM,SAAS,OAAO;AAAA,IACpB,MAAM,QAAQ;AAAA,MACZ,OAAO,QAAQ,eAAe,EAAE,IAAI,OAAO,CAAC,KAAK,EAAE,OAAO,OAAO,CAAC,MAAM;AACtE,cAAM,WAAW,MAAM,MAAM,GAAG;AAChC,cAAM,WAAW,SAAS,IAAI,CAAC,MAAM,IAAI,MAAM;AAC/C,eAAO,CAAC,KAAK,QAAQ;AAAA,MACvB,CAAC;AAAA,IACH;AAAA,EACF;AACA,SAAO;AACT;;;ANRA,IAAM,uBAAuB,CAAC,mBAAsC,WAAsD;AACxH,QAAM,EAAE,MAAM,QAAQ,SAAS,SAAS,KAAK,IAAI;AACjD,QAAM,WAAkC,EAAE,SAAS,SAAS,MAAM,QAAQ,KAAK;AAC/E,SAAO,EAAE,GAAG,UAAU,QAAQ,0BAA0B,OAAO;AACjE;AAEO,IAAM,4BAAN,cAEG,gBAAyB;AAAA,EACjC,OAAgB,gBAAgB,CAAC,qCAAqC;AAAA,EAEnD,gBAAgB,OAAO,aAA6C;AACrF,UAAM,qBAAqB,UAAU,OAAO,mBAAmB,KAAK,CAAC;AACrE,UAAM,UAAU,MAAM,QAAQ;AAAA,MAC5B,mBAAmB,IAAiC,OAAO,sBAAsB;AAC/E,cAAM,CAAC,OAAO,UAAU,IAAI,MAAM,QAAQ,IAAI;AAAA;AAAA,UAE5C,qBAAqB,mBAAmB,MAAM,qBAAqB,iBAAiB,CAAC;AAAA;AAAA,UAErF,cAAc,UAAU,iBAAiB;AAAA,QAC3C,CAAC;AACD,eAAO,EAAE,GAAG,OAAO,QAAQ,0BAA0B,SAAS,CAAC,UAAU,EAAE;AAAA,MAC7E,CAAC;AAAA,IACH;AACA,WAAO;AAAA,EACT;AACF;;;ADvCO,IAAM,kCAAkC,MAC7C;AAAA,EACE,EAAE,UAAU,EAAE,CAAC,SAAS,GAAG,EAAE,GAAG,QAAQ,iBAAiB;AAAA,EACzD;AAAA,IACE,SAAS,OAAO,WAAW;AACzB,YAAM,SAAS,MAAM,0BAA0B,OAAO,MAAM;AAC5D,aAAO;AAAA,IACT;AAAA,EACF;AACF;","names":["normalize","maxScore","normalize","defaultMu","defaultSigma","maxProbabilityDensity","maxScore"]}

package/dist/browser/index.js

@@ -1,9 +1,148 @@
-import { NftCollectionScoreDivinerPlugin } from "./Plugin";
-export * from "./Diviner";
-export * from "./lib";
+// src/Plugin.ts
+import { NftSchema } from "@xyo-network/crypto-nft-payload-plugin";
+import { PayloadSetSchema } from "@xyo-network/payload-model";
+import { createPayloadSetDivinerPlugin } from "@xyo-network/payloadset-plugin";
+
+// src/Diviner.ts
+import { AbstractDiviner } from "@xyo-network/abstract-diviner";
+import { PayloadHasher } from "@xyo-network/core";
+import {
+  isNftCollectionInfo,
+  NftCollectionScoreDivinerConfigSchema,
+  NftCollectionScoreSchema
+} from "@xyo-network/crypto-nft-collection-payload-plugin";
+
+// src/lib/rating/criteria/scoring/metadata/scoreIndividualAttributes.ts
+import { normalize } from "@xyo-network/crypto-nft-score-model";
+var maxScore = 10;
+var scoreIndividualAttributes = (info) => {
+  const { attributes } = info.metrics.metadata;
+  const entries = Object.entries(attributes);
+  if (entries.length === 0)
+    return [0, maxScore];
+  const scores = Object.entries(attributes).map(([_trait, { values }]) => {
+    return Object.entries(values).map(([_traitValue, metrics]) => {
+      const rarity = Math.min(Math.round((1 - metrics.binomial.p) * maxScore), maxScore);
+      return [rarity, maxScore];
+    });
+  }).flat();
+  const total = scores.reduce(([a, b], [c, d]) => [a + c, b + d], [0, 0]);
+  return normalize(total, maxScore);
+};
+
+// src/lib/rating/criteria/scoring/metadata/scoreTotalAttributes.ts
+import { normalize as normalize2 } from "@xyo-network/crypto-nft-score-model";
+var maxScore2 = 10;
+var defaultMu = 0.15;
+var defaultSigma = 0.1;
+var gaussianProbabilityDensity = (x, mu = defaultMu, sigma = defaultSigma) => {
+  const sqrtTwoPi = Math.sqrt(2 * Math.PI);
+  const denominator = sigma * sqrtTwoPi;
+  const power = -0.5 * Math.pow((x - mu) / sigma, 2);
+  return 1 / denominator * Math.exp(power);
+};
+var maxProbabilityDensity = gaussianProbabilityDensity(defaultMu);
+var scoreTotalAttributes = (info) => {
+  const { attributes } = info.metrics.metadata;
+  const jointProbability = Object.entries(attributes).reduce((acc, [_trait, { metrics }]) => {
+    return acc * metrics.binomial.p;
+  }, 1);
+  const probabilityDensity = gaussianProbabilityDensity(jointProbability);
+  const score = [probabilityDensity, maxProbabilityDensity];
+  return normalize2(score, maxScore2);
+};
+
+// src/lib/rating/criteria/scoring/metadata/metadata.ts
+var attributeScoringCriteria = {
+  "Metadata Attributes Individual": { score: scoreIndividualAttributes, weight: 2 },
+  "Metadata Attributes Total": { score: scoreTotalAttributes, weight: 2 }
+};
+var scoreMetadata = {
+  ...attributeScoringCriteria
+};
+
+// src/lib/rating/criteria/scoring/total.ts
+import { normalize as normalize3 } from "@xyo-network/crypto-nft-score-model";
+var median = 810308398217352e-7;
+var defaultMu2 = Math.log(median);
+var defaultSigma2 = 3;
+var mode = Math.exp(defaultMu2 - Math.pow(defaultSigma2, 2));
+var logNormalProbabilityDensity = (x, mu = defaultMu2, sigma = defaultSigma2) => {
+  if (x <= 0)
+    return 0;
+  const logX = Math.log(x);
+  return 1 / (x * sigma * Math.sqrt(2 * Math.PI)) * Math.exp(-0.5 * Math.pow((logX - mu) / sigma, 2));
+};
+var maxProbabilityDensity2 = logNormalProbabilityDensity(mode);
+var maxScore3 = 10;
+var scoreTotal = (nft) => {
+  const density = logNormalProbabilityDensity(nft.total);
+  const score = [density, maxProbabilityDensity2];
+  return normalize3(score, maxScore3);
+};
+
+// src/lib/rating/criteria/index.ts
+var scoringCriteria = {
+  ...scoreMetadata,
+  Total: { score: scoreTotal, weight: 2 }
+};
+
+// src/lib/rating/analyzeNftCollection.ts
+var analyzeNftCollection = async (nft) => {
+  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);
+        return [key, weighted];
+      })
+    )
+  );
+  return result;
+};
+
+// src/Diviner.ts
+var toNftCollectionScore = (nftCollectionInfo, scores) => {
+  const { name, symbol, address, chainId, type } = nftCollectionInfo;
+  const metadata = { address, chainId, name, symbol, type };
+  return { ...metadata, schema: NftCollectionScoreSchema, scores };
+};
+var NftCollectionScoreDiviner = class extends AbstractDiviner {
+  static configSchemas = [NftCollectionScoreDivinerConfigSchema];
+  divineHandler = async (payloads) => {
+    const nftCollectionInfos = payloads?.filter(isNftCollectionInfo) ?? [];
+    const results = await Promise.all(
+      nftCollectionInfos.map(async (nftCollectionInfo) => {
+        const [score, sourceHash] = await Promise.all([
+          // Get score
+          toNftCollectionScore(nftCollectionInfo, await analyzeNftCollection(nftCollectionInfo)),
+          // Hash sources
+          PayloadHasher.hashAsync(nftCollectionInfo)
+        ]);
+        return { ...score, schema: NftCollectionScoreSchema, sources: [sourceHash] };
+      })
+    );
+    return results;
+  };
+};
+
+// src/Plugin.ts
+var NftCollectionScoreDivinerPlugin = () => createPayloadSetDivinerPlugin(
+  { required: { [NftSchema]: 1 }, schema: PayloadSetSchema },
+  {
+    diviner: async (params) => {
+      const result = await NftCollectionScoreDiviner.create(params);
+      return result;
+    }
+  }
+);
+
+// src/index.ts
 var src_default = NftCollectionScoreDivinerPlugin;
 export {
+  NftCollectionScoreDiviner,
   NftCollectionScoreDivinerPlugin,
+  analyzeNftCollection,
   src_default as default
 };
 //# sourceMappingURL=index.js.map

package/dist/browser/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/index.ts"],"sourcesContent":["import { NftCollectionScoreDivinerPlugin } from './Plugin'\n\nexport * from './Diviner'\nexport * from './lib'\n\nexport { NftCollectionScoreDivinerPlugin }\n\n// eslint-disable-next-line import/no-default-export\nexport default NftCollectionScoreDivinerPlugin\n"],"mappings":"AAAA,SAAS,uCAAuC;AAEhD,cAAc;AACd,cAAc;AAKd,IAAO,cAAQ;","names":[]}
+{"version":3,"sources":["../../src/Plugin.ts","../../src/Diviner.ts","../../src/lib/rating/criteria/scoring/metadata/scoreIndividualAttributes.ts","../../src/lib/rating/criteria/scoring/metadata/scoreTotalAttributes.ts","../../src/lib/rating/criteria/scoring/metadata/metadata.ts","../../src/lib/rating/criteria/scoring/total.ts","../../src/lib/rating/criteria/index.ts","../../src/lib/rating/analyzeNftCollection.ts","../../src/index.ts"],"sourcesContent":["import { NftSchema } from '@xyo-network/crypto-nft-payload-plugin'\nimport { PayloadSetSchema } from '@xyo-network/payload-model'\nimport { createPayloadSetDivinerPlugin } from '@xyo-network/payloadset-plugin'\n\nimport { NftCollectionScoreDiviner } from './Diviner'\n\nexport const NftCollectionScoreDivinerPlugin = () =>\n  createPayloadSetDivinerPlugin<NftCollectionScoreDiviner>(\n    { required: { [NftSchema]: 1 }, schema: PayloadSetSchema },\n    {\n      diviner: async (params) => {\n        const result = await NftCollectionScoreDiviner.create(params)\n        return result\n      },\n    },\n  )\n","import { AbstractDiviner } from '@xyo-network/abstract-diviner'\nimport { PayloadHasher } from '@xyo-network/core'\nimport {\n  isNftCollectionInfo,\n  NftCollectionInfo,\n  NftCollectionMetadata,\n  NftCollectionScore,\n  NftCollectionScoreDivinerConfig,\n  NftCollectionScoreDivinerConfigSchema,\n  NftCollectionScoreSchema,\n} from '@xyo-network/crypto-nft-collection-payload-plugin'\nimport { DivinerParams } from '@xyo-network/diviner-model'\nimport { AnyConfigSchema } from '@xyo-network/module'\nimport { Payload } from '@xyo-network/payload-model'\n\nimport { analyzeNftCollection, NftCollectionAnalysis } from './lib'\n\nexport type NftCollectionScoreDivinerParams = DivinerParams<AnyConfigSchema<NftCollectionScoreDivinerConfig>>\n\nconst toNftCollectionScore = (nftCollectionInfo: NftCollectionInfo, scores: NftCollectionAnalysis): NftCollectionScore => {\n  const { name, symbol, address, chainId, type } = nftCollectionInfo\n  const metadata: NftCollectionMetadata = { address, chainId, name, symbol, type }\n  return { ...metadata, schema: NftCollectionScoreSchema, scores }\n}\n\nexport class NftCollectionScoreDiviner<\n  TParams extends NftCollectionScoreDivinerParams = NftCollectionScoreDivinerParams,\n> extends AbstractDiviner<TParams> {\n  static override configSchemas = [NftCollectionScoreDivinerConfigSchema]\n\n  protected override divineHandler = async (payloads?: Payload[]): Promise<Payload[]> => {\n    const nftCollectionInfos = payloads?.filter(isNftCollectionInfo) ?? []\n    const results = await Promise.all(\n      nftCollectionInfos.map<Promise<NftCollectionScore>>(async (nftCollectionInfo) => {\n        const [score, sourceHash] = await Promise.all([\n          // Get score\n          toNftCollectionScore(nftCollectionInfo, await analyzeNftCollection(nftCollectionInfo)),\n          // Hash sources\n          PayloadHasher.hashAsync(nftCollectionInfo),\n        ])\n        return { ...score, schema: NftCollectionScoreSchema, sources: [sourceHash] } as NftCollectionScore\n      }),\n    )\n    return results\n  }\n}\n","import { NftCollectionAttributeMetrics } from '@xyo-network/crypto-nft-collection-payload-plugin'\nimport { normalize, Score } from '@xyo-network/crypto-nft-score-model'\n\nconst maxScore = 10\n\nexport const scoreIndividualAttributes = (info: NftCollectionAttributeMetrics): Score => {\n  const { attributes } = info.metrics.metadata\n  const entries = Object.entries(attributes)\n  if (entries.length === 0) return [0, maxScore]\n  const scores = Object.entries(attributes)\n    .map(([_trait, { values }]) => {\n      return Object.entries(values).map<Score>(([_traitValue, metrics]) => {\n        const rarity = Math.min(Math.round((1 - metrics.binomial.p) * maxScore), maxScore)\n        return [rarity, maxScore]\n      })\n    })\n    .flat()\n  const total = scores.reduce<Score>(([a, b], [c, d]) => [a + c, b + d], [0, 0])\n  return normalize(total, maxScore)\n}\n","import { NftCollectionAttributeMetrics } from '@xyo-network/crypto-nft-collection-payload-plugin'\nimport { normalize, Score } from '@xyo-network/crypto-nft-score-model'\n\nconst maxScore = 10\n\n/**\n * Mean: What value is the distribution centered around\n */\nconst defaultMu = 0.15\n\n/**\n * Standard Deviation: How spread out is the distribution\n */\nconst defaultSigma = 0.1\n\n/**\n * Calculates the Gaussian probability density\n * @param x\n * @param mu Mean\n * @param sigma Standard Deviation\n * @returns\n */\nconst gaussianProbabilityDensity = (x: number, mu: number = defaultMu, sigma: number = defaultSigma): number => {\n  const sqrtTwoPi = Math.sqrt(2 * Math.PI)\n  const denominator = sigma * sqrtTwoPi\n  const power = -0.5 * Math.pow((x - mu) / sigma, 2)\n  return (1 / denominator) * Math.exp(power)\n}\n\n/**\n * For a Gaussian distribution, the peak of the distribution is the mean\n */\nconst maxProbabilityDensity = gaussianProbabilityDensity(defaultMu)\n\n/**\n * We're working on some assumptions here:\n *\n * - If you have a 100% chance of getting a trait, everyone get's a trophy\n * - If you have a 50% chance of getting a trait, it's not rare\n * - If you have a 0% chance of getting a trait, it's not fun\n *\n * So we're looking for something Pareto-ish (somewhere between\n * 80/20 or 90/10) as that's a good & sustainable model for the\n * distribution of many traits in real life.\n * However, we also don't want to maximally reward collections\n * that have a lot of single attributes distributed uniformly\n * (basically a 0% trait probably) as that's perfectly entropic\n * but not very interesting (some overlap is desirable).\n * So we're using a Gaussian distribution to model the\n * probability density of the joint probability of all traits\n * centered around 15%.\n * @param info\n * @returns\n */\nexport const scoreTotalAttributes = (info: NftCollectionAttributeMetrics): Score => {\n  const { attributes } = info.metrics.metadata\n  // This has somewhat of a filtering function by causing anything with 100% probability to\n  // add no value to the end score\n  const jointProbability = Object.entries(attributes).reduce((acc, [_trait, { metrics }]) => {\n    return acc * metrics.binomial.p\n  }, 1)\n  const probabilityDensity = gaussianProbabilityDensity(jointProbability)\n  const score: Score = [probabilityDensity, maxProbabilityDensity]\n  return normalize(score, maxScore)\n}\n","import { NftCollectionInfo } from '@xyo-network/crypto-nft-collection-payload-plugin'\nimport { WeightedScoringCriteria } from '@xyo-network/crypto-nft-score-model'\n\nimport { scoreIndividualAttributes } from './scoreIndividualAttributes'\nimport { scoreTotalAttributes } from './scoreTotalAttributes'\n\nexport const attributeScoringCriteria: { [key: string]: WeightedScoringCriteria<NftCollectionInfo> } = {\n  'Metadata Attributes Individual': { score: scoreIndividualAttributes, weight: 2 },\n  'Metadata Attributes Total': { score: scoreTotalAttributes, weight: 2 },\n}\n\nexport const scoreMetadata: { [key: string]: WeightedScoringCriteria<NftCollectionInfo> } = {\n  ...attributeScoringCriteria,\n}\n","import { NftCollectionCount } from '@xyo-network/crypto-nft-collection-payload-plugin'\nimport { normalize, Score } from '@xyo-network/crypto-nft-score-model'\n\n/**\n * This \"magic\" value was obtained using Solver in Excel\n * to find the median, with mu/sigma fixed, which maximizes\n * the distribution (the mode for lognormal) at 10,000\n */\nconst median = 81030839.8217352\nconst defaultMu = Math.log(median)\nconst defaultSigma = 3\nconst mode = Math.exp(defaultMu - Math.pow(defaultSigma, 2))\n/**\n * Calculates the log-normal probability density\n * @param x the value at which you want to calculate the probability density\n * @param mu mean of the associated normal distribution\n * @param sigma standard deviation of the associated normal distribution\n * @returns\n */\nconst logNormalProbabilityDensity = (x: number, mu: number = defaultMu, sigma: number = defaultSigma): number => {\n  if (x <= 0) return 0\n  const logX = Math.log(x)\n  return (1 / (x * sigma * Math.sqrt(2 * Math.PI))) * Math.exp(-0.5 * Math.pow((logX - mu) / sigma, 2))\n}\n\n/**\n * For a lognormal distribution, the peak of the distribution is the mode\n */\nconst maxProbabilityDensity = logNormalProbabilityDensity(mode)\n\nconst maxScore = 10\n\n/**\n * We're working on some assumptions here:\n * - If there's < 1000 NFTs in your collection it starts becoming too niche\n * - If there's > 20,000 NFTs in your collection it starts becoming too broad\n * So there's a sweet spot somewhere between 2000 and 10,000\n * where a collection has enough NFTs to be interesting, but\n * not so many that it's teetering on a diluted money grab.\n * To model that we're using a log-normal distribution optimized\n * to maximally reward collections in the aforementioned range\n * @param nft\n * @returns\n */\nexport const scoreTotal = (nft: NftCollectionCount): Score => {\n  const density = logNormalProbabilityDensity(nft.total)\n  const score: Score = [density, maxProbabilityDensity]\n  return normalize(score, maxScore)\n}\n","import { NftCollectionInfo } from '@xyo-network/crypto-nft-collection-payload-plugin'\nimport { WeightedScoringCriteria } from '@xyo-network/crypto-nft-score-model'\n\nimport { scoreMetadata, scoreTotal } from './scoring'\n\nexport const scoringCriteria: { [key: string]: WeightedScoringCriteria<NftCollectionInfo> } = {\n  ...scoreMetadata,\n  Total: { score: scoreTotal, weight: 2 },\n}\n","import { NftCollectionInfo } from '@xyo-network/crypto-nft-collection-payload-plugin'\nimport { Score } from '@xyo-network/crypto-nft-score-model'\n\nimport { scoringCriteria } from './criteria'\n\nexport type ScoringCriteriaKey = keyof typeof scoringCriteria & PropertyKey\n\nexport type NftCollectionAnalysis = {\n  [key in ScoringCriteriaKey]: Score\n}\n\nexport const analyzeNftCollection = async (\n  /**\n   * The NFT to evaluate\n   */\n  nft: NftCollectionInfo,\n): Promise<NftCollectionAnalysis> => {\n  const result = Object.fromEntries(\n    await Promise.all(\n      Object.entries(scoringCriteria).map(async ([key, { score, weight }]) => {\n        const rawScore = await score(nft)\n        const weighted = rawScore.map((v) => v * weight) as Score\n        return [key, weighted] as const\n      }),\n    ),\n  ) as NftCollectionAnalysis\n  return result\n}\n","import { NftCollectionScoreDivinerPlugin } from './Plugin'\n\nexport * from './Diviner'\nexport * from './lib'\n\nexport { NftCollectionScoreDivinerPlugin }\n\n// eslint-disable-next-line import/no-default-export\nexport default NftCollectionScoreDivinerPlugin\n"],"mappings":";AAAA,SAAS,iBAAiB;AAC1B,SAAS,wBAAwB;AACjC,SAAS,qCAAqC;;;ACF9C,SAAS,uBAAuB;AAChC,SAAS,qBAAqB;AAC9B;AAAA,EACE;AAAA,EAKA;AAAA,EACA;AAAA,OACK;;;ACTP,SAAS,iBAAwB;AAEjC,IAAM,WAAW;AAEV,IAAM,4BAA4B,CAAC,SAA+C;AACvF,QAAM,EAAE,WAAW,IAAI,KAAK,QAAQ;AACpC,QAAM,UAAU,OAAO,QAAQ,UAAU;AACzC,MAAI,QAAQ,WAAW;AAAG,WAAO,CAAC,GAAG,QAAQ;AAC7C,QAAM,SAAS,OAAO,QAAQ,UAAU,EACrC,IAAI,CAAC,CAAC,QAAQ,EAAE,OAAO,CAAC,MAAM;AAC7B,WAAO,OAAO,QAAQ,MAAM,EAAE,IAAW,CAAC,CAAC,aAAa,OAAO,MAAM;AACnE,YAAM,SAAS,KAAK,IAAI,KAAK,OAAO,IAAI,QAAQ,SAAS,KAAK,QAAQ,GAAG,QAAQ;AACjF,aAAO,CAAC,QAAQ,QAAQ;AAAA,IAC1B,CAAC;AAAA,EACH,CAAC,EACA,KAAK;AACR,QAAM,QAAQ,OAAO,OAAc,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AAC7E,SAAO,UAAU,OAAO,QAAQ;AAClC;;;AClBA,SAAS,aAAAA,kBAAwB;AAEjC,IAAMC,YAAW;AAKjB,IAAM,YAAY;AAKlB,IAAM,eAAe;AASrB,IAAM,6BAA6B,CAAC,GAAW,KAAa,WAAW,QAAgB,iBAAyB;AAC9G,QAAM,YAAY,KAAK,KAAK,IAAI,KAAK,EAAE;AACvC,QAAM,cAAc,QAAQ;AAC5B,QAAM,QAAQ,OAAO,KAAK,KAAK,IAAI,MAAM,OAAO,CAAC;AACjD,SAAQ,IAAI,cAAe,KAAK,IAAI,KAAK;AAC3C;AAKA,IAAM,wBAAwB,2BAA2B,SAAS;AAsB3D,IAAM,uBAAuB,CAAC,SAA+C;AAClF,QAAM,EAAE,WAAW,IAAI,KAAK,QAAQ;AAGpC,QAAM,mBAAmB,OAAO,QAAQ,UAAU,EAAE,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,QAAQ,CAAC,MAAM;AACzF,WAAO,MAAM,QAAQ,SAAS;AAAA,EAChC,GAAG,CAAC;AACJ,QAAM,qBAAqB,2BAA2B,gBAAgB;AACtE,QAAM,QAAe,CAAC,oBAAoB,qBAAqB;AAC/D,SAAOD,WAAU,OAAOC,SAAQ;AAClC;;;AC1DO,IAAM,2BAA0F;AAAA,EACrG,kCAAkC,EAAE,OAAO,2BAA2B,QAAQ,EAAE;AAAA,EAChF,6BAA6B,EAAE,OAAO,sBAAsB,QAAQ,EAAE;AACxE;AAEO,IAAM,gBAA+E;AAAA,EAC1F,GAAG;AACL;;;ACZA,SAAS,aAAAC,kBAAwB;AAOjC,IAAM,SAAS;AACf,IAAMC,aAAY,KAAK,IAAI,MAAM;AACjC,IAAMC,gBAAe;AACrB,IAAM,OAAO,KAAK,IAAID,aAAY,KAAK,IAAIC,eAAc,CAAC,CAAC;AAQ3D,IAAM,8BAA8B,CAAC,GAAW,KAAaD,YAAW,QAAgBC,kBAAyB;AAC/G,MAAI,KAAK;AAAG,WAAO;AACnB,QAAM,OAAO,KAAK,IAAI,CAAC;AACvB,SAAQ,KAAK,IAAI,QAAQ,KAAK,KAAK,IAAI,KAAK,EAAE,KAAM,KAAK,IAAI,OAAO,KAAK,KAAK,OAAO,MAAM,OAAO,CAAC,CAAC;AACtG;AAKA,IAAMC,yBAAwB,4BAA4B,IAAI;AAE9D,IAAMC,YAAW;AAcV,IAAM,aAAa,CAAC,QAAmC;AAC5D,QAAM,UAAU,4BAA4B,IAAI,KAAK;AACrD,QAAM,QAAe,CAAC,SAASD,sBAAqB;AACpD,SAAOH,WAAU,OAAOI,SAAQ;AAClC;;;AC3CO,IAAM,kBAAiF;AAAA,EAC5F,GAAG;AAAA,EACH,OAAO,EAAE,OAAO,YAAY,QAAQ,EAAE;AACxC;;;ACGO,IAAM,uBAAuB,OAIlC,QACmC;AACnC,QAAM,SAAS,OAAO;AAAA,IACpB,MAAM,QAAQ;AAAA,MACZ,OAAO,QAAQ,eAAe,EAAE,IAAI,OAAO,CAAC,KAAK,EAAE,OAAO,OAAO,CAAC,MAAM;AACtE,cAAM,WAAW,MAAM,MAAM,GAAG;AAChC,cAAM,WAAW,SAAS,IAAI,CAAC,MAAM,IAAI,MAAM;AAC/C,eAAO,CAAC,KAAK,QAAQ;AAAA,MACvB,CAAC;AAAA,IACH;AAAA,EACF;AACA,SAAO;AACT;;;ANRA,IAAM,uBAAuB,CAAC,mBAAsC,WAAsD;AACxH,QAAM,EAAE,MAAM,QAAQ,SAAS,SAAS,KAAK,IAAI;AACjD,QAAM,WAAkC,EAAE,SAAS,SAAS,MAAM,QAAQ,KAAK;AAC/E,SAAO,EAAE,GAAG,UAAU,QAAQ,0BAA0B,OAAO;AACjE;AAEO,IAAM,4BAAN,cAEG,gBAAyB;AAAA,EACjC,OAAgB,gBAAgB,CAAC,qCAAqC;AAAA,EAEnD,gBAAgB,OAAO,aAA6C;AACrF,UAAM,qBAAqB,UAAU,OAAO,mBAAmB,KAAK,CAAC;AACrE,UAAM,UAAU,MAAM,QAAQ;AAAA,MAC5B,mBAAmB,IAAiC,OAAO,sBAAsB;AAC/E,cAAM,CAAC,OAAO,UAAU,IAAI,MAAM,QAAQ,IAAI;AAAA;AAAA,UAE5C,qBAAqB,mBAAmB,MAAM,qBAAqB,iBAAiB,CAAC;AAAA;AAAA,UAErF,cAAc,UAAU,iBAAiB;AAAA,QAC3C,CAAC;AACD,eAAO,EAAE,GAAG,OAAO,QAAQ,0BAA0B,SAAS,CAAC,UAAU,EAAE;AAAA,MAC7E,CAAC;AAAA,IACH;AACA,WAAO;AAAA,EACT;AACF;;;ADvCO,IAAM,kCAAkC,MAC7C;AAAA,EACE,EAAE,UAAU,EAAE,CAAC,SAAS,GAAG,EAAE,GAAG,QAAQ,iBAAiB;AAAA,EACzD;AAAA,IACE,SAAS,OAAO,WAAW;AACzB,YAAM,SAAS,MAAM,0BAA0B,OAAO,MAAM;AAC5D,aAAO;AAAA,IACT;AAAA,EACF;AACF;;;AQPF,IAAO,cAAQ;","names":["normalize","maxScore","normalize","defaultMu","defaultSigma","maxProbabilityDensity","maxScore"]}

package/dist/browser/lib/index.js

@@ -1,2 +1,92 @@
-export * from "./rating";
+// src/lib/rating/criteria/scoring/metadata/scoreIndividualAttributes.ts
+import { normalize } from "@xyo-network/crypto-nft-score-model";
+var maxScore = 10;
+var scoreIndividualAttributes = (info) => {
+  const { attributes } = info.metrics.metadata;
+  const entries = Object.entries(attributes);
+  if (entries.length === 0)
+    return [0, maxScore];
+  const scores = Object.entries(attributes).map(([_trait, { values }]) => {
+    return Object.entries(values).map(([_traitValue, metrics]) => {
+      const rarity = Math.min(Math.round((1 - metrics.binomial.p) * maxScore), maxScore);
+      return [rarity, maxScore];
+    });
+  }).flat();
+  const total = scores.reduce(([a, b], [c, d]) => [a + c, b + d], [0, 0]);
+  return normalize(total, maxScore);
+};
+
+// src/lib/rating/criteria/scoring/metadata/scoreTotalAttributes.ts
+import { normalize as normalize2 } from "@xyo-network/crypto-nft-score-model";
+var maxScore2 = 10;
+var defaultMu = 0.15;
+var defaultSigma = 0.1;
+var gaussianProbabilityDensity = (x, mu = defaultMu, sigma = defaultSigma) => {
+  const sqrtTwoPi = Math.sqrt(2 * Math.PI);
+  const denominator = sigma * sqrtTwoPi;
+  const power = -0.5 * Math.pow((x - mu) / sigma, 2);
+  return 1 / denominator * Math.exp(power);
+};
+var maxProbabilityDensity = gaussianProbabilityDensity(defaultMu);
+var scoreTotalAttributes = (info) => {
+  const { attributes } = info.metrics.metadata;
+  const jointProbability = Object.entries(attributes).reduce((acc, [_trait, { metrics }]) => {
+    return acc * metrics.binomial.p;
+  }, 1);
+  const probabilityDensity = gaussianProbabilityDensity(jointProbability);
+  const score = [probabilityDensity, maxProbabilityDensity];
+  return normalize2(score, maxScore2);
+};
+
+// src/lib/rating/criteria/scoring/metadata/metadata.ts
+var attributeScoringCriteria = {
+  "Metadata Attributes Individual": { score: scoreIndividualAttributes, weight: 2 },
+  "Metadata Attributes Total": { score: scoreTotalAttributes, weight: 2 }
+};
+var scoreMetadata = {
+  ...attributeScoringCriteria
+};
+
+// src/lib/rating/criteria/scoring/total.ts
+import { normalize as normalize3 } from "@xyo-network/crypto-nft-score-model";
+var median = 810308398217352e-7;
+var defaultMu2 = Math.log(median);
+var defaultSigma2 = 3;
+var mode = Math.exp(defaultMu2 - Math.pow(defaultSigma2, 2));
+var logNormalProbabilityDensity = (x, mu = defaultMu2, sigma = defaultSigma2) => {
+  if (x <= 0)
+    return 0;
+  const logX = Math.log(x);
+  return 1 / (x * sigma * Math.sqrt(2 * Math.PI)) * Math.exp(-0.5 * Math.pow((logX - mu) / sigma, 2));
+};
+var maxProbabilityDensity2 = logNormalProbabilityDensity(mode);
+var maxScore3 = 10;
+var scoreTotal = (nft) => {
+  const density = logNormalProbabilityDensity(nft.total);
+  const score = [density, maxProbabilityDensity2];
+  return normalize3(score, maxScore3);
+};
+
+// src/lib/rating/criteria/index.ts
+var scoringCriteria = {
+  ...scoreMetadata,
+  Total: { score: scoreTotal, weight: 2 }
+};
+
+// src/lib/rating/analyzeNftCollection.ts
+var analyzeNftCollection = async (nft) => {
+  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);
+        return [key, weighted];
+      })
+    )
+  );
+  return result;
+};
+export {
+  analyzeNftCollection
+};
 //# sourceMappingURL=index.js.map

package/dist/browser/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/lib/index.ts"],"sourcesContent":["export * from './rating'\n"],"mappings":"AAAA,cAAc;","names":[]}
+{"version":3,"sources":["../../../src/lib/rating/criteria/scoring/metadata/scoreIndividualAttributes.ts","../../../src/lib/rating/criteria/scoring/metadata/scoreTotalAttributes.ts","../../../src/lib/rating/criteria/scoring/metadata/metadata.ts","../../../src/lib/rating/criteria/scoring/total.ts","../../../src/lib/rating/criteria/index.ts","../../../src/lib/rating/analyzeNftCollection.ts"],"sourcesContent":["import { NftCollectionAttributeMetrics } from '@xyo-network/crypto-nft-collection-payload-plugin'\nimport { normalize, Score } from '@xyo-network/crypto-nft-score-model'\n\nconst maxScore = 10\n\nexport const scoreIndividualAttributes = (info: NftCollectionAttributeMetrics): Score => {\n  const { attributes } = info.metrics.metadata\n  const entries = Object.entries(attributes)\n  if (entries.length === 0) return [0, maxScore]\n  const scores = Object.entries(attributes)\n    .map(([_trait, { values }]) => {\n      return Object.entries(values).map<Score>(([_traitValue, metrics]) => {\n        const rarity = Math.min(Math.round((1 - metrics.binomial.p) * maxScore), maxScore)\n        return [rarity, maxScore]\n      })\n    })\n    .flat()\n  const total = scores.reduce<Score>(([a, b], [c, d]) => [a + c, b + d], [0, 0])\n  return normalize(total, maxScore)\n}\n","import { NftCollectionAttributeMetrics } from '@xyo-network/crypto-nft-collection-payload-plugin'\nimport { normalize, Score } from '@xyo-network/crypto-nft-score-model'\n\nconst maxScore = 10\n\n/**\n * Mean: What value is the distribution centered around\n */\nconst defaultMu = 0.15\n\n/**\n * Standard Deviation: How spread out is the distribution\n */\nconst defaultSigma = 0.1\n\n/**\n * Calculates the Gaussian probability density\n * @param x\n * @param mu Mean\n * @param sigma Standard Deviation\n * @returns\n */\nconst gaussianProbabilityDensity = (x: number, mu: number = defaultMu, sigma: number = defaultSigma): number => {\n  const sqrtTwoPi = Math.sqrt(2 * Math.PI)\n  const denominator = sigma * sqrtTwoPi\n  const power = -0.5 * Math.pow((x - mu) / sigma, 2)\n  return (1 / denominator) * Math.exp(power)\n}\n\n/**\n * For a Gaussian distribution, the peak of the distribution is the mean\n */\nconst maxProbabilityDensity = gaussianProbabilityDensity(defaultMu)\n\n/**\n * We're working on some assumptions here:\n *\n * - If you have a 100% chance of getting a trait, everyone get's a trophy\n * - If you have a 50% chance of getting a trait, it's not rare\n * - If you have a 0% chance of getting a trait, it's not fun\n *\n * So we're looking for something Pareto-ish (somewhere between\n * 80/20 or 90/10) as that's a good & sustainable model for the\n * distribution of many traits in real life.\n * However, we also don't want to maximally reward collections\n * that have a lot of single attributes distributed uniformly\n * (basically a 0% trait probably) as that's perfectly entropic\n * but not very interesting (some overlap is desirable).\n * So we're using a Gaussian distribution to model the\n * probability density of the joint probability of all traits\n * centered around 15%.\n * @param info\n * @returns\n */\nexport const scoreTotalAttributes = (info: NftCollectionAttributeMetrics): Score => {\n  const { attributes } = info.metrics.metadata\n  // This has somewhat of a filtering function by causing anything with 100% probability to\n  // add no value to the end score\n  const jointProbability = Object.entries(attributes).reduce((acc, [_trait, { metrics }]) => {\n    return acc * metrics.binomial.p\n  }, 1)\n  const probabilityDensity = gaussianProbabilityDensity(jointProbability)\n  const score: Score = [probabilityDensity, maxProbabilityDensity]\n  return normalize(score, maxScore)\n}\n","import { NftCollectionInfo } from '@xyo-network/crypto-nft-collection-payload-plugin'\nimport { WeightedScoringCriteria } from '@xyo-network/crypto-nft-score-model'\n\nimport { scoreIndividualAttributes } from './scoreIndividualAttributes'\nimport { scoreTotalAttributes } from './scoreTotalAttributes'\n\nexport const attributeScoringCriteria: { [key: string]: WeightedScoringCriteria<NftCollectionInfo> } = {\n  'Metadata Attributes Individual': { score: scoreIndividualAttributes, weight: 2 },\n  'Metadata Attributes Total': { score: scoreTotalAttributes, weight: 2 },\n}\n\nexport const scoreMetadata: { [key: string]: WeightedScoringCriteria<NftCollectionInfo> } = {\n  ...attributeScoringCriteria,\n}\n","import { NftCollectionCount } from '@xyo-network/crypto-nft-collection-payload-plugin'\nimport { normalize, Score } from '@xyo-network/crypto-nft-score-model'\n\n/**\n * This \"magic\" value was obtained using Solver in Excel\n * to find the median, with mu/sigma fixed, which maximizes\n * the distribution (the mode for lognormal) at 10,000\n */\nconst median = 81030839.8217352\nconst defaultMu = Math.log(median)\nconst defaultSigma = 3\nconst mode = Math.exp(defaultMu - Math.pow(defaultSigma, 2))\n/**\n * Calculates the log-normal probability density\n * @param x the value at which you want to calculate the probability density\n * @param mu mean of the associated normal distribution\n * @param sigma standard deviation of the associated normal distribution\n * @returns\n */\nconst logNormalProbabilityDensity = (x: number, mu: number = defaultMu, sigma: number = defaultSigma): number => {\n  if (x <= 0) return 0\n  const logX = Math.log(x)\n  return (1 / (x * sigma * Math.sqrt(2 * Math.PI))) * Math.exp(-0.5 * Math.pow((logX - mu) / sigma, 2))\n}\n\n/**\n * For a lognormal distribution, the peak of the distribution is the mode\n */\nconst maxProbabilityDensity = logNormalProbabilityDensity(mode)\n\nconst maxScore = 10\n\n/**\n * We're working on some assumptions here:\n * - If there's < 1000 NFTs in your collection it starts becoming too niche\n * - If there's > 20,000 NFTs in your collection it starts becoming too broad\n * So there's a sweet spot somewhere between 2000 and 10,000\n * where a collection has enough NFTs to be interesting, but\n * not so many that it's teetering on a diluted money grab.\n * To model that we're using a log-normal distribution optimized\n * to maximally reward collections in the aforementioned range\n * @param nft\n * @returns\n */\nexport const scoreTotal = (nft: NftCollectionCount): Score => {\n  const density = logNormalProbabilityDensity(nft.total)\n  const score: Score = [density, maxProbabilityDensity]\n  return normalize(score, maxScore)\n}\n","import { NftCollectionInfo } from '@xyo-network/crypto-nft-collection-payload-plugin'\nimport { WeightedScoringCriteria } from '@xyo-network/crypto-nft-score-model'\n\nimport { scoreMetadata, scoreTotal } from './scoring'\n\nexport const scoringCriteria: { [key: string]: WeightedScoringCriteria<NftCollectionInfo> } = {\n  ...scoreMetadata,\n  Total: { score: scoreTotal, weight: 2 },\n}\n","import { NftCollectionInfo } from '@xyo-network/crypto-nft-collection-payload-plugin'\nimport { Score } from '@xyo-network/crypto-nft-score-model'\n\nimport { scoringCriteria } from './criteria'\n\nexport type ScoringCriteriaKey = keyof typeof scoringCriteria & PropertyKey\n\nexport type NftCollectionAnalysis = {\n  [key in ScoringCriteriaKey]: Score\n}\n\nexport const analyzeNftCollection = async (\n  /**\n   * The NFT to evaluate\n   */\n  nft: NftCollectionInfo,\n): Promise<NftCollectionAnalysis> => {\n  const result = Object.fromEntries(\n    await Promise.all(\n      Object.entries(scoringCriteria).map(async ([key, { score, weight }]) => {\n        const rawScore = await score(nft)\n        const weighted = rawScore.map((v) => v * weight) as Score\n        return [key, weighted] as const\n      }),\n    ),\n  ) as NftCollectionAnalysis\n  return result\n}\n"],"mappings":";AACA,SAAS,iBAAwB;AAEjC,IAAM,WAAW;AAEV,IAAM,4BAA4B,CAAC,SAA+C;AACvF,QAAM,EAAE,WAAW,IAAI,KAAK,QAAQ;AACpC,QAAM,UAAU,OAAO,QAAQ,UAAU;AACzC,MAAI,QAAQ,WAAW;AAAG,WAAO,CAAC,GAAG,QAAQ;AAC7C,QAAM,SAAS,OAAO,QAAQ,UAAU,EACrC,IAAI,CAAC,CAAC,QAAQ,EAAE,OAAO,CAAC,MAAM;AAC7B,WAAO,OAAO,QAAQ,MAAM,EAAE,IAAW,CAAC,CAAC,aAAa,OAAO,MAAM;AACnE,YAAM,SAAS,KAAK,IAAI,KAAK,OAAO,IAAI,QAAQ,SAAS,KAAK,QAAQ,GAAG,QAAQ;AACjF,aAAO,CAAC,QAAQ,QAAQ;AAAA,IAC1B,CAAC;AAAA,EACH,CAAC,EACA,KAAK;AACR,QAAM,QAAQ,OAAO,OAAc,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AAC7E,SAAO,UAAU,OAAO,QAAQ;AAClC;;;AClBA,SAAS,aAAAA,kBAAwB;AAEjC,IAAMC,YAAW;AAKjB,IAAM,YAAY;AAKlB,IAAM,eAAe;AASrB,IAAM,6BAA6B,CAAC,GAAW,KAAa,WAAW,QAAgB,iBAAyB;AAC9G,QAAM,YAAY,KAAK,KAAK,IAAI,KAAK,EAAE;AACvC,QAAM,cAAc,QAAQ;AAC5B,QAAM,QAAQ,OAAO,KAAK,KAAK,IAAI,MAAM,OAAO,CAAC;AACjD,SAAQ,IAAI,cAAe,KAAK,IAAI,KAAK;AAC3C;AAKA,IAAM,wBAAwB,2BAA2B,SAAS;AAsB3D,IAAM,uBAAuB,CAAC,SAA+C;AAClF,QAAM,EAAE,WAAW,IAAI,KAAK,QAAQ;AAGpC,QAAM,mBAAmB,OAAO,QAAQ,UAAU,EAAE,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,QAAQ,CAAC,MAAM;AACzF,WAAO,MAAM,QAAQ,SAAS;AAAA,EAChC,GAAG,CAAC;AACJ,QAAM,qBAAqB,2BAA2B,gBAAgB;AACtE,QAAM,QAAe,CAAC,oBAAoB,qBAAqB;AAC/D,SAAOD,WAAU,OAAOC,SAAQ;AAClC;;;AC1DO,IAAM,2BAA0F;AAAA,EACrG,kCAAkC,EAAE,OAAO,2BAA2B,QAAQ,EAAE;AAAA,EAChF,6BAA6B,EAAE,OAAO,sBAAsB,QAAQ,EAAE;AACxE;AAEO,IAAM,gBAA+E;AAAA,EAC1F,GAAG;AACL;;;ACZA,SAAS,aAAAC,kBAAwB;AAOjC,IAAM,SAAS;AACf,IAAMC,aAAY,KAAK,IAAI,MAAM;AACjC,IAAMC,gBAAe;AACrB,IAAM,OAAO,KAAK,IAAID,aAAY,KAAK,IAAIC,eAAc,CAAC,CAAC;AAQ3D,IAAM,8BAA8B,CAAC,GAAW,KAAaD,YAAW,QAAgBC,kBAAyB;AAC/G,MAAI,KAAK;AAAG,WAAO;AACnB,QAAM,OAAO,KAAK,IAAI,CAAC;AACvB,SAAQ,KAAK,IAAI,QAAQ,KAAK,KAAK,IAAI,KAAK,EAAE,KAAM,KAAK,IAAI,OAAO,KAAK,KAAK,OAAO,MAAM,OAAO,CAAC,CAAC;AACtG;AAKA,IAAMC,yBAAwB,4BAA4B,IAAI;AAE9D,IAAMC,YAAW;AAcV,IAAM,aAAa,CAAC,QAAmC;AAC5D,QAAM,UAAU,4BAA4B,IAAI,KAAK;AACrD,QAAM,QAAe,CAAC,SAASD,sBAAqB;AACpD,SAAOH,WAAU,OAAOI,SAAQ;AAClC;;;AC3CO,IAAM,kBAAiF;AAAA,EAC5F,GAAG;AAAA,EACH,OAAO,EAAE,OAAO,YAAY,QAAQ,EAAE;AACxC;;;ACGO,IAAM,uBAAuB,OAIlC,QACmC;AACnC,QAAM,SAAS,OAAO;AAAA,IACpB,MAAM,QAAQ;AAAA,MACZ,OAAO,QAAQ,eAAe,EAAE,IAAI,OAAO,CAAC,KAAK,EAAE,OAAO,OAAO,CAAC,MAAM;AACtE,cAAM,WAAW,MAAM,MAAM,GAAG;AAChC,cAAM,WAAW,SAAS,IAAI,CAAC,MAAM,IAAI,MAAM;AAC/C,eAAO,CAAC,KAAK,QAAQ;AAAA,MACvB,CAAC;AAAA,IACH;AAAA,EACF;AACA,SAAO;AACT;","names":["normalize","maxScore","normalize","defaultMu","defaultSigma","maxProbabilityDensity","maxScore"]}