The first part of the cause. Typically the same for all instances of the particular type.

The error code, usually passed in as implicit where the error class is defined

We have a correspondence {Proto version} <-> {[protocol version]}: each proto version correspond to a list of consecutive protocol versions. The representative is one instance of this list, usually the smallest value. In other words, the Proto versions induce an equivalence relation on the list of protocol version, thus use of representative.

The method protocolVersionRepresentativeFor below allows to query the representative for an equivalence class.

The second part of the cause. Typically a class parameter.

The affected resources. It is used as follows: - It will be logged as part of the context information. - It may be included into the resulting LocalReject. The computation of LocalReject performs truncation so this may or may not be included. - The LocalReject is sent via the sequencer to the mediator. Therefore: do not include any confidential data! - The LocalReject is also output through the ledger API.

Use this as a temporary solution, to make the code compile during an ongoing migration. Drawbacks:

• Instances of Pretty[T] are ignored.
• No parameter names

Casts this instance's representative protocol version to one for the target type. This only succeeds if the versioning schemes are the same.

A human readable string indicating the error

The context (declared fields) of this error

Use this if you need a custom representation of a parameter. Do not use this to create lengthy strings, as line wrapping is not supported.

Parameter has no effect at the moment, as submission ranks are not supported. Setting to false for the time being.

Use this to indicate that you've omitted fields from pretty printing

Contains the location where the error has been created.

A tree representing both parameter name and value.

A tree only written if not matching the default value

A tree representing a parameter name without a parameter value. Use this for parameters storing confidential or binary data.

Indicates how to pretty print this instance. See PrettyPrintingTest for examples on how to implement this method.

A tree consisting of a labelled node with the given children.

A tree representing the type name and parameter trees.

A tree presenting the type name only. (E.g., for case objects.)

Use this to give a class with a singleton parameter the same pretty representation as the parameter.

Creates a pretty instance from a string function. Do not use this with lengthy strings, as line wrapping is not supported.

Yields the Proto version that this class will be serialized to

The resources related to this error

We return the set of resources via com.google.rpc.ResourceInfo. Override this method in order to return resource information via com.google.rpc.Status

Returns retryability information of this particular error

In some cases, error instances would like to provide custom retry intervals. This can be achieved by locally overriding this method.

Do not use this to change the contract of the error categories. Non-retryable errors shouldn't be made retryable. Only use it for adjusting the retry intervals.

Enables the syntax show"This object is pretty: $myPrettyType".

An optional argument to log exceptions

If you want to log an exception as part of your error, then use the following example:

object MyCode extends ErrorCode(id="SUPER_DUPER_ERROR") { case class MyError(someString: String, throwable: Throwable) extends SomeInternalError( cause = "Something failed with an exception bla", throwableO = Some(throwable) ) }

NOTE: This throwable's details are not included the exception communicated to the gRPC clients so if you want them communicated, you need to explicitly add them to the e.g. context map or cause string.

Yields a byte array representation of the corresponding UntypedVersionedMessage wrapper of this instance.

Yields a byte string representation of the corresponding UntypedVersionedMessage wrapper of this instance.

Yields the proto representation of the class inside an UntypedVersionedMessage wrapper.

Subclasses should make this method public by default, as this supports composing proto serializations. Keep it protected, if there are good reasons for it (e.g. com.digitalasset.canton.serialization.ProtocolVersionedMemoizedEvidence).

Be aware that if calling on a class that defines a LegacyProtoConverter, this method will still return a VersionedMessage. If the current protocol version maps to the legacy converter, deserialization will then fail (as it will try to deserialize to the raw protobuf instead of the VersionedMessage wrapper this was serialized to. Prefer using toByteString which handles this use case correctly.

Yields a readable string representation based on com.digitalasset.canton.logging.pretty.Pretty.DefaultPprinter. Final to avoid accidental overwriting.

A tree representing a parameter value without a parameter name.

Will check that default value rules defined in companionObj.defaultValues hold.

Serializes this instance to a message together with a delimiter (the message length) to the given output stream.

This method works in conjunction with com.digitalasset.canton.version.HasProtocolVersionedCompanion2.parseDelimitedFromUnsafe which deserializes the message again. It is useful for serializing multiple messages to a single output stream through multiple invocations.

Serialization is only supported for com.digitalasset.canton.version.HasSupportedProtoVersions.VersionedProtoConverter, an error message is returned otherwise.