scalus.prelude

package scalus.prelude

Members list

Packages

Type members

Classlikes

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

class Object

trait Matchable

class Any
Self type: AssocMap.type

Validator, parametrized by Data. Keep

Needed for compatibility with solutions which use existing uplc scripts and apply Data as parameter on UPLC level.

Attributes

Supertypes: class Object

trait Matchable

class Any

@FunctionalInterface

Attributes

Companion: object
Supertypes: trait CompileDerivations

trait (A, A) => Boolean

class Object

trait Matchable

class Any

Attributes

Companion: trait
Supertypes: class Object

trait Matchable

class Any
Self type: Eq.type

Attributes

Companion: object
Supertypes: trait Enum

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Known subtypes: class Cons[A]

Attributes

Companion: enum
Supertypes: trait Sum

trait Mirror

class Object

trait Matchable

class Any
Self type: List.type

Attributes

Supertypes: class Object

trait Matchable

class Any
Self type: Math.type

Alternative to scala.Option in onchain code.

Options Eq and Ord are defined in terms of the contained A elements.

Type parameters

A: the type of the element contained in the Option

Attributes

Companion: object
Supertypes: trait Enum

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Known subtypes: class Some[A]

Attributes

Companion: enum
Supertypes: trait Sum

trait Mirror

class Object

trait Matchable

class Any
Self type: Option.type

@FunctionalInterface

Attributes

Companion: object
Supertypes: trait CompileDerivations

trait (A, A) => Order

class Object

trait Matchable

class Any

Attributes

Companion: trait
Supertypes: class Object

trait Matchable

class Any
Self type: Ord.type

Attributes

Companion: object
Supertypes: trait Enum

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: enum
Supertypes: trait Sum

trait Mirror

class Object

trait Matchable

class Any
Self type: Order.type

Attributes

Supertypes: class Object

trait Matchable

class Any

Attributes

Supertypes: class Object

trait Matchable

class Any
Self type: Prelude.type

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

class Object

trait Matchable

class Any
Self type: Rational.type

@FunctionalInterface

This is used to provide a string representation of values, which can be useful for debugging, logging, or displaying information about the value.

A typeclass for converting values of type A to a String.

This is used to provide a string representation of values, which can be useful for debugging, logging, or displaying information about the value.

Type parameters

A: the type of the value to be shown

Attributes

Companion: object
Supertypes: trait CompileDerivations

trait A => String

class Object

trait Matchable

class Any

Attributes

Companion: trait
Supertypes: class Object

trait Matchable

class Any
Self type: Show.type

@FunctionalInterface

Attributes

Companion: object
Supertypes: trait CompileDerivations

trait A => ByteString

class Object

trait Matchable

class Any

Attributes

Companion: trait
Supertypes: class Object

trait Matchable

class Any
Self type: ShowByteString.type

Alternative to scala.collection.immutable.SortedMap in onchain code.

Type parameters

A: the type of keys, must be an instance of Ord
B: the type of values

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

class Object

trait Matchable

class Any
Self type: SortedMap.type

Attributes

Supertypes: trait ArbitraryInstances

trait ScalaCheckPropertyChecks

trait ScalaCheckDrivenPropertyChecks

trait Configuration

trait TableDrivenPropertyChecks

trait Tables

trait Whenever

class AnyFunSuite

trait AnyFunSuiteLike

trait Documenting

trait Alerting

trait Notifying

trait Informing

trait TestRegistration

trait TestSuite

trait Suite

trait Serializable

trait Assertions

trait TripleEquals

trait TripleEqualsSupport

class Object

trait Matchable

class Any
Show all

Attributes

Companion: object
Supertypes: trait Enum

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: enum
Supertypes: trait Sum

trait Mirror

class Object

trait Matchable

class Any
Self type: These.type

Attributes

Supertypes: class Object

trait Matchable

class Any

Represents a variable number of arguments as a list.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Types

Value members

Concrete methods

??? can be used for marking methods that remain to be implemented.

Attributes

Throws: NotImplementedError
when ??? is invoked.

Fails the onchain evaluation with an ERROR term and a specific error message.

This is used to indicate a failure in the on-chain logic with a specific error message.

Value parameters

message: The error message to include in the failure.

Attributes

Throws: OnchainError
when invoked off-chain.

Fails the onchain evaluation with an ERROR term.

This is used to indicate a failure in the on-chain logic without providing a specific error message.

Attributes

Throws: OnchainError
when invoked off-chain.

Fails the onchain evaluation with an ERROR term indicating an impossible situation.

This is used to indicate an impossible situation in the on-chain logic.

Attributes

Throws: ImpossibleLedgerStateError
when invoked off-chain.

Tests an expression, throwing an RequirementError if false.

Value parameters

requirement: the expression to test

Attributes

Throws

RequirementError

when invoked off-chain.

Note

we do not use scala.Predef.require because it's not an inline method and it's not expanded before Scalus compiler plugin phase.

Example

 require(value > 1000, "Not enough")

Tests an expression, throwing a RequirementError if false.

This is used to enforce preconditions in on-chain logic.

Value parameters

requirement: The boolean expression to test.

Attributes

Throws

RequirementError

when invoked off-chain.

Example

 require(value > 1000)

Extensions

extension [A](self: A)

extension [A](self: A)(implicit evidence$1: Ord[A])

extension [A](self: A)

extension (self: BigInt)

extension (self: BigInt.type)

extension [A](self: Seq[A])

Converts a scala.Seq to a List.

This method is only available offchain.

Attributes

Returns

A List[A] containing all the elements from this sequence in the same order.

Example

 scala.Seq.empty[BigInt].asScalus === List.empty[BigInt]
 val seq: scala.Seq[BigInt] = scala.Seq(BigInt(1), BigInt(2), BigInt(3))
 seq.asScalus === Cons(BigInt(1), Cons(BigInt(2), Cons(BigInt(3), Nil)))

extension [A](self: Option[A])

Converts a scala.Option to an Option

Attributes

extension (self: BigInt)

Calculate the absolute value of the integer.

Value parameters

other: The other number to compute ABS with.

Attributes

See also: scalus.prelude.Math.abs

Restrict the value of this integer between two bounds

Value parameters

max: highest allowed value.
min: lowest allowed value.

Attributes

See also: scalus.prelude.Math.clamp

Calculates the power of 2 for this exponent.

Attributes

See also: scalus.prelude.Math.exp2

The greatest common factor aka divisor of this and another integer.

Value parameters

other: The other integer to compute GCD with.

Attributes

See also: scalus.prelude.Math.gcd

Checks if this integer has a given integer square root x.

Value parameters

x: square root to check.

Attributes

See also: scalus.prelude.Math.isSqrt

The integer logarithm in base 2.

Attributes

See also: scalus.prelude.Math.log2

Computes the logarithm in a given base using integer divisions.

Value parameters

base: Base of logarithm.

Attributes

See also: scalus.prelude.Math.log

Returns the larger of this and another integer.

Value parameters

other: The other number to compute MAX with.

Attributes

See also: scalus.prelude.Math.maximum

Returns the smaller of this and another integer.

Value parameters

other: The other number to compute MIN with.

Attributes

See also: scalus.prelude.Math.min

Raises this integer to a power using the exponentiation by squaring method.

Value parameters

exp: The exponent of power to raise.

Attributes

See also: scalus.prelude.Math.pow

Calculates the square root of this integer using the babylonian method.

Attributes

See also: scalus.prelude.Math.sqrt

extension [T](seq: Seq[T])

extension [A](x: A)

Deprecated extensions

extension (x: Boolean)

Trace the expression only if it evaluates to false. This is useful to trace an entire evaluation path that led to a final expression being false.

Attributes

Returns

the value of the expression

Example

mustBeAfter.? && mustSpendToken.?

will trace "mustSpendToken ? False" if mustBeAfter is true and mustSpendToken is false.

Attributes

Deprecated: [Since version 0.13.0] Use prelude.require() instead

In this article

Generated with