Offchain SDK Installation

Install the Offchain SDK using your preferred package manager:

Npm
Yarn

npm install @thenamespace/offchain-manager

yarn add @thenamespace/offchain-manager

Creating a Client

To interact with the Offchain SDK, create a client instance. You can obtain your API key from the Namespace App.

Default
Network Configuration
Address-based API Key
Domain-based API Keys

import { createOffchainClient } from "@thenamespace/offchain-manager";

// Defaults to mainnet
const client = createOffchainClient();
client.setDefaultApiKey("your-address-based-api-key");

import { createOffchainClient } from "@thenamespace/offchain-manager";

const client = createOffchainClient({ 
  mode: "sepolia" 
});

import { createOffchainClient } from "@thenamespace/offchain-manager";

const client = createOffchainClient({
  mode: "sepolia",
  defaultApiKey: "your-address-based-api-key"
});

import { createOffchainClient } from "@thenamespace/offchain-manager";

const client = createOffchainClient({
  mode: "sepolia",
  domainApiKeys: {
    "example.eth": "your-domain-based-api-key",
    "test.eth": "another-domain-key"
  }
});

Configuration Options

mode: Network mode - choose between “mainnet” for production or “sepolia” for testing
timeout: Request timeout in milliseconds (optional)
defaultApiKey: Address-based API key for all domains registered to your address
domainApiKeys: Object mapping specific ENS domains to their API keys

Overview API Key

Getting Started

How to Guides

Integrations

API Reference

SDK Reference

Architecture

Offchain SDK Installation

Creating a Client

Configuration Options

​Creating a Client

​Configuration Options

Creating a Client

Configuration Options