@shroud-fi/relayer 0.1.0

package/dist/esm/types.d.ts

@@ -0,0 +1,88 @@
+import type { Address, Hex } from 'viem';
+/**
+ * Gelato task identifier returned by `sponsoredCallERC2771`.
+ * Opaque string the SDK uses to poll status.
+ */
+export type GelatoTaskId = string;
+/**
+ * Terminal + in-flight states the SDK surfaces to the caller.
+ * Mapped from Gelato's `TaskState` plus our own `'submitted'` initial state.
+ */
+export type RelayerSweepStatus = 'submitted' | 'pending' | 'success' | 'failed' | 'cancelled';
+/**
+ * EIP-2612 permit signature components plus deadline.
+ * `v / r / s` are passed verbatim to `sweepERC20WithPermit`.
+ *
+ * Privacy: never log or serialize this struct — the signature is a
+ * spending-authorization credential equivalent to a one-time approval.
+ */
+export interface Eip2612PermitSignature {
+    readonly v: number;
+    readonly r: Hex;
+    readonly s: Hex;
+    readonly deadline: bigint;
+}
+/**
+ * Optional runtime overrides for {@link relayedSweepERC20}.
+ *
+ * All fields are optional; omitted fields use defaults from `constants.ts`.
+ *
+ * Privacy: `gelatoApiKey` is forwarded only to the Gelato adapter and never
+ * logged. The caller is responsible for sourcing it securely.
+ */
+export interface RelayerSweepOptions {
+    /** Override the EIP-2612 permit deadline lifetime in seconds. */
+    readonly deadlineSecs?: bigint;
+    /** Override poll interval (ms) for Gelato task status. */
+    readonly pollIntervalMs?: number;
+    /** Override hard timeout (ms) for the polling loop. */
+    readonly pollTimeoutMs?: number;
+    /**
+     * Optional Gelato 1Balance sponsor API key. The Gelato SDK requires a
+     * non-empty string for sponsored calls; pass it here for production.
+     */
+    readonly gelatoApiKey?: string;
+    /** Cancellation token. Aborts polling early. */
+    readonly signal?: AbortSignal;
+}
+/**
+ * Receipt for a completed relayed sweep.
+ *
+ * Privacy invariant: NO `amount` / `feeAmount` / `netAmount` fields.
+ * The caller can read pre-/post-sweep balances independently if it needs
+ * those values; the SDK never returns plaintext amounts.
+ */
+export interface RelayerSweepReceipt {
+    readonly taskId: GelatoTaskId;
+    readonly txHash: Hex;
+    readonly status: RelayerSweepStatus;
+    readonly relayerContract: Address;
+    readonly token: Address;
+    readonly destination: Address;
+    readonly blockNumber?: bigint;
+}
+/**
+ * Optional runtime overrides for {@link relayedSweepETH}.
+ */
+export interface RelayedEthSweepOptions {
+    /** Override the EIP-712 EthSweep deadline lifetime in seconds. */
+    readonly deadlineSecs?: bigint;
+    /** Override hard timeout (ms) for waitForTransactionReceipt. */
+    readonly pollTimeoutMs?: number;
+    /** Cancellation token. Forwarded to fetch + receipt polling. */
+    readonly signal?: AbortSignal;
+}
+/**
+ * Receipt for a completed ETH gasless sweep.
+ *
+ * Same privacy invariant as {@link RelayerSweepReceipt}: NO amount fields.
+ */
+export interface RelayedEthSweepReceipt {
+    readonly txHash: Hex;
+    readonly status: 'success';
+    readonly blockNumber: bigint;
+    readonly ethRelayerContract: Address;
+    readonly destination: Address;
+    readonly stealthAddress: Address;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/esm/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAEzC;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC;AAElC;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAC1B,WAAW,GACX,SAAS,GACT,SAAS,GACT,QAAQ,GACR,WAAW,CAAC;AAEhB;;;;;;GAMG;AACH,MAAM,WAAW,sBAAsB;IACrC,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC;IAChB,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC;IAChB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;CAC3B;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,mBAAmB;IAClC,iEAAiE;IACjE,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAC/B,0DAA0D;IAC1D,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IACjC,uDAAuD;IACvD,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAChC;;;OAGG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAC/B,gDAAgD;IAChD,QAAQ,CAAC,MAAM,CAAC,EAAE,WAAW,CAAC;CAC/B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC;IAC9B,QAAQ,CAAC,MAAM,EAAE,GAAG,CAAC;IACrB,QAAQ,CAAC,MAAM,EAAE,kBAAkB,CAAC;IACpC,QAAQ,CAAC,eAAe,EAAE,OAAO,CAAC;IAClC,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;IACxB,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC;IAC9B,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CAC/B;AAID;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,kEAAkE;IAClE,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAC/B,gEAAgE;IAChE,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAChC,gEAAgE;IAChE,QAAQ,CAAC,MAAM,CAAC,EAAE,WAAW,CAAC;CAC/B;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC,QAAQ,CAAC,MAAM,EAAE,GAAG,CAAC;IACrB,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC;IAC3B,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,kBAAkB,EAAE,OAAO,CAAC;IACrC,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC;IAC9B,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAC;CAClC"}

package/dist/esm/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/esm/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":""}