@relayprotocol/relay-sdk 5.2.2 → 5.2.3

package/_types/src/utils/prepareBatchTransaction.d.ts

@@ -1,5 +1,27 @@
 import type { Execute } from '../types/Execute.js';
+/**
+ * Returns true when the step sequence can be collapsed into a single atomic
+ * batch transaction.
+ *
+ * Supported shapes:
+ *   [approve, swap | deposit]                     // standard 2-step flow
+ *   [approve, approve, swap | deposit]            // zero-reset flow (e.g. USDT on Ethereum)
+ *   [approve, ..., approve, swap | deposit]       // N leading approvals + terminal
+ *
+ * Every item in every step must be incomplete — any already-executed item
+ * means we're in the middle of a partial run and should not re-batch.
+ */
 export declare function canBatchTransactions(steps: Execute['steps']): boolean;
+/**
+ * Flattens N approval steps + terminal (swap|deposit) step into a single
+ * batched step whose items will be submitted together via EIP-5792
+ * `wallet_sendCalls`.
+ *
+ * The first item stays `incomplete` so the executeSteps iterator picks it as
+ * the active step item; all subsequent items are pre-marked `complete` so the
+ * iterator doesn't try to execute them again as separate transactions after
+ * the batch lands.
+ */
 export declare function prepareBatchTransaction(steps: Execute['steps']): {
     id: any;
     action: string;

package/_types/src/utils/prepareBatchTransaction.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"prepareBatchTransaction.d.ts","sourceRoot":"","sources":["../../../src/utils/prepareBatchTransaction.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAA;AAElD,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,WAiB3D;AAED,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAqB9D"}
+{"version":3,"file":"prepareBatchTransaction.d.ts","sourceRoot":"","sources":["../../../src/utils/prepareBatchTransaction.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAA;AAElD;;;;;;;;;;;GAWG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,WAmB3D;AAED;;;;;;;;;GASG;AACH,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAwB9D"}

package/_types/src/version.d.ts

@@ -1,2 +1,2 @@
-export declare const SDK_VERSION = "5.2.2";
+export declare const SDK_VERSION = "5.2.3";
 //# sourceMappingURL=version.d.ts.map