Finance

Claim the toToken corresponding to account's deposit in batch with id batchId.

Quit the batch with id batchId. Entire deposit is returned to the user. This can only be called if the batch has not yet been dispatched or if the batch was canceled.

Permissionless function to dispatch the current batch. Increments the BatcherConfidential.currentBatchId.

Dispatch batch callback callable by anyone. This function finalizes the unwrap of BatcherConfidential.fromToken and calls BatcherConfidential._executeRoute to perform the batch's route. If _executeRoute returns ExecuteOutcome.Partial, this function should be called again with the same batchId, unwrapAmountCleartext, and decryptionProof.

See IERC7984Receiver.onConfidentialTransferReceived.

Deposit BatcherConfidential.fromToken into the current batch.

Batcher from token. Users deposit this token in exchange for BatcherConfidential.toToken.

Batcher to token. Users receive this token in exchange for their BatcherConfidential.fromToken deposits.

The ongoing batch id. New deposits join this batch.

The unwrap request id for a batch with id batchId.

The total deposits made in batch with id batchId.

The deposits made by account in batch with id batchId.

The exchange rate set for batch with id batchId.

The number of decimals of precision for the exchange rate.

Human readable description of what the batcher does.

Returns the current state of a batch. Reverts if the batch does not exist.

Claims toToken for account's deposit in batch with id batchId. Tokens are always sent to account, enabling third-party relayers to claim on behalf of depositors.

Joins a batch with amount amount on behalf of to. Does not do any transfers in. Returns the amount joined with.

Function which is executed by BatcherConfidential.dispatchBatchCallback after validation and unwrap finalization. The parameter amount is the plaintext amount of the fromToken which were unwrapped--to attain the underlying tokens received, evaluate amount * fromToken().rate(). This function should swap the underlying BatcherConfidential.fromToken for underlying BatcherConfidential.toToken.

This function returns an BatcherConfidential.ExecuteOutcome enum indicating the new state of the batch. If the route execution is complete, the balance of the underlying BatcherConfidential.toToken is wrapped and the exchange rate is set.

[WARNING]

This function must eventually return ExecuteOutcome.Complete or ExecuteOutcome.Cancel. Failure to do so results

in user deposits being locked indefinitely.

Additionally, the following must hold:

• swappedAmount >= ceil(unwrapAmountCleartext / 10 ** exchangeRateDecimals()) * toToken().rate() (the exchange rate must not be 0)
• swappedAmount \<= type(uint64).max * toToken().rate() (the wrapped amount of BatcherConfidential.toToken must fit in uint64)

Check that the current state of a batch matches the requirements described by the allowedStates bitmap. This bitmap should be built using _encodeStateBitmap.

If requirements are not met, reverts with a BatcherConfidential.BatchUnexpectedState error.

Gets the current batch id and increments it.

Encodes a BatchState into a bytes32 representation where each bit enabled corresponds to the underlying position in the BatchState enum. For example:

0x000...1000 ^--- Canceled ^-- Finalized ^- Dispatched ^ Pending

Emitted when a batch with id batchId is dispatched via BatcherConfidential.dispatchBatch.

Emitted when a batch with id batchId is canceled.

Emitted when a batch with id batchId is finalized with an exchange rate of exchangeRate.

Emitted when an account joins a batch with id batchId with a deposit of amount.

Emitted when an account claims their amount from batch with id batchId.

Emitted when an account quits a batch with id batchId.

The batchId does not exist. Batch IDs start at 1 and must be less than or equal to BatcherConfidential.currentBatchId.

The account has a zero deposits in batch batchId.

The batch batchId is in the state current, which is invalid for the operation. The expectedStates is a bitmap encoding the expected/allowed states for the operation.

See BatcherConfidential._encodeStateBitmap.

Thrown when the given exchange rate is invalid. The exchange rate must be non-zero and the wrapped amount of BatcherConfidential.toToken must be less than or equal to type(uint64).max.

The caller is not authorized to call this function.

The given token does not support IERC7984ERC20Wrapper via ERC165.

Trusted address that is able to execute arbitrary calls from the vesting wallet via ERC7821.execute.

Access control mechanism for the execute function. By default, only the contract itself is allowed to execute.

Override this function to implement custom access control, for example to allow the ERC-4337 entrypoint to execute.

function _erc7821AuthorizedExecutor(
  address caller,
  bytes32 mode,
  bytes calldata executionData
) internal view virtual override returns (bool) {
  return caller == address(entryPoint()) || super._erc7821AuthorizedExecutor(caller, mode, executionData);
}

The timestamp at which the cliff ends.

Set the duration of the cliff, in seconds. The cliff starts at the vesting start timestamp (see VestingWalletConfidential.start) and ends cliffSeconds later.

This function returns the amount vested, as a function of time, for an asset given its total historical allocation. Returns 0 if the VestingWalletCliffConfidential.cliff timestamp is not met.

The specified cliff duration is larger than the vesting duration.

Timestamp at which the vesting starts.

Duration of the vesting in seconds.

Timestamp at which the vesting ends.

Amount of token already released

Getter for the amount of releasable token tokens. token should be the address of an IERC7984 contract.

Release the tokens that have already vested.

Emits a VestingWalletConfidential.VestingWalletConfidentialTokenReleased event.

Calculates the amount of tokens that have been vested at the given timestamp. Default implementation is a linear vesting curve.

Initializes the vesting wallet for a given beneficiary with a start time of startTimestamp and an end time of startTimestamp + durationSeconds.

This returns the amount vested, as a function of time, for an asset given its total historical allocation.

Emitted when releasable vested tokens are released.

Batches the funding of multiple confidential vesting wallets.

Funds are sent to deterministic wallet addresses. Wallets can be created either before or after this operation.

Emits a VestingWalletConfidentialFactory.VestingWalletConfidentialFunded event for each funded vesting plan.

Creates a confidential vesting wallet.

Emits a VestingWalletConfidentialFactory.VestingWalletConfidentialCreated.

Predicts the deterministic address for a confidential vesting wallet.

Virtual function that must be implemented to validate the initArgs bytes.

Virtual function that must be implemented to initialize the vesting wallet at vestingWalletAddress.

Internal function that is called once to deploy the vesting wallet implementation.

Vesting wallet clones will be initialized by calls to the VestingWalletConfidentialFactory._initializeVestingWallet function.

Gets create2 salt for a confidential vesting wallet.

Emitted for each vesting wallet funded within a batch.

Emitted when a vesting wallet is deployed.