@xyo-network/crypto-nft-collection-diviner-score-plugin 2.99.5 → 2.99.6

package/dist/node/index.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/index.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/Plugin.ts"],"sourcesContent":["export * from './Diviner.ts'\nexport * from './lib/index.ts'\n// eslint-disable-next-line import/no-default-export\nexport { NftCollectionScoreDivinerPlugin as default, NftCollectionScoreDivinerPlugin } from './Plugin.ts'\n","import {\n  isNftCollectionInfo,\n  NftCollectionInfo,\n  NftCollectionMetadata,\n  NftCollectionScore,\n  NftCollectionScoreDivinerConfig,\n  NftCollectionScoreDivinerConfigSchema,\n  NftCollectionScoreSchema,\n} from '@xyo-network/crypto-nft-collection-payload-plugin'\nimport { AbstractDiviner } from '@xyo-network/diviner-abstract'\nimport { DivinerParams } from '@xyo-network/diviner-model'\nimport { AnyConfigSchema } from '@xyo-network/module-model'\nimport { PayloadBuilder } from '@xyo-network/payload-builder'\nimport { Payload, Schema } from '@xyo-network/payload-model'\n\nimport { analyzeNftCollection, NftCollectionAnalysis } from './lib/index.ts'\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 readonly configSchemas: Schema[] = [...super.configSchemas, NftCollectionScoreDivinerConfigSchema]\n  static override readonly defaultConfigSchema: Schema = 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          PayloadBuilder.dataHash(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).flatMap(([_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  // eslint-disable-next-line unicorn/no-array-reduce\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.ts'\nimport { scoreTotalAttributes } from './scoreTotalAttributes.ts'\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 = 81_030_839.821_735_2\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/index.ts'\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/index.ts'\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 { 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.ts'\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;;;;;;;;;;;ACAA,kDAQO;AACP,8BAAgC;AAGhC,6BAA+B;;;ACX/B,oCAAiC;AAEjC,IAAMA,WAAW;AAEV,IAAMC,4BAA4B,wBAACC,SAAAA;AACxC,QAAM,EAAEC,WAAU,IAAKD,KAAKE,QAAQC;AACpC,QAAMC,UAAUC,OAAOD,QAAQH,UAAAA;AAC/B,MAAIG,QAAQE,WAAW,EAAG,QAAO;IAAC;IAAGR;;AACrC,QAAMS,SAASF,OAAOD,QAAQH,UAAAA,EAAYO,QAAQ,CAAC,CAACC,QAAQ,EAAEC,OAAM,CAAE,MAAC;AACrE,WAAOL,OAAOD,QAAQM,MAAAA,EAAQC,IAAW,CAAC,CAACC,aAAaV,OAAAA,MAAQ;AAC9D,YAAMW,SAASC,KAAKC,IAAID,KAAKE,OAAO,IAAId,QAAQe,SAASC,KAAKpB,QAAAA,GAAWA,QAAAA;AACzE,aAAO;QAACe;QAAQf;;IAClB,CAAA;EACF,CAAA;AAEA,QAAMqB,QAAQZ,OAAOa,OAAc,CAAC,CAACC,GAAGC,CAAAA,GAAI,CAACC,GAAGC,CAAAA,MAAO;IAACH,IAAIE;IAAGD,IAAIE;KAAI;IAAC;IAAG;GAAE;AAC7E,aAAOC,yCAAUN,OAAOrB,QAAAA;AAC1B,GAbyC;;;ACJzC,IAAA4B,iCAAiC;AAEjC,IAAMC,YAAW;AAKjB,IAAMC,YAAY;AAKlB,IAAMC,eAAe;AASrB,IAAMC,6BAA6B,wBAACC,GAAWC,KAAaJ,WAAWK,QAAgBJ,iBAAY;AACjG,QAAMK,YAAYC,KAAKC,KAAK,IAAID,KAAKE,EAAE;AACvC,QAAMC,cAAcL,QAAQC;AAC5B,QAAMK,QAAQ,OAAOJ,KAAKK,KAAKT,IAAIC,MAAMC,OAAO,CAAA;AAChD,SAAQ,IAAIK,cAAeH,KAAKM,IAAIF,KAAAA;AACtC,GALmC;AAUnC,IAAMG,wBAAwBZ,2BAA2BF,SAAAA;AAsBlD,IAAMe,uBAAuB,wBAACC,SAAAA;AACnC,QAAM,EAAEC,WAAU,IAAKD,KAAKE,QAAQC;AAGpC,QAAMC,mBAAmBC,OAAOC,QAAQL,UAAAA,EAAYM,OAAO,CAACC,KAAK,CAACC,QAAQ,EAAEP,QAAO,CAAE,MAAC;AACpF,WAAOM,MAAMN,QAAQQ,SAASC;EAChC,GAAG,CAAA;AACH,QAAMC,qBAAqB1B,2BAA2BkB,gBAAAA;AACtD,QAAMS,QAAe;IAACD;IAAoBd;;AAC1C,aAAOgB,0CAAUD,OAAO9B,SAAAA;AAC1B,GAVoC;;;AChD7B,IAAMgC,2BAA0F;EACrG,kCAAkC;IAAEC,OAAOC;IAA2BC,QAAQ;EAAE;EAChF,6BAA6B;IAAEF,OAAOG;IAAsBD,QAAQ;EAAE;AACxE;AAEO,IAAME,gBAA+E;EAC1F,GAAGL;AACL;;;ACZA,IAAAM,iCAAiC;AAOjC,IAAMC,SAAS;AACf,IAAMC,aAAYC,KAAKC,IAAIH,MAAAA;AAC3B,IAAMI,gBAAe;AACrB,IAAMC,OAAOH,KAAKI,IAAIL,aAAYC,KAAKK,IAAIH,eAAc,CAAA,CAAA;AAQzD,IAAMI,8BAA8B,wBAACC,GAAWC,KAAaT,YAAWU,QAAgBP,kBAAY;AAClG,MAAIK,KAAK,EAAG,QAAO;AACnB,QAAMG,OAAOV,KAAKC,IAAIM,CAAAA;AACtB,SAAQ,KAAKA,IAAIE,QAAQT,KAAKW,KAAK,IAAIX,KAAKY,EAAE,KAAMZ,KAAKI,IAAI,OAAOJ,KAAKK,KAAKK,OAAOF,MAAMC,OAAO,CAAA,CAAA;AACpG,GAJoC;AASpC,IAAMI,yBAAwBP,4BAA4BH,IAAAA;AAE1D,IAAMW,YAAW;AAcV,IAAMC,aAAa,wBAACC,QAAAA;AACzB,QAAMC,UAAUX,4BAA4BU,IAAIE,KAAK;AACrD,QAAMC,QAAe;IAACF;IAASJ;;AAC/B,aAAOO,0CAAUD,OAAOL,SAAAA;AAC1B,GAJ0B;;;ACvCnB,IAAMO,kBAAiF;EAC5F,GAAGC;EACHC,OAAO;IAAEC,OAAOC;IAAYC,QAAQ;EAAE;AACxC;;;ACGO,IAAMC,uBAAuB,8BAIlCC,QAAAA;AAEA,QAAMC,SAASC,OAAOC,YACpB,MAAMC,QAAQC,IACZH,OAAOI,QAAQC,eAAAA,EAAiBC,IAAI,OAAO,CAACC,KAAK,EAAEC,OAAOC,OAAM,CAAE,MAAC;AACjE,UAAMC,WAAW,MAAMF,MAAMV,GAAAA;AAC7B,UAAMa,WAAWD,SAASJ,IAAIM,CAAAA,MAAKA,IAAIH,MAAAA;AACvC,WAAO;MAACF;MAAKI;;EACf,CAAA,CAAA,CAAA;AAGJ,SAAOZ;AACT,GAhBoC;;;ANQpC,IAAMc,uBAAuB,wBAACC,mBAAsCC,WAAAA;AAClE,QAAM,EAAEC,MAAMC,QAAQC,SAASC,SAASC,KAAI,IAAKN;AACjD,QAAMO,WAAkC;IAAEH;IAASC;IAASH;IAAMC;IAAQG;EAAK;AAC/E,SAAO;IAAE,GAAGC;IAAUC,QAAQC;IAA0BR;EAAO;AACjE,GAJ6B;AAMtB,IAAMS,6BAAN,MAAMA,mCAEHC,wCAAAA;EAIWC,gBAAgB,8BAAOC,aAAAA;AACxC,UAAMC,sBAAqBD,qCAAUE,OAAOC,qEAAwB,CAAA;AACpE,UAAMC,UAAU,MAAMC,QAAQC,IAC5BL,mBAAmBM,IAAiC,OAAOpB,sBAAAA;AACzD,YAAM,CAACqB,OAAOC,UAAAA,IAAc,MAAMJ,QAAQC,IAAI;;QAE5CpB,qBAAqBC,mBAAmB,MAAMuB,qBAAqBvB,iBAAAA,CAAAA;;QAEnEwB,sCAAeC,SAASzB,iBAAAA;OACzB;AACD,aAAO;QAAE,GAAGqB;QAAOb,QAAQC;QAA0BiB,SAAS;UAACJ;;MAAY;IAC7E,CAAA,CAAA;AAEF,WAAOL;EACT,GAdmC;AAerC;AAnBUN;AACR,cAHWD,4BAGciB,iBAA0B;KAAI,mEAAMA;EAAeC;;AAC5E,cAJWlB,4BAIcmB,uBAA8BD;AAJlD,IAAMlB,4BAAN;;;AOzBP,uCAA0B;AAC1B,2BAAiC;AACjC,+BAA8C;AAIvC,IAAMoB,kCAAkC,iCAC7CC,wDACE;EAAEC,UAAU;IAAE,CAACC,0CAAAA,GAAY;EAAE;EAAGC,QAAQC;AAAiB,GACzD;EACEC,SAAS,8BAAOC,WAAAA;AACd,UAAMC,SAAS,MAAMC,0BAA0BC,OAAOH,MAAAA;AACtD,WAAOC;EACT,GAHS;AAIX,CAAA,GAR2C;","names":["maxScore","scoreIndividualAttributes","info","attributes","metrics","metadata","entries","Object","length","scores","flatMap","_trait","values","map","_traitValue","rarity","Math","min","round","binomial","p","total","reduce","a","b","c","d","normalize","import_crypto_nft_score_model","maxScore","defaultMu","defaultSigma","gaussianProbabilityDensity","x","mu","sigma","sqrtTwoPi","Math","sqrt","PI","denominator","power","pow","exp","maxProbabilityDensity","scoreTotalAttributes","info","attributes","metrics","metadata","jointProbability","Object","entries","reduce","acc","_trait","binomial","p","probabilityDensity","score","normalize","attributeScoringCriteria","score","scoreIndividualAttributes","weight","scoreTotalAttributes","scoreMetadata","import_crypto_nft_score_model","median","defaultMu","Math","log","defaultSigma","mode","exp","pow","logNormalProbabilityDensity","x","mu","sigma","logX","sqrt","PI","maxProbabilityDensity","maxScore","scoreTotal","nft","density","total","score","normalize","scoringCriteria","scoreMetadata","Total","score","scoreTotal","weight","analyzeNftCollection","nft","result","Object","fromEntries","Promise","all","entries","scoringCriteria","map","key","score","weight","rawScore","weighted","v","toNftCollectionScore","nftCollectionInfo","scores","name","symbol","address","chainId","type","metadata","schema","NftCollectionScoreSchema","NftCollectionScoreDiviner","AbstractDiviner","divineHandler","payloads","nftCollectionInfos","filter","isNftCollectionInfo","results","Promise","all","map","score","sourceHash","analyzeNftCollection","PayloadBuilder","dataHash","sources","configSchemas","NftCollectionScoreDivinerConfigSchema","defaultConfigSchema","NftCollectionScoreDivinerPlugin","createPayloadSetDivinerPlugin","required","NftSchema","schema","PayloadSetSchema","diviner","params","result","NftCollectionScoreDiviner","create"]}
+{"version":3,"sources":["../../src/index.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/Plugin.ts"],"sourcesContent":["export * from './Diviner.ts'\nexport * from './lib/index.ts'\n// eslint-disable-next-line import/no-default-export\nexport { NftCollectionScoreDivinerPlugin as default, NftCollectionScoreDivinerPlugin } from './Plugin.ts'\n","import {\n  isNftCollectionInfo,\n  NftCollectionInfo,\n  NftCollectionMetadata,\n  NftCollectionScore,\n  NftCollectionScoreDivinerConfig,\n  NftCollectionScoreDivinerConfigSchema,\n  NftCollectionScoreSchema,\n} from '@xyo-network/crypto-nft-collection-payload-plugin'\nimport { AbstractDiviner } from '@xyo-network/diviner-abstract'\nimport { DivinerParams } from '@xyo-network/diviner-model'\nimport { AnyConfigSchema } from '@xyo-network/module-model'\nimport { PayloadBuilder } from '@xyo-network/payload-builder'\nimport { Payload, Schema } from '@xyo-network/payload-model'\n\nimport { analyzeNftCollection, NftCollectionAnalysis } from './lib/index.ts'\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 readonly configSchemas: Schema[] = [...super.configSchemas, NftCollectionScoreDivinerConfigSchema]\n  static override readonly defaultConfigSchema: Schema = 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          PayloadBuilder.dataHash(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).flatMap(([_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  // eslint-disable-next-line unicorn/no-array-reduce\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.ts'\nimport { scoreTotalAttributes } from './scoreTotalAttributes.ts'\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 = 81_030_839.821_735_2\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/index.ts'\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/index.ts'\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 { 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.ts'\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;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,kDAQO;AACP,8BAAgC;AAGhC,6BAA+B;;;ACX/B,oCAAiC;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,EAAG,QAAO,CAAC,GAAG,QAAQ;AAC7C,QAAM,SAAS,OAAO,QAAQ,UAAU,EAAE,QAAQ,CAAC,CAAC,QAAQ,EAAE,OAAO,CAAC,MAAM;AAC1E,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;AAED,QAAM,QAAQ,OAAO,OAAc,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AAC7E,aAAO,yCAAU,OAAO,QAAQ;AAClC;;;ACjBA,IAAAA,iCAAiC;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,aAAO,0CAAU,OAAOA,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,IAAAC,iCAAiC;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,EAAG,QAAO;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,aAAO,0CAAU,OAAOC,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,OAAK,IAAI,MAAM;AAC7C,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,sEAA0B,OAAO;AACjE;AAEO,IAAM,4BAAN,cAEG,wCAAyB;AAAA,EACjC,OAAyB,gBAA0B,CAAC,GAAG,MAAM,eAAe,iFAAqC;AAAA,EACjH,OAAyB,sBAA8B;AAAA,EAEpC,gBAAgB,OAAO,aAA6C;AACrF,UAAM,sBAAqB,qCAAU,OAAO,qEAAwB,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,sCAAe,SAAS,iBAAiB;AAAA,QAC3C,CAAC;AACD,eAAO,EAAE,GAAG,OAAO,QAAQ,sEAA0B,SAAS,CAAC,UAAU,EAAE;AAAA,MAC7E,CAAC;AAAA,IACH;AACA,WAAO;AAAA,EACT;AACF;;;AO9CA,uCAA0B;AAC1B,2BAAiC;AACjC,+BAA8C;AAIvC,IAAM,kCAAkC,UAC7C;AAAA,EACE,EAAE,UAAU,EAAE,CAAC,0CAAS,GAAG,EAAE,GAAG,QAAQ,sCAAiB;AAAA,EACzD;AAAA,IACE,SAAS,OAAO,WAAW;AACzB,YAAM,SAAS,MAAM,0BAA0B,OAAO,MAAM;AAC5D,aAAO;AAAA,IACT;AAAA,EACF;AACF;","names":["import_crypto_nft_score_model","maxScore","import_crypto_nft_score_model","defaultMu","defaultSigma","maxProbabilityDensity","maxScore"]}

package/dist/node/index.mjs

@@ -1,80 +1,55 @@
-var __defProp = Object.defineProperty;
-var __getProtoOf = Object.getPrototypeOf;
-var __reflectGet = Reflect.get;
-var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
-var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
-var __superGet = (cls, obj, key) => __reflectGet(__getProtoOf(cls), key, obj);
-
 // src/Diviner.ts
-import { isNftCollectionInfo, NftCollectionScoreDivinerConfigSchema, NftCollectionScoreSchema } from "@xyo-network/crypto-nft-collection-payload-plugin";
+import {
+  isNftCollectionInfo,
+  NftCollectionScoreDivinerConfigSchema,
+  NftCollectionScoreSchema
+} from "@xyo-network/crypto-nft-collection-payload-plugin";
 import { AbstractDiviner } from "@xyo-network/diviner-abstract";
 import { PayloadBuilder } from "@xyo-network/payload-builder";
 
 // src/lib/rating/criteria/scoring/metadata/scoreIndividualAttributes.ts
 import { normalize } from "@xyo-network/crypto-nft-score-model";
 var maxScore = 10;
-var scoreIndividualAttributes = /* @__PURE__ */ __name((info) => {
+var scoreIndividualAttributes = (info) => {
   const { attributes } = info.metrics.metadata;
   const entries = Object.entries(attributes);
-  if (entries.length === 0) return [
-    0,
-    maxScore
-  ];
+  if (entries.length === 0) return [0, maxScore];
   const scores = Object.entries(attributes).flatMap(([_trait, { values }]) => {
     return Object.entries(values).map(([_traitValue, metrics]) => {
       const rarity = Math.min(Math.round((1 - metrics.binomial.p) * maxScore), maxScore);
-      return [
-        rarity,
-        maxScore
-      ];
+      return [rarity, maxScore];
     });
   });
-  const total = scores.reduce(([a, b], [c, d]) => [
-    a + c,
-    b + d
-  ], [
-    0,
-    0
-  ]);
+  const total = scores.reduce(([a, b], [c, d]) => [a + c, b + d], [0, 0]);
   return normalize(total, maxScore);
-}, "scoreIndividualAttributes");
+};
 
 // 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 = /* @__PURE__ */ __name((x, mu = defaultMu, sigma = defaultSigma) => {
+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);
-}, "gaussianProbabilityDensity");
+};
 var maxProbabilityDensity = gaussianProbabilityDensity(defaultMu);
-var scoreTotalAttributes = /* @__PURE__ */ __name((info) => {
+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
-  ];
+  const score = [probabilityDensity, maxProbabilityDensity];
   return normalize2(score, maxScore2);
-}, "scoreTotalAttributes");
+};
 
 // src/lib/rating/criteria/scoring/metadata/metadata.ts
 var attributeScoringCriteria = {
-  "Metadata Attributes Individual": {
-    score: scoreIndividualAttributes,
-    weight: 2
-  },
-  "Metadata Attributes Total": {
-    score: scoreTotalAttributes,
-    weight: 2
-  }
+  "Metadata Attributes Individual": { score: scoreIndividualAttributes, weight: 2 },
+  "Metadata Attributes Total": { score: scoreTotalAttributes, weight: 2 }
 };
 var scoreMetadata = {
   ...attributeScoringCriteria
@@ -86,104 +61,78 @@ var median = 810308398217352e-7;
 var defaultMu2 = Math.log(median);
 var defaultSigma2 = 3;
 var mode = Math.exp(defaultMu2 - Math.pow(defaultSigma2, 2));
-var logNormalProbabilityDensity = /* @__PURE__ */ __name((x, mu = defaultMu2, sigma = defaultSigma2) => {
+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));
-}, "logNormalProbabilityDensity");
+};
 var maxProbabilityDensity2 = logNormalProbabilityDensity(mode);
 var maxScore3 = 10;
-var scoreTotal = /* @__PURE__ */ __name((nft) => {
+var scoreTotal = (nft) => {
   const density = logNormalProbabilityDensity(nft.total);
-  const score = [
-    density,
-    maxProbabilityDensity2
-  ];
+  const score = [density, maxProbabilityDensity2];
   return normalize3(score, maxScore3);
-}, "scoreTotal");
+};
 
 // src/lib/rating/criteria/index.ts
 var scoringCriteria = {
   ...scoreMetadata,
-  Total: {
-    score: scoreTotal,
-    weight: 2
-  }
+  Total: { score: scoreTotal, weight: 2 }
 };
 
 // src/lib/rating/analyzeNftCollection.ts
-var analyzeNftCollection = /* @__PURE__ */ __name(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
-    ];
-  })));
+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;
-}, "analyzeNftCollection");
+};
 
 // src/Diviner.ts
-var toNftCollectionScore = /* @__PURE__ */ __name((nftCollectionInfo, scores) => {
+var toNftCollectionScore = (nftCollectionInfo, scores) => {
   const { name, symbol, address, chainId, type } = nftCollectionInfo;
-  const metadata = {
-    address,
-    chainId,
-    name,
-    symbol,
-    type
-  };
-  return {
-    ...metadata,
-    schema: NftCollectionScoreSchema,
-    scores
-  };
-}, "toNftCollectionScore");
-var _NftCollectionScoreDiviner = class _NftCollectionScoreDiviner extends AbstractDiviner {
-  divineHandler = /* @__PURE__ */ __name(async (payloads) => {
+  const metadata = { address, chainId, name, symbol, type };
+  return { ...metadata, schema: NftCollectionScoreSchema, scores };
+};
+var NftCollectionScoreDiviner = class extends AbstractDiviner {
+  static configSchemas = [...super.configSchemas, NftCollectionScoreDivinerConfigSchema];
+  static defaultConfigSchema = NftCollectionScoreDivinerConfigSchema;
+  divineHandler = async (payloads) => {
     const nftCollectionInfos = (payloads == null ? void 0 : 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
-        PayloadBuilder.dataHash(nftCollectionInfo)
-      ]);
-      return {
-        ...score,
-        schema: NftCollectionScoreSchema,
-        sources: [
-          sourceHash
-        ]
-      };
-    }));
+    const results = await Promise.all(
+      nftCollectionInfos.map(async (nftCollectionInfo) => {
+        const [score, sourceHash] = await Promise.all([
+          // Get score
+          toNftCollectionScore(nftCollectionInfo, await analyzeNftCollection(nftCollectionInfo)),
+          // Hash sources
+          PayloadBuilder.dataHash(nftCollectionInfo)
+        ]);
+        return { ...score, schema: NftCollectionScoreSchema, sources: [sourceHash] };
+      })
+    );
     return results;
-  }, "divineHandler");
+  };
 };
-__name(_NftCollectionScoreDiviner, "NftCollectionScoreDiviner");
-__publicField(_NftCollectionScoreDiviner, "configSchemas", [
-  ...__superGet(_NftCollectionScoreDiviner, _NftCollectionScoreDiviner, "configSchemas"),
-  NftCollectionScoreDivinerConfigSchema
-]);
-__publicField(_NftCollectionScoreDiviner, "defaultConfigSchema", NftCollectionScoreDivinerConfigSchema);
-var NftCollectionScoreDiviner = _NftCollectionScoreDiviner;
 
 // 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";
-var NftCollectionScoreDivinerPlugin = /* @__PURE__ */ __name(() => createPayloadSetDivinerPlugin({
-  required: {
-    [NftSchema]: 1
-  },
-  schema: PayloadSetSchema
-}, {
-  diviner: /* @__PURE__ */ __name(async (params) => {
-    const result = await NftCollectionScoreDiviner.create(params);
-    return result;
-  }, "diviner")
-}), "NftCollectionScoreDivinerPlugin");
+var NftCollectionScoreDivinerPlugin = () => createPayloadSetDivinerPlugin(
+  { required: { [NftSchema]: 1 }, schema: PayloadSetSchema },
+  {
+    diviner: async (params) => {
+      const result = await NftCollectionScoreDiviner.create(params);
+      return result;
+    }
+  }
+);
 export {
   NftCollectionScoreDiviner,
   NftCollectionScoreDivinerPlugin,

package/dist/node/index.mjs.map

@@ -1 +1 @@
-{"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","../../src/Plugin.ts"],"sourcesContent":["import {\n  isNftCollectionInfo,\n  NftCollectionInfo,\n  NftCollectionMetadata,\n  NftCollectionScore,\n  NftCollectionScoreDivinerConfig,\n  NftCollectionScoreDivinerConfigSchema,\n  NftCollectionScoreSchema,\n} from '@xyo-network/crypto-nft-collection-payload-plugin'\nimport { AbstractDiviner } from '@xyo-network/diviner-abstract'\nimport { DivinerParams } from '@xyo-network/diviner-model'\nimport { AnyConfigSchema } from '@xyo-network/module-model'\nimport { PayloadBuilder } from '@xyo-network/payload-builder'\nimport { Payload, Schema } from '@xyo-network/payload-model'\n\nimport { analyzeNftCollection, NftCollectionAnalysis } from './lib/index.ts'\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 readonly configSchemas: Schema[] = [...super.configSchemas, NftCollectionScoreDivinerConfigSchema]\n  static override readonly defaultConfigSchema: Schema = 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          PayloadBuilder.dataHash(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).flatMap(([_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  // eslint-disable-next-line unicorn/no-array-reduce\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.ts'\nimport { scoreTotalAttributes } from './scoreTotalAttributes.ts'\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 = 81_030_839.821_735_2\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/index.ts'\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/index.ts'\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 { 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.ts'\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,SACEA,qBAKAC,uCACAC,gCACK;AACP,SAASC,uBAAuB;AAGhC,SAASC,sBAAsB;;;ACX/B,SAASC,iBAAwB;AAEjC,IAAMC,WAAW;AAEV,IAAMC,4BAA4B,wBAACC,SAAAA;AACxC,QAAM,EAAEC,WAAU,IAAKD,KAAKE,QAAQC;AACpC,QAAMC,UAAUC,OAAOD,QAAQH,UAAAA;AAC/B,MAAIG,QAAQE,WAAW,EAAG,QAAO;IAAC;IAAGR;;AACrC,QAAMS,SAASF,OAAOD,QAAQH,UAAAA,EAAYO,QAAQ,CAAC,CAACC,QAAQ,EAAEC,OAAM,CAAE,MAAC;AACrE,WAAOL,OAAOD,QAAQM,MAAAA,EAAQC,IAAW,CAAC,CAACC,aAAaV,OAAAA,MAAQ;AAC9D,YAAMW,SAASC,KAAKC,IAAID,KAAKE,OAAO,IAAId,QAAQe,SAASC,KAAKpB,QAAAA,GAAWA,QAAAA;AACzE,aAAO;QAACe;QAAQf;;IAClB,CAAA;EACF,CAAA;AAEA,QAAMqB,QAAQZ,OAAOa,OAAc,CAAC,CAACC,GAAGC,CAAAA,GAAI,CAACC,GAAGC,CAAAA,MAAO;IAACH,IAAIE;IAAGD,IAAIE;KAAI;IAAC;IAAG;GAAE;AAC7E,SAAOC,UAAUN,OAAOrB,QAAAA;AAC1B,GAbyC;;;ACJzC,SAAS4B,aAAAA,kBAAwB;AAEjC,IAAMC,YAAW;AAKjB,IAAMC,YAAY;AAKlB,IAAMC,eAAe;AASrB,IAAMC,6BAA6B,wBAACC,GAAWC,KAAaJ,WAAWK,QAAgBJ,iBAAY;AACjG,QAAMK,YAAYC,KAAKC,KAAK,IAAID,KAAKE,EAAE;AACvC,QAAMC,cAAcL,QAAQC;AAC5B,QAAMK,QAAQ,OAAOJ,KAAKK,KAAKT,IAAIC,MAAMC,OAAO,CAAA;AAChD,SAAQ,IAAIK,cAAeH,KAAKM,IAAIF,KAAAA;AACtC,GALmC;AAUnC,IAAMG,wBAAwBZ,2BAA2BF,SAAAA;AAsBlD,IAAMe,uBAAuB,wBAACC,SAAAA;AACnC,QAAM,EAAEC,WAAU,IAAKD,KAAKE,QAAQC;AAGpC,QAAMC,mBAAmBC,OAAOC,QAAQL,UAAAA,EAAYM,OAAO,CAACC,KAAK,CAACC,QAAQ,EAAEP,QAAO,CAAE,MAAC;AACpF,WAAOM,MAAMN,QAAQQ,SAASC;EAChC,GAAG,CAAA;AACH,QAAMC,qBAAqB1B,2BAA2BkB,gBAAAA;AACtD,QAAMS,QAAe;IAACD;IAAoBd;;AAC1C,SAAOgB,WAAUD,OAAO9B,SAAAA;AAC1B,GAVoC;;;AChD7B,IAAMgC,2BAA0F;EACrG,kCAAkC;IAAEC,OAAOC;IAA2BC,QAAQ;EAAE;EAChF,6BAA6B;IAAEF,OAAOG;IAAsBD,QAAQ;EAAE;AACxE;AAEO,IAAME,gBAA+E;EAC1F,GAAGL;AACL;;;ACZA,SAASM,aAAAA,kBAAwB;AAOjC,IAAMC,SAAS;AACf,IAAMC,aAAYC,KAAKC,IAAIH,MAAAA;AAC3B,IAAMI,gBAAe;AACrB,IAAMC,OAAOH,KAAKI,IAAIL,aAAYC,KAAKK,IAAIH,eAAc,CAAA,CAAA;AAQzD,IAAMI,8BAA8B,wBAACC,GAAWC,KAAaT,YAAWU,QAAgBP,kBAAY;AAClG,MAAIK,KAAK,EAAG,QAAO;AACnB,QAAMG,OAAOV,KAAKC,IAAIM,CAAAA;AACtB,SAAQ,KAAKA,IAAIE,QAAQT,KAAKW,KAAK,IAAIX,KAAKY,EAAE,KAAMZ,KAAKI,IAAI,OAAOJ,KAAKK,KAAKK,OAAOF,MAAMC,OAAO,CAAA,CAAA;AACpG,GAJoC;AASpC,IAAMI,yBAAwBP,4BAA4BH,IAAAA;AAE1D,IAAMW,YAAW;AAcV,IAAMC,aAAa,wBAACC,QAAAA;AACzB,QAAMC,UAAUX,4BAA4BU,IAAIE,KAAK;AACrD,QAAMC,QAAe;IAACF;IAASJ;;AAC/B,SAAOO,WAAUD,OAAOL,SAAAA;AAC1B,GAJ0B;;;ACvCnB,IAAMO,kBAAiF;EAC5F,GAAGC;EACHC,OAAO;IAAEC,OAAOC;IAAYC,QAAQ;EAAE;AACxC;;;ACGO,IAAMC,uBAAuB,8BAIlCC,QAAAA;AAEA,QAAMC,SAASC,OAAOC,YACpB,MAAMC,QAAQC,IACZH,OAAOI,QAAQC,eAAAA,EAAiBC,IAAI,OAAO,CAACC,KAAK,EAAEC,OAAOC,OAAM,CAAE,MAAC;AACjE,UAAMC,WAAW,MAAMF,MAAMV,GAAAA;AAC7B,UAAMa,WAAWD,SAASJ,IAAIM,CAAAA,MAAKA,IAAIH,MAAAA;AACvC,WAAO;MAACF;MAAKI;;EACf,CAAA,CAAA,CAAA;AAGJ,SAAOZ;AACT,GAhBoC;;;ANQpC,IAAMc,uBAAuB,wBAACC,mBAAsCC,WAAAA;AAClE,QAAM,EAAEC,MAAMC,QAAQC,SAASC,SAASC,KAAI,IAAKN;AACjD,QAAMO,WAAkC;IAAEH;IAASC;IAASH;IAAMC;IAAQG;EAAK;AAC/E,SAAO;IAAE,GAAGC;IAAUC,QAAQC;IAA0BR;EAAO;AACjE,GAJ6B;AAMtB,IAAMS,6BAAN,MAAMA,mCAEHC,gBAAAA;EAIWC,gBAAgB,8BAAOC,aAAAA;AACxC,UAAMC,sBAAqBD,qCAAUE,OAAOC,yBAAwB,CAAA;AACpE,UAAMC,UAAU,MAAMC,QAAQC,IAC5BL,mBAAmBM,IAAiC,OAAOpB,sBAAAA;AACzD,YAAM,CAACqB,OAAOC,UAAAA,IAAc,MAAMJ,QAAQC,IAAI;;QAE5CpB,qBAAqBC,mBAAmB,MAAMuB,qBAAqBvB,iBAAAA,CAAAA;;QAEnEwB,eAAeC,SAASzB,iBAAAA;OACzB;AACD,aAAO;QAAE,GAAGqB;QAAOb,QAAQC;QAA0BiB,SAAS;UAACJ;;MAAY;IAC7E,CAAA,CAAA;AAEF,WAAOL;EACT,GAdmC;AAerC;AAnBUN;AACR,cAHWD,4BAGciB,iBAA0B;KAAI,mEAAMA;EAAeC;;AAC5E,cAJWlB,4BAIcmB,uBAA8BD;AAJlD,IAAMlB,4BAAN;;;AOzBP,SAASoB,iBAAiB;AAC1B,SAASC,wBAAwB;AACjC,SAASC,qCAAqC;AAIvC,IAAMC,kCAAkC,6BAC7CC,8BACE;EAAEC,UAAU;IAAE,CAACC,SAAAA,GAAY;EAAE;EAAGC,QAAQC;AAAiB,GACzD;EACEC,SAAS,8BAAOC,WAAAA;AACd,UAAMC,SAAS,MAAMC,0BAA0BC,OAAOH,MAAAA;AACtD,WAAOC;EACT,GAHS;AAIX,CAAA,GAR2C;","names":["isNftCollectionInfo","NftCollectionScoreDivinerConfigSchema","NftCollectionScoreSchema","AbstractDiviner","PayloadBuilder","normalize","maxScore","scoreIndividualAttributes","info","attributes","metrics","metadata","entries","Object","length","scores","flatMap","_trait","values","map","_traitValue","rarity","Math","min","round","binomial","p","total","reduce","a","b","c","d","normalize","normalize","maxScore","defaultMu","defaultSigma","gaussianProbabilityDensity","x","mu","sigma","sqrtTwoPi","Math","sqrt","PI","denominator","power","pow","exp","maxProbabilityDensity","scoreTotalAttributes","info","attributes","metrics","metadata","jointProbability","Object","entries","reduce","acc","_trait","binomial","p","probabilityDensity","score","normalize","attributeScoringCriteria","score","scoreIndividualAttributes","weight","scoreTotalAttributes","scoreMetadata","normalize","median","defaultMu","Math","log","defaultSigma","mode","exp","pow","logNormalProbabilityDensity","x","mu","sigma","logX","sqrt","PI","maxProbabilityDensity","maxScore","scoreTotal","nft","density","total","score","normalize","scoringCriteria","scoreMetadata","Total","score","scoreTotal","weight","analyzeNftCollection","nft","result","Object","fromEntries","Promise","all","entries","scoringCriteria","map","key","score","weight","rawScore","weighted","v","toNftCollectionScore","nftCollectionInfo","scores","name","symbol","address","chainId","type","metadata","schema","NftCollectionScoreSchema","NftCollectionScoreDiviner","AbstractDiviner","divineHandler","payloads","nftCollectionInfos","filter","isNftCollectionInfo","results","Promise","all","map","score","sourceHash","analyzeNftCollection","PayloadBuilder","dataHash","sources","configSchemas","NftCollectionScoreDivinerConfigSchema","defaultConfigSchema","NftSchema","PayloadSetSchema","createPayloadSetDivinerPlugin","NftCollectionScoreDivinerPlugin","createPayloadSetDivinerPlugin","required","NftSchema","schema","PayloadSetSchema","diviner","params","result","NftCollectionScoreDiviner","create"]}
+{"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","../../src/Plugin.ts"],"sourcesContent":["import {\n  isNftCollectionInfo,\n  NftCollectionInfo,\n  NftCollectionMetadata,\n  NftCollectionScore,\n  NftCollectionScoreDivinerConfig,\n  NftCollectionScoreDivinerConfigSchema,\n  NftCollectionScoreSchema,\n} from '@xyo-network/crypto-nft-collection-payload-plugin'\nimport { AbstractDiviner } from '@xyo-network/diviner-abstract'\nimport { DivinerParams } from '@xyo-network/diviner-model'\nimport { AnyConfigSchema } from '@xyo-network/module-model'\nimport { PayloadBuilder } from '@xyo-network/payload-builder'\nimport { Payload, Schema } from '@xyo-network/payload-model'\n\nimport { analyzeNftCollection, NftCollectionAnalysis } from './lib/index.ts'\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 readonly configSchemas: Schema[] = [...super.configSchemas, NftCollectionScoreDivinerConfigSchema]\n  static override readonly defaultConfigSchema: Schema = 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          PayloadBuilder.dataHash(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).flatMap(([_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  // eslint-disable-next-line unicorn/no-array-reduce\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.ts'\nimport { scoreTotalAttributes } from './scoreTotalAttributes.ts'\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 = 81_030_839.821_735_2\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/index.ts'\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/index.ts'\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 { 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.ts'\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;AAAA,EACE;AAAA,EAKA;AAAA,EACA;AAAA,OACK;AACP,SAAS,uBAAuB;AAGhC,SAAS,sBAAsB;;;ACX/B,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,EAAG,QAAO,CAAC,GAAG,QAAQ;AAC7C,QAAM,SAAS,OAAO,QAAQ,UAAU,EAAE,QAAQ,CAAC,CAAC,QAAQ,EAAE,OAAO,CAAC,MAAM;AAC1E,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;AAED,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;;;ACjBA,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,EAAG,QAAO;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,OAAK,IAAI,MAAM;AAC7C,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,OAAyB,gBAA0B,CAAC,GAAG,MAAM,eAAe,qCAAqC;AAAA,EACjH,OAAyB,sBAA8B;AAAA,EAEpC,gBAAgB,OAAO,aAA6C;AACrF,UAAM,sBAAqB,qCAAU,OAAO,yBAAwB,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,eAAe,SAAS,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;;;AO9CA,SAAS,iBAAiB;AAC1B,SAAS,wBAAwB;AACjC,SAAS,qCAAqC;AAIvC,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/package.json

@@ -10,22 +10,22 @@
     "url": "https://github.com/XYOracleNetwork/plugins/issues"
   },
   "dependencies": {
-    "@xyo-network/crypto-nft-collection-payload-plugin": "^2.99.5",
-    "@xyo-network/crypto-nft-payload-plugin": "^2.99.5",
-    "@xyo-network/crypto-nft-score-model": "^2.99.5",
-    "@xyo-network/diviner-abstract": "^2.111.2",
-    "@xyo-network/diviner-model": "^2.111.2",
-    "@xyo-network/module-model": "^2.111.2",
-    "@xyo-network/payload-builder": "^2.111.2",
-    "@xyo-network/payload-model": "^2.111.2",
-    "@xyo-network/payloadset-plugin": "^2.111.2"
+    "@xyo-network/crypto-nft-collection-payload-plugin": "^2.99.6",
+    "@xyo-network/crypto-nft-payload-plugin": "^2.99.6",
+    "@xyo-network/crypto-nft-score-model": "^2.99.6",
+    "@xyo-network/diviner-abstract": "^2.111.3",
+    "@xyo-network/diviner-model": "^2.111.3",
+    "@xyo-network/module-model": "^2.111.3",
+    "@xyo-network/payload-builder": "^2.111.3",
+    "@xyo-network/payload-model": "^2.111.3",
+    "@xyo-network/payloadset-plugin": "^2.111.3"
   },
   "devDependencies": {
-    "@xylabs/jest-helpers": "^3.6.8",
-    "@xylabs/ts-scripts-yarn3": "^3.15.13",
-    "@xylabs/tsconfig": "^3.15.13",
-    "@xyo-network/account": "^2.111.2",
-    "@xyo-network/payload-wrapper": "^2.111.2",
+    "@xylabs/jest-helpers": "^3.6.12",
+    "@xylabs/ts-scripts-yarn3": "^3.15.14",
+    "@xylabs/tsconfig": "^3.15.14",
+    "@xyo-network/account": "^2.111.3",
+    "@xyo-network/payload-wrapper": "^2.111.3",
     "ethers": "^6.13.2",
     "jest": "^29.7.0",
     "typescript": "^5.5.4"
@@ -69,6 +69,6 @@
     "url": "https://github.com/XYOracleNetwork/plugins.git"
   },
   "sideEffects": false,
-  "version": "2.99.5",
+  "version": "2.99.6",
   "type": "module"
 }