com.radixdlt.client.application

Class RadixApplicationAPI.Transaction

java.lang.Object

com.radixdlt.client.application.RadixApplicationAPI.Transaction

Enclosing class:

RadixApplicationAPI

public final class RadixApplicationAPI.Transaction
extends java.lang.Object

Represents an atomic transaction to be committed to the ledger

Method Summary

Modifier and Type	Method and Description
void	addToWorkingArea(Action action) Add an action to the working area
UnsignedAtom	buildAtom() Creates an atom composed of all of the currently staged particles.
RadixApplicationAPI.Result	commitAndPush() Commit the transaction onto the ledger
RadixApplicationAPI.Result	commitAndPush(RadixNode originNode) Commit the transaction onto the ledger
java.util.Set<ShardedParticleStateId>	getWorkingAreaRequirements() Retrieves the shards and particle types required to execute the actions in the current working area.
void	stage(Action action) Add an action to staging area in preparation for commitAndPush.
void	stageWorkingArea() Move all actions in the current working area to staging

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

addToWorkingArea

public void addToWorkingArea(Action action)

Add an action to the working area

Parameters:

action - action to add to the working area

getWorkingAreaRequirements

public java.util.Set<ShardedParticleStateId> getWorkingAreaRequirements()

Retrieves the shards and particle types required to execute the actions in the current working area.

Returns:

set of shard + particle types

stageWorkingArea

public void stageWorkingArea()
                      throws StageActionException

Move all actions in the current working area to staging

Throws:

StageActionException

stage

public void stage(Action action)
           throws StageActionException

Add an action to staging area in preparation for commitAndPush. Collects the necessary particles to make the action happen.

Parameters:

action - action to add to staging area.

Throws:

StageActionException

buildAtom

public UnsignedAtom buildAtom()

Creates an atom composed of all of the currently staged particles.

Returns:

an unsigned atom

commitAndPush

public RadixApplicationAPI.Result commitAndPush()

Commit the transaction onto the ledger

Returns:

the results of committing

commitAndPush

public RadixApplicationAPI.Result commitAndPush(RadixNode originNode)

Commit the transaction onto the ledger

Parameters:

originNode - the originNode to push to

Returns:

the results of committing