Documentation

XYOracleNetwork · Dec 14, 2023 · 2d8617d · 2d8617d
1 parent ed066c3
commit 2d8617d
Showing 1 changed file with 12 additions and 4 deletions.
diff --git a/packages/payloadset/packages/evm/packages/token-interface/packages/diviner/src/Diviner.ts b/packages/payloadset/packages/evm/packages/token-interface/packages/diviner/src/Diviner.ts
@@ -27,6 +27,9 @@ export type EvmTokenInterfaceDivinerParams = DivinerParams<AnyConfigSchema<EvmTo
 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 EvmTokenInterfaceDiviner<TParams extends EvmTokenInterfaceDivinerParams = EvmTokenInterfaceDivinerParams> extends AbstractDiviner<
   TParams,
   EvmContract,
@@ -49,6 +52,9 @@ export class EvmTokenInterfaceDiviner<TParams extends EvmTokenInterfaceDivinerPa
 
   private _tokenInterfaces?: TokenInterfaceDictionary
 
+  /**
+   * The list of token interfaces to check against the contract
+   */
   get tokenInterfaces() {
     if (!this._tokenInterfaces) {
       if (this.config?.tokenInterfaces) {
@@ -68,13 +74,15 @@ export class EvmTokenInterfaceDiviner<TParams extends EvmTokenInterfaceDivinerPa
   protected override async divineHandler(inPayloads: EvmContract[] = []): Promise<EvmTokenInterfaceImplemented[]> {
     await this.started('throw')
     try {
-      const observations = await Promise.all(
+      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)
             contractInterface.forEachFunction(({ selector }) => {
               const result: EvmTokenInterfaceImplemented = {
@@ -91,7 +99,7 @@ export class EvmTokenInterfaceDiviner<TParams extends EvmTokenInterfaceDivinerPa
           return results
         }),
       )
-      return observations.flat()
+      return allResults.flat()
     } catch (ex) {
       const error = ex as Error
       console.log(`Error [${this.config.name}]: ${error.message}`)