one.block.eosiojava.utilities

Class EOSFormatter

java.lang.Object

one.block.eosiojava.utilities.EOSFormatter

public class EOSFormatter
extends java.lang.Object

This class provides a number of helper methods that can be used to convert certain objects to and from formats that are germane to EOS blockchain transactions and the PEM (Privacy Enhanced Mail) format for those objects. It also provides methods to format a serialized transaction into a format that can be submitted to an EOS blockchain.

Constructor Summary

Constructors

Constructor and Description
EOSFormatter()

Method Summary

Modifier and Type	Method and Description
static @NotNull java.lang.String	convertDERSignatureToEOSFormat(@NotNull byte[] signatureDER, @NotNull byte[] signableTransaction, @NotNull java.lang.String publicKeyPEM) This method converts a signature to a EOS compliant form.
static @NotNull java.lang.String	convertEOSPrivateKeyToPEMFormat(@NotNull java.lang.String privateKeyEOS) This method converts an EOS formatted private key to the PEM format.
static @NotNull java.lang.String	convertEOSPublicKeyToPEMFormat(@NotNull java.lang.String publicKeyEOS) This method converts an EOS formatted public key to the PEM format.
static @NotNull java.lang.String	convertPEMFormattedPrivateKeyToEOSFormat(@NotNull java.lang.String privateKeyPEM) This method converts a PEM formatted private key to the EOS format.
static @NotNull java.lang.String	convertPEMFormattedPublicKeyToEOSFormat(@NotNull java.lang.String publicKeyPEM, boolean requireLegacyFormOfSecp256k1Key) This method converts a PEM formatted public key to the EOS format.
static @NotNull java.lang.String	convertRawRandSofSignatureToEOSFormat(@NotNull java.lang.String signatureR, java.lang.String signatureS, @NotNull byte[] signableTransaction, @NotNull java.lang.String publicKeyPEM) This method converts a signature to a EOS compliant form.
static @NotNull byte[]	decodePublicKey(@NotNull java.lang.String strKey, java.lang.String keyPrefix) Base58 decodes a public key and validates checksum.
static @NotNull java.lang.String	encodePrivateKey(@NotNull byte[] pemKey, @NotNull AlgorithmEmployed keyType) Base58 encodes a private key after calculating and appending the checksum.
static @NotNull java.lang.String	encodePublicKey(@NotNull byte[] pemKey, @NotNull AlgorithmEmployed keyType, boolean isLegacy) Encoding PEM public key to EOS format.
static java.lang.String	extractSerializedTransactionFromSignable(@NotNull java.lang.String eosTransaction) Extract serialized transaction from a signable transaction
static java.lang.String	prepareSerializedTransactionForSigning(@NotNull java.lang.String serializedTransaction, @NotNull java.lang.String chainId) Preparing signable transaction for signing.

Methods inherited from class java.lang.Object

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

Constructor Detail

EOSFormatter

public EOSFormatter()

Method Detail

convertPEMFormattedPublicKeyToEOSFormat

@NotNull
public static @NotNull java.lang.String convertPEMFormattedPublicKeyToEOSFormat(@NotNull
                                                                                         @NotNull java.lang.String publicKeyPEM,
                                                                                         boolean requireLegacyFormOfSecp256k1Key)
                                                                                  throws EOSFormatterError

This method converts a PEM formatted public key to the EOS format.

Parameters:

publicKeyPEM - Public key in the PEM format

requireLegacyFormOfSecp256k1Key - - If the developer prefers a legacy version of a secp256k1 key that uses a "EOS" prefix.

Returns:

EOS formatted public key as string

Throws:

EOSFormatterError - if PEM conversion to EOS format fails.

convertEOSPublicKeyToPEMFormat

@NotNull
public static @NotNull java.lang.String convertEOSPublicKeyToPEMFormat(@NotNull
                                                                                @NotNull java.lang.String publicKeyEOS)
                                                                         throws EOSFormatterError

This method converts an EOS formatted public key to the PEM format.

Parameters:

publicKeyEOS - Public key in the EOS format

Returns:

PEM formatted public key as string

Throws:

EOSFormatterError - if EOS conversion to PEM format fails.

convertDERSignatureToEOSFormat

@NotNull
public static @NotNull java.lang.String convertDERSignatureToEOSFormat(@NotNull
                                                                                @NotNull byte[] signatureDER,
                                                                                @NotNull
                                                                                @NotNull byte[] signableTransaction,
                                                                                @NotNull
                                                                                @NotNull java.lang.String publicKeyPEM)
                                                                         throws EOSFormatterError

This method converts a signature to a EOS compliant form. The signature to be converted must be an The ECDSA signature that is a DER encoded ASN.1 sequence of two integer fields (see ECDSA-Sig-Value in rfc3279 section 2.2.3). The DER encoded ECDSA signature follows the following format: Byte 1 - Sequence (Should be 30) Byte 2 - Signature length Byte 3 - R Marker (0x02) Byte 4 - R length Bytes 5 to 37 or 38- R Byte After R - S Marker (0x02) Byte After S Marker - S Length Bytes After S Length - S (always 32-33 bytes) Byte Final - Hash Type

Parameters:

signatureDER - ECDSA DER encoded signature as byte array

signableTransaction - Transaction in signable format

publicKeyPEM - public key in PEM format

Returns:

EOS format of signature

Throws:

EOSFormatterError - if DER conversion to EOS format fails.

convertRawRandSofSignatureToEOSFormat

@NotNull
public static @NotNull java.lang.String convertRawRandSofSignatureToEOSFormat(@NotNull
                                                                                       @NotNull java.lang.String signatureR,
                                                                                       java.lang.String signatureS,
                                                                                       @NotNull
                                                                                       @NotNull byte[] signableTransaction,
                                                                                       @NotNull
                                                                                       @NotNull java.lang.String publicKeyPEM)
                                                                                throws EOSFormatterError

This method converts a signature to a EOS compliant form. The signature to be converted must be an The ECDSA signature that is a DER encoded ASN.1 sequence of two integer fields (see ECDSA-Sig-Value in rfc3279 section 2.2.3). This method should be used when only the R and S values of the signature are available. The DER encoded ECDSA signature follows the following format: Byte 1 - Sequence (Should be 30) Byte 2 - Signature length Byte 3 - R Marker (0x02) Byte 4 - R length Bytes 5 to 37 or 38- R Byte After R - S Marker (0x02) Byte After S Marker - S Length Bytes After S Length - S (always 32-33 bytes) Byte Final - Hash Type

Parameters:

signatureR - R value as BigInteger in string format

signatureS - S value as BigInteger in string format

signableTransaction - Transaction in signable format

publicKeyPEM - Public Key used to sign in PEM format

Returns:

EOS format of signature

Throws:

EOSFormatterError - if conversion to EOS format fails.

convertPEMFormattedPrivateKeyToEOSFormat

@NotNull
public static @NotNull java.lang.String convertPEMFormattedPrivateKeyToEOSFormat(@NotNull
                                                                                          @NotNull java.lang.String privateKeyPEM)
                                                                                   throws EOSFormatterError

This method converts a PEM formatted private key to the EOS format.

Parameters:

privateKeyPEM - Private key in PEM format

Returns:

EOS formatted private key as string

Throws:

EOSFormatterError - if PEM conversion to EOS format fails.

convertEOSPrivateKeyToPEMFormat

@NotNull
public static @NotNull java.lang.String convertEOSPrivateKeyToPEMFormat(@NotNull
                                                                                 @NotNull java.lang.String privateKeyEOS)
                                                                          throws EOSFormatterError

This method converts an EOS formatted private key to the PEM format.

Parameters:

privateKeyEOS - Private key in EOS format

Returns:

PEM formatted private key as a string

Throws:

EOSFormatterError - if EOS conversion to PEM format fails.

extractSerializedTransactionFromSignable

public static java.lang.String extractSerializedTransactionFromSignable(@NotNull
                                                                        @NotNull java.lang.String eosTransaction)
                                                                 throws EOSFormatterError

Extract serialized transaction from a signable transaction

Signable signature structure:

chainId (64 characters) + serialized transaction + 32 bytes of 0

Parameters:

eosTransaction - - the input signable transaction

Returns:

- extracted serialized transaction from the input signable transaction

Throws:

EOSFormatterError - if input is invalid

prepareSerializedTransactionForSigning

public static java.lang.String prepareSerializedTransactionForSigning(@NotNull
                                                                      @NotNull java.lang.String serializedTransaction,
                                                                      @NotNull
                                                                      @NotNull java.lang.String chainId)
                                                               throws EOSFormatterError

Preparing signable transaction for signing.

Signable signature structure:

chainId + serialized transaction + 32 bytes of 0

Parameters:

serializedTransaction - - the serialized transaction to be converted to signable transaction

chainId - - the chain id will be used inside the signature transaction structure.

Returns:

- Signable transaction

Throws:

EOSFormatterError - if inputs are invalid

encodePrivateKey

@NotNull
public static @NotNull java.lang.String encodePrivateKey(@NotNull
                                                                  @NotNull byte[] pemKey,
                                                                  @NotNull
                                                                  @NotNull AlgorithmEmployed keyType)
                                                           throws Base58ManipulationError

Base58 encodes a private key after calculating and appending the checksum.

Parameters:

pemKey - - Private key as byte[] to encode

keyType - - input key type

Returns:

Base58 encoded private key as byte[]

Throws:

Base58ManipulationError - it private key encoding fails.

encodePublicKey

@NotNull
public static @NotNull java.lang.String encodePublicKey(@NotNull
                                                                 @NotNull byte[] pemKey,
                                                                 @NotNull
                                                                 @NotNull AlgorithmEmployed keyType,
                                                                 boolean isLegacy)
                                                          throws Base58ManipulationError

Encoding PEM public key to EOS format.

Parameters:

pemKey - - PEM key as byte[] to encode

keyType - - Algorithm type used to create key

isLegacy - - If the developer prefers a legacy version of a secp256k1 key that uses an "EOS" prefix.

Returns:

- EOS format of public key

Throws:

Base58ManipulationError - if public key encoding fails.

decodePublicKey

@NotNull
public static @NotNull byte[] decodePublicKey(@NotNull
                                                       @NotNull java.lang.String strKey,
                                                       java.lang.String keyPrefix)
                                                throws Base58ManipulationError

Base58 decodes a public key and validates checksum.

Parameters:

strKey - Base58 encoded public key in string format.

keyPrefix - EOS specific key type prefix (i.e. PUB_R1_, PUB_K1_, or EOS).

Returns:

Base58 decoded public key as byte[]

Throws:

Base58ManipulationError - if public key decoding fails.