org.stellar.sdk

Class StrKey

java.lang.Object

org.stellar.sdk.StrKey

public class StrKey
extends java.lang.Object

StrKey is a helper class that allows encoding and decoding Stellar keys to/from strings, i.e. between their binary and string (i.e. "GABCD...", etc.) representations.

Constructor Summary

Constructors

Constructor and Description
StrKey()

Method Summary

Modifier and Type	Method and Description
static byte[]	decodeClaimableBalance(java.lang.String data) Decodes strkey claimable balance ID (B...) to raw bytes.
static byte[]	decodeContract(java.lang.String data) Decodes strkey contract ID (C...) to raw bytes.
static byte[]	decodeEd25519PublicKey(java.lang.String data) Decodes strkey ed25519 public key (G...) to raw data
static byte[]	decodeEd25519SecretSeed(char[] data) Decodes strkey ed25519 seed char array (S...) to raw bytes
static byte[]	decodeLiquidityPool(java.lang.String data) Decodes strkey liquidity pool ID (L...) to raw bytes.
static byte[]	decodeMed25519PublicKey(java.lang.String data) Decodes strkey Stellar med25519 public key (M...) to raw bytes
static MuxedAccount	decodeMuxedAccount(java.lang.String address) Deprecated.
static byte[]	decodePreAuthTx(java.lang.String data) Decodes strkey PreAuthTx (T...) to raw bytes
static byte[]	decodeSha256Hash(java.lang.String data) Decodes strkey SHA256 hash (X...) to raw bytes
static byte[]	decodeSignedPayload(java.lang.String data) Decodes strkey signed payload (P...) to raw bytes.
static java.lang.String	encodeClaimableBalance(byte[] data) Encodes raw data to strkey claimable balance ID (B...)
static java.lang.String	encodeContract(byte[] data) Encodes raw data to strkey contract ID (C...)
static java.lang.String	encodeEd25519PublicKey(AccountID accountID) Deprecated.
static java.lang.String	encodeEd25519PublicKey(byte[] data) Encodes raw data to strkey ed25519 public key (G...)
static char[]	encodeEd25519SecretSeed(byte[] data) Encodes raw data to strkey ed25519 seed in char array (S...)
static java.lang.String	encodeLiquidityPool(byte[] data) Encodes raw data to strkey liquidity pool ID (L...)
static java.lang.String	encodeMed25519PublicKey(byte[] data) Encodes raw data to strkey Stellar med25519 public key (M...)
static java.lang.String	encodeMuxedAccount(MuxedAccount muxedAccount) Deprecated.
static java.lang.String	encodePreAuthTx(byte[] data) Encodes raw data to strkey PreAuthTx (T...)
static java.lang.String	encodeSha256Hash(byte[] data) Encodes raw data to strkey SHA256 hash (X...)
static java.lang.String	encodeSignedPayload(byte[] data) Encodes raw data to strkey signed payload (P...)
static AccountID	encodeToXDRAccountId(java.lang.String data) Deprecated.
static MuxedAccount	encodeToXDRMuxedAccount(java.lang.String data) Deprecated.
static boolean	isValidClaimableBalance(java.lang.String claimableBalanceId) Checks validity of claimable balance (B...) address.
static boolean	isValidContract(java.lang.String contractId) Checks validity of contract (C...) address.
static boolean	isValidEd25519PublicKey(java.lang.String accountID) Checks validity of Stellar account ID (G...).
static boolean	isValidEd25519SecretSeed(char[] seed) Checks validity of seed (S...).
static boolean	isValidLiquidityPool(java.lang.String liquidityPoolId) Checks validity of liquidity pool (L...) address.
static boolean	isValidMed25519PublicKey(java.lang.String med25519PublicKey) Checks validity of med25519 public key (M...).
static boolean	isValidPreAuthTx(java.lang.String preAuthTx) Checks validity of PreAuthTx (T...).
static boolean	isValidSha256Hash(java.lang.String sha256Hash) Checks validity of SHA256 hash (X...).
static boolean	isValidSignedPayload(java.lang.String signedPayload) Checks validity of signed payload (P...).

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StrKey

public StrKey()

Method Detail

encodeEd25519PublicKey

public static java.lang.String encodeEd25519PublicKey(byte[] data)

Encodes raw data to strkey ed25519 public key (G...)

Parameters:

data - data to encode

Returns:

"G..." representation of the key

decodeEd25519PublicKey

public static byte[] decodeEd25519PublicKey(java.lang.String data)

Decodes strkey ed25519 public key (G...) to raw data

Parameters:

data - data to decode

Returns:

raw bytes

isValidEd25519PublicKey

public static boolean isValidEd25519PublicKey(java.lang.String accountID)

Checks validity of Stellar account ID (G...).

Parameters:

accountID - the account ID to check

Returns:

true if the given Stellar account ID is a valid Stellar account ID, false otherwise

encodeEd25519SecretSeed

public static char[] encodeEd25519SecretSeed(byte[] data)

Encodes raw data to strkey ed25519 seed in char array (S...)

Parameters:

data - data to encode

Returns:

"S..." representation of the key in char array

decodeEd25519SecretSeed

public static byte[] decodeEd25519SecretSeed(char[] data)

Decodes strkey ed25519 seed char array (S...) to raw bytes

Parameters:

data - data to decode

Returns:

raw bytes

isValidEd25519SecretSeed

public static boolean isValidEd25519SecretSeed(char[] seed)

Checks validity of seed (S...).

Parameters:

seed - the seed to check

Returns:

true if the given seed is a valid seed, false otherwise

encodePreAuthTx

public static java.lang.String encodePreAuthTx(byte[] data)

Encodes raw data to strkey PreAuthTx (T...)

Parameters:

data - data to encode

Returns:

"T..." representation of the key

decodePreAuthTx

public static byte[] decodePreAuthTx(java.lang.String data)

Decodes strkey PreAuthTx (T...) to raw bytes

Parameters:

data - data to decode

Returns:

raw bytes

isValidPreAuthTx

public static boolean isValidPreAuthTx(java.lang.String preAuthTx)

Checks validity of PreAuthTx (T...).

Parameters:

preAuthTx - the PreAuthTx to check

Returns:

true if the given PreAuthTx is a valid PreAuthTx, false otherwise

encodeSha256Hash

public static java.lang.String encodeSha256Hash(byte[] data)

Encodes raw data to strkey SHA256 hash (X...)

Parameters:

data - data to encode

Returns:

"X..." representation of the key

decodeSha256Hash

public static byte[] decodeSha256Hash(java.lang.String data)

Decodes strkey SHA256 hash (X...) to raw bytes

Parameters:

data - data to decode

Returns:

raw bytes

isValidSha256Hash

public static boolean isValidSha256Hash(java.lang.String sha256Hash)

Checks validity of SHA256 hash (X...).

Parameters:

sha256Hash - the SHA256 hash to check

Returns:

true if the given SHA256 hash is a valid SHA256 hash, false otherwise

encodeSignedPayload

public static java.lang.String encodeSignedPayload(byte[] data)

Encodes raw data to strkey signed payload (P...)

Parameters:

data - data to encode

Returns:

"P..." representation of the key

decodeSignedPayload

public static byte[] decodeSignedPayload(java.lang.String data)

Decodes strkey signed payload (P...) to raw bytes.

Parameters:

data - data to decode

Returns:

raw bytes

isValidSignedPayload

public static boolean isValidSignedPayload(java.lang.String signedPayload)

Checks validity of signed payload (P...).

Parameters:

signedPayload - the signed payload to check

Returns:

true if the given signed payload is a valid signed payload, false otherwise

encodeContract

public static java.lang.String encodeContract(byte[] data)

Encodes raw data to strkey contract ID (C...)

Parameters:

data - data to encode

Returns:

"C..." representation of the key

decodeContract

public static byte[] decodeContract(java.lang.String data)

Decodes strkey contract ID (C...) to raw bytes.

Parameters:

data - data to decode

Returns:

raw bytes

isValidContract

public static boolean isValidContract(java.lang.String contractId)

Checks validity of contract (C...) address.

Parameters:

contractId - the contract ID to check

Returns:

true if the given contract ID is a valid contract ID, false otherwise

encodeLiquidityPool

public static java.lang.String encodeLiquidityPool(byte[] data)

Encodes raw data to strkey liquidity pool ID (L...)

Parameters:

data - data to encode

Returns:

"L..." representation of the key

decodeLiquidityPool

public static byte[] decodeLiquidityPool(java.lang.String data)

Decodes strkey liquidity pool ID (L...) to raw bytes.

Parameters:

data - data to decode

Returns:

raw bytes

isValidLiquidityPool

public static boolean isValidLiquidityPool(java.lang.String liquidityPoolId)

Checks validity of liquidity pool (L...) address.

Parameters:

liquidityPoolId - the liquidity pool ID to check

Returns:

true if the given liquidity pool ID is a valid liquidity pool ID, false otherwise

encodeClaimableBalance

public static java.lang.String encodeClaimableBalance(byte[] data)

Encodes raw data to strkey claimable balance ID (B...)

Parameters:

data - data to encode

Returns:

"B..." representation of the key

decodeClaimableBalance

public static byte[] decodeClaimableBalance(java.lang.String data)

Decodes strkey claimable balance ID (B...) to raw bytes.

Parameters:

data - data to decode

Returns:

raw bytes

isValidClaimableBalance

public static boolean isValidClaimableBalance(java.lang.String claimableBalanceId)

Checks validity of claimable balance (B...) address.

Parameters:

claimableBalanceId - the claimable balance ID to check

Returns:

true if the given claimable balance ID is a valid claimable balance ID, false otherwise

encodeMed25519PublicKey

public static java.lang.String encodeMed25519PublicKey(byte[] data)

Encodes raw data to strkey Stellar med25519 public key (M...)

Parameters:

data - data to encode

Returns:

"M..." representation of the key

decodeMed25519PublicKey

public static byte[] decodeMed25519PublicKey(java.lang.String data)

Decodes strkey Stellar med25519 public key (M...) to raw bytes

Parameters:

data - data to decode

Returns:

raw bytes

isValidMed25519PublicKey

public static boolean isValidMed25519PublicKey(java.lang.String med25519PublicKey)

Checks validity of med25519 public key (M...).

Parameters:

med25519PublicKey - the med25519 public key to check

Returns:

true if the given med25519 public key is a valid med25519 public key, false otherwise

encodeEd25519PublicKey

@Deprecated
public static java.lang.String encodeEd25519PublicKey(AccountID accountID)

Deprecated.

Encodes raw data to strkey Stellar account ID (G...)

This method is deprecated and will be removed in future versions, use encodeEd25519PublicKey(byte[]) instead.

Parameters:

accountID - data to encode

Returns:

"G..." representation of the key

encodeMuxedAccount

@Deprecated
public static java.lang.String encodeMuxedAccount(MuxedAccount muxedAccount)

Deprecated.

Encodes raw data to strkey Stellar muxed account ID (M... or G...)

This method is deprecated and will be removed in future versions, use MuxedAccount instead.

Parameters:

muxedAccount - the muxed account to encode

Returns:

"M..." or "G..." representation of the key

decodeMuxedAccount

@Deprecated
public static MuxedAccount decodeMuxedAccount(java.lang.String address)

Deprecated.

Decodes strkey Stellar account ID (G...) or muxed account ID (M...) to MuxedAccount.

This method is deprecated and will be removed in future versions, use MuxedAccount instead.

Parameters:

address - the address to decode

Returns:

MuxedAccount representation of the key

encodeToXDRAccountId

@Deprecated
public static AccountID encodeToXDRAccountId(java.lang.String data)

Deprecated.

Encodes strkey Stellar account ID (G...) to AccountID.

This method is deprecated and will be removed in future versions, use KeyPair.getXdrAccountId() instead.

Parameters:

data - the data to encode

Returns:

AccountID representation of the key

encodeToXDRMuxedAccount

@Deprecated
public static MuxedAccount encodeToXDRMuxedAccount(java.lang.String data)

Deprecated.

Encodes strkey Stellar account ID (G...) or muxed account ID (M...) to MuxedAccount.

This method is deprecated and will be removed in future versions, use MuxedAccount instead.

Parameters:

data - the data to encode

Returns:

MuxedAccount representation of the key