Class Buy

Namespace

Nekoyume.Action

Assembly

Lib9c.dll

Updated at https://github.com/planetarium/lib9c/pull/1164

[Serializable]
[ActionObsolete(8324909)]
[ActionType("buy12")]
public class Buy : GameAction, IBuy5, IAction, IBuyV2

Inheritance

object

ActionBase

GameAction

Buy

Implements

IBuy5

IAction

IBuyV2

Inherited Members

GameAction.Id

GameAction.PlainValue

GameAction.LoadPlainValue(IValue)

ActionBase.GetSignerAndOtherAddressesHex(IActionContext, params Address[])

ActionBase.TryGetAdminState(IActionContext, out AdminState)

ActionBase.CheckPermission(IActionContext)

ActionBase.CheckObsolete(long, IActionContext)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Fields

ErrorCodeDuplicateSell

public const int ErrorCodeDuplicateSell = 10

Field Value

int

ErrorCodeFailedLoadingState

public const int ErrorCodeFailedLoadingState = 1

Field Value

int

ErrorCodeInsufficientBalance

public const int ErrorCodeInsufficientBalance = 4

Field Value

int

ErrorCodeInvalidAddress

public const int ErrorCodeInvalidAddress = 5

Field Value

int

ErrorCodeInvalidItemType

public const int ErrorCodeInvalidItemType = 9

Field Value

int

ErrorCodeInvalidOrderId

public const int ErrorCodeInvalidOrderId = 7

Field Value

int

ErrorCodeInvalidPrice

public const int ErrorCodeInvalidPrice = 6

Field Value

int

ErrorCodeInvalidTradableId

public const int ErrorCodeInvalidTradableId = 8

Field Value

int

ErrorCodeItemDoesNotExist

public const int ErrorCodeItemDoesNotExist = 2

Field Value

int

ErrorCodeShopItemExpired

public const int ErrorCodeShopItemExpired = 3

Field Value

int

TaxRate

public const int TaxRate = 8

Field Value

int

errors

public List<(Guid orderId, int errorCode)> errors

Field Value

List<(Guid orderId, int errorCode)>

purchaseInfos

public IEnumerable<PurchaseInfo> purchaseInfos

Field Value

IEnumerable<PurchaseInfo>

Properties

PlainValueInternal

protected override IImmutableDictionary<string, IValue> PlainValueInternal { get; }

Property Value

IImmutableDictionary<string, IValue>

buyerAvatarAddress

public Address buyerAvatarAddress { get; set; }

Property Value

Address

Methods

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

LoadPlainValueInternal(IImmutableDictionary<string, IValue>)

protected override void LoadPlainValueInternal(IImmutableDictionary<string, IValue> plainValue)

Parameters

plainValue IImmutableDictionary<string, IValue>