Class ExitOperation

Constructs and executes an exit from the root chain.

Hierarchy

ExitOperation

Index

Constructors

constructor

Methods

Constructors

constructor

new ExitOperation(contract: PlasmaContract, client: IRootClient, from: string): ExitOperation

- Defined in operations/ExitOperation.ts:21
Constructs an ExitOperation.

Parameters
- contract: PlasmaContract
  
  An instance of the Plasma smart contract.
- client: IRootClient
  
  An instance of the Plasma root node gRPC client.
- from: string
  
  The address whose outpoints are to be exited.
Returns ExitOperation

Methods

exit

exit(): Promise<void>

- Defined in operations/ExitOperation.ts:66
Performs the exit. Will throw an error if outpoint or committedFee aren't set.

Performing an exit entails the following steps:
1. Retrieving all transactions from the block referenced by outpoint.
2. Generating a Merkle proof-of-inclusion for the exiting transaction.
3. Starting the exit on the root chain.
Returns Promise<void>

withCommittedFee

withCommittedFee(committedFee: BN): ExitOperation

- Defined in operations/ExitOperation.ts:51
Sets the exit bond.

Parameters
- committedFee: BN
  
  The amount of the fee.
Returns ExitOperation

withOutpoint

withOutpoint(outpoint: Outpoint): ExitOperation

- Defined in operations/ExitOperation.ts:41
Sets the outpoint to be exited.

Parameters
- outpoint: Outpoint
  
  The outpoint.
Returns ExitOperation

Generated using TypeDoc