@perkos/schema-validation 1.0.0

package/dist/payment.d.mts

@@ -0,0 +1,361 @@
+import { z } from 'zod';
+
+/**
+ * @perkos/validators/payment
+ * Payment and x402 protocol validators using Zod
+ */
+
+declare const networkSchema: z.ZodEnum<["avalanche", "base", "celo", "avalanche-fuji", "base-sepolia", "celo-alfajores"]>;
+declare const caip2NetworkSchema: z.ZodString;
+declare const ethereumAddressSchema: z.ZodString;
+declare const transactionHashSchema: z.ZodString;
+declare const signatureSchema: z.ZodString;
+declare const paymentEnvelopeSchema: z.ZodObject<{
+    payload: z.ZodObject<{
+        from: z.ZodString;
+        to: z.ZodString;
+        value: z.ZodString;
+        validAfter: z.ZodNumber;
+        validBefore: z.ZodNumber;
+        nonce: z.ZodString;
+        network: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        value: string;
+        from: string;
+        to: string;
+        validAfter: number;
+        validBefore: number;
+        nonce: string;
+        network: string;
+    }, {
+        value: string;
+        from: string;
+        to: string;
+        validAfter: number;
+        validBefore: number;
+        nonce: string;
+        network: string;
+    }>;
+    signature: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    payload: {
+        value: string;
+        from: string;
+        to: string;
+        validAfter: number;
+        validBefore: number;
+        nonce: string;
+        network: string;
+    };
+    signature: string;
+}, {
+    payload: {
+        value: string;
+        from: string;
+        to: string;
+        validAfter: number;
+        validBefore: number;
+        nonce: string;
+        network: string;
+    };
+    signature: string;
+}>;
+declare const paymentHeaderSchema: z.ZodString;
+declare const priceSchema: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
+declare const paymentConfigSchema: z.ZodObject<{
+    recipientAddress: z.ZodString;
+    network: z.ZodEnum<["avalanche", "base", "celo", "avalanche-fuji", "base-sepolia", "celo-alfajores"]>;
+    tokenAddress: z.ZodOptional<z.ZodString>;
+    prices: z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
+}, "strip", z.ZodTypeAny, {
+    network: "avalanche" | "base" | "celo" | "avalanche-fuji" | "base-sepolia" | "celo-alfajores";
+    recipientAddress: string;
+    prices: Record<string, string | number>;
+    tokenAddress?: string | undefined;
+}, {
+    network: "avalanche" | "base" | "celo" | "avalanche-fuji" | "base-sepolia" | "celo-alfajores";
+    recipientAddress: string;
+    prices: Record<string, string | number>;
+    tokenAddress?: string | undefined;
+}>;
+declare const routeConfigSchema: z.ZodObject<{
+    path: z.ZodString;
+    price: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
+    description: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    path: string;
+    price: string | number;
+    description?: string | undefined;
+}, {
+    path: string;
+    price: string | number;
+    description?: string | undefined;
+}>;
+declare const paymentRequestSchema: z.ZodObject<{
+    amount: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
+    recipient: z.ZodString;
+    network: z.ZodEnum<["avalanche", "base", "celo", "avalanche-fuji", "base-sepolia", "celo-alfajores"]>;
+    memo: z.ZodOptional<z.ZodString>;
+    expiresAt: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    network: "avalanche" | "base" | "celo" | "avalanche-fuji" | "base-sepolia" | "celo-alfajores";
+    amount: string | number;
+    recipient: string;
+    memo?: string | undefined;
+    expiresAt?: number | undefined;
+}, {
+    network: "avalanche" | "base" | "celo" | "avalanche-fuji" | "base-sepolia" | "celo-alfajores";
+    amount: string | number;
+    recipient: string;
+    memo?: string | undefined;
+    expiresAt?: number | undefined;
+}>;
+declare const paymentVerificationSchema: z.ZodObject<{
+    envelope: z.ZodObject<{
+        payload: z.ZodObject<{
+            from: z.ZodString;
+            to: z.ZodString;
+            value: z.ZodString;
+            validAfter: z.ZodNumber;
+            validBefore: z.ZodNumber;
+            nonce: z.ZodString;
+            network: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            value: string;
+            from: string;
+            to: string;
+            validAfter: number;
+            validBefore: number;
+            nonce: string;
+            network: string;
+        }, {
+            value: string;
+            from: string;
+            to: string;
+            validAfter: number;
+            validBefore: number;
+            nonce: string;
+            network: string;
+        }>;
+        signature: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        payload: {
+            value: string;
+            from: string;
+            to: string;
+            validAfter: number;
+            validBefore: number;
+            nonce: string;
+            network: string;
+        };
+        signature: string;
+    }, {
+        payload: {
+            value: string;
+            from: string;
+            to: string;
+            validAfter: number;
+            validBefore: number;
+            nonce: string;
+            network: string;
+        };
+        signature: string;
+    }>;
+    expectedAmount: z.ZodString;
+    expectedRecipient: z.ZodString;
+    tolerance: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
+}, "strip", z.ZodTypeAny, {
+    envelope: {
+        payload: {
+            value: string;
+            from: string;
+            to: string;
+            validAfter: number;
+            validBefore: number;
+            nonce: string;
+            network: string;
+        };
+        signature: string;
+    };
+    expectedAmount: string;
+    expectedRecipient: string;
+    tolerance: number;
+}, {
+    envelope: {
+        payload: {
+            value: string;
+            from: string;
+            to: string;
+            validAfter: number;
+            validBefore: number;
+            nonce: string;
+            network: string;
+        };
+        signature: string;
+    };
+    expectedAmount: string;
+    expectedRecipient: string;
+    tolerance?: number | undefined;
+}>;
+declare const tokenInfoSchema: z.ZodObject<{
+    address: z.ZodString;
+    name: z.ZodString;
+    symbol: z.ZodString;
+    decimals: z.ZodNumber;
+    chainId: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    symbol: string;
+    address: string;
+    name: string;
+    decimals: number;
+    chainId: number;
+}, {
+    symbol: string;
+    address: string;
+    name: string;
+    decimals: number;
+    chainId: number;
+}>;
+declare const eip712DomainSchema: z.ZodObject<{
+    name: z.ZodString;
+    version: z.ZodString;
+    chainId: z.ZodNumber;
+    verifyingContract: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    chainId: number;
+    version: string;
+    verifyingContract: string;
+}, {
+    name: string;
+    chainId: number;
+    version: string;
+    verifyingContract: string;
+}>;
+declare const settlementRequestSchema: z.ZodObject<{
+    envelope: z.ZodObject<{
+        payload: z.ZodObject<{
+            from: z.ZodString;
+            to: z.ZodString;
+            value: z.ZodString;
+            validAfter: z.ZodNumber;
+            validBefore: z.ZodNumber;
+            nonce: z.ZodString;
+            network: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            value: string;
+            from: string;
+            to: string;
+            validAfter: number;
+            validBefore: number;
+            nonce: string;
+            network: string;
+        }, {
+            value: string;
+            from: string;
+            to: string;
+            validAfter: number;
+            validBefore: number;
+            nonce: string;
+            network: string;
+        }>;
+        signature: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        payload: {
+            value: string;
+            from: string;
+            to: string;
+            validAfter: number;
+            validBefore: number;
+            nonce: string;
+            network: string;
+        };
+        signature: string;
+    }, {
+        payload: {
+            value: string;
+            from: string;
+            to: string;
+            validAfter: number;
+            validBefore: number;
+            nonce: string;
+            network: string;
+        };
+        signature: string;
+    }>;
+    privateKey: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    envelope: {
+        payload: {
+            value: string;
+            from: string;
+            to: string;
+            validAfter: number;
+            validBefore: number;
+            nonce: string;
+            network: string;
+        };
+        signature: string;
+    };
+    privateKey?: string | undefined;
+}, {
+    envelope: {
+        payload: {
+            value: string;
+            from: string;
+            to: string;
+            validAfter: number;
+            validBefore: number;
+            nonce: string;
+            network: string;
+        };
+        signature: string;
+    };
+    privateKey?: string | undefined;
+}>;
+declare const settlementResultSchema: z.ZodObject<{
+    success: z.ZodBoolean;
+    transactionHash: z.ZodOptional<z.ZodString>;
+    error: z.ZodOptional<z.ZodString>;
+    gasUsed: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    success: boolean;
+    error?: string | undefined;
+    transactionHash?: string | undefined;
+    gasUsed?: string | undefined;
+}, {
+    success: boolean;
+    error?: string | undefined;
+    transactionHash?: string | undefined;
+    gasUsed?: string | undefined;
+}>;
+declare const paymentErrorSchema: z.ZodObject<{
+    error: z.ZodString;
+    code: z.ZodEnum<["MISSING_PAYMENT", "INVALID_SIGNATURE", "INVALID_AMOUNT", "EXPIRED_PAYMENT", "INSUFFICIENT_BALANCE", "SETTLEMENT_FAILED", "NETWORK_MISMATCH"]>;
+    details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, "strip", z.ZodTypeAny, {
+    code: "MISSING_PAYMENT" | "INVALID_SIGNATURE" | "INVALID_AMOUNT" | "EXPIRED_PAYMENT" | "INSUFFICIENT_BALANCE" | "SETTLEMENT_FAILED" | "NETWORK_MISMATCH";
+    error: string;
+    details?: Record<string, unknown> | undefined;
+}, {
+    code: "MISSING_PAYMENT" | "INVALID_SIGNATURE" | "INVALID_AMOUNT" | "EXPIRED_PAYMENT" | "INSUFFICIENT_BALANCE" | "SETTLEMENT_FAILED" | "NETWORK_MISMATCH";
+    error: string;
+    details?: Record<string, unknown> | undefined;
+}>;
+type Network = z.infer<typeof networkSchema>;
+type CAIP2Network = z.infer<typeof caip2NetworkSchema>;
+type EthereumAddress = z.infer<typeof ethereumAddressSchema>;
+type TransactionHash = z.infer<typeof transactionHashSchema>;
+type Signature = z.infer<typeof signatureSchema>;
+type PaymentEnvelope = z.infer<typeof paymentEnvelopeSchema>;
+type PaymentConfig = z.infer<typeof paymentConfigSchema>;
+type RouteConfig = z.infer<typeof routeConfigSchema>;
+type PaymentRequest = z.infer<typeof paymentRequestSchema>;
+type PaymentVerification = z.infer<typeof paymentVerificationSchema>;
+type TokenInfo = z.infer<typeof tokenInfoSchema>;
+type EIP712Domain = z.infer<typeof eip712DomainSchema>;
+type SettlementRequest = z.infer<typeof settlementRequestSchema>;
+type SettlementResult = z.infer<typeof settlementResultSchema>;
+type PaymentError = z.infer<typeof paymentErrorSchema>;
+
+export { type CAIP2Network, type EIP712Domain, type EthereumAddress, type Network, type PaymentConfig, type PaymentEnvelope, type PaymentError, type PaymentRequest, type PaymentVerification, type RouteConfig, type SettlementRequest, type SettlementResult, type Signature, type TokenInfo, type TransactionHash, caip2NetworkSchema, eip712DomainSchema, ethereumAddressSchema, networkSchema, paymentConfigSchema, paymentEnvelopeSchema, paymentErrorSchema, paymentHeaderSchema, paymentRequestSchema, paymentVerificationSchema, priceSchema, routeConfigSchema, settlementRequestSchema, settlementResultSchema, signatureSchema, tokenInfoSchema, transactionHashSchema };