Struct TIP20ChannelReserve 

pub struct TIP20ChannelReserve {
    pub channel_states: <Mapping<B256, PackedChannelState> as StorableType>::Handler,
    pub opened_this_tx: <Mapping<B256, bool> as StorableType>::Handler,
    pub channel_open_context_hash: <B256 as StorableType>::Handler,
    address: Address,
    storage: StorageCtx,
}

Fields

channel_states: <Mapping<B256, PackedChannelState> as StorableType>::Handler

opened_this_tx: <Mapping<B256, bool> as StorableType>::Handler

channel_open_context_hash: <B256 as StorableType>::Handler

address: Address

storage: StorageCtx

Implementations

impl TIP20ChannelReserve

pub fn new() -> Self

Creates an instance of the precompile.

Caution: This does not initialize the account, see Self::initialize.

fn __new(address: Address) -> Self

fn __initialize(&mut self) -> Result<()>

fn emit_event(&mut self, event: impl IntoLogData) -> Result<()>

pub fn emitted_events(&self) -> &Vec<LogData>

Available on crate features test-utils only.

pub fn clear_emitted_events(&mut self)

Available on crate features test-utils only.

pub fn assert_emitted_events(&self, expected: Vec<impl IntoLogData>)

Available on crate features test-utils only.

impl TIP20ChannelReserve

pub fn initialize(&mut self) -> Result<()>

Initializes the precompile storage layout.

pub fn set_channel_open_context_hash(&mut self, hash: B256) -> Result<()>

Seeds the enclosing transaction’s replay-protected context hash for open calls.

The handler seeds keccak256(encode_for_signing || sender) for every real transaction type. The value is stored in transient storage so batched open calls share the same transaction-derived hash and the context is automatically cleared before the next transaction. If this is not called, open reads zero from transient storage and reverts.

pub fn open(&mut self, msg_sender: Address, call: openCall) -> Result<B256>

Opens a channel and pulls the initial deposit from the payer into reserve.

Payees and integrators must independently decide whether any nonzero operator is acceptable before relying on the channel.

Payees cannot be zero or TIP-20 addresses. Virtual payees require a non-virtual operator. This prevents channels whose payee cannot receive direct payouts or submit vouchers itself.

pub fn settle(&mut self, msg_sender: Address, call: settleCall) -> Result<()>

Settles an increasing cumulative voucher, paying only the unsettled delta to the payee.

The payee can call directly. If an operator was set when the channel was opened, that operator can submit the payee’s voucher and route the payment to the descriptor payee.

pub fn top_up(&mut self, msg_sender: Address, call: topUpCall) -> Result<()>

Adds deposit to an existing channel and cancels a pending close request.

A zero top-up is allowed and only cancels a pending close request.

pub fn request_close( &mut self, msg_sender: Address, call: requestCloseCall, ) -> Result<()>

Starts the payer’s unilateral close timer.

Repeated calls are idempotent while the timer is active.

pub fn close(&mut self, msg_sender: Address, call: closeCall) -> Result<()>

Closes a channel from the payee side and refunds any uncaptured deposit to the payer.

The payee can call directly. If an operator was set when the channel was opened, that operator can close the channel and route any capture to the descriptor payee.

captureAmount can be below cumulativeAmount but cannot be below what has already settled. A new voucher is only required when the close captures more than settled.

pub fn withdraw( &mut self, msg_sender: Address, call: withdrawCall, ) -> Result<()>

Withdraws the payer’s remaining deposit after the close grace period has elapsed.

pub fn get_channel(&self, call: getChannelCall) -> Result<Channel>

Returns a descriptor with its current on-chain state.

pub fn get_channel_state( &self, call: getChannelStateCall, ) -> Result<ChannelState>

Returns the current state for a channel id, or the zero state for an empty slot.

pub fn get_channel_states_batch( &self, call: getChannelStatesBatchCall, ) -> Result<Vec<ChannelState>>

Returns current states for multiple channel ids.

pub fn compute_channel_id(&self, call: computeChannelIdCall) -> Result<B256>

Computes the deterministic channel id for a full channel descriptor.

pub fn get_voucher_digest(&self, call: getVoucherDigestCall) -> Result<B256>

Returns the EIP-712 digest that the payer or authorized signer must sign.

pub fn domain_separator(&self) -> Result<B256>

Returns the EIP-712 domain separator for this chain and precompile address.

fn now(&self) -> u64

Returns the current block timestamp as u64.

fn now_u32(&self) -> u32

Returns the current block timestamp as the packed close-request representation.

fn channel_id(&self, descriptor: &ChannelDescriptor) -> Result<B256>

Computes the channel id from a descriptor.

fn ensure_payee_or_operator( msg_sender: Address, descriptor: &ChannelDescriptor, ) -> Result<()>

Ensures the caller is the payee or the descriptor’s nonzero operator.

fn enclosing_channel_open_context_hash(&self) -> Result<B256>

Loads the transaction-scoped nonce hash seeded by the handler.

fn compute_channel_id_inner( &self, payer: Address, payee: Address, operator: Address, token: Address, salt: B256, authorized_signer: Address, expiring_nonce_hash: B256, ) -> Result<B256>

Computes the channel id including chain and precompile domain separation.

fn load_existing_state(&self, channel_id: B256) -> Result<PackedChannelState>

Loads an active channel or returns ChannelNotFound.

fn expected_signer(&self, descriptor: &ChannelDescriptor) -> Address

Returns the address authorized to sign vouchers for this descriptor.

fn validate_voucher( &self, descriptor: &ChannelDescriptor, channel_id: B256, cumulative_amount: U96, signature: &Bytes, ) -> Result<()>

Validates a voucher signature against the descriptor’s expected signer.

fn get_voucher_digest_inner( &self, channel_id: B256, cumulative_amount: U96, ) -> Result<B256>

Computes the EIP-712 voucher digest.

impl TIP20ChannelReserve

pub fn create_precompile( cfg: &CfgEnv<TempoHardfork>, actions: StorageActions, ) -> DynPrecompile

Creates the EVM precompile for this type.

Trait Implementations

impl ContractStorage for TIP20ChannelReserve

fn address(&self) -> Address

Contract address.

fn storage(&self) -> &StorageCtx

Contract storage accessor.

fn storage_mut(&mut self) -> &mut StorageCtx

Contract storage mutable accessor.

fn is_initialized(&self) -> Result<bool>

Returns true if the contract has been initialized (has bytecode deployed).

impl Default for TIP20ChannelReserve

fn default() -> Self

Returns the “default value” for a type.

impl Precompile for TIP20ChannelReserve

fn call(&mut self, calldata: &[u8], msg_sender: Address) -> PrecompileResult

Dispatches an EVM call to this precompile.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 296 bytes