@mfxhub/sdk 0.2.2 → 0.3.0

package/CHANGELOG.md

@@ -4,6 +4,59 @@ Every release of `@mfxhub/sdk`, newest first. The format follows
 [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and versions follow
 [Semantic Versioning](https://semver.org/).
 
+## 0.3.0
+
+### Added
+
+- A terminal can be `QUEUED`: placed on a cell and waiting for its turn to start. A cell starts
+  terminals a few at a time so the ones already running are not slowed. `terminal.queue` says its
+  place, when it is expected to start (`expected_start_at`) and why it waits (a coarse `reason`).
+  `isUsable` is false for it, as for every state but ACTIVE.
+- `terminals.waitUntilActive(id, { timeoutMs })`: reads the terminal until it is no longer on its
+  way to ACTIVE. A QUEUED terminal is read again at its expected start (2 s to 1 min away), not on
+  a fixed beat.
+- `terminals.bulkRestart` and `terminals.bulkRetire` (`POST /v1/terminals:restart`,
+  `POST /v1/terminals:retire`): many terminals by farm, broker or ids, answered at once with the
+  action, what was refused and the expected finish. `getBulkAction` and `cancelBulkAction` follow
+  and cancel it.
+
+### Changed
+
+- The vendored API description is the platform's current public contract, with the queued state,
+  the queue fields and the bulk routes; the generated types follow it.
+
+### Fixed
+
+- A request path whose first segment holds a colon (`/terminals:restart`) is sent to the API. The
+  URL parser read `terminals:` as a scheme.
+
+## 0.2.4
+
+### Added
+
+- `client.tradingAccounts`: the trading accounts over every venue (`GET /v1/accounts`,
+  `GET /v1/accounts/{id}`, scope `acct:read`). `page()` and `list()` narrow by `venue`,
+  `environment` and `state` on the platform; `get(id)` takes the account's id or one of its
+  terminals' ids. An MT5 account's id is its terminal's id. The state is the venue-neutral word
+  (`CONNECTED`, `DEGRADED`, `REAUTH_NEEDED`, ...). `client.accounts` is unchanged: it is still the
+  balance, positions and deals of a terminal's account.
+
+### Changed
+
+- The vendored API description is the platform's current public contract, and the generated types
+  follow it.
+
+## 0.2.3
+
+### Added
+
+- Every HTTP attempt is timed. `new MfxClient(..., { onCall })` is told each one as a `CallTiming`
+  (`what`, `status`, `ms`; `status` is `null` when no answer came), and when the environment
+  variable `MFX_CALL_LOG` names a file, one line `{"status": 200, "ms": 12.5}` is appended to it
+  for each. A read retried after a 429 is two attempts. Nothing else is written: no path, id,
+  header or key. A listener that throws, or a file that cannot be written, never fails a call.
+  The platform's checks use it to count and time a sample's calls, as they do for the Python SDK.
+
 ## 0.2.2
 
 ### Fixed

package/dist/client.d.ts

@@ -1,10 +1,3 @@
-/**
- * `MfxClient`: one signed connection to the MFX Hub API.
- *
- * Every request is signed with the tenant's Ed25519 key. Reads that are rate limited are retried
- * after the platform's own `Retry-After`; writes are never retried, because a retried write is a
- * second order. Failures become typed errors from `errors.ts`.
- */
 import { MfxApiError } from "./errors.js";
 import { RequestSigner, type SigningKey } from "./signing.js";
 import { Accounts } from "./accounts.js";
@@ -12,10 +5,23 @@ import { Catalog } from "./catalog.js";
 import { Execution } from "./execution.js";
 import { MfxStream, type StreamOptions } from "./stream.js";
 import { Terminals } from "./terminals.js";
+import { TradingAccounts } from "./trading-accounts.js";
 /** Default time a single request may take. */
 export declare const DEFAULT_TIMEOUT_MS = 30000;
 /** How many times a rate-limited read is tried again. */
 export declare const DEFAULT_READ_RETRIES = 3;
+/** The environment variable naming a file to append one JSON line to for every HTTP attempt. */
+export declare const CALL_LOG_ENV = "MFX_CALL_LOG";
+/**
+ * One HTTP attempt the client made: what was asked, the status, and how long it took.
+ * Each attempt is a call: a read retried after a 429 is two. `status` is null when no answer came
+ * (a connection that failed, a timeout). `ms` is measured on the client's own clock.
+ */
+export interface CallTiming {
+    readonly what: string;
+    readonly status: number | null;
+    readonly ms: number;
+}
 /** What the key had left when MFX Hub last answered. */
 export interface Budget {
     readonly remaining: number;
@@ -35,6 +41,10 @@ export interface ClientOptions {
     readonly clock?: () => number;
     /** A number in [0, 1) for the backoff's jitter; replaceable in tests. */
     readonly random?: () => number;
+    /** Told each call as it ends ({@link CallTiming}); `MFX_CALL_LOG` is the same, as a file. */
+    readonly onCall?: (timing: CallTiming) => void;
+    /** A monotonic clock in milliseconds; replaceable in tests. */
+    readonly now?: () => number;
 }
 /** One request, as the resource modules describe it. */
 export interface RequestSpec {
@@ -64,6 +74,8 @@ export declare class MfxClient {
     readonly catalog: Catalog;
     /** The trading account behind a terminal: figures, positions, pending orders and deals. */
     readonly accounts: Accounts;
+    /** The trading accounts over every venue: an MT5 account, and later a cTrader one. */
+    readonly tradingAccounts: TradingAccounts;
     /**
      * @param baseUrl the API's base, including the version: `https://api.mfxhub.com/v1`, or
      *   `https://api.dev.mfxhub.com/v1` for development

package/dist/client.js

@@ -5,6 +5,7 @@
  * after the platform's own `Retry-After`; writes are never retried, because a retried write is a
  * second order. Failures become typed errors from `errors.ts`.
  */
+import { appendFileSync } from "node:fs";
 import { MfxApiError, MfxTimeout, MfxTransportError, errorFor, retryAfterSeconds, } from "./errors.js";
 import { RequestSigner } from "./signing.js";
 import { Accounts } from "./accounts.js";
@@ -12,6 +13,7 @@ import { Catalog } from "./catalog.js";
 import { Execution } from "./execution.js";
 import { MfxStream } from "./stream.js";
 import { Terminals } from "./terminals.js";
+import { TradingAccounts } from "./trading-accounts.js";
 import { USER_AGENT } from "./version.js";
 /** Default time a single request may take. */
 export const DEFAULT_TIMEOUT_MS = 30_000;
@@ -28,6 +30,8 @@ const NOT_SENT = new Set([
     "EHOSTUNREACH",
     "UND_ERR_CONNECT_TIMEOUT",
 ]);
+/** The environment variable naming a file to append one JSON line to for every HTTP attempt. */
+export const CALL_LOG_ENV = "MFX_CALL_LOG";
 const wait = (ms) => new Promise((resolve) => {
     setTimeout(resolve, ms);
 });
@@ -40,6 +44,9 @@ export class MfxClient {
     #sleep;
     #fetch;
     #random;
+    #onCall;
+    #now;
+    #callLog;
     #budget = null;
     /** The terminals this key's tenant owns. */
     terminals;
@@ -49,6 +56,8 @@ export class MfxClient {
     catalog;
     /** The trading account behind a terminal: figures, positions, pending orders and deals. */
     accounts;
+    /** The trading accounts over every venue: an MT5 account, and later a cTrader one. */
+    tradingAccounts;
     /**
      * @param baseUrl the API's base, including the version: `https://api.mfxhub.com/v1`, or
      *   `https://api.dev.mfxhub.com/v1` for development
@@ -63,10 +72,14 @@ export class MfxClient {
         this.#sleep = options.sleep ?? wait;
         this.#fetch = options.fetch ?? fetch;
         this.#random = options.random ?? Math.random;
+        this.#onCall = options.onCall;
+        this.#now = options.now ?? (() => performance.now());
+        this.#callLog = process.env[CALL_LOG_ENV] || undefined;
         this.terminals = new Terminals(this);
         this.execution = new Execution(this);
         this.catalog = new Catalog(this);
         this.accounts = new Accounts(this);
+        this.tradingAccounts = new TradingAccounts(this);
     }
     /** The id of the key this client signs with. Safe to log, unlike the private key. */
     get keyId() {
@@ -124,7 +137,9 @@ export class MfxClient {
     }
     /** One attempt, signed afresh. Transport faults become MfxTransportError or MfxTimeout. */
     async send(spec) {
-        const url = new URL(spec.path.replace(/^\//, ""), this.#base);
+        // "./" keeps a path with a colon in its first segment (`/terminals:restart`) relative: without
+        // it the URL parser reads `terminals:` as a scheme and the request leaves the API.
+        const url = new URL("./" + spec.path.replace(/^\/+/, ""), this.#base);
         for (const [name, value] of Object.entries(spec.query ?? {})) {
             if (value === null || value === undefined)
                 continue;
@@ -146,18 +161,29 @@ export class MfxClient {
             headers["Content-Type"] = "application/json";
         if (spec.idempotencyKey !== undefined)
             headers["Idempotency-Key"] = spec.idempotencyKey;
-        let response;
+        const started = this.#now();
+        let status = null;
         try {
-            response = await this.#fetch(url, {
-                method: spec.method,
-                headers,
-                ...(spec.body === undefined ? {} : { body }),
-                signal: AbortSignal.timeout(this.#timeoutMs),
-            });
+            let response;
+            try {
+                response = await this.#fetch(url, {
+                    method: spec.method,
+                    headers,
+                    ...(spec.body === undefined ? {} : { body }),
+                    signal: AbortSignal.timeout(this.#timeoutMs),
+                });
+            }
+            catch (error) {
+                throw transportError(error, spec);
+            }
+            status = response.status;
+            return await this.#answer(response);
         }
-        catch (error) {
-            throw transportError(error, spec);
+        finally {
+            this.#timed(`${spec.method} ${spec.path}`, status, started);
         }
+    }
+    async #answer(response) {
         const text = await response.text();
         this.#noteBudget(response.headers);
         let parsed = null;
@@ -171,6 +197,29 @@ export class MfxClient {
         }
         return { status: response.status, headers: response.headers, body: parsed };
     }
+    /**
+     * Hand one call's timing on. Never throws: timing is an observation, not a reason for a call
+     * that succeeded to fail. Nothing but the status and the time is written: no path, id, header
+     * or key.
+     */
+    #timed(what, status, started) {
+        const timing = { what, status, ms: this.#now() - started };
+        try {
+            this.#onCall?.(timing);
+        }
+        catch {
+            // A listener's bug must not fail the call.
+        }
+        if (this.#callLog !== undefined) {
+            try {
+                const ms = Math.round(timing.ms * 1000) / 1000;
+                appendFileSync(this.#callLog, JSON.stringify({ status, ms }) + "\n", "utf8");
+            }
+            catch {
+                // An unwritable log is no reason to fail a call.
+            }
+        }
+    }
     #noteBudget(headers) {
         const remaining = headers.get("X-MFX-Budget-Remaining");
         if (remaining !== null && Number.isFinite(Number(remaining))) {