@xyo-network/evm-call-witness 2.84.1

package/package.json

@@ -0,0 +1,78 @@
+{
+  "name": "@xyo-network/evm-call-witness",
+  "author": {
+    "email": "support@xyo.network",
+    "name": "XYO Development Team",
+    "url": "https://xyo.network"
+  },
+  "bugs": {
+    "email": "support@xyo.network",
+    "url": "https://github.com/XYOracleNetwork/plugins/issues"
+  },
+  "dependencies": {
+    "@xylabs/assert": "^2.13.20",
+    "@xylabs/promise": "^2.13.20",
+    "@xyo-network/abstract-diviner": "^2.84.3",
+    "@xyo-network/diviner-model": "^2.84.3",
+    "@xyo-network/erc1822-witness": "~2.84.1",
+    "@xyo-network/erc1967-witness": "~2.84.1",
+    "@xyo-network/payload-model": "^2.84.3",
+    "@xyo-network/witness-blockchain-abstract": "^2.84.3",
+    "ethers": "^6.9.0"
+  },
+  "devDependencies": {
+    "@xylabs/jest-helpers": "^2.13.20",
+    "@xylabs/profile": "^2.13.20",
+    "@xylabs/ts-scripts-yarn3": "^3.2.19",
+    "@xylabs/tsconfig": "^3.2.19",
+    "@xyo-network/account": "^2.84.3",
+    "@xyo-network/manifest": "^2.84.3",
+    "@xyo-network/module-model": "^2.84.3",
+    "@xyo-network/open-zeppelin-typechain": "^3.0.5",
+    "@xyo-network/sentinel-model": "^2.84.3",
+    "@xyo-network/witness-model": "^2.84.3",
+    "jest": "^29.7.0",
+    "typescript": "^5.3.3"
+  },
+  "description": "Typescript/Javascript Plugins for XYO Platform",
+  "types": "dist/node/index.d.ts",
+  "exports": {
+    ".": {
+      "browser": {
+        "require": {
+          "types": "./dist/browser/index.d.cts",
+          "default": "./dist/browser/index.cjs"
+        },
+        "import": {
+          "types": "./dist/browser/index.d.mts",
+          "default": "./dist/browser/index.js"
+        }
+      },
+      "node": {
+        "require": {
+          "types": "./dist/node/index.d.cts",
+          "default": "./dist/node/index.cjs"
+        },
+        "import": {
+          "types": "./dist/node/index.d.mts",
+          "default": "./dist/node/index.js"
+        }
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "dist/node/index.cjs",
+  "module": "dist/node/index.js",
+  "homepage": "https://xyo.network",
+  "license": "LGPL-3.0-only",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/XYOracleNetwork/plugins.git"
+  },
+  "sideEffects": false,
+  "version": "2.84.1",
+  "type": "module"
+}

package/src/Diviner.ts

@@ -0,0 +1,102 @@
+import { assertEx } from '@xylabs/assert'
+import { Promisable } from '@xylabs/promise'
+import { AbstractDiviner } from '@xyo-network/abstract-diviner'
+import { DivinerConfig, DivinerParams } from '@xyo-network/diviner-model'
+import { isPayloadOfSchemaType, Payload } from '@xyo-network/payload-model'
+
+import { asEvmCallSuccess, EvmCallResult, EvmCallResultSchema } from './Payload'
+
+export type FindCallResult<TResult = string, TPayload = Payload> = [TResult, TPayload] | [undefined, TPayload] | [undefined, undefined]
+
+export const EvmCallDivinerConfigSchema = 'network.xyo.evm.call.diviner.config'
+export type EvmCallDivinerConfigSchema = typeof EvmCallDivinerConfigSchema
+
+export type EvmCallDivinerConfig = DivinerConfig<{
+  schema: EvmCallDivinerConfigSchema
+}>
+export type EvmCallDivinerParams = DivinerParams<EvmCallDivinerConfig>
+
+export const EvmCallResultsSchema = 'network.xyo.evm.call.results'
+export type EvmCallResultsSchema = typeof EvmCallResultsSchema
+
+export type EvmCallResults = Payload<
+  {
+    address: string
+    chainId: string
+    results?: Record<
+      string,
+      {
+        args?: unknown[]
+        result: unknown
+      }
+    >
+  },
+  EvmCallResultsSchema
+>
+
+export class EvmCallDiviner<TParams extends EvmCallDivinerParams = EvmCallDivinerParams> extends AbstractDiviner<TParams> {
+  static override configSchemas = [EvmCallDivinerConfigSchema]
+
+  protected static findCallResult<TResult = string>(address: string, functionName: string, payloads: EvmCallResult[]): TResult | undefined {
+    const foundPayload = payloads.find((payload) => payload.functionName === functionName && payload.address === address)
+    return asEvmCallSuccess(foundPayload)?.result as TResult | undefined
+  }
+
+  protected static matchingExistingField<R = string, T extends Payload = Payload>(objs: T[], field: keyof T): R | undefined {
+    const expectedValue = objs.at(0)?.[field] as R
+    const didNotMatch = objs.reduce((prev, obj) => {
+      return prev || obj[field] !== expectedValue
+    }, false)
+    return didNotMatch ? undefined : expectedValue
+  }
+
+  protected contractInfoRequiredFields(callResults: EvmCallResult[]): EvmCallResults {
+    return {
+      address: assertEx(EvmCallDiviner.matchingExistingField(callResults, 'address'), 'Mismatched address'),
+      chainId: assertEx(EvmCallDiviner.matchingExistingField(callResults, 'chainId'), 'Mismatched chainId'),
+      schema: EvmCallResultsSchema,
+    }
+  }
+
+  protected override async divineHandler(inPayloads: EvmCallResult[] = []): Promise<EvmCallResults[]> {
+    const callResults = inPayloads.filter(isPayloadOfSchemaType<EvmCallResult>(EvmCallResultSchema))
+    const addresses = Object.keys(
+      callResults.reduce<Record<string, boolean>>((prev, result) => {
+        if (result.address) {
+          prev[result.address] = true
+        }
+        return prev
+      }, {}),
+    )
+    const result = await Promise.all(
+      addresses.map(async (address) => {
+        const foundCallResults = callResults.filter((callResult) => callResult.address === address)
+        const results: EvmCallResults = {
+          ...{ results: await this.reduceResults(foundCallResults) },
+          ...this.contractInfoRequiredFields(foundCallResults),
+        }
+        return results
+      }),
+    )
+
+    return result
+  }
+
+  protected reduceResults(callResults: EvmCallResult[]): Promisable<EvmCallResults['results']> {
+    return callResults.reduce<
+      Record<
+        string,
+        {
+          args?: unknown[]
+          result: unknown
+        }
+      >
+    >((prev, callResult) => {
+      const typedCallResult = asEvmCallSuccess(callResult)
+      if (typedCallResult) {
+        prev[callResult.functionName] = { args: typedCallResult.args, result: typedCallResult?.result }
+      }
+      return prev
+    }, {})
+  }
+}

package/src/Payload.ts

@@ -0,0 +1,51 @@
+import { Payload } from '@xyo-network/payload-model'
+
+export const EvmCallSchema = 'network.xyo.blockchain.contract.call'
+export type EvmCallSchema = typeof EvmCallSchema
+
+export type EvmCall = Payload<
+  {
+    address?: string
+    args?: unknown[]
+    block?: number
+    functionName?: string
+  },
+  EvmCallSchema
+>
+
+export const EvmCallResultSchema = 'network.xyo.blockchain.contract.call.result'
+export type EvmCallResultSchema = typeof EvmCallResultSchema
+
+export type EvmCallResultBase = Payload<
+  {
+    address: string
+    args: unknown[]
+    block?: number
+    chainId: number
+    functionName: string
+    implementation?: string
+  },
+  EvmCallResultSchema
+>
+
+export type EvmCallSuccess = EvmCallResultBase & {
+  result: unknown
+}
+
+export type EvmCallFailure = EvmCallResultBase & {
+  error: string
+}
+
+export type EvmCallResult = EvmCallSuccess | EvmCallFailure
+
+export const isEvmCallSuccess = (payload?: EvmCallResult): payload is EvmCallSuccess => {
+  return (payload as EvmCallSuccess | undefined)?.result !== undefined
+}
+
+export const isEvmCallFailure = (payload?: EvmCallResult): payload is EvmCallFailure => {
+  return (payload as EvmCallFailure | undefined)?.error !== undefined
+}
+
+export const asEvmCallSuccess = (payload?: EvmCallResult) => (isEvmCallSuccess(payload) ? payload : undefined)
+
+export const asEvmCallFailure = (payload?: EvmCallResult) => (isEvmCallFailure(payload) ? payload : undefined)

package/src/Witness.ts

@@ -0,0 +1,106 @@
+import { assertEx } from '@xylabs/assert'
+import { getErc1822SlotStatus } from '@xyo-network/erc1822-witness'
+import { getErc1967SlotStatus } from '@xyo-network/erc1967-witness'
+import { isPayloadOfSchemaType } from '@xyo-network/payload-model'
+import { AbstractBlockchainWitness, BlockchainWitnessConfig, BlockchainWitnessParams } from '@xyo-network/witness-blockchain-abstract'
+import { Contract, JsonFragment } from 'ethers'
+
+import { EvmCall, EvmCallResult, EvmCallResultSchema, EvmCallSchema, EvmCallSuccess } from './Payload'
+
+export type Abi = string | ReadonlyArray<JsonFragment | string>
+
+export const EvmCallWitnessConfigSchema = 'network.xyo.evm.call.witness.config'
+export type EvmCallWitnessConfigSchema = typeof EvmCallWitnessConfigSchema
+
+export type EvmCallWitnessConfig = BlockchainWitnessConfig<
+  {
+    abi?: Abi
+    address?: string
+    args?: unknown[]
+    block?: number
+    functionName?: string
+  },
+  EvmCallWitnessConfigSchema
+>
+
+export type EvmCallWitnessParams = BlockchainWitnessParams<EvmCallWitnessConfig>
+
+const prefixHex = (value?: string) => {
+  if (value !== undefined) {
+    const lowerValue = value.toLowerCase()
+    return lowerValue.startsWith('0x') ? lowerValue : `0x${lowerValue}`
+  }
+}
+
+const isHexZero = (value?: string) => {
+  const prefixedValue = prefixHex(value)
+  return prefixedValue === undefined ? true : BigInt(prefixedValue) === 0n
+}
+
+export class EvmCallWitness<TParams extends EvmCallWitnessParams = EvmCallWitnessParams> extends AbstractBlockchainWitness<
+  TParams,
+  EvmCall,
+  EvmCallResult
+> {
+  static override configSchemas = [EvmCallWitnessConfigSchema]
+
+  get abi() {
+    return assertEx(this.config.abi, 'Missing abi')
+  }
+
+  protected override async observeHandler(inPayloads: EvmCall[] = []): Promise<EvmCallResult[]> {
+    await this.started('throw')
+    //calling it here to make sure we rests the cache
+    await this.getProviders()
+    try {
+      const observations = await Promise.all(
+        inPayloads.filter(isPayloadOfSchemaType(EvmCallSchema)).map(async ({ functionName, args, address, block: payloadBlock }) => {
+          const validatedAddress = assertEx(address ?? this.config.address, 'Missing address')
+          const validatedFunctionName = assertEx(functionName ?? this.config.functionName, 'Missing address')
+          const mergedArgs = [...(args ?? this.config.args ?? [])]
+
+          const provider = await this.getProvider(true, true)
+
+          const block = this.config.block ?? payloadBlock ?? (await provider.getBlockNumber())
+
+          //Check if ERC-1967 Upgradeable
+          const erc1967Status = await getErc1967SlotStatus(provider, validatedAddress, block)
+
+          //Check if ERC-1822 Upgradeable
+          const erc1822Status = await getErc1822SlotStatus(provider, validatedAddress, block)
+
+          const implementation = isHexZero(erc1967Status.slots.implementation) ? erc1822Status.implementation : erc1967Status.implementation
+
+          const contract = new Contract(implementation, this.abi, provider)
+          let transformedResult: unknown
+          try {
+            const result = await contract[validatedFunctionName](...mergedArgs)
+            transformedResult = typeof result === 'bigint' ? `0x${result.toString(16)}` : result
+          } catch (ex) {
+            //const error = ex as Error & { code: string }
+            //this.logger.error(`Error [${this.config.name}]: ${error.code} : ${error.message}`)
+          }
+          const observation: EvmCallSuccess = {
+            address: validatedAddress,
+            args: mergedArgs,
+            block,
+            chainId: Number((await provider.getNetwork()).chainId),
+            functionName: validatedFunctionName,
+            result: transformedResult,
+            schema: EvmCallResultSchema,
+          }
+          if (implementation !== validatedAddress) {
+            observation.implementation = implementation
+          }
+          console.log(`observation: ${JSON.stringify(observation, null, 2)}`)
+          return observation
+        }),
+      )
+      return observations
+    } catch (ex) {
+      const error = ex as Error
+      console.log(`Error [${this.config.name}]: ${error.message}`)
+      throw error
+    }
+  }
+}

package/src/index.ts

@@ -0,0 +1,3 @@
+export * from './Diviner'
+export * from './Payload'
+export * from './Witness'

package/src/spec/Erc721Sentinel.json

@@ -0,0 +1,134 @@
+{
+  "$schema": "https://raw.githubusercontent.com/XYOracleNetwork/sdk-xyo-client-js/main/packages/manifest/src/schema.json",
+  "nodes": [
+    {
+      "config": {
+        "name": "Erc721Info",
+        "schema": "network.xyo.node.config"
+      },
+      "modules": {
+        "public": [
+          {
+            "config": {
+              "functionName": "name",
+              "labels": {
+                "network.xyo.evm.interface": "Erc721"
+              },
+              "language": "javascript",
+              "name": "Erc721NameWitness",
+              "params": [],
+              "schema": "network.xyo.evm.call.witness.config"
+            }
+          },
+          {
+            "config": {
+              "functionName": "symbol",
+              "labels": {
+                "network.xyo.evm.interface": "Erc721"
+              },
+              "language": "javascript",
+              "name": "Erc721SymbolWitness",
+              "params": [],
+              "schema": "network.xyo.evm.call.witness.config"
+            }
+          },
+          {
+            "config": {
+              "functionName": "tokenURI",
+              "labels": {
+                "network.xyo.evm.interface": "Erc721"
+              },
+              "language": "javascript",
+              "name": "Erc721TokenURIWitness",
+              "schema": "network.xyo.evm.call.witness.config"
+            }
+          },
+          {
+            "config": {
+              "functionName": "ownerOf",
+              "labels": {
+                "network.xyo.evm.interface": "Erc721"
+              },
+              "language": "javascript",
+              "name": "Erc721OwnerOfWitness",
+              "schema": "network.xyo.evm.call.witness.config"
+            }
+          },
+          {
+            "config": {
+              "functionName": "totalSupply",
+              "labels": {
+                "network.xyo.evm.interface": "Erc721Enumerable"
+              },
+              "language": "javascript",
+              "name": "Erc721TotalSupplyWitness",
+              "params": [],
+              "schema": "network.xyo.evm.call.witness.config"
+            }
+          },
+          {
+            "config": {
+              "functionName": "tokenByIndex",
+              "labels": {
+                "network.xyo.evm.interface": "Erc721Enumerable"
+              },
+              "language": "javascript",
+              "name": "Erc721TokenByIndexWitness",
+              "schema": "network.xyo.evm.call.witness.config"
+            }
+          },
+          {
+            "config": {
+              "functionName": "uri",
+              "labels": {
+                "network.xyo.evm.interface": "Erc1155"
+              },
+              "language": "javascript",
+              "name": "Erc1155UriWitness",
+              "params": [],
+              "schema": "network.xyo.evm.call.witness.config"
+            }
+          },
+          {
+            "config": {
+              "language": "javascript",
+              "name": "ContractInfoDiviner",
+              "schema": "network.xyo.evm.call.diviner.config"
+            }
+          },
+          {
+            "config": {
+              "language": "javascript",
+              "name": "NftInfoSentinel",
+              "schema": "network.xyo.sentinel.config",
+              "synchronous": "true",
+              "tasks": [
+                {
+                  "input": true,
+                  "module": "Erc721NameWitness"
+                },
+                {
+                  "input": true,
+                  "module": "Erc721SymbolWitness"
+                },
+                {
+                  "input": true,
+                  "module": "Erc721TotalSupplyWitness"
+                },
+                {
+                  "input": [
+                    "Erc721NameWitness",
+                    "Erc721SymbolWitness",
+                    "Erc721TotalSupplyWitness"
+                  ],
+                  "module": "ContractInfoDiviner"
+                }
+              ]
+            }
+          }
+        ]
+      }
+    }
+  ],
+  "schema": "network.xyo.manifest"
+}

package/src/spec/Erc721TokenSentinel.json

@@ -0,0 +1,86 @@
+{
+  "$schema": "https://raw.githubusercontent.com/XYOracleNetwork/sdk-xyo-client-js/main/packages/manifest/src/schema.json",
+  "nodes": [
+    {
+      "config": {
+        "name": "Erc721TokenInfo",
+        "schema": "network.xyo.node.config"
+      },
+      "modules": {
+        "public": [
+          {
+            "config": {
+              "functionName": "tokenURI",
+              "labels": {
+                "network.xyo.evm.interface": "ERC721URIStorage"
+              },
+              "language": "javascript",
+              "name": "Erc721TokenURIWitness",
+              "schema": "network.xyo.evm.call.witness.config"
+            }
+          },
+          {
+            "config": {
+              "functionName": "ownerOf",
+              "labels": {
+                "network.xyo.evm.interface": "Erc721"
+              },
+              "language": "javascript",
+              "name": "Erc721OwnerOfWitness",
+              "schema": "network.xyo.evm.call.witness.config"
+            }
+          },
+          {
+            "config": {
+              "functionName": "uri",
+              "labels": {
+                "network.xyo.evm.interface": "Erc1155"
+              },
+              "language": "javascript",
+              "name": "Erc1155UriWitness",
+              "schema": "network.xyo.evm.call.witness.config"
+            }
+          },
+          {
+            "config": {
+              "language": "javascript",
+              "name": "TokenInfoDiviner",
+              "schema": "network.xyo.evm.call.diviner.config"
+            }
+          },
+          {
+            "config": {
+              "language": "javascript",
+              "name": "NftTokenInfoSentinel",
+              "schema": "network.xyo.sentinel.config",
+              "synchronous": "true",
+              "tasks": [
+                {
+                  "input": true,
+                  "module": "Erc721TokenURIWitness"
+                },
+                {
+                  "input": true,
+                  "module": "Erc721OwnerOfWitness"
+                },
+                {
+                  "input": true,
+                  "module": "Erc1155UriWitness"
+                },
+                {
+                  "input": [
+                    "Erc721TokenURIWitness",
+                    "Erc721OwnerOfWitness",
+                    "Erc1155UriWitness"
+                  ],
+                  "module": "TokenInfoDiviner"
+                }
+              ]
+            }
+          }
+        ]
+      }
+    }
+  ],
+  "schema": "network.xyo.manifest"
+}

package/typedoc.json

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

package/xy.config.ts

@@ -0,0 +1,14 @@
+import { XyTsupConfig } from '@xylabs/ts-scripts-yarn3'
+const config: XyTsupConfig = {
+  compile: {
+    browser: {
+      src: true,
+    },
+    node: {
+      src: true,
+    },
+  },
+}
+
+// eslint-disable-next-line import/no-default-export
+export default config