@xyo-network/evm-token-interface-diviner 2.84.1

package/src/Diviner.ts

@@ -0,0 +1,113 @@
+import { assertEx } from '@xylabs/assert'
+import { AbstractDiviner } from '@xyo-network/abstract-diviner'
+import { DivinerConfig, DivinerParams } from '@xyo-network/diviner-model'
+import { EvmContract, isEvmContract } from '@xyo-network/evm-contract-witness'
+import { AnyConfigSchema } from '@xyo-network/module-model'
+import {
+  ERC20__factory,
+  ERC721__factory,
+  ERC1155__factory,
+  IERC721Enumerable__factory,
+  IERC721Metadata__factory,
+  IERC721Receiver__factory,
+  IERC1155MetadataURI__factory,
+  IERC1155Receiver__factory,
+} from '@xyo-network/open-zeppelin-typechain'
+import { Interface, JsonFragment } from 'ethers'
+
+import { EvmTokenInterfaceImplemented, EvmTokenInterfaceImplementedSchema, TokenInterface } from './Payload'
+
+export const EvmTokenInterfaceImplementedDivinerConfigSchema = `${EvmTokenInterfaceImplementedSchema}.diviner.config`
+export type EvmTokenInterfaceImplementedDivinerConfigSchema = typeof EvmTokenInterfaceImplementedDivinerConfigSchema
+
+export type EvmTokenInterfaceImplementedDivinerConfig = DivinerConfig<{
+  schema: EvmTokenInterfaceImplementedDivinerConfigSchema
+  tokenInterfaces?: TokenInterface[]
+}>
+
+export type EvmTokenInterfaceImplementedDivinerParams = DivinerParams<AnyConfigSchema<EvmTokenInterfaceImplementedDivinerConfig>>
+
+type DistributiveMappedType<T> = T extends string ? { [K in T]: readonly JsonFragment[] } : never
+type TokenInterfaceDictionary = DistributiveMappedType<TokenInterface>
+
+/**
+ * A diviner that checks if a contract implements a token interface
+ */
+export class EvmTokenInterfaceImplementedDiviner<
+  TParams extends EvmTokenInterfaceImplementedDivinerParams = EvmTokenInterfaceImplementedDivinerParams,
+> extends AbstractDiviner<TParams, EvmContract, EvmTokenInterfaceImplemented> {
+  /**
+   * The list of supported token interfaces
+   */
+  static readonly SupportedTokenInterfaces: Readonly<Record<TokenInterface, readonly JsonFragment[]>> = {
+    ERC1155: ERC1155__factory.abi,
+    ERC1155Metadata_URI: IERC1155MetadataURI__factory.abi,
+    ERC1155TokenReceiver: IERC1155Receiver__factory.abi,
+    ERC20: ERC20__factory.abi,
+    ERC721: ERC721__factory.abi,
+    ERC721Enumerable: IERC721Enumerable__factory.abi,
+    ERC721Metadata: IERC721Metadata__factory.abi,
+    ERC721TokenReceiver: IERC721Receiver__factory.abi,
+  }
+  static override configSchemas = [EvmTokenInterfaceImplementedDivinerConfigSchema]
+
+  private _tokenInterfaces?: TokenInterfaceDictionary
+
+  /**
+   * The list of token interfaces to check against the contract
+   */
+  get tokenInterfaces() {
+    if (!this._tokenInterfaces) {
+      if (this.config?.tokenInterfaces) {
+        this._tokenInterfaces =
+          (Object.fromEntries(
+            this.config?.tokenInterfaces.map((tokenInterface) => {
+              return [tokenInterface, EvmTokenInterfaceImplementedDiviner.SupportedTokenInterfaces[tokenInterface]] as const
+            }),
+          ) as TokenInterfaceDictionary) ?? {}
+      } else {
+        this._tokenInterfaces = EvmTokenInterfaceImplementedDiviner.SupportedTokenInterfaces
+      }
+    }
+    return this._tokenInterfaces
+  }
+
+  protected override async divineHandler(inPayloads: EvmContract[] = []): Promise<EvmTokenInterfaceImplemented[]> {
+    await this.started('throw')
+    try {
+      const allResults = await Promise.all(
+        // Iterate over each contract passed in
+        inPayloads.filter(isEvmContract).map(({ address, code, chainId }) => {
+          // Ensure we have the contract code
+          const byteCode = assertEx(code, 'Missing code')
+          const results: EvmTokenInterfaceImplemented[] = []
+          // Iterate over each token interface
+          Object.entries(this.tokenInterfaces).forEach(([tokenInterface, abi]) => {
+            // Check if the contract implements the interface abi
+            const contractInterface = new Interface(abi)
+            const implementations: boolean[] = []
+            contractInterface.forEachFunction(({ selector }) => {
+              implementations.push(byteCode.includes(BigInt(selector).toString(16)))
+            })
+            const implemented = implementations.every((implementation) => implementation)
+            const result: EvmTokenInterfaceImplemented = {
+              address,
+              chainId,
+              implemented,
+              schema: EvmTokenInterfaceImplementedSchema,
+              tokenInterface: tokenInterface as TokenInterface,
+            }
+            results.push(result)
+          })
+
+          return results
+        }),
+      )
+      return allResults.flat()
+    } catch (ex) {
+      const error = ex as Error
+      console.log(`Error [${this.config.name}]: ${error.message}`)
+      throw error
+    }
+  }
+}

package/src/Payload.ts

@@ -0,0 +1,60 @@
+import { isPayloadOfSchemaType, Payload } from '@xyo-network/payload-model'
+
+/**
+ * ERC20 Token Interfaces
+ */
+export type ERC20TokenInterfaces = 'ERC20'
+
+/**
+ * ERC721 Token Interfaces
+ */
+export type ERC721TokenInterfaces = 'ERC721' | 'ERC721TokenReceiver' | 'ERC721Metadata' | 'ERC721Enumerable'
+
+/**
+ * ERC1155 Token Interfaces
+ */
+export type ERC1155TokenInterfaces = 'ERC1155' | 'ERC1155TokenReceiver' | 'ERC1155Metadata_URI'
+
+/**
+ * All Token Interfaces
+ */
+export type TokenInterface = ERC20TokenInterfaces | ERC721TokenInterfaces | ERC1155TokenInterfaces
+
+/**
+ * The schema for the EVM Token Interface Implemented payload
+ */
+export const EvmTokenInterfaceImplementedSchema = 'network.xyo.evm.token.interface.implemented'
+/**
+ * The schema for the EVM Token Interface Implemented payload
+ */
+export type EvmTokenInterfaceImplementedSchema = typeof EvmTokenInterfaceImplementedSchema
+
+/**
+ * The EVM Token Interface Implemented payload
+ */
+export type EvmTokenInterfaceImplemented = Payload<
+  {
+    /**
+     * The contract address
+     */
+    address: string
+    /**
+     * The chain id
+     */
+    chainId: number
+    /**
+     * True if the contract implements the interface
+     */
+    implemented: boolean
+    /**
+     * The specific token interface
+     */
+    tokenInterface: TokenInterface
+  },
+  EvmTokenInterfaceImplementedSchema
+>
+
+/**
+ * Identity function for EvmTokenInterfaceImplemented payload
+ */
+export const isEvmTokenInterfaceImplemented = isPayloadOfSchemaType<EvmTokenInterfaceImplemented>(EvmTokenInterfaceImplementedSchema)

package/src/index.ts

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

package/src/spec/Contract.Witness.Index.json

@@ -0,0 +1,222 @@
+{
+  "$schema": "https://raw.githubusercontent.com/XYOracleNetwork/sdk-xyo-client-js/main/packages/manifest/src/schema.json",
+  "nodes": [
+    {
+      "config": {
+        "accountPath": "m/44'/60'/1",
+        "name": "ContractWitnessIndexNode",
+        "schema": "network.xyo.node.config"
+      },
+      "modules": {
+        "private": [
+          {
+            "config": {
+              "language": "javascript",
+              "name": "AddressStateArchivist",
+              "schema": "network.xyo.archivist.config",
+              "storeQueries": false
+            }
+          },
+          {
+            "config": {
+              "archivist": "AddressStateArchivist",
+              "language": "javascript",
+              "name": "AddressStateBoundWitnessDiviner",
+              "schema": "network.xyo.diviner.boundwitness.config"
+            }
+          },
+          {
+            "config": {
+              "archivist": "AddressStateArchivist",
+              "language": "javascript",
+              "name": "AddressStatePayloadDiviner",
+              "schema": "network.xyo.diviner.payload.config"
+            }
+          },
+          {
+            "config": {
+              "language": "javascript",
+              "name": "EvmContractDivinerIndexArchivist",
+              "schema": "network.xyo.archivist.config"
+            }
+          },
+          {
+            "config": {
+              "archivist": "EvmContractDivinerIndexArchivist",
+              "language": "javascript",
+              "name": "EvmContractDivinerIndexBoundWitnessDiviner",
+              "schema": "network.xyo.diviner.boundwitness.config"
+            }
+          },
+          {
+            "config": {
+              "archivist": "EvmContractDivinerIndexArchivist",
+              "language": "javascript",
+              "name": "EvmContractDivinerIndexPayloadDiviner",
+              "schema": "network.xyo.diviner.payload.config"
+            }
+          },
+          {
+            "config": {
+              "filter": {
+                "payload_schemas": ["network.xyo.evm.contract"]
+              },
+              "labels": {
+                "network.xyo.diviner.stage": "stateToIndexCandidateDiviner"
+              },
+              "language": "javascript",
+              "name": "EvmContractStateToIndexCandidateDiviner",
+              "payloadStore": {
+                "archivist": "Archivist",
+                "boundWitnessDiviner": "BoundWitnessDiviner",
+                "payloadDiviner": "PayloadDiviner"
+              },
+              "schema": "network.xyo.diviner.indexing.temporal.stage.stateToIndexCandidateDiviner.config"
+            }
+          },
+          {
+            "config": {
+              "labels": {
+                "network.xyo.diviner.stage": "indexCandidateToIndexDiviner"
+              },
+              "language": "javascript",
+              "name": "EvmContractIndexCandidateToEvmContractIndexDiviner",
+              "schema": "network.xyo.diviner.indexing.temporal.stage.indexCandidateToIndexDiviner.config",
+              "schemaTransforms": {
+                "network.xyo.evm.contract": [
+                  {
+                    "destinationField": "address",
+                    "sourcePathExpression": "$.address"
+                  },
+                  {
+                    "destinationField": "chainId",
+                    "sourcePathExpression": "$.chainId"
+                  }
+                ],
+                "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"
+              },
+              "language": "javascript",
+              "name": "EvmContractQueryToEvmContractIndexQueryDiviner",
+              "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"
+              },
+              "language": "javascript",
+              "name": "EvmContractIndexQueryResponseToEvmContractQueryResponseDiviner",
+              "schema": "network.xyo.diviner.indexing.temporal.stage.indexQueryResponseToDivinerQueryResponseDiviner.config"
+            }
+          },
+          {
+            "config": {
+              "language": "javascript",
+              "name": "EvmContractWitness",
+              "schema": "network.xyo.evm.contract.witness.config"
+            }
+          },
+          {
+            "config": {
+              "language": "javascript",
+              "name": "TimestampWitness",
+              "schema": "network.xyo.witness.timestamp.config"
+            }
+          }
+        ],
+        "public": [
+          {
+            "config": {
+              "indexStore": {
+                "archivist": "EvmContractDivinerIndexArchivist",
+                "boundWitnessDiviner": "EvmContractDivinerIndexBoundWitnessDiviner",
+                "payloadDiviner": "EvmContractDivinerIndexPayloadDiviner"
+              },
+              "indexingDivinerStages": {
+                "divinerQueryToIndexQueryDiviner": "EvmContractQueryToEvmContractIndexQueryDiviner",
+                "indexCandidateToIndexDiviner": "EvmContractIndexCandidateToEvmContractIndexDiviner",
+                "indexQueryResponseToDivinerQueryResponseDiviner": "EvmContractIndexQueryResponseToEvmContractQueryResponseDiviner",
+                "stateToIndexCandidateDiviner": "EvmContractStateToIndexCandidateDiviner"
+              },
+              "language": "javascript",
+              "name": "EvmContractIndexDiviner",
+              "pollFrequency": 1,
+              "schema": "network.xyo.diviner.indexing.temporal.config",
+              "stateStore": {
+                "archivist": "AddressStateArchivist",
+                "boundWitnessDiviner": "AddressStateBoundWitnessDiviner",
+                "payloadDiviner": "AddressStatePayloadDiviner"
+              }
+            }
+          },
+          {
+            "config": {
+              "archiving": {
+                "archivists": ["Archivist"]
+              },
+              "language": "javascript",
+              "name": "EvmContractSentinel",
+              "schema": "network.xyo.sentinel.config",
+              "synchronous": "true",
+              "tasks": [
+                {
+                  "input": true,
+                  "module": "TimestampWitness"
+                },
+                {
+                  "input": true,
+                  "module": "EvmContractWitness"
+                }
+              ]
+            }
+          }
+        ]
+      }
+    }
+  ],
+  "schema": "network.xyo.manifest"
+}

package/src/spec/Token.Diviner.Index.json

@@ -0,0 +1,272 @@
+{
+  "$schema": "https://raw.githubusercontent.com/XYOracleNetwork/sdk-xyo-client-js/main/packages/manifest/src/schema.json",
+  "nodes": [
+    {
+      "config": {
+        "accountPath": "m/44'/60'/2",
+        "name": "TokenDivinerIndexNode",
+        "schema": "network.xyo.node.config"
+      },
+      "modules": {
+        "private": [
+          {
+            "config": {
+              "language": "javascript",
+              "name": "AddressStateArchivist",
+              "schema": "network.xyo.archivist.config",
+              "storeQueries": false
+            }
+          },
+          {
+            "config": {
+              "archivist": "AddressStateArchivist",
+              "language": "javascript",
+              "name": "AddressStateBoundWitnessDiviner",
+              "schema": "network.xyo.diviner.boundwitness.config"
+            }
+          },
+          {
+            "config": {
+              "archivist": "AddressStateArchivist",
+              "language": "javascript",
+              "name": "AddressStatePayloadDiviner",
+              "schema": "network.xyo.diviner.payload.config"
+            }
+          },
+          {
+            "config": {
+              "language": "javascript",
+              "name": "EvmContractDivinerIndexArchivist",
+              "schema": "network.xyo.archivist.config"
+            }
+          },
+          {
+            "config": {
+              "archivist": "EvmContractDivinerIndexArchivist",
+              "language": "javascript",
+              "name": "EvmContractDivinerIndexBoundWitnessDiviner",
+              "schema": "network.xyo.diviner.boundwitness.config"
+            }
+          },
+          {
+            "config": {
+              "archivist": "EvmContractDivinerIndexArchivist",
+              "language": "javascript",
+              "name": "EvmContractDivinerIndexPayloadDiviner",
+              "schema": "network.xyo.diviner.payload.config"
+            }
+          },
+          {
+            "config": {
+              "filter": {
+                "payload_schemas": [
+                  "network.xyo.evm.token.interface.implemented"
+                ]
+              },
+              "labels": {
+                "network.xyo.diviner.stage": "stateToIndexCandidateDiviner"
+              },
+              "language": "javascript",
+              "name": "EvmContractStateToIndexCandidateDiviner",
+              "payloadStore": {
+                "archivist": "Archivist",
+                "boundWitnessDiviner": "BoundWitnessDiviner",
+                "payloadDiviner": "PayloadDiviner"
+              },
+              "schema": "network.xyo.diviner.indexing.temporal.stage.stateToIndexCandidateDiviner.config"
+            }
+          },
+          {
+            "config": {
+              "labels": {
+                "network.xyo.diviner.stage": "indexCandidateToIndexDiviner"
+              },
+              "language": "javascript",
+              "name": "EvmContractIndexCandidateToEvmContractIndexDiviner",
+              "schema": "network.xyo.diviner.indexing.temporal.stage.indexCandidateToIndexDiviner.config",
+              "schemaTransforms": {
+                "network.xyo.evm.token.interface.implemented": [
+                  {
+                    "destinationField": "address",
+                    "sourcePathExpression": "$.address"
+                  },
+                  {
+                    "destinationField": "chainId",
+                    "sourcePathExpression": "$.chainId"
+                  },
+                  {
+                    "destinationField": "tokenInterface",
+                    "sourcePathExpression": "$.tokenInterface"
+                  },
+                  {
+                    "destinationField": "implemented",
+                    "sourcePathExpression": "$.implemented"
+                  }
+                ],
+                "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"
+              },
+              "language": "javascript",
+              "name": "EvmContractQueryToEvmContractIndexQueryDiviner",
+              "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": "tokenInterface",
+                    "sourcePathExpression": "$.tokenInterface"
+                  },
+                  {
+                    "defaultValue": 1,
+                    "destinationField": "implemented",
+                    "sourcePathExpression": "$.implemented"
+                  },
+                  {
+                    "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"
+              },
+              "language": "javascript",
+              "name": "EvmContractIndexQueryResponseToEvmContractQueryResponseDiviner",
+              "schema": "network.xyo.diviner.indexing.temporal.stage.indexQueryResponseToDivinerQueryResponseDiviner.config"
+            }
+          },
+          {
+            "config": {
+              "language": "javascript",
+              "name": "TimestampWitness",
+              "schema": "network.xyo.witness.timestamp.config"
+            }
+          }
+        ],
+        "public": [
+          {
+            "config": {
+              "language": "javascript",
+              "name": "ERC721TokenInterfaceImplementedDiviner",
+              "schema": "network.xyo.evm.token.interface.implemented.diviner.config",
+              "tokenInterfaces": ["ERC721"]
+            }
+          },
+          {
+            "config": {
+              "language": "javascript",
+              "name": "ERC1155TokenInterfaceImplementedDiviner",
+              "schema": "network.xyo.evm.token.interface.implemented.diviner.config",
+              "tokenInterfaces": ["ERC1155"]
+            }
+          },
+          {
+            "config": {
+              "indexStore": {
+                "archivist": "EvmContractDivinerIndexArchivist",
+                "boundWitnessDiviner": "EvmContractDivinerIndexBoundWitnessDiviner",
+                "payloadDiviner": "EvmContractDivinerIndexPayloadDiviner"
+              },
+              "indexingDivinerStages": {
+                "divinerQueryToIndexQueryDiviner": "EvmContractQueryToEvmContractIndexQueryDiviner",
+                "indexCandidateToIndexDiviner": "EvmContractIndexCandidateToEvmContractIndexDiviner",
+                "indexQueryResponseToDivinerQueryResponseDiviner": "EvmContractIndexQueryResponseToEvmContractQueryResponseDiviner",
+                "stateToIndexCandidateDiviner": "EvmContractStateToIndexCandidateDiviner"
+              },
+              "language": "javascript",
+              "name": "EvmTokenInterfaceImplementedIndexDiviner",
+              "pollFrequency": 1,
+              "schema": "network.xyo.diviner.indexing.temporal.config",
+              "stateStore": {
+                "archivist": "AddressStateArchivist",
+                "boundWitnessDiviner": "AddressStateBoundWitnessDiviner",
+                "payloadDiviner": "AddressStatePayloadDiviner"
+              }
+            }
+          },
+          {
+            "config": {
+              "archiving": {
+                "archivists": ["Archivist"]
+              },
+              "language": "javascript",
+              "name": "ERC721TokenInterfaceImplementedSentinel",
+              "schema": "network.xyo.sentinel.config",
+              "synchronous": "true",
+              "tasks": [
+                {
+                  "input": true,
+                  "module": "TimestampWitness"
+                },
+                {
+                  "input": true,
+                  "module": "ERC721TokenInterfaceImplementedDiviner"
+                }
+              ]
+            }
+          },
+          {
+            "config": {
+              "archiving": {
+                "archivists": ["Archivist"]
+              },
+              "language": "javascript",
+              "name": "ERC1155TokenInterfaceImplementedSentinel",
+              "schema": "network.xyo.sentinel.config",
+              "synchronous": "true",
+              "tasks": [
+                {
+                  "input": true,
+                  "module": "TimestampWitness"
+                },
+                {
+                  "input": true,
+                  "module": "ERC1155TokenInterfaceImplementedDiviner"
+                }
+              ]
+            }
+          }
+        ]
+      }
+    }
+  ],
+  "schema": "network.xyo.manifest"
+}