@terminal3/t3n-sdk 4.12.0 → 4.13.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -1880,11 +1880,29 @@ declare class T3nClient {
1880
1880
  * entries. `kinds` filters by `TokenTxKind`; an empty array is
1881
1881
  * treated as "no filter".
1882
1882
  *
1883
- * Unlike {@link execute}, the body of this RPC is plaintext —
1884
- * `token.get-usage` is a session-authed read endpoint and the
1885
- * server-side handler does not run the encryption layer.
1883
+ * Like {@link getAuditEvents} / {@link execute}, this runs the
1884
+ * session-payload encryption: balance and ledger history are
1885
+ * self-only data, so the request params and response are sealed to
1886
+ * the session key rather than sent plaintext over TLS. (Transitional:
1887
+ * the node still accepts the legacy plaintext shape during the
1888
+ * staggered rollout, so a leaked `Session-Id` alone is not fully
1889
+ * de-fanged on this endpoint until the sealed shape becomes
1890
+ * mandatory.)
1886
1891
  */
1887
1892
  getUsage(opts?: GetUsageOptions): Promise<UsagePage>;
1893
+ /**
1894
+ * Fetch the caller's own credit row (`token.get-balance`).
1895
+ *
1896
+ * Like {@link getUsage} / {@link getAuditEvents}, this runs the
1897
+ * session-payload encryption: the balance is self-only data, so the
1898
+ * request (an empty sealed blob showing possession of the session
1899
+ * key) and the response are sealed to the session key rather than
1900
+ * sent plaintext over TLS. (Transitional: the node still accepts the
1901
+ * legacy plaintext shape during the staggered rollout.) Prefer this
1902
+ * over reading `getUsage().balance` when only the credit row is
1903
+ * needed.
1904
+ */
1905
+ getBalance(): Promise<BalanceRow>;
1888
1906
  /**
1889
1907
  * List the caller's discoverable contracts (`contracts.list`) — the
1890
1908
  * node-backed source for the MCP `listContracts` funnel tool.
@@ -1896,8 +1914,9 @@ declare class T3nClient {
1896
1914
  * discovery-grant gated and return a uniform, non-disclosive empty page on a
1897
1915
  * gate miss (R5 anti-enumeration).
1898
1916
  *
1899
- * Plaintext session read (like {@link getUsage}): the response carries only
1900
- * public contract-registry metadata, so it is not sealed.
1917
+ * Plaintext session read: the response carries only public
1918
+ * contract-registry metadata (no PII), so it is not sealed — unlike
1919
+ * the self-only reads {@link getUsage} / {@link getBalance}, which are.
1901
1920
  */
1902
1921
  listContracts(params?: ListContractsParams): Promise<ListContractsResult>;
1903
1922
  /**
@@ -1911,7 +1930,9 @@ declare class T3nClient {
1911
1930
  * and the verdict is uniform + non-disclosive (`disclosed:false`) when the
1912
1931
  * agent is not registered under the member (R5 anti-enumeration).
1913
1932
  *
1914
- * Plaintext session read (like {@link getUsage}).
1933
+ * Plaintext session read: the verdict is uniform and non-disclosive,
1934
+ * so it is not sealed (unlike the self-only reads {@link getUsage} /
1935
+ * {@link getBalance}).
1915
1936
  */
1916
1937
  checkDelegation(params: GrantCheckParams): Promise<GrantCheckResult>;
1917
1938
  /**
@@ -2458,8 +2479,10 @@ declare class T3nClient {
2458
2479
  /**
2459
2480
  * Send a session-authenticated JSON-RPC request with plaintext
2460
2481
  * params/result (no SessionEncryption layer). Used for tenant-facing
2461
- * read endpoints (`token.get-balance`, `token.get-usage`) where the
2462
- * server-side handler reads the JSON envelope directly.
2482
+ * read endpoints whose payloads carry only public / non-disclosive
2483
+ * metadata (`contracts.list`, `delegation.check`) where the
2484
+ * server-side handler reads the JSON envelope directly. (The token
2485
+ * self-reads moved to the sealed path — see {@link getUsage}.)
2463
2486
  *
2464
2487
  * Auto-attaches the `Session-Id` header; surfaces JSON-RPC errors
2465
2488
  * the same way as {@link sendRpcRequest} (typed