@domfi/sdk 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,216 @@
+import { o as DomfiActionsClient } from './types-CMtixBIP.cjs';
+import { ReadinessWarningEvent, DomfiInfoClient, DomfiRawClient } from './api.cjs';
+import { R as ReadOptions, e as ResultEnvelope, g as ApiStatus } from './types-DQft82W7.cjs';
+import { Address } from './units.cjs';
+import { DomfiChain, DomfiChainProfile } from './config.cjs';
+export { CollateralConfig, baseDomfiChain, baseSepoliaDomfiChain, domfiChains } from './config.cjs';
+import { P as PublicClient, b as WalletClient, c as DelegationClient, d as TradingClient, e as TradingClientNoApi } from './types-DJBX-p4X.cjs';
+import { DiagnosticsEnvelope } from '@domfi/sdk/errors';
+export { AbortError, ApiError, ApiErrorInit, ContractRevertError, ContractRevertErrorInit, DiagnosticsEnvelope, DomfiError, DomfiErrorCode, DomfiErrorInit, DomfiErrorKind, IdentityMismatchError, MissingAccountError, MissingApiClientError, MissingPublicClientError, MissingWalletClientError, OracleFeeCapExceededError, ProtocolCompatibilityMismatchError, ReadModelNotReadyError, TimeoutError, TransportError, TransportErrorInit, ValidationError, WalletAccountMismatchError, WalletChainMismatchError, WalletDisconnectedError, isDomfiError } from '@domfi/sdk/errors';
+import { SdkCompatibilityReport } from './contracts.cjs';
+import { ReferralClient } from './referrals.cjs';
+import { TokenClient } from './token.cjs';
+import { V as ValuationClient, d as ValuationClientNoApi } from './types-BK6dYOXr.cjs';
+import { k as VaultClient } from './types-x1MvxSdy.cjs';
+export { Address, Brand, ClosePercent, Collateral, DecimalInput, DecimalString, FeePercent, FormatOptions, Hex, IsoTimestamp, Leverage, Notional, NumberBrandCodec, OrderId, PairIndex, Precision2Percent, Price, Ratio, RatioCodec, ScaleP2, SignedCollateral, SignedP18, SignedP6, SlippagePercent, StringBrandCodec, TimeInput, TradeId, TradeIndex, TriggerOrderIndex, TriggerOrderIndexCodec, UnitCodec, UnixMs, UnsignedP18, UsdP6, VaultAsset, VaultShare, VaultSharePrice, WholePercent, parseDecimalString } from '@domfi/sdk/units';
+import './units-BYd75H7U.cjs';
+import './errors.cjs';
+import 'viem';
+
+/** HTTP request shape passed to a custom SDK REST transport. */
+type DomfiHttpRequest = {
+    method: "GET" | "POST";
+    url: string;
+    headers?: Record<string, string>;
+    body?: string;
+    signal?: AbortSignal;
+    timeoutMs?: number;
+};
+/** HTTP response shape returned by a custom SDK REST transport. */
+type DomfiHttpResponse = {
+    status: number;
+    headers: Headers | Record<string, string>;
+    body: string;
+};
+/** Custom HTTP transport hook for REST API calls. */
+type IRequestTransport = (request: DomfiHttpRequest) => Promise<DomfiHttpResponse>;
+/** REST API configuration for API-enabled SDK clients. */
+type ApiClientOptions = {
+    /** Override the selected chain profile's REST API base URL. */
+    baseUrl?: string;
+    /** Custom HTTP request implementation for runtimes without global `fetch` or for tests. */
+    requestTransport?: IRequestTransport;
+    /** Default REST request timeout in milliseconds. */
+    defaultTimeoutMs?: number;
+};
+/** Observable REST transport event emitted through `createDomfiClient({ onEvent })`. */
+type ApiTransportEvent = {
+    type: "rest_request";
+    diagnostics: DiagnosticsEnvelope;
+    url: string;
+} | {
+    type: "rest_response";
+    diagnostics: DiagnosticsEnvelope;
+    url: string;
+    status: number;
+};
+
+/**
+ * Observable, non-fatal SDK events emitted through `createDomfiClient({ onEvent })`.
+ *
+ * Today this covers REST transport diagnostics and read-plane readiness warnings.
+ * Handler exceptions are ignored so observability code cannot change SDK behavior.
+ */
+type DomfiEvent = ApiTransportEvent | ReadinessWarningEvent;
+/**
+ * REST/RPC concurrency and retry controls for SDK-managed transport calls.
+ *
+ * These controls only wrap calls the SDK initiates. They do not change retry or
+ * batching behavior inside a user-provided viem client.
+ */
+type DomfiTransportOptions = {
+    /** Maximum number of concurrent SDK REST API requests. Must be a positive integer. */
+    maxConcurrentRest?: number;
+    /** Maximum number of concurrent SDK-issued viem public/wallet client calls. Must be a positive integer. */
+    maxConcurrentRpc?: number;
+    /**
+     * Maximum REST retry attempts per request for transient REST failures.
+     * Must be a non-negative integer. Defaults to 0, applies only to REST requests,
+     * and does not retry RPC/wallet calls. Retries use abort-aware exponential
+     * backoff with jitter and honor `Retry-After` on HTTP 429 responses.
+     * Transient REST failures are transport failures, timeouts with remaining timeout budget,
+     * HTTP 429/5xx responses, or structured API errors with retryable:true. Structured API
+     * errors with retryable:false suppress retries even for HTTP 429/5xx responses.
+     */
+    retryBudget?: number;
+};
+/**
+ * Shared options for all DomFi SDK client modes.
+ *
+ * Use `api: false` for an RPC-only client, or omit `api`/pass `api` options for
+ * the full client with REST reads, referrals, vault reads, and high-level actions.
+ */
+type CreateDomfiClientBaseOptions = {
+    /** Target DomFi deployment, by name, chain id, or custom chain profile. */
+    chain: DomfiChain | DomfiChainProfile;
+    /** viem-compatible public client used for reads, simulations, and receipt polling. */
+    publicClient?: PublicClient;
+    /** viem-compatible wallet client used for transaction sending. */
+    walletClient?: WalletClient;
+    /** Default wallet address for account-scoped operations. */
+    account?: Address;
+    /** Optional concurrency and retry controls. */
+    transport?: DomfiTransportOptions;
+    /** Observer hook for non-fatal SDK events. Handler failures are ignored. */
+    onEvent?: (event: DomfiEvent) => void;
+};
+/**
+ * Options for a full SDK client with REST API access enabled.
+ *
+ * Built-in mainnet and testnet profiles include default REST API URLs.
+ * Pass `api.baseUrl` to override the selected chain profile's `apiBaseUrl`.
+ */
+type CreateDomfiClientWithApiOptions = CreateDomfiClientBaseOptions & {
+    api?: ApiClientOptions;
+};
+/**
+ * Options for an RPC-only SDK client.
+ *
+ * Set `api: false` to omit REST-dependent clients such as `api`, `raw`,
+ * `actions`, `vault`, and `referrals`.
+ */
+type CreateDomfiClientNoApiOptions = CreateDomfiClientBaseOptions & {
+    api: false;
+};
+type CreateDomfiClientOptions = CreateDomfiClientWithApiOptions | CreateDomfiClientNoApiOptions;
+/** System metadata client available on API-enabled SDK clients. */
+type SystemClient = {
+    /** Returns the SDK/contract compatibility report bundled with this package. */
+    sdkCompatibility(opts?: ReadOptions): Promise<SdkCompatibilityReport>;
+    /** Reads the REST API status endpoint and maps it into the SDK result envelope. */
+    apiStatus(opts?: ReadOptions): Promise<ResultEnvelope<ApiStatus>>;
+};
+/** System metadata client available when REST API access is disabled. */
+type SystemClientNoApi = {
+    /** Returns the SDK/contract compatibility report bundled with this package. */
+    sdkCompatibility(opts?: ReadOptions): Promise<SdkCompatibilityReport>;
+};
+/**
+ * SDK client returned by `createDomfiClient` when `api: false` is used.
+ *
+ * This mode keeps onchain helpers available but intentionally omits all REST
+ * read-plane clients and high-level action helpers that depend on REST data.
+ */
+type DomfiClientNoApi = {
+    /** Resolved DomFi chain profile used by this client. */
+    chain: DomfiChainProfile;
+    /** Collateral token reads and approvals. */
+    token: TokenClient;
+    /** Delegated trading wallet helpers. */
+    delegation: DelegationClient;
+    /** RPC-backed trading preparation and sending helpers. */
+    trading: TradingClientNoApi;
+    /** RPC-only valuation helpers. */
+    valuation: ValuationClientNoApi;
+    /** SDK/system metadata helpers available without REST API access. */
+    system: SystemClientNoApi;
+};
+/**
+ * Full SDK client returned by `createDomfiClient` when REST API access is enabled.
+ *
+ * Includes REST domain reads, raw REST access, referrals, vault reads/writes,
+ * and high-level action handles in addition to onchain trading and valuation.
+ */
+type DomfiClient = {
+    /** Resolved DomFi chain profile used by this client. */
+    chain: DomfiChainProfile;
+    /** Collateral token reads and approvals. */
+    token: TokenClient;
+    /** Delegated trading wallet helpers. */
+    delegation: DelegationClient;
+    /** Trading preparation, sending, and tracking helpers. */
+    trading: TradingClient;
+    /** REST-assisted valuation helpers. */
+    valuation: ValuationClient;
+    /** SDK/system metadata helpers. */
+    system: SystemClient;
+    /** Mapped high-level REST read client. */
+    api: DomfiInfoClient;
+    /** Raw REST route client. */
+    raw: DomfiRawClient;
+    /** High-level action client that starts/stages full trading and vault flows. */
+    actions: DomfiActionsClient;
+    /** Vault reads, preparation helpers, and direct send helpers. */
+    vault: VaultClient;
+    /** Referral read helpers. */
+    referrals: ReferralClient;
+};
+/**
+ * Creates a DomFi SDK client for a DomFi deployment.
+ *
+ * Omitting `api` creates a full client with REST reads plus transaction helpers.
+ * Passing `api: false` creates an RPC-only client for preparing, sending, and
+ * tracking transactions without REST API dependencies.
+ *
+ * The returned type narrows from the `api` option: `api: false` returns
+ * `DomfiClientNoApi`; all other calls return the full `DomfiClient`.
+ *
+ * @example
+ * ```ts
+ * const domfi = createDomfiClient({ chain: "mainnet", publicClient, walletClient });
+ * await domfi.system.apiStatus();
+ * ```
+ *
+ * @example
+ * ```ts
+ * const rpcOnly = createDomfiClient({ chain: "mainnet", publicClient, api: false });
+ * await rpcOnly.trading.prepareOpenTrade(params);
+ * ```
+ *
+ * @throws {ValidationError} When the chain, API base URL, or transport options are invalid.
+ */
+declare function createDomfiClient(options: CreateDomfiClientNoApiOptions): DomfiClientNoApi;
+declare function createDomfiClient(options: CreateDomfiClientWithApiOptions): DomfiClient;
+declare function createDomfiClient<T extends CreateDomfiClientOptions>(options: T): T extends CreateDomfiClientNoApiOptions ? DomfiClientNoApi : DomfiClient;
+
+export { type ApiClientOptions, type CreateDomfiClientBaseOptions, type CreateDomfiClientNoApiOptions, type CreateDomfiClientOptions, type CreateDomfiClientWithApiOptions, DomfiChain, DomfiChainProfile, type DomfiClient, type DomfiClientNoApi, type DomfiEvent, type DomfiHttpRequest, type DomfiHttpResponse, type DomfiTransportOptions, type IRequestTransport, type SystemClient, type SystemClientNoApi, createDomfiClient };

package/dist/index.d.ts

@@ -0,0 +1,216 @@
+import { o as DomfiActionsClient } from './types-DB1r_Ppi.js';
+import { ReadinessWarningEvent, DomfiInfoClient, DomfiRawClient } from './api.js';
+import { R as ReadOptions, e as ResultEnvelope, g as ApiStatus } from './types-7s13ZSql.js';
+import { Address } from './units.js';
+import { DomfiChain, DomfiChainProfile } from './config.js';
+export { CollateralConfig, baseDomfiChain, baseSepoliaDomfiChain, domfiChains } from './config.js';
+import { P as PublicClient, b as WalletClient, c as DelegationClient, d as TradingClient, e as TradingClientNoApi } from './types-DDgJiEFg.js';
+import { DiagnosticsEnvelope } from '@domfi/sdk/errors';
+export { AbortError, ApiError, ApiErrorInit, ContractRevertError, ContractRevertErrorInit, DiagnosticsEnvelope, DomfiError, DomfiErrorCode, DomfiErrorInit, DomfiErrorKind, IdentityMismatchError, MissingAccountError, MissingApiClientError, MissingPublicClientError, MissingWalletClientError, OracleFeeCapExceededError, ProtocolCompatibilityMismatchError, ReadModelNotReadyError, TimeoutError, TransportError, TransportErrorInit, ValidationError, WalletAccountMismatchError, WalletChainMismatchError, WalletDisconnectedError, isDomfiError } from '@domfi/sdk/errors';
+import { SdkCompatibilityReport } from './contracts.js';
+import { ReferralClient } from './referrals.js';
+import { TokenClient } from './token.js';
+import { V as ValuationClient, d as ValuationClientNoApi } from './types-DhCzEwnS.js';
+import { k as VaultClient } from './types-veTDfbhq.js';
+export { Address, Brand, ClosePercent, Collateral, DecimalInput, DecimalString, FeePercent, FormatOptions, Hex, IsoTimestamp, Leverage, Notional, NumberBrandCodec, OrderId, PairIndex, Precision2Percent, Price, Ratio, RatioCodec, ScaleP2, SignedCollateral, SignedP18, SignedP6, SlippagePercent, StringBrandCodec, TimeInput, TradeId, TradeIndex, TriggerOrderIndex, TriggerOrderIndexCodec, UnitCodec, UnixMs, UnsignedP18, UsdP6, VaultAsset, VaultShare, VaultSharePrice, WholePercent, parseDecimalString } from '@domfi/sdk/units';
+import './units-BYd75H7U.js';
+import './errors.js';
+import 'viem';
+
+/** HTTP request shape passed to a custom SDK REST transport. */
+type DomfiHttpRequest = {
+    method: "GET" | "POST";
+    url: string;
+    headers?: Record<string, string>;
+    body?: string;
+    signal?: AbortSignal;
+    timeoutMs?: number;
+};
+/** HTTP response shape returned by a custom SDK REST transport. */
+type DomfiHttpResponse = {
+    status: number;
+    headers: Headers | Record<string, string>;
+    body: string;
+};
+/** Custom HTTP transport hook for REST API calls. */
+type IRequestTransport = (request: DomfiHttpRequest) => Promise<DomfiHttpResponse>;
+/** REST API configuration for API-enabled SDK clients. */
+type ApiClientOptions = {
+    /** Override the selected chain profile's REST API base URL. */
+    baseUrl?: string;
+    /** Custom HTTP request implementation for runtimes without global `fetch` or for tests. */
+    requestTransport?: IRequestTransport;
+    /** Default REST request timeout in milliseconds. */
+    defaultTimeoutMs?: number;
+};
+/** Observable REST transport event emitted through `createDomfiClient({ onEvent })`. */
+type ApiTransportEvent = {
+    type: "rest_request";
+    diagnostics: DiagnosticsEnvelope;
+    url: string;
+} | {
+    type: "rest_response";
+    diagnostics: DiagnosticsEnvelope;
+    url: string;
+    status: number;
+};
+
+/**
+ * Observable, non-fatal SDK events emitted through `createDomfiClient({ onEvent })`.
+ *
+ * Today this covers REST transport diagnostics and read-plane readiness warnings.
+ * Handler exceptions are ignored so observability code cannot change SDK behavior.
+ */
+type DomfiEvent = ApiTransportEvent | ReadinessWarningEvent;
+/**
+ * REST/RPC concurrency and retry controls for SDK-managed transport calls.
+ *
+ * These controls only wrap calls the SDK initiates. They do not change retry or
+ * batching behavior inside a user-provided viem client.
+ */
+type DomfiTransportOptions = {
+    /** Maximum number of concurrent SDK REST API requests. Must be a positive integer. */
+    maxConcurrentRest?: number;
+    /** Maximum number of concurrent SDK-issued viem public/wallet client calls. Must be a positive integer. */
+    maxConcurrentRpc?: number;
+    /**
+     * Maximum REST retry attempts per request for transient REST failures.
+     * Must be a non-negative integer. Defaults to 0, applies only to REST requests,
+     * and does not retry RPC/wallet calls. Retries use abort-aware exponential
+     * backoff with jitter and honor `Retry-After` on HTTP 429 responses.
+     * Transient REST failures are transport failures, timeouts with remaining timeout budget,
+     * HTTP 429/5xx responses, or structured API errors with retryable:true. Structured API
+     * errors with retryable:false suppress retries even for HTTP 429/5xx responses.
+     */
+    retryBudget?: number;
+};
+/**
+ * Shared options for all DomFi SDK client modes.
+ *
+ * Use `api: false` for an RPC-only client, or omit `api`/pass `api` options for
+ * the full client with REST reads, referrals, vault reads, and high-level actions.
+ */
+type CreateDomfiClientBaseOptions = {
+    /** Target DomFi deployment, by name, chain id, or custom chain profile. */
+    chain: DomfiChain | DomfiChainProfile;
+    /** viem-compatible public client used for reads, simulations, and receipt polling. */
+    publicClient?: PublicClient;
+    /** viem-compatible wallet client used for transaction sending. */
+    walletClient?: WalletClient;
+    /** Default wallet address for account-scoped operations. */
+    account?: Address;
+    /** Optional concurrency and retry controls. */
+    transport?: DomfiTransportOptions;
+    /** Observer hook for non-fatal SDK events. Handler failures are ignored. */
+    onEvent?: (event: DomfiEvent) => void;
+};
+/**
+ * Options for a full SDK client with REST API access enabled.
+ *
+ * Built-in mainnet and testnet profiles include default REST API URLs.
+ * Pass `api.baseUrl` to override the selected chain profile's `apiBaseUrl`.
+ */
+type CreateDomfiClientWithApiOptions = CreateDomfiClientBaseOptions & {
+    api?: ApiClientOptions;
+};
+/**
+ * Options for an RPC-only SDK client.
+ *
+ * Set `api: false` to omit REST-dependent clients such as `api`, `raw`,
+ * `actions`, `vault`, and `referrals`.
+ */
+type CreateDomfiClientNoApiOptions = CreateDomfiClientBaseOptions & {
+    api: false;
+};
+type CreateDomfiClientOptions = CreateDomfiClientWithApiOptions | CreateDomfiClientNoApiOptions;
+/** System metadata client available on API-enabled SDK clients. */
+type SystemClient = {
+    /** Returns the SDK/contract compatibility report bundled with this package. */
+    sdkCompatibility(opts?: ReadOptions): Promise<SdkCompatibilityReport>;
+    /** Reads the REST API status endpoint and maps it into the SDK result envelope. */
+    apiStatus(opts?: ReadOptions): Promise<ResultEnvelope<ApiStatus>>;
+};
+/** System metadata client available when REST API access is disabled. */
+type SystemClientNoApi = {
+    /** Returns the SDK/contract compatibility report bundled with this package. */
+    sdkCompatibility(opts?: ReadOptions): Promise<SdkCompatibilityReport>;
+};
+/**
+ * SDK client returned by `createDomfiClient` when `api: false` is used.
+ *
+ * This mode keeps onchain helpers available but intentionally omits all REST
+ * read-plane clients and high-level action helpers that depend on REST data.
+ */
+type DomfiClientNoApi = {
+    /** Resolved DomFi chain profile used by this client. */
+    chain: DomfiChainProfile;
+    /** Collateral token reads and approvals. */
+    token: TokenClient;
+    /** Delegated trading wallet helpers. */
+    delegation: DelegationClient;
+    /** RPC-backed trading preparation and sending helpers. */
+    trading: TradingClientNoApi;
+    /** RPC-only valuation helpers. */
+    valuation: ValuationClientNoApi;
+    /** SDK/system metadata helpers available without REST API access. */
+    system: SystemClientNoApi;
+};
+/**
+ * Full SDK client returned by `createDomfiClient` when REST API access is enabled.
+ *
+ * Includes REST domain reads, raw REST access, referrals, vault reads/writes,
+ * and high-level action handles in addition to onchain trading and valuation.
+ */
+type DomfiClient = {
+    /** Resolved DomFi chain profile used by this client. */
+    chain: DomfiChainProfile;
+    /** Collateral token reads and approvals. */
+    token: TokenClient;
+    /** Delegated trading wallet helpers. */
+    delegation: DelegationClient;
+    /** Trading preparation, sending, and tracking helpers. */
+    trading: TradingClient;
+    /** REST-assisted valuation helpers. */
+    valuation: ValuationClient;
+    /** SDK/system metadata helpers. */
+    system: SystemClient;
+    /** Mapped high-level REST read client. */
+    api: DomfiInfoClient;
+    /** Raw REST route client. */
+    raw: DomfiRawClient;
+    /** High-level action client that starts/stages full trading and vault flows. */
+    actions: DomfiActionsClient;
+    /** Vault reads, preparation helpers, and direct send helpers. */
+    vault: VaultClient;
+    /** Referral read helpers. */
+    referrals: ReferralClient;
+};
+/**
+ * Creates a DomFi SDK client for a DomFi deployment.
+ *
+ * Omitting `api` creates a full client with REST reads plus transaction helpers.
+ * Passing `api: false` creates an RPC-only client for preparing, sending, and
+ * tracking transactions without REST API dependencies.
+ *
+ * The returned type narrows from the `api` option: `api: false` returns
+ * `DomfiClientNoApi`; all other calls return the full `DomfiClient`.
+ *
+ * @example
+ * ```ts
+ * const domfi = createDomfiClient({ chain: "mainnet", publicClient, walletClient });
+ * await domfi.system.apiStatus();
+ * ```
+ *
+ * @example
+ * ```ts
+ * const rpcOnly = createDomfiClient({ chain: "mainnet", publicClient, api: false });
+ * await rpcOnly.trading.prepareOpenTrade(params);
+ * ```
+ *
+ * @throws {ValidationError} When the chain, API base URL, or transport options are invalid.
+ */
+declare function createDomfiClient(options: CreateDomfiClientNoApiOptions): DomfiClientNoApi;
+declare function createDomfiClient(options: CreateDomfiClientWithApiOptions): DomfiClient;
+declare function createDomfiClient<T extends CreateDomfiClientOptions>(options: T): T extends CreateDomfiClientNoApiOptions ? DomfiClientNoApi : DomfiClient;
+
+export { type ApiClientOptions, type CreateDomfiClientBaseOptions, type CreateDomfiClientNoApiOptions, type CreateDomfiClientOptions, type CreateDomfiClientWithApiOptions, DomfiChain, DomfiChainProfile, type DomfiClient, type DomfiClientNoApi, type DomfiEvent, type DomfiHttpRequest, type DomfiHttpResponse, type DomfiTransportOptions, type IRequestTransport, type SystemClient, type SystemClientNoApi, createDomfiClient };