Client configuration

PolyesterClient

new PolyesterClient(config: PolyesterClientConfig)

Properties: one lazy getter per service (auth, accounts, apiKeys, subaccounts, candles, chainAnalytics, marketData, marketOverview, orderbook, heatmap, lifecycle, trades, orders, triggers, balances, transfers, internalTransfers, tradingWithdraws, deposit, addressBook, guardSigner, socialVerification, whiteboard, zipper, mfa), plus realtime (the shared RealtimeClient) and catalog (the ClientCatalog).

Auth providers

interface JwtAuthProvider {
	kind: "jwt";
	getToken: () => string | null | Promise<string | null>;
}

interface ApiKeyEd25519AuthProvider {
	kind: "api-key-ed25519";
	getKeyId: () => string | null | Promise<string | null>;
	getSecretKey: () => Uint8Array | null | Promise<Uint8Array | null>; // 32-byte secret
}

PolyesterBrowserClient

new PolyesterBrowserClient(config: PolyesterBrowserClientConfig)

Extends the base config (minus auth, which it manages) with:

Additional members: auth is narrowed to AccountSignerAuthService (login/logout/sessions/events — see the Account services reference), and setAccountSigner(signer | null) swaps the signer at runtime.

Token storage implementations:

createMemoryAuthTokenStorage(initialToken?)
createCookieAuthTokenStorage({ cookieName?, path?, secure?, sameSite? })

PolyesterServerClient

new PolyesterServerClient(config: PolyesterServerClientConfig)

Extends the base config with:

Members: session, hasAuthProvider, hasBearerToken, hasUsableBearerToken, hasDisplaySession, and verifySession(): Promise<Me | null>.

Factories

createPolyesterServerClientFromRequest({ environment, request, ...baseOptions })
createPolyesterServerClientFromCookies({ environment, cookies, ...baseOptions })

Both parse the session cookies, attach a JWT provider when a valid bearer token is present, and return a configured PolyesterServerClient. Related helpers: parseSessionCookie(cookies, environment), getBearerTokenFromCookies(cookies, environment), and the exported cookie-name constants POLYESTER_AUTH_TOKEN_COOKIE_NAME / POLYESTER_SESSION_COOKIE_NAME.

Request options

Every service method takes an options object as its last parameter:

interface PolyesterRequestOptions {
	signal?: AbortSignal; // cancel the request
}

interface PolyesterMutationOptions extends PolyesterRequestOptions {
	stepUpToken?: string | null; // MFA fresh step-up proof (sent as X-Auth-Step-Up)
}

Reads take PolyesterRequestOptions; mutations take PolyesterMutationOptions.

Environments

POLYESTER_TESTNET_ENVIRONMENT: PolyesterEnvironment
createPolyesterEnvironment(params: CreatePolyesterEnvironmentParams): PolyesterEnvironment

See Environments for the full parameter reference and validation rules.

Package entry points

Utilities (root export)