Struct SafePayloadGenerator

pub struct SafePayloadGenerator { /* private fields */ }

Payload generator that generates Safe-compliant ABI

Implementations

impl SafePayloadGenerator

pub fn new( chain_keypair: &ChainKeypair, contract_addrs: ContractAddresses, module: Address, ) -> Self

Trait Implementations

impl Clone for SafePayloadGenerator

fn clone(&self) -> SafePayloadGenerator

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SafePayloadGenerator

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PayloadGenerator<TypedTransaction> for SafePayloadGenerator

fn approve(&self, spender: Address, amount: Balance) -> Result<TypedTransaction>

Create a ERC20 approve transaction payload. Pre-requisite to open payment channels. The spender address is typically the HOPR Channels contract address.

fn transfer( &self, destination: Address, amount: Balance, ) -> Result<TypedTransaction>

Create a ERC20 transfer transaction payload

fn announce(&self, announcement: AnnouncementData) -> Result<TypedTransaction>

Creates the transaction payload to announce a node on-chain.

fn fund_channel( &self, dest: Address, amount: Balance, ) -> Result<TypedTransaction>

Creates the transaction payload to open a payment channel

fn close_incoming_channel(&self, source: Address) -> Result<TypedTransaction>

Creates the transaction payload to immediately close an incoming payment channel

fn initiate_outgoing_channel_closure( &self, destination: Address, ) -> Result<TypedTransaction>

Creates the transaction payload that initiates the closure of a payment channel. Once the notice period is due, the funds can be withdrawn using a finalizeChannelClosure transaction.

fn finalize_outgoing_channel_closure( &self, destination: Address, ) -> Result<TypedTransaction>

Creates a transaction payload that withdraws funds from an outgoing payment channel. This will succeed once the closure notice period is due.

fn redeem_ticket( &self, acked_ticket: RedeemableTicket, ) -> Result<TypedTransaction>

Used to create the payload to claim incentives for relaying a mixnet packet.

fn register_safe_by_node(&self, safe_addr: Address) -> Result<TypedTransaction>

Creates a transaction payload to register a Safe instance which is used to manage the node’s funds

fn deregister_node_by_safe(&self) -> Result<TypedTransaction>

Creates a transaction payload to remove the Safe instance. Once succeeded, the funds are no longer managed by the node.