.. _module-splice-util-50740: Splice.Util =========== Utility functions shared across all splice apps\. Typeclasses ----------- .. _class-splice-util-hascheckedfetch-36555: **class** (`HasFetch `_ t, `Show `_ t, `Eq `_ cgid, `Show `_ cgid) \=\> `HasCheckedFetch `_ t cgid **where** Contracts typically come in groups\. For example, all contracts managed by a specific DSO party\. We aim to always fetch with a specific contract group identifier to ensure that we do not mixup contracts from different groups\. .. _function-splice-util-contractgroupid-63283: `contractGroupId `_ \: t \-\> cgid Functions --------- .. _function-splice-util-requirematchingcontract-54053: `requireMatchingContract `_ \: (`Eq `_ t, `Show `_ t, `HasFetch `_ t) \=\> `ContractId `_ t \-\> t \-\> `Update `_ () Require that a contract\-id refers to a specific contract\. .. _function-splice-util-require-11486: `require `_ \: `CanAssert `_ m \=\> `Text `_ \-\> `Bool `_ \-\> m () Check whether a required condition is true\. If it's not, abort the transaction with a message saying that the requirement was not met\. .. _function-splice-util-fetchandarchive-96960: `fetchAndArchive `_ \: (`HasCheckedFetch `_ t cgid, `HasArchive `_ t) \=\> cgid \-\> `ContractId `_ t \-\> `Update `_ t Fetch and archive a contract in one go\. Use this when implementing choices that mutate another contract by fetching, archiving, and then creating the updated contract\. .. _function-splice-util-fetchreferencedata-72475: `fetchReferenceData `_ \: `HasCheckedFetch `_ t cgid \=\> cgid \-\> `ContractId `_ t \-\> `Update `_ t Fetch a contract that serves as reference data\. Use this whenever you need to fetch a contract that you do not intend to mutate\. .. _function-splice-util-fetchbutarchivelater-86159: `fetchButArchiveLater `_ \: `HasCheckedFetch `_ t cgid \=\> cgid \-\> `ContractId `_ t \-\> `Update `_ t Fetch a contract that is not reference data, and should be archived later in some cases\. Prefer ``fetchAndArchive`` over this function, as it avoids forgetting to archive the contract\. .. _function-splice-util-fetchpublicreferencedata-76996: `fetchPublicReferenceData `_ \: (`HasCheckedFetch `_ t cgid, `HasExercise `_ t ch t) \=\> cgid \-\> `ContractId `_ t \-\> ch \-\> `Update `_ t Fetch a contract that offers a choice anybody to be read as reference data\. .. _function-splice-util-fetchuncheckedandarchive-65397: `fetchUncheckedAndArchive `_ \: (`HasFetch `_ b, `HasArchive `_ b) \=\> `ContractId `_ b \-\> `Update `_ b Fetch and archive a contract in one go\. Use this when implementing choices that mutate another contract by fetching, archiving, and then creating the updated contract\. .. _function-splice-util-fetchuncheckedreferencedata-5520: `fetchUncheckedReferenceData `_ \: `HasFetch `_ t \=\> `ContractId `_ t \-\> `Update `_ t Fetch a contract that serves as reference data\. Use this whenever you need to fetch a contract that you do not intend to mutate\. .. _function-splice-util-fetchuncheckedbutarchivelater-82900: `fetchUncheckedButArchiveLater `_ \: `HasFetch `_ t \=\> `ContractId `_ t \-\> `Update `_ t Fetch a contract that is not reference data, and should be archived later in some cases\. Prefer ``fetchAndArchive`` over this function, as it avoids forgetting to archive the contract\. .. _function-splice-util-potentiallyunsafearchive-47027: `potentiallyUnsafeArchive `_ \: `HasArchive `_ t \=\> `ContractId `_ t \-\> `Update `_ () A more appropriately named version of ``archive``\. Please justify all its uses, and where possible prefer ``fetchAndArchive`` so that the contract group identifier is surely performed\.