Publish code snippet to lookup core contract address using Registry.sol

[arthurgousset]

@therealharpaljadeja shared a great insight.

He loves using viem + @celo/abis, but when he wants to interact with core contracts, he ends up hard-coding the core contract address.

That's not strictly necessary, because the address can be fetched from Registry.sol.
In ContractKit, this is abstracted from the developer, whereas with viem this has to be done manually.

There are various solutions and ideas to make this easier:

• v1 (easiest): publish a code snippet that achieves this (so devs can copy/paste and get started)
• v2 (more involved): publish a viem plugin, NPM package, or other form of abstraction

Here is a little code snippet I used in celo-org/epochs to lookup core contract addresses in various places:

// utils.ts
import { createPublicClient, http, getContract } from "viem";
import { celo } from "viem/chains";
import { registryABI } from "@celo/abis";

// ...

export async function getCoreContractAddress(
    contractName: string
): Promise<Address> {
    const registryContract = getContract({
        address: "0x000000000000000000000000000000000000ce10",
        abi: registryABI,
        publicClient,
    });
    return await registryContract.read.getAddressForStringOrDie([contractName]);
}

Source: utils.ts

// carbonOffsetDistributions.ts
import { getCoreContractAddress, publicClient } from "./utils";
import { goldTokenABI } from "@celo/abis";

// ...

async function getCarbonOffsetDistribution(epochNumber: bigint) {
    const filter = await publicClient.createContractEventFilter({
        address: await getCoreContractAddress("GoldToken"), // CELO ERC20 contract address
        abi: goldTokenABI,
        eventName: "Transfer",
        // ...
    });
    // ...
}

Source: carbonOffsetDistributions.ts

[aaronmgdr]

would be cool to add it to a viem extension https://viem.sh/docs/clients/custom.html

[aaronmgdr]

also here is the snippet for the registry react hook we use in staked-celo

import { useContractRead } from 'wagmi';
import { registryABI } from '@celo/abis';

const REGISTRY_CONTRACT_ADDRESS = '0x000000000000000000000000000000000000ce10';



export default function useCeloRegistryAddress(contractName: string) {
  const { data: address } = useContractRead({
    address: REGISTRY_CONTRACT_ADDRESS,
    abi: registryABI,
    functionName: 'getAddressForString',
    args: [contractName],
  });

  if (address && parseInt(address, 16) === 0) {
    return undefined;
  }
  return address;
}

[aaronmgdr]

todo: add in cacheing and either a TTL OR for extra credit clear it when the RegistryUpdated event happens.