@xyo-network/crypto-contract-function-read-plugin 2.85.0 → 2.85.1

package/package.json

@@ -10,41 +10,41 @@
     "url": "https://github.com/XYOracleNetwork/plugins/issues"
   },
   "dependencies": {
-    "@xylabs/assert": "^2.13.20",
-    "@xylabs/promise": "^2.13.20",
-    "@xyo-network/abstract-diviner": "^2.85.0",
-    "@xyo-network/abstract-witness": "^2.85.0",
-    "@xyo-network/crypto-contract-function-read-payload-plugin": "~2.85.0",
-    "@xyo-network/crypto-nft-payload-plugin": "~2.85.0",
-    "@xyo-network/module-model": "^2.85.0",
-    "@xyo-network/payload-model": "^2.85.0",
-    "@xyo-network/payloadset-plugin": "^2.85.0",
-    "@xyo-network/witness-model": "^2.85.0",
+    "@xylabs/assert": "^2.13.22",
+    "@xylabs/promise": "^2.13.22",
+    "@xyo-network/abstract-diviner": "^2.85.3",
+    "@xyo-network/abstract-witness": "^2.85.3",
+    "@xyo-network/crypto-contract-function-read-payload-plugin": "~2.85.1",
+    "@xyo-network/crypto-nft-payload-plugin": "~2.85.1",
+    "@xyo-network/module-model": "^2.85.3",
+    "@xyo-network/payload-model": "^2.85.3",
+    "@xyo-network/payloadset-plugin": "^2.85.3",
+    "@xyo-network/witness-model": "^2.85.3",
     "ethers": "^6.9.1"
   },
   "devDependencies": {
-    "@xylabs/delay": "^2.13.20",
-    "@xylabs/hex": "^2.13.20",
-    "@xylabs/jest-helpers": "^2.13.20",
+    "@xylabs/delay": "^2.13.22",
+    "@xylabs/hex": "^2.13.22",
+    "@xylabs/jest-helpers": "^2.13.22",
     "@xylabs/ts-scripts-yarn3": "^3.2.25",
     "@xylabs/tsconfig": "^3.2.25",
-    "@xyo-network/account": "^2.85.0",
-    "@xyo-network/diviner-boundwitness-memory": "^2.85.0",
-    "@xyo-network/diviner-jsonpatch": "^2.85.0",
-    "@xyo-network/diviner-jsonpath-aggregate-memory": "^2.85.0",
-    "@xyo-network/diviner-model": "^2.85.0",
-    "@xyo-network/diviner-payload-memory": "^2.85.0",
-    "@xyo-network/diviner-payload-model": "^2.85.0",
-    "@xyo-network/diviner-range": "^2.85.0",
-    "@xyo-network/diviner-temporal-indexing": "^2.85.0",
-    "@xyo-network/evm-nft-id-payload-plugin": "~2.85.0",
-    "@xyo-network/manifest": "^2.85.0",
-    "@xyo-network/memory-archivist": "^2.85.0",
-    "@xyo-network/node-memory": "^2.85.0",
+    "@xyo-network/account": "^2.85.3",
+    "@xyo-network/diviner-boundwitness-memory": "^2.85.3",
+    "@xyo-network/diviner-jsonpatch": "^2.85.3",
+    "@xyo-network/diviner-jsonpath-aggregate-memory": "^2.85.3",
+    "@xyo-network/diviner-model": "^2.85.3",
+    "@xyo-network/diviner-payload-memory": "^2.85.3",
+    "@xyo-network/diviner-payload-model": "^2.85.3",
+    "@xyo-network/diviner-range": "^2.85.3",
+    "@xyo-network/diviner-temporal-indexing": "^2.85.3",
+    "@xyo-network/evm-nft-id-payload-plugin": "~2.85.1",
+    "@xyo-network/manifest": "^2.85.3",
+    "@xyo-network/memory-archivist": "^2.85.3",
+    "@xyo-network/node-memory": "^2.85.3",
     "@xyo-network/open-zeppelin-typechain": "^3.0.5",
-    "@xyo-network/sentinel-model": "^2.85.0",
-    "@xyo-network/witness-blockchain-abstract": "^2.85.0",
-    "@xyo-network/witness-timestamp": "^2.85.0",
+    "@xyo-network/sentinel-model": "^2.85.3",
+    "@xyo-network/witness-blockchain-abstract": "^2.85.3",
+    "@xyo-network/witness-timestamp": "^2.85.3",
     "async-mutex": "^0.4.0",
     "jest": "^29.7.0",
     "typescript": "^5.3.3"
@@ -88,6 +88,6 @@
     "url": "https://github.com/XYOracleNetwork/plugins.git"
   },
   "sideEffects": false,
-  "version": "2.85.0",
+  "version": "2.85.1",
   "type": "module"
 }

package/src/Diviner/Diviner.ts

@@ -13,8 +13,10 @@ import {
 } from '@xyo-network/crypto-contract-function-read-payload-plugin'
 import { isPayloadOfSchemaType, Payload } from '@xyo-network/payload-model'
 
+/** @deprecated use EvmCallDiviner instead */
 export type FindCallResult<TResult = string, TPayload = Payload> = [TResult, TPayload] | [undefined, TPayload] | [undefined, undefined]
 
+/** @deprecated use EvmCallDiviner instead */
 export class CryptoContractDiviner<TParams extends CryptoContractDivinerParams = CryptoContractDivinerParams> extends AbstractDiviner<TParams> {
   static override configSchemas = [CryptoContractDivinerConfigSchema]
   static labels: CryptoContractDivinerLabels = CryptoContractDivinerLabels
@@ -30,6 +32,7 @@ export class CryptoContractDiviner<TParams extends CryptoContractDivinerParams =
 
   protected static matchingExistingField<R = string, T extends Payload = Payload>(objs: T[], field: keyof T): R | undefined {
     const expectedValue = objs.at(0)?.[field] as R
+    // eslint-disable-next-line unicorn/no-array-reduce
     const didNotMatch = objs.reduce((prev, obj) => {
       return prev || obj[field] !== expectedValue
     }, false)
@@ -47,6 +50,7 @@ export class CryptoContractDiviner<TParams extends CryptoContractDivinerParams =
   protected override async divineHandler(inPayloads: CryptoContractFunctionCallResult[] = []): Promise<ContractInfo[]> {
     const callResults = inPayloads.filter(isPayloadOfSchemaType<CryptoContractFunctionCallResult>(CryptoContractFunctionCallResultSchema))
     const addresses = Object.keys(
+      // eslint-disable-next-line unicorn/no-array-reduce
       callResults.reduce<Record<string, boolean>>((prev, result) => {
         if (result.address) {
           prev[result.address] = true
@@ -58,7 +62,7 @@ export class CryptoContractDiviner<TParams extends CryptoContractDivinerParams =
       addresses.map(async (address) => {
         const foundCallResults = callResults.filter((callResult) => callResult.address === address)
         const info: ContractInfo = {
-          ...{ results: await this.reduceResults(foundCallResults) },
+          results: await this.reduceResults(foundCallResults),
           ...this.contractInfoRequiredFields(foundCallResults),
         }
         return info
@@ -69,6 +73,7 @@ export class CryptoContractDiviner<TParams extends CryptoContractDivinerParams =
   }
 
   protected reduceResults(callResults: CryptoContractFunctionCallResult[]): Promisable<ContractInfo['results']> {
+    // eslint-disable-next-line unicorn/no-array-reduce
     return callResults.reduce<Record<string, unknown>>((prev, callResult) => {
       prev[callResult.functionName] = asCryptoContractFunctionCallSuccess(callResult)?.result
       return prev

package/src/Plugin.ts

@@ -1,9 +1,11 @@
+/* eslint-disable import/no-deprecated */
 import { NftSchema } from '@xyo-network/crypto-nft-payload-plugin'
 import { PayloadSetSchema } from '@xyo-network/payload-model'
 import { createPayloadSetWitnessPlugin } from '@xyo-network/payloadset-plugin'
 
 import { CryptoContractFunctionReadWitness } from './Witness'
 
+/** @deprecated use EvmCallWitness instead */
 export const CryptoContractFunctionReadWitnessPlugin = () =>
   createPayloadSetWitnessPlugin<CryptoContractFunctionReadWitness>(
     { required: { [NftSchema]: 1 }, schema: PayloadSetSchema },

package/src/Witness.ts

@@ -15,6 +15,7 @@ import { isPayloadOfSchemaType } from '@xyo-network/payload-model'
 import { WitnessParams } from '@xyo-network/witness-model'
 import { Contract, Provider } from 'ethers'
 
+/** @deprecated use EvmCallWitness instead */
 export type CryptoContractFunctionReadWitnessParams = WitnessParams<
   AnyConfigSchema<CryptoContractFunctionReadWitnessConfig>,
   {
@@ -22,6 +23,7 @@ export type CryptoContractFunctionReadWitnessParams = WitnessParams<
   }
 >
 
+/** @deprecated use EvmCallWitness instead */
 export class CryptoContractFunctionReadWitness<
   TParams extends CryptoContractFunctionReadWitnessParams = CryptoContractFunctionReadWitnessParams,
 > extends AbstractWitness<TParams, CryptoContractFunctionCall, CryptoContractFunctionCallResult> {

package/src/index.ts

@@ -1,9 +1,3 @@
-import { CryptoContractFunctionReadWitnessPlugin } from './Plugin'
-
 export * from './Diviner'
+export { CryptoContractFunctionReadWitnessPlugin, CryptoContractFunctionReadWitnessPlugin as default } from './Plugin'
 export * from './Witness'
-
-export { CryptoContractFunctionReadWitnessPlugin }
-
-// eslint-disable-next-line import/no-default-export
-export default CryptoContractFunctionReadWitnessPlugin

package/src/spec/NftIndexToNftIdIndex/Erc721.NftId.Index.json

@@ -0,0 +1,314 @@
+{
+  "$schema": "https://raw.githubusercontent.com/XYOracleNetwork/sdk-xyo-client-js/main/packages/manifest/src/schema.json",
+  "nodes": [
+    {
+      "config": {
+        "name": "Info",
+        "schema": "network.xyo.node.config"
+      },
+      "modules": {
+        "private": [
+          {
+            "config": {
+              "name": "AddressStateArchivist",
+              "schema": "network.xyo.archivist.config",
+              "storeQueries": false
+            }
+          },
+          {
+            "config": {
+              "archivist": "AddressStateArchivist",
+              "name": "AddressStateBoundWitnessDiviner",
+              "schema": "network.xyo.diviner.boundwitness.config"
+            }
+          },
+          {
+            "config": {
+              "archivist": "AddressStateArchivist",
+              "name": "AddressStatePayloadDiviner",
+              "schema": "network.xyo.diviner.payload.config"
+            }
+          },
+          {
+            "config": {
+              "name": "IndexArchivist",
+              "schema": "network.xyo.archivist.config"
+            }
+          },
+          {
+            "config": {
+              "archivist": "IndexArchivist",
+              "name": "IndexBoundWitnessDiviner",
+              "schema": "network.xyo.diviner.boundwitness.config"
+            }
+          },
+          {
+            "config": {
+              "archivist": "IndexArchivist",
+              "name": "IndexPayloadDiviner",
+              "schema": "network.xyo.diviner.payload.config"
+            }
+          },
+          {
+            "config": {
+              "filter": {
+                "payload_schemas": ["network.xyo.evm.nft.index"]
+              },
+              "labels": {
+                "network.xyo.diviner.stage": "stateToIndexCandidateDiviner"
+              },
+              "name": "StateToIndexCandidateDiviner",
+              "payloadStore": {
+                "archivist": "Archivist",
+                "boundWitnessDiviner": "BoundWitnessDiviner",
+                "payloadDiviner": "PayloadDiviner"
+              },
+              "schema": "network.xyo.diviner.indexing.temporal.stage.stateToIndexCandidateDiviner.config"
+            }
+          },
+          {
+            "config": {
+              "labels": {
+                "network.xyo.diviner.stage": "indexCandidateToIndexDiviner"
+              },
+              "name": "IndexCandidateToIndexDiviner",
+              "schema": "network.xyo.diviner.indexing.temporal.stage.indexCandidateToIndexDiviner.config",
+              "schemaTransforms": {
+                "network.xyo.evm.nft.index": [
+                  {
+                    "destinationField": "address",
+                    "sourcePathExpression": "$.address"
+                  },
+                  {
+                    "destinationField": "chainId",
+                    "sourcePathExpression": "$.chainId"
+                  },
+                  {
+                    "destinationField": "index",
+                    "sourcePathExpression": "$.index"
+                  }
+                ],
+                "network.xyo.timestamp": [
+                  {
+                    "destinationField": "timestamp",
+                    "sourcePathExpression": "$.timestamp"
+                  }
+                ]
+              }
+            }
+          },
+          {
+            "config": {
+              "divinerQuerySchema": "network.xyo.diviner.payload.query",
+              "indexQuerySchema": "network.xyo.diviner.payload.query",
+              "indexSchema": "network.xyo.diviner.indexing.temporal.result.index",
+              "labels": {
+                "network.xyo.diviner.stage": "divinerQueryToIndexQueryDiviner"
+              },
+              "name": "QueryToIndexQueryDiviner",
+              "schema": "network.xyo.diviner.indexing.temporal.stage.divinerQueryToIndexQueryDiviner.config",
+              "schemaTransforms": {
+                "network.xyo.diviner.payload.query": [
+                  {
+                    "destinationField": "address",
+                    "sourcePathExpression": "$.address"
+                  },
+                  {
+                    "defaultValue": 1,
+                    "destinationField": "chainId",
+                    "sourcePathExpression": "$.chainId"
+                  },
+                  {
+                    "defaultValue": 1,
+                    "destinationField": "limit",
+                    "sourcePathExpression": "$.limit"
+                  },
+                  {
+                    "defaultValue": 0,
+                    "destinationField": "offset",
+                    "sourcePathExpression": "$.offset"
+                  },
+                  {
+                    "defaultValue": "desc",
+                    "destinationField": "order",
+                    "sourcePathExpression": "$.order"
+                  }
+                ]
+              }
+            }
+          },
+          {
+            "config": {
+              "labels": {
+                "network.xyo.diviner.stage": "indexQueryResponseToDivinerQueryResponseDiviner"
+              },
+              "name": "IndexQueryResponseToQueryResponseDiviner",
+              "schema": "network.xyo.diviner.indexing.temporal.stage.indexQueryResponseToDivinerQueryResponseDiviner.config"
+            }
+          },
+          {
+            "config": {
+              "name": "TimestampWitness",
+              "schema": "network.xyo.witness.timestamp.config"
+            }
+          },
+          {
+            "config": {
+              "name": "RangeDiviner",
+              "schema": "network.xyo.diviner.range.config"
+            }
+          },
+          {
+            "config": {
+              "name": "InputBufferingDiviner",
+              "operations": [
+                {
+                  "op": "test",
+                  "path": "/schema",
+                  "value": "network.xyo.crypto.contract.function.call"
+                },
+                {
+                  "op": "test",
+                  "path": "/functionName",
+                  "value": "tokenByIndex"
+                },
+                { "op": "defined", "path": "/address" }
+              ],
+              "schema": "network.xyo.diviner.jsonpatch.config"
+            }
+          },
+          {
+            "config": {
+              "destinationSchema": "network.xyo.evm.nft.id",
+              "name": "NftIdPartialToNftIdTransformDiviner",
+              "schemaTransforms": {
+                "network.xyo.crypto.contract.function.call.result": [
+                  {
+                    "destinationField": "address",
+                    "sourcePathExpression": "$.address"
+                  },
+                  {
+                    "destinationField": "chainId",
+                    "sourcePathExpression": "$.chainId"
+                  },
+                  {
+                    "destinationField": "tokenId",
+                    "sourcePathExpression": "$.result"
+                  }
+                ]
+              },
+              "schema": "network.xyo.diviner.jsonpath.aggregate.config"
+            }
+          },
+          {
+            "config": {
+              "name": "InputBufferingSentinel",
+              "schema": "network.xyo.sentinel.config",
+              "synchronous": "true",
+              "tasks": [
+                {
+                  "input": true,
+                  "module": "InputBufferingDiviner"
+                }
+              ]
+            }
+          },
+          {
+            "config": {
+              "functionName": "tokenByIndex",
+              "labels": {
+                "network.xyo.crypto.contract.interface": "Erc721Enumerable"
+              },
+              "language": "javascript",
+              "name": "Erc721TokenByIndexWitness",
+              "schema": "network.xyo.crypto.contract.function.read.config"
+            }
+          },
+          {
+            "config": {
+              "archiving": {
+                "archivists": ["Archivist"]
+              },
+              "name": "TokenIndexToTokenIdSentinel",
+              "schema": "network.xyo.sentinel.config",
+              "synchronous": "true",
+              "tasks": [
+                {
+                  "input": true,
+                  "module": "Erc721TokenByIndexWitness"
+                }
+              ]
+            }
+          }
+        ],
+        "public": [
+          {
+            "config": {
+              "name": "Archivist",
+              "schema": "network.xyo.archivist.config",
+              "storeQueries": false
+            }
+          },
+          {
+            "config": {
+              "archivist": "Archivist",
+              "name": "BoundWitnessDiviner",
+              "schema": "network.xyo.diviner.boundwitness.config"
+            }
+          },
+          {
+            "config": {
+              "archivist": "Archivist",
+              "name": "PayloadDiviner",
+              "schema": "network.xyo.diviner.payload.config"
+            }
+          },
+          {
+            "config": {
+              "indexStore": {
+                "archivist": "IndexArchivist",
+                "boundWitnessDiviner": "IndexBoundWitnessDiviner",
+                "payloadDiviner": "IndexPayloadDiviner"
+              },
+              "indexingDivinerStages": {
+                "divinerQueryToIndexQueryDiviner": "QueryToIndexQueryDiviner",
+                "indexCandidateToIndexDiviner": "IndexCandidateToIndexDiviner",
+                "indexQueryResponseToDivinerQueryResponseDiviner": "IndexQueryResponseToQueryResponseDiviner",
+                "stateToIndexCandidateDiviner": "StateToIndexCandidateDiviner"
+              },
+              "name": "IndexDiviner",
+              "pollFrequency": 1,
+              "schema": "network.xyo.diviner.indexing.temporal.config",
+              "stateStore": {
+                "archivist": "AddressStateArchivist",
+                "boundWitnessDiviner": "AddressStateBoundWitnessDiviner",
+                "payloadDiviner": "AddressStatePayloadDiviner"
+              }
+            }
+          },
+          {
+            "config": {
+              "archiving": {
+                "archivists": ["Archivist"]
+              },
+              "name": "Sentinel",
+              "schema": "network.xyo.sentinel.config",
+              "synchronous": "true",
+              "tasks": [
+                {
+                  "input": true,
+                  "module": "Erc721TokenByIndexWitness"
+                },
+                {
+                  "input": ["Erc721TokenByIndexWitness"],
+                  "module": "NftIdPartialToNftIdTransformDiviner"
+                }
+              ]
+            }
+          }
+        ]
+      }
+    }
+  ],
+  "schema": "network.xyo.manifest"
+}