@invisi-labs/payer 1.0.0

package/dist/index.d.cts

@@ -0,0 +1,314 @@
+import { Address, Hex } from 'viem';
+import { IPPRequest } from '@invisi-labs/ipp';
+
+interface PayOpenParams {
+    chainId: bigint;
+    identityCommitment: `0x${string}`;
+    tokenAddress: `0x${string}`;
+    amount: bigint;
+    treeId: bigint;
+    refundLink?: bigint | undefined;
+    /** 外部提供的 nonce（如 propose 响应）。不传则内部随机生成 */
+    nonce?: bigint | undefined;
+}
+interface PayOpenCalldata {
+    paymentCommitment: `0x${string}`;
+    nonce: `0x${string}`;
+    data: `0x${string}`;
+    approveAmount: bigint;
+    value?: bigint;
+}
+declare function buildPayOpenCalldata(params: PayOpenParams): Promise<PayOpenCalldata>;
+interface PayBlindParams {
+    proof: `0x${string}`;
+    paymentCommitment: `0x${string}`;
+    changeCommitment: `0x${string}`;
+    inputAmount: bigint;
+    tokenAddress: `0x${string}`;
+    treeId: bigint;
+    refundLink?: bigint;
+}
+interface PayBlindCalldata {
+    data: `0x${string}`;
+    approveAmount: bigint;
+}
+declare function buildPayBlindCalldata(params: PayBlindParams): Promise<PayBlindCalldata>;
+/** Payer's local record of change from a shielded payment, for later recovery via withdraw */
+interface ChangeRecord {
+    treeId: bigint;
+    leafIndex: number;
+    nullifierKey: bigint;
+    receivingAddress: `0x${string}`;
+    tokenAddress: `0x${string}`;
+    amount: bigint;
+    nonce: bigint;
+}
+interface SettleChangeParams {
+    chainId: bigint;
+    nullifierKey: bigint;
+    receivingAddress: `0x${string}`;
+    tokenAddress: `0x${string}`;
+    amount: bigint;
+    nonce: bigint;
+    merkleRoot: `0x${string}`;
+    proof: `0x${string}`;
+    treeId: bigint;
+}
+interface SettleChangeCalldata {
+    nullifier: `0x${string}`;
+    data: `0x${string}`;
+}
+declare function buildSettleChangeCalldata(params: SettleChangeParams): Promise<SettleChangeCalldata>;
+
+interface CreditAuthorization {
+    creditId: bigint;
+    identityCommitment: `0x${string}`;
+    payerCommitment: `0x${string}`;
+    creditNullifierKey: bigint;
+    nullifierKeyHash: `0x${string}`;
+    tokenAddress: `0x${string}`;
+    amount: bigint;
+    nonce: bigint;
+    expiry: bigint;
+    treeId: bigint;
+    chainId: bigint;
+}
+interface CreateCreditParams {
+    payerMasterKey: bigint;
+    creditId: bigint;
+    identityCommitment: `0x${string}`;
+    payerAddress: bigint;
+    tokenAddress: `0x${string}`;
+    amount: bigint;
+    expiry: bigint;
+    treeId: bigint;
+    chainId: bigint;
+}
+interface CreateCreditResult {
+    authorization: CreditAuthorization;
+    data: `0x${string}`;
+    approveAmount: bigint;
+}
+declare function createCredit(params: CreateCreditParams): Promise<CreateCreditResult>;
+interface BuildReclaimCalldataParams {
+    nullifier: `0x${string}`;
+    amount: bigint;
+    receivingAddress: `0x${string}`;
+    tokenAddress: `0x${string}`;
+    merkleRoot: `0x${string}`;
+    proof: `0x${string}`;
+    treeId: bigint;
+    expiry: bigint;
+}
+interface ReclaimCalldata {
+    data: `0x${string}`;
+    nullifier: `0x${string}`;
+}
+declare function buildReclaimCalldata(params: BuildReclaimCalldataParams): Promise<ReclaimCalldata>;
+
+interface EIP712DomainParams {
+    chainId: bigint;
+    verifyingContract: Address;
+}
+declare function getEIP712Domain(params: EIP712DomainParams): {
+    readonly name: "InvisibleProtocol";
+    readonly version: "1";
+    readonly chainId: bigint;
+    readonly verifyingContract: `0x${string}`;
+};
+interface TokenPermit {
+    deadline: bigint;
+    v: number;
+    r: Hex;
+    s: Hex;
+}
+declare const EMPTY_PERMIT: TokenPermit;
+declare const payOpenWithSigTypes: {
+    readonly Asset: readonly [{
+        readonly name: "addr";
+        readonly type: "address";
+    }, {
+        readonly name: "amount";
+        readonly type: "uint256";
+    }];
+    readonly PayOpenWithSig: readonly [{
+        readonly name: "identityCommitment";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "asset";
+        readonly type: "Asset";
+    }, {
+        readonly name: "nonce";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "treeId";
+        readonly type: "uint256";
+    }, {
+        readonly name: "refundLink";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "sigNonce";
+        readonly type: "uint256";
+    }, {
+        readonly name: "deadline";
+        readonly type: "uint256";
+    }];
+};
+declare const payBlindWithSigTypes: {
+    readonly PayBlindWithSig: readonly [{
+        readonly name: "proof";
+        readonly type: "bytes";
+    }, {
+        readonly name: "paymentCommitment";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "changeCommitment";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "inputAmount";
+        readonly type: "uint256";
+    }, {
+        readonly name: "tokenAddress";
+        readonly type: "address";
+    }, {
+        readonly name: "treeId";
+        readonly type: "uint256";
+    }, {
+        readonly name: "refundLink";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "sigNonce";
+        readonly type: "uint256";
+    }, {
+        readonly name: "deadline";
+        readonly type: "uint256";
+    }];
+};
+declare const depositCreditWithSigTypes: {
+    readonly Asset: readonly [{
+        readonly name: "addr";
+        readonly type: "address";
+    }, {
+        readonly name: "amount";
+        readonly type: "uint256";
+    }];
+    readonly DepositCreditWithSig: readonly [{
+        readonly name: "identityCommitment";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "payerCommitment";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "asset";
+        readonly type: "Asset";
+    }, {
+        readonly name: "nonce";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "expiry";
+        readonly type: "uint256";
+    }, {
+        readonly name: "nullifierKeyHash";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "treeId";
+        readonly type: "uint256";
+    }, {
+        readonly name: "sigNonce";
+        readonly type: "uint256";
+    }, {
+        readonly name: "deadline";
+        readonly type: "uint256";
+    }];
+};
+interface SignPayOpenResult {
+    paymentCommitment: Hex;
+    nonce: Hex;
+    typedData: {
+        domain: ReturnType<typeof getEIP712Domain>;
+        types: typeof payOpenWithSigTypes;
+        primaryType: "PayOpenWithSig";
+        message: Record<string, unknown>;
+    };
+}
+interface SignPayBlindResult {
+    typedData: {
+        domain: ReturnType<typeof getEIP712Domain>;
+        types: typeof payBlindWithSigTypes;
+        primaryType: "PayBlindWithSig";
+        message: Record<string, unknown>;
+    };
+}
+interface SignDepositCreditResult {
+    typedData: {
+        domain: ReturnType<typeof getEIP712Domain>;
+        types: typeof depositCreditWithSigTypes;
+        primaryType: "DepositCreditWithSig";
+        message: Record<string, unknown>;
+    };
+}
+interface SignPayOpenParams {
+    chainId: bigint;
+    verifyingContract: Address;
+    identityCommitment: Hex;
+    tokenAddress: Address;
+    amount: bigint;
+    treeId: bigint;
+    refundLink?: Hex;
+    sigNonce: bigint;
+    deadline: bigint;
+}
+declare function buildSignPayOpenTypedData(params: SignPayOpenParams): Promise<SignPayOpenResult>;
+interface SignPayBlindParams {
+    chainId: bigint;
+    verifyingContract: Address;
+    proof: Hex;
+    paymentCommitment: Hex;
+    changeCommitment: Hex;
+    inputAmount: bigint;
+    tokenAddress: Address;
+    treeId: bigint;
+    refundLink?: Hex;
+    sigNonce: bigint;
+    deadline: bigint;
+}
+declare function buildSignPayBlindTypedData(params: SignPayBlindParams): SignPayBlindResult;
+interface SignDepositCreditParams {
+    chainId: bigint;
+    verifyingContract: Address;
+    identityCommitment: Hex;
+    payerCommitment: Hex;
+    tokenAddress: Address;
+    amount: bigint;
+    nonce: Hex;
+    expiry: bigint;
+    nullifierKeyHash: Hex;
+    treeId: bigint;
+    sigNonce: bigint;
+    deadline: bigint;
+}
+declare function buildSignDepositCreditTypedData(params: SignDepositCreditParams): SignDepositCreditResult;
+
+interface VerifyPaymentCommitmentParams {
+    identityCommitment: `0x${string}`;
+    tokenAddress: `0x${string}`;
+    amount: bigint;
+    nonce: `0x${string}`;
+    paymentCommitment: `0x${string}`;
+    chainId: bigint;
+}
+declare function verifyPaymentCommitment(params: VerifyPaymentCommitmentParams): Promise<boolean>;
+
+interface BuildPaymentFromRequestParams {
+    request: IPPRequest;
+    nonce: `0x${string}`;
+    paymentCommitment: `0x${string}`;
+    amount: bigint;
+}
+interface BuildPaymentFromRequestResult {
+    calldata: `0x${string}`;
+    approveAmount: bigint;
+}
+declare function buildPaymentFromRequest(params: BuildPaymentFromRequestParams): Promise<BuildPaymentFromRequestResult>;
+
+export { type BuildPaymentFromRequestParams, type BuildPaymentFromRequestResult, type BuildReclaimCalldataParams, type ChangeRecord, type CreateCreditParams, type CreateCreditResult, type CreditAuthorization, type EIP712DomainParams, EMPTY_PERMIT, type PayBlindCalldata, type PayBlindParams, type PayOpenCalldata, type PayOpenParams, type ReclaimCalldata, type SettleChangeCalldata, type SettleChangeParams, type SignDepositCreditParams, type SignDepositCreditResult, type SignPayBlindParams, type SignPayBlindResult, type SignPayOpenParams, type SignPayOpenResult, type TokenPermit, type VerifyPaymentCommitmentParams, buildPayBlindCalldata, buildPayOpenCalldata, buildPaymentFromRequest, buildReclaimCalldata, buildSettleChangeCalldata, buildSignDepositCreditTypedData, buildSignPayBlindTypedData, buildSignPayOpenTypedData, createCredit, getEIP712Domain, verifyPaymentCommitment };

package/dist/index.d.ts

@@ -0,0 +1,314 @@
+import { Address, Hex } from 'viem';
+import { IPPRequest } from '@invisi-labs/ipp';
+
+interface PayOpenParams {
+    chainId: bigint;
+    identityCommitment: `0x${string}`;
+    tokenAddress: `0x${string}`;
+    amount: bigint;
+    treeId: bigint;
+    refundLink?: bigint | undefined;
+    /** 外部提供的 nonce（如 propose 响应）。不传则内部随机生成 */
+    nonce?: bigint | undefined;
+}
+interface PayOpenCalldata {
+    paymentCommitment: `0x${string}`;
+    nonce: `0x${string}`;
+    data: `0x${string}`;
+    approveAmount: bigint;
+    value?: bigint;
+}
+declare function buildPayOpenCalldata(params: PayOpenParams): Promise<PayOpenCalldata>;
+interface PayBlindParams {
+    proof: `0x${string}`;
+    paymentCommitment: `0x${string}`;
+    changeCommitment: `0x${string}`;
+    inputAmount: bigint;
+    tokenAddress: `0x${string}`;
+    treeId: bigint;
+    refundLink?: bigint;
+}
+interface PayBlindCalldata {
+    data: `0x${string}`;
+    approveAmount: bigint;
+}
+declare function buildPayBlindCalldata(params: PayBlindParams): Promise<PayBlindCalldata>;
+/** Payer's local record of change from a shielded payment, for later recovery via withdraw */
+interface ChangeRecord {
+    treeId: bigint;
+    leafIndex: number;
+    nullifierKey: bigint;
+    receivingAddress: `0x${string}`;
+    tokenAddress: `0x${string}`;
+    amount: bigint;
+    nonce: bigint;
+}
+interface SettleChangeParams {
+    chainId: bigint;
+    nullifierKey: bigint;
+    receivingAddress: `0x${string}`;
+    tokenAddress: `0x${string}`;
+    amount: bigint;
+    nonce: bigint;
+    merkleRoot: `0x${string}`;
+    proof: `0x${string}`;
+    treeId: bigint;
+}
+interface SettleChangeCalldata {
+    nullifier: `0x${string}`;
+    data: `0x${string}`;
+}
+declare function buildSettleChangeCalldata(params: SettleChangeParams): Promise<SettleChangeCalldata>;
+
+interface CreditAuthorization {
+    creditId: bigint;
+    identityCommitment: `0x${string}`;
+    payerCommitment: `0x${string}`;
+    creditNullifierKey: bigint;
+    nullifierKeyHash: `0x${string}`;
+    tokenAddress: `0x${string}`;
+    amount: bigint;
+    nonce: bigint;
+    expiry: bigint;
+    treeId: bigint;
+    chainId: bigint;
+}
+interface CreateCreditParams {
+    payerMasterKey: bigint;
+    creditId: bigint;
+    identityCommitment: `0x${string}`;
+    payerAddress: bigint;
+    tokenAddress: `0x${string}`;
+    amount: bigint;
+    expiry: bigint;
+    treeId: bigint;
+    chainId: bigint;
+}
+interface CreateCreditResult {
+    authorization: CreditAuthorization;
+    data: `0x${string}`;
+    approveAmount: bigint;
+}
+declare function createCredit(params: CreateCreditParams): Promise<CreateCreditResult>;
+interface BuildReclaimCalldataParams {
+    nullifier: `0x${string}`;
+    amount: bigint;
+    receivingAddress: `0x${string}`;
+    tokenAddress: `0x${string}`;
+    merkleRoot: `0x${string}`;
+    proof: `0x${string}`;
+    treeId: bigint;
+    expiry: bigint;
+}
+interface ReclaimCalldata {
+    data: `0x${string}`;
+    nullifier: `0x${string}`;
+}
+declare function buildReclaimCalldata(params: BuildReclaimCalldataParams): Promise<ReclaimCalldata>;
+
+interface EIP712DomainParams {
+    chainId: bigint;
+    verifyingContract: Address;
+}
+declare function getEIP712Domain(params: EIP712DomainParams): {
+    readonly name: "InvisibleProtocol";
+    readonly version: "1";
+    readonly chainId: bigint;
+    readonly verifyingContract: `0x${string}`;
+};
+interface TokenPermit {
+    deadline: bigint;
+    v: number;
+    r: Hex;
+    s: Hex;
+}
+declare const EMPTY_PERMIT: TokenPermit;
+declare const payOpenWithSigTypes: {
+    readonly Asset: readonly [{
+        readonly name: "addr";
+        readonly type: "address";
+    }, {
+        readonly name: "amount";
+        readonly type: "uint256";
+    }];
+    readonly PayOpenWithSig: readonly [{
+        readonly name: "identityCommitment";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "asset";
+        readonly type: "Asset";
+    }, {
+        readonly name: "nonce";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "treeId";
+        readonly type: "uint256";
+    }, {
+        readonly name: "refundLink";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "sigNonce";
+        readonly type: "uint256";
+    }, {
+        readonly name: "deadline";
+        readonly type: "uint256";
+    }];
+};
+declare const payBlindWithSigTypes: {
+    readonly PayBlindWithSig: readonly [{
+        readonly name: "proof";
+        readonly type: "bytes";
+    }, {
+        readonly name: "paymentCommitment";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "changeCommitment";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "inputAmount";
+        readonly type: "uint256";
+    }, {
+        readonly name: "tokenAddress";
+        readonly type: "address";
+    }, {
+        readonly name: "treeId";
+        readonly type: "uint256";
+    }, {
+        readonly name: "refundLink";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "sigNonce";
+        readonly type: "uint256";
+    }, {
+        readonly name: "deadline";
+        readonly type: "uint256";
+    }];
+};
+declare const depositCreditWithSigTypes: {
+    readonly Asset: readonly [{
+        readonly name: "addr";
+        readonly type: "address";
+    }, {
+        readonly name: "amount";
+        readonly type: "uint256";
+    }];
+    readonly DepositCreditWithSig: readonly [{
+        readonly name: "identityCommitment";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "payerCommitment";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "asset";
+        readonly type: "Asset";
+    }, {
+        readonly name: "nonce";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "expiry";
+        readonly type: "uint256";
+    }, {
+        readonly name: "nullifierKeyHash";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "treeId";
+        readonly type: "uint256";
+    }, {
+        readonly name: "sigNonce";
+        readonly type: "uint256";
+    }, {
+        readonly name: "deadline";
+        readonly type: "uint256";
+    }];
+};
+interface SignPayOpenResult {
+    paymentCommitment: Hex;
+    nonce: Hex;
+    typedData: {
+        domain: ReturnType<typeof getEIP712Domain>;
+        types: typeof payOpenWithSigTypes;
+        primaryType: "PayOpenWithSig";
+        message: Record<string, unknown>;
+    };
+}
+interface SignPayBlindResult {
+    typedData: {
+        domain: ReturnType<typeof getEIP712Domain>;
+        types: typeof payBlindWithSigTypes;
+        primaryType: "PayBlindWithSig";
+        message: Record<string, unknown>;
+    };
+}
+interface SignDepositCreditResult {
+    typedData: {
+        domain: ReturnType<typeof getEIP712Domain>;
+        types: typeof depositCreditWithSigTypes;
+        primaryType: "DepositCreditWithSig";
+        message: Record<string, unknown>;
+    };
+}
+interface SignPayOpenParams {
+    chainId: bigint;
+    verifyingContract: Address;
+    identityCommitment: Hex;
+    tokenAddress: Address;
+    amount: bigint;
+    treeId: bigint;
+    refundLink?: Hex;
+    sigNonce: bigint;
+    deadline: bigint;
+}
+declare function buildSignPayOpenTypedData(params: SignPayOpenParams): Promise<SignPayOpenResult>;
+interface SignPayBlindParams {
+    chainId: bigint;
+    verifyingContract: Address;
+    proof: Hex;
+    paymentCommitment: Hex;
+    changeCommitment: Hex;
+    inputAmount: bigint;
+    tokenAddress: Address;
+    treeId: bigint;
+    refundLink?: Hex;
+    sigNonce: bigint;
+    deadline: bigint;
+}
+declare function buildSignPayBlindTypedData(params: SignPayBlindParams): SignPayBlindResult;
+interface SignDepositCreditParams {
+    chainId: bigint;
+    verifyingContract: Address;
+    identityCommitment: Hex;
+    payerCommitment: Hex;
+    tokenAddress: Address;
+    amount: bigint;
+    nonce: Hex;
+    expiry: bigint;
+    nullifierKeyHash: Hex;
+    treeId: bigint;
+    sigNonce: bigint;
+    deadline: bigint;
+}
+declare function buildSignDepositCreditTypedData(params: SignDepositCreditParams): SignDepositCreditResult;
+
+interface VerifyPaymentCommitmentParams {
+    identityCommitment: `0x${string}`;
+    tokenAddress: `0x${string}`;
+    amount: bigint;
+    nonce: `0x${string}`;
+    paymentCommitment: `0x${string}`;
+    chainId: bigint;
+}
+declare function verifyPaymentCommitment(params: VerifyPaymentCommitmentParams): Promise<boolean>;
+
+interface BuildPaymentFromRequestParams {
+    request: IPPRequest;
+    nonce: `0x${string}`;
+    paymentCommitment: `0x${string}`;
+    amount: bigint;
+}
+interface BuildPaymentFromRequestResult {
+    calldata: `0x${string}`;
+    approveAmount: bigint;
+}
+declare function buildPaymentFromRequest(params: BuildPaymentFromRequestParams): Promise<BuildPaymentFromRequestResult>;
+
+export { type BuildPaymentFromRequestParams, type BuildPaymentFromRequestResult, type BuildReclaimCalldataParams, type ChangeRecord, type CreateCreditParams, type CreateCreditResult, type CreditAuthorization, type EIP712DomainParams, EMPTY_PERMIT, type PayBlindCalldata, type PayBlindParams, type PayOpenCalldata, type PayOpenParams, type ReclaimCalldata, type SettleChangeCalldata, type SettleChangeParams, type SignDepositCreditParams, type SignDepositCreditResult, type SignPayBlindParams, type SignPayBlindResult, type SignPayOpenParams, type SignPayOpenResult, type TokenPermit, type VerifyPaymentCommitmentParams, buildPayBlindCalldata, buildPayOpenCalldata, buildPaymentFromRequest, buildReclaimCalldata, buildSettleChangeCalldata, buildSignDepositCreditTypedData, buildSignPayBlindTypedData, buildSignPayOpenTypedData, createCredit, getEIP712Domain, verifyPaymentCommitment };