@invisi-labs/protocol 1.1.5 → 1.1.6

package/dist/index.d.cts

@@ -3,7 +3,7 @@ import { Hex, Address, ReceivingKeyLookup, PublicWallet, CreditDeliveryState, Au
 import { ContractRunner, Provider } from 'ethers';
 import { DeploymentContext, CanonicalBlock, ProtocolDeployment, ProtocolRpcClient } from '@invisi-labs/rpc';
 export { CanonicalBlock, DeploymentContext, Membership, ProtocolDataProvider, ProtocolDataStatus, ProtocolUpdateRange, ProtocolUpdates } from '@invisi-labs/rpc';
-import { F as FundingParams, D as Delivery, I as InputSource, C as CreateCreditParams, a as CancelCreditParams, b as CreditDrawParams, T as TopUpCreditParams, c as TransactRequest, S as ShieldParams, d as ShieldOutput, e as CrossTreeTransactParams } from './types-BCTQjKzw.cjs';
+import { F as FundingParams, D as Delivery, I as InputSource, C as CreateCreditParams, a as CancelCreditParams, b as CreditDrawParams, T as TopUpCreditParams, c as TransactRequest, S as ShieldParams, d as ShieldOutput, e as CrossTreeTransactParams } from './types-BmUlasOg.cjs';
 import { ProofTarget, CircuitName, ProofStatement, ProvingRequest } from '@invisi-labs/prover';
 
 interface RegistryContext {
@@ -18,7 +18,7 @@ interface RegistryReceivingKeys {
 }
 interface AddressRegistration {
     /** Nonzero EVM owner: 20 bytes or canonical zero-padded bytes32. */
-    walletIdentity: Hex;
+    ownerAddress: Hex;
     keys: RegistryReceivingKeys;
     /** The current registry nonce expected for this operation. */
     nonce: bigint;
@@ -108,6 +108,7 @@ declare const pad: (v: readonly bigint[], n: number) => bigint[];
 /** Receipt/transport validation must not reject unrelated future wallet codecs. */
 declare function normalizeOpaqueDelivery(value: Delivery, options?: {
     empty?: boolean;
+    allowEmpty?: boolean;
 }): Delivery;
 declare const deliveriesHash: (v: readonly Delivery[]) => Hex;
 declare function normalizeFunding(input?: FundingInput): FundingParams;
@@ -180,7 +181,7 @@ interface FactoryReader {
 interface RegistryReader extends Pick<ChainReader, "getChainId" | "getCode" | "getBlock" | "getLatestBlockNumber" | "getTransaction" | "getReceipt"> {
     /** Validate arbitrary ERC-1271 bytes for a contract owner; transport errors propagate. */
     isValidRegistrationSignature?(owner: Address, digest: Hex, signature: Hex): Promise<boolean>;
-    getRegistryNonce(context: RegistryContext, walletIdentity: Hex, block: CanonicalBlock): Promise<bigint>;
+    getRegistryNonce(context: RegistryContext, ownerAddress: Hex, block: CanonicalBlock): Promise<bigint>;
 }
 interface RegistrationPreparation {
     wallet: PublicWallet;
@@ -197,7 +198,7 @@ declare class RegistrationOperation {
     get id(): string;
     preview(): {
         update: boolean;
-        walletIdentity: Hex;
+        ownerAddress: Hex;
         keys: RegistryReceivingKeys;
         nonce: bigint;
         deadline: bigint;
@@ -293,7 +294,7 @@ declare class AddressRegistry {
     buildCall(registration: AddressRegistration, signature: `0x${string}`, options?: RegistrationOptions): RegistrationCalldata;
 }
 
-declare const CREATE_CREDIT_FIELDS: readonly ["token", "sources", "nullifiers", "creditCommitment", "changeCommitment", "owner", "expiry", "deadline"];
+declare const CREATE_CREDIT_FIELDS: readonly ["token", "sources", "nullifiers", "creditCommitment", "changeCommitment", "owner", "expiry", "deadline", "feeRecipient", "feeAmount"];
 /** Public checks cannot establish ownership or conservation: those are enforced by the proof. */
 declare function validateCreateCreditRequest(c: TransactionContext, p: CreateCreditParams, cs: readonly Delivery[], funding?: FundingInput): {
     sources: {
@@ -310,6 +311,8 @@ declare function validateCreateCreditRequest(c: TransactionContext, p: CreateCre
     deadline: bigint;
     deliveries: Delivery[];
     funding: FundingParams;
+    feeRecipient: `0x${string}`;
+    feeAmount: bigint;
     chainId: bigint;
     protocolAddress: Hex;
     tokenAddress: Hex;
@@ -436,6 +439,8 @@ declare function validateCancelCreditRequest(c: TransactionContext, p: CancelCre
     owner: `0x${string}`;
     amount: bigint;
     deadline: bigint;
+    feeRecipient: `0x${string}`;
+    feeAmount: bigint;
     chainId: bigint;
     protocolAddress: Hex;
     tokenAddress: Hex;
@@ -459,6 +464,8 @@ declare function validateTopUpCreditRequest(c: TransactionContext, p: TopUpCredi
         deadline: bigint;
         deliveries: Delivery[];
         funding: FundingParams;
+        feeRecipient: `0x${string}`;
+        feeAmount: bigint;
         chainId: bigint;
         protocolAddress: Hex;
         tokenAddress: Hex;
@@ -615,7 +622,7 @@ type TransactCapacity = (typeof TRANSACT_CAPACITIES)[number];
 declare function selectTransactCapacity(inputs: number, outputs: number): TransactCapacity;
 type TransactRequestParams = CrossTreeTransactParams;
 declare function normalizeTransactRequest(c: TransactionContext, p: TransactRequestParams, cs: readonly Delivery[], funding?: FundingInput): {
-    capacity: 112 | 14 | 56 | 168;
+    capacity: 14 | 56 | 112 | 168;
     sources: {
         treeId: bigint;
         merkleRoot: `0x${string}`;
@@ -632,6 +639,8 @@ declare function normalizeTransactRequest(c: TransactionContext, p: TransactRequ
     deliveriesHash: `0x${string}`;
     withdrawalAddress: `0x${string}`;
     withdrawalAmount: bigint;
+    feeRecipient: `0x${string}`;
+    feeAmount: bigint;
     deadline: bigint;
     depositAmount: bigint;
     depositPayer: `0x${string}`;
@@ -710,7 +719,7 @@ interface BuildTransactCalldataParams {
 }
 declare function buildTransactCalldata(p: BuildTransactCalldataParams): {
     data: `0x${string}`;
-    capacity: 112 | 14 | 56 | 168;
+    capacity: 14 | 56 | 112 | 168;
     approveAmount: bigint;
 };
 interface BuildTransactAggregateCalldataParams {
@@ -780,7 +789,7 @@ type AggregateMemberInput = Pick<TransactRequest, "params" | "deliveries"> & {
 };
 /** Atomic aggregate funding binds the member statement rather than the aggregate proof bytes. */
 declare function aggregateMemberRequestHash(c: TransactionContext, r: AggregateMemberInput): Hex;
-/** Router adapter business words (56 per member), not the aggregate circuit statement. */
+/** Router adapter business words (58 per member), not the aggregate circuit statement. */
 declare function aggregatePublicInputs(c: TransactionContext, requests: readonly AggregateMemberInput[]): `0x${string}`[];
 declare function encodeAggregateFundingTypedData(c: TransactionContext, r: AggregateMemberInput): {
     domain: {
@@ -830,7 +839,7 @@ declare class TokenProtocol {
     }): Promise<void>;
     transact(request: Omit<BuildTransactCalldataParams, "context">): {
         data: `0x${string}`;
-        capacity: 112 | 14 | 56 | 168;
+        capacity: 14 | 56 | 112 | 168;
         approveAmount: bigint;
         to: `0x${string}`;
         value: bigint;
@@ -900,7 +909,7 @@ declare class Protocol {
 }
 
 interface VerifyNoteCommitmentParams {
-    walletIdentity: `0x${string}`;
+    ownerAddress: `0x${string}`;
     tokenAddress: `0x${string}`;
     amount: bigint;
     nonce: `0x${string}`;
@@ -943,7 +952,11 @@ interface CreditMembership {
 }
 interface TransactWitnessParams extends Omit<BuildTransactCalldataParams, "proof" | "context"> {
     inputs: readonly NoteMembership[];
-    outputs: readonly Note[];
+    outputs: readonly (Note | {
+        identity: Hex;
+        amount: bigint;
+        note?: Note;
+    })[];
     authorization?: AuthorizedStatement;
     target?: ProofTarget;
 }

package/dist/index.d.ts

@@ -3,7 +3,7 @@ import { Hex, Address, ReceivingKeyLookup, PublicWallet, CreditDeliveryState, Au
 import { ContractRunner, Provider } from 'ethers';
 import { DeploymentContext, CanonicalBlock, ProtocolDeployment, ProtocolRpcClient } from '@invisi-labs/rpc';
 export { CanonicalBlock, DeploymentContext, Membership, ProtocolDataProvider, ProtocolDataStatus, ProtocolUpdateRange, ProtocolUpdates } from '@invisi-labs/rpc';
-import { F as FundingParams, D as Delivery, I as InputSource, C as CreateCreditParams, a as CancelCreditParams, b as CreditDrawParams, T as TopUpCreditParams, c as TransactRequest, S as ShieldParams, d as ShieldOutput, e as CrossTreeTransactParams } from './types-BCTQjKzw.js';
+import { F as FundingParams, D as Delivery, I as InputSource, C as CreateCreditParams, a as CancelCreditParams, b as CreditDrawParams, T as TopUpCreditParams, c as TransactRequest, S as ShieldParams, d as ShieldOutput, e as CrossTreeTransactParams } from './types-BmUlasOg.js';
 import { ProofTarget, CircuitName, ProofStatement, ProvingRequest } from '@invisi-labs/prover';
 
 interface RegistryContext {
@@ -18,7 +18,7 @@ interface RegistryReceivingKeys {
 }
 interface AddressRegistration {
     /** Nonzero EVM owner: 20 bytes or canonical zero-padded bytes32. */
-    walletIdentity: Hex;
+    ownerAddress: Hex;
     keys: RegistryReceivingKeys;
     /** The current registry nonce expected for this operation. */
     nonce: bigint;
@@ -108,6 +108,7 @@ declare const pad: (v: readonly bigint[], n: number) => bigint[];
 /** Receipt/transport validation must not reject unrelated future wallet codecs. */
 declare function normalizeOpaqueDelivery(value: Delivery, options?: {
     empty?: boolean;
+    allowEmpty?: boolean;
 }): Delivery;
 declare const deliveriesHash: (v: readonly Delivery[]) => Hex;
 declare function normalizeFunding(input?: FundingInput): FundingParams;
@@ -180,7 +181,7 @@ interface FactoryReader {
 interface RegistryReader extends Pick<ChainReader, "getChainId" | "getCode" | "getBlock" | "getLatestBlockNumber" | "getTransaction" | "getReceipt"> {
     /** Validate arbitrary ERC-1271 bytes for a contract owner; transport errors propagate. */
     isValidRegistrationSignature?(owner: Address, digest: Hex, signature: Hex): Promise<boolean>;
-    getRegistryNonce(context: RegistryContext, walletIdentity: Hex, block: CanonicalBlock): Promise<bigint>;
+    getRegistryNonce(context: RegistryContext, ownerAddress: Hex, block: CanonicalBlock): Promise<bigint>;
 }
 interface RegistrationPreparation {
     wallet: PublicWallet;
@@ -197,7 +198,7 @@ declare class RegistrationOperation {
     get id(): string;
     preview(): {
         update: boolean;
-        walletIdentity: Hex;
+        ownerAddress: Hex;
         keys: RegistryReceivingKeys;
         nonce: bigint;
         deadline: bigint;
@@ -293,7 +294,7 @@ declare class AddressRegistry {
     buildCall(registration: AddressRegistration, signature: `0x${string}`, options?: RegistrationOptions): RegistrationCalldata;
 }
 
-declare const CREATE_CREDIT_FIELDS: readonly ["token", "sources", "nullifiers", "creditCommitment", "changeCommitment", "owner", "expiry", "deadline"];
+declare const CREATE_CREDIT_FIELDS: readonly ["token", "sources", "nullifiers", "creditCommitment", "changeCommitment", "owner", "expiry", "deadline", "feeRecipient", "feeAmount"];
 /** Public checks cannot establish ownership or conservation: those are enforced by the proof. */
 declare function validateCreateCreditRequest(c: TransactionContext, p: CreateCreditParams, cs: readonly Delivery[], funding?: FundingInput): {
     sources: {
@@ -310,6 +311,8 @@ declare function validateCreateCreditRequest(c: TransactionContext, p: CreateCre
     deadline: bigint;
     deliveries: Delivery[];
     funding: FundingParams;
+    feeRecipient: `0x${string}`;
+    feeAmount: bigint;
     chainId: bigint;
     protocolAddress: Hex;
     tokenAddress: Hex;
@@ -436,6 +439,8 @@ declare function validateCancelCreditRequest(c: TransactionContext, p: CancelCre
     owner: `0x${string}`;
     amount: bigint;
     deadline: bigint;
+    feeRecipient: `0x${string}`;
+    feeAmount: bigint;
     chainId: bigint;
     protocolAddress: Hex;
     tokenAddress: Hex;
@@ -459,6 +464,8 @@ declare function validateTopUpCreditRequest(c: TransactionContext, p: TopUpCredi
         deadline: bigint;
         deliveries: Delivery[];
         funding: FundingParams;
+        feeRecipient: `0x${string}`;
+        feeAmount: bigint;
         chainId: bigint;
         protocolAddress: Hex;
         tokenAddress: Hex;
@@ -615,7 +622,7 @@ type TransactCapacity = (typeof TRANSACT_CAPACITIES)[number];
 declare function selectTransactCapacity(inputs: number, outputs: number): TransactCapacity;
 type TransactRequestParams = CrossTreeTransactParams;
 declare function normalizeTransactRequest(c: TransactionContext, p: TransactRequestParams, cs: readonly Delivery[], funding?: FundingInput): {
-    capacity: 112 | 14 | 56 | 168;
+    capacity: 14 | 56 | 112 | 168;
     sources: {
         treeId: bigint;
         merkleRoot: `0x${string}`;
@@ -632,6 +639,8 @@ declare function normalizeTransactRequest(c: TransactionContext, p: TransactRequ
     deliveriesHash: `0x${string}`;
     withdrawalAddress: `0x${string}`;
     withdrawalAmount: bigint;
+    feeRecipient: `0x${string}`;
+    feeAmount: bigint;
     deadline: bigint;
     depositAmount: bigint;
     depositPayer: `0x${string}`;
@@ -710,7 +719,7 @@ interface BuildTransactCalldataParams {
 }
 declare function buildTransactCalldata(p: BuildTransactCalldataParams): {
     data: `0x${string}`;
-    capacity: 112 | 14 | 56 | 168;
+    capacity: 14 | 56 | 112 | 168;
     approveAmount: bigint;
 };
 interface BuildTransactAggregateCalldataParams {
@@ -780,7 +789,7 @@ type AggregateMemberInput = Pick<TransactRequest, "params" | "deliveries"> & {
 };
 /** Atomic aggregate funding binds the member statement rather than the aggregate proof bytes. */
 declare function aggregateMemberRequestHash(c: TransactionContext, r: AggregateMemberInput): Hex;
-/** Router adapter business words (56 per member), not the aggregate circuit statement. */
+/** Router adapter business words (58 per member), not the aggregate circuit statement. */
 declare function aggregatePublicInputs(c: TransactionContext, requests: readonly AggregateMemberInput[]): `0x${string}`[];
 declare function encodeAggregateFundingTypedData(c: TransactionContext, r: AggregateMemberInput): {
     domain: {
@@ -830,7 +839,7 @@ declare class TokenProtocol {
     }): Promise<void>;
     transact(request: Omit<BuildTransactCalldataParams, "context">): {
         data: `0x${string}`;
-        capacity: 112 | 14 | 56 | 168;
+        capacity: 14 | 56 | 112 | 168;
         approveAmount: bigint;
         to: `0x${string}`;
         value: bigint;
@@ -900,7 +909,7 @@ declare class Protocol {
 }
 
 interface VerifyNoteCommitmentParams {
-    walletIdentity: `0x${string}`;
+    ownerAddress: `0x${string}`;
     tokenAddress: `0x${string}`;
     amount: bigint;
     nonce: `0x${string}`;
@@ -943,7 +952,11 @@ interface CreditMembership {
 }
 interface TransactWitnessParams extends Omit<BuildTransactCalldataParams, "proof" | "context"> {
     inputs: readonly NoteMembership[];
-    outputs: readonly Note[];
+    outputs: readonly (Note | {
+        identity: Hex;
+        amount: bigint;
+        note?: Note;
+    })[];
     authorization?: AuthorizedStatement;
     target?: ProofTarget;
 }