@lifi/composer-sdk 0.6.1 → 0.6.3

package/src/responseSchemas.ts

@@ -123,6 +123,8 @@ export interface ServerFailedPreparedOp {
   readonly kind: string;
   readonly message: string;
   readonly path?: string;
+  readonly port?: string;
+  readonly fix?: string;
 }
 
 /** Error envelope returned on non-2xx responses. */
@@ -131,6 +133,8 @@ export interface ServerErrorBody {
     readonly kind?: string;
     readonly message?: string;
     readonly path?: string;
+    readonly port?: string;
+    readonly fix?: string;
     readonly sdkVersion?: string;
     readonly serverVersion?: string;
     readonly minimumSdkVersion?: string;
@@ -146,6 +150,8 @@ const failedPreparedOpSchema = z.object({
   kind: z.string(),
   message: z.string(),
   path: z.string().optional(),
+  port: z.string().optional(),
+  fix: z.string().optional(),
 });
 
 // `details` is passed through (`z.custom`) rather than parsed: the SDK does not
@@ -154,13 +160,17 @@ const failedPreparedOpSchema = z.object({
 //
 // `failedOps`/`succeededOps` are optional here because every error kind shares
 // this envelope; they are only populated for `preparation_error` (422). Zod
-// strips undeclared keys, so omitting them would silently drop them.
+// strips undeclared keys, so omitting them would silently drop them — which is
+// also why `port` and `fix`, set on every author-caused `validation_error`,
+// have to be declared here to reach the caller.
 const serverErrorBodySchema = z.object({
   error: z
     .object({
       kind: z.string().optional(),
       message: z.string().optional(),
       path: z.string().optional(),
+      port: z.string().optional(),
+      fix: z.string().optional(),
       sdkVersion: z.string().optional(),
       serverVersion: z.string().optional(),
       minimumSdkVersion: z.string().optional(),

package/src/sdk.ts

@@ -149,12 +149,11 @@ export interface ComposeSdk {
     run: ComposeRunInput<T>,
   ) => ComposeCompileRequest;
   /**
-   * Compiles a token pair on one chain — as of today a single zap step over
-   * one routing-catalog edge. Thin pass-through to
-   * {@link ComposeClient.route}; see it for the current single-step limit,
-   * when to prefer `flow(...).compile(...)`, the `success` / `partial`
-   * discrimination, and error behaviour. Build the `amount` with
-   * `routeAmount.exact(...)` / `routeAmount.all(...)`.
+   * Compiles a token pair on one chain into a submit-ready transaction. Thin
+   * pass-through to {@link ComposeClient.route}; see it for the short chain of
+   * catalog edges the server plans, when to prefer `flow(...).compile(...)`,
+   * the `success` / `partial` discrimination, and error behaviour. Build the
+   * `amount` with `routeAmount.exact(...)` / `routeAmount.all(...)`.
    *
    * @param request - The from/to token pair, amount, signer, and route options.
    * @returns A discriminated result: `status: 'success'` or `status: 'partial'`.