Class TxInvoice

A concrete implementation of ITxInvoice.

Inheritance
Object
TxInvoice
Implements
Inherited Members
System.Object.GetType()
Namespace: Libplanet.Types.Tx
Assembly: Libplanet.Types.dll
Syntax
public sealed class TxInvoice : ITxInvoice, IEquatable<ITxInvoice>, IEquatable<TxInvoice>

Constructors

| Improve this Doc View Source

TxInvoice(ITxInvoice)

Creates a new TxInvoice instance by copying everything from another invoice.

Declaration
public TxInvoice(ITxInvoice invoice)
Parameters
Type Name Description
ITxInvoice invoice

Another invoice to copy data from.
See Also
| Improve this Doc View Source

TxInvoice(Nullable<BlockHash>, DateTimeOffset, TxActionList, Nullable<FungibleAssetValue>, Nullable<Int64>)

Creates a new TxInvoice instance by filling data for its fields.

Declaration
public TxInvoice(BlockHash? genesisHash, DateTimeOffset timestamp, TxActionList actions, FungibleAssetValue? maxGasPrice, long? gasLimit)
Parameters
Type Name Description
Nullable<BlockHash> genesisHash

The value for GenesisHash.
DateTimeOffset timestamp

The value for Timestamp.
TxActionList actions

The value of Actions.
Nullable<FungibleAssetValue> maxGasPrice

The value of MaxGasPrice.
Nullable<System.Int64> gasLimit

The value of langword_csharp_Gas limit.
Exceptions
Type Condition
System.ArgumentNullException

Thrown when updatedAddresses or actions is null.
ArgumentException

Thrown when null-ness of maxGasPrice and gasLimit are not the same.
See Also
| Improve this Doc View Source

TxInvoice(Nullable<BlockHash>, Nullable<DateTimeOffset>, TxActionList, Nullable<FungibleAssetValue>, Nullable<Int64>)

Creates a new TxInvoice instance by filling data for its fields. There are some default values for some fields.

Declaration
public TxInvoice(BlockHash? genesisHash = null, DateTimeOffset? timestamp = null, TxActionList actions = null, FungibleAssetValue? maxGasPrice = null, long? gasLimit = null)
Parameters
Type Name Description
Nullable<BlockHash> genesisHash

The value for GenesisHash.
Nullable<DateTimeOffset> timestamp

The value for Timestamp. Time of creation by default.
TxActionList actions

The value of Actions. TxActionList by default.
Nullable<FungibleAssetValue> maxGasPrice

The value of MaxGasPrice.
Nullable<System.Int64> gasLimit

The value of langword_csharp_Gas limit.
See Also

Properties

| Improve this Doc View Source

Actions

A list of actions in this transaction.

Declaration
[JsonConverter(typeof(TxActionListJsonConverter))]
public TxActionList Actions { get; }
Property Value
Type Description
TxActionList
See Also
| Improve this Doc View Source

GasLimit

The limit on the total amount of gas that the Transaction can use.

If null, gas processing is entirely bypassed. The parity of null-ness is always the same as that of MaxGasPrice.

If not null, this value cannot be negative.

Declaration
public long? GasLimit { get; }
Property Value
Type Description
Nullable<System.Int64>
See Also
| Improve this Doc View Source

GenesisHash

A BlockHash value of the genesis which this transaction is made from. This can be null iff the transaction is contained in the genesis block.

Declaration
public BlockHash? GenesisHash { get; }
Property Value
Type Description
Nullable<BlockHash>
See Also
| Improve this Doc View Source

MaxGasPrice

The maximum amount of FungibleAssetValue that the Transaction's author is willing to pay per gas for the Transaction.

If null, gas processing is entirely bypassed. The parity of null-ness is always the same as that of GasLimit.

If not null, this value cannot be negative.

Declaration
public FungibleAssetValue? MaxGasPrice { get; }
Property Value
Type Description
Nullable<FungibleAssetValue>
See Also
| Improve this Doc View Source

Timestamp

The time this transaction is created and signed.

Declaration
public DateTimeOffset Timestamp { get; }
Property Value
Type Description
DateTimeOffset
See Also
| Improve this Doc View Source

UpdatedAddresses

A deprecated property which was used as an approximated list of addresses whose states would be affected by actions in this transaction.

This is no longer officially supported in the sense that a Transaction cannot be created with a non-empty set of Addresses through normal means (i.e. using intended APIs).

It is still possible to create a Transaction through other means, such as creating a payload directly by assigning appropriate values and signing an "unsigned transaction". This is not recommended.

Declaration
public IImmutableSet<Address> UpdatedAddresses { get; }
Property Value
Type Description
IImmutableSet<Address>
See Also

Methods

| Improve this Doc View Source

Equals(TxInvoice)

A concrete implementation of ITxInvoice.

Declaration
[Pure]
public bool Equals(TxInvoice other)
Parameters
Type Name Description
TxInvoice other
Returns
Type Description
System.Boolean
See Also
| Improve this Doc View Source

Equals(Object)

A concrete implementation of ITxInvoice.

Declaration
[Pure]
public override bool Equals(object obj)
Parameters
Type Name Description
Object obj
Returns
Type Description
System.Boolean
Overrides
See Also
| Improve this Doc View Source

GetHashCode()

A concrete implementation of ITxInvoice.

Declaration
[Pure]
public override int GetHashCode()
Returns
Type Description
Int32
Overrides
See Also
| Improve this Doc View Source

ToString()

A concrete implementation of ITxInvoice.

Declaration
[Pure]
public override string ToString()
Returns
Type Description
String
Overrides
System.Object.ToString()
See Also

Explicit Interface Implementations

| Improve this Doc View Source

IEquatable<ITxInvoice>.Equals(ITxInvoice)

A concrete implementation of ITxInvoice.

Declaration
[Pure]
bool IEquatable<ITxInvoice>.Equals(ITxInvoice other)
Parameters
Type Name Description
ITxInvoice other
Returns
Type Description
System.Boolean
See Also

Implements

Extension Methods

See Also