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

package/src/lib/collectionMetrics/lib/calculatePropertyDistribution.ts

@@ -0,0 +1,19 @@
+import { Distribution } from './distribution'
+
+export const calculatePropertyDistribution = <T>(array: T[], property: keyof T): Distribution<T> => {
+  const distribution: Distribution<T> = {}
+  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] as Record<string, number>)[valueString] = 1
+      } else {
+        ;(distribution[property] as Record<string, number>)[valueString] += 1
+      }
+    }
+  })
+  return distribution
+}

package/src/lib/collectionMetrics/lib/distribution.ts

@@ -0,0 +1,3 @@
+export type Distribution<T> = {
+  [K in keyof T]?: { [value: string]: number }
+}

package/src/lib/collectionMetrics/lib/index.ts

@@ -0,0 +1,2 @@
+export * from './calculateAllPropertiesDistribution'
+export * from './distribution'

package/src/lib/getNftCollectionInfo.ts

@@ -1,14 +1,7 @@
 import { Auth, SDK } from '@infura/sdk'
-import { NftCollectionInfoPayload, NftCollectionSchema } from '@xyo-network/crypto-nft-collection-payload-plugin'
+import { NftCollectionInfo } 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'
 
 type ContractAddressOptions = {
   contractAddress: string
@@ -32,32 +25,12 @@ export const getNftCollectionInfo = async (
    * The private key of the wallet to use to search for NFTs
    */
   privateKey: string,
-  /**
-   * The maximum number of NFTs to return. Configurable to prevent
-   * large wallets from exhausting Infura API credits.
-   */
-  maxNftCount = 20000,
-): Promise<NftCollectionInfoPayload> => {
+): Promise<Omit<NftCollectionInfo, 'total'>> => {
   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: ContractAddressOptions = { 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 }
 }

package/src/lib/getNftCollectionNfts.ts

@@ -0,0 +1,52 @@
+import { Auth, SDK } from '@infura/sdk'
+import { NftInfo, NftInfoPayload, NftSchema } from '@xyo-network/crypto-nft-payload-plugin'
+
+import { nonEvaluableContractAddresses } from './nonEvaluableContractAddresses'
+
+type ContractAddressOptions = {
+  contractAddress: string
+  cursor?: string
+}
+
+export const getNftCollectionNfts = async (
+  /**
+   * The address of the NFT contract to search for
+   */
+  contractAddress: string,
+  /**
+   * The chain ID (1 = Ethereum Mainnet, 4 = Rinkeby, etc.) of the chain to search for NFTs on
+   */
+  chainId: number,
+  // /**
+  //  * 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: string,
+  /**
+   * 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,
+): Promise<NftInfoPayload[]> => {
+  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: NftInfo[] = []
+  let cursor: string | undefined = undefined
+  do {
+    const opts: ContractAddressOptions = { contractAddress, cursor }
+    const { cursor: nextCursor, pageSize, total, assets } = await sdk.api.getNFTsForCollection(opts)
+    const batch: NftInfo[] = 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 }
+  })
+}

package/src/lib/getNftCollectionTotalNfts.ts

@@ -0,0 +1,35 @@
+import { Auth, SDK } from '@infura/sdk'
+
+import { nonEvaluableContractAddresses } from './nonEvaluableContractAddresses'
+
+type ContractAddressOptions = {
+  contractAddress: string
+  cursor?: string
+}
+
+export const getNftCollectionTotalNfts = async (
+  /**
+   * The address of the NFT contract to search for
+   */
+  contractAddress: string,
+  /**
+   * The chain ID (1 = Ethereum Mainnet, 4 = Rinkeby, etc.) of the chain to search for NFTs on
+   */
+  chainId: number,
+  // /**
+  //  * 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: string,
+): Promise<number> => {
+  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: ContractAddressOptions = { contractAddress }
+  const { total } = await sdk.api.getNFTsForCollection(opts)
+  return total
+}

package/src/lib/index.ts

@@ -1 +1,4 @@
+export * from './collectionMetrics'
 export * from './getNftCollectionInfo'
+export * from './getNftCollectionNfts'
+export * from './getNftCollectionTotalNfts'

package/src/lib/nonEvaluableContractAddresses.ts

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