@pafi-dev/core 0.1.2 → 0.3.0-alpha.0

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import { Address, WalletClient, PublicClient, Hex } from 'viem';
+import { Address, Hex, PublicClient, WalletClient } from 'viem';
 import { P as PoolKey, C as ChainConfig, a as PafiSDKConfig, b as PointTokenDomainConfig, M as MintRequest, R as ReceiverConsent, E as EIP712Signature, S as SignatureVerification, c as MintParams, d as SwapParams, B as BestQuote, Q as QuoteResult, e as PathKey } from './types-CkRJzrZr.cjs';
 export { I as Issuer } from './types-CkRJzrZr.cjs';
 export { erc20Abi, issuerRegistryAbi, mintingOracleAbi, permit2Abi, pointTokenAbi, pointTokenFactoryAbi, relayAbi, universalRouterAbi, v4QuoterAbi } from './abi/index.cjs';
@@ -74,6 +74,275 @@ declare class ApiError extends PafiSDKError {
     constructor(message: string, status?: number | undefined);
 }
 
+/**
+ * ERC-4337 v0.7 EntryPoint standard address (deployed deterministically
+ * at the same address across chains).
+ * https://eips.ethereum.org/EIPS/eip-4337
+ */
+declare const ENTRY_POINT_V07: Address;
+/**
+ * A single call inside a batch. `BatchExecutor.execute(Call[])` iterates
+ * and invokes each one. When the batch runs via EIP-7702 delegation,
+ * `msg.sender` for each call is the user's EOA.
+ */
+interface Operation {
+    target: Address;
+    value: bigint;
+    data: Hex;
+}
+/**
+ * Paymaster fields attached to a UserOperation. Populated by the
+ * Coinbase Paymaster (via PAFI Backend proxy) before the user signs.
+ */
+interface PaymasterFields {
+    paymaster: Address;
+    paymasterData: Hex;
+    paymasterVerificationGasLimit: bigint;
+    paymasterPostOpGasLimit: bigint;
+}
+/**
+ * Partial UserOp used during preparation — before paymaster fields are
+ * attached or the user signs.
+ */
+interface PartialUserOperation {
+    sender: Address;
+    nonce: bigint;
+    callData: Hex;
+    callGasLimit: bigint;
+    verificationGasLimit: bigint;
+    preVerificationGas: bigint;
+    maxFeePerGas: bigint;
+    maxPriorityFeePerGas: bigint;
+}
+/**
+ * Full ERC-4337 v0.7 UserOperation, ready for bundler submission.
+ */
+interface UserOperation extends PartialUserOperation {
+    paymaster: Address;
+    paymasterData: Hex;
+    paymasterVerificationGasLimit: bigint;
+    paymasterPostOpGasLimit: bigint;
+    signature: Hex;
+}
+/**
+ * Receipt returned by a bundler after a UserOp lands on-chain.
+ */
+interface UserOpReceipt {
+    userOpHash: Hex;
+    success: boolean;
+    txHash: Hex;
+    blockNumber: bigint;
+    gasUsed: bigint;
+    /** Effective gas cost paid (wei). */
+    actualGasCost: bigint;
+}
+/**
+ * Sentinel operation value used in tests + docs when `Operation.value`
+ * is irrelevant (ERC-20 transfers, for example).
+ */
+declare const ZERO_VALUE = 0n;
+
+/**
+ * Build an ERC-20 `transfer(to, amount)` operation. Used inside a batch
+ * to move fee tokens from the user to the fee recipient atomically with
+ * the main action.
+ */
+declare function erc20TransferOp(token: Address, to: Address, amount: bigint): Operation;
+/**
+ * Build an ERC-20 `approve(spender, amount)` operation. Used inside a
+ * batch before a swap / deposit call so the AMM / protocol can pull
+ * tokens from the user.
+ */
+declare function erc20ApproveOp(token: Address, spender: Address, amount: bigint): Operation;
+/**
+ * Build an ERC-20 `burn(amount)` operation (OpenZeppelin ERC20Burnable
+ * extension). Burns from `msg.sender`, which — via EIP-7702 — is the
+ * user's EOA.
+ *
+ * Requires the PointToken contract to expose a public `burn(uint256)`
+ * without a role check. See
+ * [SDK_V1.4_TASKS.md §11 — PointToken.burn callable via batch].
+ */
+declare function erc20BurnOp(token: Address, amount: bigint): Operation;
+/**
+ * Build a raw call operation with caller-supplied calldata. Useful for
+ * non-ERC-20 contracts (PoolManager.swap, PerpDEX.deposit, Relayer.mint)
+ * where the encoding is specific to that protocol.
+ */
+declare function rawCallOp(target: Address, data: `0x${string}`, value?: bigint): Operation;
+
+/**
+ * Standard BatchExecutor ABI — a contract that takes an array of calls
+ * and invokes each one in sequence, reverting all if any fail.
+ *
+ * Compatible with OpenZeppelin `Account.execute(Call[])`, Biconomy
+ * `executeBatch`, Safe `MultiSend`, and most EIP-7702 delegation
+ * targets. The exact deployed address is supplied by the infra team
+ * (see [V1.4_V1.5_READINESS.md B2]).
+ */
+declare const BATCH_EXECUTOR_ABI: readonly [{
+    readonly name: "execute";
+    readonly type: "function";
+    readonly stateMutability: "nonpayable";
+    readonly inputs: readonly [{
+        readonly type: "tuple[]";
+        readonly components: readonly [{
+            readonly type: "address";
+            readonly name: "target";
+        }, {
+            readonly type: "uint256";
+            readonly name: "value";
+        }, {
+            readonly type: "bytes";
+            readonly name: "data";
+        }];
+        readonly name: "calls";
+    }];
+    readonly outputs: readonly [];
+}];
+/**
+ * Encode a batch of operations into calldata for `BatchExecutor.execute()`.
+ * The resulting calldata goes into `UserOperation.callData`.
+ *
+ * When the EOA has an EIP-7702 delegation to a BatchExecutor, calling
+ * this calldata against the EOA runs all operations with
+ * `msg.sender = EOA` for each inner call.
+ *
+ * @param operations batch of calls, in execution order
+ * @returns calldata bytes for `execute((address,uint256,bytes)[])`
+ */
+declare function encodeBatchExecute(operations: Operation[]): Hex;
+
+interface BuildPartialUserOpParams {
+    /** User's EOA (with EIP-7702 delegation). */
+    sender: Address;
+    /** Batch of operations — encoded into callData via `encodeBatchExecute`. */
+    operations: Operation[];
+    /** EntryPoint nonce for this sender. Caller fetches from the EntryPoint contract. */
+    nonce: bigint;
+    /** Optional gas overrides; bundler re-estimates before submission. */
+    gasLimits?: {
+        callGasLimit?: bigint;
+        verificationGasLimit?: bigint;
+        preVerificationGas?: bigint;
+    };
+    /** Optional fee overrides; bundler usually fills these. */
+    feeOverrides?: {
+        maxFeePerGas?: bigint;
+        maxPriorityFeePerGas?: bigint;
+    };
+}
+/**
+ * Build a partial ERC-4337 UserOperation from a batch of operations.
+ * Paymaster fields and signature are populated later:
+ *   1. Call `PafiBackendClient.requestSponsorship()` → get paymaster fields
+ *   2. Compute userOpHash and have the user sign it (via Privy)
+ *   3. Attach `signature` → submit to bundler
+ *
+ * This function is a pure struct builder — no network calls.
+ */
+declare function buildPartialUserOperation(params: BuildPartialUserOpParams): PartialUserOperation;
+/**
+ * Assemble a full UserOperation once paymaster fields + signature are
+ * known. Used after `PafiBackendClient.requestSponsorship()` and user
+ * signing complete.
+ */
+declare function assembleUserOperation(partial: PartialUserOperation, paymaster: {
+    paymaster: Address;
+    paymasterData: `0x${string}`;
+    paymasterVerificationGasLimit: bigint;
+    paymasterPostOpGasLimit: bigint;
+}, signature: `0x${string}`): UserOperation;
+
+/**
+ * Module-level paymaster config shared by all batch builders and the
+ * `@pafi/issuer` RelayService. Holds the fee recipient address and the
+ * PAFI-assigned issuer identity.
+ *
+ * v1.4 update: the paymaster endpoint is **PAFI Backend**, which proxies
+ * to Coinbase Paymaster. See [SPONSORED_PATH_FLOW.md].
+ */
+interface PaymasterConfig {
+    /**
+     * PAFI Backend API base URL. Example:
+     *   https://api.pacificfinance.org/paymaster
+     */
+    pafiBackendUrl: string;
+    /** PAFI-assigned issuer ID. Passed in X-Issuer-Id header. */
+    issuerId: string;
+    /** Per-issuer API key (or JWT) for Authorization header. */
+    apiKey: string;
+    /**
+     * Where the fee transfer lands inside the batch call. Fee recovery is
+     * application-level — Paymaster sponsors gas, fee is a separate
+     * ERC-20 transfer inside the batch that reimburses the issuer.
+     */
+    feeRecipient: Address;
+    /** EIP-4337 EntryPoint address. Default: v0.7 (same across chains). */
+    entryPoint?: Address;
+    /** Chain ID the paymaster sponsors on. Defaults to consumer config. */
+    chainId?: number;
+}
+/**
+ * Which PAFI-defined scenario this UserOp represents. PAFI Backend
+ * validates the request's target contracts + function selectors
+ * match the expected pattern for the scenario.
+ */
+type SponsorshipScenario = "mint" | "burn" | "swap" | "perp-deposit";
+
+/**
+ * Set the application-wide paymaster config. Safe to call multiple
+ * times (later calls override earlier). Throws if required fields
+ * are missing.
+ */
+declare function setPaymasterConfig(config: PaymasterConfig): void;
+/**
+ * Get the current paymaster config. Throws if `setPaymasterConfig()`
+ * has not been called yet — this surfaces boot-order bugs early
+ * instead of failing with "paymaster.feeRecipient is undefined" at
+ * the point of use.
+ */
+declare function getPaymasterConfig(): PaymasterConfig;
+/** Test helper — clear the singleton. */
+declare function _resetPaymasterConfigForTests(): void;
+/** Check whether paymaster config has been initialized. */
+declare function isPaymasterConfigured(): boolean;
+
+/**
+ * Submission path chosen by `checkEthAndBranch`.
+ * - `normal`: initiator has enough ETH; submit via `walletClient.writeContract`
+ *   or a plain `eth_sendRawTransaction`. No paymaster round-trip.
+ * - `paymaster`: initiator doesn't have enough ETH; wrap the batch as a
+ *   UserOperation and route through PAFI Backend → Coinbase Paymaster
+ *   → Bundler.
+ */
+type SubmissionPath = "normal" | "paymaster";
+interface CheckEthAndBranchParams {
+    /** viem PublicClient bound to the target chain. */
+    client: PublicClient;
+    /** The address whose ETH balance we check. */
+    initiator: Address;
+    /** Estimated gas cost in wei for the upcoming tx. */
+    estimatedGasWei: bigint;
+    /**
+     * Optional safety margin multiplier (basis points). Defaults to
+     * 11_000 (110%) — the initiator needs 10% above the estimate to
+     * qualify for the normal path. Prevents edge cases where gas price
+     * spikes between estimation and submission cause a "has enough"
+     * decision to fail at broadcast time.
+     */
+    marginBps?: number;
+}
+/**
+ * Step 3 of the Generalized Flow ([SPONSORED_PATH_FLOW.md §2]):
+ * choose between the normal path (initiator pays ETH directly) and the
+ * paymaster path (bundler + Coinbase Paymaster).
+ *
+ * Intentionally synchronous in spirit — the only network call is
+ * `getBalance`. Callers can parallelize it with other reads.
+ */
+declare function checkEthAndBranch(params: CheckEthAndBranchParams): Promise<SubmissionPath>;
+
 declare class PafiSDK {
     private _pointTokenAddress?;
     private _relayContractAddress?;
@@ -236,4 +505,4 @@ declare class PafiSDK {
     signLoginMessage(message: string): Promise<Hex>;
 }
 
-export { ApiError, BestQuote, COMMON_POOLS, COMMON_TOKENS, ChainConfig, ConfigurationError, EIP712Signature, LoginMessageParams, MintParams, MintRequest, POINT_TOKEN_POOLS, PafiSDK, PafiSDKConfig, PafiSDKError, PathKey, PointTokenDomainConfig, PoolKey, QuoteResult, ReceiverConsent, SUPPORTED_CHAINS, SignatureVerification, SigningError, SimulationError, SimulationResult, SwapParams, SwapSimulationResult, UNIVERSAL_ROUTER_ADDRESSES, V4_QUOTER_ADDRESSES, mintRequestTypes, receiverConsentTypes };
+export { ApiError, BATCH_EXECUTOR_ABI, BestQuote, type BuildPartialUserOpParams, COMMON_POOLS, COMMON_TOKENS, ChainConfig, type CheckEthAndBranchParams, ConfigurationError, EIP712Signature, ENTRY_POINT_V07, LoginMessageParams, MintParams, MintRequest, type Operation, POINT_TOKEN_POOLS, PafiSDK, PafiSDKConfig, PafiSDKError, type PartialUserOperation, PathKey, type PaymasterConfig, type PaymasterFields, PointTokenDomainConfig, PoolKey, QuoteResult, ReceiverConsent, SUPPORTED_CHAINS, SignatureVerification, SigningError, SimulationError, SimulationResult, type SponsorshipScenario, type SubmissionPath, SwapParams, SwapSimulationResult, UNIVERSAL_ROUTER_ADDRESSES, type UserOpReceipt, type UserOperation, V4_QUOTER_ADDRESSES, ZERO_VALUE, _resetPaymasterConfigForTests, assembleUserOperation, buildPartialUserOperation, checkEthAndBranch, encodeBatchExecute, erc20ApproveOp, erc20BurnOp, erc20TransferOp, getPaymasterConfig, isPaymasterConfigured, mintRequestTypes, rawCallOp, receiverConsentTypes, setPaymasterConfig };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { Address, WalletClient, PublicClient, Hex } from 'viem';
+import { Address, Hex, PublicClient, WalletClient } from 'viem';
 import { P as PoolKey, C as ChainConfig, a as PafiSDKConfig, b as PointTokenDomainConfig, M as MintRequest, R as ReceiverConsent, E as EIP712Signature, S as SignatureVerification, c as MintParams, d as SwapParams, B as BestQuote, Q as QuoteResult, e as PathKey } from './types-CkRJzrZr.js';
 export { I as Issuer } from './types-CkRJzrZr.js';
 export { erc20Abi, issuerRegistryAbi, mintingOracleAbi, permit2Abi, pointTokenAbi, pointTokenFactoryAbi, relayAbi, universalRouterAbi, v4QuoterAbi } from './abi/index.js';
@@ -74,6 +74,275 @@ declare class ApiError extends PafiSDKError {
     constructor(message: string, status?: number | undefined);
 }
 
+/**
+ * ERC-4337 v0.7 EntryPoint standard address (deployed deterministically
+ * at the same address across chains).
+ * https://eips.ethereum.org/EIPS/eip-4337
+ */
+declare const ENTRY_POINT_V07: Address;
+/**
+ * A single call inside a batch. `BatchExecutor.execute(Call[])` iterates
+ * and invokes each one. When the batch runs via EIP-7702 delegation,
+ * `msg.sender` for each call is the user's EOA.
+ */
+interface Operation {
+    target: Address;
+    value: bigint;
+    data: Hex;
+}
+/**
+ * Paymaster fields attached to a UserOperation. Populated by the
+ * Coinbase Paymaster (via PAFI Backend proxy) before the user signs.
+ */
+interface PaymasterFields {
+    paymaster: Address;
+    paymasterData: Hex;
+    paymasterVerificationGasLimit: bigint;
+    paymasterPostOpGasLimit: bigint;
+}
+/**
+ * Partial UserOp used during preparation — before paymaster fields are
+ * attached or the user signs.
+ */
+interface PartialUserOperation {
+    sender: Address;
+    nonce: bigint;
+    callData: Hex;
+    callGasLimit: bigint;
+    verificationGasLimit: bigint;
+    preVerificationGas: bigint;
+    maxFeePerGas: bigint;
+    maxPriorityFeePerGas: bigint;
+}
+/**
+ * Full ERC-4337 v0.7 UserOperation, ready for bundler submission.
+ */
+interface UserOperation extends PartialUserOperation {
+    paymaster: Address;
+    paymasterData: Hex;
+    paymasterVerificationGasLimit: bigint;
+    paymasterPostOpGasLimit: bigint;
+    signature: Hex;
+}
+/**
+ * Receipt returned by a bundler after a UserOp lands on-chain.
+ */
+interface UserOpReceipt {
+    userOpHash: Hex;
+    success: boolean;
+    txHash: Hex;
+    blockNumber: bigint;
+    gasUsed: bigint;
+    /** Effective gas cost paid (wei). */
+    actualGasCost: bigint;
+}
+/**
+ * Sentinel operation value used in tests + docs when `Operation.value`
+ * is irrelevant (ERC-20 transfers, for example).
+ */
+declare const ZERO_VALUE = 0n;
+
+/**
+ * Build an ERC-20 `transfer(to, amount)` operation. Used inside a batch
+ * to move fee tokens from the user to the fee recipient atomically with
+ * the main action.
+ */
+declare function erc20TransferOp(token: Address, to: Address, amount: bigint): Operation;
+/**
+ * Build an ERC-20 `approve(spender, amount)` operation. Used inside a
+ * batch before a swap / deposit call so the AMM / protocol can pull
+ * tokens from the user.
+ */
+declare function erc20ApproveOp(token: Address, spender: Address, amount: bigint): Operation;
+/**
+ * Build an ERC-20 `burn(amount)` operation (OpenZeppelin ERC20Burnable
+ * extension). Burns from `msg.sender`, which — via EIP-7702 — is the
+ * user's EOA.
+ *
+ * Requires the PointToken contract to expose a public `burn(uint256)`
+ * without a role check. See
+ * [SDK_V1.4_TASKS.md §11 — PointToken.burn callable via batch].
+ */
+declare function erc20BurnOp(token: Address, amount: bigint): Operation;
+/**
+ * Build a raw call operation with caller-supplied calldata. Useful for
+ * non-ERC-20 contracts (PoolManager.swap, PerpDEX.deposit, Relayer.mint)
+ * where the encoding is specific to that protocol.
+ */
+declare function rawCallOp(target: Address, data: `0x${string}`, value?: bigint): Operation;
+
+/**
+ * Standard BatchExecutor ABI — a contract that takes an array of calls
+ * and invokes each one in sequence, reverting all if any fail.
+ *
+ * Compatible with OpenZeppelin `Account.execute(Call[])`, Biconomy
+ * `executeBatch`, Safe `MultiSend`, and most EIP-7702 delegation
+ * targets. The exact deployed address is supplied by the infra team
+ * (see [V1.4_V1.5_READINESS.md B2]).
+ */
+declare const BATCH_EXECUTOR_ABI: readonly [{
+    readonly name: "execute";
+    readonly type: "function";
+    readonly stateMutability: "nonpayable";
+    readonly inputs: readonly [{
+        readonly type: "tuple[]";
+        readonly components: readonly [{
+            readonly type: "address";
+            readonly name: "target";
+        }, {
+            readonly type: "uint256";
+            readonly name: "value";
+        }, {
+            readonly type: "bytes";
+            readonly name: "data";
+        }];
+        readonly name: "calls";
+    }];
+    readonly outputs: readonly [];
+}];
+/**
+ * Encode a batch of operations into calldata for `BatchExecutor.execute()`.
+ * The resulting calldata goes into `UserOperation.callData`.
+ *
+ * When the EOA has an EIP-7702 delegation to a BatchExecutor, calling
+ * this calldata against the EOA runs all operations with
+ * `msg.sender = EOA` for each inner call.
+ *
+ * @param operations batch of calls, in execution order
+ * @returns calldata bytes for `execute((address,uint256,bytes)[])`
+ */
+declare function encodeBatchExecute(operations: Operation[]): Hex;
+
+interface BuildPartialUserOpParams {
+    /** User's EOA (with EIP-7702 delegation). */
+    sender: Address;
+    /** Batch of operations — encoded into callData via `encodeBatchExecute`. */
+    operations: Operation[];
+    /** EntryPoint nonce for this sender. Caller fetches from the EntryPoint contract. */
+    nonce: bigint;
+    /** Optional gas overrides; bundler re-estimates before submission. */
+    gasLimits?: {
+        callGasLimit?: bigint;
+        verificationGasLimit?: bigint;
+        preVerificationGas?: bigint;
+    };
+    /** Optional fee overrides; bundler usually fills these. */
+    feeOverrides?: {
+        maxFeePerGas?: bigint;
+        maxPriorityFeePerGas?: bigint;
+    };
+}
+/**
+ * Build a partial ERC-4337 UserOperation from a batch of operations.
+ * Paymaster fields and signature are populated later:
+ *   1. Call `PafiBackendClient.requestSponsorship()` → get paymaster fields
+ *   2. Compute userOpHash and have the user sign it (via Privy)
+ *   3. Attach `signature` → submit to bundler
+ *
+ * This function is a pure struct builder — no network calls.
+ */
+declare function buildPartialUserOperation(params: BuildPartialUserOpParams): PartialUserOperation;
+/**
+ * Assemble a full UserOperation once paymaster fields + signature are
+ * known. Used after `PafiBackendClient.requestSponsorship()` and user
+ * signing complete.
+ */
+declare function assembleUserOperation(partial: PartialUserOperation, paymaster: {
+    paymaster: Address;
+    paymasterData: `0x${string}`;
+    paymasterVerificationGasLimit: bigint;
+    paymasterPostOpGasLimit: bigint;
+}, signature: `0x${string}`): UserOperation;
+
+/**
+ * Module-level paymaster config shared by all batch builders and the
+ * `@pafi/issuer` RelayService. Holds the fee recipient address and the
+ * PAFI-assigned issuer identity.
+ *
+ * v1.4 update: the paymaster endpoint is **PAFI Backend**, which proxies
+ * to Coinbase Paymaster. See [SPONSORED_PATH_FLOW.md].
+ */
+interface PaymasterConfig {
+    /**
+     * PAFI Backend API base URL. Example:
+     *   https://api.pacificfinance.org/paymaster
+     */
+    pafiBackendUrl: string;
+    /** PAFI-assigned issuer ID. Passed in X-Issuer-Id header. */
+    issuerId: string;
+    /** Per-issuer API key (or JWT) for Authorization header. */
+    apiKey: string;
+    /**
+     * Where the fee transfer lands inside the batch call. Fee recovery is
+     * application-level — Paymaster sponsors gas, fee is a separate
+     * ERC-20 transfer inside the batch that reimburses the issuer.
+     */
+    feeRecipient: Address;
+    /** EIP-4337 EntryPoint address. Default: v0.7 (same across chains). */
+    entryPoint?: Address;
+    /** Chain ID the paymaster sponsors on. Defaults to consumer config. */
+    chainId?: number;
+}
+/**
+ * Which PAFI-defined scenario this UserOp represents. PAFI Backend
+ * validates the request's target contracts + function selectors
+ * match the expected pattern for the scenario.
+ */
+type SponsorshipScenario = "mint" | "burn" | "swap" | "perp-deposit";
+
+/**
+ * Set the application-wide paymaster config. Safe to call multiple
+ * times (later calls override earlier). Throws if required fields
+ * are missing.
+ */
+declare function setPaymasterConfig(config: PaymasterConfig): void;
+/**
+ * Get the current paymaster config. Throws if `setPaymasterConfig()`
+ * has not been called yet — this surfaces boot-order bugs early
+ * instead of failing with "paymaster.feeRecipient is undefined" at
+ * the point of use.
+ */
+declare function getPaymasterConfig(): PaymasterConfig;
+/** Test helper — clear the singleton. */
+declare function _resetPaymasterConfigForTests(): void;
+/** Check whether paymaster config has been initialized. */
+declare function isPaymasterConfigured(): boolean;
+
+/**
+ * Submission path chosen by `checkEthAndBranch`.
+ * - `normal`: initiator has enough ETH; submit via `walletClient.writeContract`
+ *   or a plain `eth_sendRawTransaction`. No paymaster round-trip.
+ * - `paymaster`: initiator doesn't have enough ETH; wrap the batch as a
+ *   UserOperation and route through PAFI Backend → Coinbase Paymaster
+ *   → Bundler.
+ */
+type SubmissionPath = "normal" | "paymaster";
+interface CheckEthAndBranchParams {
+    /** viem PublicClient bound to the target chain. */
+    client: PublicClient;
+    /** The address whose ETH balance we check. */
+    initiator: Address;
+    /** Estimated gas cost in wei for the upcoming tx. */
+    estimatedGasWei: bigint;
+    /**
+     * Optional safety margin multiplier (basis points). Defaults to
+     * 11_000 (110%) — the initiator needs 10% above the estimate to
+     * qualify for the normal path. Prevents edge cases where gas price
+     * spikes between estimation and submission cause a "has enough"
+     * decision to fail at broadcast time.
+     */
+    marginBps?: number;
+}
+/**
+ * Step 3 of the Generalized Flow ([SPONSORED_PATH_FLOW.md §2]):
+ * choose between the normal path (initiator pays ETH directly) and the
+ * paymaster path (bundler + Coinbase Paymaster).
+ *
+ * Intentionally synchronous in spirit — the only network call is
+ * `getBalance`. Callers can parallelize it with other reads.
+ */
+declare function checkEthAndBranch(params: CheckEthAndBranchParams): Promise<SubmissionPath>;
+
 declare class PafiSDK {
     private _pointTokenAddress?;
     private _relayContractAddress?;
@@ -236,4 +505,4 @@ declare class PafiSDK {
     signLoginMessage(message: string): Promise<Hex>;
 }
 
-export { ApiError, BestQuote, COMMON_POOLS, COMMON_TOKENS, ChainConfig, ConfigurationError, EIP712Signature, LoginMessageParams, MintParams, MintRequest, POINT_TOKEN_POOLS, PafiSDK, PafiSDKConfig, PafiSDKError, PathKey, PointTokenDomainConfig, PoolKey, QuoteResult, ReceiverConsent, SUPPORTED_CHAINS, SignatureVerification, SigningError, SimulationError, SimulationResult, SwapParams, SwapSimulationResult, UNIVERSAL_ROUTER_ADDRESSES, V4_QUOTER_ADDRESSES, mintRequestTypes, receiverConsentTypes };
+export { ApiError, BATCH_EXECUTOR_ABI, BestQuote, type BuildPartialUserOpParams, COMMON_POOLS, COMMON_TOKENS, ChainConfig, type CheckEthAndBranchParams, ConfigurationError, EIP712Signature, ENTRY_POINT_V07, LoginMessageParams, MintParams, MintRequest, type Operation, POINT_TOKEN_POOLS, PafiSDK, PafiSDKConfig, PafiSDKError, type PartialUserOperation, PathKey, type PaymasterConfig, type PaymasterFields, PointTokenDomainConfig, PoolKey, QuoteResult, ReceiverConsent, SUPPORTED_CHAINS, SignatureVerification, SigningError, SimulationError, SimulationResult, type SponsorshipScenario, type SubmissionPath, SwapParams, SwapSimulationResult, UNIVERSAL_ROUTER_ADDRESSES, type UserOpReceipt, type UserOperation, V4_QUOTER_ADDRESSES, ZERO_VALUE, _resetPaymasterConfigForTests, assembleUserOperation, buildPartialUserOperation, checkEthAndBranch, encodeBatchExecute, erc20ApproveOp, erc20BurnOp, erc20TransferOp, getPaymasterConfig, isPaymasterConfigured, mintRequestTypes, rawCallOp, receiverConsentTypes, setPaymasterConfig };