@0xmonaco/types 0.8.7-develop.0e951a5 → 0.8.7-develop.0f12336

package/dist/profile/index.d.ts

@@ -3,6 +3,7 @@
  *
  * Types for user profile operations including fetching user profile data.
  */
+import type { Address } from "viem";
 import type { BaseAPI } from "../api";
 import type { OrderSide, OrderStatus, OrderType, TimeInForce } from "../trading";
 /**
@@ -15,7 +16,7 @@ export interface ProfileMovement {
     /** Movement type */
     type: "deposit" | "withdrawal" | "trade" | "transfer" | string;
     /** Token address */
-    token: string;
+    token: Address;
     /** Amount of the movement (as string to preserve precision) */
     amount: string;
     /** Movement timestamp (ISO string) */
@@ -35,47 +36,53 @@ export interface LedgerMovement {
     /** Movement unique identifier */
     id: string;
     /** Type of entry (Credit, Debit) */
-    entry_type: string;
+    entryType: string;
     /** Type of transaction (Deposit, Withdrawal, Trade, etc.) */
-    transaction_type: string;
+    transactionType: string;
     /** Transaction amount (normalized, human-readable) */
     amount: string;
     /** Transaction amount in raw format (wei) */
-    amount_raw: string;
+    amountRaw: string;
     /** Token contract address */
-    token: string;
+    token: Address;
     /** Token symbol */
     symbol: string | null;
     /** Token decimals */
     decimals: number;
     /** Balance before this transaction (normalized) */
-    balance_before: string | null;
+    balanceBefore: string | null;
     /** Balance before in raw format (wei) */
-    balance_before_raw: string | null;
+    balanceBeforeRaw: string | null;
     /** Balance after this transaction (normalized) */
-    balance_after: string | null;
+    balanceAfter: string | null;
     /** Balance after in raw format (wei) */
-    balance_after_raw: string | null;
+    balanceAfterRaw: string | null;
     /** Locked balance before transaction (normalized) */
-    locked_before: string | null;
+    lockedBefore: string | null;
     /** Locked balance before in raw format (wei) */
-    locked_before_raw: string | null;
+    lockedBeforeRaw: string | null;
     /** Locked balance after transaction (normalized) */
-    locked_after: string | null;
+    lockedAfter: string | null;
     /** Locked balance after in raw format (wei) */
-    locked_after_raw: string | null;
+    lockedAfterRaw: string | null;
     /** Reference identifier for related operations */
-    reference_id: string | null;
+    referenceId: string | null;
     /** Reference type */
-    reference_type: string | null;
+    referenceType: string | null;
     /** Human readable description */
     description: string | null;
     /** Blockchain transaction hash */
-    tx_hash: string | null;
+    txHash: string | null;
     /** Blockchain block number */
-    block_number: number | null;
+    blockNumber: number | null;
     /** Transaction timestamp */
-    created_at: string | null;
+    createdAt: string | null;
+    /** Asset UUID this movement affects */
+    assetId?: string | null;
+    /** User UUID who owns this movement */
+    userId?: string | null;
+    /** Balance UUID this movement affects */
+    balanceId?: string | null;
 }
 /**
  * Ledger entry type for filtering movements.
@@ -94,13 +101,13 @@ export interface GetUserMovementsParams {
     /** Page number (starts from 1) */
     page?: number;
     /** Number of items per page (max 100) */
-    page_size?: number;
+    pageSize?: number;
     /** Filter by entry type (CREDIT, DEBIT, LOCK, UNLOCK, FEE) */
-    entry_type?: LedgerEntryType;
+    entryType?: LedgerEntryType;
     /** Filter by transaction type (DEPOSIT, WITHDRAWAL, TRADE, FEE, FUNDING, LIQUIDATION, INTEREST, REWARD) */
-    transaction_type?: TransactionType;
+    transactionType?: TransactionType;
     /** Filter by asset ID (UUID) */
-    asset_id?: string;
+    assetId?: string;
 }
 /**
  * Query parameters for getting user balances
@@ -109,7 +116,7 @@ export interface GetUserBalancesParams {
     /** Page number (starts from 1) */
     page?: number;
     /** Number of items per page (max 100) */
-    page_size?: number;
+    pageSize?: number;
 }
 /**
  * Response from getting user movements
@@ -126,11 +133,11 @@ export interface GetPaginatedUserMovementsResponse {
     /** Current page number */
     page: number;
     /** Items per page */
-    page_size: number;
+    pageSize: number;
     /** Total number of movements in PostgreSQL */
     total: number;
     /** Total number of pages */
-    total_pages: number;
+    totalPages: number;
 }
 /**
  * Response from getting user balances
@@ -141,11 +148,11 @@ export interface GetUserBalancesResponse {
     /** Total number of balances */
     total: number;
     /** Items per page */
-    page_size: number;
+    pageSize: number;
     /** Current page number */
     page: number;
     /** Total number of pages */
-    total_pages: number;
+    totalPages: number;
 }
 /**
  * Order information for recent orders.
@@ -159,7 +166,7 @@ export interface ProfileOrder {
     /** Order side */
     side: OrderSide;
     /** Order type */
-    order_type: OrderType;
+    orderType: OrderType;
     /** Order price (null for market orders) */
     price: string | null;
     /** Order quantity */
@@ -167,11 +174,11 @@ export interface ProfileOrder {
     /** Order status */
     status: OrderStatus;
     /** Time in force */
-    time_in_force?: TimeInForce;
+    timeInForce?: TimeInForce;
     /** Order creation timestamp (ISO string) */
-    created_at: string;
+    createdAt: string;
     /** Order last update timestamp (ISO string) */
-    updated_at?: string;
+    updatedAt?: string;
 }
 /**
  * Account balance for a specific token.
@@ -179,48 +186,46 @@ export interface ProfileOrder {
  */
 export interface AccountBalance {
     /** Asset ID (UUID for API calls) */
-    asset_id: string;
+    assetId: string;
     /** Token address */
-    token: string;
+    token: Address;
     /** Token symbol */
     symbol: string | null;
     /** Decimal places for the token */
     decimals: number;
     /** Available balance for trading (normalized) */
-    available_balance: string;
+    availableBalance: string;
     /** Locked balance (in orders or pending operations, normalized) */
-    locked_balance: string;
-    /** Collateral posted into margin (perps) accounts (normalized) */
-    margin_locked: string;
-    /** Total balance (available + locked + margin_locked, normalized) */
-    total_balance: string;
+    lockedBalance: string;
+    /** Total balance (available + locked, normalized) */
+    totalBalance: string;
     /** Available balance in raw format (wei) */
-    available_balance_raw: string;
+    availableBalanceRaw: string;
     /** Locked balance in raw format (wei) */
-    locked_balance_raw: string;
-    /** Margin-locked balance in raw format (wei) */
-    margin_locked_raw: string;
+    lockedBalanceRaw: string;
+    /** Total balance (available + locked) in raw format (wei) */
+    totalBalanceRaw: string;
 }
 /**
  * A single user trade execution.
  */
 export interface UserTrade {
     /** Trade unique identifier */
-    trade_id: string;
+    tradeId: string;
     /** Trading pair identifier (UUID) */
-    trading_pair_id: string;
+    tradingPairId: string;
     /** Execution price (as string to preserve precision) */
     price: string;
     /** Executed quantity (as string to preserve precision) */
     quantity: string;
     /** Quote volume (price * quantity, as string to preserve precision) */
-    quote_volume: string;
+    quoteVolume: string;
     /** Side of the trade */
     side: OrderSide;
     /** Fee paid for this trade (as string to preserve precision) */
     fee: string;
     /** Timestamp when the trade was executed (ISO string) */
-    executed_at: string;
+    executedAt: string;
 }
 /**
  * Query parameters for getting user trades
@@ -229,9 +234,9 @@ export interface GetUserTradesParams {
     /** Page number (starts from 1) */
     page?: number;
     /** Number of items per page (max 100) */
-    page_size?: number;
+    pageSize?: number;
     /** Filter by trading pair ID (UUID) */
-    trading_pair_id?: string;
+    tradingPairId?: string;
 }
 /**
  * Response from getting user trades
@@ -242,11 +247,72 @@ export interface GetUserTradesResponse {
     /** Current page number */
     page: number;
     /** Items per page */
-    page_size: number;
+    pageSize: number;
     /** Total number of trades */
     total: number;
     /** Total number of pages */
-    total_pages: number;
+    totalPages: number;
+}
+/**
+ * Direction of a funding payment from the user's perspective.
+ */
+export type FundingDirection = "PAID" | "RECEIVED";
+/**
+ * A single funding payment settled against a margin position.
+ */
+export interface FundingPayment {
+    /** Funding payment unique identifier (UUID) */
+    id: string;
+    /** Margin position identifier (UUID) */
+    positionId: string;
+    /** Margin account identifier (UUID) */
+    marginAccountId: string;
+    /** Trading pair identifier (UUID) */
+    tradingPairId: string;
+    /** Funding rate applied for the epoch (as string to preserve precision) */
+    fundingRate: string;
+    /** Absolute position size at settlement (as string to preserve precision) */
+    positionSize: string;
+    /** Signed funding amount; positive means paid, negative means received (as string) */
+    paymentAmount: string;
+    /** Funding direction for the user */
+    direction: FundingDirection;
+    /** Funding window start timestamp (ISO 8601), if known */
+    periodStart?: string;
+    /** Funding window end timestamp (ISO 8601), if known */
+    periodEnd?: string;
+    /** Funding payment creation timestamp (ISO 8601), if known */
+    createdAt?: string;
+}
+/**
+ * Query parameters for listing funding payments.
+ */
+export interface ListFundingPaymentsParams {
+    /** Page number (starts from 1) */
+    page?: number;
+    /** Number of items per page (max 100) */
+    pageSize?: number;
+    /** Filter by trading pair ID (UUID) */
+    tradingPairId?: string;
+    /** Filter by margin position ID (UUID) */
+    positionId?: string;
+    /** Filter by margin account ID (UUID) */
+    marginAccountId?: string;
+}
+/**
+ * Response from listing funding payments.
+ */
+export interface ListFundingPaymentsResponse {
+    /** List of funding payment records */
+    records: FundingPayment[];
+    /** Current page number */
+    page: number;
+    /** Items per page */
+    pageSize: number;
+    /** Total number of matching records */
+    total: number;
+    /** Total number of pages */
+    totalPages: number;
 }
 /**
  * Time period for portfolio stats and chart queries.
@@ -284,20 +350,20 @@ export interface PortfolioChartResponse {
 export interface PortfolioStats {
     /** Realized profit and loss (sum of CREDIT minus DEBIT from TRADE ledger entries) */
     pnl: string;
-    /** Total trading volume (sum of quote_volume from trades) */
+    /** Total trading volume (sum of quoteVolume from trades) */
     volume: string;
     /** Maximum peak-to-trough drawdown on running PnL */
-    max_drawdown: string;
+    maxDrawdown: string;
     /** Total number of orders placed */
-    total_orders: number;
+    totalOrders: number;
     /** Total number of trades executed */
-    total_trades: number;
+    totalTrades: number;
     /** Total fees paid */
-    fees_paid: string;
+    feesPaid: string;
     /** Ratio of profitable trades to total trades */
-    win_loss_ratio: string;
+    winLossRatio: string;
     /** Total equity in USDC terms (sum of all spot balances) */
-    total_equity: string;
+    totalEquity: string;
 }
 /**
  * User profile information returned by the /api/v1/accounts/me endpoint.
@@ -306,19 +372,23 @@ export interface UserProfile {
     /** Unique identifier for the user */
     id: string;
     /** Wallet address of the user */
-    address: string;
+    address: Address;
     /** Username of the user (can be null) */
     username: string | null;
     /** Account type (e.g., "master") */
-    account_type: string;
+    accountType: string;
     /** Whether the user can withdraw funds */
-    can_withdraw: boolean;
+    canWithdraw: boolean;
     /** Taker fee rate in basis points */
-    taker_fee_bps: number;
+    takerFeeBps: number;
     /** Maker fee rate in basis points */
-    maker_fee_bps: number;
+    makerFeeBps: number;
     /** Account creation timestamp (ISO string) */
-    created_at: string;
+    createdAt: string;
+    /** Additional taker fee in basis points contributed by the application (if any) */
+    applicationTakerFeeBps?: number;
+    /** Additional maker fee in basis points contributed by the application (if any) */
+    applicationMakerFeeBps?: number;
 }
 /**
  * Profile API interface.
@@ -343,9 +413,9 @@ export interface ProfileAPI extends BaseAPI {
      * @param params - Optional query parameters for pagination and filtering
      * @param params.page - Page number (starts from 1)
      * @param params.limit - Number of items per page (max 100)
-     * @param params.entry_type - Filter by entry type (CREDIT, DEBIT, LOCK, UNLOCK, FEE)
-     * @param params.transaction_type - Filter by transaction type (DEPOSIT, WITHDRAWAL, TRADE, FEE, FUNDING, LIQUIDATION, INTEREST, REWARD)
-     * @param params.asset_id - Filter by asset ID (UUID)
+     * @param params.entryType - Filter by entry type (CREDIT, DEBIT, LOCK, UNLOCK, FEE)
+     * @param params.transactionType - Filter by transaction type (DEPOSIT, WITHDRAWAL, TRADE, FEE, FUNDING, LIQUIDATION, INTEREST, REWARD)
+     * @param params.assetId - Filter by asset ID (UUID)
      * @returns Promise resolving to paginated movements response
      */
     getPaginatedUserMovements(params?: GetUserMovementsParams): Promise<GetPaginatedUserMovementsResponse>;
@@ -364,7 +434,7 @@ export interface ProfileAPI extends BaseAPI {
     /**
      * Get the current user's balance for a specific asset.
      *
-     * Fetches the user's balance for a specific asset from the /api/v1/accounts/balances/{asset_id} endpoint.
+     * Fetches the user's balance for a specific asset from the /api/v1/accounts/balances/{assetId} endpoint.
      * Requires a valid access token to be set. If no balance exists for a valid asset, returns zero balances.
      *
      * @param assetId - The asset identifier (UUID)
@@ -401,9 +471,25 @@ export interface ProfileAPI extends BaseAPI {
      * @param params - Optional query parameters for pagination and filtering
      * @param params.page - Page number (starts from 1)
      * @param params.limit - Number of items per page (max 100)
-     * @param params.trading_pair_id - Filter by trading pair ID (UUID)
+     * @param params.tradingPairId - Filter by trading pair ID (UUID)
      * @returns Promise resolving to paginated trades response
-     * @throws ValidationError If pagination params (page/limit) are invalid or trading_pair_id is not a valid UUID; this may occur before any network request.
+     * @throws ValidationError If pagination params (page/limit) are invalid or tradingPairId is not a valid UUID; this may occur before any network request.
      */
     getUserTrades(params?: GetUserTradesParams): Promise<GetUserTradesResponse>;
+    /**
+     * List the current user's funding payment history with pagination and filters.
+     *
+     * Fetches funding payments from the /api/v1/accounts/funding-payments endpoint.
+     * Requires a valid access token to be set.
+     *
+     * @param params - Optional query parameters for pagination and filtering
+     * @param params.page - Page number (starts from 1)
+     * @param params.pageSize - Number of items per page (max 100)
+     * @param params.tradingPairId - Filter by trading pair ID (UUID)
+     * @param params.positionId - Filter by margin position ID (UUID)
+     * @param params.marginAccountId - Filter by margin account ID (UUID)
+     * @returns Promise resolving to paginated funding payments response
+     * @throws ValidationError If pagination params or a UUID filter are invalid; this may occur before any network request.
+     */
+    listFundingPayments(params?: ListFundingPaymentsParams): Promise<ListFundingPaymentsResponse>;
 }

package/dist/sdk/index.d.ts

@@ -1,15 +1,19 @@
-import type { PublicClient, TransactionReceipt, WalletClient } from "viem";
+import type { Address, PublicClient, TransactionReceipt, WalletClient } from "viem";
 import type { ApplicationsAPI } from "../applications";
 import type { AuthAPI, AuthState, SessionCredentials } from "../auth/index";
 import type { DelegatedAgentsAPI } from "../delegated-agents";
+import type { FaucetAPI } from "../faucet";
 import type { FeesAPI } from "../fees";
 import type { MarginAccountsAPI } from "../margin-accounts";
 import type { Interval, MarketAPI } from "../market";
 import type { PositionsAPI } from "../positions";
 import type { ProfileAPI } from "../profile";
+import type { SubAccountsAPI } from "../sub-accounts";
 import type { TradingAPI, TradingMode } from "../trading";
 import type { VaultAPI } from "../vault";
 import type { ConditionalOrderEvent, OHLCVEvent, OrderbookEvent, OrderbookQuotationMode, OrderEvent, TradeEvent, UserBalanceEvent, UserMovementEvent } from "../websocket";
+import type { WhitelistAPI } from "../whitelist";
+import type { WithdrawalsAPI } from "../withdrawals";
 import type { Network } from "./network";
 /**
  * Configuration options for the Monaco SDK.
@@ -65,6 +69,8 @@ export interface MonacoSDK {
     delegatedAgents: DelegatedAgentsAPI;
     /** Vault operations API */
     vault: VaultAPI;
+    /** Low-level withdrawals API (initiate + fetch signed calldata) */
+    withdrawals: WithdrawalsAPI;
     /** Trading operations API */
     trading: TradingAPI;
     /** Market metadata API */
@@ -73,6 +79,12 @@ export interface MonacoSDK {
     marginAccounts: MarginAccountsAPI;
     /** Perp position operations API */
     positions: PositionsAPI;
+    /** Sub-account management API */
+    subAccounts: SubAccountsAPI;
+    /** Testnet faucet API */
+    faucet: FaucetAPI;
+    /** Public whitelist (waitlist) submission API */
+    whitelist: WhitelistAPI;
     /** Profile operations API */
     profile: ProfileAPI;
     /** Orderbook REST API for fetching orderbook snapshots */
@@ -94,7 +106,7 @@ export interface MonacoSDK {
             /** Page number (starts from 1, default: 1) */
             page?: number;
             /** Maximum number of records to return (default: 25, max: 100) */
-            page_size?: number;
+            pageSize?: number;
         }) => Promise<TradeEvent[]>;
     };
     /** WebSocket client for real-time data (orders, orderbook, ohlcv) */
@@ -125,6 +137,15 @@ export interface MonacoSDK {
     login(clientId: string, options?: {
         connectWebSocket?: boolean;
     }): Promise<AuthState>;
+    /**
+     * Create and adopt an owner-scoped delegated session.
+     *
+     * The current authenticated session must belong to an agent wallet that has
+     * an active delegation from `ownerUserId`. On success, the SDK signs
+     * subsequent requests with the delegated session keypair, so account reads
+     * and trading calls operate on the owner while preserving agent attribution.
+     */
+    loginAsDelegatedOwner(ownerUserId: string): Promise<AuthState>;
     /** Log out the user */
     logout(): Promise<void>;
     /** Refresh the access token */
@@ -136,7 +157,7 @@ export interface MonacoSDK {
     /** Check connection status */
     isConnected(): boolean;
     /** Get the current account address */
-    getAccountAddress(): string;
+    getAccountAddress(): Address;
     /** Get the current network ('mainnet' or 'testnet') */
     getNetwork(): Network;
     /** Get the current chain ID */

package/dist/sub-accounts/index.d.ts

@@ -0,0 +1,146 @@
+/**
+ * Sub-Accounts Types
+ *
+ * Types for managing sub-accounts and their per-asset spending limits. All
+ * endpoints are session-authenticated; the limit mutations additionally
+ * require the caller to be a master account with the `ManageSubAccounts`
+ * permission (enforced server-side). Wire shapes are snake_case; optional
+ * fields are `null` rather than omitted.
+ */
+import type { Address } from "viem";
+import type { BaseAPI } from "../api";
+import type { AccountBalance } from "../profile";
+/**
+ * A sub-account owned by the authenticated master account, with its balances.
+ */
+export interface SubAccount {
+    /** Sub-account UUID */
+    id: string;
+    /** Sub-account wallet address */
+    address: Address;
+    /** Sub-account display username */
+    username: string | null;
+    /** Whether the sub-account is allowed to withdraw */
+    canWithdraw: boolean;
+    /** Account creation timestamp (ISO 8601) */
+    createdAt: string;
+    /** Per-asset balances held by the sub-account */
+    balances: AccountBalance[];
+}
+/**
+ * A per-asset spending limit on a sub-account.
+ */
+export interface SubAccountLimit {
+    /** Limit UUID */
+    id: string;
+    /** Sub-account UUID this limit applies to */
+    subAccountId: string;
+    /** Token contract address */
+    token: Address;
+    /** Maximum daily spending limit in token units */
+    dailyLimit: string | null;
+    /** Amount used today against the limit */
+    usedToday: string;
+    /** Limit creation timestamp (ISO 8601) */
+    createdAt: string;
+    /** Last update timestamp (ISO 8601) */
+    updatedAt: string | null;
+    /** Master account UUID that owns this sub-account */
+    masterAccountId: string;
+    /** Maximum amount allowed in token units */
+    maxAmount: string;
+    /** Last reset timestamp for the daily limit (ISO 8601) */
+    lastResetAt: string | null;
+    /** Whether the limit is active */
+    isActive: boolean;
+}
+/**
+ * Body for creating a sub-account limit.
+ */
+export interface CreateSubAccountLimitRequest {
+    /** Sub-account UUID to create the limit for */
+    subAccountId: string;
+    /** Asset UUID to limit */
+    assetId: string;
+    /** Maximum amount allowed in token units */
+    maxAmount: string;
+    /** Maximum daily spending limit in token units */
+    dailyLimit?: string;
+}
+/**
+ * Body for updating a sub-account limit. The sub-account and asset are taken
+ * from the path; all body fields are optional (partial update).
+ */
+export interface UpdateSubAccountLimitBody {
+    /** New maximum amount allowed in token units */
+    maxAmount?: string;
+    /** New maximum daily spending limit in token units */
+    dailyLimit?: string;
+    /** Whether the limit is active */
+    isActive?: boolean;
+}
+/** Paginated list of the master account's sub-accounts. */
+export interface ListSubAccountsResponse {
+    subAccounts: SubAccount[];
+    /** Total number of sub-accounts */
+    total: number;
+}
+/** Response wrapping a single created limit. */
+export interface CreateSubAccountLimitResponse {
+    limit: SubAccountLimit;
+}
+/** Response wrapping a single updated limit. */
+export interface UpdateSubAccountLimitResponse {
+    limit: SubAccountLimit;
+}
+/** Response wrapping a sub-account's limits. */
+export interface GetSubAccountLimitsResponse {
+    limits: SubAccountLimit[];
+}
+/**
+ * Sub-accounts API interface.
+ *
+ * `list` and `getLimits` need only session auth; `createLimit`, `updateLimit`,
+ * and `deleteLimit` additionally require the master account to hold the
+ * `ManageSubAccounts` permission (enforced server-side — a non-master or
+ * unpermissioned caller gets a 403).
+ */
+export interface SubAccountsAPI extends BaseAPI {
+    /**
+     * Lists the authenticated master account's sub-accounts with balances.
+     *
+     * @returns Promise resolving to the sub-accounts and total count
+     */
+    list(): Promise<ListSubAccountsResponse>;
+    /**
+     * Creates a per-asset spending limit on a sub-account.
+     *
+     * @param body - Sub-account, asset, max amount, and optional daily limit
+     * @returns Promise resolving to the created limit
+     */
+    createLimit(body: CreateSubAccountLimitRequest): Promise<CreateSubAccountLimitResponse>;
+    /**
+     * Gets the limits configured for a sub-account.
+     *
+     * @param subAccountId - Sub-account UUID
+     * @returns Promise resolving to the sub-account's limits
+     */
+    getLimits(subAccountId: string): Promise<GetSubAccountLimitsResponse>;
+    /**
+     * Updates a sub-account's per-asset limit (partial update).
+     *
+     * @param subAccountId - Sub-account UUID
+     * @param assetId - Asset UUID
+     * @param body - Fields to update
+     * @returns Promise resolving to the updated limit
+     */
+    updateLimit(subAccountId: string, assetId: string, body: UpdateSubAccountLimitBody): Promise<UpdateSubAccountLimitResponse>;
+    /**
+     * Deletes a sub-account's per-asset limit.
+     *
+     * @param subAccountId - Sub-account UUID
+     * @param assetId - Asset UUID
+     * @returns Promise resolving when the limit is deleted
+     */
+    deleteLimit(subAccountId: string, assetId: string): Promise<void>;
+}

package/dist/sub-accounts/index.js

@@ -0,0 +1,9 @@
+/**
+ * Sub-Accounts Types
+ *
+ * Types for managing sub-accounts and their per-asset spending limits. All
+ * endpoints are session-authenticated; the limit mutations additionally
+ * require the caller to be a master account with the `ManageSubAccounts`
+ * permission (enforced server-side). Wire shapes are snake_case; optional
+ * fields are `null` rather than omitted.
+ */