Class ValidatorSetOperate

Namespace

Nekoyume.Action

Assembly

Lib9c.dll

[Serializable]
[ActionType("op_validator_set")]
public sealed class ValidatorSetOperate : ActionBase, IAction, IEquatable<ValidatorSetOperate>

Inheritance

object

ActionBase

ValidatorSetOperate

Implements

IAction

IEquatable<ValidatorSetOperate>

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ValidatorSetOperate()

public ValidatorSetOperate()

ValidatorSetOperate(ValidatorSetOperatorType, Validator)

public ValidatorSetOperate(ValidatorSetOperatorType @operator, Validator operand)

Parameters

operator ValidatorSetOperatorType

operand Validator

Fields

TypeIdentifier

public const string TypeIdentifier = "op_validator_set"

Field Value

string

ValidatorSetOperateKey

public static readonly string ValidatorSetOperateKey

Field Value

string

Properties

Error

public string Error { get; }

Property Value

string

Operand

public Validator Operand { get; }

Property Value

Validator

Operator

public ValidatorSetOperatorType Operator { get; }

Property Value

ValidatorSetOperatorType

PlainValue

Serializes values bound to an action, which is held by properties (or fields) of an action, so that they can be transmitted over network or saved to persistent storage.

Serialized values are deserialized by Libplanet.Action.IAction.LoadPlainValue(Bencodex.Types.IValue) method later.

public override IValue PlainValue { get; }

Property Value

IValue

A Bencodex value which encodes this action's bound values (held by properties or fields).

See Also

LoadPlainValue(IValue)

Methods

Append(Validator)

public static ValidatorSetOperate Append(Validator operand)

Parameters

operand Validator

Returns

ValidatorSetOperate

Equals(ValidatorSetOperate)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(ValidatorSetOperate other)

Parameters

other ValidatorSetOperate

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

Equals(object)

Determines whether the specified object is equal to the current object.

public override bool Equals(object obj)

Parameters

obj object

The object to compare with the current object.

Returns

bool

true if the specified object is equal to the current object; otherwise, false.

Execute(IActionContext)

Executes the main game logic of an action. This should be deterministic.

Through the context object, it receives information such as a transaction signer, its states immediately before the execution, and a deterministic random seed.

Other “bound” information resides in the action object in itself, as its properties (or fields).

A returned Libplanet.Action.State.IWorld object functions as a delta which shifts from previous states to next states.

public override IWorld Execute(IActionContext context)

Parameters

context IActionContext

A context object containing addresses that signed the transaction, states immediately before the execution, and a PRNG object which produces deterministic random numbers. See Libplanet.Action.IActionContext for details.

Returns

IWorld

A map of changed states (so-called "dirty").

Remarks

This method should be deterministic: for structurally (member-wise) equal actions and Libplanet.Action.IActionContexts, the same result should be returned. Side effects should be avoided, because an action's Libplanet.Action.IAction.Execute(Libplanet.Action.IActionContext) method can be called more than once, the time it's called is difficult to predict.

For changing in-memory game states or drawing graphics, implement the Blockchain.Renderers.IRenderer interface separately and attach it to a Blockchain.BlockChain instance.

For randomness, never use Random nor any other PRNGs provided by other than Libplanet. Use IActionContext.Random instead. IActionContext.Random guarantees the same action has the consistent result for every node in the network.

Also do not perform I/O operations such as file system access or networking. These bring an action indeterministic. You maybe fine to log messages for debugging purpose, but equivalent messages could be logged multiple times.

Although it might be surprising, floating-point arithmetics are underspecified so that it can make different results on different machines, platforms, runtimes, compilers, and builds.

Lastly, you need to be aware and keep in mind that there is a global state named CurrentCulture on .NET; if you format numbers, dates and times, currencies, or other such things into strings and parse these strings back these can rely on CurrentCulture, so that the same action make different results on two differently configured systems like Thai language and French language. In order to make these types of conversions deterministic, you have to explicitly pass InvariantCulture.

For more on determinism in general, please read also Tendermint ABCI's docs on determinism.

Lastly, you can conduct static analysis on your code using Libplanet.Analyzers. The analyzer can be enabled by adding its NuGet package into your project as a dependency.

See Also

IActionContext

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

LoadPlainValue(IValue)

Deserializes serialized data (i.e., data Libplanet.Action.IAction.PlainValue property made), and then fills this action's properties (or fields) with the deserialized values.

public override void LoadPlainValue(IValue plainValue)

Parameters

plainValue IValue

Data (made by Libplanet.Action.IAction.PlainValue property) to be deserialized and assigned to this action's properties (or fields).

See Also

PlainValue

Remove(Validator)

public static ValidatorSetOperate Remove(Validator operand)

Parameters

operand Validator

Returns

ValidatorSetOperate

Update(Validator)

public static ValidatorSetOperate Update(Validator operand)

Parameters

operand Validator

Returns

ValidatorSetOperate