@pafi-dev/core 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,239 @@
+import { Address, WalletClient, PublicClient, Hex } 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';
+export { buildDomain, buildMintRequestTypedData, buildReceiverConsentTypedData, signMintRequest, signReceiverConsent, verifyMintRequest, verifyReceiverConsent } from './eip712/index.cjs';
+import { SimulationResult } from './relay/index.cjs';
+export { buildRelaySwapParams, decodeExtData, decodeMintAndSwap, encodeExtData, encodeMintAndSwap, simulateMintAndSwap } from './relay/index.cjs';
+export { getIssuer, getMintRequestNonce, getPointTokenIssuer, getPointTokenIssuerAddress, getReceiverConsentNonce, getTokenName, getUsdt, isActiveIssuer, isMinter, verifyMintCap } from './contract/index.cjs';
+export { buildAllPaths, combineRoutes, findBestQuote, quoteBestRoute, quoteExactInput, quoteExactInputSingle } from './quoting/index.cjs';
+import { SwapSimulationResult } from './swap/index.cjs';
+export { SETTLE_ALL, SWAP_EXACT_IN, TAKE_ALL, V4_SWAP, buildErc20ApprovalCalldata, buildPermit2ApprovalCalldata, buildSwapFromQuote, buildUniversalRouterExecuteArgs, buildV4SwapInput, checkAllowance, simulateSwap } from './swap/index.cjs';
+import { LoginMessageParams } from './auth/index.cjs';
+export { VerifyLoginResult, createLoginMessage, parseLoginMessage, verifyLoginMessage } from './auth/index.cjs';
+
+declare const mintRequestTypes: {
+    readonly MintRequest: readonly [{
+        readonly name: "to";
+        readonly type: "address";
+    }, {
+        readonly name: "amount";
+        readonly type: "uint256";
+    }, {
+        readonly name: "nonce";
+        readonly type: "uint256";
+    }, {
+        readonly name: "deadline";
+        readonly type: "uint256";
+    }];
+};
+declare const receiverConsentTypes: {
+    readonly ReceiverConsent: readonly [{
+        readonly name: "onBehalfOf";
+        readonly type: "address";
+    }, {
+        readonly name: "originalReceiver";
+        readonly type: "address";
+    }, {
+        readonly name: "amount";
+        readonly type: "uint256";
+    }, {
+        readonly name: "nonce";
+        readonly type: "uint256";
+    }, {
+        readonly name: "deadline";
+        readonly type: "uint256";
+    }, {
+        readonly name: "extData";
+        readonly type: "bytes";
+    }];
+};
+declare const SUPPORTED_CHAINS: Record<number, ChainConfig>;
+declare const V4_QUOTER_ADDRESSES: Record<number, Address>;
+declare const UNIVERSAL_ROUTER_ADDRESSES: Record<number, Address>;
+declare const COMMON_TOKENS: Record<number, Record<string, Address>>;
+declare const COMMON_POOLS: Record<number, PoolKey[]>;
+declare const POINT_TOKEN_POOLS: Record<number, Record<Address, PoolKey[]>>;
+
+declare class PafiSDKError extends Error {
+    constructor(message: string);
+}
+declare class ConfigurationError extends PafiSDKError {
+    constructor(message: string);
+}
+declare class SigningError extends PafiSDKError {
+    constructor(message: string);
+}
+declare class SimulationError extends PafiSDKError {
+    operation: string;
+    reason: string;
+    constructor(operation: string, reason: string);
+}
+declare class ApiError extends PafiSDKError {
+    status?: number | undefined;
+    constructor(message: string, status?: number | undefined);
+}
+
+declare class PafiSDK {
+    private _pointTokenAddress?;
+    private _relayContractAddress?;
+    private _signer?;
+    private _provider?;
+    private _chainId?;
+    constructor(config: PafiSDKConfig);
+    setPointTokenAddress(address: Address): void;
+    setRelayContractAddress(address: Address): void;
+    setSigner(signer: WalletClient): void;
+    setProvider(provider: PublicClient): void;
+    private requirePointToken;
+    private requireProvider;
+    private requireSigner;
+    private requireChainId;
+    getDomain(): Promise<PointTokenDomainConfig>;
+    /**
+     * Build the EIP-712 typed data for a MintRequest.
+     * Pass the result to any external signer (Privy, WalletConnect, etc.).
+     */
+    buildMintRequestTypedData(message: MintRequest): Promise<{
+        domain: {
+            name: string;
+            version: "1";
+            chainId: number;
+            verifyingContract: `0x${string}`;
+        };
+        types: {
+            readonly MintRequest: readonly [{
+                readonly name: "to";
+                readonly type: "address";
+            }, {
+                readonly name: "amount";
+                readonly type: "uint256";
+            }, {
+                readonly name: "nonce";
+                readonly type: "uint256";
+            }, {
+                readonly name: "deadline";
+                readonly type: "uint256";
+            }];
+        };
+        primaryType: "MintRequest";
+        message: MintRequest;
+    }>;
+    /**
+     * Build the EIP-712 typed data for a ReceiverConsent.
+     * Pass the result to any external signer (Privy, WalletConnect, etc.).
+     */
+    buildReceiverConsentTypedData(message: ReceiverConsent): Promise<{
+        domain: {
+            name: string;
+            version: "1";
+            chainId: number;
+            verifyingContract: `0x${string}`;
+        };
+        types: {
+            readonly ReceiverConsent: readonly [{
+                readonly name: "onBehalfOf";
+                readonly type: "address";
+            }, {
+                readonly name: "originalReceiver";
+                readonly type: "address";
+            }, {
+                readonly name: "amount";
+                readonly type: "uint256";
+            }, {
+                readonly name: "nonce";
+                readonly type: "uint256";
+            }, {
+                readonly name: "deadline";
+                readonly type: "uint256";
+            }, {
+                readonly name: "extData";
+                readonly type: "bytes";
+            }];
+        };
+        primaryType: "ReceiverConsent";
+        message: ReceiverConsent;
+    }>;
+    signMintRequest(message: MintRequest): Promise<EIP712Signature>;
+    verifyMintRequest(message: MintRequest, signature: Hex, expectedMinter: Address): Promise<SignatureVerification>;
+    signReceiverConsent(message: ReceiverConsent): Promise<EIP712Signature>;
+    verifyReceiverConsent(message: ReceiverConsent, signature: Hex, expectedReceiver: Address): Promise<SignatureVerification>;
+    getMintRequestNonce(receiver: Address): Promise<bigint>;
+    getReceiverConsentNonce(receiver: Address): Promise<bigint>;
+    encodeMintAndSwap(mint: MintParams, swap: SwapParams): Hex;
+    decodeMintAndSwap(calldata: Hex): {
+        mint: MintParams;
+        swap: SwapParams;
+    };
+    /**
+     * Find the best swap route from `tokenIn` to `tokenOut`.
+     * Merges `pools` with COMMON_POOLS for the configured chain, builds all
+     * paths, and quotes via a single multicall RPC call.
+     */
+    findBestQuote(tokenIn: Address, tokenOut: Address, exactAmount: bigint, pools?: PoolKey[], quoterAddress?: Address, maxHops?: number): Promise<BestQuote>;
+    /**
+     * Build UniversalRouter execute args from a quote result.
+     * The caller provides `minAmountOut` after applying their own slippage.
+     */
+    buildSwapFromQuote(params: {
+        quote: QuoteResult;
+        currencyIn: Address;
+        currencyOut: Address;
+        amountIn: bigint;
+        minAmountOut: bigint;
+    }): {
+        commands: Hex;
+        inputs: Hex[];
+    };
+    /**
+     * Build Relay SwapParams + extData from a quote result.
+     * Returns ready-to-use args for `Relay.mintAndSwap`.
+     */
+    buildRelaySwapParams(params: {
+        quote: {
+            path: PathKey[];
+        };
+        minAmountOut: bigint;
+        feeInUsdt: bigint;
+        deadline: bigint;
+    }): {
+        swapParams: SwapParams;
+        extData: Hex;
+    };
+    /**
+     * Encode extData for ReceiverConsent and MintParams.
+     * extData = abi.encode(minAmountOut, feeInUsdt)
+     */
+    encodeExtData(minAmountOut: bigint, feeInUsdt: bigint): Hex;
+    /**
+     * Simulate a Relay.mintAndSwap call. Catches reverts (bad signatures,
+     * expired deadlines, insufficient mint cap, pool errors) before submitting.
+     *
+     * @param relayAddress - Relay contract address
+     * @param mint         - MintParams with real signatures
+     * @param swap         - SwapParams (path + deadline)
+     * @param from         - Relayer address that will submit the tx
+     */
+    simulateMintAndSwap(relayAddress: Address, mint: MintParams, swap: SwapParams, from: Address): Promise<SimulationResult>;
+    /**
+     * Simulate a UniversalRouter.execute swap call. Catches reverts (bad
+     * approvals, insufficient balance, pool errors) before submitting.
+     *
+     * @param routerAddress - UniversalRouter contract address
+     * @param commands      - Packed command bytes (from buildSwapFromQuote)
+     * @param inputs        - Encoded inputs (from buildSwapFromQuote)
+     * @param deadline      - Unix timestamp
+     * @param from          - Address that will execute the swap
+     */
+    simulateSwap(routerAddress: Address, commands: Hex, inputs: Hex[], deadline: bigint, from: Address): Promise<SwapSimulationResult>;
+    /**
+     * Build an EIP-4361 login message for the current signer + chain. The
+     * caller supplies the issuer-specific fields (domain, nonce, uri); the SDK
+     * fills in the wallet address and chain id from its own config.
+     */
+    createLoginMessage(params: Omit<LoginMessageParams, "address" | "chainId">): Promise<string>;
+    /** Sign a login message string with the current signer (personal_sign) */
+    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 };

package/dist/index.d.ts

@@ -0,0 +1,239 @@
+import { Address, WalletClient, PublicClient, Hex } 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';
+export { buildDomain, buildMintRequestTypedData, buildReceiverConsentTypedData, signMintRequest, signReceiverConsent, verifyMintRequest, verifyReceiverConsent } from './eip712/index.js';
+import { SimulationResult } from './relay/index.js';
+export { buildRelaySwapParams, decodeExtData, decodeMintAndSwap, encodeExtData, encodeMintAndSwap, simulateMintAndSwap } from './relay/index.js';
+export { getIssuer, getMintRequestNonce, getPointTokenIssuer, getPointTokenIssuerAddress, getReceiverConsentNonce, getTokenName, getUsdt, isActiveIssuer, isMinter, verifyMintCap } from './contract/index.js';
+export { buildAllPaths, combineRoutes, findBestQuote, quoteBestRoute, quoteExactInput, quoteExactInputSingle } from './quoting/index.js';
+import { SwapSimulationResult } from './swap/index.js';
+export { SETTLE_ALL, SWAP_EXACT_IN, TAKE_ALL, V4_SWAP, buildErc20ApprovalCalldata, buildPermit2ApprovalCalldata, buildSwapFromQuote, buildUniversalRouterExecuteArgs, buildV4SwapInput, checkAllowance, simulateSwap } from './swap/index.js';
+import { LoginMessageParams } from './auth/index.js';
+export { VerifyLoginResult, createLoginMessage, parseLoginMessage, verifyLoginMessage } from './auth/index.js';
+
+declare const mintRequestTypes: {
+    readonly MintRequest: readonly [{
+        readonly name: "to";
+        readonly type: "address";
+    }, {
+        readonly name: "amount";
+        readonly type: "uint256";
+    }, {
+        readonly name: "nonce";
+        readonly type: "uint256";
+    }, {
+        readonly name: "deadline";
+        readonly type: "uint256";
+    }];
+};
+declare const receiverConsentTypes: {
+    readonly ReceiverConsent: readonly [{
+        readonly name: "onBehalfOf";
+        readonly type: "address";
+    }, {
+        readonly name: "originalReceiver";
+        readonly type: "address";
+    }, {
+        readonly name: "amount";
+        readonly type: "uint256";
+    }, {
+        readonly name: "nonce";
+        readonly type: "uint256";
+    }, {
+        readonly name: "deadline";
+        readonly type: "uint256";
+    }, {
+        readonly name: "extData";
+        readonly type: "bytes";
+    }];
+};
+declare const SUPPORTED_CHAINS: Record<number, ChainConfig>;
+declare const V4_QUOTER_ADDRESSES: Record<number, Address>;
+declare const UNIVERSAL_ROUTER_ADDRESSES: Record<number, Address>;
+declare const COMMON_TOKENS: Record<number, Record<string, Address>>;
+declare const COMMON_POOLS: Record<number, PoolKey[]>;
+declare const POINT_TOKEN_POOLS: Record<number, Record<Address, PoolKey[]>>;
+
+declare class PafiSDKError extends Error {
+    constructor(message: string);
+}
+declare class ConfigurationError extends PafiSDKError {
+    constructor(message: string);
+}
+declare class SigningError extends PafiSDKError {
+    constructor(message: string);
+}
+declare class SimulationError extends PafiSDKError {
+    operation: string;
+    reason: string;
+    constructor(operation: string, reason: string);
+}
+declare class ApiError extends PafiSDKError {
+    status?: number | undefined;
+    constructor(message: string, status?: number | undefined);
+}
+
+declare class PafiSDK {
+    private _pointTokenAddress?;
+    private _relayContractAddress?;
+    private _signer?;
+    private _provider?;
+    private _chainId?;
+    constructor(config: PafiSDKConfig);
+    setPointTokenAddress(address: Address): void;
+    setRelayContractAddress(address: Address): void;
+    setSigner(signer: WalletClient): void;
+    setProvider(provider: PublicClient): void;
+    private requirePointToken;
+    private requireProvider;
+    private requireSigner;
+    private requireChainId;
+    getDomain(): Promise<PointTokenDomainConfig>;
+    /**
+     * Build the EIP-712 typed data for a MintRequest.
+     * Pass the result to any external signer (Privy, WalletConnect, etc.).
+     */
+    buildMintRequestTypedData(message: MintRequest): Promise<{
+        domain: {
+            name: string;
+            version: "1";
+            chainId: number;
+            verifyingContract: `0x${string}`;
+        };
+        types: {
+            readonly MintRequest: readonly [{
+                readonly name: "to";
+                readonly type: "address";
+            }, {
+                readonly name: "amount";
+                readonly type: "uint256";
+            }, {
+                readonly name: "nonce";
+                readonly type: "uint256";
+            }, {
+                readonly name: "deadline";
+                readonly type: "uint256";
+            }];
+        };
+        primaryType: "MintRequest";
+        message: MintRequest;
+    }>;
+    /**
+     * Build the EIP-712 typed data for a ReceiverConsent.
+     * Pass the result to any external signer (Privy, WalletConnect, etc.).
+     */
+    buildReceiverConsentTypedData(message: ReceiverConsent): Promise<{
+        domain: {
+            name: string;
+            version: "1";
+            chainId: number;
+            verifyingContract: `0x${string}`;
+        };
+        types: {
+            readonly ReceiverConsent: readonly [{
+                readonly name: "onBehalfOf";
+                readonly type: "address";
+            }, {
+                readonly name: "originalReceiver";
+                readonly type: "address";
+            }, {
+                readonly name: "amount";
+                readonly type: "uint256";
+            }, {
+                readonly name: "nonce";
+                readonly type: "uint256";
+            }, {
+                readonly name: "deadline";
+                readonly type: "uint256";
+            }, {
+                readonly name: "extData";
+                readonly type: "bytes";
+            }];
+        };
+        primaryType: "ReceiverConsent";
+        message: ReceiverConsent;
+    }>;
+    signMintRequest(message: MintRequest): Promise<EIP712Signature>;
+    verifyMintRequest(message: MintRequest, signature: Hex, expectedMinter: Address): Promise<SignatureVerification>;
+    signReceiverConsent(message: ReceiverConsent): Promise<EIP712Signature>;
+    verifyReceiverConsent(message: ReceiverConsent, signature: Hex, expectedReceiver: Address): Promise<SignatureVerification>;
+    getMintRequestNonce(receiver: Address): Promise<bigint>;
+    getReceiverConsentNonce(receiver: Address): Promise<bigint>;
+    encodeMintAndSwap(mint: MintParams, swap: SwapParams): Hex;
+    decodeMintAndSwap(calldata: Hex): {
+        mint: MintParams;
+        swap: SwapParams;
+    };
+    /**
+     * Find the best swap route from `tokenIn` to `tokenOut`.
+     * Merges `pools` with COMMON_POOLS for the configured chain, builds all
+     * paths, and quotes via a single multicall RPC call.
+     */
+    findBestQuote(tokenIn: Address, tokenOut: Address, exactAmount: bigint, pools?: PoolKey[], quoterAddress?: Address, maxHops?: number): Promise<BestQuote>;
+    /**
+     * Build UniversalRouter execute args from a quote result.
+     * The caller provides `minAmountOut` after applying their own slippage.
+     */
+    buildSwapFromQuote(params: {
+        quote: QuoteResult;
+        currencyIn: Address;
+        currencyOut: Address;
+        amountIn: bigint;
+        minAmountOut: bigint;
+    }): {
+        commands: Hex;
+        inputs: Hex[];
+    };
+    /**
+     * Build Relay SwapParams + extData from a quote result.
+     * Returns ready-to-use args for `Relay.mintAndSwap`.
+     */
+    buildRelaySwapParams(params: {
+        quote: {
+            path: PathKey[];
+        };
+        minAmountOut: bigint;
+        feeInUsdt: bigint;
+        deadline: bigint;
+    }): {
+        swapParams: SwapParams;
+        extData: Hex;
+    };
+    /**
+     * Encode extData for ReceiverConsent and MintParams.
+     * extData = abi.encode(minAmountOut, feeInUsdt)
+     */
+    encodeExtData(minAmountOut: bigint, feeInUsdt: bigint): Hex;
+    /**
+     * Simulate a Relay.mintAndSwap call. Catches reverts (bad signatures,
+     * expired deadlines, insufficient mint cap, pool errors) before submitting.
+     *
+     * @param relayAddress - Relay contract address
+     * @param mint         - MintParams with real signatures
+     * @param swap         - SwapParams (path + deadline)
+     * @param from         - Relayer address that will submit the tx
+     */
+    simulateMintAndSwap(relayAddress: Address, mint: MintParams, swap: SwapParams, from: Address): Promise<SimulationResult>;
+    /**
+     * Simulate a UniversalRouter.execute swap call. Catches reverts (bad
+     * approvals, insufficient balance, pool errors) before submitting.
+     *
+     * @param routerAddress - UniversalRouter contract address
+     * @param commands      - Packed command bytes (from buildSwapFromQuote)
+     * @param inputs        - Encoded inputs (from buildSwapFromQuote)
+     * @param deadline      - Unix timestamp
+     * @param from          - Address that will execute the swap
+     */
+    simulateSwap(routerAddress: Address, commands: Hex, inputs: Hex[], deadline: bigint, from: Address): Promise<SwapSimulationResult>;
+    /**
+     * Build an EIP-4361 login message for the current signer + chain. The
+     * caller supplies the issuer-specific fields (domain, nonce, uri); the SDK
+     * fills in the wallet address and chain id from its own config.
+     */
+    createLoginMessage(params: Omit<LoginMessageParams, "address" | "chainId">): Promise<string>;
+    /** Sign a login message string with the current signer (personal_sign) */
+    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 };