@xyo-network/crypto-nft-collection-diviner-score-plugin 3.1.0 → 3.1.2

package/dist/browser/Plugin.d.ts

@@ -1,8 +1,8 @@
 import { NftCollectionScoreDiviner } from './Diviner.ts';
 export declare const NftCollectionScoreDivinerPlugin: () => import("@xyo-network/payloadset-plugin").PayloadSetDivinerPlugin<NftCollectionScoreDiviner<import("@xylabs/object").BaseParamsFields & {
-    account?: import(".store/@xyo-network-account-model-virtual-0c2e9849ce/package").AccountInstance | "random";
+    account?: import(".store/@xyo-network-account-model-virtual-b94ae9d87c/package").AccountInstance | "random";
     addToResolvers?: boolean;
-    additionalSigners?: import(".store/@xyo-network-account-model-virtual-0c2e9849ce/package").AccountInstance[];
+    additionalSigners?: import(".store/@xyo-network-account-model-virtual-b94ae9d87c/package").AccountInstance[];
     allowNameResolution?: boolean;
     config: import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & Omit<import("@xyo-network/module-model").ArchivingModuleConfig & import("@xyo-network/module-model").ModuleConfigFields & import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & Omit<import("@xyo-network/module-model").ArchivingModuleConfig & import("@xyo-network/module-model").ModuleConfigFields & {
         schema: "network.xyo.crypto.nft.collection.score.diviner.config";

package/dist/browser/lib/rating/criteria/scoring/metadata/scoreTotalAttributes.d.ts

@@ -1,4 +1,24 @@
 import type { NftCollectionAttributeMetrics } from '@xyo-network/crypto-nft-collection-payload-plugin';
 import type { Score } from '@xyo-network/crypto-nft-score-model';
+/**
+ * We're working on some assumptions here:
+ *
+ * - If you have a 100% chance of getting a trait, everyone get's a trophy
+ * - If you have a 50% chance of getting a trait, it's not rare
+ * - If you have a 0% chance of getting a trait, it's not fun
+ *
+ * So we're looking for something Pareto-ish (somewhere between
+ * 80/20 or 90/10) as that's a good & sustainable model for the
+ * distribution of many traits in real life.
+ * However, we also don't want to maximally reward collections
+ * that have a lot of single attributes distributed uniformly
+ * (basically a 0% trait probably) as that's perfectly entropic
+ * but not very interesting (some overlap is desirable).
+ * So we're using a Gaussian distribution to model the
+ * probability density of the joint probability of all traits
+ * centered around 15%.
+ * @param info
+ * @returns
+ */
 export declare const scoreTotalAttributes: (info: NftCollectionAttributeMetrics) => Score;
 //# sourceMappingURL=scoreTotalAttributes.d.ts.map

package/dist/browser/lib/rating/criteria/scoring/metadata/scoreTotalAttributes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"scoreTotalAttributes.d.ts","sourceRoot":"","sources":["../../../../../../../src/lib/rating/criteria/scoring/metadata/scoreTotalAttributes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,mDAAmD,CAAA;AACtG,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,qCAAqC,CAAA;AAsDhE,eAAO,MAAM,oBAAoB,SAAU,6BAA6B,KAAG,KAU1E,CAAA"}
+{"version":3,"file":"scoreTotalAttributes.d.ts","sourceRoot":"","sources":["../../../../../../../src/lib/rating/criteria/scoring/metadata/scoreTotalAttributes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,mDAAmD,CAAA;AACtG,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,qCAAqC,CAAA;AAkChE;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,oBAAoB,SAAU,6BAA6B,KAAG,KAU1E,CAAA"}

package/dist/browser/lib/rating/criteria/scoring/total.d.ts

@@ -1,4 +1,16 @@
 import type { NftCollectionCount } from '@xyo-network/crypto-nft-collection-payload-plugin';
 import type { Score } from '@xyo-network/crypto-nft-score-model';
+/**
+ * We're working on some assumptions here:
+ * - If there's < 1000 NFTs in your collection it starts becoming too niche
+ * - If there's > 20,000 NFTs in your collection it starts becoming too broad
+ * So there's a sweet spot somewhere between 2000 and 10,000
+ * where a collection has enough NFTs to be interesting, but
+ * not so many that it's teetering on a diluted money grab.
+ * To model that we're using a log-normal distribution optimized
+ * to maximally reward collections in the aforementioned range
+ * @param nft
+ * @returns
+ */
 export declare const scoreTotal: (nft: NftCollectionCount) => Score;
 //# sourceMappingURL=total.d.ts.map

package/dist/browser/lib/rating/criteria/scoring/total.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"total.d.ts","sourceRoot":"","sources":["../../../../../../src/lib/rating/criteria/scoring/total.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,mDAAmD,CAAA;AAC3F,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,qCAAqC,CAAA;AA4ChE,eAAO,MAAM,UAAU,QAAS,kBAAkB,KAAG,KAIpD,CAAA"}
+{"version":3,"file":"total.d.ts","sourceRoot":"","sources":["../../../../../../src/lib/rating/criteria/scoring/total.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,mDAAmD,CAAA;AAC3F,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,qCAAqC,CAAA;AAgChE;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,UAAU,QAAS,kBAAkB,KAAG,KAIpD,CAAA"}

package/dist/neutral/Plugin.d.ts

@@ -1,8 +1,8 @@
 import { NftCollectionScoreDiviner } from './Diviner.ts';
 export declare const NftCollectionScoreDivinerPlugin: () => import("@xyo-network/payloadset-plugin").PayloadSetDivinerPlugin<NftCollectionScoreDiviner<import("@xylabs/object").BaseParamsFields & {
-    account?: import(".store/@xyo-network-account-model-virtual-0c2e9849ce/package").AccountInstance | "random";
+    account?: import(".store/@xyo-network-account-model-virtual-b94ae9d87c/package").AccountInstance | "random";
     addToResolvers?: boolean;
-    additionalSigners?: import(".store/@xyo-network-account-model-virtual-0c2e9849ce/package").AccountInstance[];
+    additionalSigners?: import(".store/@xyo-network-account-model-virtual-b94ae9d87c/package").AccountInstance[];
     allowNameResolution?: boolean;
     config: import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & Omit<import("@xyo-network/module-model").ArchivingModuleConfig & import("@xyo-network/module-model").ModuleConfigFields & import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & Omit<import("@xyo-network/module-model").ArchivingModuleConfig & import("@xyo-network/module-model").ModuleConfigFields & {
         schema: "network.xyo.crypto.nft.collection.score.diviner.config";

package/dist/neutral/lib/rating/criteria/scoring/metadata/scoreTotalAttributes.d.ts

@@ -1,4 +1,24 @@
 import type { NftCollectionAttributeMetrics } from '@xyo-network/crypto-nft-collection-payload-plugin';
 import type { Score } from '@xyo-network/crypto-nft-score-model';
+/**
+ * We're working on some assumptions here:
+ *
+ * - If you have a 100% chance of getting a trait, everyone get's a trophy
+ * - If you have a 50% chance of getting a trait, it's not rare
+ * - If you have a 0% chance of getting a trait, it's not fun
+ *
+ * So we're looking for something Pareto-ish (somewhere between
+ * 80/20 or 90/10) as that's a good & sustainable model for the
+ * distribution of many traits in real life.
+ * However, we also don't want to maximally reward collections
+ * that have a lot of single attributes distributed uniformly
+ * (basically a 0% trait probably) as that's perfectly entropic
+ * but not very interesting (some overlap is desirable).
+ * So we're using a Gaussian distribution to model the
+ * probability density of the joint probability of all traits
+ * centered around 15%.
+ * @param info
+ * @returns
+ */
 export declare const scoreTotalAttributes: (info: NftCollectionAttributeMetrics) => Score;
 //# sourceMappingURL=scoreTotalAttributes.d.ts.map

package/dist/neutral/lib/rating/criteria/scoring/metadata/scoreTotalAttributes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"scoreTotalAttributes.d.ts","sourceRoot":"","sources":["../../../../../../../src/lib/rating/criteria/scoring/metadata/scoreTotalAttributes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,mDAAmD,CAAA;AACtG,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,qCAAqC,CAAA;AAsDhE,eAAO,MAAM,oBAAoB,SAAU,6BAA6B,KAAG,KAU1E,CAAA"}
+{"version":3,"file":"scoreTotalAttributes.d.ts","sourceRoot":"","sources":["../../../../../../../src/lib/rating/criteria/scoring/metadata/scoreTotalAttributes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,mDAAmD,CAAA;AACtG,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,qCAAqC,CAAA;AAkChE;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,oBAAoB,SAAU,6BAA6B,KAAG,KAU1E,CAAA"}

package/dist/neutral/lib/rating/criteria/scoring/total.d.ts

@@ -1,4 +1,16 @@
 import type { NftCollectionCount } from '@xyo-network/crypto-nft-collection-payload-plugin';
 import type { Score } from '@xyo-network/crypto-nft-score-model';
+/**
+ * We're working on some assumptions here:
+ * - If there's < 1000 NFTs in your collection it starts becoming too niche
+ * - If there's > 20,000 NFTs in your collection it starts becoming too broad
+ * So there's a sweet spot somewhere between 2000 and 10,000
+ * where a collection has enough NFTs to be interesting, but
+ * not so many that it's teetering on a diluted money grab.
+ * To model that we're using a log-normal distribution optimized
+ * to maximally reward collections in the aforementioned range
+ * @param nft
+ * @returns
+ */
 export declare const scoreTotal: (nft: NftCollectionCount) => Score;
 //# sourceMappingURL=total.d.ts.map

package/dist/neutral/lib/rating/criteria/scoring/total.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"total.d.ts","sourceRoot":"","sources":["../../../../../../src/lib/rating/criteria/scoring/total.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,mDAAmD,CAAA;AAC3F,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,qCAAqC,CAAA;AA4ChE,eAAO,MAAM,UAAU,QAAS,kBAAkB,KAAG,KAIpD,CAAA"}
+{"version":3,"file":"total.d.ts","sourceRoot":"","sources":["../../../../../../src/lib/rating/criteria/scoring/total.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,mDAAmD,CAAA;AAC3F,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,qCAAqC,CAAA;AAgChE;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,UAAU,QAAS,kBAAkB,KAAG,KAIpD,CAAA"}

package/dist/node/Plugin.d.ts

@@ -1,8 +1,8 @@
 import { NftCollectionScoreDiviner } from './Diviner.ts';
 export declare const NftCollectionScoreDivinerPlugin: () => import("@xyo-network/payloadset-plugin").PayloadSetDivinerPlugin<NftCollectionScoreDiviner<import("@xylabs/object").BaseParamsFields & {
-    account?: import(".store/@xyo-network-account-model-virtual-0c2e9849ce/package").AccountInstance | "random";
+    account?: import(".store/@xyo-network-account-model-virtual-b94ae9d87c/package").AccountInstance | "random";
     addToResolvers?: boolean;
-    additionalSigners?: import(".store/@xyo-network-account-model-virtual-0c2e9849ce/package").AccountInstance[];
+    additionalSigners?: import(".store/@xyo-network-account-model-virtual-b94ae9d87c/package").AccountInstance[];
     allowNameResolution?: boolean;
     config: import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & Omit<import("@xyo-network/module-model").ArchivingModuleConfig & import("@xyo-network/module-model").ModuleConfigFields & import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & Omit<import("@xyo-network/module-model").ArchivingModuleConfig & import("@xyo-network/module-model").ModuleConfigFields & {
         schema: "network.xyo.crypto.nft.collection.score.diviner.config";

package/dist/node/lib/rating/criteria/scoring/metadata/scoreTotalAttributes.d.ts

@@ -1,4 +1,24 @@
 import type { NftCollectionAttributeMetrics } from '@xyo-network/crypto-nft-collection-payload-plugin';
 import type { Score } from '@xyo-network/crypto-nft-score-model';
+/**
+ * We're working on some assumptions here:
+ *
+ * - If you have a 100% chance of getting a trait, everyone get's a trophy
+ * - If you have a 50% chance of getting a trait, it's not rare
+ * - If you have a 0% chance of getting a trait, it's not fun
+ *
+ * So we're looking for something Pareto-ish (somewhere between
+ * 80/20 or 90/10) as that's a good & sustainable model for the
+ * distribution of many traits in real life.
+ * However, we also don't want to maximally reward collections
+ * that have a lot of single attributes distributed uniformly
+ * (basically a 0% trait probably) as that's perfectly entropic
+ * but not very interesting (some overlap is desirable).
+ * So we're using a Gaussian distribution to model the
+ * probability density of the joint probability of all traits
+ * centered around 15%.
+ * @param info
+ * @returns
+ */
 export declare const scoreTotalAttributes: (info: NftCollectionAttributeMetrics) => Score;
 //# sourceMappingURL=scoreTotalAttributes.d.ts.map

package/dist/node/lib/rating/criteria/scoring/metadata/scoreTotalAttributes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"scoreTotalAttributes.d.ts","sourceRoot":"","sources":["../../../../../../../src/lib/rating/criteria/scoring/metadata/scoreTotalAttributes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,mDAAmD,CAAA;AACtG,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,qCAAqC,CAAA;AAsDhE,eAAO,MAAM,oBAAoB,SAAU,6BAA6B,KAAG,KAU1E,CAAA"}
+{"version":3,"file":"scoreTotalAttributes.d.ts","sourceRoot":"","sources":["../../../../../../../src/lib/rating/criteria/scoring/metadata/scoreTotalAttributes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,mDAAmD,CAAA;AACtG,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,qCAAqC,CAAA;AAkChE;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,oBAAoB,SAAU,6BAA6B,KAAG,KAU1E,CAAA"}

package/dist/node/lib/rating/criteria/scoring/total.d.ts

@@ -1,4 +1,16 @@
 import type { NftCollectionCount } from '@xyo-network/crypto-nft-collection-payload-plugin';
 import type { Score } from '@xyo-network/crypto-nft-score-model';
+/**
+ * We're working on some assumptions here:
+ * - If there's < 1000 NFTs in your collection it starts becoming too niche
+ * - If there's > 20,000 NFTs in your collection it starts becoming too broad
+ * So there's a sweet spot somewhere between 2000 and 10,000
+ * where a collection has enough NFTs to be interesting, but
+ * not so many that it's teetering on a diluted money grab.
+ * To model that we're using a log-normal distribution optimized
+ * to maximally reward collections in the aforementioned range
+ * @param nft
+ * @returns
+ */
 export declare const scoreTotal: (nft: NftCollectionCount) => Score;
 //# sourceMappingURL=total.d.ts.map

package/dist/node/lib/rating/criteria/scoring/total.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"total.d.ts","sourceRoot":"","sources":["../../../../../../src/lib/rating/criteria/scoring/total.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,mDAAmD,CAAA;AAC3F,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,qCAAqC,CAAA;AA4ChE,eAAO,MAAM,UAAU,QAAS,kBAAkB,KAAG,KAIpD,CAAA"}
+{"version":3,"file":"total.d.ts","sourceRoot":"","sources":["../../../../../../src/lib/rating/criteria/scoring/total.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,mDAAmD,CAAA;AAC3F,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,qCAAqC,CAAA;AAgChE;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,UAAU,QAAS,kBAAkB,KAAG,KAIpD,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/crypto-nft-collection-diviner-score-plugin",
-  "version": "3.1.0",
+  "version": "3.1.2",
   "description": "Typescript/Javascript Plugins for XYO Platform",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -29,25 +29,25 @@
   "module": "dist/neutral/index.mjs",
   "types": "dist/neutral/index.d.ts",
   "dependencies": {
-    "@xyo-network/crypto-nft-collection-payload-plugin": "^3.1.0",
-    "@xyo-network/crypto-nft-payload-plugin": "^3.1.0",
-    "@xyo-network/crypto-nft-score-model": "^3.1.0",
-    "@xyo-network/diviner-abstract": "^3.2.0",
-    "@xyo-network/diviner-model": "^3.2.0",
-    "@xyo-network/module-model": "^3.2.0",
-    "@xyo-network/payload-builder": "^3.2.0",
-    "@xyo-network/payload-model": "^3.2.0",
-    "@xyo-network/payloadset-plugin": "^3.2.0"
+    "@xyo-network/crypto-nft-collection-payload-plugin": "^3.1.2",
+    "@xyo-network/crypto-nft-payload-plugin": "^3.1.2",
+    "@xyo-network/crypto-nft-score-model": "^3.1.2",
+    "@xyo-network/diviner-abstract": "^3.5.1",
+    "@xyo-network/diviner-model": "^3.5.1",
+    "@xyo-network/module-model": "^3.5.1",
+    "@xyo-network/payload-builder": "^3.5.1",
+    "@xyo-network/payload-model": "^3.5.1",
+    "@xyo-network/payloadset-plugin": "^3.5.1"
   },
   "devDependencies": {
-    "@xylabs/jest-helpers": "^4.1.0",
-    "@xylabs/ts-scripts-yarn3": "^4.1.0",
-    "@xylabs/tsconfig": "^4.1.0",
-    "@xyo-network/account": "^3.2.0",
-    "@xyo-network/payload-wrapper": "^3.2.0",
-    "ethers": "^6.13.3",
-    "jest": "^29.7.0",
-    "typescript": "^5.6.2"
+    "@xylabs/ts-scripts-yarn3": "^4.2.4",
+    "@xylabs/tsconfig": "^4.2.4",
+    "@xylabs/vitest-extended": "^4.4.9",
+    "@xyo-network/account": "^3.5.1",
+    "@xyo-network/payload-wrapper": "^3.5.1",
+    "ethers": "^6.13.4",
+    "typescript": "^5.7.2",
+    "vitest": "^2.1.6"
   },
   "publishConfig": {
     "access": "public"