Generate API key

To interact with the offchain system, an API key is required for each ENS name. Here's how you can generate and manage API keys:

Generating an API Key

The generateApiKey method creates an API key for a given ENS name. It requires the signerAddress and a SignerFunction to generate a token. Below is the implementation of the key generation process:

generateApiKey method uses sign message under the hood, it constructs a token which is then sent to backend service. The backend will verify that wallet which requests an api key has required permissions for the name it wants to get api key for.

Below is the implementation of the key generation process using Viem:

import { privateKeyToAccount } from "viem/accounts";
import { createOffchainClient } from "@namespacesdk/offchain-manager";

const offchainClient = createOffchainClient({
  baseURL: "https://api...",
});

async function generateApiKey() {
  const PRIVATE_KEY = "0xYourPkHere";
  const WALLET = privateKeyToAccount(PRIVATE_KEY);
  const WALLET_ADDRESS = WALLET.address;
  const ENS_NAME = "myensname.eth";

  const signerFunction = async (message: string) => {
    return WALLET.signMessage({ message });
  };

  const apiKeyForName = await client.generateApiKey(
    {ensName: ENS_NAME, keyName: "key1"}
    WALLET_ADDRESS,
    signerFunction
  );
}

Using the API Key

Once the API key is generated, you can set it for an ENS name using the setApiKey method:

client.setApiKey("example.eth", "your-api-key");

This ensures all subsequent requests for the ENS name use the provided API key.