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-sdkarrow-up-right

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

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

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

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

circle-info

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:

Project Setup

Create a new project and configure it for the SDK:

Create a new project

Add ESM support

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

Initialize TypeScript

Ensure your tsconfig.json includes the following settings:

Upgrading

To upgrade to the latest version:

Uninstalling

To remove the SDK:

Next Steps

Once installed, proceed to:

chevron-rightHaving issues?hashtag

Check the Troubleshooting Guide or FAQ.

Last updated