@terminal3/t3n-sdk 3.12.5 → 3.12.7

package/dist/index.d.ts

@@ -3148,7 +3148,16 @@ declare function verifyDkgAttestation(encapsKeyB64: string, attestationMsgB64: s
  */
 
 /**
- * Validate SDK configuration
+ * Validate the shape of an {@link SdkConfig}-like object.
+ *
+ * Checks that `config` is an object with:
+ * - `environment` — a string that is one of {@link VALID_ENVS};
+ * - `nodeUrl` — a string beginning with `http://` or `https://`;
+ * - `version` — a non-empty string.
+ *
+ * Returns `{ valid, errors }`: `valid` is `true` only when `errors` is empty;
+ * `errors` collects one human-readable message per failed check (it does not
+ * throw). Pairs with {@link loadConfig}, whose output always validates.
  */
 declare function validateConfig(config: unknown): ConfigValidationResult;
 
@@ -3248,6 +3257,18 @@ interface TenantClientConfig {
     environment?: TenantSdkEnvironment;
     /** Node URL for `getScriptVersion` during business contract execution. Falls back to `baseUrl`. */
     endpoint?: string;
+    /**
+     * Authenticated base client the TenantClient dispatches RPCs through.
+     * **Optional**, but required by every operation that issues a control or
+     * business RPC: all `tenant.*` and `maps.*` helpers,
+     * `contracts.register`/`publish`/`disable`/`enable`/`unregister`/`execute`,
+     * and `token.getUsage` (which additionally needs a full authenticated
+     * `T3nClient` exposing `getUsage`). Those throw
+     * `"TenantClient config requires t3n ..."` at call time when it is absent.
+     * Operations that do NOT need `t3n`: `admitForOrg` (signed cluster-admin call
+     * over `fetch`), `executeBusinessContract` (dispatches through the `session`
+     * argument), and pure config accessors such as `getEnvironment`.
+     */
     t3n?: TenantBaseClient;
     baseUrl?: string;
     tenantDid?: string;