com.concordium.sdk.transactions

Class TransactionHeader

java.lang.Object

com.concordium.sdk.transactions.TransactionHeader

public class TransactionHeader
extends Object

Header for an AccountTransaction.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TransactionHeader.TransactionHeaderBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static int	BYTES
static int	COST_CONSTANT_A The "A" constant for NRG assignment.
static int	COST_CONSTANT_B The "B" constant for NRG assignment.

Constructor Summary

Constructors

Constructor and Description
TransactionHeader(@NonNull AccountAddress sender, @NonNull Nonce nonce, @NonNull UInt64 maxEnergyCost, @NonNull UInt32 payloadSize, @NonNull Expiry expiry)

Method Summary

Modifier and Type	Method and Description
static TransactionHeader.TransactionHeaderBuilder	builder()
static UInt64	calculateMaxEnergyCost(int signatureCount, int payloadSize, UInt64 transactionSpecificCost) Calculate the maximum amount of energy that can be spent on executing a transaction.
protected boolean	canEqual(Object other)
boolean	equals(Object o)
static TransactionHeader	fromBytes(ByteBuffer source)
@NonNull Expiry	getExpiry() A Unix timestamp indicating when the transaction should expire.
@NonNull UInt64	getMaxEnergyCost() The amount of energy allocated for executing this transaction.
@NonNull Nonce	getNonce() The sequence number of the transaction, sender (source) account nonce.
@NonNull UInt32	getPayloadSize() The size of the transaction payload in bytes.
@NonNull AccountAddress	getSender() The address of the account that is the source of the transaction.
int	hashCode()
TransactionHeader.TransactionHeaderBuilder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

COST_CONSTANT_A

public static final int COST_CONSTANT_A

The "A" constant for NRG assignment. This scales the effect of the number of signatures on the energy.

See Also:

Constant Field Values

COST_CONSTANT_B

public static final int COST_CONSTANT_B

The "B" constant for NRG assignment. This scales the effect of transaction size on the energy.

See Also:

Constant Field Values

BYTES

public static int BYTES

Constructor Detail

TransactionHeader

public TransactionHeader(@NonNull
                         @NonNull AccountAddress sender,
                         @NonNull
                         @NonNull Nonce nonce,
                         @NonNull
                         @NonNull UInt64 maxEnergyCost,
                         @NonNull
                         @NonNull UInt32 payloadSize,
                         @NonNull
                         @NonNull Expiry expiry)

Method Detail

fromBytes

public static TransactionHeader fromBytes(ByteBuffer source)

calculateMaxEnergyCost

public static UInt64 calculateMaxEnergyCost(int signatureCount,
                                            int payloadSize,
                                            UInt64 transactionSpecificCost)

Calculate the maximum amount of energy that can be spent on executing a transaction.

Parameters:

signatureCount - number of signatures in the transaction (TransactionSigner.size())

payloadSize - size of the transaction payload in bytes

transactionSpecificCost - cost of the specific transaction (payload) type

Returns:

the energy cost for the transaction, to be set in the transaction header.

See Also:

TransactionTypeCost

builder

public static TransactionHeader.TransactionHeaderBuilder builder()

toBuilder

public TransactionHeader.TransactionHeaderBuilder toBuilder()

getSender

@NonNull
public @NonNull AccountAddress getSender()

The address of the account that is the source of the transaction.

getNonce

@NonNull
public @NonNull Nonce getNonce()

The sequence number of the transaction, sender (source) account nonce. Transactions executed on an account must have sequential sequence numbers, starting from 1.

getMaxEnergyCost

@NonNull
public @NonNull UInt64 getMaxEnergyCost()

The amount of energy allocated for executing this transaction. This is the maximum amount of energy that can be spent on executing this transaction.

See Also:

calculateMaxEnergyCost(int, int, UInt64)

getPayloadSize

@NonNull
public @NonNull UInt32 getPayloadSize()

The size of the transaction payload in bytes.

getExpiry

@NonNull
public @NonNull Expiry getExpiry()

A Unix timestamp indicating when the transaction should expire. A transaction cannot be included in a block with a timestamp later than the transaction’s expiry time.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object