Show / Hide Table of Contents

Class TxInvoice

A concrete implementation of ITxInvoice.

Inheritance
Object
TxInvoice
Implements
ITxInvoice
IEquatable<ITxInvoice>
IEquatable<TxInvoice>
Inherited Members
Object.Equals(Object, Object)
Object.GetType()
Object.MemberwiseClone()
Object.ReferenceEquals(Object, Object)
Namespace: Libplanet.Tx
Assembly: Libplanet.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
ITxInvoice
TxSigningMetadata
UnsignedTx
Transaction
| Improve this Doc View Source

TxInvoice(Nullable<BlockHash>, IEnumerable<Address>, Nullable<DateTimeOffset>, TxActionList)

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, IEnumerable<Address> updatedAddresses = null, DateTimeOffset? timestamp = null, TxActionList actions = null)
Parameters
Type Name Description
Nullable<BlockHash> genesisHash

The value for GenesisHash.

IEnumerable<Address> updatedAddresses

The value for UpdatedAddresses. Empty by default.

Nullable<DateTimeOffset> timestamp

The value for Timestamp. Time of creation by default.

TxActionList actions

The value of Actions. TxActionList by default.

See Also
ITxInvoice
TxSigningMetadata
UnsignedTx
Transaction
| Improve this Doc View Source

TxInvoice(Nullable<BlockHash>, IImmutableSet<Address>, DateTimeOffset, TxActionList)

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

Declaration
public TxInvoice(BlockHash? genesisHash, IImmutableSet<Address> updatedAddresses, DateTimeOffset timestamp, TxActionList actions)
Parameters
Type Name Description
Nullable<BlockHash> genesisHash

The value for GenesisHash.

IImmutableSet<Address> updatedAddresses

The value for UpdatedAddresses.

DateTimeOffset timestamp

The value for Timestamp.

TxActionList actions

The value of Actions.

Exceptions
Type Condition
ArgumentNullException

Thrown when updatedAddresses or actions is null.

See Also
ITxInvoice
TxSigningMetadata
UnsignedTx
Transaction

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
ITxInvoice
TxSigningMetadata
UnsignedTx
Transaction
| Improve this Doc View Source

GenesisHash

A HashDigest<T> 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
ITxInvoice
TxSigningMetadata
UnsignedTx
Transaction
| 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
ITxInvoice
TxSigningMetadata
UnsignedTx
Transaction
| Improve this Doc View Source

UpdatedAddresses

An approximated list of addresses whose states would be affected by actions in this transaction. However, it could be wrong.

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

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
Boolean
See Also
ITxInvoice
TxSigningMetadata
UnsignedTx
Transaction
| 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
Boolean
Overrides
Object.Equals(Object)
See Also
ITxInvoice
TxSigningMetadata
UnsignedTx
Transaction
| Improve this Doc View Source

GetHashCode()

A concrete implementation of ITxInvoice.

Declaration
[Pure]
public override int GetHashCode()
Returns
Type Description
Int32
Overrides
Object.GetHashCode()
See Also
ITxInvoice
TxSigningMetadata
UnsignedTx
Transaction
| Improve this Doc View Source

ToString()

A concrete implementation of ITxInvoice.

Declaration
[Pure]
public override string ToString()
Returns
Type Description
String
Overrides
Object.ToString()
See Also
ITxInvoice
TxSigningMetadata
UnsignedTx
Transaction

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
Boolean
See Also
ITxInvoice
TxSigningMetadata
UnsignedTx
Transaction

Implements

ITxInvoice
System.IEquatable<T>
System.IEquatable<T>

Extension Methods

TransactionExtensions.Combine(ITxInvoice, ITxSigningMetadata)
TransactionExtensions.Sign(ITxInvoice, PrivateKey, Int64)
TxMarshaler.MarshalTxInvoice(ITxInvoice)

See Also

ITxInvoice
TxSigningMetadata
UnsignedTx
Transaction
  • Improve this Doc
  • View Source
In This Article
Back to top Copyright © 2018–2023 Planetarium