com.radixdlt.client.application.translate

Interface StatefulActionToParticleGroupsMapper<T extends Action>

All Known Implementing Classes:

BurnTokensActionMapper, MintTokensActionMapper, TransferTokensToParticleGroupsMapper

public interface StatefulActionToParticleGroupsMapper<T extends Action>

Maps a high level application action to lower level spun particles used to construct an atom given a context requirement which this interface describes via requiredState().

Method Summary

Modifier and Type	Method and Description
java.util.List<ParticleGroup>	mapToParticleGroups(T action, java.util.stream.Stream<Particle> store) Creates new particle groups to be added to an atom given a high level action and application state
java.util.Set<ShardedParticleStateId>	requiredState(T action) Retrieves the necessary application state to be used in creating new particles given a high level action.

Method Detail

requiredState

java.util.Set<ShardedParticleStateId> requiredState(T action)

Retrieves the necessary application state to be used in creating new particles given a high level action. The returned Observable describes the shardable and the type of state needed to create particles.

Parameters:

action - the action to get the required context about

Returns:

required contexts required to create spun particles for the action

mapToParticleGroups

java.util.List<ParticleGroup> mapToParticleGroups(T action,
                                                  java.util.stream.Stream<Particle> store)
                                           throws StageActionException

Creates new particle groups to be added to an atom given a high level action and application state

Parameters:

action - the action to map

store - particles as requested by requiredState()

Returns:

Particle groups created given an action

Throws:

StageActionException