Package org.xrpl.xrpl4j.model.transactions

Interface SetRegularKey

All Superinterfaces:

Transaction

All Known Implementing Classes:

ImmutableSetRegularKey

@Immutable
public interface SetRegularKey
extends Transaction

A SetRegularKey transaction assigns, changes, or removes the regular key pair associated with an account.

You can protect your account by assigning a regular key pair to it and using it instead of the master key pair to sign transactions whenever possible. If your regular key pair is compromised, but your master key pair is not, you can use a SetRegularKey transaction to regain control of your account.

Field Summary

Fields inherited from interface org.xrpl.xrpl4j.model.transactions.Transaction

typeMap

Method Summary

Modifier and Type	Method	Description
static ImmutableSetRegularKey.Builder	builder()	Construct a builder for this class.
default TransactionFlags	flags()	Set of TransactionFlagss for this SetRegularKey, which only allows the tfFullyCanonicalSig flag, which is deprecated.
Optional<Address>	regularKey()	An Address that indicates the regular key pair to be assigned to the account.

Methods inherited from interface org.xrpl.xrpl4j.model.transactions.Transaction

account, accountTransactionId, delegate, fee, lastLedgerSequence, memos, networkId, sequence, signers, signingPublicKey, sourceTag, ticketSequence, transactionFlags, transactionSignature, transactionType, unknownFields, validateDelegateNotSameAsAccount

Method Details

builder

static ImmutableSetRegularKey.Builder builder()

Construct a builder for this class.

Returns:

An ImmutableSetRegularKey.Builder.

flags

@Default
default TransactionFlags flags()

Set of TransactionFlagss for this SetRegularKey, which only allows the tfFullyCanonicalSig flag, which is deprecated.

The value of the flags cannot be set manually, but exists for JSON serialization/deserialization only and for proper signature computation in rippled.

Returns:

Always TransactionFlags.EMPTY.

regularKey

Optional<Address> regularKey()

An Address that indicates the regular key pair to be assigned to the account. If omitted, removes any existing regular key pair from the account. Must not match the master key pair for the address.

Returns:

The Optional Address indicating the regular key pair to use.