@xyo-network/evm-plugins 4.2.0 → 5.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/evm-plugins",
-  "version": "4.2.0",
+  "version": "5.0.1",
   "description": "Typescript/Javascript Plugins for XYO Platform",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -28,42 +28,46 @@
   },
   "module": "dist/neutral/index.mjs",
   "types": "dist/neutral/index.d.ts",
+  "files": [
+    "dist",
+    "src"
+  ],
   "dependencies": {
-    "@xyo-network/erc1822-witness": "^4.2.0",
-    "@xyo-network/erc1967-witness": "^4.2.0",
-    "@xyo-network/ethereum-blockchain-plugins": "^4.2.0",
-    "@xyo-network/evm-abi-diviner": "^4.2.0",
-    "@xyo-network/evm-call-witness": "^4.2.0",
-    "@xyo-network/evm-contract-witness": "^4.2.0",
-    "@xyo-network/payloadset-plugin": "^4.3.0"
+    "@xyo-network/erc1822-witness": "~5.0.1",
+    "@xyo-network/erc1967-witness": "~5.0.1",
+    "@xyo-network/ethereum-blockchain-plugins": "~5.0.1",
+    "@xyo-network/evm-abi-diviner": "~5.0.1",
+    "@xyo-network/evm-call-witness": "~5.0.1",
+    "@xyo-network/evm-contract-witness": "~5.0.1",
+    "@xyo-network/payloadset-plugin": "~5.0.2"
   },
   "devDependencies": {
-    "@xylabs/delay": "^4.15.1",
-    "@xylabs/ts-scripts-yarn3": "^7.0.1",
-    "@xylabs/tsconfig": "^7.0.1",
-    "@xylabs/vitest-extended": "^4.15.1",
-    "@xyo-network/api-call-witness": "^4.2.0",
-    "@xyo-network/archivist-model": "^4.3.0",
-    "@xyo-network/crypto-nft-payload-plugin": "^4.2.0",
-    "@xyo-network/diviner-boundwitness-memory": "^4.3.0",
-    "@xyo-network/diviner-evm-call-result-to-token-uri": "^4.2.0",
-    "@xyo-network/diviner-model": "^4.3.0",
-    "@xyo-network/diviner-payload-generic": "^4.3.0",
-    "@xyo-network/diviner-payload-model": "^4.3.0",
-    "@xyo-network/diviner-temporal-indexing": "^4.3.0",
-    "@xyo-network/evm-nft-id-payload-plugin": "^4.2.0",
-    "@xyo-network/manifest": "^4.3.0",
-    "@xyo-network/module-factory-locator": "^4.3.0",
-    "@xyo-network/module-model": "^4.3.0",
-    "@xyo-network/node-memory": "^4.3.0",
-    "@xyo-network/open-zeppelin-typechain": "^3.5.4",
-    "@xyo-network/payload-model": "^4.3.0",
-    "@xyo-network/sentinel-model": "^4.3.0",
-    "@xyo-network/wallet": "^4.3.0",
-    "@xyo-network/witness-evm-abstract": "^4.3.0",
-    "@xyo-network/witness-timestamp": "^4.3.0",
-    "typescript": "^5.8.3",
-    "vitest": "^3.2.4"
+    "@xylabs/delay": "~5.0.7",
+    "@xylabs/ts-scripts-yarn3": "~7.1.0",
+    "@xylabs/tsconfig": "~7.1.0",
+    "@xylabs/vitest-extended": "~5.0.7",
+    "@xyo-network/api-call-witness": "~5.0.1",
+    "@xyo-network/archivist-model": "~5.0.2",
+    "@xyo-network/crypto-nft-payload-plugin": "~5.0.1",
+    "@xyo-network/diviner-boundwitness-memory": "~5.0.2",
+    "@xyo-network/diviner-evm-call-result-to-token-uri": "~5.0.1",
+    "@xyo-network/diviner-model": "~5.0.2",
+    "@xyo-network/diviner-payload-generic": "~5.0.2",
+    "@xyo-network/diviner-payload-model": "~5.0.2",
+    "@xyo-network/diviner-temporal-indexing": "~5.0.2",
+    "@xyo-network/evm-nft-id-payload-plugin": "~5.0.1",
+    "@xyo-network/manifest": "~5.0.2",
+    "@xyo-network/module-factory-locator": "~5.0.2",
+    "@xyo-network/module-model": "~5.0.2",
+    "@xyo-network/node-memory": "~5.0.2",
+    "@xyo-network/open-zeppelin-typechain": "~4.0.0",
+    "@xyo-network/payload-model": "~5.0.2",
+    "@xyo-network/sentinel-model": "~5.0.2",
+    "@xyo-network/wallet": "~5.0.2",
+    "@xyo-network/witness-evm-abstract": "~5.0.2",
+    "@xyo-network/witness-timestamp": "~5.0.2",
+    "typescript": "~5.9.2",
+    "vitest": "~3.2.4"
   },
   "publishConfig": {
     "access": "public"

package/src/spec/NftIdToNftMetadataUri/NftIdToNftMetadataUri.spec.ts

@@ -0,0 +1,117 @@
+import '@xylabs/vitest-extended'
+
+import { delay } from '@xylabs/delay'
+import { MemoryBoundWitnessDiviner } from '@xyo-network/diviner-boundwitness-memory'
+import { EvmCallResultToNftTokenUriDiviner } from '@xyo-network/diviner-evm-call-result-to-token-uri'
+import { asDivinerInstance } from '@xyo-network/diviner-model'
+import { GenericPayloadDiviner } from '@xyo-network/diviner-payload-generic'
+import { PayloadDivinerQuerySchema } from '@xyo-network/diviner-payload-model'
+import {
+  TemporalIndexingDiviner,
+  TemporalIndexingDivinerDivinerQueryToIndexQueryDiviner,
+  TemporalIndexingDivinerIndexCandidateToIndexDiviner,
+  TemporalIndexingDivinerIndexQueryResponseToDivinerQueryResponseDiviner,
+  TemporalIndexingDivinerStateToIndexCandidateDiviner,
+} from '@xyo-network/diviner-temporal-indexing'
+import type { EvmCall, EvmCallWitnessParams } from '@xyo-network/evm-call-witness'
+import {
+  EvmCallDiviner, EvmCallSchema, EvmCallWitness,
+} from '@xyo-network/evm-call-witness'
+import { isNftMetadataUri, NftMetadataUriSchema } from '@xyo-network/evm-nft-id-payload-plugin'
+import type { PackageManifestPayload } from '@xyo-network/manifest'
+import { ManifestWrapper } from '@xyo-network/manifest'
+import { ModuleFactoryLocator } from '@xyo-network/module-factory-locator'
+import { ModuleFactory } from '@xyo-network/module-model'
+import type { MemoryNode } from '@xyo-network/node-memory'
+import { ERC721URIStorage__factory } from '@xyo-network/open-zeppelin-typechain'
+import type { Payload } from '@xyo-network/payload-model'
+import { asSentinelInstance } from '@xyo-network/sentinel-model'
+import { HDWallet } from '@xyo-network/wallet'
+import { getProvidersFromEnv } from '@xyo-network/witness-evm-abstract'
+import { TimestampWitness } from '@xyo-network/witness-timestamp'
+import {
+  beforeAll, describe, expect,
+  it,
+} from 'vitest'
+
+import nftIdToNftMetadataUri from './NftIdToNftMetadataUri.json' with { type: 'json' }
+
+const maxProviders = 2
+const providers = getProvidersFromEnv(maxProviders)
+
+describe.skipIf(providers.length === 0)('NftIdToNftMetadataUri', () => {
+  const chainId = 1
+  let node: MemoryNode
+  const cases = [
+    // Bored Apes
+    ['0xBC4CA0EdA7647A8aB7C2061c2E118A18a936f13D', '0x0f'],
+    // Gutter Cat Gang
+    ['0xEdB61f74B0d09B2558F1eeb79B247c1F363Ae452', '0x543'],
+  ]
+  beforeAll(async () => {
+    const wallet = await HDWallet.random()
+    const locator = new ModuleFactoryLocator()
+    locator.register(MemoryBoundWitnessDiviner.factory())
+    locator.register(GenericPayloadDiviner.factory())
+    locator.register(TemporalIndexingDivinerDivinerQueryToIndexQueryDiviner.factory())
+    locator.register(TemporalIndexingDivinerIndexCandidateToIndexDiviner.factory())
+    locator.register(TemporalIndexingDivinerIndexQueryResponseToDivinerQueryResponseDiviner.factory())
+    locator.register(TemporalIndexingDivinerStateToIndexCandidateDiviner.factory())
+    locator.register(TemporalIndexingDiviner.factory())
+    locator.register(TimestampWitness.factory())
+    locator.register(EvmCallDiviner.factory())
+    locator.register(EvmCallResultToNftTokenUriDiviner.factory())
+    locator.register(
+      new ModuleFactory(EvmCallWitness, {
+        config: { abi: ERC721URIStorage__factory.abi },
+        providers: () => getProvidersFromEnv(maxProviders),
+      } as EvmCallWitnessParams),
+      { 'network.xyo.evm.interface': 'ERC721TokenUri' },
+    )
+    const manifest = nftIdToNftMetadataUri as PackageManifestPayload
+    const manifestWrapper = new ManifestWrapper(manifest, wallet, locator)
+    node = await manifestWrapper.loadNodeFromIndex(0)
+    const mods = await node.resolve('*')
+    const publicModules = manifest.nodes[0].modules?.public ?? []
+    expect(mods.length).toBeGreaterThan(publicModules.length)
+  })
+  describe('Sentinel', () => {
+    it.each(cases)('returns metadata URI for token ID', async (address, tokenId) => {
+      const tokenCallPayload: EvmCall = {
+        address, args: [tokenId], schema: EvmCallSchema,
+      }
+      const tokenSentinel = asSentinelInstance(await node.resolve('NftTokenUriSentinel'))
+      expect(tokenSentinel).toBeDefined()
+      const report = await tokenSentinel?.report([tokenCallPayload])
+      const results = report?.filter(isNftMetadataUri) ?? []
+      expect(results.length).toBe(1)
+      expect(results?.[0]?.address).toBe(address)
+      expect(results?.[0]?.chainId).toBe(chainId)
+      expect(results?.[0]?.tokenId).toBe(tokenId)
+      expect(results?.[0]?.schema).toBe(NftMetadataUriSchema)
+      expect(results?.[0]?.metadataUri).toBeString()
+      const num = Number(BigInt(tokenId)).toString()
+      // It is not always true that the metadata URI contains the token ID, but
+      // it is true for the cases we are testing
+      expect(results?.[0]?.metadataUri).toContain(num)
+    })
+  })
+  describe.skip('Index', () => {
+    beforeAll(async () => {
+      await delay(100)
+    })
+    it.each(cases)('returns indexed NftIndex results', async (address, tokenId) => {
+      const diviner = asDivinerInstance(await node.resolve('IndexDiviner'))
+      expect(diviner).toBeDefined()
+      const query = {
+        address, chainId, length: 1, schema: PayloadDivinerQuerySchema, tokenId,
+      }
+      const result = (await diviner?.divine([query])) as unknown as Payload<{ address?: string; chainId?: number; tokenId?: string }>[]
+      expect(result).toBeDefined()
+      expect(result).toBeArrayOfSize(1)
+      expect(result?.[0]?.address).toBe(address)
+      expect(result?.[0]?.chainId).toBe(chainId)
+      expect(result?.[0]?.tokenId).toBe(tokenId)
+    })
+  })
+})

package/src/spec/NftMetadataUriToNftMetadata/NftMetadataUriToNftMetadata.spec.ts

@@ -0,0 +1,119 @@
+import '@xylabs/vitest-extended'
+
+import { delay } from '@xylabs/delay'
+import type { ApiCallWitnessParams, ApiUriCallPayload } from '@xyo-network/api-call-witness'
+import {
+  ApiCallSchema, ApiCallWitness, ApiCallWitnessConfigSchema,
+  isApiCallJsonResult,
+} from '@xyo-network/api-call-witness'
+import { asArchivistInstance } from '@xyo-network/archivist-model'
+import type { OpenSeaNftMetadata } from '@xyo-network/crypto-nft-payload-plugin'
+import { MemoryBoundWitnessDiviner } from '@xyo-network/diviner-boundwitness-memory'
+import { asDivinerInstance } from '@xyo-network/diviner-model'
+import { GenericPayloadDiviner } from '@xyo-network/diviner-payload-generic'
+import { PayloadDivinerQuerySchema } from '@xyo-network/diviner-payload-model'
+import {
+  TemporalIndexingDiviner,
+  TemporalIndexingDivinerDivinerQueryToIndexQueryDiviner,
+  TemporalIndexingDivinerIndexCandidateToIndexDiviner,
+  TemporalIndexingDivinerIndexQueryResponseToDivinerQueryResponseDiviner,
+  TemporalIndexingDivinerStateToIndexCandidateDiviner,
+} from '@xyo-network/diviner-temporal-indexing'
+import type { PackageManifestPayload } from '@xyo-network/manifest'
+import { ManifestWrapper } from '@xyo-network/manifest'
+import { ModuleFactoryLocator } from '@xyo-network/module-factory-locator'
+import { ModuleFactory } from '@xyo-network/module-model'
+import type { MemoryNode } from '@xyo-network/node-memory'
+import type { Payload } from '@xyo-network/payload-model'
+import { asSentinelInstance } from '@xyo-network/sentinel-model'
+import { HDWallet } from '@xyo-network/wallet'
+import { getProvidersFromEnv } from '@xyo-network/witness-evm-abstract'
+import { TimestampWitness } from '@xyo-network/witness-timestamp'
+import {
+  beforeAll, describe, expect,
+  it,
+} from 'vitest'
+
+import nftIdToNftMetadataUri from './NftMetadataUriToNftMetadata.json' with { type: 'json' }
+
+const maxProviders = 2
+const providers = getProvidersFromEnv(maxProviders)
+
+describe.skipIf(providers.length === 0)('NftMetadataUriToNftMetadata', () => {
+  let node: MemoryNode
+  const cases: ApiUriCallPayload[] = [
+    {
+      schema: ApiCallSchema,
+      // BAYC
+      uri: 'ipfs://QmeSjSinHpPnmXmspMjwiXyN6zS4E9zccariGR3jxcaWtq/15',
+    },
+    /* {
+      schema: ApiCallSchema,
+      // Gutter Cats
+      uri: 'https://gutter-cats-metadata.s3.us-east-2.amazonaws.com/metadata/1347',
+    }, */
+  ]
+  beforeAll(async () => {
+    const wallet = await HDWallet.random()
+    const locator = new ModuleFactoryLocator()
+    locator.register(MemoryBoundWitnessDiviner.factory())
+    locator.register(GenericPayloadDiviner.factory())
+    locator.register(TemporalIndexingDivinerDivinerQueryToIndexQueryDiviner.factory())
+    locator.register(TemporalIndexingDivinerIndexCandidateToIndexDiviner.factory())
+    locator.register(TemporalIndexingDivinerIndexQueryResponseToDivinerQueryResponseDiviner.factory())
+    locator.register(TemporalIndexingDivinerStateToIndexCandidateDiviner.factory())
+    locator.register(TemporalIndexingDiviner.factory())
+    locator.register(TimestampWitness.factory())
+    locator.register(
+      new ModuleFactory(ApiCallWitness, {
+        config: { schema: ApiCallWitnessConfigSchema },
+        ipfsGateway: '5d7b6582.beta.decentralnetworkservices.com',
+      } as ApiCallWitnessParams),
+    )
+    const manifest = nftIdToNftMetadataUri as PackageManifestPayload
+    const manifestWrapper = new ManifestWrapper(manifest, wallet, locator)
+    node = await manifestWrapper.loadNodeFromIndex(0)
+    const mods = await node.resolve('*')
+    const publicModules = manifest.nodes[0].modules?.public ?? []
+    expect(mods.length).toBeGreaterThan(publicModules.length)
+  })
+  describe('Sentinel', () => {
+    it.each(cases)('returns metadata URI for token ID', async (apiCall) => {
+      const sentinel = asSentinelInstance(await node.resolve('NftMetadataSentinel'))
+      expect(sentinel).toBeDefined()
+      const report = await sentinel?.report([apiCall])
+      const results = report?.filter(isApiCallJsonResult) ?? []
+      expect(results.length).toBe(1)
+      expect(results[0].data).toBeObject()
+      const metadata = results[0].data as OpenSeaNftMetadata
+      expect(metadata.image).toBeString()
+      expect(metadata.attributes).toBeArray()
+    })
+  })
+  describe.skip('Index', () => {
+    beforeAll(async () => {
+      await delay(1000)
+    }, 60_000)
+    it.each(cases)('returns indexed NftIndex results', async (apiCall) => {
+      const { uri } = apiCall
+      const archivistModule = await node.resolvePrivate('IndexArchivist')
+      expect(archivistModule).toBeDefined()
+      const archivist = asArchivistInstance(archivistModule)
+      expect(archivist).toBeDefined()
+      expect(archivist?.all).toBeDefined()
+      const allPayload = (await archivist?.all?.()) ?? []
+      console.log('uri', uri)
+      console.log(JSON.stringify(allPayload, null, 2))
+      expect(allPayload).toBeArrayOfSize(1)
+      const diviner = asDivinerInstance(await node.resolve('IndexDiviner'))
+      expect(diviner).toBeDefined()
+      const query = {
+        limit: 1, schema: PayloadDivinerQuerySchema, uri,
+      }
+      const result = (await diviner?.divine([query])) as unknown as Payload<{ uri: string }>[]
+      expect(result).toBeDefined()
+      expect(result).toBeArrayOfSize(1)
+      expect(result?.[0]?.uri).toBe(uri)
+    }, 20_000)
+  })
+})

package/typedoc.json

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

package/xy.config.ts

@@ -1,10 +0,0 @@
-import type { XyTsupConfig } from '@xylabs/ts-scripts-yarn3'
-const config: XyTsupConfig = {
-  compile: {
-    browser: {},
-    node: {},
-    neutral: { src: true },
-  },
-}
-
-export default config