Type Definitions

This directory contains all TypeScript type definitions for the SDK.

File Overview

File
Purpose

common.ts

Shared enums and literal types (OptionType, OptionStructure, OrderSide, etc.)

client.ts

Client configuration types (ThetanutsClientConfig, SupportedChainId)

errors.ts

Error codes and error class (ThetanutsErrorCode, ThetanutsError)

logger.ts

Logger interface (ThetanutsLogger)

optionBook.ts

OptionBook contract types (ContractOrder, Order, SwapParams, FillOrderResult)

optionFactory.ts

RFQ/OptionFactory types (QuotationParameters, RFQRequest, ReferralParameters, SwapAndCallParams)

option.ts

Option position types (OptionInfo, PayoutCalculation, UnpackedOptionType)

events.ts

Blockchain event types (OrderFillEvent, QuotationRequestedEvent, etc.)

pricing.ts

Pricing and Greeks types (PayoffInput, PayoffDiagram, Greeks)

erc20.ts

ERC20 operation types (ApprovalResult, TokenBalance, TokenInfo)

api.ts

API response types (OrderWithSignature, Position, MarketDataResponse)

stateApi.ts

State API types for RFQ indexer (StateApiResponse, StateRfq, StateOffer, StateOption)

websocket.ts

WebSocket types (WebSocketState, SubscriptionType, OrderUpdate, PriceUpdate)

rfqKeyManager.ts

RFQ key management types (RFQKeyPair, EncryptedOffer, DecryptedOffer, KeyStorageProvider)


Common Types (common.ts)

Basic Enums


Client Types (client.ts)

Configuration


Error Types (errors.ts)

Error Codes

Error Class


Order Types (optionBook.ts)

Contract Order (On-chain)

SDK Order (Simplified)

Order with Signature

Raw API Data

Accessing Greeks:

OptionBook Result Types


API Types (api.ts)

Market Data

Protocol Stats

PositionSettlement

Settlement details for closed or settled positions.

Position

User position with full details from the Indexer API.

TradeHistory

Trade history entry with extended details.

ReferrerStats


Option Types (option.ts)

Option Info

Payout & Position Results

Option Parameters


Event Types (events.ts)

Order Events

RFQ Events

BaseOption Events


State API Types (stateApi.ts)

Types for the RFQ State API indexer, providing a snapshot of on-chain OptionFactory state.

User Data Types

State API Response


OptionFactory Types (optionFactory.ts)

Enums

Core Types

Referral & Swap Types

Transaction Result Types


Pricing Types (pricing.ts)

Greeks

Payoff


WebSocket Types (websocket.ts)

Connection

Subscriptions

Updates


Logger Types (logger.ts)


RFQ Key Manager Types (rfqKeyManager.ts)

Types for ECDH keypair generation, storage, and encryption for the sealed-bid RFQ workflow.

Keypair Types

Encryption Types

Storage Provider Interface

Built-in Storage Providers

FileStorageProvider Features:

  • Default for Node.js environments

  • Keys persist to .thetanuts-keys/ directory

  • Directory created with 0o700 permissions (owner only)

  • Key files have 0o600 permissions (owner read/write)

  • Atomic writes to prevent corruption

  • Path traversal protection

Usage Example:


Usage Example

Last updated