Description

A library used to interact with ZKM's naming service, by providing methods to interact with the ZKM Controller smart contract.

Installation

Add the package by running npm install zkm-lib

Usage

First you need to set the RPC url and private key you will use to make requests:

// Infura, Alchemy, or similar web3 RPC provider
const rpcUrl = ""
// Your wallet's private key
const privKey = ""

A very simple use case would be fetching name details for a registered name:

import { ZkmController } from "./util/zkmController";

const controller = new ZkmController(rpcUrl,privKey)

try {
    const result = await controller.getNameDetails(name)
    console.log(JSON.stringify(result))
    } catch(e) {
    const err = e as Error;
    console.log(err)
    }

License

Zkm-lib is published under the MIT license. Read more about the license: MIT License