Client configuration

Build a client with polyester.New(Config{...}) and pass Environment: &polyester.TestnetEnvironment: a Config without it does not target Testnet. Defaults target API-key trading applications. Unary ConnectRPC responses are limited to 4 MiB after decompression.

Recommended constructor

accountID := "..." // Profile → Account ID
client, err := polyester.New(polyester.Config{
    Environment:      &polyester.TestnetEnvironment,
    APIKeyID:         "ak_...",
    APIPrivateKey:    auth.NewSecret("..."), // 64-char hex from key creation
    DefaultAccountID: &accountID,
    HydrateCatalogs:  true,
    // APIURL: "https://api.testnet.polyester.com",
    // WSURL:  "wss://api.testnet.polyester.com",
    // Timeout: 10 * time.Second,
    // WireFormat: "binary", // or "json"
    // DefaultSubAccountID: &subID,
})
if err != nil { log.Fatal(err) }
defer client.Close()
if err := client.WaitForCatalogs(ctx); err != nil { log.Fatal(err) }

Config fields

• Environment: API, WebSocket, RPC, and contract pins. Pass &polyester.TestnetEnvironment.
• APIKeyID / APIPrivateKey: Required for private RPCs / private WS. Default: empty. APIPrivateKey is an auth.Secret: build it with auth.NewSecret(hexKey) and read it back with cfg.APIPrivateKey.Reveal(). Printing a Config with any fmt verb, or encoding it with encoding/json, encoding/xml or the log/slog JSON handler, writes [REDACTED] for the key; gob refuses to encode it. Decoding a JSON Config still reads APIPrivateKey.
• APIURL: ConnectRPC base override. Default: from Environment.
• WSURL: Centrifugo WebSocket override. Default: from Environment.
• DefaultAccountID: Private channel scoping. Default: unset / env fallback.
• DefaultSubAccountID: Default trading scope. Default: unset.
• Timeout: HTTP timeout. Default: 10s.
• WireFormat: "binary" or "json". Default: binary.
• HydrateCatalogs: Background spot + Zipper hydrate. Default: false in zero Config; set true for bots.
• HTTPClient: Optional custom *http.Client. Default: SDK default.

FromEnv sets HydrateCatalogs: true before applying overrides.

Aliases

FromEnv

polyester.FromEnv() loads:

• POLYESTER_API_KEY_ID
• POLYESTER_API_PRIVATE_KEY
• POLYESTER_ACCOUNT_ID (optional)
• POLYESTER_ENV, set to testnet (without it, the client does not target Testnet)
• POLYESTER_API_URL / POLYESTER_WS_URL (optional overrides)

Override funcs run after these values load. Prefer explicit Config in production.

Related

• Authentication
• Catalog
• Realtime

Related Topics