org.stellar.sdk

Class SignerKey.Ed25519SignedPayload

java.lang.Object

org.stellar.sdk.SignerKey.Ed25519SignedPayload

Enclosing class:

SignerKey

public static final class SignerKey.Ed25519SignedPayload
extends java.lang.Object

Represents an Ed25519 signed payload as defined in CAP-40.

An Ed25519 signed payload consists of an Ed25519 public key and a payload of up to 64 bytes. The signature for this signer type is produced by Ed25519 signing the payload with the private key that corresponds to the public key.

This signer type is particularly useful for multi-party contracts such as payment channels, where it allows all parties to share signatures for a set of transactions while ensuring that signing one transaction reveals the information needed to authorize related transactions.

The signature hint for this signer type is calculated as the XOR of the last 4 bytes of the Ed25519 public key and the last 4 bytes of the payload (padded with zeros if the payload is less than 4 bytes).

See Also:

CAP-40: Ed25519 Signed Payload Signer

Constructor Summary

Constructors

Constructor and Description
Ed25519SignedPayload(byte[] ed25519PublicKey, byte[] payload) Creates a new Ed25519SignedPayload.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
byte[]	getEd25519PublicKey() The Ed25519 public key (32 bytes) that must sign the payload.
java.lang.String	getEncodedEd25519PublicKey() Gets the StrKey-encoded representation of the Ed25519 public key.
byte[]	getPayload() The payload to be signed (up to 64 bytes).
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Ed25519SignedPayload

public Ed25519SignedPayload(byte[] ed25519PublicKey,
                            byte[] payload)

Creates a new Ed25519SignedPayload.

Parameters:

ed25519PublicKey - The 32-byte Ed25519 public key

payload - The payload to be signed (maximum 64 bytes)

Throws:

java.lang.IllegalArgumentException - if the payload length exceeds the maximum allowed

Method Detail

getEncodedEd25519PublicKey

public java.lang.String getEncodedEd25519PublicKey()

Gets the StrKey-encoded representation of the Ed25519 public key.

Returns:

The StrKey-encoded Ed25519 public key (starts with 'G')

getEd25519PublicKey

public byte[] getEd25519PublicKey()

The Ed25519 public key (32 bytes) that must sign the payload.

getPayload

public byte[] getPayload()

The payload to be signed (up to 64 bytes).

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object