A builtin Plutus Value.

Since: 1.14.0

Given a currency, a token name, an amount, an an existing PBuiltinValue, produce a new PBuiltinValue, identical to the argument PBuiltinValue, except as follows:

• If the amount is 0, the new PBuiltinValue will have the given currency-token name entry deleted;
• If the argument PBuiltinValue is empty, the new PBuiltinValue will be a singleton containing the given currency-token name entry with the given (nonzero) amount.
• If the argument PBuiltinValue already contains the given currency-token name entry, the new PBuiltinValue will have that currency-token name entry replaced with the given (nonzero) amount.
• Otherwise, the new PBuiltinValue will contain a new currency-token name entry, with the given (nonzero) amount.

Important note

If given a currency name, or a token name, that isn't valid, this will error.

Since: 1.14.0

Given a currency, a token name, and a PBuiltinValue, return the amount associated with the given currency-token name entry. If there is no such entry, the result is 0.

Important note

If given a currency name, or token name, that isn't valid, this will produce 0.

Since: 1.14.0

Given two PBuiltinValues, constructs their union. More specifically, for every currency-token name entry in either argument, the result will contain a currency-token name entry as well. If the entry is in one argument, it will be copied as-is; otherwise, the amounts will be combined from both maps using addition.

Important note

PBuiltinValues cannot store amounts outside of the range of a 128-bit signed integer. If any amount produced by this operation would fall outside of this range, this function will error.

Since: 1.14.0

pvalueContains x y is true when, for any currency-token name entry in y, the amount associated with that entry in x is not smaller.

Important note

Neither argument can contain any negative entries. If either argument has a negative entry, this will error.

Since: 1.14.0

Converts a PBuiltinValue into its Data encoding.

Since: 1.14.0

Converts a valid Data encoding of a PBuiltinValue into the PBuiltinValue it represents, and errors otherwise.

Since: 1.14.0

Given a PBuiltinValue and a scalar, produce a new PBuiltinValue with all amounts multiplied by that scalar. Note that if the scalar is 0, then the result will be an empty PBuiltinValue.

Since: 1.14.0