Package org.stellar.sdk

Class StrKey

java.lang.Object
org.stellar.sdk.StrKey
public class StrKey extends 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 Details

    • StrKey

      public StrKey()

  • Method Details

    • encodeEd25519PublicKey

      public static 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(String data)
      Decodes strkey ed25519 public key (G...) to raw data
      Parameters:
      data - data to decode
      Returns:
      raw bytes

    • 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

    • encodePreAuthTx

      public static 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(String data)
      Decodes strkey PreAuthTx (T...) to raw bytes
      Parameters:
      data - data to decode
      Returns:
      raw bytes

    • encodeSha256Hash

      public static 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(String data)
      Decodes strkey SHA256 hash (X...) to raw bytes
      Parameters:
      data - data to decode
      Returns:
      raw bytes

    • encodeSignedPayload

      public static String encodeSignedPayload(SignedPayloadSigner signedPayloadSigner)
      Encodes SignedPayloadSigner to strkey signed payload (P...)
      Parameters:
      signedPayloadSigner - the signed payload signer
      Returns:
      "P..." representation of the key

    • decodeSignedPayload

      public static SignedPayloadSigner decodeSignedPayload(String data)
      Decodes strkey signed payload (P...) to SignedPayloadSigner
      Parameters:
      data - data to decode
      Returns:
      raw bytes

    • encodeContract

      public static 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(String data)
      Decodes strkey contract ID (C...) to raw bytes.
      Parameters:
      data - data to decode
      Returns:
      raw bytes

    • encodeEd25519PublicKey

      public static String encodeEd25519PublicKey(AccountID accountID)
      Encodes raw data to strkey Stellar account ID (G...)
      Parameters:
      accountID - data to encode
      Returns:
      "G..." representation of the key

    • encodeMuxedAccount

      public static String encodeMuxedAccount(MuxedAccount muxedAccount)
      Encodes raw data to strkey Stellar muxed account ID (M... or G...)
      Parameters:
      muxedAccount - the muxed account to encode
      Returns:
      "M..." or "G..." representation of the key

    • decodeMuxedAccount

      public static MuxedAccount decodeMuxedAccount(String address)
      Decodes strkey Stellar account ID (G...) or muxed account ID (M...) to MuxedAccount.
      Parameters:
      address - the address to decode
      Returns:
      MuxedAccount representation of the key

    • encodeToXDRAccountId

      public static AccountID encodeToXDRAccountId(String data)
      Encodes strkey Stellar account ID (G...) to AccountID.
      Parameters:
      data - the data to encode
      Returns:
      AccountID representation of the key

    • encodeToXDRMuxedAccount

      public static MuxedAccount encodeToXDRMuxedAccount(String data)
      Encodes strkey Stellar account ID (G...) or muxed account ID (M...) to MuxedAccount.
      Parameters:
      data - the data to encode
      Returns:
      MuxedAccount representation of the key

    • isValidEd25519PublicKey

      public static boolean isValidEd25519PublicKey(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

    • isValidContract

      public static boolean isValidContract(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