@xyo-network/crypto-nft-collection-witness-plugin 4.2.0 → 5.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/crypto-nft-collection-witness-plugin",
-  "version": "4.2.0",
+  "version": "5.0.0",
   "description": "Typescript/Javascript Plugins for XYO Platform",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -28,31 +28,35 @@
   },
   "module": "dist/neutral/index.mjs",
   "types": "dist/neutral/index.d.ts",
+  "files": [
+    "dist",
+    "src"
+  ],
   "dependencies": {
-    "@xylabs/assert": "^4.15.1",
-    "@xylabs/axios": "^4.15.1",
-    "@xylabs/eth-address": "^4.15.1",
-    "@xylabs/exists": "^4.15.1",
-    "@xylabs/hex": "^4.15.1",
-    "@xyo-network/crypto-nft-collection-payload-plugin": "^4.2.0",
-    "@xyo-network/crypto-nft-payload-plugin": "^4.2.0",
-    "@xyo-network/erc1822-witness": "^4.2.0",
-    "@xyo-network/erc1967-witness": "^4.2.0",
+    "@xylabs/assert": "^5.0.0",
+    "@xylabs/axios": "^5.0.0",
+    "@xylabs/eth-address": "^5.0.0",
+    "@xylabs/exists": "^5.0.0",
+    "@xylabs/hex": "^5.0.0",
+    "@xyo-network/crypto-nft-collection-payload-plugin": "^5.0.0",
+    "@xyo-network/crypto-nft-payload-plugin": "^5.0.0",
+    "@xyo-network/erc1822-witness": "^5.0.0",
+    "@xyo-network/erc1967-witness": "^5.0.0",
     "@xyo-network/open-zeppelin-typechain": "^3.5.4",
-    "@xyo-network/payload-builder": "^4.3.0",
-    "@xyo-network/payload-model": "^4.3.0",
-    "@xyo-network/payloadset-plugin": "^4.3.0",
-    "@xyo-network/witness-blockchain-abstract": "^4.3.0",
-    "@xyo-network/witness-evm-abstract": "^4.3.0",
+    "@xyo-network/payload-builder": "^5.0.0",
+    "@xyo-network/payload-model": "^5.0.0",
+    "@xyo-network/payloadset-plugin": "^5.0.0",
+    "@xyo-network/witness-blockchain-abstract": "^5.0.0",
+    "@xyo-network/witness-evm-abstract": "^5.0.0",
     "ethers": "^6.15.0"
   },
   "devDependencies": {
     "@types/node": "^24.1.0",
-    "@xylabs/ts-scripts-yarn3": "^7.0.1",
-    "@xylabs/tsconfig": "^7.0.1",
-    "@xylabs/vitest-extended": "^4.15.1",
-    "@xyo-network/account": "^4.3.0",
-    "@xyo-network/account-model": "^4.3.0",
+    "@xylabs/ts-scripts-yarn3": "^7.0.2",
+    "@xylabs/tsconfig": "^7.0.2",
+    "@xylabs/vitest-extended": "^5.0.0",
+    "@xyo-network/account": "^5.0.0",
+    "@xyo-network/account-model": "^5.0.0",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4"
   },

package/src/lib/collectionMetrics/lib/probabilityDistributions/binomial/spec/calculateBinomialParamsFromOutcomes.spec.ts

@@ -0,0 +1,33 @@
+import '@xylabs/vitest-extended'
+
+import type { BinomialDistributionParameters } from '@xyo-network/crypto-nft-collection-payload-plugin'
+import {
+  describe, expect,
+  it,
+} from 'vitest'
+
+import { calculateBinomialParamsFromOutcomes } from '../calculateBinomialParamsFromOutcomes.ts'
+
+describe('calculateBinomialParamsFromOutcomes', () => {
+  const data: [values: number[], outcome: BinomialDistributionParameters][] = [
+    [[1, 0], {
+      mean: 1, p: 0.5, stdDev: 0.707_106_781_186_547_6, variance: 0.5,
+    }],
+    [[1, 1, 0, 0], {
+      mean: 2, p: 0.5, stdDev: 1, variance: 1,
+    }],
+    [[1, 0, 0, 0], {
+      mean: 1, p: 0.25, stdDev: 0.866_025_403_784_438_6, variance: 0.75,
+    }],
+    [[1, 1, 1, 1], {
+      mean: 4, p: 1, stdDev: 0, variance: 0,
+    }],
+    [[0, 0, 0, 0], {
+      mean: 0, p: 0, stdDev: 0, variance: 0,
+    }],
+  ]
+  it.each(data)('calculates the params', (values, outcome) => {
+    const result = calculateBinomialParamsFromOutcomes(values)
+    expect(result).toEqual(outcome)
+  })
+})

package/src/lib/collectionMetrics/lib/probabilityDistributions/binomial/spec/calculateBinomialParamsFromProbability.spec.ts

@@ -0,0 +1,33 @@
+import '@xylabs/vitest-extended'
+
+import type { BinomialDistributionParameters } from '@xyo-network/crypto-nft-collection-payload-plugin'
+import {
+  describe, expect,
+  it,
+} from 'vitest'
+
+import { calculateBinomialParamsFromProbability } from '../calculateBinomialParamsFromProbability.ts'
+
+describe('calculateBinomialParamsFromProbability', () => {
+  const data: [values: [trials: number, probability: number], outcome: BinomialDistributionParameters][] = [
+    [[2, 0.5], {
+      mean: 1, p: 0.5, stdDev: 0.707_106_781_186_547_6, variance: 0.5,
+    }],
+    [[4, 0.5], {
+      mean: 2, p: 0.5, stdDev: 1, variance: 1,
+    }],
+    [[4, 0.25], {
+      mean: 1, p: 0.25, stdDev: 0.866_025_403_784_438_6, variance: 0.75,
+    }],
+    [[4, 1], {
+      mean: 4, p: 1, stdDev: 0, variance: 0,
+    }],
+    [[4, 0], {
+      mean: 0, p: 0, stdDev: 0, variance: 0,
+    }],
+  ]
+  it.each(data)('calculates the params', (values, outcome) => {
+    const result = calculateBinomialParamsFromProbability(values[0], values[1])
+    expect(result).toEqual(outcome)
+  })
+})

package/src/lib/collectionMetrics/lib/spec/calculateAllPropertiesDistribution.spec.ts

@@ -0,0 +1,27 @@
+import '@xylabs/vitest-extended'
+
+import { readFile } from 'node:fs/promises'
+import Path from 'node:path'
+
+import type { NftInfo, OpenSeaNftAttribute } from '@xyo-network/crypto-nft-payload-plugin'
+import {
+  describe, expect,
+  test,
+} from 'vitest'
+
+import { calculateAllPropertiesDistribution } from '../calculateAllPropertiesDistribution.ts'
+
+describe('calculateAllPropertiesDistribution', () => {
+  test('calculates the property distribution', async () => {
+    const filePath = Path.join(__dirname, 'testData.json')
+    const fileContents = await readFile(filePath, 'utf8')
+    const nfts = JSON.parse(fileContents) as NftInfo[]
+    const attributes = nfts
+      .map(nft => nft.metadata?.attributes as OpenSeaNftAttribute[])
+      .map((attributes) => {
+        return Object.fromEntries(attributes.map(attribute => [attribute.trait_type, attribute.value]))
+      })
+    const result = calculateAllPropertiesDistribution(attributes)
+    expect(result).toBeObject()
+  })
+})