Contract w s e a is a contract with schema s, producing a value of type a or an error e. See note [Contract Schema].

Class of types that can be trivially converted to a Contract. For use with functions where it is convenient to accept both Contract and Promise types.

Sequentially compose two actions, discarding any value produced by the first, like sequencing operators (such as the semicolon) in imperative languages.

'as >> bs' can be understood as the do expression

do as
   bs

Handle errors, potentially throwing new errors.

Transform any exceptions thrown by the Contract using the given function.

Turn a contract with error type e and return type a into one with any error type (ie. throwing no errors) that returns 'Either e a'

A wrapper indicating that this contract starts with a waiting action. For use with select.

Lift a mapping function for Contract to a mapping function for Promise.

Run more Contract code after the Promise.

Execute both contracts in any order

A variant of select for contracts with different return types.

select returns the contract that makes progress first, discarding the other one.

However, note that if multiples promises are chained together like P1 select P2 select P3 and all three can make progress at the same moment, then select will prioritize the promises starting from the right (first P3 then P2 then P1).

selectList returns the contract that makes progress first, discarding the other ones.

However, if multiple contracts can make progress, selectList prioritizes the ones appearing first in the input list. Therefore, the order of the list of promises is important.

A Promise that is never fulfilled. This is the identity of select.

Wait until the slot

Wait until the slot

Get the current slot number

Get the current slot number of PAB

Get the current slot number of the node client (the local or remote node) that the application is connected to.

Get the current node slot number querying slot number from plutus chain index to be aligned with slot at local running node

Wait for a number of slots to pass

Wait until the slot where the given time falls into and return latest time we know has passed.

Example: if starting time is 0 and slot length is 3s, then `awaitTime 4` waits until slot 2 and returns the value `POSIXTime 5`.

Wait until the slot where the given time falls into and return latest time we know has passed.

Get the latest time of the current slot.

Example: if slot length is 3s and current slot is 2, then currentTime returns the value `POSIXTime 5`

Get the POSIXTime range of the current slot.

Example: if slot length is 3s and current slot is 2, then currentTimeRange returns the time interval [3, 5[.

Wait for a number of milliseconds starting at the ending time of the current slot, and return the latest time we know has passed.

Example: if starting time is 0, slot length is 3000ms and current slot is 0, then `waitNMilliSeconds 0` returns the value `POSIXTime 2000` and `waitNMilliSeconds 1000` returns the value `POSIXTime 5`.

Expose an endpoint, return the data that was entered

Expose an endpoint with some metadata. Return the data that was entered.

Wait until the target slot and get the unspent transaction outputs at an address.

Wait until the target time and get the unspent transaction outputs at an address.

Watch an address for changes, and return the outputs at that address when the total value at the address has surpassed the given value.

Watch an address for changes, and return the outputs at that address when the total value at the address has reached or surpassed the given value.

Wait until the UTXO has been spent, returning the transaction that spends it.

Wait until the UTXO has been spent, returning the transaction that spends it.

Wait until one or more unspent outputs are produced at an address.

Wait until one or more unspent outputs are produced at an address.

Get the all datums at an address whether or not the corresponding utxo have been consumed or not.

Find the reference to an utxo containing a reference script by its the script hash, amongst the utxos at a given address

Get the unspent transaction output references at an address.

Get the unspent transaction output references with a specific currrency (AssetClass).

Get the unspent transaction outputs at an address.

Get the unspent transaction outputs from a ChainIndexTx.

Get the hash of a public key belonging to the wallet that runs this contract. * Any funds paid to this public key hash will be treated as the wallet's own funds * The wallet is able to sign transactions with the private key of this public key, for example, if the public key is added to the requiredSignatures field of Tx. * There is a 1-n relationship between wallets and public keys (although in the mockchain n=1)

Get the addresses belonging to the wallet that runs this contract. * Any funds paid to one of these addresses will be treated as the wallet's own funds * The wallet is able to sign transactions with the private key of one of its public key, for example, if the public key is added to the requiredSignatures field of Tx. * There is a 1-n relationship between wallets and addresses (although in the mockchain n=1)

Get the first address of the wallet that runs this contract.

Get all utxos belonging to the wallet that runs this contract.

Unique ID for contract instance

Get the ContractInstanceId of this instance.

Update the contract's accumulating state w

An error thrown by wallet interactions.

Adjust the unbalanced tx

Build a transaction that satisfies the constraints, then submit it to the network. The constraints do not refer to any typed script inputs or outputs.

A version of submitTx that waits until the transaction has been confirmed on the ledger before returning.

Build a transaction that satisfies the constraints, then submit it to the network. Using the current outputs at the contract address and the contract's own public key to solve the constraints.

Build a transaction that satisfies the constraints using the UTXO map to resolve any input constraints (see InputConstraint)

Build a transaction that satisfies the constraints, then submit it to the network. Using the given constraints.

Send an unbalanced transaction to be balanced and signed. Returns the ID of the final transaction when the transaction was submitted. Throws an error if balancing or signing failed.

Send an balanced transaction to be signed. Returns the ID of the final transaction when the transaction was submitted. Throws an error if signing failed.

Send an unbalanced transaction to be balanced. Returns the balanced transaction. Throws an error if balancing failed.

Build a transaction that satisfies the constraints

Take an UnbalancedTx then balance, sign and submit it to the blockchain without returning any results.

Wait until a transaction is confirmed (added to the ledger). If the transaction is never added to the ledger then awaitTxConfirmed never returns

Wait for the status of a transaction to change

Wait until a transaction is confirmed (added to the ledger).

Wait for the status of a transaction output to change.

Get the configured parameter set.

Write the current state of the contract to a checkpoint.

Constraints on the contract schema, ensuring that the labels of the schema are unique.