Aborts evaluation with an error.

A type corresponding to the Plutus Core builtin equivalent of Data.

The point of this type is to be an opaque equivalent of Data, so as to ensure that it is only used in ways that the compiler can handle.

As such, you should use this type in your on-chain code, and in any data structures that you want to be representable on-chain.

For off-chain usage, there are conversion functions builtinDataToData and dataToBuiltinData, but note that these will not work on-chain.

Given five values for the five different constructors of BuiltinData, selects one depending on which corresponds to the actual constructor of the given value.

Given a BuiltinData value and matching functions for the five constructors, applies the appropriate matcher to the arguments of the constructor and returns the result.

Check if two BuiltinDatas are equal.

Convert a String into a ByteString.

Constructs a BuiltinData value with the Constr constructor.

Constructs a BuiltinData value with the Map constructor.

Constructs a BuiltinData value with the List constructor.

Constructs a BuiltinData value with the I constructor.

Constructs a BuiltinData value with the B constructor.

Deconstructs a BuiltinData as a Constr, or fails if it is not one.

Deconstructs a BuiltinData as a Map, or fails if it is not one.

Deconstructs a BuiltinData as a List, or fails if it is not one.

Deconstructs a BuiltinData as an I, or fails if it is not one.

Deconstructs a BuiltinData as a B, or fails if it is not one.

NOT a builtin. Converts a BuiltinData into a Data. Only works off-chain.

NOT a builtin. Converts a Data into a BuiltinData. Only works off-chain.

Append two Strings.

An empty String.

Check if two strings are equal

Convert a String into a ByteString.

Turn a builtin pair into a normal pair, useful in patterns.

Case matching on a builtin pair. Continuation is needed here to make it more efficient on builtin-casing implementation.

The empty list of elements of the given type that gets spotted by the plugin (grep for mkNilOpaque in the plugin code) and replaced by the actual empty list constant for types that are supported (a subset of built-in types).

Similar to chooseList but deconstructs the list in case provided list is not empty.

Takes the first element of the list and fails if given list is empty.

Takes the last element of the list and fails if given list is empty.

Drops first n elements from the given list and never fails.

Uncons a builtin list, failing if the list is empty, useful in patterns.

Uncons a builtin list, failing if the list is empty, useful in patterns.

Converts given list into array and never fails.

Returns the length of the provided array and never fails

Returns the n-th element from the array. Fails if the given index is not in the range [0..j), where j is the length of the array.

Emit the given string as a trace message before evaluating the argument.

Byte ordering.

Convert a BuiltinInteger into a BuiltinByteString, as described in CIP-121. The first argument indicates the endianness of the conversion and the third argument is the integer to be converted, which must be non-negative. The second argument must also be non-negative and it indicates the required width of the output. If the width is zero then the output is the smallest bytestring which can contain the converted input (and in this case, the integer 0 encodes to the empty bytestring). If the width is nonzero then the output bytestring will be padded to the required width with 0x00 bytes (on the left for big-endian conversions and on the right for little-endian conversions); if the input integer is too big to fit into a bytestring of the specified width then the conversion will fail. Conversion will also fail if the specified width is greater than 8192 or the input integer is too big to fit into a bytestring of length 8192.

Convert a BuiltinByteString to a BuiltinInteger, as described in CIP-121. The first argument indicates the endianness of the conversion and the second is the bytestring to be converted. There is no limitation on the size of the bytestring. The empty bytestring is converted to the integer 0.

Perform logical AND on two BuiltinByteString arguments, as described in CIP-122.

The first argument indicates whether padding semantics should be used or not; if False, truncation semantics will be used instead.

See also

• Padding and truncation semantics
• Bit indexing scheme

Perform logical OR on two BuiltinByteString arguments, as described here.

The first argument indicates whether padding semantics should be used or not; if False, truncation semantics will be used instead.

See also

• Padding and truncation semantics
• Bit indexing scheme

Perform logical XOR on two BuiltinByteString arguments, as described here.

The first argument indicates whether padding semantics should be used or not; if False, truncation semantics will be used instead.

See also

• Padding and truncation semantics
• Bit indexing scheme

Perform logical complement on a BuiltinByteString, as described here.

See also

• Bit indexing scheme

Read a bit at the _bit_ index given by the Integer argument in the BuiltinByteString argument. The result will be True if the corresponding bit is set, and False if it is clear. Will error if given an out-of-bounds index argument; that is, if the index is either negative, or equal to or greater than the total number of bits in the BuiltinByteString argument.

See also

• Bit indexing scheme
• Operation description

Given a BuiltinByteString, a list of indexes to change, and a boolean value b to change those indexes to, set the bit at each of the specified index as follows:

• If b is True, set that bit;
• Otherwise, clear that bit.

Will error if any of the indexes are out-of-bounds: that is, if the index is either negative, or equal to or greater than the total number of bits in the BuiltinByteString argument.

Note

This differs slightly from the description of the corresponding operation in CIP-122; instead of a single changelist argument comprised of pairs, we instead pass a single list of indexes to change, and a single boolean value to change those indexes to. The original proposal allowed one to set and clear bits in a single operation, but constructing the list of boolean values for the updates was somewhat expensive. If it's really necessary to set some bits and clear others then it is easier to call the function twice, once to set bits and and once to clear them.

See also

• Bit indexing scheme
• Operation description

Given a length (first argument) and a byte (second argument), produce a BuiltinByteString of that length, with that byte in every position. Will error if given a negative length, or a second argument that isn't a byte (less than 0, greater than 255).

See also

• Operation description

Shift a BuiltinByteString, as per CIP-123.

Rotate a BuiltinByteString, as per CIP-123.

Count the set bits in a BuiltinByteString, as per CIP-123.

Find the lowest index of a set bit in a BuiltinByteString, as per CIP-123.

If given a BuiltinByteString which consists only of zero bytes (including the empty BuiltinByteString, this returns -1.