@xyo-network/crypto-nft-collection-witness-plugin 2.70.3

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 { createPayloadSetWitnessPlugin } from '@xyo-network/payloadset-plugin';
+import { CryptoNftCollectionWitness } from './Witness';
+export const CryptoNftCollectionWitnessPlugin = () => createPayloadSetWitnessPlugin({ required: { [NftSchema]: 1 }, schema: PayloadSetSchema }, {
+    witness: async (params) => {
+        const result = await CryptoNftCollectionWitness.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,0BAA0B,EAAE,MAAM,WAAW,CAAA;AAEtD,MAAM,CAAC,MAAM,gCAAgC,GAAG,GAAG,EAAE,CACnD,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,0BAA0B,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;QAC9D,OAAO,MAAM,CAAA;IACf,CAAC;CACF,CACF,CAAA"}

package/dist/esm/Witness.js

@@ -0,0 +1,22 @@
+import { assertEx } from '@xylabs/assert';
+import { isNftCollectionWitnessQueryPayload, NftCollectionWitnessConfigSchema, } from '@xyo-network/crypto-nft-collection-payload-plugin';
+import { AbstractWitness } from '@xyo-network/witness';
+import { getNftCollectionInfo } from './lib';
+export class CryptoNftCollectionWitness extends AbstractWitness {
+    static configSchemas = [NftCollectionWitnessConfigSchema];
+    get provider() {
+        return assertEx(this.params.provider, 'Provider Required');
+    }
+    async observeHandler(payloads) {
+        await this.started('throw');
+        const queries = payloads?.filter(isNftCollectionWitnessQueryPayload) ?? [];
+        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;
+        }));
+        return observations.flat();
+    }
+}
+//# sourceMappingURL=Witness.js.map

package/dist/esm/Witness.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Witness.js","sourceRoot":"","sources":["../../src/Witness.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AACzC,OAAO,EACL,kCAAkC,EAIlC,gCAAgC,GACjC,MAAM,mDAAmD,CAAA;AAG1D,OAAO,EAAE,eAAe,EAAiB,MAAM,sBAAsB,CAAA;AAErE,OAAO,EAAE,oBAAoB,EAAE,MAAM,OAAO,CAAA;AAS5C,MAAM,OAAO,0BAEX,SAAQ,eAAwB;IAChC,MAAM,CAAU,aAAa,GAAG,CAAC,gCAAgC,CAAC,CAAA;IAElE,IAAc,QAAQ;QACpB,OAAO,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,mBAAmB,CAAC,CAAA;IAC5D,CAAC;IAEkB,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"}

package/dist/esm/index.js

@@ -0,0 +1,7 @@
+import { CryptoNftCollectionWitnessPlugin } from './Plugin';
+export * from './lib';
+export * from './Witness';
+export { CryptoNftCollectionWitnessPlugin };
+// eslint-disable-next-line import/no-default-export
+export default CryptoNftCollectionWitnessPlugin;
+//# 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,gCAAgC,EAAE,MAAM,UAAU,CAAA;AAE3D,cAAc,OAAO,CAAA;AACrB,cAAc,WAAW,CAAA;AAEzB,OAAO,EAAE,gCAAgC,EAAE,CAAA;AAE3C,oDAAoD;AACpD,eAAe,gCAAgC,CAAA"}

package/dist/esm/lib/getNftCollectionInfo.js

@@ -0,0 +1,54 @@
+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());
+export const getNftCollectionInfo = 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.
+ */
+maxNftCount = 20000) => {
+    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 opts = { contractAddress };
+    const { name, symbol, tokenType } = await sdk.api.getContractMetadata(opts);
+    return { address: contractAddress, chainId, name, schema: NftCollectionSchema, symbol, tokenType };
+};
+//# sourceMappingURL=getNftCollectionInfo.js.map

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

@@ -0,0 +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"}

package/dist/esm/lib/index.js

@@ -0,0 +1,2 @@
+export * from './getNftCollectionInfo';
+//# 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,wBAAwB,CAAA"}

package/dist/types/Plugin.d.ts

@@ -0,0 +1,54 @@
+import { CryptoNftCollectionWitness } from './Witness';
+export declare const CryptoNftCollectionWitnessPlugin: () => import("@xyo-network/payloadset-plugin").PayloadSetWitnessPlugin<CryptoNftCollectionWitness<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.witness.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.witness.config";
+        targetSet?: (import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & import("@xyo-network/payload-model").PayloadSet & {
+            schema: "network.xyo.payload.set";
+        }) | undefined;
+    } & {
+        address?: string | undefined;
+        chainId?: number | undefined;
+        schema: "network.xyo.crypto.nft.collection.witness.config";
+    }, "schema"> & {
+        schema: "network.xyo.crypto.nft.collection.witness.config";
+    }, "schema"> & {
+        schema: string;
+    }, "schema"> & {
+        schema: string;
+    };
+    ephemeralQueryAccountEnabled?: boolean | undefined;
+    wallet?: import("@xyo-network/wallet-model").WalletInstance | undefined;
+} & {
+    provider?: import("@ethersproject/providers").ExternalProvider | import("@ethersproject/providers").JsonRpcFetchFunc | 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,0BAA0B,EAAE,MAAM,WAAW,CAAA;AAEtD,eAAO,MAAM,gCAAgC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAS1C,CAAA"}

package/dist/types/Witness.d.ts

@@ -0,0 +1,14 @@
+import type { ExternalProvider, JsonRpcFetchFunc } from '@ethersproject/providers';
+import { NftCollectionWitnessConfig } from '@xyo-network/crypto-nft-collection-payload-plugin';
+import { AnyConfigSchema } from '@xyo-network/module';
+import { Payload } from '@xyo-network/payload-model';
+import { AbstractWitness, WitnessParams } from '@xyo-network/witness';
+export type CryptoNftCollectionWitnessParams = WitnessParams<AnyConfigSchema<NftCollectionWitnessConfig>, {
+    provider?: ExternalProvider | JsonRpcFetchFunc;
+}>;
+export declare class CryptoNftCollectionWitness<TParams extends CryptoNftCollectionWitnessParams = CryptoNftCollectionWitnessParams> extends AbstractWitness<TParams> {
+    static configSchemas: "network.xyo.crypto.nft.collection.witness.config"[];
+    protected get provider(): ExternalProvider | JsonRpcFetchFunc;
+    protected observeHandler(payloads?: Payload[]): Promise<Payload[]>;
+}
+//# sourceMappingURL=Witness.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Witness.d.ts","sourceRoot":"","sources":["../../src/Witness.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAElF,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,CAC1D,eAAe,CAAC,0BAA0B,CAAC,EAC3C;IACE,QAAQ,CAAC,EAAE,gBAAgB,GAAG,gBAAgB,CAAA;CAC/C,CACF,CAAA;AAED,qBAAa,0BAA0B,CACrC,OAAO,SAAS,gCAAgC,GAAG,gCAAgC,CACnF,SAAQ,eAAe,CAAC,OAAO,CAAC;IAChC,OAAgB,aAAa,uDAAqC;IAElE,SAAS,KAAK,QAAQ,wCAErB;cAEwB,cAAc,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;CAalF"}

package/dist/types/index.d.ts

@@ -0,0 +1,6 @@
+import { CryptoNftCollectionWitnessPlugin } from './Plugin';
+export * from './lib';
+export * from './Witness';
+export { CryptoNftCollectionWitnessPlugin };
+export default CryptoNftCollectionWitnessPlugin;
+//# 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,gCAAgC,EAAE,MAAM,UAAU,CAAA;AAE3D,cAAc,OAAO,CAAA;AACrB,cAAc,WAAW,CAAA;AAEzB,OAAO,EAAE,gCAAgC,EAAE,CAAA;AAG3C,eAAe,gCAAgC,CAAA"}

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

@@ -0,0 +1,8 @@
+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>;
+//# sourceMappingURL=getNftCollectionInfo.d.ts.map

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

@@ -0,0 +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"}

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

@@ -0,0 +1,2 @@
+export * from './getNftCollectionInfo';
+//# 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,wBAAwB,CAAA"}

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@xyo-network/crypto-nft-collection-witness-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": {
+    "@ethersproject/providers": "^5.7.2",
+    "@infura/sdk": "^2.4.3",
+    "@xylabs/assert": "^2.9.3",
+    "@xyo-network/crypto-nft-collection-payload-plugin": "~2.70.3",
+    "@xyo-network/crypto-nft-payload-plugin": "~2.70.3",
+    "@xyo-network/module": "~2.70.3",
+    "@xyo-network/payload-model": "~2.70.3",
+    "@xyo-network/payloadset-plugin": "~2.70.3",
+    "@xyo-network/witness": "~2.70.3"
+  },
+  "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.3"
+}

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 { createPayloadSetWitnessPlugin } from '@xyo-network/payloadset-plugin'
+
+import { CryptoNftCollectionWitness } from './Witness'
+
+export const CryptoNftCollectionWitnessPlugin = () =>
+  createPayloadSetWitnessPlugin<CryptoNftCollectionWitness>(
+    { required: { [NftSchema]: 1 }, schema: PayloadSetSchema },
+    {
+      witness: async (params) => {
+        const result = await CryptoNftCollectionWitness.create(params)
+        return result
+      },
+    },
+  )

package/src/Witness.ts

@@ -0,0 +1,45 @@
+import type { ExternalProvider, JsonRpcFetchFunc } from '@ethersproject/providers'
+import { assertEx } from '@xylabs/assert'
+import {
+  isNftCollectionWitnessQueryPayload,
+  NftCollectionInfoPayload,
+  NftCollectionSchema,
+  NftCollectionWitnessConfig,
+  NftCollectionWitnessConfigSchema,
+} from '@xyo-network/crypto-nft-collection-payload-plugin'
+import { AnyConfigSchema } from '@xyo-network/module'
+import { Payload } from '@xyo-network/payload-model'
+import { AbstractWitness, WitnessParams } from '@xyo-network/witness'
+
+import { getNftCollectionInfo } from './lib'
+
+export type CryptoNftCollectionWitnessParams = WitnessParams<
+  AnyConfigSchema<NftCollectionWitnessConfig>,
+  {
+    provider?: ExternalProvider | JsonRpcFetchFunc
+  }
+>
+
+export class CryptoNftCollectionWitness<
+  TParams extends CryptoNftCollectionWitnessParams = CryptoNftCollectionWitnessParams,
+> extends AbstractWitness<TParams> {
+  static override configSchemas = [NftCollectionWitnessConfigSchema]
+
+  protected get provider() {
+    return assertEx(this.params.provider, 'Provider Required')
+  }
+
+  protected override async observeHandler(payloads?: Payload[]): Promise<Payload[]> {
+    await this.started('throw')
+    const queries = payloads?.filter(isNftCollectionWitnessQueryPayload) ?? []
+    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
+      }),
+    )
+    return observations.flat()
+  }
+}

package/src/index.ts

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

package/src/lib/getNftCollectionInfo.ts

@@ -0,0 +1,63 @@
+import { Auth, SDK } from '@infura/sdk'
+import { NftCollectionInfoPayload, 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())
+
+type ContractAddressOptions = {
+  contractAddress: string
+  cursor?: string
+}
+
+export const getNftCollectionInfo = 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.
+   */
+  maxNftCount = 20000,
+): Promise<NftCollectionInfoPayload> => {
+  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 opts: ContractAddressOptions = { contractAddress }
+  const { name, symbol, tokenType } = await sdk.api.getContractMetadata(opts)
+  return { address: contractAddress, chainId, name, schema: NftCollectionSchema, symbol, tokenType }
+}

package/src/lib/index.ts

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

package/typedoc.json

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