Burn roles tokens

[nhenin]

  -- | Construct a transaction that burns all role tokens in a wallet which match
  -- the given filter.
  Burn
    :: WalletAddresses
    -- ^ The wallet addresses to use when constructing the transaction
    -> RoleTokenFilter
    -- ^ Which role tokens to burn
    -> MarloweTxCommand Void BurnError BurnTx

type RoleTokenFilter = RoleTokenFilter' ContractId PolicyId AssetId

data BurnError
  = BurnEraUnsupported AnyCardanoEra
  | BurnRolesActive (Set PolicyId)
  | BurnInvalidPolicyId (Set PolicyId)
  | BurnNoTokens
  | BurnFromCardanoError
  | -- FIXME most of this error is not relevant to burning, but due to the current
    -- constraint solving being too marlowe-specific, and because we use the
    -- final balancing pipeline for burning, we sadly need to use this type here.
    BurnConstraintError ConstraintError
  deriving stock (Show, Eq, Ord, Generic)
  deriving anyclass (Binary, ToJSON, Variations)

-- | Represents different filters for role tokens.
data RoleTokenFilter' contract policyId token
  = -- | Represents a filter that matches if either of the two sub-filters match.
    RoleTokensOr (RoleTokenFilter' contract policyId token) (RoleTokenFilter' contract policyId token)
  | -- | Represents a filter that matches if both of the two sub-filters match.
    RoleTokensAnd (RoleTokenFilter' contract policyId token) (RoleTokenFilter' contract policyId token)
  | -- | Represents a filter that matches if the sub-filter does not match.
    RoleTokensNot (RoleTokenFilter' contract policyId token)
  | -- | Represents a filter that matches any role token.
    RoleTokenFilterAny
  | -- | Represents a filter that matches no role tokens.
    RoleTokenFilterNone
  | -- | Represents a filter that matches role tokens based on a set of contracts.
    RoleTokenFilterByContracts (Set contract)
  | -- | Represents a filter that matches role tokens based on a set of policy IDs.
    RoleTokenFilterByPolicyIds (Set policyId)
  | -- | Represents a filter that matches role tokens based on a set of tokens.
    RoleTokenFilterByTokens (Set token)
  deriving stock (Show, Eq, Ord, Generic)
  deriving anyclass (Binary)