KeyPair (stellar-sdk 2.0.0-beta1 API)

java.lang.Object
- org.stellar.sdk.KeyPair

public class KeyPair
extends java.lang.Object

Holds a Stellar keypair.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`canSign()` Returns true if this Keypair is capable of signing
`boolean`	`equals(java.lang.Object object)`
`static KeyPair`	`fromAccountId(java.lang.String accountId)` Creates a new Stellar KeyPair from a strkey encoded Stellar account ID.
`static KeyPair`	`fromBip39Seed(byte[] bip39Seed, int accountNumber)` Finds the KeyPair for the path m/44'/148'/accountNumber' using the method described in SEP-0005.
`static KeyPair`	`fromPublicKey(byte[] publicKey)` Creates a new Stellar keypair from a 32 byte address.
`static KeyPair`	`fromSecretSeed(byte[] seed)` Creates a new Stellar keypair from a raw 32 byte secret seed.
`static KeyPair`	`fromSecretSeed(char[] seed)` Creates a new Stellar KeyPair from a strkey encoded Stellar secret seed.
`static KeyPair`	`fromSecretSeed(java.lang.String seed)` Insecure Creates a new Stellar KeyPair from a strkey encoded Stellar secret seed.
`static KeyPair`	`fromXdrPublicKey(PublicKey key)` Creates a new KeyPair from an XDR `PublicKey`.
`java.lang.String`	`getAccountId()` Returns the human-readable account ID encoded in strkey.
`byte[]`	`getPublicKey()` Returns the raw 32 byte public key.
`char[]`	`getSecretSeed()` Returns the human-readable secret seed encoded in strkey.
`SignatureHint`	`getSignatureHint()` Returns the signature hint for this keypair.
`AccountID`	`getXdrAccountId()` Returns the XDR `AccountID` for this keypair.
`PublicKey`	`getXdrPublicKey()` Returns the XDR `PublicKey` for this keypair.
`int`	`hashCode()`
`static KeyPair`	`random()` Generates a random Stellar keypair.
`byte[]`	`sign(byte[] data)` Sign the provided data with the keypair's private key.
`DecoratedSignature`	`signDecorated(byte[] data)` Sign the provided data with the keypair's private key and returns `DecoratedSignature`.
`byte[]`	`signMessage(byte[] message)` Sign a message according to SEP-53.
`byte[]`	`signMessage(java.lang.String message)` Sign a message according to SEP-53.
`DecoratedSignature`	`signPayloadDecorated(byte[] signerPayload)` Sign the provided payload data for payload signer where the input is the data being signed.
`boolean`	`verify(byte[] data, byte[] signature)` Verify the provided data and signature match this keypair's public key.
`boolean`	`verifyMessage(byte[] message, byte[] signature)` Verify a SEP-53 signed message.
`boolean`	`verifyMessage(java.lang.String message, byte[] signature)` Verify a SEP-53 signed message.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - canSign
```
public boolean canSign()
```
    Returns true if this Keypair is capable of signing
  - fromSecretSeed
```
public static KeyPair fromSecretSeed(char[] seed)
```
    Creates a new Stellar KeyPair from a strkey encoded Stellar secret seed.
    
    Parameters:
    
    seed - Char array containing strkey encoded Stellar secret seed.
    
    Returns:
    
    KeyPair
    
    Throws:
    
    java.lang.IllegalArgumentException - if the provided seed is invalid
  - fromSecretSeed
```
public static KeyPair fromSecretSeed(java.lang.String seed)
```
    Insecure Creates a new Stellar KeyPair from a strkey encoded Stellar secret seed. This method is insecure. Use only if you are aware of security implications.
    
    Parameters:
    
    seed - The strkey encoded Stellar secret seed.
    
    Returns:
    
    KeyPair
    
    Throws:
    
    java.lang.IllegalArgumentException - if the provided seed is invalid
    
    See Also:
    
    Using Password-Based Encryption
  - fromSecretSeed
```
public static KeyPair fromSecretSeed(byte[] seed)
```
    Creates a new Stellar keypair from a raw 32 byte secret seed.
    
    Parameters:
    
    seed - The 32 byte secret seed.
    
    Returns:
    
    KeyPair
    
    Throws:
    
    java.lang.IllegalArgumentException - if the provided seed is invalid
  - fromAccountId
```
public static KeyPair fromAccountId(java.lang.String accountId)
```
    Creates a new Stellar KeyPair from a strkey encoded Stellar account ID.
    
    Parameters:
    
    accountId - The strkey encoded Stellar account ID.
    
    Returns:
    
    KeyPair
    
    Throws:
    
    java.lang.IllegalArgumentException - if the provided account ID is invalid
  - fromPublicKey
```
public static KeyPair fromPublicKey(byte[] publicKey)
```
    Creates a new Stellar keypair from a 32 byte address.
    
    Parameters:
    
    publicKey - The 32 byte public key.
    
    Returns:
    
    KeyPair
    
    Throws:
    
    java.lang.IllegalArgumentException - if the provided public key is invalid
  - fromBip39Seed
```
public static KeyPair fromBip39Seed(byte[] bip39Seed,
                                    int accountNumber)
```
    Finds the KeyPair for the path m/44'/148'/accountNumber' using the method described in SEP-0005.
    You can generate a BIP39 seed using a library like mnemonic4j.
    
    Parameters:
    
    bip39Seed - The output of BIP0039
    
    accountNumber - The number of the account
    
    Returns:
    
    KeyPair with secret
    
    Throws:
    
    java.lang.IllegalArgumentException - if the provided bip39Seed is invalid
  - random
```
public static KeyPair random()
```
    Generates a random Stellar keypair.
    
    Returns:
    
    a random Stellar keypair.
  - getAccountId
```
public java.lang.String getAccountId()
```
    Returns the human-readable account ID encoded in strkey.
  - getSecretSeed
```
public char[] getSecretSeed()
```
    Returns the human-readable secret seed encoded in strkey.
    WARNING: This method returns the secret seed of the keypair. The secret seed should be handled with care and not be exposed to anyone else. Exposing the secret seed can lead to the theft of the account.
    
    Returns:
    
    char[] The secret seed of the keypair. If the keypair was created without a secret seed, this method will return null.
  - getPublicKey
```
public byte[] getPublicKey()
```
    Returns the raw 32 byte public key.
  - getSignatureHint
```
public SignatureHint getSignatureHint()
```
    Returns the signature hint for this keypair.
  - getXdrPublicKey
```
public PublicKey getXdrPublicKey()
```
    Returns the XDR PublicKey for this keypair.
  - getXdrAccountId
```
public AccountID getXdrAccountId()
```
    Returns the XDR AccountID for this keypair.
  - fromXdrPublicKey
```
public static KeyPair fromXdrPublicKey(PublicKey key)
```
    Creates a new KeyPair from an XDR PublicKey.
    
    Parameters:
    
    key - The XDR PublicKey object.
    
    Returns:
    
    KeyPair
  - sign
```
public byte[] sign(byte[] data)
```
    Sign the provided data with the keypair's private key.
    
    Parameters:
    
    data - The data to sign.
    
    Returns:
    
    signed bytes, null if the private key for this keypair is null.
    
    Throws:
    
    java.lang.IllegalStateException - if the private key for this keypair is null.
  - signDecorated
```
public DecoratedSignature signDecorated(byte[] data)
```
    Sign the provided data with the keypair's private key and returns DecoratedSignature.
    
    Parameters:
    
    data - the data to sign
    
    Returns:
    
    DecoratedSignature
  - signPayloadDecorated
```
public DecoratedSignature signPayloadDecorated(byte[] signerPayload)
```
    Sign the provided payload data for payload signer where the input is the data being signed. Per the CAP-40 Signature spec DecoratedSignature.
    
    Parameters:
    
    signerPayload - the payload signers raw data to sign
    
    Returns:
    
    DecoratedSignature
  - verify
```
public boolean verify(byte[] data,
                      byte[] signature)
```
    Verify the provided data and signature match this keypair's public key.
    
    Parameters:
    
    data - The data that was signed.
    
    signature - The signature.
    
    Returns:
    
    True if they match, false otherwise.
  - equals
```
public boolean equals(java.lang.Object object)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - signMessage
```
public byte[] signMessage(java.lang.String message)
```
    Sign a message according to SEP-53.
    
    Parameters:
    
    message - The message to sign.
    
    Returns:
    
    The signature bytes.
  - signMessage
```
public byte[] signMessage(byte[] message)
```
    Sign a message according to SEP-53.
    
    Parameters:
    
    message - The message to sign.
    
    Returns:
    
    The signature bytes.
  - verifyMessage
```
public boolean verifyMessage(byte[] message,
                             byte[] signature)
```
    Verify a SEP-53 signed message.
    
    Parameters:
    
    message - The original message.
    
    signature - The signature to verify.
    
    Returns:
    
    True if the signature is valid for the given message, false otherwise.
  - verifyMessage
```
public boolean verifyMessage(java.lang.String message,
                             byte[] signature)
```
    Verify a SEP-53 signed message.
    
    Parameters:
    
    message - The original message.
    
    signature - The signature to verify.
    
    Returns:
    
    True if the signature is valid for the given message, false otherwise.

Class KeyPair

Method Summary

Methods inherited from class java.lang.Object

Method Detail

canSign

fromSecretSeed

fromSecretSeed

fromSecretSeed

fromAccountId

fromPublicKey

fromBip39Seed

random

getAccountId

getSecretSeed

getPublicKey

getSignatureHint

getXdrPublicKey

getXdrAccountId

fromXdrPublicKey

sign

signDecorated

signPayloadDecorated

verify

equals

hashCode

signMessage

signMessage

verifyMessage

verifyMessage