CERTHUB Documentation

registerInstitution

Registers a new institution, restricted to factory agents.

function registerInstitution(
  address institutionWalletAddress,
  string calldata institutionName
) public onlyFactoryAgent {
  // Stores in verified_institutions mapping
}

Inputs: Institution wallet address (e.g., `0x123...`), institution name (e.g., `Harvard`).
Output: Emits `InstitutionRegistered` event.

issueCertificate

Issues a new certificate, restricted to verified institutions or admins.

function issueCertificate(
  address institutionWalletAddress,
  string calldata institutionName,
  string calldata certificateName,
  string calldata certificateId,
  string calldata uri,
  uint256 certificateYear,
  bytes32 merkleRoot,
  uint256 certificateTokenQuantity
) public onlyVerifiedInstitutionOrAdmin(institutionName, institutionWalletAddress) {
  // Deploys certificate contract, stores in institution_certificates
}

Inputs: Institution wallet address, institution name, certificate name (e.g., `Bachelor of Science`), certificate ID (e.g., `CERT123`), URI (e.g., `ipfs://Qm...`), year (e.g., `2023`), Merkle root (32-byte hex), token quantity (e.g., `100`).
Output: Emits `CertificateIssued` event.

updateCertificate

Updates an existing certificate’s details, restricted to verified institutions or admins.

function updateCertificate(
  address institutionWalletAddress,
  string calldata institutionName,
  string calldata previousCertificateName,
  string calldata certificateName,
  string calldata certificateId,
  string calldata uri,
  uint256 previousCertificateYear,
  uint256 newCertificateYear,
  bytes32 merkleRoot,
  uint256 certificateTokenUpdateQuantity
) public onlyVerifiedInstitutionOrAdmin(institutionName, institutionWalletAddress) {
  // Updates certificate details via institution_certificates mapping
}

Inputs: Institution wallet address, institution name, previous certificate name, new certificate name, certificate ID, URI, previous year, new year, Merkle root, token quantity.
Output: Emits `CertificateUpdated` event.

verifyCertificate

Verifies a recipient’s certificate claim, public function.

function verifyCertificate(
  address recipientAddress,
  string calldata certificateName,
  uint256 certificateYear,
  address institutionWalletAddress
) public view returns (Recipient memory details) {
  // Returns Recipient struct with claim details
}

Inputs: Recipient address, certificate name, certificate year, institution wallet address.
Output: `Recipient` struct (`RecipientName`, `CertificateName`, `CertificateYear`, `CertificateId`, `RecipientId`, `InstitutionName`, `Claimed`).

claimCertificate (Assumed)

Allows recipients to claim a certificate using a Merkle proof.

function claimCertificate(
  address recipientAddress,
  string calldata certificateId,
  string calldata institutionName,
  bytes32[] calldata merkleProof
) public {
  // Verifies Merkle proof and marks claim in certificate contract
}

Inputs: Recipient address, certificate ID, institution name, Merkle proof (array of 32-byte hex strings).
Output: Emits `CertificateClaimed` event.

expandCertificateDetails (Assumed)

Retrieves detailed certificate information, public function.

function expandCertificateDetails(
  address institutionWalletAddress,
  string calldata certificateName,
  uint256 certificateYear
) public view returns (string memory certificateId, string memory uri, bytes32 merkleRoot, uint256 tokenQuantity) {
  // Returns certificate metadata
}

Inputs: Institution wallet address, certificate name, certificate year.
Output: Certificate ID, URI, Merkle root, token quantity.

Register Institution (/register)

Factory agents register institutions to allow them to issue certificates.

• Navigate to /register.
• Connect a factory agent wallet (e.g., `0x85E12F2100554D46b498D887a83ABBf9C42fF951`).
• Enter institution wallet address and name.
• Submit to register the institution.

Issue Certificate (/issue)

Verified institutions or admins issue new certificates with Merkle proofs for recipients.

• Navigate to /issue.
• Connect an institution admin wallet.
• Enter institution details, certificate details (name, ID, URI, year, token quantity), and recipient addresses.
• Generate a Merkle root and download proofs via the UI.
• Submit to deploy the certificate contract.

Update Certificate (/agent/update-certificate)

Verified institutions or admins update existing certificate details.

• Navigate to /agent/update-certificate.
• Connect an institution admin wallet.
• Enter institution name, previous certificate details (name, year), and updated details (name, ID, URI, year, Merkle root, token quantity).
• Optionally generate a new Merkle root and download proofs.
• Submit to update the certificate.

Claim Certificate (/claim)

Recipients claim their certificates using a Merkle proof.

• Navigate to /claim.
• Connect the recipient’s wallet.
• Enter certificate ID, institution name, and upload or paste the Merkle proof.
• Submit to claim the certificate.

Verify Certificate Claim (/verify)

Anyone can verify a recipient’s certificate claim.

• Navigate to /verify.
• Enter institution wallet address, certificate name, certificate year, and recipient address.
• Submit to view claim details (e.g., Recipient Name, Certificate ID, Claimed status).

Inspect Certificate (/inspect)

View detailed certificate metadata.

• Navigate to /inspect.
• Enter institution wallet address, certificate name, and certificate year.
• Submit to view certificate details (e.g., ID, URI, Merkle root).
• Note: This feature may encounter issues (e.g., `CALL_EXCEPTION`); check logs for debugging.

View Profiles (/profile)

View institution or recipient profiles, including issued or claimed certificates.

• Navigate to /profile.
• Connect a wallet to view your profile or enter an address to view another’s.
• Displays issued certificates (for institutions) or claimed certificates (for recipients).