abstract class ErrorCode extends AnyRef

Error Code Definition

We want to support our users and our developers with good error codes. Therefore, every error that an API returns should refer to a documented error code and provide some context information.

Every error code is uniquely identified using an error-id of max 63 CAPITALIZED_WITH_UNDERSCORES characters

Errors are organised according to ErrorGroups. And we separate the error code definition (using a singleton by virtue of using objects to express the nested hierarchy) and the actual error.

Please note that there is some implicit argument passing involved in the example below:

object SyncServiceErrors extends ParticipantErrorGroup { object ConnectionErrors extends ErrorGroup { object DomainUnavailable extends ErrorCode(id="DOMAIN_UNAVAILABLE", ..) { case class ActualError(someContext: Val) extends BaseError with SyncServiceError // this error will actually be referring to the same error code! case class OtherError(otherContext: Val) extends BaseError with SyncServiceError } } object HandshakeErrors extends ErrorGroup { ... } }

Linear Supertypes
AnyRef, Any
Known Subclasses
ErrorCodeFoo, ProtoDeserializationFailure, CannotParseFilesError, CannotReadFilesError, ConfigErrorCode, GenericConfigError, NoConfigFiles, SubstitutionError, ValidationError, CommandErrorCode, CommandInternalError, ConsoleTimeout, NodeNotStarted, InvalidKmsKeyId, NoEncryptedPrivateKeyStoreError, RegisterKmsKeyInternalError, WrapperKeyAlreadyInUseError, WrapperKeyDisabledOrDeletedError, WrapperKeyNotExistError, WrapperKeyRotationInternalError, FailedToInitialiseDomainNode, ExceededMaxSequencingTime, InvalidAcknowledgementSignature, InvalidAcknowledgementTimestamp, InvalidEnvelopeSignature, InvalidLedgerEvent, InvalidPruningRequestOnChain, InvalidSubmissionRequestSignature, MaxRequestSizeExceeded, MissingSubmissionRequestSignatureTimestamp, MultipleMediatorRecipients, PayloadToEventTimeBoundExceeded, SequencerAuthenticationFailure, SequencerAuthenticationFaultyOrMalicious, AlienDomainEntities, FailedToAddMember, InvalidOrFaultyOnboardingRequest, ParticipantNotInitialized, WrongDomain, WrongProtocolVersion, TopologyDispatchingDegradation, TopologyDispatchingInternalError, AlarmErrorCode, AheadOfHead, AttemptToChangeImmutableValue, BesuVersionMismatch, ManyBlocksBehindHead, NotFreeGasNetwork, UnableToQueryVersion, WrongEVMBytecode, InvalidTransaction, ReceiptFetchingFailed, SubmissionFailed, AheadOfHead, ManyBlocksBehindHead, InvalidTransaction, SubmissionFailed, TransactionProposalSubmissionFailed, InternalError, InvalidMessage, MalformedMessage, Timeout, RequestDeadlineExceeded, RequestTimeOut, ServerIsShuttingDown, ServiceInternalError, ServiceNotRunning, UnsupportedOperation, ResultSetError, SqlNonTransientError, SqlTransientError, HeapMemoryOverLimit, InternalError, MaximumNumberOfStreams, ParticipantBackpressure, ThreadpoolOverloaded, InternalError, ParticipantShuttingDown, InvalidDar, InvalidDarFileName, InvalidLegacyDar, InvalidZipEntry, ParseError, ZipBomb, SelfConsistency, UpgradeVersion, Upgradeability, ValidationError, ConfigurationEntryRejected, InternallyInvalidKey, PackageUploadRejected, AccessTokenExpired, InternalAuthorizationError, PermissionDenied, StaleUserManagementBasedStreamClaims, Unauthenticated, FailedToDetermineLedgerTime, AuthorizationError, ContractDoesNotImplementInterface, ContractDoesNotImplementRequiringInterface, ContractIdComparability, ContractIdInContractKey, ContractNotActive, CreateEmptyContractKeyMaintainers, DisclosedContractKeyHashingError, FetchEmptyContractKeyMaintainers, GenericInterpretationError, InterpretationDevError, InterpretationUserError, InvalidArgumentInterpretationError, ContractKeyNotFound, NonComparableValues, TemplatePreconditionViolated, UnhandledException, ValueNesting, WronglyTypedContract, AllowedLanguageVersions, PackageValidationFailed, PreprocessingFailed, TimeExceeded, ContractNotFound, DisclosedContractInvalid, DuplicateCommand, DuplicateContractKey, Inconsistent, InconsistentContractKey, InconsistentContracts, InvalidLedgerTime, SubmissionAlreadyInFlight, IdentityProviderConfigAlreadyExists, IdentityProviderConfigByIssuerNotFound, IdentityProviderConfigIssuerAlreadyExists, IdentityProviderConfigNotFound, InvalidUpdateIdentityProviderConfigRequest, TooManyIdentityProviderConfigs, ConcurrentPartyDetailsUpdateDetected, InternalPartyRecordAlreadyExists, InternalPartyRecordNotFound, InvalidUpdatePartyDetailsRequest, MaxPartyAnnotationsSizeExceeded, PartyNotFound, InvalidArgument, InvalidDeduplicationPeriodField, InvalidField, LedgerIdMismatch, MissingField, NonHexOffset, LedgerConfiguration, NoTemplatesForPackageNameAndQualifiedName, Package, PackageNamesNotFound, TemplateOrInterfaceIdsNotFound, Transaction, OffsetAfterLedgerEnd, OffsetOutOfRange, ParticipantPrunedDataAccessed, ConcurrentUserUpdateDetected, InvalidUpdateUserRequest, MaxUserAnnotationsSizeExceeded, TooManyUserRights, UserAlreadyExists, UserNotFound, InternallyDuplicateKeys, InternallyInconsistentKeys, PartyNotKnownOnLedger, SubmitterCannotActViaParticipant, SubmittingPartyNotKnownOnLedger, AbortedDueToShutdown, CanNotAutomaticallyVetAdminWorkflowPackage, DarNotFound, PackageMissingDependencies, PackageRemovalErrorCode, InternalError, UnsupportedConfig, InternalServerError, NoInternalParticipantDataBefore, NonCantonOffset, ParticipantShuttingDown, PruningNotSupportedInCommunityEdition, UnsafeToPrune, ContractPurgeError, ImportAcsError, InconsistentAcsSnapshot, InvalidAcsSnapshotTimestamp, InvalidArgument, SerializationError, UnavailableAcsSnapshot, UnsupportedProtocolVersionParticipant, CanNotIssueDomainTrustCertificate, DomainParametersChanged, IncompatibleUniqueContractKeysMode, InvalidDomainConnections, MisconfiguredStaticDomainParameters, SequencersFromDifferentDomainsAreConfigured, DomainIsNotAvailable, FailedToConnectToSequencer, FailedToConnectToSequencers, GrpcFailure, ParticipantIsNotActive, DomainRegistryInternalError, DomainAliasDuplication, DomainCryptoHandshakeFailed, DomainIdMismatch, HandshakeFailed, ServiceAgreementAcceptanceFailed, TopologyConversionError, ContractAuthenticationFailed, DomainBackpressure, DomainWithoutMediatorError, InactiveMediatorError, MalformedRequest, PackageNotVettedByRecipients, ParticipantOverloaded, SequencerRequest, SubmissionDuringShutdown, TimeoutError, UnknownContractDomain, AcsCommitmentDegradation, AcsCommitmentDegradationWithIneffectiveConfig, InternalError, AcsCommitmentAlarm, CommitmentsMismatch, NoSharedContracts, MalformedDeduplicationOffset, InternalError, InvalidArgument, PartyAllocationNoDomainError, SyncServiceAlarm, SyncServiceAlreadyAdded, SyncServiceDomainBecamePassive, SyncServiceDomainDisabledUs, SyncServiceDomainDisconnect, SyncServiceDomainIsNotActive, SyncServiceDomainMustBeOffline, SyncServiceDomainMustNotHaveInFlightTransactions, SyncServiceDomainStatusMustBeInactive, SyncServiceInternalError, SyncServiceUnknownDomain, InjectionFailure, NotConnectedToAnyDomain, PassiveReplica, AutomaticTransferForTransactionFailure, InvalidPrescribedDomainId, MultiDomainSupportNotEnabled, SubmissionDomainNotReady, DisclosedContractAuthenticationFailed, InvalidDisclosedContract, InvalidDomainAlias, InvalidDomainId, InvalidPartyIdentifier, InvalidSubmitter, RoutingInternalError, InformeesNotActive, NoCommonDomain, NoDomainForSubmission, NoDomainOnWhichAllSubmittersCanSubmit, NotConnectedToAllContractDomains, SubmitterAlwaysStakeholder, SubmittersNotActive, UnknownContractDomains, UnknownInformees, UnknownSubmitters, UnableToQueryTopologySnapshot, CannotVetDueToMissingPackages, DangerousKeyUseCommandRequiresForce, DangerousVettingCommandsRequireForce, DependenciesNotVetted, DisablePartyWithActiveContractsRequiresForce, UninitializedParticipant, DuplicateKey, InactiveContracts, InconsistentKey, LockedContracts, LockedKeys, BadRootHashMessages, CreatesExistingContracts, MalformedRequest, ModelConformance, Payloads, LedgerTime, LocalTimeout, SubmissionTime, AlreadyCompleted, ContractAlreadyActive, ContractAlreadyArchived, ContractIsLocked, ActivenessCheckFailed, LocalRejectErrorCode, MalformedErrorCode, DatabaseConnectionLost, DatabaseStorageDegradation, ForkHappened, LostSequencerSubscription, TombstoneEncountered, EnvelopeOpenerDeserializationError, SequencerDeliverErrorCode, AggregateSubmissionAlreadySent, AggregateSubmissionStuffing, MaxSequencingTimeTooFar, PersistTombstone, SigningTimestampAfterSequencingTimestamp, SigningTimestampMissing, SigningTimestampTooEarly, SubmissionRequestMalformed, SubmissionRequestRefused, TrafficCredit, UnknownRecipients, SystemClockRunningBackwards, DuplicateTransaction, IllegalRemovalOfDomainTrustCertificate, IncreaseOfLedgerTimeRecordTimeTolerance, InsufficientKeys, InternalError, InvalidSignatureError, InvalidThreshold, InvalidTrafficLimit, MappingAlreadyExists, NoAppropriateSigningKeyInStore, NoCorrespondingActiveTxToRevoke, PublicKeyNotInStore, RemovingKeyWithDanglingTransactionsMustBeForced, RemovingLastKeyMustBeForced, SecretKeyNotInStore, SerialMismatch, TopologyManagerAlarm, UnauthorizedTransaction, UnknownMembers, WrongDomain, DeprecatedProtocolVersion, DeprecatingProtocolVersion, Disputed, OutOfQuota
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ErrorCode
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ErrorCode(id: String, category: ErrorCategory)(implicit parent: ErrorClass)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. val category: ErrorCategory
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  7. implicit val code: ErrorCode
  8. def codeStr(correlationId: Option[String]): String

    The machine readable error code string, uniquely identifiable by the error id, error category and correlation id.

    The machine readable error code string, uniquely identifiable by the error id, error category and correlation id. e.g. NO_DOMAINS_CONNECTED(2,ABC234)

  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  11. def errorConveyanceDocString: Option[String]

    The error conveyance doc string provides a statement about the form this error will be returned to the user

  12. def exposedViaApi: Boolean

    True if this error may appear on the API

    True if this error may appear on the API

    Attributes
    protected
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  15. val id: String
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. def logLevel: Level

    Log level of the error code

    Log level of the error code

    Generally, the log level is defined by the error category. In rare cases, it might be overridden by the error code.

  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  21. implicit val parent: ErrorClass
  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. def toMsg(cause: => String, correlationId: Option[String], limit: Option[Int]): String

    returns

    message including error category id, error code id, correlation id and cause

  24. def toString(): String
    Definition Classes
    AnyRef → Any
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped