Skip to main content

​
Overview

This document provides a comprehensive reference for all functions available in the ZKScore Protocol Registry contract. Each function includes detailed parameter descriptions, return values, gas estimates, and usage examples.
All functions that modify state require a transaction and will consume gas. View functions are free to call and return data immediately.

​
Protocol Management Functions

​
registerProtocol

Register a new protocol in the registry. 
function registerProtocol(
    string memory name,
    string memory description,
    ProtocolType protocolType,
    address dataProvider,
    uint256 scoreWeight,
    bytes memory metadata
) external returns (uint256);
Parameters:
  • name (string): Protocol name
  • description (string): Protocol description
  • protocolType (ProtocolType): Type of protocol (0-7)
  • dataProvider (address): Authorized data provider address
  • scoreWeight (uint256): Score contribution weight (basis points)
  • metadata (bytes): Encoded additional metadata
Returns:
  • uint256: Newly created protocol ID
Gas Estimate: ~180,000 gas Requirements:
  • Caller must have REGISTRAR_ROLE
  • Name cannot be empty
  • Score weight must be reasonable (max 5000 = 50%)
Events Emitted:
  • ProtocolRegistered(uint256 indexed protocolId, string name, ProtocolType protocolType)
Example Usage: 
const { ethers } = require('ethers');

async function registerProtocol() {
  const provider = new ethers.providers.JsonRpcProvider('https://mainnet.infura.io/v3/YOUR_KEY');
  const signer = provider.getSigner();
  
  const contract = new ethers.Contract(
    '0x5678901234567890123456789012345678901234',
    PROTOCOL_REGISTRY_ABI,
    signer
  );
  
  // Encode metadata
  const metadata = ethers.utils.defaultAbiCoder.encode(
    ['string', 'string', 'string', 'string[]'],
    [
      'https://myprotocol.com',
      'v1.0.0',
      'DeFi lending protocol',
      ['https://twitter.com/myprotocol', 'https://discord.gg/myprotocol']
    ]
  );
  
  const tx = await contract.registerProtocol(
    'MyDeFiProtocol',
    'Decentralized lending and borrowing platform with competitive rates',
    0, // DEFI
    '0x1234567890123456789012345678901234567890',
    1500, // 15%
    metadata
  );
  
  const receipt = await tx.wait();
  const event = receipt.events.find(e => e.event === 'ProtocolRegistered');
  const protocolId = event.args.protocolId;
  
  console.log(`Protocol registered: ID ${protocolId.toString()}`);
  return protocolId;
}

​
getProtocol

Get detailed protocol information. 
function getProtocol(uint256 protocolId) 
    external 
    view 
    returns (Protocol memory);
Parameters:
  • protocolId (uint256): Protocol identifier
Returns:
  • Protocol: Complete protocol data structure
Gas Estimate: ~5,000 gas (view function) Example Usage: 
async function getProtocolDetails(protocolId) {
  const protocol = await contract.getProtocol(protocolId);
  
  console.log('Protocol:', {
    id: protocol.id.toString(),
    name: protocol.name,
    description: protocol.description,
    type: protocol.protocolType,
    dataProvider: protocol.dataProvider,
    scoreWeight: protocol.scoreWeight.toString(),
    isActive: protocol.isActive,
    totalUsers: protocol.totalUsers.toString()
  });
  
  return protocol;
}

​
isAuthorizedProvider

Check if an address is authorized to provide data for a protocol. 
function isAuthorizedProvider(uint256 protocolId, address provider) 
    external 
    view 
    returns (bool);
Parameters:
  • protocolId (uint256): Protocol identifier
  • provider (address): Provider address to check
Returns:
  • bool: True if authorized, false otherwise
Gas Estimate: ~2,000 gas (view function)

​
Error Handling

​
Common Errors

ErrorDescriptionSolution
"Protocol not found"Invalid protocol IDVerify protocol ID exists
"Not authorized"Insufficient permissionsCheck role assignments
"Protocol not active"Protocol is deactivatedCheck isActive status
"Invalid weight"Score weight out of rangeUse valid weight (0-5000)
"Provider already exists"Provider already addedCheck existing providers