@xyo-network/diviner-evm-call-result-to-token-uri 4.1.1 → 5.0.0

package/dist/neutral/index.d.ts

@@ -1,53 +1,6 @@
-import { DivinerConfig, DivinerParams } from '@xyo-network/diviner-model';
-import { AbstractDiviner } from '@xyo-network/diviner-abstract';
-import { NftMetadataUri } from '@xyo-network/evm-nft-id-payload-plugin';
-import { Payload, Schema } from '@xyo-network/payload-model';
-import { AnyConfigSchema } from '@xyo-network/module-model';
-import { EvmCallResults } from '@xyo-network/evm-call-witness';
-
-/**
- * The config schema for the EVM call result to NFT token URI diviner
- */
-declare const EvmCallResultToNftTokenUriDivinerConfigSchema = "network.xyo.evm.call.results.metadata.uri.diviner.config";
-/**
- * The config schema for the EVM call result to NFT token URI diviner
- */
-type EvmCallResultToNftTokenUriDivinerConfigSchema = typeof EvmCallResultToNftTokenUriDivinerConfigSchema;
-/**
- * The config for the EVM call result to NFT token URI diviner
- */
-type EvmCallResultToNftTokenUriDivinerConfig = DivinerConfig<{
-    schema: EvmCallResultToNftTokenUriDivinerConfigSchema;
-}>;
-
-/**
- * The params for the EVM call result to NFT token URI diviner
- */
-type EvmCallResultToNftTokenUriDivinerParams = DivinerParams<AnyConfigSchema<EvmCallResultToNftTokenUriDivinerConfig>>;
-
-declare class EvmCallResultToNftTokenUriDiviner<TParams extends EvmCallResultToNftTokenUriDivinerParams = EvmCallResultToNftTokenUriDivinerParams> extends AbstractDiviner<TParams, Payload, NftMetadataUri> {
-    static readonly configSchemas: Schema[];
-    static readonly defaultConfigSchema: Schema;
-    protected divineHandler(payloads?: Payload[]): NftMetadataUri[];
-}
-
-type EvmTokenUriCallResults = EvmCallResults & {
-    results: {
-        tokenURI: {
-            args: [string];
-            result?: string;
-        };
-    };
-};
-
-/**
- * The schema for the EVM call result to NFT token URI diviner.
- */
-declare const EvmCallResultToNftTokenUriDivinerSchema = "network.xyo.evm.call.results.metadata.uri.diviner";
-/**
- * The schema for the EVM call result to NFT token URI diviner.
- */
-type EvmCallResultToNftTokenUriDivinerSchema = typeof EvmCallResultToNftTokenUriDivinerSchema;
-
-export { EvmCallResultToNftTokenUriDiviner, EvmCallResultToNftTokenUriDivinerConfigSchema, EvmCallResultToNftTokenUriDivinerSchema };
-export type { EvmCallResultToNftTokenUriDivinerConfig, EvmCallResultToNftTokenUriDivinerParams, EvmTokenUriCallResults };
+export * from './Config.ts';
+export * from './Diviner.ts';
+export * from './Params.ts';
+export * from './Payload.ts';
+export * from './Schema.ts';
+//# sourceMappingURL=index.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/diviner-evm-call-result-to-token-uri",
-  "version": "4.1.1",
+  "version": "5.0.0",
   "description": "Typescript/Javascript Plugins for XYO Platform",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -28,20 +28,23 @@
   },
   "module": "dist/neutral/index.mjs",
   "types": "dist/neutral/index.d.ts",
+  "files": [
+    "dist",
+    "src"
+  ],
   "dependencies": {
-    "@xyo-network/diviner-abstract": "^4.1.7",
-    "@xyo-network/diviner-model": "^4.1.7",
-    "@xyo-network/evm-call-witness": "^4.1.1",
-    "@xyo-network/evm-nft-id-payload-plugin": "^4.1.1",
-    "@xyo-network/module-model": "^4.1.7",
-    "@xyo-network/payload-model": "^4.1.7"
+    "@xyo-network/diviner-abstract": "^5.0.0",
+    "@xyo-network/diviner-model": "^5.0.0",
+    "@xyo-network/evm-call-witness": "^5.0.0",
+    "@xyo-network/evm-nft-id-payload-plugin": "^5.0.0",
+    "@xyo-network/module-model": "^5.0.0",
+    "@xyo-network/payload-model": "^5.0.0"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.24",
-    "@xylabs/tsconfig": "^7.0.0-rc.24",
-    "@xylabs/vitest-extended": "^4.13.23",
-    "@xyo-network/evm-nft-id-payload-plugin": "^4.1.1",
-    "knip": "^5.62.0",
+    "@xylabs/ts-scripts-yarn3": "^7.0.2",
+    "@xylabs/tsconfig": "^7.0.2",
+    "@xylabs/vitest-extended": "^5.0.0",
+    "@xyo-network/evm-nft-id-payload-plugin": "^5.0.0",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4"
   },

package/src/spec/Diviner.spec.ts

@@ -0,0 +1,72 @@
+import '@xylabs/vitest-extended'
+
+import { isNftMetadataUri, NftMetadataUriSchema } from '@xyo-network/evm-nft-id-payload-plugin'
+import type { Payload } from '@xyo-network/payload-model'
+import {
+  beforeAll,
+  describe, expect, it,
+} from 'vitest'
+
+import { EvmCallResultToNftTokenUriDivinerConfigSchema } from '../Config.ts'
+import { EvmCallResultToNftTokenUriDiviner } from '../Diviner.ts'
+import type { EvmTokenUriCallResults } from '../Payload.ts'
+
+const validateResult = (evmCallResults: EvmTokenUriCallResults, actual: Payload[]) => {
+  const results = actual.filter(isNftMetadataUri)
+  expect(results.length).toBe(1)
+  const {
+    address,
+    chainId,
+    results: { tokenURI: { args: [tokenId] } },
+  } = evmCallResults
+  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('CryptoWalletNftDiviner', () => {
+  const cases = [
+    {
+      address: '0xBC4CA0EdA7647A8aB7C2061c2E118A18a936f13D',
+      chainId: 1,
+      results: { tokenURI: { args: ['0x0f'], result: 'ipfs://QmeSjSinHpPnmXmspMjwiXyN6zS4E9zccariGR3jxcaWtq/15' } },
+      schema: 'network.xyo.evm.call.results',
+    },
+    {
+      address: '0xEdB61f74B0d09B2558F1eeb79B247c1F363Ae452',
+      chainId: 1,
+      results: { tokenURI: { args: ['0x543'], result: 'https://gutter-cats-metadata.s3.us-east-2.amazonaws.com/metadata/1347' } },
+      schema: 'network.xyo.evm.call.results',
+    },
+  ] as EvmTokenUriCallResults[]
+  let diviner: EvmCallResultToNftTokenUriDiviner
+  beforeAll(async () => {
+    diviner = await EvmCallResultToNftTokenUriDiviner.create({
+      account: 'random',
+      config: { schema: EvmCallResultToNftTokenUriDivinerConfigSchema },
+    })
+  })
+  describe('divine', () => {
+    it.each(cases)('transforms the input to the result', async (evmCallResult) => {
+      const result = await diviner.divine([evmCallResult])
+      validateResult(evmCallResult, result)
+    })
+
+    it('replaced values in templatized results', async () => {
+      const evmCallResult = {
+        address: '0xEdB61f74B0d09B2558F1eeb79B247c1F363Ae452',
+        chainId: 1,
+        results: { tokenURI: { args: ['0x543'], result: 'https://gutter-cats-metadata.s3.us-east-2.amazonaws.com/metadata/{id}' } },
+        schema: 'network.xyo.evm.call.results',
+      } as EvmTokenUriCallResults
+      const result = await diviner.divine([evmCallResult])
+      validateResult(evmCallResult, result)
+    })
+  })
+})

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