Getting Started

Install

yarn:

yarn add @hatsprotocol/modules-sdk viem

npm:

npm install @hatsprotocol/modules-sdk viem

The SDK uses Viem in order to interact with the various chains and includes it as a peer dependency.

HatsModulesClient Initialization

Import and initialize HatsModulesClient:

import { HatsModulesClient } from "@hatsprotocol/modules-sdk";

const hatsModulesClient = new HatsModulesClient({
    publicClient,
    walletClient,
});

Arguments:

{
    publicClient: PublicClient;
    walletClient: WalletClient;
}

• publicClient - A Viem Public Client, used for onchain read operations.

• walletClient - A Viem Wallet Client, used for onchain write operations.

Prepare

The prepare function fetches from the modules registry. This step is necessary in order to be able to use the client. Additionally, the function accepts an optional registry input , in order to support user's caching. If provided, then the client will use the given modules instead of fetching from the registry.

await hatsModulesClient.prepare();

Arguments:

registry?: Registry

registry - Optional registry object to use, instead of fetching from the current registry.