Class SignatureData


  • public class SignatureData
    extends java.lang.Object
    Representing a ECDSA Signature data
    • Constructor Summary

      Constructors 
      Constructor Description
      SignatureData​(byte[] v, byte[] r, byte[] s)
      Creates a SignatureData instance.
      SignatureData​(java.lang.String v, java.lang.String r, java.lang.String s)
      Creates a SignatureData instance.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static java.util.List<SignatureData> decodeSignatures​(java.util.List<org.web3j.rlp.RlpType> signatureRlpTypeList)
      Decodes a RLP encoded string contains signature list.
      boolean equals​(java.lang.Object o)
      Indicates whether some other object is "equal to" this one.
      java.math.BigInteger getChainId()
      Get chain id from signatureData.
      static SignatureData getEmptySignature()
      Returns an empty signature.
      java.lang.String getR()
      Getter function for R.
      int getRecoverId()
      Get a recover id from signatureData.
      java.lang.String getS()
      Getter function for S.
      java.lang.String getTrimZeroR()  
      java.lang.String getTrimZeroS()  
      java.lang.String getTrimZeroV()  
      java.lang.String getV()
      Getter function for V.
      int hashCode()
      Returns a hash code value for the object.
      void makeEIP155Signature​(int chainId)
      Set "V" field according to EIP-155.
      static java.util.List<SignatureData> refineSignature​(java.util.List<SignatureData> signatureDataList)
      Refines the array containing signatures.
      void setR​(java.lang.String r)
      Setter function for R.
      void setS​(java.lang.String s)
      Setter function for S.
      void setV​(java.lang.String v)
      Setter function for V.
      org.web3j.rlp.RlpList toRlpList()
      Returns the RLP-encoded string of this signature.
      java.lang.String toString()
      Returns a string representation of the object.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • SignatureData

        public SignatureData​(java.lang.String v,
                             java.lang.String r,
                             java.lang.String s)
        Creates a SignatureData instance.
        Parameters:
        v - The version byte.
        r - The ECDSA Signature data R
        s - The ECDSA Signature data S
      • SignatureData

        public SignatureData​(byte[] v,
                             byte[] r,
                             byte[] s)
        Creates a SignatureData instance.
        Parameters:
        v - The version byte.
        r - The ECDSA Signature data R
        s - The ECDSA Signature data S
    • Method Detail

      • getEmptySignature

        public static SignatureData getEmptySignature()
        Returns an empty signature.
        Example :
         
         SignatureData signature = SignatureData.getEmptySignature();
         
         
        Returns:
        SignatureData
      • decodeSignatures

        public static java.util.List<SignatureData> decodeSignatures​(java.util.List<org.web3j.rlp.RlpType> signatureRlpTypeList)
        Decodes a RLP encoded string contains signature list.
        Example :
         
         List<SignatureData> senderSignList = SignatureData.decodeSignatures(senderSignaturesRLP);
         
         
        Parameters:
        signatureRlpTypeList - a RLP encoded string contains signature list.
        Returns:
        List<SignatureData>
      • makeEIP155Signature

        public void makeEIP155Signature​(int chainId)
        Set "V" field according to EIP-155.
        Example :
         
         int chainId = 1;
         signatureData.makeEIP155Signature(chainId);
         
         
        Parameters:
        chainId - The chain id specific to the network.
      • refineSignature

        public static 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")

        Example :
         
         List<SignatureData> refinedList = SignatureData.refineSignature(signatureDataList);
         
         
        Parameters:
        signatureDataList - The list of SignatureData
        Returns:
        List<SignatureData>
      • toRlpList

        public org.web3j.rlp.RlpList toRlpList()
        Returns the RLP-encoded string of this signature.
        Example :
         
         RlpList rlpList = signature.toRlpList();
         
         
        Returns:
        RlpList
      • getRecoverId

        public int getRecoverId()
        Get a recover id from signatureData.
        Example :
         
         int recId = signature.getRecoverId();
         
         
        Returns:
        int
      • getChainId

        public java.math.BigInteger getChainId()
        Get chain id from signatureData.
        Example :
         
         int recId = signature.getChainId();
         
         
        Returns:
        BigInteger
      • equals

        public boolean equals​(java.lang.Object o)
        Indicates whether some other object is "equal to" this one.
        Overrides:
        equals in class java.lang.Object
        Parameters:
        o - The reference object with which to compare.
        Returns:
        boolean
      • hashCode

        public int hashCode()
        Returns a hash code value for the object.
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        integer
      • toString

        public java.lang.String toString()
        Returns a string representation of the object.
        Overrides:
        toString in class java.lang.Object
        Returns:
        String
      • getV

        public java.lang.String getV()
        Getter function for V.
        Returns:
        String
      • getR

        public java.lang.String getR()
        Getter function for R.
        Returns:
        String
      • getS

        public java.lang.String getS()
        Getter function for S.
        Returns:
        String
      • getTrimZeroV

        public java.lang.String getTrimZeroV()
      • getTrimZeroR

        public java.lang.String getTrimZeroR()
      • getTrimZeroS

        public java.lang.String getTrimZeroS()
      • setV

        public void setV​(java.lang.String v)
        Setter function for V.
        Parameters:
        v - Version byte.
      • setR

        public void setR​(java.lang.String r)
        Setter function for R.
        Parameters:
        r - ECDSA Signature data R.
      • setS

        public void setS​(java.lang.String s)
        Setter function for S.
        Parameters:
        s - ECDSA Signature data S.