AbstractTransaction (core 1.5.7-android API)

java.lang.Object
- com.klaytn.caver.transaction.AbstractTransaction

Direct Known Subclasses:

AbstractFeeDelegatedTransaction, AccountUpdate, Cancel, ChainDataAnchoring, LegacyTransaction, SmartContractDeploy, SmartContractExecution, ValueTransfer, ValueTransferMemo
```
public abstract class AbstractTransaction
extends java.lang.Object
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AbstractTransaction.Builder<B extends AbstractTransaction.Builder>
Represents a AbstractTransaction class builder.

Nested Classes
Modifier and Type	Class and Description
`static class`	`AbstractTransaction.Builder<B extends AbstractTransaction.Builder>` Represents a AbstractTransaction class builder.

Constructor Summary

Constructors
Constructor and Description
`AbstractTransaction(AbstractTransaction.Builder builder)` Create AbstractTransaction instance
`AbstractTransaction(Klay klaytnCall, java.lang.String type, java.lang.String from, java.lang.String nonce, java.lang.String gas, java.lang.String gasPrice, java.lang.String chainId, java.util.List<SignatureData> signatures)` Create AbstractTransaction instance

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`appendSignatures(java.util.List<SignatureData> signatureData)` Appends signatures to the transaction.
`void`	`appendSignatures(SignatureData signatureData)` Appends signatures to the transaction.
`java.lang.String`	`combineSignedRawTransactions(java.util.List<java.lang.String> rlpEncoded)` Combines signatures to the transaction from RLP-encoded transaction strings and returns a single transaction with all signatures combined.
`boolean`	`compareTxField(AbstractTransaction txObj, boolean checkSig)` Check equals txObj passed parameter and Current instance.
`void`	`fillTransaction()` Fills empty optional transaction field.(nonce, gasPrice, chainId)
`java.lang.String`	`getChainId()` Getter function for chain id
`abstract java.lang.String`	`getCommonRLPEncodingForSignature()` Returns the RLP-encoded string to make the signature of this transaction.
`java.lang.String`	`getFrom()` Getter function for from
`java.lang.String`	`getGas()` Getter function for gas
`java.lang.String`	`getGasPrice()` Getter function for gas price
`int`	`getKeyType()`
`Klay`	`getKlaytnCall()` Getter function for klaytnRPC
`java.lang.String`	`getNonce()` Getter function for nonce
`java.lang.String`	`getRawTransaction()` Returns a RawTransaction(RLP-encoded transaction string)
`abstract java.lang.String`	`getRLPEncoding()` Returns the RLP-encoded string of this transaction (i.e., rawTransaction).
`java.lang.String`	`getRLPEncodingForSignature()` Returns an RLP-encoded transaction string for making signature.
`java.lang.String`	`getSenderTxHash()` Returns a senderTxHash of transaction
`java.util.List<SignatureData>`	`getSignatures()` Getter function for signatures
`java.lang.String`	`getTransactionHash()` Returns a hash string of transaction
`java.lang.String`	`getType()` Getter function for type.
`java.util.List<SignatureData>`	`refineSignature(java.util.List<SignatureData> signatureDataList)` Refines the array containing signatures - Removes duplicate signatures - Removes the default empty signature("0x01", "0x", "0x") - For an empty signature array, return an array containing the default empty signature("0x01", "0x", "0x")
`void`	`setChainId(java.math.BigInteger chainId)` Setter function for chain id.
`void`	`setChainId(java.lang.String chainId)` Setter function for chain id.
`void`	`setFrom(java.lang.String from)`
`void`	`setGas(java.math.BigInteger gas)` Setter function for gas
`void`	`setGas(java.lang.String gas)` Setter function for gas
`void`	`setGasPrice(java.math.BigInteger gasPrice)` Setter function for gas price.
`void`	`setGasPrice(java.lang.String gasPrice)` Setter function for gas price.
`void`	`setKlaytnCall(Klay klaytnCall)` Setter function for klaytnRPC
`void`	`setNonce(java.math.BigInteger nonce)` Setter function for nonce.
`void`	`setNonce(java.lang.String nonce)` Setter function for nonce.
`void`	`setSignatures(java.util.List<SignatureData> signatures)`
`void`	`setType(java.lang.String type)` Setter function for type.
`AbstractTransaction`	`sign(AbstractKeyring keyring)` Signs using all private keys used in the role defined in the Keyring instance.
`AbstractTransaction`	`sign(AbstractKeyring keyring, java.util.function.Function<AbstractTransaction,java.lang.String> signer)` Signs using all private keys used in the role defined in the Keyring instance.
`AbstractTransaction`	`sign(AbstractKeyring keyring, int index)` Signs to the transaction with a private key in the Keyring instance.
`AbstractTransaction`	`sign(AbstractKeyring keyring, int index, java.util.function.Function<AbstractTransaction,java.lang.String> signer)` Signs to the transaction with a private key in the Keyring instance.
`AbstractTransaction`	`sign(java.lang.String keyString)` Signs to the transaction with a single private key.
`AbstractTransaction`	`sign(java.lang.String keyString, java.util.function.Function<AbstractTransaction,java.lang.String> signer)` Signs to the transaction with a single private key.
`void`	`validateOptionalValues(boolean checkChainID)` Checks that member variables that can be defined by the user are defined.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractTransaction
```
public AbstractTransaction(AbstractTransaction.Builder builder)
```
    Create AbstractTransaction instance
    
    Parameters:
    
    builder - AbstractTransaction.builder
  - AbstractTransaction
```
public AbstractTransaction(Klay klaytnCall,
                           java.lang.String type,
                           java.lang.String from,
                           java.lang.String nonce,
                           java.lang.String gas,
                           java.lang.String gasPrice,
                           java.lang.String chainId,
                           java.util.List<SignatureData> signatures)
```
    Create AbstractTransaction instance
    
    Parameters:
    
    klaytnCall - Klay RPC instance
    
    type - Transaction's type string
    
    from - The address of the sender.
    
    nonce - A value used to uniquely identify a sender’s transaction.
    
    gas - The maximum amount of gas the transaction is allowed to use.
    
    gasPrice - A unit price of gas in peb the sender will pay for a transaction fee.
    
    chainId - Network ID
    
    signatures - A Signature list
- Method Detail
  - getRLPEncoding
```
public abstract java.lang.String getRLPEncoding()
```
    Returns the RLP-encoded string of this transaction (i.e., rawTransaction).
    
    Returns:
    
    String
  - getCommonRLPEncodingForSignature
```
public abstract java.lang.String getCommonRLPEncodingForSignature()
```
    Returns the RLP-encoded string to make the signature of this transaction.
    
    Returns:
    
    String
  - sign
```
public AbstractTransaction sign(java.lang.String keyString)
                         throws java.io.IOException
```
    Signs to the transaction with a single private key. It sets Hasher default value. - signer : TransactionHasher.getHashForSignature()
    
    Parameters:
    
    keyString - The private key string.
    
    Returns:
    
    AbstractTransaction
    
    Throws:
    
    java.io.IOException
  - sign
```
public AbstractTransaction sign(java.lang.String keyString,
                                java.util.function.Function<AbstractTransaction,java.lang.String> signer)
                         throws java.io.IOException
```
    Signs to the transaction with a single private key.
    
    Parameters:
    
    keyString - The private key string
    
    signer - The function to get hash of transaction.
    
    Returns:
    
    AbstractTransaction
    
    Throws:
    
    java.io.IOException
  - sign
```
public AbstractTransaction sign(AbstractKeyring keyring)
                         throws java.io.IOException
```
    Signs using all private keys used in the role defined in the Keyring instance. It sets index and Hasher default value. - signer : TransactionHasher.getHashForSignature()
    
    Parameters:
    
    keyring - The Keyring instance.
    
    Returns:
    
    AbstractTransaction
    
    Throws:
    
    java.io.IOException
  - sign
```
public AbstractTransaction sign(AbstractKeyring keyring,
                                java.util.function.Function<AbstractTransaction,java.lang.String> signer)
                         throws java.io.IOException
```
    Signs using all private keys used in the role defined in the Keyring instance.
    
    Parameters:
    
    keyring - The Keyring instance.
    
    signer - The function to get hash of transaction.
    
    Returns:
    
    AbstractTransaction
    
    Throws:
    
    java.io.IOException
  - sign
```
public AbstractTransaction sign(AbstractKeyring keyring,
                                int index)
                         throws java.io.IOException
```
    Signs to the transaction with a private key in the Keyring instance. It sets signer to TransactionHasher.getHashForSignature()
    
    Parameters:
    
    keyring - The Keyring instance.
    
    index - The index of private key to use in Keyring instance.
    
    Returns:
    
    AbstractTransaction
    
    Throws:
    
    java.io.IOException
  - sign
```
public AbstractTransaction sign(AbstractKeyring keyring,
                                int index,
                                java.util.function.Function<AbstractTransaction,java.lang.String> signer)
                         throws java.io.IOException
```
    Signs to the transaction with a private key in the Keyring instance.
    
    Parameters:
    
    keyring - The Keyring instance.
    
    index - The index of private key to use in Keyring instance.
    
    signer - The function to get hash of transaction.
    
    Returns:
    
    AbstractTransaction
    
    Throws:
    
    java.io.IOException
  - appendSignatures
```
public void appendSignatures(SignatureData signatureData)
```
    Appends signatures to the transaction.
    
    Parameters:
    
    signatureData - SignatureData instance contains ECDSA signature data
  - appendSignatures
```
public void appendSignatures(java.util.List<SignatureData> signatureData)
```
    Appends signatures to the transaction.
    
    Parameters:
    
    signatureData - List of SignatureData contains ECDSA signature data
  - combineSignedRawTransactions
```
public java.lang.String combineSignedRawTransactions(java.util.List<java.lang.String> rlpEncoded)
```
    Combines signatures to the transaction from RLP-encoded transaction strings and returns a single transaction with all signatures combined. When combining the signatures into a transaction instance, an error is thrown if the decoded transaction contains different value except signatures.
    
    Parameters:
    
    rlpEncoded - A List of RLP-encoded transaction strings.
    
    Returns:
    
    String
  - getRawTransaction
```
public java.lang.String getRawTransaction()
```
    Returns a RawTransaction(RLP-encoded transaction string)
    
    Returns:
    
    String
  - getTransactionHash
```
public java.lang.String getTransactionHash()
```
    Returns a hash string of transaction
    
    Returns:
    
    String
  - getSenderTxHash
```
public java.lang.String getSenderTxHash()
```
    Returns a senderTxHash of transaction
    
    Returns:
    
    String
  - getRLPEncodingForSignature
```
public java.lang.String getRLPEncodingForSignature()
```
    Returns an RLP-encoded transaction string for making signature.
    
    Returns:
    
    String
  - fillTransaction
```
public void fillTransaction()
                     throws java.io.IOException
```
    Fills empty optional transaction field.(nonce, gasPrice, chainId)
    
    Throws:
    
    java.io.IOException
  - compareTxField
```
public boolean compareTxField(AbstractTransaction txObj,
                              boolean checkSig)
```
    Check equals txObj passed parameter and Current instance.
    
    Parameters:
    
    txObj - The AbstractTransaction Object to compare
    
    checkSig - Check whether signatures field is equal.
    
    Returns:
    
    boolean
  - validateOptionalValues
```
public void validateOptionalValues(boolean checkChainID)
```
    Checks that member variables that can be defined by the user are defined. If there is an undefined variable, an error occurs.
  - refineSignature
```
public java.util.List<SignatureData> refineSignature(java.util.List<SignatureData> signatureDataList)
```
    Refines the array containing signatures - Removes duplicate signatures - Removes the default empty signature("0x01", "0x", "0x") - For an empty signature array, return an array containing the default empty signature("0x01", "0x", "0x")
    
    Parameters:
    
    signatureDataList -
    
    Returns:
  - getKlaytnCall
```
public Klay getKlaytnCall()
```
    Getter function for klaytnRPC
    
    Returns:
    
    Klay
  - setKlaytnCall
```
public void setKlaytnCall(Klay klaytnCall)
```
    Setter function for klaytnRPC
    
    Parameters:
    
    klaytnCall - Klay RPC Instance.
  - getType
```
public java.lang.String getType()
```
    Getter function for type.
    
    Returns:
    
    String
  - getFrom
```
public java.lang.String getFrom()
```
    Getter function for from
    
    Returns:
    
    String
  - getNonce
```
public java.lang.String getNonce()
```
    Getter function for nonce
    
    Returns:
    
    String
  - getGas
```
public java.lang.String getGas()
```
    Getter function for gas
    
    Returns:
    
    String
  - getGasPrice
```
public java.lang.String getGasPrice()
```
    Getter function for gas price
    
    Returns:
    
    String
  - getChainId
```
public java.lang.String getChainId()
```
    Getter function for chain id
    
    Returns:
    
    String
  - getSignatures
```
public java.util.List<SignatureData> getSignatures()
```
    Getter function for signatures
    
    Returns:
    
    String
  - setType
```
public void setType(java.lang.String type)
```
    Setter function for type.
    
    Parameters:
    
    type - The Transaction type.
  - setFrom
```
public void setFrom(java.lang.String from)
```
  - setGas
```
public void setGas(java.lang.String gas)
```
    Setter function for gas
    
    Parameters:
    
    gas - The maximum amount of gas the transaction is allowed to use.
  - setGas
```
public void setGas(java.math.BigInteger gas)
```
    Setter function for gas
    
    Parameters:
    
    gas - The maximum amount of gas the transaction is allowed to use.
  - setNonce
```
public void setNonce(java.lang.String nonce)
```
    Setter function for nonce.
    
    Parameters:
    
    nonce - A value used to uniquely identify a sender’s transaction.
  - setNonce
```
public void setNonce(java.math.BigInteger nonce)
```
    Setter function for nonce.
    
    Parameters:
    
    nonce - A value used to uniquely identify a sender’s transaction.
  - setGasPrice
```
public void setGasPrice(java.lang.String gasPrice)
```
    Setter function for gas price.
    
    Parameters:
    
    gasPrice - A unit price of gas in peb the sender will pay for a transaction fee.
  - setGasPrice
```
public void setGasPrice(java.math.BigInteger gasPrice)
```
    Setter function for gas price.
    
    Parameters:
    
    gasPrice - A unit price of gas in peb the sender will pay for a transaction fee.
  - setChainId
```
public void setChainId(java.lang.String chainId)
```
    Setter function for chain id.
    
    Parameters:
    
    chainId - A network id.
  - setChainId
```
public void setChainId(java.math.BigInteger chainId)
```
    Setter function for chain id.
    
    Parameters:
    
    chainId - A network id.
  - setSignatures
```
public void setSignatures(java.util.List<SignatureData> signatures)
```
  - getKeyType
```
public int getKeyType()
```

Class AbstractTransaction

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractTransaction

AbstractTransaction

Method Detail

getRLPEncoding

getCommonRLPEncodingForSignature

sign

sign

sign

sign

sign

sign

appendSignatures

appendSignatures

combineSignedRawTransactions

getRawTransaction

getTransactionHash

getSenderTxHash

getRLPEncodingForSignature

fillTransaction

compareTxField

validateOptionalValues

refineSignature

getKlaytnCall

setKlaytnCall

getType

getFrom

getNonce

getGas

getGasPrice

getChainId

getSignatures

setType

setFrom

setGas

setGas

setNonce

setNonce

setGasPrice

setGasPrice

setChainId

setChainId

setSignatures

getKeyType