> ## Documentation Index
> Fetch the complete documentation index at: https://cantonfoundation-generated-references-json-api-reference-up.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Splice.Testing.Utils

> Documentation for Splice.Testing.Utils

Testing utilities to simplify testing token standard usage and implementation.

## Data Types

<div id="type-splice-testing-utils-disclosurestick-7569">
  **data** Disclosures'
</div>

> A set of disclosures. Used to work around the fact that duplicate disclosures for the same contract are not allowed.
>
> <div id="constr-splice-testing-utils-disclosurestick-34366">
>   Disclosures'
> </div>
>
> > | Field       | Type                                                                                                          | Description |
> > | ----------- | ------------------------------------------------------------------------------------------------------------- | ----------- |
> > | disclosures | [Map](/appdev/reference/daml-standard-library/prelude#type-da-internal-lf-map-90052) AnyContractId Disclosure |             |
>
> **instance** [Monoid](/appdev/reference/daml-standard-library/prelude#class-da-internal-prelude-monoid-6742) Disclosures'
>
> **instance** [Semigroup](/appdev/reference/daml-standard-library/prelude#class-da-internal-prelude-semigroup-78998) Disclosures'
>
> **instance** GetField "disclosures" Disclosures' ([Map](/appdev/reference/daml-standard-library/prelude#type-da-internal-lf-map-90052) AnyContractId Disclosure)
>
> **instance** GetField "disclosures" (EnrichedFactoryChoice t ch) Disclosures'
>
> **instance** GetField "disclosures" OpenApiChoiceContext Disclosures'
>
> **instance** SetField "disclosures" Disclosures' ([Map](/appdev/reference/daml-standard-library/prelude#type-da-internal-lf-map-90052) AnyContractId Disclosure)
>
> **instance** SetField "disclosures" (EnrichedFactoryChoice t ch) Disclosures'
>
> **instance** SetField "disclosures" OpenApiChoiceContext Disclosures'

<div id="type-splice-testing-utils-enrichedfactorychoice-76896">
  **data** EnrichedFactoryChoice t ch
</div>

> A choice on a factory contract enriched with an appropriate choice-context and disclosures.
>
> <div id="constr-splice-testing-utils-enrichedfactorychoice-82153">
>   EnrichedFactoryChoice
> </div>
>
> > | Field       | Type                                                                                                 | Description |
> > | ----------- | ---------------------------------------------------------------------------------------------------- | ----------- |
> > | factoryCid  | [ContractId](/appdev/reference/daml-standard-library/prelude#type-da-internal-lf-contractid-95282) t |             |
> > | arg         | ch                                                                                                   |             |
> > | disclosures | Disclosures'                                                                                         |             |
>
> **instance** GetField "arg" (EnrichedFactoryChoice t ch) ch
>
> **instance** GetField "disclosures" (EnrichedFactoryChoice t ch) Disclosures'
>
> **instance** GetField "factoryCid" (EnrichedFactoryChoice t ch) ([ContractId](/appdev/reference/daml-standard-library/prelude#type-da-internal-lf-contractid-95282) t)
>
> **instance** SetField "arg" (EnrichedFactoryChoice t ch) ch
>
> **instance** SetField "disclosures" (EnrichedFactoryChoice t ch) Disclosures'
>
> **instance** SetField "factoryCid" (EnrichedFactoryChoice t ch) ([ContractId](/appdev/reference/daml-standard-library/prelude#type-da-internal-lf-contractid-95282) t)

<div id="type-splice-testing-utils-failurestatuscheck-2574">
  **data** FailureStatusCheck
</div>

> <div id="constr-splice-testing-utils-failurestatuscheck-17729">
>   FailureStatusCheck
> </div>
>
> > | Field | Type                                                                                                                                                                                                   | Description |
> > | ----- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------- |
> > | check | FailureStatus -> [Optional](/appdev/reference/daml-standard-library/prelude#type-da-internal-prelude-optional-37153) [Text](/appdev/reference/daml-standard-library/prelude#type-ghc-types-text-51952) |             |
>
> **instance** [Semigroup](/appdev/reference/daml-standard-library/prelude#class-da-internal-prelude-semigroup-78998) FailureStatusCheck
>
> **instance** GetField "check" FailureStatusCheck (FailureStatus -> [Optional](/appdev/reference/daml-standard-library/prelude#type-da-internal-prelude-optional-37153) [Text](/appdev/reference/daml-standard-library/prelude#type-ghc-types-text-51952))
>
> **instance** SetField "check" FailureStatusCheck (FailureStatus -> [Optional](/appdev/reference/daml-standard-library/prelude#type-da-internal-prelude-optional-37153) [Text](/appdev/reference/daml-standard-library/prelude#type-ghc-types-text-51952))

<div id="type-splice-testing-utils-openapichoicecontext-5726">
  **data** OpenApiChoiceContext
</div>

> A representation of a ChoiceContext and disclosed contracts as they would be returned by the an OpenAPI endpoint of the token standard.
>
> <div id="constr-splice-testing-utils-openapichoicecontext-58633">
>   OpenApiChoiceContext
> </div>
>
> > | Field         | Type          | Description |
> > | ------------- | ------------- | ----------- |
> > | choiceContext | ChoiceContext |             |
> > | disclosures   | Disclosures'  |             |
>
> **instance** [Semigroup](/appdev/reference/daml-standard-library/prelude#class-da-internal-prelude-semigroup-78998) OpenApiChoiceContext
>
> **instance** GetField "choiceContext" OpenApiChoiceContext ChoiceContext
>
> **instance** GetField "disclosures" OpenApiChoiceContext Disclosures'
>
> **instance** SetField "choiceContext" OpenApiChoiceContext ChoiceContext
>
> **instance** SetField "disclosures" OpenApiChoiceContext Disclosures'

## Functions

<div id="function-splice-testing-utils-emptyextraargs-23102">
  emptyExtraArgs
  : ExtraArgs

  Use this to construct an empty 'ExtraArgs' record.
</div>

<div id="function-splice-testing-utils-withextradisclosures-38780">
  withExtraDisclosures
  : Disclosures' -> OpenApiChoiceContext -> OpenApiChoiceContext

  Add extra disclosures to an 'OpenApiChoiceContext'.
</div>

<div id="function-splice-testing-utils-querydisclosuretick-36762">
  queryDisclosure'
  : [Template](/appdev/reference/daml-standard-library/prelude#type-da-internal-template-functions-template-31804) t => [Party](/appdev/reference/daml-standard-library/prelude#type-da-internal-lf-party-57932) -> [ContractId](/appdev/reference/daml-standard-library/prelude#type-da-internal-lf-contractid-95282) t -> Script Disclosures'

  Retrieve a disclosed contract by its contract-id from a specific party's ACS.
</div>

<div id="function-splice-testing-utils-submitwithdisclosurestick-2335">
  submitWithDisclosures'
  : [Party](/appdev/reference/daml-standard-library/prelude#type-da-internal-lf-party-57932) -> Disclosures' -> Commands a -> Script a

  Version of 'submitWithDisclosures' that works with the simplified `Disclosures'` type.
</div>

<div id="function-splice-testing-utils-submitwithdisclosuresmustfailtick-79338">
  submitWithDisclosuresMustFail'
  : [Party](/appdev/reference/daml-standard-library/prelude#type-da-internal-lf-party-57932) -> Disclosures' -> Commands a -> Script ()

  Version of 'submitWithDisclosuresMustFail' that works with the simplified `Disclosures'` type.
</div>

<div id="function-splice-testing-utils-allocatepartyexact-97926">
  allocatePartyExact
  : [Text](/appdev/reference/daml-standard-library/prelude#type-ghc-types-text-51952) -> Script [Party](/appdev/reference/daml-standard-library/prelude#type-da-internal-lf-party-57932)

  Allocate party with a specific name.
</div>

<div id="function-splice-testing-utils-submitwithdisclosuresmustfailticktick-58494">
  submitWithDisclosuresMustFail''
  : [Show](/appdev/reference/daml-standard-library/prelude#class-ghc-show-show-65360) a => FailureStatusCheck -> [Party](/appdev/reference/daml-standard-library/prelude#type-da-internal-lf-party-57932) -> Disclosures' -> Commands a -> Script ()

  Use this to check that commands fail with the expected 'FailureStatus'.
</div>

<div id="function-splice-testing-utils-submitmultimustfailticktick-78157">
  submitMultiMustFail''
  : [Show](/appdev/reference/daml-standard-library/prelude#class-ghc-show-show-65360) a => FailureStatusCheck -> \[[Party](/appdev/reference/daml-standard-library/prelude#type-da-internal-lf-party-57932)] -> \[[Party](/appdev/reference/daml-standard-library/prelude#type-da-internal-lf-party-57932)] -> Commands a -> Script ()

  Use this to check that multi-party submission fails with the expected 'FailureStatus'.
</div>

<div id="function-splice-testing-utils-expecterrorid-70623">
  expectErrorId
  : [Text](/appdev/reference/daml-standard-library/prelude#type-ghc-types-text-51952) -> FailureStatusCheck
</div>

<div id="function-splice-testing-utils-expectmessagecontains-36340">
  expectMessageContains
  : [Text](/appdev/reference/daml-standard-library/prelude#type-ghc-types-text-51952) -> FailureStatusCheck
</div>

<div id="function-splice-testing-utils-expectunmetrequirement-1831">
  expectUnmetRequirement
  : [Text](/appdev/reference/daml-standard-library/prelude#type-ghc-types-text-51952) -> FailureStatusCheck
</div>

<div id="function-splice-testing-utils-expectfailurestatus-34748">
  expectFailureStatus
  : (FailureStatus -> [Bool](/appdev/reference/daml-standard-library/prelude#type-ghc-types-bool-66265)) -> FailureStatusCheck
</div>