Documentation

Unit

Adds two integers and never fails.

Subtracts two integers and never fails.

Multiplies two integers and never fails.

Finds the quotient of two integers and fails when the second argument, the divisor, is zero. See Note [Integer division operations] for explanation on divideInteger, modInteger, quotientInteger, and remainderInteger.

Finds the remainder of two integers and fails when the second argument, the divisor, is zero.

Finds the quotient of two integers and fails when the second argument, the divisor, is zero.

Finds the remainder of two integers and fails when the second argument, the divisor, is zero.

Compares two integers and returns true when the first argument is less than the second | argument.

Compares two integers and returns true when the first argument is less or equal to than the | second argument.

Checks equality of two integers and never fails.

An opaque type representing Plutus Core ByteStrings.

Appends a bytestring to another and never fails.

Appends a byte to the given bytestring. The semantics of this function differ based on [Builtin semantics variants]. - For builtin semantics variant A and B, that is for PlutusV1 and PlutusV2, this reduces the first argument modulo 256 and will never fail. - For builtin semantics variant C, that is for PlutusV3, this will expect first argument to be in range [0..255] and fail otherwise.

Slices the given bytestring and never fails. The first integer marks the beginning index and the second marks the end. Indices are expected to be 0-indexed, and when the first integer is greater than the second, it returns an empty bytestring.

Returns the length of the provided bytestring.

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

An empty bytestring.

Computes the SHA2-256 hash of the given bytestring.

Computes the SHA3-256 hash of the given bytestring.

Computes the Blake2b-224 hash of the given bytestring.

Computes the Blake2b-256 hash of the given bytestring.

Computes the Keccak-256 hash of the given bytestring.

Computes the RIPEMD-160 hash of the given bytestring.

Ed25519 signature verification. The first bytestring is the public key (32 bytes), followed by an arbitrary-size message and the signature (64 bytes). The sizes of the public key and signature are enforced, and it fails when given bytestrings of incorrect size.

ECDSA signature verification on the SECP256k1 curve. The first bytestring is the public key (33 bytes), followed by the message hash (32 bytes) and the signature (64 bytes). The sizes of the public key and signature are enforced, and it fails when given bytestrings of incorrect size.

Schnorr signature verification on the SECP256k1 curve. The first bytestring is the public key (32 bytes), followed by an arbitrary-length message and the signature (64 bytes). The sizes of the public key and signature are enforced, and it fails when given bytestrings of incorrect size.

Runs trace for each element in a foldable structure.

Checks the equality of two bytestrings and never fails

Checks if the first bytestring is less than the second bytestring and never fails. Comparison of the bytestrings will behave identically to the compare implementation in Ord. It will compare two bytestrings byte by byte—lexicographical ordering.

Checks if the first bytestring is less than or equal to the second bytestring and never fails.

Decodes the given bytestring to a string and fails when the given bytestring is not a valid UTF-8 bytestring.

Appends a string to another and never fails.

An empty string.

Checks the equality of two strings and never fails.

Emits a trace message and never fails.

Encodes a string into a bytestring and never fails.

Takes first value from the tuple and never fails.

Takes second value from the tuple and never fails.

Constructs tuple from two builtin data.

Checks if the given list is 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.

Branches out depending on the structure of given list and never fails. If given list is empty, it will take the first branch and if not it will take the second branch.

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

Similar to caseList', but empty list case is omitted so passing empty list will raise error

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

Creates an empty data list and never fails. Prefer using constant. See Note [Constants vs built-in functions]

Creates an empty data pair list and never fails. Prefer using constant. See Note [Constants vs built-in functions]

Appends a new element to the given list and never fails.

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.

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.

Branches out depending on the structure of given data and never fails.

Creates Constr data value with the given index and elements; never fails.

Creates Map data value with the given list of pairs and never fails.

Creates List data value with the given list and never fails.

Creates I data value with the given integer and never fails.

Creates B data value with the given bytestring and never fails.

Deconstructs the given data as a Constr, failing if it is not a Constr.

Deconstructs the given data as a Map, failing if it is not a Map.

Deconstructs the given data as a List, failing if it is not a List.

Deconstructs the given data as a I, failing if it is not a I.

Deconstructs the given data as a B, failing if it is not a B.

Checks equality of two data and never fails.

Serialize the given data into CBOR bytestring. See Data for exact encoder as Data does not uses Generic version.

Returns the length of the provided array and never fails

Converts given list into 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.

Checks equality of two G1 elements and never fails.

Adds two G1 elements and never fails.

Negates a G1 element and never fails.

Multiplies a G1 element by a scalar and never fails.

Compresses a G1 element to a bytestring and never fails.

Uncompresses a bytestring to a G1 element, failing if the bytestring is not a valid compressed G1 element.

Hashes an arbitrary bytestring message to a G1 element using the given domain separation tag (DST), failing if length of the DST is bigger than 255 bytes.

The compressed form of the G1 identity element.

The compressed form of the G1 generator element.

Checks equality of two G2 elements and never fails.

Adds two G2 elements and never fails.

Negates a G2 element and never fails.

Multiplies a G2 element by a scalar and never fails.

Compresses a G2 element to a bytestring and never fails.

Uncompresses a bytestring to a G2 element, failing if the bytestring is not a valid compressed G2 element.

Hashes an arbitrary bytestring message to a G2 element using the given domain separation tag (DST), failing if length of the DST is bigger than 255 bytes.

The compressed form of the G2 identity element (also known as zero or point at infinity).

The compressed form of the G2 generator element.

Computes the Miller loop between a G1 element and a G2 element and never fails.

Multiplies two Miller loop results and never fails.

Performs the final verification step of a pairing check. Returns true if e(P,Q) == e(R,S) for the given Miller loop results, and never fails.

Converts the given integer to a bytestring. The first argument specifies endianness (True for big-endian), followed by the target length of the resulting bytestring and the integer itself. Fails if the target length is greater than 8192 or if the length argument is 0 and the result won't fit into 8192 bytes. See integerToByteString for its invariants in detail.

Converts the given bytestring to the integer and never fails. The first argument specifies endianness (True for big-endian), followed by the bytestring.

Shifts the bytestring to the left if the second argument is positive, and to the right otherwise. Right-shifts fill with 0s from the left (logical shift); left-shifts fill with 0s from the right. Never fails.

Rotates the bytestring to the left if the second argument is positive, and to the right otherwise. Never fails.

Counts the number of bits set to 1 in the bytestring and never fails.

Finds the index of the first bit set to 1 in the bytestring. If the bytestring consists only of 0s, it returns the length of the bytestring in bits. Never fails.

Performs a bitwise AND on two bytestrings. The first boolean argument indicates whether to use padding (True) or truncation (False) if the bytestrings have different lengths. Never fails.

Performs a bitwise OR on two bytestrings. The first boolean argument indicates whether to use padding (True) or truncation (False) if the bytestrings have different lengths. Never fails.

Performs a bitwise XOR on two bytestrings. The first boolean argument indicates whether to use padding (True) or truncation (False) if the bytestrings have different lengths. Never fails.

Performs a bitwise complement on the bytestring and never fails.

Reads the bit at the given index in the bytestring. Fails if the index is out of bounds.

Writes the given bit (third argument, True for 1, False for 0) at the specified indices (second argument) in the bytestring. Fails if any index is out of bounds.

Creates a bytestring of a given length by repeating the given byte. Fails if the byte, second argument, is not in range [0,255], the length is negative, or when the length is greater than 8192.

Computes modular exponentiation (base^exponent mod modulus). Fails if the modulus is zero or negative, or if the exponent is negative and the modular inverse does not exist.

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