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

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

@@ -0,0 +1,24 @@
+import '@xylabs/vitest-extended'
+
+import { readFile } from 'node:fs/promises'
+import Path from 'node:path'
+
+import type { NftInfo } from '@xyo-network/crypto-nft-payload-plugin'
+import {
+  describe, expect,
+  test,
+} from 'vitest'
+
+import { getNftCollectionMetrics } from '../getNftCollectionMetrics.ts'
+
+describe('getNftCollectionMetrics', () => {
+  test('gets NFTs collection metrics', async () => {
+    const filePath = Path.join(__dirname, '..', 'lib', 'spec', 'testData.json')
+    const fileContents = await readFile(filePath, 'utf8')
+    const nfts = JSON.parse(fileContents) as NftInfo[]
+    const result = getNftCollectionMetrics(nfts)
+    expect(result).toBeObject()
+    expect(result?.metadata).toBeObject()
+    expect(result?.metadata?.attributes).toBeObject()
+  })
+})

package/src/lib/spec/getNftCollectionNfts.spec.ts

@@ -0,0 +1,26 @@
+import '@xylabs/vitest-extended'
+
+import type { EthAddress } from '@xylabs/hex'
+import { getProviderFromEnv } from '@xyo-network/witness-blockchain-abstract'
+import {
+  describe, expect, it,
+} from 'vitest'
+
+import { getNftCollectionNfts } from '../getNftCollectionNfts.ts'
+
+describe.skipIf(!process.env.INFURA_PROJECT_ID)('getNftCollectionNfts', () => {
+  const cases: [address: EthAddress, chainId: number][] = [
+    // ['0xb47e3cd837dDF8e4c57F05d70Ab865de6e193BBB', 1], //CryptoPunks - Need special handling
+    ['0xBC4CA0EdA7647A8aB7C2061c2E118A18a936f13D' as EthAddress, 1],
+    ['0x60E4d786628Fea6478F785A6d7e704777c86a7c6' as EthAddress, 1],
+    ['0xED5AF388653567Af2F388E6224dC7C4b3241C544' as EthAddress, 1],
+    ['0x059EDD72Cd353dF5106D2B9cC5ab83a52287aC3a' as EthAddress, 1],
+  ]
+
+  it.each(cases)('gets NFTs owned by the address', async (address, chainId) => {
+    const provider = getProviderFromEnv(chainId)
+    const result = await getNftCollectionNfts(address, provider, undefined, 5)
+    expect(result).toBeArray()
+    expect(result.at(0)).toBeObject()
+  })
+})

package/src/lib/spec/tokenTypes.spec.ts

@@ -0,0 +1,26 @@
+import '@xylabs/vitest-extended'
+
+import { getProviderFromEnv } from '@xyo-network/witness-blockchain-abstract'
+import {
+  describe, expect,
+  it,
+} from 'vitest'
+
+import { isErc721, isErc1155 } from '../tokenTypes.ts'
+
+describe.skipIf(!process.env.INFURA_PROJECT_ID)('getNftCollectionMetadata', () => {
+  it('Check ERC721', async () => {
+    const provider = getProviderFromEnv(0x01)
+    const address = '0xBC4CA0EdA7647A8aB7C2061c2E118A18a936f13D'
+    const result721 = await isErc721(provider, address)
+    const result1155 = await isErc1155(provider, address)
+    expect(result721).toBeTrue()
+    expect(result1155).toBeFalse()
+  })
+  it('Check ERC1155', async () => {
+    const provider = getProviderFromEnv(0x01)
+    const address = '0x495f947276749ce646f68ac8c248420045cb7b5e'
+    const result1155 = await isErc1155(provider, address)
+    expect(result1155).toBeTrue()
+  })
+})

package/src/spec/Plugin.spec.ts

@@ -0,0 +1,17 @@
+import '@xylabs/vitest-extended'
+
+import { PayloadSetPluginResolver } from '@xyo-network/payloadset-plugin'
+import {
+  describe, expect,
+  test,
+} from 'vitest'
+
+import { CryptoNftCollectionWitnessPlugin } from '../Plugin.ts'
+
+describe('CryptoNftCollectionWitnessPlugin', () => {
+  test('Add to Resolver', async () => {
+    const plugin = CryptoNftCollectionWitnessPlugin()
+    const resolver = await new PayloadSetPluginResolver().register(plugin)
+    expect(resolver.resolve(plugin.set)).toBeDefined()
+  })
+})

package/src/spec/Witness.spec.ts

@@ -0,0 +1,101 @@
+import '@xylabs/vitest-extended'
+
+import { writeFile } from 'node:fs/promises'
+
+import { Account } from '@xyo-network/account'
+import type { AccountInstance } from '@xyo-network/account-model'
+import type { NftCollectionWitnessQuery } from '@xyo-network/crypto-nft-collection-payload-plugin'
+import {
+  isNftCollectionInfoWithSources,
+  NftCollectionWitnessConfigSchema,
+  NftCollectionWitnessQuerySchema,
+} from '@xyo-network/crypto-nft-collection-payload-plugin'
+import type { Payload } from '@xyo-network/payload-model'
+import { getProvidersFromEnv } from '@xyo-network/witness-blockchain-abstract'
+import {
+  beforeAll, describe, expect,
+  it,
+} from 'vitest'
+
+import { CryptoNftCollectionWitness } from '../Witness.ts'
+
+const validateObservation = (observation: Payload[]) => {
+  const results = observation.filter(isNftCollectionInfoWithSources)
+  expect(results.length).toBeGreaterThan(0)
+  const collectionInfo = results[0]
+  expect(collectionInfo.address).toBeString()
+  expect(collectionInfo.chainId).toBeNumber()
+  expect(collectionInfo.name).toBeString()
+  expect(collectionInfo.type).toBeOneOf(['ERC721', 'ERC1155', null])
+  expect(collectionInfo.$sources).toBeArray()
+  expect(collectionInfo.$sources?.length).toBeGreaterThan(0)
+}
+
+/**
+ * @group slow
+ */
+
+describe.skipIf(!process.env.INFURA_PROJECT_ID)('CryptoNftCollectionWitness', () => {
+  let account: AccountInstance
+  beforeAll(async () => {
+    account = await Account.random()
+  })
+  describe('observe', () => {
+    const address = '0xBC4CA0EdA7647A8aB7C2061c2E118A18a936f13D'
+    const chainId = 1
+    describe('with no address or chainId in query', () => {
+      it('uses values from config', async () => {
+        const witness = await CryptoNftCollectionWitness.create({
+          account,
+          config: {
+            address, chainId, schema: NftCollectionWitnessConfigSchema,
+          },
+          providers: () => getProvidersFromEnv(1, chainId),
+        })
+        const query: NftCollectionWitnessQuery = { maxNfts: 10, schema: NftCollectionWitnessQuerySchema }
+        const observation = await witness.observe([query])
+        validateObservation(observation)
+      })
+    })
+    describe('with address and chainId in query', () => {
+      it('uses values from query', async () => {
+        const witness = await CryptoNftCollectionWitness.create({
+          account,
+          config: { schema: NftCollectionWitnessConfigSchema },
+          providers: () => getProvidersFromEnv(1, chainId),
+        })
+        const query: NftCollectionWitnessQuery = {
+          address, chainId, maxNfts: 10, schema: NftCollectionWitnessQuerySchema,
+        }
+        const observation = await witness.observe([query])
+        validateObservation(observation)
+      })
+    })
+  })
+  describe.skip('with common NFT collections', () => {
+    const cases: [address: string, chainId: number][] = [
+      ['0xb47e3cd837dDF8e4c57F05d70Ab865de6e193BBB', 1],
+      ['0xBC4CA0EdA7647A8aB7C2061c2E118A18a936f13D', 1],
+      ['0x60E4d786628Fea6478F785A6d7e704777c86a7c6', 1],
+      ['0xED5AF388653567Af2F388E6224dC7C4b3241C544', 1],
+      ['0x059EDD72Cd353dF5106D2B9cC5ab83a52287aC3a', 1],
+    ]
+    it.each(cases)(
+      'witness the collection',
+      async (address, chainId) => {
+        const witness = await CryptoNftCollectionWitness.create({
+          account,
+          config: { schema: NftCollectionWitnessConfigSchema },
+          providers: () => getProvidersFromEnv(1, chainId),
+        })
+        const query: NftCollectionWitnessQuery = {
+          address, chainId, maxNfts: 20_000, schema: NftCollectionWitnessQuerySchema,
+        }
+        const observation = await witness.observe([query])
+        validateObservation(observation)
+        await writeFile(`./nftData/witness/${address}-witness.json`, JSON.stringify(observation, null, 2))
+      },
+      120_000,
+    )
+  })
+})

package/typedoc.json

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