@xyo-network/crypto-nft-collection-diviner-score-plugin 2.70.9

package/dist/esm/Diviner.js

@@ -0,0 +1,25 @@
+import { AbstractDiviner } from '@xyo-network/abstract-diviner';
+import { PayloadHasher } from '@xyo-network/core';
+import { isNftCollectionInfoPayload, NftCollectionScoreDivinerConfigSchema, NftCollectionScoreSchema, } from '@xyo-network/crypto-nft-collection-payload-plugin';
+import { analyzeNftCollection } from './lib';
+const toNftCollectionScorePayload = (rating) => {
+    return { ...rating, schema: NftCollectionScoreSchema };
+};
+export const isNftCollectionScorePayload = (payload) => payload.schema === NftCollectionScoreSchema;
+export class NftCollectionScoreDiviner extends AbstractDiviner {
+    static configSchemas = [NftCollectionScoreDivinerConfigSchema];
+    divineHandler = async (payloads) => {
+        const nfts = payloads?.filter(isNftCollectionInfoPayload) ?? [];
+        const results = await Promise.all(nfts.map(async (p) => {
+            const [score, sourceHash] = await Promise.all([
+                // Get score
+                toNftCollectionScorePayload(await analyzeNftCollection(p)),
+                // Hash sources
+                PayloadHasher.hashAsync(p),
+            ]);
+            return { ...score, schema: NftCollectionScoreSchema, sources: [sourceHash] };
+        }));
+        return results;
+    };
+}
+//# sourceMappingURL=Diviner.js.map

package/dist/esm/Diviner.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Diviner.js","sourceRoot":"","sources":["../../src/Diviner.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAA;AAC/D,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAA;AACjD,OAAO,EACL,0BAA0B,EAE1B,qCAAqC,EAErC,wBAAwB,GACzB,MAAM,mDAAmD,CAAA;AAK1D,OAAO,EAAE,oBAAoB,EAAyB,MAAM,OAAO,CAAA;AAInE,MAAM,2BAA2B,GAAG,CAAC,MAA6B,EAA6B,EAAE;IAC/F,OAAO,EAAE,GAAG,MAAM,EAAE,MAAM,EAAE,wBAAwB,EAA0C,CAAA;AAChG,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,OAAgB,EAAwC,EAAE,CAAC,OAAO,CAAC,MAAM,KAAK,wBAAwB,CAAA;AAElJ,MAAM,OAAO,yBAEX,SAAQ,eAAwB;IAChC,MAAM,CAAU,aAAa,GAAG,CAAC,qCAAqC,CAAC,CAAA;IAEpD,aAAa,GAAG,KAAK,EAAE,QAAoB,EAAsB,EAAE;QACpF,MAAM,IAAI,GAAG,QAAQ,EAAE,MAAM,CAAC,0BAA0B,CAAC,IAAI,EAAE,CAAA;QAC/D,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAC/B,IAAI,CAAC,GAAG,CAAqC,KAAK,EAAE,CAAC,EAAE,EAAE;YACvD,MAAM,CAAC,KAAK,EAAE,UAAU,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;gBAC5C,YAAY;gBACZ,2BAA2B,CAAC,MAAM,oBAAoB,CAAC,CAAC,CAAC,CAAC;gBAC1D,eAAe;gBACf,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC;aAC3B,CAAC,CAAA;YACF,OAAO,EAAE,GAAG,KAAK,EAAE,MAAM,EAAE,wBAAwB,EAAE,OAAO,EAAE,CAAC,UAAU,CAAC,EAA+B,CAAA;QAC3G,CAAC,CAAC,CACH,CAAA;QACD,OAAO,OAAO,CAAA;IAChB,CAAC,CAAA"}

package/dist/esm/Plugin.js

@@ -0,0 +1,11 @@
+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';
+export const NftCollectionScoreDivinerPlugin = () => createPayloadSetDivinerPlugin({ required: { [NftSchema]: 1 }, schema: PayloadSetSchema }, {
+    diviner: async (params) => {
+        const result = await NftCollectionScoreDiviner.create(params);
+        return result;
+    },
+});
+//# sourceMappingURL=Plugin.js.map

package/dist/esm/Plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Plugin.js","sourceRoot":"","sources":["../../src/Plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,wCAAwC,CAAA;AAClE,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAA;AAC7D,OAAO,EAAE,6BAA6B,EAAE,MAAM,gCAAgC,CAAA;AAE9E,OAAO,EAAE,yBAAyB,EAAE,MAAM,WAAW,CAAA;AAErD,MAAM,CAAC,MAAM,+BAA+B,GAAG,GAAG,EAAE,CAClD,6BAA6B,CAC3B,EAAE,QAAQ,EAAE,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,gBAAgB,EAAE,EAC1D;IACE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE;QACxB,MAAM,MAAM,GAAG,MAAM,yBAAyB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;QAC7D,OAAO,MAAM,CAAA;IACf,CAAC;CACF,CACF,CAAA"}

package/dist/esm/index.js

@@ -0,0 +1,7 @@
+import { NftCollectionScoreDivinerPlugin } from './Plugin';
+export * from './Diviner';
+export * from './lib';
+export { NftCollectionScoreDivinerPlugin };
+// eslint-disable-next-line import/no-default-export
+export default NftCollectionScoreDivinerPlugin;
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,+BAA+B,EAAE,MAAM,UAAU,CAAA;AAE1D,cAAc,WAAW,CAAA;AACzB,cAAc,OAAO,CAAA;AAErB,OAAO,EAAE,+BAA+B,EAAE,CAAA;AAE1C,oDAAoD;AACpD,eAAe,+BAA+B,CAAA"}

package/dist/esm/lib/index.js

@@ -0,0 +1,2 @@
+export * from './rating';
+//# sourceMappingURL=index.js.map

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

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

package/dist/esm/lib/rating/analyzeNftCollection.js

@@ -0,0 +1,14 @@
+import { scoringCriteria } from './criteria';
+export const analyzeNftCollection = async (
+/**
+ * The NFT to evaluate
+ */
+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;
+};
+//# sourceMappingURL=analyzeNftCollection.js.map

package/dist/esm/lib/rating/analyzeNftCollection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"analyzeNftCollection.js","sourceRoot":"","sources":["../../../../src/lib/rating/analyzeNftCollection.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA;AAQ5C,MAAM,CAAC,MAAM,oBAAoB,GAAG,KAAK;AACvC;;GAEG;AACH,GAAsB,EACU,EAAE;IAClC,MAAM,MAAM,GAAG,MAAM,CAAC,WAAW,CAC/B,MAAM,OAAO,CAAC,GAAG,CACf,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,GAAG,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,EAAE,EAAE;QACrE,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,CAAA;QACjC,MAAM,QAAQ,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,MAAM,CAAU,CAAA;QACzD,OAAO,CAAC,GAAG,EAAE,QAAQ,CAAU,CAAA;IACjC,CAAC,CAAC,CACH,CACuB,CAAA;IAC1B,OAAO,MAAM,CAAA;AACf,CAAC,CAAA"}

package/dist/esm/lib/rating/criteria/index.js

@@ -0,0 +1,34 @@
+const median = 100000;
+const defaultMu = Math.log(median);
+const defaultSigma = 2;
+// const mean = Math.exp(defaultMu + Math.pow(defaultSigma, 2) / 2)
+const mode = Math.exp(defaultMu - Math.pow(defaultSigma, 2));
+// console.log(`mean: ${mean} median: ${median} mode: ${mode}`)
+/**
+ * Calculates the log-normal probability density
+ * @param x the value at which you want to calculate the probability density
+ * @param mu mean of the associated normal distribution
+ * @param sigma standard deviation of the associated normal distribution
+ * @returns
+ */
+const logNormalProbabilityDensity = (x, mu = defaultMu, sigma = defaultSigma) => {
+    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));
+};
+/**
+ * For a lognormal distribution, the peak of the distribution is the mode
+ */
+const maxProbabilityDensity = logNormalProbabilityDensity(mode);
+// console.log(`mode: ${mode} maxDensity: ${maxProbabilityDensity}`)
+const scoreTotal = async (nft) => {
+    const density = logNormalProbabilityDensity(nft.total);
+    const normalized = density / maxProbabilityDensity;
+    const score = Math.min(Math.floor(normalized * 100), 100);
+    return await Promise.resolve([score, 100]);
+};
+export const scoringCriteria = {
+    total: { score: scoreTotal, weight: 1 },
+};
+//# sourceMappingURL=index.js.map

package/dist/esm/lib/rating/criteria/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/lib/rating/criteria/index.ts"],"names":[],"mappings":"AAGA,MAAM,MAAM,GAAG,MAAM,CAAA;AACrB,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;AAClC,MAAM,YAAY,GAAG,CAAC,CAAA;AACtB,mEAAmE;AACnE,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,CAAA;AAC5D,+DAA+D;AAE/D;;;;;;GAMG;AACH,MAAM,2BAA2B,GAAG,CAAC,CAAS,EAAE,KAAa,SAAS,EAAE,QAAgB,YAAY,EAAU,EAAE;IAC9G,IAAI,CAAC,IAAI,CAAC;QAAE,OAAO,CAAC,CAAA;IACpB,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;IACxB,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,GAAG,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,CAAA;AACvG,CAAC,CAAA;AAED;;GAEG;AACH,MAAM,qBAAqB,GAAG,2BAA2B,CAAC,IAAI,CAAC,CAAA;AAC/D,oEAAoE;AAEpE,MAAM,UAAU,GAAG,KAAK,EAAE,GAAsB,EAAkB,EAAE;IAClE,MAAM,OAAO,GAAG,2BAA2B,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;IACtD,MAAM,UAAU,GAAG,OAAO,GAAG,qBAAqB,CAAA;IAClD,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,GAAG,GAAG,CAAC,EAAE,GAAG,CAAC,CAAA;IACzD,OAAO,MAAM,OAAO,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAA;AAC5C,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,KAAK,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC,EAAE;CACxC,CAAA"}

package/dist/esm/lib/rating/index.js

@@ -0,0 +1,2 @@
+export * from './analyzeNftCollection';
+//# sourceMappingURL=index.js.map

package/dist/esm/lib/rating/index.js.map

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

package/dist/types/Diviner.d.ts

@@ -0,0 +1,16 @@
+import { AbstractDiviner } from '@xyo-network/abstract-diviner';
+import { NftCollectionScoreDivinerConfig } from '@xyo-network/crypto-nft-collection-payload-plugin';
+import { DivinerParams } from '@xyo-network/diviner-model';
+import { AnyConfigSchema } from '@xyo-network/module';
+import { Payload } from '@xyo-network/payload-model';
+export type NftCollectionScoreDivinerParams = DivinerParams<AnyConfigSchema<NftCollectionScoreDivinerConfig>>;
+export declare const isNftCollectionScorePayload: (payload: Payload) => payload is import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & {
+    schema: "network.xyo.crypto.nft.collection.score";
+} & Partial<Omit<import("@xyo-network/crypto-nft-collection-payload-plugin").NftCollectionAnalysis, "schema">> & {
+    schema: "network.xyo.crypto.nft.collection.score";
+};
+export declare class NftCollectionScoreDiviner<TParams extends NftCollectionScoreDivinerParams = NftCollectionScoreDivinerParams> extends AbstractDiviner<TParams> {
+    static configSchemas: "network.xyo.crypto.nft.collection.score.diviner.config"[];
+    protected divineHandler: (payloads?: Payload[]) => Promise<Payload[]>;
+}
+//# sourceMappingURL=Diviner.d.ts.map

package/dist/types/Diviner.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Diviner.d.ts","sourceRoot":"","sources":["../../src/Diviner.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAA;AAE/D,OAAO,EAEL,+BAA+B,EAIhC,MAAM,mDAAmD,CAAA;AAC1D,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAC1D,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAA;AACrD,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAIpD,MAAM,MAAM,+BAA+B,GAAG,aAAa,CAAC,eAAe,CAAC,+BAA+B,CAAC,CAAC,CAAA;AAM7G,eAAO,MAAM,2BAA2B,YAAa,OAAO;;;;CAAsF,CAAA;AAElJ,qBAAa,yBAAyB,CACpC,OAAO,SAAS,+BAA+B,GAAG,+BAA+B,CACjF,SAAQ,eAAe,CAAC,OAAO,CAAC;IAChC,OAAgB,aAAa,6DAA0C;IAEvE,UAAmB,aAAa,cAAqB,OAAO,EAAE,KAAG,QAAQ,OAAO,EAAE,CAAC,CAclF;CACF"}

package/dist/types/Plugin.d.ts

@@ -0,0 +1,47 @@
+import { NftCollectionScoreDiviner } from './Diviner';
+export declare const NftCollectionScoreDivinerPlugin: () => import("@xyo-network/payloadset-plugin").PayloadSetDivinerPlugin<NftCollectionScoreDiviner<import("@xyo-network/core").BaseParamsFields & {
+    account?: import("@xyo-network/account-model").AccountInstance | "random" | undefined;
+    accountDerivationPath?: string | undefined;
+    config: import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & {
+        readonly archivist?: import("@xyo-network/module-model").ArchivistModuleConfig | undefined;
+        readonly name?: string | undefined;
+        readonly paging?: Record<string, {
+            size?: number | undefined;
+        }> | undefined;
+        readonly schema: string;
+        readonly security?: {
+            readonly allowAnonymous?: boolean | undefined;
+            readonly allowed?: Record<string, (string | import("@xyo-network/module-model").CosigningAddressSet)[]> | undefined;
+            readonly disallowed?: Record<string, string[]> | undefined;
+        } | undefined;
+        readonly sign?: boolean | undefined;
+        readonly storeQueries?: boolean | undefined;
+    } & Omit<Omit<import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & {
+        readonly archivist?: import("@xyo-network/module-model").ArchivistModuleConfig | undefined;
+        readonly name?: string | undefined;
+        readonly paging?: Record<string, {
+            size?: number | undefined;
+        }> | undefined;
+        readonly schema: "network.xyo.crypto.nft.collection.score.diviner.config";
+        readonly security?: {
+            readonly allowAnonymous?: boolean | undefined;
+            readonly allowed?: Record<string, (string | import("@xyo-network/module-model").CosigningAddressSet)[]> | undefined;
+            readonly disallowed?: Record<string, string[]> | undefined;
+        } | undefined;
+        readonly sign?: boolean | undefined;
+        readonly storeQueries?: boolean | undefined;
+    } & Omit<{
+        schema: "network.xyo.crypto.nft.collection.score.diviner.config";
+    } & Omit<{
+        schema: "network.xyo.crypto.nft.collection.score.diviner.config";
+    }, "schema">, "schema"> & {
+        schema: "network.xyo.crypto.nft.collection.score.diviner.config";
+    }, "schema"> & {
+        schema: string;
+    }, "schema"> & {
+        schema: string;
+    };
+    ephemeralQueryAccountEnabled?: boolean | undefined;
+    wallet?: import("@xyo-network/wallet-model").WalletInstance | undefined;
+}>>;
+//# sourceMappingURL=Plugin.d.ts.map

package/dist/types/Plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Plugin.d.ts","sourceRoot":"","sources":["../../src/Plugin.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,yBAAyB,EAAE,MAAM,WAAW,CAAA;AAErD,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GASzC,CAAA"}

package/dist/types/index.d.ts

@@ -0,0 +1,6 @@
+import { NftCollectionScoreDivinerPlugin } from './Plugin';
+export * from './Diviner';
+export * from './lib';
+export { NftCollectionScoreDivinerPlugin };
+export default NftCollectionScoreDivinerPlugin;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,+BAA+B,EAAE,MAAM,UAAU,CAAA;AAE1D,cAAc,WAAW,CAAA;AACzB,cAAc,OAAO,CAAA;AAErB,OAAO,EAAE,+BAA+B,EAAE,CAAA;AAG1C,eAAe,+BAA+B,CAAA"}

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

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

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

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

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

@@ -0,0 +1,9 @@
+import { NftCollectionInfo } from '@xyo-network/crypto-nft-collection-payload-plugin';
+import { Score } from '@xyo-network/crypto-nft-score-model';
+import { scoringCriteria } from './criteria';
+export type ScoringCriteriaKey = keyof typeof scoringCriteria & PropertyKey;
+export type NftCollectionAnalysis = {
+    [key in ScoringCriteriaKey]: Score;
+};
+export declare const analyzeNftCollection: (nft: NftCollectionInfo) => Promise<NftCollectionAnalysis>;
+//# sourceMappingURL=analyzeNftCollection.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"analyzeNftCollection.d.ts","sourceRoot":"","sources":["../../../../src/lib/rating/analyzeNftCollection.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,mDAAmD,CAAA;AACrF,OAAO,EAAE,KAAK,EAAE,MAAM,qCAAqC,CAAA;AAE3D,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA;AAE5C,MAAM,MAAM,kBAAkB,GAAG,MAAM,OAAO,eAAe,GAAG,WAAW,CAAA;AAE3E,MAAM,MAAM,qBAAqB,GAAG;KACjC,GAAG,IAAI,kBAAkB,GAAG,KAAK;CACnC,CAAA;AAED,eAAO,MAAM,oBAAoB,QAI1B,iBAAiB,KACrB,QAAQ,qBAAqB,CAW/B,CAAA"}

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

@@ -0,0 +1,9 @@
+import { NftCollectionInfo } from '@xyo-network/crypto-nft-collection-payload-plugin';
+import { Score } from '@xyo-network/crypto-nft-score-model';
+export declare const scoringCriteria: {
+    total: {
+        score: (nft: NftCollectionInfo) => Promise<Score>;
+        weight: number;
+    };
+};
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/lib/rating/criteria/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,mDAAmD,CAAA;AACrF,OAAO,EAAE,KAAK,EAAE,MAAM,qCAAqC,CAAA;AAmC3D,eAAO,MAAM,eAAe;;qBAPG,iBAAiB,KAAG,QAAQ,KAAK,CAAC;;;CAShE,CAAA"}

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

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

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

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

package/package.json

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

package/src/Diviner.ts

@@ -0,0 +1,44 @@
+import { AbstractDiviner } from '@xyo-network/abstract-diviner'
+import { PayloadHasher } from '@xyo-network/core'
+import {
+  isNftCollectionInfoPayload,
+  NftCollectionScoreDivinerConfig,
+  NftCollectionScoreDivinerConfigSchema,
+  NftCollectionScorePayload,
+  NftCollectionScoreSchema,
+} from '@xyo-network/crypto-nft-collection-payload-plugin'
+import { DivinerParams } from '@xyo-network/diviner-model'
+import { AnyConfigSchema } from '@xyo-network/module'
+import { Payload } from '@xyo-network/payload-model'
+
+import { analyzeNftCollection, NftCollectionAnalysis } from './lib'
+
+export type NftCollectionScoreDivinerParams = DivinerParams<AnyConfigSchema<NftCollectionScoreDivinerConfig>>
+
+const toNftCollectionScorePayload = (rating: NftCollectionAnalysis): NftCollectionScorePayload => {
+  return { ...rating, schema: NftCollectionScoreSchema } as unknown as NftCollectionScorePayload
+}
+
+export const isNftCollectionScorePayload = (payload: Payload): payload is NftCollectionScorePayload => payload.schema === NftCollectionScoreSchema
+
+export class NftCollectionScoreDiviner<
+  TParams extends NftCollectionScoreDivinerParams = NftCollectionScoreDivinerParams,
+> extends AbstractDiviner<TParams> {
+  static override configSchemas = [NftCollectionScoreDivinerConfigSchema]
+
+  protected override divineHandler = async (payloads?: Payload[]): Promise<Payload[]> => {
+    const nfts = payloads?.filter(isNftCollectionInfoPayload) ?? []
+    const results = await Promise.all(
+      nfts.map<Promise<NftCollectionScorePayload>>(async (p) => {
+        const [score, sourceHash] = await Promise.all([
+          // Get score
+          toNftCollectionScorePayload(await analyzeNftCollection(p)),
+          // Hash sources
+          PayloadHasher.hashAsync(p),
+        ])
+        return { ...score, schema: NftCollectionScoreSchema, sources: [sourceHash] } as NftCollectionScorePayload
+      }),
+    )
+    return results
+  }
+}

package/src/Plugin.ts

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

package/src/index.ts

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

package/src/lib/index.ts

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

package/src/lib/rating/analyzeNftCollection.ts

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

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

@@ -0,0 +1,39 @@
+import { NftCollectionInfo } from '@xyo-network/crypto-nft-collection-payload-plugin'
+import { Score } from '@xyo-network/crypto-nft-score-model'
+
+const median = 100000
+const defaultMu = Math.log(median)
+const defaultSigma = 2
+// const mean = Math.exp(defaultMu + Math.pow(defaultSigma, 2) / 2)
+const mode = Math.exp(defaultMu - Math.pow(defaultSigma, 2))
+// console.log(`mean: ${mean} median: ${median} mode: ${mode}`)
+
+/**
+ * Calculates the log-normal probability density
+ * @param x the value at which you want to calculate the probability density
+ * @param mu mean of the associated normal distribution
+ * @param sigma standard deviation of the associated normal distribution
+ * @returns
+ */
+const logNormalProbabilityDensity = (x: number, mu: number = defaultMu, sigma: number = defaultSigma): number => {
+  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))
+}
+
+/**
+ * For a lognormal distribution, the peak of the distribution is the mode
+ */
+const maxProbabilityDensity = logNormalProbabilityDensity(mode)
+// console.log(`mode: ${mode} maxDensity: ${maxProbabilityDensity}`)
+
+const scoreTotal = async (nft: NftCollectionInfo): Promise<Score> => {
+  const density = logNormalProbabilityDensity(nft.total)
+  const normalized = density / maxProbabilityDensity
+  const score = Math.min(Math.floor(normalized * 100), 100)
+  return await Promise.resolve([score, 100])
+}
+
+export const scoringCriteria = {
+  total: { score: scoreTotal, weight: 1 },
+}

package/src/lib/rating/index.ts

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

package/typedoc.json

@@ -0,0 +1,5 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "entryPoints": ["./src/index.ts"],
+  "tsconfig": "./tsconfig.typedoc.json"
+}