web3.db-fileconnector/server/plugins/ens/index.js

GraphQL System Built on web3 technologies. Web3.DB is an open database built on top of web3 technologies. It is a decentralized, open-source database that allows users to store and query data in a secure and efficient manner. The system is designed to be

import { ethers } from "ethers";
import logger from "../../logger/index.js";
import { getValueByPath } from "../../utils/helpers.js";

export default class ENSPlugin {
  /**
   * This will initialize all of the hooks used by this plugin.
   * A plugin can register multiple hooks, each hook being linked to a function that will be executed when the hook is triggered
   */
  async init() {
    this.provider = new ethers.JsonRpcProvider(this.rpc_url);

    return {
      HOOKS: {
        add_metadata: (stream) => this.add_metadata(stream),
      },
    };
  }

  async add_metadata(stream) {
    logger.debug("In add_metadata this.only_model:", this.only_model);
    logger.debug("In add_metadata this.model:", this.model_id);
    logger.debug("In add_metadata stream.model:", stream.model);

    if (
      this.only_model == "no" ||
      (this.only_model == "yes" && stream.model == this.model_id)
    ) {
      let field;

      /** Will convert the field to the actual value and make an exception for controller to use the address instead of the full did */
      if (this.field == "controller") {
        let { address } = getAddressFromDid(stream.controller);
        field = address;
      } else {
        field = getValueByPath(stream, this.field);
      }

      logger.debug("field:", field);
      if (field) {
        switch (this.action) {
          // Will converrt an ENS name to an address
          case "name_to_address":
            const address = await this.getAddress(field);
            logger.debug("address is: ", address);
            return {
              address: address,
            };

          // Will convert an address to an ENS name
          case "address_to_name":
            const ensName = await this.getName(field);
            logger.debug("ensName is: ", ensName);
            return {
              ensName: ensName,
            };
          default:
            return null;
        }
      } else {
        return {
          error: "Couldn't retrieve the correct field with " + this.field,
        };
      }
    } else {
      logger.debug("ENS Plugin shouldn't be used on this model.");
    }
  }

  /** Will convert an ens name into an address */
  async getName(address) {
    try {
      const ensName = await this.provider.lookupAddress(address);
      logger.debug("ensName is: ", ensName);
      return ensName;
    } catch (e) {
      logger.debug("Error retrieving ens name:", e);
      return null;
    }
  }

  /** Will convert an address into an ens name */
  async getAddress(ensName) {
    try {
      const address = await this.provider.resolveName(ensName);
      logger.debug("address is: ", address);
      return address;
    } catch (e) {
      logger.debug("Error retrieving address:", e);
      return null;
    }
  }
}

/** Returns a JSON object with the address and network based on the did */
function getAddressFromDid(did) {
  if (did) {
    let didParts = did.split(":");
    if (did.substring(0, 7) == "did:pkh") {
      /** Explode address to retrieve did */
      if (didParts.length >= 4) {
        let address = didParts[4];
        let network = didParts[2];
        let chain = didParts[2] + ":" + didParts[3];

        /** Return result */
        return {
          address: address,
          network: network,
          chain: chain,
        };
      } else {
        /** Return null object */
        return {
          address: null,
          network: null,
          chain: null,
        };
      }
    } else if (did.substring(0, 7) == "did:key") {
      /** Return did object */
      return {
        address: didParts[3],
        network: "key",
        chain: "key",
      };
    } else {
      /** Return null object */
      return {
        address: null,
        network: null,
        chain: null,
      };
    }
  } else {
    /** Return null object */
    return {
      address: null,
      network: null,
      chain: null,
    };
  }
}