Installation

This guide will help you install the Opinion CLOB TypeScript SDK and its dependencies.

Package registry: https://www.npmjs.com/package/@opinion-labs/opinion-clob-sdk

Requirements

Node.js Version

• Node.js 18 or higher

Check your Node.js version:

node --version

System Requirements

• Operating Systems: Linux, macOS, Windows

• Network: Internet connection for API access and blockchain RPC

• Optional: Git (for development installation)

Installation Methods

Install from npm (Recommended)

The simplest way to install the Opinion CLOB TypeScript SDK is via a package manager.

npm

npm install @opinion-labs/opinion-clob-sdk

yarn

yarn add @opinion-labs/opinion-clob-sdk

pnpm

pnpm add @opinion-labs/opinion-clob-sdk

This will install the latest stable version and all required dependencies including viem.

The TypeScript SDK is ESM-only. Ensure your package.json has "type": "module".

Dependencies

The SDK automatically installs the following key dependency:

Package	Purpose
viem	Blockchain interactions, contract calls, transaction signing

Verify Installation

After installation, verify it works:

import {
  Client,
  TopicType,
  TopicStatus,
  CHAIN_ID_BNB_MAINNET,
} from '@opinion-labs/opinion-clob-sdk';

console.log('Opinion CLOB TypeScript SDK installed successfully!');
console.log('Supported chain:', CHAIN_ID_BNB_MAINNET);

Project Setup

Create a new project and configure it for the SDK:

Create a new project

mkdir my-opinion-bot
cd my-opinion-bot
npm init -y

Add ESM support

Add "type": "module" to package.json, then install dependencies:

npm install @opinion-labs/opinion-clob-sdk
npm install -D typescript @types/node dotenv

Initialize TypeScript

npx tsc --init

Ensure your tsconfig.json includes the following settings:

{
  "compilerOptions": {
    "target": "ES2020",
    "module": "ESNext",
    "moduleResolution": "bundler",
    "esModuleInterop": true,
    "strict": true,
    "outDir": "./dist"
  }
}

Upgrading

To upgrade to the latest version:

npm install @opinion-labs/opinion-clob-sdk@latest

Uninstalling

To remove the SDK:

npm uninstall @opinion-labs/opinion-clob-sdk

Next Steps

Once installed, proceed to:

1. Quick Start Guide - Build your first application

2. Configuration - Set up API keys and credentials

3. API Reference - Explore available methods

Having issues?

Check the Troubleshooting Guide or FAQ.