Module com.hedera.hashgraph.sdk
Package com.hedera.hashgraph.sdk.proto

Class LedgerId

java.lang.Object
com.google.protobuf.AbstractMessageLite<LedgerId,LedgerId.Builder>
com.google.protobuf.GeneratedMessageLite<LedgerId,LedgerId.Builder>
com.hedera.hashgraph.sdk.proto.LedgerId
All Implemented Interfaces:
com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, LedgerIdOrBuilder
@Generated public final class LedgerId extends com.google.protobuf.GeneratedMessageLite<LedgerId,LedgerId.Builder> implements LedgerIdOrBuilder
 *
 A ledger identifier.<br/>
 This message identifies a ledger and is used to verify ledger
 signatures in a Threshold Signature Scheme (TSS).

 A ledger identifier SHALL be a public key defined according to the TSS
 process.<br/>
 A ledger identifier SHOULD NOT change, but MAY do so in rare
 circumstances.<br/>
 Clients SHOULD always check for the correct ledger identifier, according to
 the network roster, before attempting to verify any state proof or other
 ledger signature.

 ### Block Stream Effects
 Every block in the Block Stream `BlockProof` SHALL be signed via TSS and
 MUST be verified with the ledger identifier current at the _start_ of that
 block.
 If the ledger identifier changes, the new value MUST be used to validate
 Block Proof items after the change.
 A change to the ledger identifier SHALL be reported in a State Change for
 the block containing that change, which SHALL be verified with the _prior_
 ledger identifier.
Protobuf type com.hedera.hapi.node.state.roster.LedgerId

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    LedgerId.Builder
    * A ledger identifier.<br/> This message identifies a ledger and is used to verify ledger signatures in a Threshold Signature Scheme (TSS).

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageLite

    com.google.protobuf.GeneratedMessageLite.DefaultInstanceBasedParser<T extends com.google.protobuf.GeneratedMessageLite<T,?>>, com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.GeneratedExtension<ContainingType extends com.google.protobuf.MessageLite,Type>, com.google.protobuf.GeneratedMessageLite.MethodToInvoke, com.google.protobuf.GeneratedMessageLite.SerializedForm

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    LEDGER_ID_FIELD_NUMBER
     
    static final int
    LEDGER_SIGNATURE_FIELD_NUMBER
     
    static final int
    ROSTER_SIGNATURES_FIELD_NUMBER
     
    static final int
    ROUND_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageLite

    unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    protected final Object
    dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
     
    static LedgerId
    getDefaultInstance()
     
    com.google.protobuf.ByteString
    getLedgerId()
    * A public key.<br/> This key both identifies the ledger and can be used to verify ledger signatures.
    com.google.protobuf.ByteString
    getLedgerSignature()
    * A signature from the prior ledger key.<br/> This signature is the _previous_ ledger ID signing _this_ ledger ID.<br/> This value MAY be unset, if there is no prior ledger ID.<br/> This value SHOULD be set if a prior ledger ID exists to generate the signature.
    RosterSignatures
    getRosterSignatures()
    * The signatures from nodes in the active roster signing the new ledger id.<br/> These signatures establish a chain of trust from the network to the new ledger id.
    long
    getRound()
    * A round number.<br/> This identifies when this ledger id becomes active.<br/> This value is REQUIRED.
    boolean
    hasRosterSignatures()
    * The signatures from nodes in the active roster signing the new ledger id.<br/> These signatures establish a chain of trust from the network to the new ledger id.
    static LedgerId.Builder
    newBuilder()
     
    static LedgerId.Builder
    newBuilder(LedgerId prototype)
     
    static LedgerId
    parseDelimitedFrom(InputStream input)
     
    static LedgerId
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static LedgerId
    parseFrom(byte[] data)
     
    static LedgerId
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static LedgerId
    parseFrom(com.google.protobuf.ByteString data)
     
    static LedgerId
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static LedgerId
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static LedgerId
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static LedgerId
    parseFrom(InputStream input)
     
    static LedgerId
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static LedgerId
    parseFrom(ByteBuffer data)
     
    static LedgerId
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<LedgerId>
    parser()
     

    Methods inherited from class com.google.protobuf.GeneratedMessageLite

    createBuilder, createBuilder, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, emptyProtobufList, equals, getDefaultInstanceForType, getParserForType, getSerializedSize, hashCode, isInitialized, makeImmutable, mergeLengthDelimitedField, mergeUnknownFields, mergeVarintField, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBuilderForType, newMessageInfo, newRepeatedGeneratedExtension, newSingularGeneratedExtension, parseDelimitedFrom, parseDelimitedFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parsePartialFrom, parseUnknownField, registerDefaultInstance, toBuilder, toString, writeTo

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Field Details

    • LEDGER_ID_FIELD_NUMBER

      public static final int LEDGER_ID_FIELD_NUMBER
      See Also:

    • ROUND_FIELD_NUMBER

      public static final int ROUND_FIELD_NUMBER
      See Also:

    • LEDGER_SIGNATURE_FIELD_NUMBER

      public static final int LEDGER_SIGNATURE_FIELD_NUMBER
      See Also:

    • ROSTER_SIGNATURES_FIELD_NUMBER

      public static final int ROSTER_SIGNATURES_FIELD_NUMBER
      See Also:

  • Method Details

    • getLedgerId

      public com.google.protobuf.ByteString getLedgerId()
       *
 A public key.<br/>
 This key both identifies the ledger and can be used to verify ledger
 signatures.
 <p>
 This value MUST be set.<br/>
 This value MUST NOT be empty.<br/>
 This value MUST contain a valid public key.
      bytes ledger_id = 1;
      Specified by:
      getLedgerId in interface LedgerIdOrBuilder
      Returns:
      The ledgerId.

    • getRound

      public long getRound()
       *
 A round number.<br/>
 This identifies when this ledger id becomes active.<br/>
 This value is REQUIRED.
      uint64 round = 2;
      Specified by:
      getRound in interface LedgerIdOrBuilder
      Returns:
      The round.

    • getLedgerSignature

      public com.google.protobuf.ByteString getLedgerSignature()
       *
 A signature from the prior ledger key.<br/>
 This signature is the _previous_ ledger ID signing _this_ ledger ID.<br/>
 This value MAY be unset, if there is no prior ledger ID.<br/>
 This value SHOULD be set if a prior ledger ID exists
 to generate the signature.
      bytes ledger_signature = 3;
      Specified by:
      getLedgerSignature in interface LedgerIdOrBuilder
      Returns:
      The ledgerSignature.

    • hasRosterSignatures

      public boolean hasRosterSignatures()
       *
 The signatures from nodes in the active roster signing the new
 ledger id.<br/>
 These signatures establish a chain of trust from the network to the new
 ledger id.
 <p>
 This value MUST be present when the ledger signature of a previous ledger
 id is absent.
      .com.hedera.hapi.node.state.roster.RosterSignatures roster_signatures = 4;
      Specified by:
      hasRosterSignatures in interface LedgerIdOrBuilder
      Returns:
      Whether the rosterSignatures field is set.

    • getRosterSignatures

      public RosterSignatures getRosterSignatures()
       *
 The signatures from nodes in the active roster signing the new
 ledger id.<br/>
 These signatures establish a chain of trust from the network to the new
 ledger id.
 <p>
 This value MUST be present when the ledger signature of a previous ledger
 id is absent.
      .com.hedera.hapi.node.state.roster.RosterSignatures roster_signatures = 4;
      Specified by:
      getRosterSignatures in interface LedgerIdOrBuilder
      Returns:
      The rosterSignatures.

    • parseFrom

      public static LedgerId parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static LedgerId parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static LedgerId parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static LedgerId parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static LedgerId parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static LedgerId parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static LedgerId parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static LedgerId parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static LedgerId parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static LedgerId parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static LedgerId parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static LedgerId parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilder

      public static LedgerId.Builder newBuilder()

    • newBuilder

      public static LedgerId.Builder newBuilder(LedgerId prototype)

    • dynamicMethod

      protected final Object dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
      Specified by:
      dynamicMethod in class com.google.protobuf.GeneratedMessageLite<LedgerId,LedgerId.Builder>

    • getDefaultInstance

      public static LedgerId getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<LedgerId> parser()