# Configuration

This guide covers how to configure the Opinion CLOB TypeScript SDK for different environments and use cases.

### Client Configuration

The `Client` class accepts a configuration object during initialization:

{% code title="example.ts" %}

```typescript
import { Client, CHAIN_ID_BNB_MAINNET, DEFAULT_API_HOST } from '@opinion-labs/opinion-clob-sdk';

const client = new Client({
  host: DEFAULT_API_HOST,
  apiKey: 'your_api_key',
  chainId: CHAIN_ID_BNB_MAINNET,  // 56
  rpcUrl: 'your_rpc_url',
  privateKey: '0x...' as `0x${string}`,
  multiSigAddress: '0x...' as `0x${string}`,
  conditionalTokensAddress: '0xAD1a38cEc043e70E83a3eC30443dB285ED10D774',
  multiSendAddress: '0x38869bf66a61cF6bDB996A6aE40D5853Fd43B526',
  feeManagerAddress: '0xC9063Dc52dEEfb518E5b6634A6b8D624bc5d7c36',
  enableTradingCheckInterval: 3600,
  quoteTokensCacheTtl: 3600,
  marketCacheTtl: 300,
  proxyUrl: 'http://127.0.0.1:7890',  // Optional HTTP proxy
});
```

{% endcode %}

### Required Parameters

#### host

**Type**: `string`\
**Description**: Opinion API host URL\
**Default**: No default (required)

```typescript
import { DEFAULT_API_HOST } from '@opinion-labs/opinion-clob-sdk';
// DEFAULT_API_HOST = 'https://openapi.opinion.trade/openapi'
host: DEFAULT_API_HOST
```

#### apiKey

**Type**: `string`\
**Description**: API authentication key provided by Opinion Labs\
**Default**: No default (required)

How to obtain: fill out this [short application form](https://docs.google.com/forms/d/1h7gp8UffZeXzYQ-lv4jcou9PoRNOqMAQhyW4IwZDnII)

```typescript
apiKey: '________'
```

{% hint style="warning" %}
Security: Store API keys in environment variables, never in source code.
{% endhint %}

#### chainId

**Type**: `number`\
**Description**: Blockchain network chain ID\
**Supported values**:

* `56` - BNB Chain Mainnet (production)

```typescript
import { CHAIN_ID_BNB_MAINNET } from '@opinion-labs/opinion-clob-sdk';
chainId: CHAIN_ID_BNB_MAINNET  // 56
```

#### rpcUrl

**Type**: `string`\
**Description**: Blockchain RPC endpoint URL\
**Default**: No default (required)

Common providers:

* BNB Chain Mainnet: `https://bsc-dataseed.binance.org`
* BNB Chain (Nodereal): <https://bsc.nodereal.io>

```typescript
// Public RPC (rate limited)
rpcUrl: 'https://bsc-dataseed.binance.org'

// Private RPC (recommended for production)
rpcUrl: 'https://bsc.nodereal.io'
```

#### privateKey

**Type**: `` `0x${string}` ``\
**Description**: Private key for signing orders and transactions\
**Format**: 64-character hex string with `0x` prefix

```typescript
privateKey: '0x1234567890abcdef...' as `0x${string}`  // Must have 0x prefix
```

{% hint style="danger" %}
Critical Security:

* Never commit private keys to version control
* Use environment variables or secure key management systems
* Ensure the associated address has BNB for gas fees
* This is the **signer** address, may differ from multiSigAddress
  {% endhint %}

#### multiSigAddress

**Type**: `Address`\
**Description**: Multi-signature wallet address (your assets/portfolio wallet)\
**Format**: Ethereum address (checksummed or lowercase)

```typescript
multiSigAddress: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb' as `0x${string}`
```

Relationship to `privateKey`:

* `privateKey` -> Signer address (signs orders/transactions)
* `multiSigAddress` -> Assets address (holds funds/positions)
* Can be the same address or different (e.g., hot wallet signs for cold wallet)

Where to find:

* Check your Opinion platform "My Profile" section
* Or use the wallet address where you hold USDT/positions

***

### Optional Parameters

#### conditionalTokensAddress

**Type**: `Address`\
**Description**: ConditionalTokens contract address\
**Default**: `0xAD1a38cEc043e70E83a3eC30443dB285ED10D774` (BNB Chain mainnet)\
When to set: Only if using a custom deployment

#### multiSendAddress

**Type**: `Address`\
**Description**: Gnosis Safe MultiSend contract address\
**Default**: `0x38869bf66a61cF6bDB996A6aE40D5853Fd43B526`\
When to set: Only if using a custom Gnosis Safe deployment

#### feeManagerAddress

**Type**: `Address`\
**Description**: Fee rate management contract address\
**Default**: `0xC9063Dc52dEEfb518E5b6634A6b8D624bc5d7c36`\
When to set: Only if using a custom deployment

#### enableTradingCheckInterval

**Type**: `number`\
**Description**: Cache duration (in seconds) for trading approval checks\
**Default**: `3600` (1 hour)\
**Range**: `0` to infinity

```typescript
// Default: check approval status every hour
enableTradingCheckInterval: 3600

// Check every time (no caching)
enableTradingCheckInterval: 0

// Check daily
enableTradingCheckInterval: 86400
```

Impact:

* Higher values -> Fewer RPC calls -> Faster performance
* `0` -> Always check -> Slower but always current
* Recommended: `3600` (approvals rarely change)

#### quoteTokensCacheTtl

**Type**: `number`\
**Description**: Cache duration (in seconds) for quote token data\
**Default**: `3600` (1 hour)\
**Range**: `0` to infinity

Impact:

* Quote tokens rarely change
* Higher values improve performance
* Recommended: `3600` or higher

#### marketCacheTtl

**Type**: `number`\
**Description**: Cache duration (in seconds) for market data\
**Default**: `300` (5 minutes)\
**Range**: `0` to infinity

Impact:

* Markets change frequently (prices, status)
* Lower values -> More current data
* Recommended: `300` for balance of performance and freshness

#### proxyUrl

**Type**: `string`\
**Description**: HTTP proxy URL for API requests\
**Default**: undefined (no proxy)

```typescript
proxyUrl: 'http://127.0.0.1:7890'
```

***

### Environment Variables

#### Using .env Files

Create a `.env` file in your project root:

```bash
# .env
API_KEY=opn_prod_abc123xyz789
RPC_URL=____
PRIVATE_KEY=0x1234567890abcdef...
MULTI_SIG_ADDRESS=0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb
CHAIN_ID=56
```

Load in your code:

{% code title="env-load.ts" %}

```typescript
import 'dotenv/config';
import { Client, CHAIN_ID_BNB_MAINNET, DEFAULT_API_HOST } from '@opinion-labs/opinion-clob-sdk';

const client = new Client({
  host: DEFAULT_API_HOST,
  apiKey: process.env.API_KEY!,
  chainId: CHAIN_ID_BNB_MAINNET,
  rpcUrl: process.env.RPC_URL!,
  privateKey: process.env.PRIVATE_KEY! as `0x${string}`,
  multiSigAddress: process.env.MULTI_SIG_ADDRESS! as `0x${string}`,
});
```

{% endcode %}

#### Using System Environment Variables

Set in shell:

```bash
# Linux/macOS
export API_KEY="opn_prod_abc123xyz789"
export RPC_URL=___
export PRIVATE_KEY="0x..."
export MULTI_SIG_ADDRESS="0x..."

# Windows (Command Prompt)
set API_KEY=opn_prod_abc123xyz789
set RPC_URL=___

# Windows (PowerShell)
$env:API_KEY="opn_prod_abc123xyz789"
$env:RPC_URL=___
```

Then access in your code:

```typescript
const client = new Client({
  host: DEFAULT_API_HOST,
  apiKey: process.env.API_KEY!, // Throws if not set at runtime
  // ...
});
```

***

### Configuration Patterns

#### Multi-Environment Setup

Manage different environments (dev, staging, prod):

{% code title="multi-env.ts" %}

```typescript
import { Client, CHAIN_ID_BNB_MAINNET, DEFAULT_API_HOST } from '@opinion-labs/opinion-clob-sdk';

const ENVIRONMENTS = {
  production: {
    host: DEFAULT_API_HOST,
    chainId: CHAIN_ID_BNB_MAINNET,
    rpcUrl: 'https://bsc-dataseed.binance.org',
  },
} as const;

function createClient(env: 'production' = 'production') {
  const config = ENVIRONMENTS[env];
  const prefix = env.toUpperCase();

  return new Client({
    host: config.host,
    apiKey: process.env[`${prefix}_API_KEY`]!,
    chainId: config.chainId,
    rpcUrl: config.rpcUrl,
    privateKey: process.env[`${prefix}_PRIVATE_KEY`]! as `0x${string}`,
    multiSigAddress: process.env[`${prefix}_MULTI_SIG_ADDRESS`]! as `0x${string}`,
  });
}

const prodClient = createClient('production');
```

{% endcode %}

#### Factory Function

Organize configuration in a factory function:

{% code title="factory.ts" %}

```typescript
import { Client, CHAIN_ID_BNB_MAINNET, DEFAULT_API_HOST } from '@opinion-labs/opinion-clob-sdk';

function createClientFromEnv(): Client {
  return new Client({
    host: DEFAULT_API_HOST,
    apiKey: process.env.API_KEY!,
    chainId: CHAIN_ID_BNB_MAINNET,
    rpcUrl: process.env.RPC_URL!,
    privateKey: process.env.PRIVATE_KEY! as `0x${string}`,
    multiSigAddress: process.env.MULTI_SIG_ADDRESS! as `0x${string}`,
    marketCacheTtl: 300,
  });
}

const client = createClientFromEnv();
```

{% endcode %}

#### Read-Only Client

For applications that only read data (no trading):

{% code title="readonly.ts" %}

```typescript
// Minimal configuration for read-only access
const client = new Client({
  host: DEFAULT_API_HOST,
  apiKey: process.env.API_KEY!,
  chainId: CHAIN_ID_BNB_MAINNET,
  rpcUrl: '',
  privateKey: `0x${'00'.repeat(32)}` as `0x${string}`,
  multiSigAddress: '0x0000000000000000000000000000000000000000',
});

// Can use all GET methods
const markets = await client.getMarkets();
const market = await client.getMarket(123);
const orderbook = await client.getOrderbook('token_123');

// Cannot use trading or contract methods
```

{% endcode %}

***

### Performance Tuning

#### High-Frequency Trading

For trading bots with frequent API calls:

{% code title="hft.ts" %}

```typescript
const client = new Client({
  // ... required params ...
  marketCacheTtl: 60,
  quoteTokensCacheTtl: 3600,
  enableTradingCheckInterval: 7200,
});
```

{% endcode %}

#### Analytics/Research

For data analysis with less frequent updates:

{% code title="analytics.ts" %}

```typescript
const client = new Client({
  // ... required params ...
  marketCacheTtl: 1800,
  quoteTokensCacheTtl: 86400,
  enableTradingCheckInterval: 0,
});
```

{% endcode %}

#### Real-Time Monitoring

For dashboards requiring fresh data:

{% code title="realtime.ts" %}

```typescript
const client = new Client({
  // ... required params ...
  marketCacheTtl: 0,
  quoteTokensCacheTtl: 0,
  enableTradingCheckInterval: 0,
});
```

{% endcode %}

***

### Smart Contract Addresses

#### BNB Chain Mainnet (Chain ID: 56)

The following smart contract addresses are used by the Opinion CLOB TypeScript SDK on BNB Chain mainnet:

| Contract              | Address                                      | Description                                            |
| --------------------- | -------------------------------------------- | ------------------------------------------------------ |
| **ConditionalTokens** | `0xAD1a38cEc043e70E83a3eC30443dB285ED10D774` | ERC1155 conditional tokens contract for outcome tokens |
| **MultiSend**         | `0x38869bf66a61cF6bDB996A6aE40D5853Fd43B526` | Gnosis Safe MultiSend contract for batch transactions  |
| **FeeManager**        | `0xC9063Dc52dEEfb518E5b6634A6b8D624bc5d7c36` | Fee rate management contract                           |

These addresses are automatically used by the SDK when you specify `chainId: 56`. You only need to provide custom addresses if you are using a custom deployment.

Verification:

* ConditionalTokens: [View on BscScan](https://bscscan.com/address/0xAD1a38cEc043e70E83a3eC30443dB285ED10D774)
* MultiSend: [View on BscScan](https://bscscan.com/address/0x38869bf66a61cF6bDB996A6aE40D5853Fd43B526)
* FeeManager: [View on BscScan](https://bscscan.com/address/0xC9063Dc52dEEfb518E5b6634A6b8D624bc5d7c36)

***

### Next Steps

* [**API Reference**](/developer-guide/opinion-clob-typescript-sdk/api-references.md): All Supported Methods
* [**Configuration Guide**](/developer-guide/opinion-clob-typescript-sdk/getting-started/configuration.md): Configuration
* [**Core Concepts**](/developer-guide/opinion-clob-typescript-sdk/core-concepts.md): Architecture
* [**Troubleshooting**](/developer-guide/opinion-clob-typescript-sdk/support/troubleshooting.md): Common Issues


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.opinion.trade/developer-guide/opinion-clob-typescript-sdk/getting-started/configuration.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.