@pafi-dev/issuer 0.5.4 → 0.5.5

package/dist/index.d.cts

@@ -1,5 +1,5 @@
 import { Address, Hex, PublicClient, WalletClient } from 'viem';
-import { PointTokenDomainConfig, PartialUserOperation, BurnRequest, ReceiverConsent, PathKey, PoolKey } from '@pafi-dev/core';
+import { PointTokenDomainConfig, PartialUserOperation, BurnRequest, PoolKey } from '@pafi-dev/core';
 
 /**
  * Lifecycle of a minting request as tracked by the issuer's point ledger.
@@ -802,6 +802,12 @@ interface ApiConfigResponse {
 }
 interface ApiNonceResponse {
     nonce: string;
+    /**
+     * Complete EIP-4361 message, ready to pass directly to `wallet.signMessage()`.
+     * Built by the controller using `createLoginMessage()` — requires the caller's
+     * `walletAddress`, so it cannot be constructed inside the handler itself.
+     */
+    message?: string;
 }
 interface ApiLoginRequest {
     message: string;
@@ -854,32 +860,46 @@ interface ApiUserResponse {
     balance: bigint;
     isMinter: boolean;
 }
-/** @deprecated Since 0.3.0 — use `ApiClaimRequest` (mint-only) instead. Removed in 2.0. */
-interface ApiClaimAndSwapRequest {
-    chainId: number;
-    pointTokenAddress: Address;
-    /**
-     * EIP-712 domain for the point token. Frontends read this once (via
-     * `PafiSDK.getDomain()` or a direct contract call) and include it on
-     * every claim request so the backend doesn't need to re-read it.
-     */
-    domain: PointTokenDomainConfig;
-    /** The full signed ReceiverConsent message. */
-    receiverConsent: ReceiverConsent;
-    /** Detached EIP-712 signature (`serialized` form from `@pafi/core`). */
-    receiverSignature: Hex;
-    /** Swap hop(s) from pointToken → USDT. */
-    swapPath: PathKey[];
-    /** Unix seconds. */
-    swapDeadline: bigint;
-}
-/** @deprecated Since 0.3.0 — use `ApiClaimResponse` instead. Removed in 2.0. */
-interface ApiClaimAndSwapResponse {
-    txHash: Hex;
+interface ApiRedeemRequest {
+    userAddress: Address;
+    /** PT amount to burn. */
+    amount: bigint;
+    /** ERC-4337 account nonce for the user's EOA. */
+    aaNonce: bigint;
+}
+interface ApiRedeemResponse {
+    /** Pending credit lock id — poll `/user` to track PENDING → CREDITED. */
     lockId: string;
-    blockNumber?: bigint;
-    gasUsed?: bigint;
+    /** Unsigned UserOp — attach paymaster data + user signature, then submit. */
+    userOp: PartialUserOperation;
+    /** Seconds until the pending credit lock expires if the burn doesn't land. */
+    expiresInSeconds: number;
+    /** BurnRequest deadline (unix seconds) — FE can surface a countdown. */
+    signatureDeadline: bigint;
 }
+interface ApiTopUpRequest {
+    userAddress: Address;
+    /** Total points the voucher requires off-chain. */
+    requiredAmount: bigint;
+    /** ERC-4337 account nonce for the user's EOA. */
+    aaNonce: bigint;
+}
+type ApiTopUpResponse = {
+    /** Off-chain balance already covers the required amount — no burn needed. */
+    action: "NO_TOP_UP_NEEDED";
+    offChainBalance: bigint;
+} | {
+    /** Combined off-chain + on-chain is still insufficient — cannot fulfill. */
+    action: "INSUFFICIENT_ONCHAIN";
+    offChainBalance: bigint;
+    onChainBalance: bigint;
+    shortfall: bigint;
+} | {
+    /** Burn of `shortfall` PT initiated — FE submits the returned UserOp. */
+    action: "TOP_UP_STARTED";
+    shortfall: bigint;
+    redeem: ApiRedeemResponse;
+};
 interface ApiClaimRequest {
     chainId: number;
     pointTokenAddress: Address;
@@ -901,27 +921,6 @@ interface ApiClaimResponse {
     /** Seconds until the off-chain lock expires if the UserOp is not submitted. */
     expiresInSeconds: number;
 }
-interface ApiBuildConsentTypedDataRequest {
-    chainId: number;
-    pointTokenAddress: Address;
-    receiverConsent: ReceiverConsent;
-}
-interface ApiBuildConsentTypedDataResponse {
-    typedData: {
-        domain: {
-            name: string;
-            version: string;
-            chainId: number;
-            verifyingContract: Address;
-        };
-        types: Record<string, {
-            name: string;
-            type: string;
-        }[]>;
-        primaryType: string;
-        message: Record<string, unknown>;
-    };
-}
 type PoolsProvider = (request: ApiPoolsRequest) => Promise<ApiPoolsResponse>;
 
 interface IssuerApiHandlersConfig {
@@ -1023,20 +1022,6 @@ declare class IssuerApiHandlers {
      * balance.
      */
     handleUser(userAddress: Address, request: ApiUserRequest): Promise<ApiUserResponse>;
-    /**
-     * `POST /build-consent-typed-data`
-     *
-     * Backend builds the full EIP-712 typed data payload for a
-     * ReceiverConsent message. The domain (name, version, chainId,
-     * verifyingContract) is read from the PointToken contract — mobile
-     * never needs to know or hardcode these values. Forward the
-     * response directly to `wallet.signTypedData()`.
-     *
-     * This ensures a single source of truth for domain + types, and
-     * makes contract upgrades (domain version bump) transparent to
-     * mobile apps — no app store review needed.
-     */
-    handleBuildConsentTypedData(userAddress: Address, request: ApiBuildConsentTypedDataRequest): Promise<ApiBuildConsentTypedDataResponse>;
     /**
      * `POST /claim`
      *
@@ -1587,4 +1572,4 @@ declare function createIssuerService(config: IssuerServiceConfig): IssuerService
 /** SDK package version — bumped on every release */
 declare const PAFI_ISSUER_SDK_VERSION = "0.4.0";
 
-export { type ApiBuildConsentTypedDataRequest, type ApiBuildConsentTypedDataResponse, type ApiClaimAndSwapRequest, type ApiClaimAndSwapResponse, type ApiClaimRequest, type ApiClaimResponse, type ApiConfigResponse, type ApiGasFeeResponse, type ApiLoginRequest, type ApiLoginResponse, type ApiNonceResponse, type ApiPoolsRequest, type ApiPoolsResponse, type ApiUserRequest, type ApiUserResponse, type AuthContext, AuthError, type AuthErrorCode, AuthService, type AuthServiceConfig, BalanceAggregator, type BalanceAggregatorConfig, type BurnEvent, BurnIndexer, type BurnIndexerConfig, type CombinedBalance, DefaultPolicyEngine, type DefaultPolicyEngineOptions, FeeManager, type FeeManagerConfig, type IIndexerCursorStore, type IPointLedger, type IPolicyEngine, type ISessionStore, InMemoryCursorStore, IssuerApiHandlers, type IssuerApiHandlersConfig, type IssuerService, type IssuerServiceConfig, type LockedMintRequest, type LoginResult, MemorySessionStore, type MemorySessionStoreOptions, type MintEvent, type MintingStatus, NonceManager, PAFI_ISSUER_SDK_VERSION, PAFI_SUBGRAPH_URL, PTRedeemError, PTRedeemHandler, type PTRedeemHandlerConfig, type PTRedeemRequest, type PTRedeemResponse, PafiBackendClient, type PafiBackendConfig, PafiBackendError, type PafiBackendErrorCode, PointIndexer, type PointIndexerConfig, type PolicyDecision, type PolicyEvalRequest, type PoolsProvider, type PrepareBurnDirectParams, type PrepareBurnParams, type PrepareBurnWithSigParams, type PrepareMintParams, RelayError, type RelayErrorCode, RelayService, type RetryConfig, type Session, type SponsorshipRequest, type SponsorshipResponse, type SponsorshipTarget, type SponsorshipUserOp, type SubgraphNativeUsdtQuoterConfig, type SubgraphPoolsProviderConfig, TopUpRedemptionError, TopUpRedemptionHandler, type TopUpRedemptionHandlerConfig, type TopUpRedemptionRequest, type TopUpRedemptionResponse, authenticateRequest, createIssuerService, createSubgraphNativeUsdtQuoter, createSubgraphPoolsProvider };
+export { type ApiClaimRequest, type ApiClaimResponse, type ApiConfigResponse, type ApiGasFeeResponse, type ApiLoginRequest, type ApiLoginResponse, type ApiNonceResponse, type ApiPoolsRequest, type ApiPoolsResponse, type ApiRedeemRequest, type ApiRedeemResponse, type ApiTopUpRequest, type ApiTopUpResponse, type ApiUserRequest, type ApiUserResponse, type AuthContext, AuthError, type AuthErrorCode, AuthService, type AuthServiceConfig, BalanceAggregator, type BalanceAggregatorConfig, type BurnEvent, BurnIndexer, type BurnIndexerConfig, type CombinedBalance, DefaultPolicyEngine, type DefaultPolicyEngineOptions, FeeManager, type FeeManagerConfig, type IIndexerCursorStore, type IPointLedger, type IPolicyEngine, type ISessionStore, InMemoryCursorStore, IssuerApiHandlers, type IssuerApiHandlersConfig, type IssuerService, type IssuerServiceConfig, type LockedMintRequest, type LoginResult, MemorySessionStore, type MemorySessionStoreOptions, type MintEvent, type MintingStatus, NonceManager, PAFI_ISSUER_SDK_VERSION, PAFI_SUBGRAPH_URL, PTRedeemError, PTRedeemHandler, type PTRedeemHandlerConfig, type PTRedeemRequest, type PTRedeemResponse, PafiBackendClient, type PafiBackendConfig, PafiBackendError, type PafiBackendErrorCode, PointIndexer, type PointIndexerConfig, type PolicyDecision, type PolicyEvalRequest, type PoolsProvider, type PrepareBurnDirectParams, type PrepareBurnParams, type PrepareBurnWithSigParams, type PrepareMintParams, RelayError, type RelayErrorCode, RelayService, type RetryConfig, type Session, type SponsorshipRequest, type SponsorshipResponse, type SponsorshipTarget, type SponsorshipUserOp, type SubgraphNativeUsdtQuoterConfig, type SubgraphPoolsProviderConfig, TopUpRedemptionError, TopUpRedemptionHandler, type TopUpRedemptionHandlerConfig, type TopUpRedemptionRequest, type TopUpRedemptionResponse, authenticateRequest, createIssuerService, createSubgraphNativeUsdtQuoter, createSubgraphPoolsProvider };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { Address, Hex, PublicClient, WalletClient } from 'viem';
-import { PointTokenDomainConfig, PartialUserOperation, BurnRequest, ReceiverConsent, PathKey, PoolKey } from '@pafi-dev/core';
+import { PointTokenDomainConfig, PartialUserOperation, BurnRequest, PoolKey } from '@pafi-dev/core';
 
 /**
  * Lifecycle of a minting request as tracked by the issuer's point ledger.
@@ -802,6 +802,12 @@ interface ApiConfigResponse {
 }
 interface ApiNonceResponse {
     nonce: string;
+    /**
+     * Complete EIP-4361 message, ready to pass directly to `wallet.signMessage()`.
+     * Built by the controller using `createLoginMessage()` — requires the caller's
+     * `walletAddress`, so it cannot be constructed inside the handler itself.
+     */
+    message?: string;
 }
 interface ApiLoginRequest {
     message: string;
@@ -854,32 +860,46 @@ interface ApiUserResponse {
     balance: bigint;
     isMinter: boolean;
 }
-/** @deprecated Since 0.3.0 — use `ApiClaimRequest` (mint-only) instead. Removed in 2.0. */
-interface ApiClaimAndSwapRequest {
-    chainId: number;
-    pointTokenAddress: Address;
-    /**
-     * EIP-712 domain for the point token. Frontends read this once (via
-     * `PafiSDK.getDomain()` or a direct contract call) and include it on
-     * every claim request so the backend doesn't need to re-read it.
-     */
-    domain: PointTokenDomainConfig;
-    /** The full signed ReceiverConsent message. */
-    receiverConsent: ReceiverConsent;
-    /** Detached EIP-712 signature (`serialized` form from `@pafi/core`). */
-    receiverSignature: Hex;
-    /** Swap hop(s) from pointToken → USDT. */
-    swapPath: PathKey[];
-    /** Unix seconds. */
-    swapDeadline: bigint;
-}
-/** @deprecated Since 0.3.0 — use `ApiClaimResponse` instead. Removed in 2.0. */
-interface ApiClaimAndSwapResponse {
-    txHash: Hex;
+interface ApiRedeemRequest {
+    userAddress: Address;
+    /** PT amount to burn. */
+    amount: bigint;
+    /** ERC-4337 account nonce for the user's EOA. */
+    aaNonce: bigint;
+}
+interface ApiRedeemResponse {
+    /** Pending credit lock id — poll `/user` to track PENDING → CREDITED. */
     lockId: string;
-    blockNumber?: bigint;
-    gasUsed?: bigint;
+    /** Unsigned UserOp — attach paymaster data + user signature, then submit. */
+    userOp: PartialUserOperation;
+    /** Seconds until the pending credit lock expires if the burn doesn't land. */
+    expiresInSeconds: number;
+    /** BurnRequest deadline (unix seconds) — FE can surface a countdown. */
+    signatureDeadline: bigint;
 }
+interface ApiTopUpRequest {
+    userAddress: Address;
+    /** Total points the voucher requires off-chain. */
+    requiredAmount: bigint;
+    /** ERC-4337 account nonce for the user's EOA. */
+    aaNonce: bigint;
+}
+type ApiTopUpResponse = {
+    /** Off-chain balance already covers the required amount — no burn needed. */
+    action: "NO_TOP_UP_NEEDED";
+    offChainBalance: bigint;
+} | {
+    /** Combined off-chain + on-chain is still insufficient — cannot fulfill. */
+    action: "INSUFFICIENT_ONCHAIN";
+    offChainBalance: bigint;
+    onChainBalance: bigint;
+    shortfall: bigint;
+} | {
+    /** Burn of `shortfall` PT initiated — FE submits the returned UserOp. */
+    action: "TOP_UP_STARTED";
+    shortfall: bigint;
+    redeem: ApiRedeemResponse;
+};
 interface ApiClaimRequest {
     chainId: number;
     pointTokenAddress: Address;
@@ -901,27 +921,6 @@ interface ApiClaimResponse {
     /** Seconds until the off-chain lock expires if the UserOp is not submitted. */
     expiresInSeconds: number;
 }
-interface ApiBuildConsentTypedDataRequest {
-    chainId: number;
-    pointTokenAddress: Address;
-    receiverConsent: ReceiverConsent;
-}
-interface ApiBuildConsentTypedDataResponse {
-    typedData: {
-        domain: {
-            name: string;
-            version: string;
-            chainId: number;
-            verifyingContract: Address;
-        };
-        types: Record<string, {
-            name: string;
-            type: string;
-        }[]>;
-        primaryType: string;
-        message: Record<string, unknown>;
-    };
-}
 type PoolsProvider = (request: ApiPoolsRequest) => Promise<ApiPoolsResponse>;
 
 interface IssuerApiHandlersConfig {
@@ -1023,20 +1022,6 @@ declare class IssuerApiHandlers {
      * balance.
      */
     handleUser(userAddress: Address, request: ApiUserRequest): Promise<ApiUserResponse>;
-    /**
-     * `POST /build-consent-typed-data`
-     *
-     * Backend builds the full EIP-712 typed data payload for a
-     * ReceiverConsent message. The domain (name, version, chainId,
-     * verifyingContract) is read from the PointToken contract — mobile
-     * never needs to know or hardcode these values. Forward the
-     * response directly to `wallet.signTypedData()`.
-     *
-     * This ensures a single source of truth for domain + types, and
-     * makes contract upgrades (domain version bump) transparent to
-     * mobile apps — no app store review needed.
-     */
-    handleBuildConsentTypedData(userAddress: Address, request: ApiBuildConsentTypedDataRequest): Promise<ApiBuildConsentTypedDataResponse>;
     /**
      * `POST /claim`
      *
@@ -1587,4 +1572,4 @@ declare function createIssuerService(config: IssuerServiceConfig): IssuerService
 /** SDK package version — bumped on every release */
 declare const PAFI_ISSUER_SDK_VERSION = "0.4.0";
 
-export { type ApiBuildConsentTypedDataRequest, type ApiBuildConsentTypedDataResponse, type ApiClaimAndSwapRequest, type ApiClaimAndSwapResponse, type ApiClaimRequest, type ApiClaimResponse, type ApiConfigResponse, type ApiGasFeeResponse, type ApiLoginRequest, type ApiLoginResponse, type ApiNonceResponse, type ApiPoolsRequest, type ApiPoolsResponse, type ApiUserRequest, type ApiUserResponse, type AuthContext, AuthError, type AuthErrorCode, AuthService, type AuthServiceConfig, BalanceAggregator, type BalanceAggregatorConfig, type BurnEvent, BurnIndexer, type BurnIndexerConfig, type CombinedBalance, DefaultPolicyEngine, type DefaultPolicyEngineOptions, FeeManager, type FeeManagerConfig, type IIndexerCursorStore, type IPointLedger, type IPolicyEngine, type ISessionStore, InMemoryCursorStore, IssuerApiHandlers, type IssuerApiHandlersConfig, type IssuerService, type IssuerServiceConfig, type LockedMintRequest, type LoginResult, MemorySessionStore, type MemorySessionStoreOptions, type MintEvent, type MintingStatus, NonceManager, PAFI_ISSUER_SDK_VERSION, PAFI_SUBGRAPH_URL, PTRedeemError, PTRedeemHandler, type PTRedeemHandlerConfig, type PTRedeemRequest, type PTRedeemResponse, PafiBackendClient, type PafiBackendConfig, PafiBackendError, type PafiBackendErrorCode, PointIndexer, type PointIndexerConfig, type PolicyDecision, type PolicyEvalRequest, type PoolsProvider, type PrepareBurnDirectParams, type PrepareBurnParams, type PrepareBurnWithSigParams, type PrepareMintParams, RelayError, type RelayErrorCode, RelayService, type RetryConfig, type Session, type SponsorshipRequest, type SponsorshipResponse, type SponsorshipTarget, type SponsorshipUserOp, type SubgraphNativeUsdtQuoterConfig, type SubgraphPoolsProviderConfig, TopUpRedemptionError, TopUpRedemptionHandler, type TopUpRedemptionHandlerConfig, type TopUpRedemptionRequest, type TopUpRedemptionResponse, authenticateRequest, createIssuerService, createSubgraphNativeUsdtQuoter, createSubgraphPoolsProvider };
+export { type ApiClaimRequest, type ApiClaimResponse, type ApiConfigResponse, type ApiGasFeeResponse, type ApiLoginRequest, type ApiLoginResponse, type ApiNonceResponse, type ApiPoolsRequest, type ApiPoolsResponse, type ApiRedeemRequest, type ApiRedeemResponse, type ApiTopUpRequest, type ApiTopUpResponse, type ApiUserRequest, type ApiUserResponse, type AuthContext, AuthError, type AuthErrorCode, AuthService, type AuthServiceConfig, BalanceAggregator, type BalanceAggregatorConfig, type BurnEvent, BurnIndexer, type BurnIndexerConfig, type CombinedBalance, DefaultPolicyEngine, type DefaultPolicyEngineOptions, FeeManager, type FeeManagerConfig, type IIndexerCursorStore, type IPointLedger, type IPolicyEngine, type ISessionStore, InMemoryCursorStore, IssuerApiHandlers, type IssuerApiHandlersConfig, type IssuerService, type IssuerServiceConfig, type LockedMintRequest, type LoginResult, MemorySessionStore, type MemorySessionStoreOptions, type MintEvent, type MintingStatus, NonceManager, PAFI_ISSUER_SDK_VERSION, PAFI_SUBGRAPH_URL, PTRedeemError, PTRedeemHandler, type PTRedeemHandlerConfig, type PTRedeemRequest, type PTRedeemResponse, PafiBackendClient, type PafiBackendConfig, PafiBackendError, type PafiBackendErrorCode, PointIndexer, type PointIndexerConfig, type PolicyDecision, type PolicyEvalRequest, type PoolsProvider, type PrepareBurnDirectParams, type PrepareBurnParams, type PrepareBurnWithSigParams, type PrepareMintParams, RelayError, type RelayErrorCode, RelayService, type RetryConfig, type Session, type SponsorshipRequest, type SponsorshipResponse, type SponsorshipTarget, type SponsorshipUserOp, type SubgraphNativeUsdtQuoterConfig, type SubgraphPoolsProviderConfig, TopUpRedemptionError, TopUpRedemptionHandler, type TopUpRedemptionHandlerConfig, type TopUpRedemptionRequest, type TopUpRedemptionResponse, authenticateRequest, createIssuerService, createSubgraphNativeUsdtQuoter, createSubgraphPoolsProvider };

package/dist/index.js

@@ -983,8 +983,7 @@ import {
   getPointTokenBalance,
   getReceiverConsentNonce,
   getTokenName,
-  isMinter,
-  buildReceiverConsentTypedData
+  isMinter
 } from "@pafi-dev/core";
 var IssuerApiHandlers = class {
   authService;
@@ -1152,60 +1151,6 @@ var IssuerApiHandlers = class {
       isMinter: minter
     };
   }
-  /**
-   * `POST /build-consent-typed-data`
-   *
-   * Backend builds the full EIP-712 typed data payload for a
-   * ReceiverConsent message. The domain (name, version, chainId,
-   * verifyingContract) is read from the PointToken contract — mobile
-   * never needs to know or hardcode these values. Forward the
-   * response directly to `wallet.signTypedData()`.
-   *
-   * This ensures a single source of truth for domain + types, and
-   * makes contract upgrades (domain version bump) transparent to
-   * mobile apps — no app store review needed.
-   */
-  async handleBuildConsentTypedData(userAddress, request) {
-    if (request.chainId !== this.chainId) {
-      throw new Error(
-        `handleBuildConsentTypedData: unsupported chainId ${request.chainId}`
-      );
-    }
-    const pointToken = getAddress5(request.pointTokenAddress);
-    if (!this.supportedTokens.has(pointToken)) {
-      throw new Error(
-        `handleBuildConsentTypedData: unsupported pointToken ${pointToken}`
-      );
-    }
-    const consent = request.receiverConsent;
-    if (getAddress5(consent.originalReceiver) !== getAddress5(userAddress)) {
-      throw new Error(
-        "handleBuildConsentTypedData: receiverConsent.originalReceiver must match authenticated user"
-      );
-    }
-    if (consent.amount <= 0n) {
-      throw new Error("handleBuildConsentTypedData: amount must be positive");
-    }
-    const nowSecs = BigInt(Math.floor(Date.now() / 1e3));
-    if (consent.deadline <= nowSecs) {
-      throw new Error("handleBuildConsentTypedData: deadline is in the past");
-    }
-    const name = await getTokenName(this.provider, pointToken);
-    const domain = {
-      name,
-      verifyingContract: pointToken,
-      chainId: this.chainId
-    };
-    const typedData = buildReceiverConsentTypedData(domain, consent);
-    return {
-      typedData: {
-        domain: typedData.domain,
-        types: typedData.types,
-        primaryType: typedData.primaryType,
-        message: typedData.message
-      }
-    };
-  }
   /**
    * `POST /claim`
    *