Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.canton.network/llms.txt

Use this file to discover all available pages before exploring further.

​
DA.Fail

Fail, for FailureStatus

​
Module Snapshot

Lifecycle

Stable.

Notices

Status: active Introduced in: 3.4.9 Removed in: - Warnings: 0 Deprecations: 0 Deprecated since: -

​
Data Types

​
data FailureCategory

The category of the failure, which determines the status code and log level of the failure. Maps 1-1 to the Canton error categories documented here: https://docs.digitalasset.com/operate/3.4/reference/error_codes.html#error-categories-inventory If you are more familiar with gRPC error codes, you can use the synonyms referenced in the comments. Constructors:
  • InvalidIndependentOfSystemState Use this to report errors that are independent of the current state of the ledger, and should thus not be retried.
Corresponds to the gRPC status code INVALID_ARGUMENT. See https://docs.digitalasset.com/operate/3.4/reference/error_codes.html#invalidindependentofsystemstate for more information.
  • InvalidGivenCurrentSystemStateOther Use this to report errors that are due to the current state of the ledger, but might disappear if the ledger state changes. Clients should retry these requests after reading updated state from the ledger.
Corresponds to the gRPC status code FAILED_PRECONDITION. See https://docs.digitalasset.com/operate/3.4/reference/error_codes.html#error-categories-inventory for more information. Instances:
  • instance GetField category FailureStatus FailureCategory
  • instance SetField category FailureStatus FailureCategory
  • instance Eq FailureCategory
  • instance Ord FailureCategory
  • instance Show FailureCategory

​
data FailureStatus

Constructors:
  • FailureStatus | Field | Type | Description | | :---- | :--- | :---------- | | errorId | Text | Unambiguous identifier of the error.

    SHOULD be prefixed with the DNS name identifying the app provider

    or the API standard defining the error. For example,

    splice.lfdecentralizedtrust.org/insufficient-funds could be used for

    reporting an out of funds error in the context of the CN token standards. | | category | FailureCategory | Category of the failure, which determines how clients are expected to handle the error. | | message | Text | Developer-facing error message, which should be in English. | | meta | TextMap Text | Machine-readable metadata about the error in a key-value format.

    Use this to provide extra context to clients for errors.

    SHOULD be less than < 512 characters as it MAY be truncated otherwise. |
Instances:
  • instance GetField category FailureStatus FailureCategory
  • instance GetField errorId FailureStatus Text
  • instance GetField message FailureStatus Text
  • instance GetField meta FailureStatus (TextMap Text)
  • instance SetField category FailureStatus FailureCategory
  • instance SetField errorId FailureStatus Text
  • instance SetField message FailureStatus Text
  • instance SetField meta FailureStatus (TextMap Text)
  • instance Eq FailureStatus
  • instance Ord FailureStatus
  • instance Show FailureStatus

​
Typeclasses

​
class Action m => ActionFailWithStatus m

Methods:
  • failWithStatus : FailureStatus -> m a Fail with a failure status
Instances:
  • instance ActionFailWithStatus Update

​
Functions

​
invalidArgument

invalidArgument : FailureCategory
Alternative name for InvalidIndependentOfSystemState.

​
failedPrecondition

failedPrecondition : FailureCategory
Alternative name for InvalidGivenCurrentSystemStateOther.

​
failWithStatusPure

failWithStatusPure : FailureStatus -> a
Fail with a failure status in a pure context

​
Orphan Typeclass Instances

  • instance Eq FailureStatus
  • instance Ord FailureStatus
  • instance Show FailureStatus
  • instance Eq FailureCategory
  • instance Ord FailureCategory
  • instance Show FailureCategory
  • instance GetField errorId FailureStatus Text
  • instance SetField errorId FailureStatus Text
  • instance GetField category FailureStatus FailureCategory
  • instance SetField category FailureStatus FailureCategory
  • instance GetField message FailureStatus Text
  • instance SetField message FailureStatus Text
  • instance GetField meta FailureStatus (TextMap Text)
  • instance SetField meta FailureStatus (TextMap Text)
  • instance ActionFail Update
  • instance CanAbort Update