com.beowulfchain.beowulfj.protocol.operations

Class SupernodeUpdateOperation

java.lang.Object

com.beowulfchain.beowulfj.protocol.operations.BaseOperation

com.beowulfchain.beowulfj.protocol.operations.Operation

com.beowulfchain.beowulfj.protocol.operations.SupernodeUpdateOperation

All Implemented Interfaces:

ByteTransformable, Validatable

public class SupernodeUpdateOperation
extends Operation

This class represents the Beowulf "supernode_update_operation" object.

Constructor Summary

Constructors

Constructor and Description
SupernodeUpdateOperation(AccountName owner, PublicKey blockSigningKey, Asset fee) Create a new supernode update operation.

Method Summary

Modifier and Type	Method and Description
PublicKey	getBlockSigningKey() Get the public key of the key pair that will be used to sign blocks.
Asset	getFee() Get the fee that has been paid for this supernode update.
AccountName	getOwner() Get the account name of the account for that the supernode update operation has been executed.
Map<SignatureObject,PrivateKeyType>	getRequiredAuthorities(Map<SignatureObject,PrivateKeyType> requiredAuthoritiesBase) Add the authorities which are required to sign this operation to an existing map.
void	setBlockSigningKey(PublicKey blockSigningKey) Set the public key of the key pair that will be used to sign blocks.
void	setFee(Asset fee) Set the fee that should be paid for this supernode update.
void	setOwner(AccountName owner) Set the account name of the account for that the supernode update operation should be executed.
byte[]	toByteArray() Covert the operation into a byte array.
String	toString()
void	validate(ValidationType validationType) Use this method to verify that this object is valid.

Methods inherited from class com.beowulfchain.beowulfj.protocol.operations.Operation

isVirtual, mergeRequiredAuthorities, mergeRequiredAuthorities

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SupernodeUpdateOperation

public SupernodeUpdateOperation(AccountName owner,
                                PublicKey blockSigningKey,
                                Asset fee)

Create a new supernode update operation.

Users who wish to become a supernode must pay a fee acceptable to the current supernodes to apply for the position and allow voting to begin.

If the owner isn't a supernode they will become a supernode. Supernodes are charged a fee equal to 1 weeks worth of supernode pay which in turn is derived from the current share supply. The fee is only applied if the owner is not already a supernode.

If the blockSigningKey is null then the supernode is removed from contention. The network will pick the top 21 supernodes for producing blocks.

Parameters:

owner - The Supernode account name to set (see

blockSigningKey - The public part of the key used to sign a block (see setBlockSigningKey(PublicKey)).

fee - The fee to pay for this update (see setFee(Asset)).

Method Detail

getOwner

public AccountName getOwner()

Get the account name of the account for that the supernode update operation has been executed.

Returns:

The name of the account that this operation has been executed for.

setOwner

public void setOwner(AccountName owner)

Set the account name of the account for that the supernode update operation should be executed. Notice: The private active key of this account needs to be stored in the key storage.

Parameters:

owner - The name of the account that this operation should be executed for.

Throws:

InvalidParameterException - If the owner is null.

getBlockSigningKey

public PublicKey getBlockSigningKey()

Get the public key of the key pair that will be used to sign blocks.

Returns:

The public key of the key pair that will be used to sign blocks.

setBlockSigningKey

public void setBlockSigningKey(PublicKey blockSigningKey)

Set the public key of the key pair that will be used to sign blocks.

Parameters:

blockSigningKey - The public key of the key pair that will be used to sign blocks.

Throws:

InvalidParameterException - If the blockSigningKey is null.

getFee

public Asset getFee()

Get the fee that has been paid for this supernode update.

Returns:

The fee that has been paid for this supernode update.

setFee

public void setFee(Asset fee)

Set the fee that should be paid for this supernode update. The fee paid to register a new supernode, should be 10x current block production pay.

Parameters:

fee - The fee that should be paid for this supernode update.

Throws:

InvalidParameterException - If the provided asset object is null.

toByteArray

public byte[] toByteArray()
                   throws BeowulfInvalidTransactionException

Description copied from interface: ByteTransformable

Covert the operation into a byte array.

Returns:

The operation as a byte array.

Throws:

BeowulfInvalidTransactionException - If there was a problem while transforming the transaction into a byte array.

toString

public String toString()

Overrides:

toString in class Operation

getRequiredAuthorities

public Map<SignatureObject,PrivateKeyType> getRequiredAuthorities(Map<SignatureObject,PrivateKeyType> requiredAuthoritiesBase)

Description copied from class: Operation

Add the authorities which are required to sign this operation to an existing map.

Specified by:

getRequiredAuthorities in class Operation

Parameters:

requiredAuthoritiesBase - A map to which the required authorities of this operation should be added to.

Returns:

A map of required authorities.

validate

public void validate(ValidationType validationType)

Description copied from interface: Validatable

Use this method to verify that this object is valid.

Parameters:

validationType - An indicator telling the method what should be validated.