@xyo-network/crypto-nft-collection-witness-plugin 2.70.5 → 2.70.6

package/dist/esm/Witness.js

@@ -1,7 +1,15 @@
 import { assertEx } from '@xylabs/assert';
-import { isNftCollectionWitnessQueryPayload, NftCollectionWitnessConfigSchema, } from '@xyo-network/crypto-nft-collection-payload-plugin';
+import { PayloadHasher } from '@xyo-network/core';
+import { isNftCollectionWitnessQueryPayload, NftCollectionSchema, NftCollectionWitnessConfigSchema, } from '@xyo-network/crypto-nft-collection-payload-plugin';
 import { AbstractWitness } from '@xyo-network/witness';
-import { getNftCollectionInfo } from './lib';
+import { getNftCollectionInfo, getNftCollectionMetrics, getNftCollectionNfts, getNftCollectionTotalNfts } from './lib';
+const defaultMaxNftSampleSize = 100;
+/**
+ * A "no operation" Promise to be used
+ * when no action is desired but a Promise
+ * is required to be returned
+ */
+const NoOp = Promise.resolve();
 export class CryptoNftCollectionWitness extends AbstractWitness {
     static configSchemas = [NftCollectionWitnessConfigSchema];
     async observeHandler(payloads) {
@@ -10,8 +18,21 @@ export class CryptoNftCollectionWitness extends AbstractWitness {
         const observations = await Promise.all(queries.map(async (query) => {
             const address = assertEx(query?.address || this.config.address, 'params.address is required');
             const chainId = assertEx(query?.chainId || this.config.chainId, 'params.chainId is required');
-            const observation = await getNftCollectionInfo(address, chainId, this.account.private.hex);
-            return observation;
+            const maxNftSampleSize = query?.maxNftSampleSize || defaultMaxNftSampleSize;
+            const [info, total, nfts, archivist] = await Promise.all([
+                getNftCollectionInfo(address, chainId, this.account.private.hex),
+                getNftCollectionTotalNfts(address, chainId, this.account.private.hex),
+                getNftCollectionNfts(address, chainId, this.account.private.hex, maxNftSampleSize),
+                this.writeArchivist(),
+            ]);
+            const distribution = getNftCollectionMetrics(nfts);
+            const [sources] = await Promise.all([
+                // Hash all the payloads
+                Promise.all(nfts.map((nft) => PayloadHasher.hashAsync(nft))),
+                // Insert them into the archivist if we have one
+                archivist ? archivist.insert(nfts) : NoOp,
+            ]);
+            return { ...info, ...distribution, schema: NftCollectionSchema, sources, total };
         }));
         return observations.flat();
     }

package/dist/esm/Witness.js.map

@@ -1 +1 @@
-{"version":3,"file":"Witness.js","sourceRoot":"","sources":["../../src/Witness.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AACzC,OAAO,EACL,kCAAkC,EAElC,gCAAgC,GACjC,MAAM,mDAAmD,CAAA;AAG1D,OAAO,EAAE,eAAe,EAAiB,MAAM,sBAAsB,CAAA;AAErE,OAAO,EAAE,oBAAoB,EAAE,MAAM,OAAO,CAAA;AAI5C,MAAM,OAAO,0BAEX,SAAQ,eAAwB;IAChC,MAAM,CAAU,aAAa,GAAG,CAAC,gCAAgC,CAAC,CAAA;IAE/C,KAAK,CAAC,cAAc,CAAC,QAAoB;QAC1D,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;QAC3B,MAAM,OAAO,GAAG,QAAQ,EAAE,MAAM,CAAC,kCAAkC,CAAC,IAAI,EAAE,CAAA;QAC1E,MAAM,YAAY,GAAG,MAAM,OAAO,CAAC,GAAG,CACpC,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;YAC1B,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,EAAE,OAAO,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,4BAA4B,CAAC,CAAA;YAC7F,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,EAAE,OAAO,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,4BAA4B,CAAC,CAAA;YAC7F,MAAM,WAAW,GAAG,MAAM,oBAAoB,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;YAC1F,OAAO,WAAW,CAAA;QACpB,CAAC,CAAC,CACH,CAAA;QACD,OAAO,YAAY,CAAC,IAAI,EAAE,CAAA;IAC5B,CAAC"}
+{"version":3,"file":"Witness.js","sourceRoot":"","sources":["../../src/Witness.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AACzC,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAA;AACjD,OAAO,EACL,kCAAkC,EAElC,mBAAmB,EAEnB,gCAAgC,GACjC,MAAM,mDAAmD,CAAA;AAG1D,OAAO,EAAE,eAAe,EAAiB,MAAM,sBAAsB,CAAA;AAErE,OAAO,EAAE,oBAAoB,EAAE,uBAAuB,EAAE,oBAAoB,EAAE,yBAAyB,EAAE,MAAM,OAAO,CAAA;AAItH,MAAM,uBAAuB,GAAG,GAAG,CAAA;AAEnC;;;;GAIG;AACH,MAAM,IAAI,GAAG,OAAO,CAAC,OAAO,EAAE,CAAA;AAE9B,MAAM,OAAO,0BAEX,SAAQ,eAAwB;IAChC,MAAM,CAAU,aAAa,GAAG,CAAC,gCAAgC,CAAC,CAAA;IAE/C,KAAK,CAAC,cAAc,CAAC,QAAoB;QAC1D,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;QAC3B,MAAM,OAAO,GAAG,QAAQ,EAAE,MAAM,CAAC,kCAAkC,CAAC,IAAI,EAAE,CAAA;QAC1E,MAAM,YAAY,GAAG,MAAM,OAAO,CAAC,GAAG,CACpC,OAAO,CAAC,GAAG,CAAoC,KAAK,EAAE,KAAK,EAAE,EAAE;YAC7D,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,EAAE,OAAO,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,4BAA4B,CAAC,CAAA;YAC7F,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,EAAE,OAAO,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,4BAA4B,CAAC,CAAA;YAC7F,MAAM,gBAAgB,GAAG,KAAK,EAAE,gBAAgB,IAAI,uBAAuB,CAAA;YAC3E,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,SAAS,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;gBACvD,oBAAoB,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC;gBAChE,yBAAyB,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC;gBACrE,oBAAoB,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,gBAAgB,CAAC;gBAClF,IAAI,CAAC,cAAc,EAAE;aACtB,CAAC,CAAA;YACF,MAAM,YAAY,GAAG,uBAAuB,CAAC,IAAI,CAAC,CAAA;YAClD,MAAM,CAAC,OAAO,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;gBAClC,wBAAwB;gBACxB,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,aAAa,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC;gBAC5D,gDAAgD;gBAChD,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI;aAC1C,CAAC,CAAA;YACF,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,YAAY,EAAE,MAAM,EAAE,mBAAmB,EAAE,OAAO,EAAE,KAAK,EAAE,CAAA;QAClF,CAAC,CAAC,CACH,CAAA;QACD,OAAO,YAAY,CAAC,IAAI,EAAE,CAAA;IAC5B,CAAC"}

package/dist/esm/lib/collectionMetrics/getNftCollectionMetrics.js

@@ -0,0 +1,17 @@
+import { calculateAllPropertiesDistribution } from './lib';
+export const getNftCollectionMetrics = (nfts) => {
+    const attributes = nfts
+        .map((nft) => nft.metadata?.attributes)
+        .map((attributes) => {
+        return Object.fromEntries(attributes.map((attribute) => [attribute.trait_type, attribute.value]));
+    });
+    const distribution = calculateAllPropertiesDistribution(attributes);
+    return {
+        distribution: {
+            metadata: {
+                attributes: distribution,
+            },
+        },
+    };
+};
+//# sourceMappingURL=getNftCollectionMetrics.js.map

package/dist/esm/lib/collectionMetrics/getNftCollectionMetrics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getNftCollectionMetrics.js","sourceRoot":"","sources":["../../../../src/lib/collectionMetrics/getNftCollectionMetrics.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,kCAAkC,EAAgB,MAAM,OAAO,CAAA;AAYxE,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,IAAe,EAAwB,EAAE;IAC/E,MAAM,UAAU,GAAG,IAAI;SACpB,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,EAAE,UAAmC,CAAC;SAC/D,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE;QAClB,OAAO,MAAM,CAAC,WAAW,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,SAAS,CAAC,UAAU,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IACnG,CAAC,CAAC,CAAA;IACJ,MAAM,YAAY,GAAG,kCAAkC,CAAC,UAAU,CAAC,CAAA;IACnE,OAAO;QACL,YAAY,EAAE;YACZ,QAAQ,EAAE;gBACR,UAAU,EAAE,YAAY;aACzB;SACF;KACF,CAAA;AACH,CAAC,CAAA"}

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

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

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

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

package/dist/esm/lib/collectionMetrics/lib/calculateAllPropertiesDistribution.js

@@ -0,0 +1,26 @@
+export const calculateAllPropertiesDistribution = (array) => {
+    const distribution = {};
+    array.forEach((item) => {
+        for (const property in item) {
+            if (Object.prototype.hasOwnProperty.call(item, property)) {
+                const value = item[property];
+                if (value !== undefined && value !== null) {
+                    const valueString = value.toString();
+                    if (!distribution[property]) {
+                        distribution[property] = { [valueString]: 1 };
+                    }
+                    else if (!distribution[property][valueString]) {
+                        ;
+                        distribution[property][valueString] = 1;
+                    }
+                    else {
+                        ;
+                        distribution[property][valueString] += 1;
+                    }
+                }
+            }
+        }
+    });
+    return distribution;
+};
+//# sourceMappingURL=calculateAllPropertiesDistribution.js.map

package/dist/esm/lib/collectionMetrics/lib/calculateAllPropertiesDistribution.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"calculateAllPropertiesDistribution.js","sourceRoot":"","sources":["../../../../../src/lib/collectionMetrics/lib/calculateAllPropertiesDistribution.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,kCAAkC,GAAG,CAAI,KAAU,EAAmB,EAAE;IACnF,MAAM,YAAY,GAAoB,EAAE,CAAA;IAExC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QACrB,KAAK,MAAM,QAAQ,IAAI,IAAI,EAAE;YAC3B,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE;gBACxD,MAAM,KAAK,GAAG,IAAI,CAAC,QAAmB,CAAC,CAAA;gBACvC,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,EAAE;oBACzC,MAAM,WAAW,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAA;oBACpC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE;wBAC3B,YAAY,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,WAAW,CAAC,EAAE,CAAC,EAAE,CAAA;qBAC9C;yBAAM,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAE,CAAC,WAAW,CAAC,EAAE;wBAChD,CAAC;wBAAC,YAAY,CAAC,QAAQ,CAA4B,CAAC,WAAW,CAAC,GAAG,CAAC,CAAA;qBACrE;yBAAM;wBACL,CAAC;wBAAC,YAAY,CAAC,QAAQ,CAA4B,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;qBACtE;iBACF;aACF;SACF;IACH,CAAC,CAAC,CAAA;IAEF,OAAO,YAAY,CAAA;AACrB,CAAC,CAAA"}

package/dist/esm/lib/collectionMetrics/lib/calculatePropertyDistribution.js

@@ -0,0 +1,22 @@
+export const calculatePropertyDistribution = (array, property) => {
+    const distribution = {};
+    array.forEach((item) => {
+        const value = item[property];
+        if (value !== undefined && value !== null) {
+            const valueString = value.toString();
+            if (!distribution[property]) {
+                distribution[property] = { [valueString]: 1 };
+            }
+            else if (!distribution[property][valueString]) {
+                ;
+                distribution[property][valueString] = 1;
+            }
+            else {
+                ;
+                distribution[property][valueString] += 1;
+            }
+        }
+    });
+    return distribution;
+};
+//# sourceMappingURL=calculatePropertyDistribution.js.map

package/dist/esm/lib/collectionMetrics/lib/calculatePropertyDistribution.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"calculatePropertyDistribution.js","sourceRoot":"","sources":["../../../../../src/lib/collectionMetrics/lib/calculatePropertyDistribution.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAI,KAAU,EAAE,QAAiB,EAAmB,EAAE;IACjG,MAAM,YAAY,GAAoB,EAAE,CAAA;IACxC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QACrB,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAA;QAC5B,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,EAAE;YACzC,MAAM,WAAW,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAA;YACpC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE;gBAC3B,YAAY,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,WAAW,CAAC,EAAE,CAAC,EAAE,CAAA;aAC9C;iBAAM,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAE,CAAC,WAAW,CAAC,EAAE;gBAChD,CAAC;gBAAC,YAAY,CAAC,QAAQ,CAA4B,CAAC,WAAW,CAAC,GAAG,CAAC,CAAA;aACrE;iBAAM;gBACL,CAAC;gBAAC,YAAY,CAAC,QAAQ,CAA4B,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;aACtE;SACF;IACH,CAAC,CAAC,CAAA;IACF,OAAO,YAAY,CAAA;AACrB,CAAC,CAAA"}

package/dist/esm/lib/collectionMetrics/lib/distribution.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=distribution.js.map

package/dist/esm/lib/collectionMetrics/lib/distribution.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"distribution.js","sourceRoot":"","sources":["../../../../../src/lib/collectionMetrics/lib/distribution.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,3 @@
+export * from './calculateAllPropertiesDistribution';
+export * from './distribution';
+//# sourceMappingURL=index.js.map

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

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

package/dist/esm/lib/getNftCollectionInfo.js

@@ -1,13 +1,5 @@
 import { Auth, SDK } from '@infura/sdk';
-import { NftCollectionSchema } from '@xyo-network/crypto-nft-collection-payload-plugin';
-/**
- * These contracts are not evaluable for some
- * reason (too large, nonsensical, etc.)
- */
-export const nonEvaluableContractAddresses = [
-    // ENS
-    '0xC18360217D8F7Ab5e7c516566761Ea12Ce7F9D72',
-].map((address) => address.toUpperCase());
+import { nonEvaluableContractAddresses } from './nonEvaluableContractAddresses';
 export const getNftCollectionInfo = async (
 /**
  * The address of the NFT contract to search for
@@ -24,31 +16,13 @@ chainId,
 /**
  * The private key of the wallet to use to search for NFTs
  */
-privateKey, 
-/**
- * The maximum number of NFTs to return. Configurable to prevent
- * large wallets from exhausting Infura API credits.
- */
-maxNftCount = 20000) => {
+privateKey) => {
     if (nonEvaluableContractAddresses.includes(contractAddress.toUpperCase())) {
         throw new Error(`Unable to evaluate collection with contractAddress: ${contractAddress}`);
     }
-    // Instantiate SDK
-    const sdk = new SDK(new Auth({
-        chainId,
-        privateKey,
-        projectId: process.env.INFURA_PROJECT_ID,
-        // ipfs: {
-        //   apiKeySecret: process.env.INFURA_IPFS_PROJECT_SECRET,
-        //   projectId: process.env.INFURA_IPFS_PROJECT_ID,
-        // },
-        // provider,
-        // NOTE: rpcUrl is not required if chainId & projectId are provided
-        // rpcUrl: process.env.EVM_RPC_URL,
-        secretId: process.env.INFURA_PROJECT_SECRET,
-    }));
+    const sdk = new SDK(new Auth({ chainId, privateKey, projectId: process.env.INFURA_PROJECT_ID, secretId: process.env.INFURA_PROJECT_SECRET }));
     const opts = { contractAddress };
     const { name, symbol, tokenType } = await sdk.api.getContractMetadata(opts);
-    return { address: contractAddress, chainId, name, schema: NftCollectionSchema, symbol, tokenType };
+    return { address: contractAddress, chainId, name, symbol, tokenType };
 };
 //# sourceMappingURL=getNftCollectionInfo.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"getNftCollectionInfo.js","sourceRoot":"","sources":["../../../src/lib/getNftCollectionInfo.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,EAA4B,mBAAmB,EAAE,MAAM,mDAAmD,CAAA;AAEjH;;;GAGG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG;IAC3C,MAAM;IACN,4CAA4C;CAC7C,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAA;AAOzC,MAAM,CAAC,MAAM,oBAAoB,GAAG,KAAK;AACvC;;GAEG;AACH,eAAuB;AACvB;;GAEG;AACH,OAAe;AACf,MAAM;AACN,mDAAmD;AACnD,MAAM;AACN,iDAAiD;AACjD;;GAEG;AACH,UAAkB;AAClB;;;GAGG;AACH,WAAW,GAAG,KAAK,EACgB,EAAE;IACrC,IAAI,6BAA6B,CAAC,QAAQ,CAAC,eAAe,CAAC,WAAW,EAAE,CAAC,EAAE;QACzE,MAAM,IAAI,KAAK,CAAC,uDAAuD,eAAe,EAAE,CAAC,CAAA;KAC1F;IACD,kBAAkB;IAClB,MAAM,GAAG,GAAG,IAAI,GAAG,CACjB,IAAI,IAAI,CAAC;QACP,OAAO;QACP,UAAU;QACV,SAAS,EAAE,OAAO,CAAC,GAAG,CAAC,iBAAiB;QACxC,UAAU;QACV,0DAA0D;QAC1D,mDAAmD;QACnD,KAAK;QACL,YAAY;QACZ,mEAAmE;QACnE,mCAAmC;QACnC,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,qBAAqB;KAC5C,CAAC,CACH,CAAA;IACD,MAAM,IAAI,GAA2B,EAAE,eAAe,EAAE,CAAA;IACxD,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,GAAG,CAAC,GAAG,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAA;IAC3E,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,mBAAmB,EAAE,MAAM,EAAE,SAAS,EAAE,CAAA;AACpG,CAAC,CAAA"}
+{"version":3,"file":"getNftCollectionInfo.js","sourceRoot":"","sources":["../../../src/lib/getNftCollectionInfo.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,aAAa,CAAA;AAGvC,OAAO,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAA;AAO/E,MAAM,CAAC,MAAM,oBAAoB,GAAG,KAAK;AACvC;;GAEG;AACH,eAAuB;AACvB;;GAEG;AACH,OAAe;AACf,MAAM;AACN,mDAAmD;AACnD,MAAM;AACN,iDAAiD;AACjD;;GAEG;AACH,UAAkB,EACyB,EAAE;IAC7C,IAAI,6BAA6B,CAAC,QAAQ,CAAC,eAAe,CAAC,WAAW,EAAE,CAAC,EAAE;QACzE,MAAM,IAAI,KAAK,CAAC,uDAAuD,eAAe,EAAE,CAAC,CAAA;KAC1F;IACD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,IAAI,IAAI,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,CAAC,CAAC,CAAA;IAC7I,MAAM,IAAI,GAA2B,EAAE,eAAe,EAAE,CAAA;IACxD,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,GAAG,CAAC,GAAG,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAA;IAC3E,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,CAAA;AACvE,CAAC,CAAA"}

package/dist/esm/lib/getNftCollectionNfts.js

@@ -0,0 +1,46 @@
+import { Auth, SDK } from '@infura/sdk';
+import { NftSchema } from '@xyo-network/crypto-nft-payload-plugin';
+import { nonEvaluableContractAddresses } from './nonEvaluableContractAddresses';
+export const getNftCollectionNfts = async (
+/**
+ * The address of the NFT contract to search for
+ */
+contractAddress, 
+/**
+ * The chain ID (1 = Ethereum Mainnet, 4 = Rinkeby, etc.) of the chain to search for NFTs on
+ */
+chainId, 
+// /**
+//  * The ethers provider to use to search for NFTs
+//  */
+// provider: ExternalProvider | JsonRpcFetchFunc,
+/**
+ * The private key of the wallet to use to search for NFTs
+ */
+privateKey, 
+/**
+ * The maximum number of NFTs to return. Configurable to prevent
+ * large wallets from exhausting Infura API credits. Ideally a
+ * multiple of 100 as that appears to be the default page size.
+ */
+maxNftSampleSize = 100) => {
+    if (nonEvaluableContractAddresses.includes(contractAddress.toUpperCase())) {
+        throw new Error(`Unable to evaluate collection with contractAddress: ${contractAddress}`);
+    }
+    const sdk = new SDK(new Auth({ chainId, privateKey, projectId: process.env.INFURA_PROJECT_ID, secretId: process.env.INFURA_PROJECT_SECRET }));
+    const nfts = [];
+    let cursor = undefined;
+    do {
+        const opts = { contractAddress, cursor };
+        const { cursor: nextCursor, pageSize, total, assets } = await sdk.api.getNFTsForCollection(opts);
+        const batch = assets.slice(0, Math.min(pageSize, total - nfts.length));
+        nfts.push(...batch);
+        cursor = nextCursor;
+        if (nfts.length >= total || !cursor)
+            break;
+    } while (nfts.length < maxNftSampleSize);
+    return nfts.map((nft) => {
+        return { ...nft, schema: NftSchema };
+    });
+};
+//# sourceMappingURL=getNftCollectionNfts.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"getNftCollectionNfts.js","sourceRoot":"","sources":["../../../src/lib/getNftCollectionNfts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,EAA2B,SAAS,EAAE,MAAM,wCAAwC,CAAA;AAE3F,OAAO,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAA;AAO/E,MAAM,CAAC,MAAM,oBAAoB,GAAG,KAAK;AACvC;;GAEG;AACH,eAAuB;AACvB;;GAEG;AACH,OAAe;AACf,MAAM;AACN,mDAAmD;AACnD,MAAM;AACN,iDAAiD;AACjD;;GAEG;AACH,UAAkB;AAClB;;;;GAIG;AACH,gBAAgB,GAAG,GAAG,EACK,EAAE;IAC7B,IAAI,6BAA6B,CAAC,QAAQ,CAAC,eAAe,CAAC,WAAW,EAAE,CAAC,EAAE;QACzE,MAAM,IAAI,KAAK,CAAC,uDAAuD,eAAe,EAAE,CAAC,CAAA;KAC1F;IACD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,IAAI,IAAI,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,CAAC,CAAC,CAAA;IAC7I,MAAM,IAAI,GAAc,EAAE,CAAA;IAC1B,IAAI,MAAM,GAAuB,SAAS,CAAA;IAC1C,GAAG;QACD,MAAM,IAAI,GAA2B,EAAE,eAAe,EAAE,MAAM,EAAE,CAAA;QAChE,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,GAAG,CAAC,GAAG,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAA;QAChG,MAAM,KAAK,GAAc,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAA;QACjF,IAAI,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAA;QACnB,MAAM,GAAG,UAAU,CAAA;QACnB,IAAI,IAAI,CAAC,MAAM,IAAI,KAAK,IAAI,CAAC,MAAM;YAAE,MAAK;KAC3C,QAAQ,IAAI,CAAC,MAAM,GAAG,gBAAgB,EAAC;IACxC,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QACtB,OAAO,EAAE,GAAG,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,CAAA;IACtC,CAAC,CAAC,CAAA;AACJ,CAAC,CAAA"}

package/dist/esm/lib/getNftCollectionTotalNfts.js

@@ -0,0 +1,28 @@
+import { Auth, SDK } from '@infura/sdk';
+import { nonEvaluableContractAddresses } from './nonEvaluableContractAddresses';
+export const getNftCollectionTotalNfts = async (
+/**
+ * The address of the NFT contract to search for
+ */
+contractAddress, 
+/**
+ * The chain ID (1 = Ethereum Mainnet, 4 = Rinkeby, etc.) of the chain to search for NFTs on
+ */
+chainId, 
+// /**
+//  * The ethers provider to use to search for NFTs
+//  */
+// provider: ExternalProvider | JsonRpcFetchFunc,
+/**
+ * The private key of the wallet to use to search for NFTs
+ */
+privateKey) => {
+    if (nonEvaluableContractAddresses.includes(contractAddress.toUpperCase())) {
+        throw new Error(`Unable to evaluate collection with contractAddress: ${contractAddress}`);
+    }
+    const sdk = new SDK(new Auth({ chainId, privateKey, projectId: process.env.INFURA_PROJECT_ID, secretId: process.env.INFURA_PROJECT_SECRET }));
+    const opts = { contractAddress };
+    const { total } = await sdk.api.getNFTsForCollection(opts);
+    return total;
+};
+//# sourceMappingURL=getNftCollectionTotalNfts.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"getNftCollectionTotalNfts.js","sourceRoot":"","sources":["../../../src/lib/getNftCollectionTotalNfts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,aAAa,CAAA;AAEvC,OAAO,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAA;AAO/E,MAAM,CAAC,MAAM,yBAAyB,GAAG,KAAK;AAC5C;;GAEG;AACH,eAAuB;AACvB;;GAEG;AACH,OAAe;AACf,MAAM;AACN,mDAAmD;AACnD,MAAM;AACN,iDAAiD;AACjD;;GAEG;AACH,UAAkB,EACD,EAAE;IACnB,IAAI,6BAA6B,CAAC,QAAQ,CAAC,eAAe,CAAC,WAAW,EAAE,CAAC,EAAE;QACzE,MAAM,IAAI,KAAK,CAAC,uDAAuD,eAAe,EAAE,CAAC,CAAA;KAC1F;IACD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,IAAI,IAAI,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,CAAC,CAAC,CAAA;IAC7I,MAAM,IAAI,GAA2B,EAAE,eAAe,EAAE,CAAA;IACxD,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,GAAG,CAAC,GAAG,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAA;IAC1D,OAAO,KAAK,CAAA;AACd,CAAC,CAAA"}

package/dist/esm/lib/index.js

@@ -1,2 +1,5 @@
+export * from './collectionMetrics';
 export * from './getNftCollectionInfo';
+export * from './getNftCollectionNfts';
+export * from './getNftCollectionTotalNfts';
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/lib/index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/lib/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAA;AACnC,cAAc,wBAAwB,CAAA;AACtC,cAAc,wBAAwB,CAAA;AACtC,cAAc,6BAA6B,CAAA"}

package/dist/esm/lib/nonEvaluableContractAddresses.js

@@ -0,0 +1,9 @@
+/**
+ * These contracts are not evaluable for some
+ * reason (too large, nonsensical, etc.)
+ */
+export const nonEvaluableContractAddresses = [
+    // ENS
+    '0xC18360217D8F7Ab5e7c516566761Ea12Ce7F9D72',
+].map((address) => address.toUpperCase());
+//# sourceMappingURL=nonEvaluableContractAddresses.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"nonEvaluableContractAddresses.js","sourceRoot":"","sources":["../../../src/lib/nonEvaluableContractAddresses.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG;IAC3C,MAAM;IACN,4CAA4C;CAC7C,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAA"}

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

@@ -1 +1 @@
-{"version":3,"file":"Witness.d.ts","sourceRoot":"","sources":["../../src/Witness.ts"],"names":[],"mappings":"AACA,OAAO,EAEL,0BAA0B,EAE3B,MAAM,mDAAmD,CAAA;AAC1D,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAA;AACrD,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AACpD,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAA;AAIrE,MAAM,MAAM,gCAAgC,GAAG,aAAa,CAAC,eAAe,CAAC,0BAA0B,CAAC,CAAC,CAAA;AAEzG,qBAAa,0BAA0B,CACrC,OAAO,SAAS,gCAAgC,GAAG,gCAAgC,CACnF,SAAQ,eAAe,CAAC,OAAO,CAAC;IAChC,OAAgB,aAAa,uDAAqC;cAEzC,cAAc,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;CAalF"}
+{"version":3,"file":"Witness.d.ts","sourceRoot":"","sources":["../../src/Witness.ts"],"names":[],"mappings":"AAEA,OAAO,EAIL,0BAA0B,EAE3B,MAAM,mDAAmD,CAAA;AAC1D,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAA;AACrD,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AACpD,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAA;AAIrE,MAAM,MAAM,gCAAgC,GAAG,aAAa,CAAC,eAAe,CAAC,0BAA0B,CAAC,CAAC,CAAA;AAWzG,qBAAa,0BAA0B,CACrC,OAAO,SAAS,gCAAgC,GAAG,gCAAgC,CACnF,SAAQ,eAAe,CAAC,OAAO,CAAC;IAChC,OAAgB,aAAa,uDAAqC;cAEzC,cAAc,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;CA0BlF"}

package/dist/types/lib/collectionMetrics/getNftCollectionMetrics.d.ts

@@ -0,0 +1,13 @@
+import { NftInfo } from '@xyo-network/crypto-nft-payload-plugin';
+import { Distribution } from './lib';
+export interface NftCollectionMetrics {
+    distribution: {
+        metadata: {
+            attributes: Distribution<{
+                [key: string]: string | number;
+            }>;
+        };
+    };
+}
+export declare const getNftCollectionMetrics: (nfts: NftInfo[]) => NftCollectionMetrics;
+//# sourceMappingURL=getNftCollectionMetrics.d.ts.map

package/dist/types/lib/collectionMetrics/getNftCollectionMetrics.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getNftCollectionMetrics.d.ts","sourceRoot":"","sources":["../../../../src/lib/collectionMetrics/getNftCollectionMetrics.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAuB,MAAM,wCAAwC,CAAA;AAErF,OAAO,EAAsC,YAAY,EAAE,MAAM,OAAO,CAAA;AAExE,MAAM,WAAW,oBAAoB;IACnC,YAAY,EAAE;QACZ,QAAQ,EAAE;YACR,UAAU,EAAE,YAAY,CAAC;gBACvB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAA;aAC/B,CAAC,CAAA;SACH,CAAA;KACF,CAAA;CACF;AAED,eAAO,MAAM,uBAAuB,SAAU,OAAO,EAAE,KAAG,oBAczD,CAAA"}

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

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

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

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

package/dist/types/lib/collectionMetrics/lib/calculateAllPropertiesDistribution.d.ts

@@ -0,0 +1,3 @@
+import { Distribution } from './distribution';
+export declare const calculateAllPropertiesDistribution: <T>(array: T[]) => Distribution<T>;
+//# sourceMappingURL=calculateAllPropertiesDistribution.d.ts.map

package/dist/types/lib/collectionMetrics/lib/calculateAllPropertiesDistribution.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"calculateAllPropertiesDistribution.d.ts","sourceRoot":"","sources":["../../../../../src/lib/collectionMetrics/lib/calculateAllPropertiesDistribution.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAE7C,eAAO,MAAM,kCAAkC,oCAsB9C,CAAA"}

package/dist/types/lib/collectionMetrics/lib/calculatePropertyDistribution.d.ts

@@ -0,0 +1,3 @@
+import { Distribution } from './distribution';
+export declare const calculatePropertyDistribution: <T>(array: T[], property: keyof T) => Distribution<T>;
+//# sourceMappingURL=calculatePropertyDistribution.d.ts.map

package/dist/types/lib/collectionMetrics/lib/calculatePropertyDistribution.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"calculatePropertyDistribution.d.ts","sourceRoot":"","sources":["../../../../../src/lib/collectionMetrics/lib/calculatePropertyDistribution.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAE7C,eAAO,MAAM,6BAA6B,uDAgBzC,CAAA"}

package/dist/types/lib/collectionMetrics/lib/distribution.d.ts

@@ -0,0 +1,6 @@
+export type Distribution<T> = {
+    [K in keyof T]?: {
+        [value: string]: number;
+    };
+};
+//# sourceMappingURL=distribution.d.ts.map

package/dist/types/lib/collectionMetrics/lib/distribution.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"distribution.d.ts","sourceRoot":"","sources":["../../../../../src/lib/collectionMetrics/lib/distribution.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI;KAC3B,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE;QAAE,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE;CAC7C,CAAA"}

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

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

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

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

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

@@ -1,8 +1,3 @@
-import { NftCollectionInfoPayload } from '@xyo-network/crypto-nft-collection-payload-plugin';
-/**
- * These contracts are not evaluable for some
- * reason (too large, nonsensical, etc.)
- */
-export declare const nonEvaluableContractAddresses: string[];
-export declare const getNftCollectionInfo: (contractAddress: string, chainId: number, privateKey: string, maxNftCount?: number) => Promise<NftCollectionInfoPayload>;
+import { NftCollectionInfo } from '@xyo-network/crypto-nft-collection-payload-plugin';
+export declare const getNftCollectionInfo: (contractAddress: string, chainId: number, privateKey: string) => Promise<Omit<NftCollectionInfo, 'total'>>;
 //# sourceMappingURL=getNftCollectionInfo.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"getNftCollectionInfo.d.ts","sourceRoot":"","sources":["../../../src/lib/getNftCollectionInfo.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,wBAAwB,EAAuB,MAAM,mDAAmD,CAAA;AAEjH;;;GAGG;AACH,eAAO,MAAM,6BAA6B,UAGD,CAAA;AAOzC,eAAO,MAAM,oBAAoB,oBAId,MAAM,WAId,MAAM,cAQH,MAAM,2BAMjB,QAAQ,wBAAwB,CAuBlC,CAAA"}
+{"version":3,"file":"getNftCollectionInfo.d.ts","sourceRoot":"","sources":["../../../src/lib/getNftCollectionInfo.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,EAAE,MAAM,mDAAmD,CAAA;AASrF,eAAO,MAAM,oBAAoB,oBAId,MAAM,WAId,MAAM,cAQH,MAAM,KACjB,QAAQ,KAAK,iBAAiB,EAAE,OAAO,CAAC,CAQ1C,CAAA"}

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

@@ -0,0 +1,3 @@
+import { NftInfoPayload } from '@xyo-network/crypto-nft-payload-plugin';
+export declare const getNftCollectionNfts: (contractAddress: string, chainId: number, privateKey: string, maxNftSampleSize?: number) => Promise<NftInfoPayload[]>;
+//# sourceMappingURL=getNftCollectionNfts.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"getNftCollectionNfts.d.ts","sourceRoot":"","sources":["../../../src/lib/getNftCollectionNfts.ts"],"names":[],"mappings":"AACA,OAAO,EAAW,cAAc,EAAa,MAAM,wCAAwC,CAAA;AAS3F,eAAO,MAAM,oBAAoB,oBAId,MAAM,WAId,MAAM,cAQH,MAAM,gCAOjB,QAAQ,cAAc,EAAE,CAkB1B,CAAA"}

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

@@ -0,0 +1,2 @@
+export declare const getNftCollectionTotalNfts: (contractAddress: string, chainId: number, privateKey: string) => Promise<number>;
+//# sourceMappingURL=getNftCollectionTotalNfts.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"getNftCollectionTotalNfts.d.ts","sourceRoot":"","sources":["../../../src/lib/getNftCollectionTotalNfts.ts"],"names":[],"mappings":"AASA,eAAO,MAAM,yBAAyB,oBAInB,MAAM,WAId,MAAM,cAQH,MAAM,KACjB,QAAQ,MAAM,CAQhB,CAAA"}

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

@@ -1,2 +1,5 @@
+export * from './collectionMetrics';
 export * from './getNftCollectionInfo';
+export * from './getNftCollectionNfts';
+export * from './getNftCollectionTotalNfts';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/lib/index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/lib/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAA;AACnC,cAAc,wBAAwB,CAAA;AACtC,cAAc,wBAAwB,CAAA;AACtC,cAAc,6BAA6B,CAAA"}

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

@@ -0,0 +1,6 @@
+/**
+ * These contracts are not evaluable for some
+ * reason (too large, nonsensical, etc.)
+ */
+export declare const nonEvaluableContractAddresses: string[];
+//# sourceMappingURL=nonEvaluableContractAddresses.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"nonEvaluableContractAddresses.d.ts","sourceRoot":"","sources":["../../../src/lib/nonEvaluableContractAddresses.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,eAAO,MAAM,6BAA6B,UAGD,CAAA"}

package/package.json

@@ -12,12 +12,13 @@
   "dependencies": {
     "@infura/sdk": "^2.4.3",
     "@xylabs/assert": "^2.9.3",
-    "@xyo-network/crypto-nft-collection-payload-plugin": "~2.70.5",
-    "@xyo-network/crypto-nft-payload-plugin": "~2.70.5",
-    "@xyo-network/module": "~2.70.5",
-    "@xyo-network/payload-model": "~2.70.5",
-    "@xyo-network/payloadset-plugin": "~2.70.5",
-    "@xyo-network/witness": "~2.70.5"
+    "@xyo-network/core": "~2.70.6",
+    "@xyo-network/crypto-nft-collection-payload-plugin": "~2.70.6",
+    "@xyo-network/crypto-nft-payload-plugin": "~2.70.6",
+    "@xyo-network/module": "~2.70.6",
+    "@xyo-network/payload-model": "~2.70.6",
+    "@xyo-network/payloadset-plugin": "~2.70.6",
+    "@xyo-network/witness": "~2.70.6"
   },
   "devDependencies": {
     "@xylabs/jest-helpers": "^2.9.3",
@@ -60,5 +61,5 @@
   },
   "sideEffects": false,
   "types": "dist/types/index.d.ts",
-  "version": "2.70.5"
+  "version": "2.70.6"
 }

package/src/Witness.ts

@@ -1,6 +1,9 @@
 import { assertEx } from '@xylabs/assert'
+import { PayloadHasher } from '@xyo-network/core'
 import {
   isNftCollectionWitnessQueryPayload,
+  NftCollectionInfoPayload,
+  NftCollectionSchema,
   NftCollectionWitnessConfig,
   NftCollectionWitnessConfigSchema,
 } from '@xyo-network/crypto-nft-collection-payload-plugin'
@@ -8,10 +11,19 @@ import { AnyConfigSchema } from '@xyo-network/module'
 import { Payload } from '@xyo-network/payload-model'
 import { AbstractWitness, WitnessParams } from '@xyo-network/witness'
 
-import { getNftCollectionInfo } from './lib'
+import { getNftCollectionInfo, getNftCollectionMetrics, getNftCollectionNfts, getNftCollectionTotalNfts } from './lib'
 
 export type CryptoNftCollectionWitnessParams = WitnessParams<AnyConfigSchema<NftCollectionWitnessConfig>>
 
+const defaultMaxNftSampleSize = 100
+
+/**
+ * A "no operation" Promise to be used
+ * when no action is desired but a Promise
+ * is required to be returned
+ */
+const NoOp = Promise.resolve()
+
 export class CryptoNftCollectionWitness<
   TParams extends CryptoNftCollectionWitnessParams = CryptoNftCollectionWitnessParams,
 > extends AbstractWitness<TParams> {
@@ -21,11 +33,24 @@ export class CryptoNftCollectionWitness<
     await this.started('throw')
     const queries = payloads?.filter(isNftCollectionWitnessQueryPayload) ?? []
     const observations = await Promise.all(
-      queries.map(async (query) => {
+      queries.map<Promise<NftCollectionInfoPayload>>(async (query) => {
         const address = assertEx(query?.address || this.config.address, 'params.address is required')
         const chainId = assertEx(query?.chainId || this.config.chainId, 'params.chainId is required')
-        const observation = await getNftCollectionInfo(address, chainId, this.account.private.hex)
-        return observation
+        const maxNftSampleSize = query?.maxNftSampleSize || defaultMaxNftSampleSize
+        const [info, total, nfts, archivist] = await Promise.all([
+          getNftCollectionInfo(address, chainId, this.account.private.hex),
+          getNftCollectionTotalNfts(address, chainId, this.account.private.hex),
+          getNftCollectionNfts(address, chainId, this.account.private.hex, maxNftSampleSize),
+          this.writeArchivist(),
+        ])
+        const distribution = getNftCollectionMetrics(nfts)
+        const [sources] = await Promise.all([
+          // Hash all the payloads
+          Promise.all(nfts.map((nft) => PayloadHasher.hashAsync(nft))),
+          // Insert them into the archivist if we have one
+          archivist ? archivist.insert(nfts) : NoOp,
+        ])
+        return { ...info, ...distribution, schema: NftCollectionSchema, sources, total }
       }),
     )
     return observations.flat()

package/src/lib/collectionMetrics/getNftCollectionMetrics.ts

@@ -0,0 +1,29 @@
+import { NftInfo, OpenSeaNftAttribute } from '@xyo-network/crypto-nft-payload-plugin'
+
+import { calculateAllPropertiesDistribution, Distribution } from './lib'
+
+export interface NftCollectionMetrics {
+  distribution: {
+    metadata: {
+      attributes: Distribution<{
+        [key: string]: string | number
+      }>
+    }
+  }
+}
+
+export const getNftCollectionMetrics = (nfts: NftInfo[]): NftCollectionMetrics => {
+  const attributes = nfts
+    .map((nft) => nft.metadata?.attributes as OpenSeaNftAttribute[])
+    .map((attributes) => {
+      return Object.fromEntries(attributes.map((attribute) => [attribute.trait_type, attribute.value]))
+    })
+  const distribution = calculateAllPropertiesDistribution(attributes)
+  return {
+    distribution: {
+      metadata: {
+        attributes: distribution,
+      },
+    },
+  }
+}

package/src/lib/collectionMetrics/index.ts

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

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

@@ -0,0 +1,25 @@
+import { Distribution } from './distribution'
+
+export const calculateAllPropertiesDistribution = <T>(array: T[]): Distribution<T> => {
+  const distribution: Distribution<T> = {}
+
+  array.forEach((item) => {
+    for (const property in item) {
+      if (Object.prototype.hasOwnProperty.call(item, property)) {
+        const value = item[property as keyof T]
+        if (value !== undefined && value !== null) {
+          const valueString = value.toString()
+          if (!distribution[property]) {
+            distribution[property] = { [valueString]: 1 }
+          } else if (!distribution[property]![valueString]) {
+            ;(distribution[property] as Record<string, number>)[valueString] = 1
+          } else {
+            ;(distribution[property] as Record<string, number>)[valueString] += 1
+          }
+        }
+      }
+    }
+  })
+
+  return distribution
+}