Utils updateForm

[jedtravis]

Hi guys, I'm looking through the exported functions in the utils.ts file and there are 2 functions I'm not too sure what they are for. They are updateFormV2 and updateFormV3. Is it possible for someone shed some light on the usage of these functions?

export const updateFormV2 = ({
  wallet,
  form,
  documentStoreAddress,
  tokenRegistryAddress,
  dnsVerifiable,
  dnsDid,
  dnsTransferableRecord,
}: UpdateForm) => {
  const { encryptedJson } = wallet as WalletEncryptedJson;
  const { address } = JSON.parse(encryptedJson);

  if (form.type === "VERIFIABLE_DOCUMENT") {
    const updatedIssuers = form.defaults.issuers.map((issuer: any) => {
      if (issuer.identityProof) {
        if (issuer.identityProof.type === "DNS-TXT") {
          issuer.documentStore = documentStoreAddress;
          issuer.identityProof.location = dnsVerifiable;
        } else if (issuer.identityProof.type === "DNS-DID" || issuer.identityProof.type === "DID") {
          issuer.id = `did:ethr:0x${address}`;
          issuer.identityProof.key = `did:ethr:0x${address}#controller`;

          if (issuer.identityProof.type === "DNS-DID") {
            issuer.identityProof.location = dnsDid;
          } else if (issuer.identityProof.type === "DID") {
            delete issuer.identityProof.location;
          }
        }
      }
      return issuer;
    });
    form.defaults.issuers = updatedIssuers;
  }

  if (form.type === "TRANSFERABLE_RECORD") {
    const updatedIssuers = form.defaults.issuers.map((issuer: any) => {
      issuer.tokenRegistry = tokenRegistryAddress;
      if (issuer.identityProof) {
        issuer.identityProof.location = dnsTransferableRecord;
      }
      return issuer;
    });
    form.defaults.issuers = updatedIssuers;
  }

  return form;
};

export const updateFormV3 = ({
  wallet,
  form,
  documentStoreAddress,
  tokenRegistryAddress,
  dnsVerifiable,
  dnsDid,
  dnsTransferableRecord,
}: UpdateForm) => {
  const { encryptedJson } = wallet as WalletEncryptedJson;
  const { address } = JSON.parse(encryptedJson);

  if (form.type === "VERIFIABLE_DOCUMENT") {
    if (form.defaults.openAttestationMetadata.proof.method === "DOCUMENT_STORE") {
      form.defaults.openAttestationMetadata.proof.value = documentStoreAddress;
    } else if (form.defaults.openAttestationMetadata.proof.method === "DID") {
      form.defaults.openAttestationMetadata.proof.value = `did:ethr:0x${address}`;
    }

    if (form.defaults.openAttestationMetadata.identityProof.type === "DNS-TXT") {
      form.defaults.openAttestationMetadata.identityProof.identifier = dnsVerifiable;
    } else if (form.defaults.openAttestationMetadata.identityProof.type === "DNS-DID") {
      form.defaults.openAttestationMetadata.identityProof.identifier = dnsDid;
    } else if (form.defaults.openAttestationMetadata.identityProof.type === "DID") {
      form.defaults.openAttestationMetadata.identityProof.identifier = `did:ethr:0x${address}`;
    }
  }

  if (form.type === "TRANSFERABLE_RECORD") {
    form.defaults.openAttestationMetadata.proof.value = tokenRegistryAddress;
    form.defaults.openAttestationMetadata.identityProof.identifier = dnsTransferableRecord;
  }

  return form;
};

[cavacado]

@isaackps care to explain abit?
From my own knowledge, these functions are only consumed in the open-attestation cli, and they are used as helper functions in the command for issuing a config file here.

For yourself, I doubt you would need to utilise these functions (unless you are handling a raw config file), and perhaps we will migrate these functions into the repo that requires them, after we've ascertained whether its safe to relocate them.