Class SendOperation

Executes a send on the sidechain.

Hierarchy

SendOperation

Index

Constructors

constructor

Methods

Constructors

constructor

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

- Defined in operations/SendOperation.ts:25
Constructs a SendOperation.

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

Methods

forValue

forValue(value: BN): SendOperation

- Defined in operations/SendOperation.ts:55
The amount of funds to send.

Parameters
- value: BN
  
  The amount.
Returns SendOperation

send

send(privateKey: Buffer): Promise<ConfirmedTransaction>

- Defined in operations/SendOperation.ts:95
Performs the send. Will throw an error if to, value, or fee are not defined.

Performing a send entails the following steps:
1. Looking up the address's UTXO set.
2. Choosing the appropriate UTXOs to spend.
3. Generating and signing a transaction.
4. Sending that transaction to the root node.
5. Consuming the returned inclusion receipt, generating confirm signatures, and forwarding them to the root node.
Parameters
- privateKey: Buffer
Returns Promise<ConfirmedTransaction>

toAddress

toAddress(to: string): SendOperation

- Defined in operations/SendOperation.ts:45
The address to send funds to.

Parameters
- to: string
  
  The address.
Returns SendOperation

withDepositNonce

withDepositNonce(depositNonce: BN): SendOperation

- Defined in operations/SendOperation.ts:75
A deposit nonce. Set when spending a deposit.

Parameters
- depositNonce: BN
Returns SendOperation

withFee

withFee(fee: BN): SendOperation

- Defined in operations/SendOperation.ts:65
The fee amount to pay to the root node.

Parameters
- fee: BN
  
  The fee.
Returns SendOperation

Generated using TypeDoc