> For the complete documentation index, see [llms.txt](https://docs.thetanuts.finance/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.thetanuts.finance/sdk/sdk-reference/type-exports.md).

# Type Exports

All TypeScript types and classes exported from `@thetanuts-finance/thetanuts-client`, grouped by domain.

## Full Import Example

```typescript
import type {
  // Client
  ThetanutsClientConfig,
  ChainConfig,

  // RFQ
  RFQBuilderParams,
  RFQRequest,
  QuotationParameters,
  QuotationTracking,
  RFQUnderlying,
  RFQOptionType,
  RFQCollateralToken,

  // Multi-leg RFQ helpers
  SpreadRFQParams,
  ButterflyRFQParams,
  CondorRFQParams,
  IronCondorRFQParams,
  PhysicalOptionRFQParams,
  PhysicalSpreadRFQParams,
  PhysicalButterflyRFQParams,
  PhysicalCondorRFQParams,
  PhysicalIronCondorRFQParams,

  // Option
  OptionInfo,
  FullOptionInfo,
  PayoutCalculation,

  // MM Pricing
  MMVanillaPricing,
  MMPositionPricing,
  MMSpreadPricing,
  MMCondorPricing,
  MMButterflyPricing,

  // Utils
  PayoutType,
  PayoutParams,

  // API
  OrderWithSignature,
  Position,
  PositionSettlement,
  TradeHistory,
  APIProtocolStats,

  // RFQ Key Manager
  RFQKeyPair,
  EncryptedOffer,
  DecryptedOffer,
  KeyStorageProvider,
} from '@thetanuts-finance/thetanuts-client';

// Storage Providers (concrete classes, not just types)
import {
  LocalStorageProvider,
  MemoryStorageProvider,
} from '@thetanuts-finance/thetanuts-client';
```

## Grouped by Domain

### Client

| Export                  | Kind   | Description                                                |
| ----------------------- | ------ | ---------------------------------------------------------- |
| `ThetanutsClientConfig` | `type` | Constructor options for `ThetanutsClient`                  |
| `ChainConfig`           | `type` | Chain configuration shape (contracts, tokens, feeds, URLs) |

### RFQ

| Export                | Kind   | Description                                                                                     |
| --------------------- | ------ | ----------------------------------------------------------------------------------------------- |
| `RFQBuilderParams`    | `type` | Parameters for `buildRFQParams()`                                                               |
| `RFQRequest`          | `type` | Complete RFQ request ready for submission                                                       |
| `QuotationParameters` | `type` | On-chain quotation parameters                                                                   |
| `QuotationTracking`   | `type` | Tracking fields (referralId, eventCode)                                                         |
| `RFQUnderlying`       | `type` | `'ETH' \| 'BTC' \| 'SOL' \| 'DOGE' \| 'XRP' \| 'BNB' \| 'PAXG' \| 'AVAX'`                       |
| `RFQOptionType`       | `type` | `'CALL' \| 'PUT'`                                                                               |
| `RFQCollateralToken`  | `type` | `'USDC' \| 'WETH' \| 'cbBTC' \| 'aBasWETH' \| 'aBascbBTC' \| 'aBasUSDC' \| 'cbDOGE' \| 'cbXRP'` |

### Multi-leg RFQ Helpers

| Export                        | Kind   | Description                                       |
| ----------------------------- | ------ | ------------------------------------------------- |
| `SpreadRFQParams`             | `type` | Parameters for `buildSpreadRFQ()` (2 strikes)     |
| `ButterflyRFQParams`          | `type` | Parameters for `buildButterflyRFQ()` (3 strikes)  |
| `CondorRFQParams`             | `type` | Parameters for `buildCondorRFQ()` (4 strikes)     |
| `IronCondorRFQParams`         | `type` | Parameters for `buildIronCondorRFQ()` (4 strikes) |
| `PhysicalOptionRFQParams`     | `type` | Parameters for `buildPhysicalOptionRFQ()`         |
| `PhysicalSpreadRFQParams`     | `type` | Parameters for `buildPhysicalSpreadRFQ()`         |
| `PhysicalButterflyRFQParams`  | `type` | Parameters for `buildPhysicalButterflyRFQ()`      |
| `PhysicalCondorRFQParams`     | `type` | Parameters for `buildPhysicalCondorRFQ()`         |
| `PhysicalIronCondorRFQParams` | `type` | Parameters for `buildPhysicalIronCondorRFQ()`     |

### Option

| Export              | Kind   | Description                                                                               |
| ------------------- | ------ | ----------------------------------------------------------------------------------------- |
| `OptionInfo`        | `type` | Basic option info (type, strikes, expiry, collateral, priceFeed, implementation)          |
| `FullOptionInfo`    | `type` | Full option state including buyer, seller, contracts, collateral, expiry/settlement flags |
| `PayoutCalculation` | `type` | Return type of payout calculation methods                                                 |

### MM Pricing

| Export               | Kind   | Description                                                             |
| -------------------- | ------ | ----------------------------------------------------------------------- |
| `MMVanillaPricing`   | `type` | Pricing for a single vanilla option (bid/ask, IV, collateral breakdown) |
| `MMPositionPricing`  | `type` | Position pricing including collateral cost and total price              |
| `MMSpreadPricing`    | `type` | Spread pricing with width, collateral cost, MM bid/ask                  |
| `MMCondorPricing`    | `type` | Condor pricing with four legs and spread collateral cost                |
| `MMButterflyPricing` | `type` | Butterfly pricing with three legs and wing width                        |

### Utils

| Export         | Kind   | Description                                                                                                                                 |
| -------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------- |
| `PayoutType`   | `type` | `'call' \| 'put' \| 'call_spread' \| 'put_spread' \| 'call_fly' \| 'put_fly' \| 'call_condor' \| 'put_condor' \| 'iron_condor' \| 'ranger'` |
| `PayoutParams` | `type` | Parameters for `calculatePayout()`                                                                                                          |

### API

| Export               | Kind   | Description                                                        |
| -------------------- | ------ | ------------------------------------------------------------------ |
| `OrderWithSignature` | `type` | Order as returned from `client.api.fetchOrders()`                  |
| `Position`           | `type` | User position with full details from the indexer                   |
| `PositionSettlement` | `type` | Settlement details (price, payouts, exercised flag, oracle status) |
| `TradeHistory`       | `type` | Trade history entry                                                |
| `APIProtocolStats`   | `type` | Protocol-wide statistics from the API module                       |

### RFQ Key Manager

| Export               | Kind        | Description                                                |
| -------------------- | ----------- | ---------------------------------------------------------- |
| `RFQKeyPair`         | `type`      | ECDH key pair (privateKey, compressedPublicKey, publicKey) |
| `EncryptedOffer`     | `type`      | Encrypted offer ciphertext and signing key                 |
| `DecryptedOffer`     | `type`      | Decrypted offer (offerAmount, nonce)                       |
| `KeyStorageProvider` | `interface` | Interface for implementing custom key storage backends     |

### Storage Providers (classes)

| Export                  | Kind    | Description                                                  |
| ----------------------- | ------- | ------------------------------------------------------------ |
| `LocalStorageProvider`  | `class` | Browser localStorage storage for explicit opt-in/testing use |
| `MemoryStorageProvider` | `class` | In-memory storage for testing only (keys lost on exit)       |

## Usage in TypeScript Projects

When building integrations, import only the types you need:

```typescript
import type { RFQBuilderParams, RFQCollateralToken } from '@thetanuts-finance/thetanuts-client';

function buildMyRFQ(
  strike: number,
  collateral: RFQCollateralToken,
): RFQBuilderParams {
  return {
    requester: '0x...',
    underlying: 'ETH',
    optionType: 'PUT',
    strikes: strike,
    expiry: Math.floor(Date.now() / 1000) + 86400 * 7,
    numContracts: 1,
    isLong: true,
    offerDeadlineMinutes: 60,
    collateralToken: collateral,
  };
}
```

***

## See Also

* [Modules Overview](/sdk/sdk-reference/modules-overview.md) — All 15 modules at a glance
* [Client](/sdk/sdk-reference/client.md) — ThetanutsClient constructor and properties
* [../rfq/overview.md](/sdk/rfq-factory/overview.md) — RFQ module and workflow


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://docs.thetanuts.finance/sdk/sdk-reference/type-exports.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.