Skip to content

Commit

Permalink
Organize builtins, add blake2b-224, fix AList -> Pairs
Browse files Browse the repository at this point in the history
  • Loading branch information
@KtorZ
KtorZ committed Aug 23, 2024
1 parent 2b3ec51 commit e658c8a
Show file tree
Hide file tree
Showing 2 changed files with 134 additions and 104 deletions.
14 changes: 7 additions & 7 deletions lib/aiken.ak
View file
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,13 @@ pub opaque type Pair<k, v> {
Pair
}

/// <small>Minimum Plutus Version</small> | <small>1</small>
/// --- | ---
///
/// A associative list as a list of pairs of 2 elements.
pub type Pairs<k, v> =
List<Pair<k, v>>

/// <small>Minimum Plutus Version</small> | <small>3</small>
/// --- | ---
///
Expand Down Expand Up @@ -137,13 +144,6 @@ pub type PRNG {
pub type Fuzzer<a> =
fn(PRNG) -> Option<(PRNG, a)>

/// <small>Minimum Plutus Version</small> | <small>1</small>
/// --- | ---
///
/// An associative list of key/value pairs.
pub type AList<k, v> =
List<Pair<k, v>>

/// <small>Minimum Plutus Version</small> | <small>1</small>
/// --- | ---
///
Expand Down
224 changes: 127 additions & 97 deletions lib/aiken/builtin.ak
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
//// of the Plutus virtual machine on failure. They also all rely on call-by-value, which means
//// that function arguments are eagerly evaluated.

// ## Integer

/// <small>Minimum Plutus Version</small> | <small>1</small>
/// --- | ---
///
Expand Down Expand Up @@ -92,6 +94,29 @@ pub fn less_than_equals_integer(left: Int, right: Int) -> Int {
fail
}

/// <small>Minimum Plutus Version</small> | <small>3</small>
/// --- | ---
///
/// Convert an integer value into a [ByteArray](../aiken.html#ByteArray).
///
/// - The first arguments / specifies the endianness:
///
/// boolean value | endianness
/// ---- | ----
/// True | Big endian
/// False | Little endian
///
/// - The second argument indicates the target `size` (in bytes) of the final [ByteArray](../aiken.html#ByteArray). This allows to allocate a specific number of bytes in advance. The function fails if the given value cannot fit in the requested size or if the `value` is negative. However, a size of 0 will yield a [ByteArray](../aiken.html#ByteArray) that is precisely as large as necessary to fit the `value`.
pub fn integer_to_bytearray(
endianness: Bool,
size: Int,
value: Int,
) -> ByteArray {
fail
}

// ## Bytearray

/// <small>Minimum Plutus Version</small> | <small>1</small>
/// --- | ---
///
Expand Down Expand Up @@ -156,65 +181,21 @@ pub fn less_than_equals_bytearray(left: ByteArray, right: ByteArray) -> Bool {
fail
}

/// <small>Minimum Plutus Version</small> | <small>1</small>
/// --- | ---
///
/// Calculate the SHA2-256 hash digest value of a given bytearray. Output is always 32-byte long.
pub fn sha2_256(preimage: ByteArray) -> ByteArray {
fail
}

/// <small>Minimum Plutus Version</small> | <small>1</small>
/// --- | ---
///
/// Calculate the SHA3-256 hash digest value of a given bytearray. Output is always 32-byte long.
pub fn sha3_256(preimage: ByteArray) -> ByteArray {
fail
}

/// <small>Minimum Plutus Version</small> | <small>1</small>
/// --- | ---
///
/// Calculate the blake2b-256 hash digest value of a given bytearray. Output is always 32-byte long.
pub fn blake2b_256(preimage: ByteArray) -> ByteArray {
fail
}

/// <small>Minimum Plutus Version</small> | <small>1</small>
/// <small>Minimum Plutus Version</small> | <small>3</small>
/// --- | ---
///
/// Verify an Ed25519 signature from a associated verification key.
pub fn verify_ed25519_signature(
verification_key: ByteArray,
message: ByteArray,
signature: ByteArray,
) -> ByteArray {
fail
}

/// <small>Minimum Plutus Version</small> | <small>2</small>
/// --- | ---
/// Convert a [ByteArray](../aiken.html#ByteArray) to an integer value. The first argument
/// specifies the endianness:
///
/// Verify an ECDSA-SECP256k1 signature from a associated verification key.
pub fn verify_ecdsa_secp256k1_signature(
verification_key: ByteArray,
message: ByteArray,
signature: ByteArray,
) -> ByteArray {
/// boolean value | endianness
/// ---- | ----
/// True | Big endian
/// False | Little endian
pub fn bytearray_to_integer(endianness: Bool, bytes: ByteArray) -> Int {
fail
}

/// <small>Minimum Plutus Version</small> | <small>2</small>
/// --- | ---
///
/// Verify a SCHNORR-SECP256k1 signature from a associated verification key.
pub fn verify_schnorr_secp256k1_signature(
verification_key: ByteArray,
message: ByteArray,
signature: ByteArray,
) -> ByteArray {
fail
}
// ## String

/// <small>Minimum Plutus Version</small> | <small>1</small>
/// --- | ---
Expand Down Expand Up @@ -248,11 +229,21 @@ pub fn decode_utf8(bytes: ByteArray) -> String {
fail
}

// ## List

/// <small>Minimum Plutus Version</small> | <small>1</small>
/// --- | ---
///
/// Return first computation when the condition is true, and the second otherwise.
pub fn if_then_else(condition: Bool, when_true: a, when_false: a) -> a {
/// Construct an empty list of Data.
pub fn new_list() -> List<Data> {
fail
}

/// <small>Minimum Plutus Version</small> | <small>1</small>
/// --- | ---
///
/// Push an element in front of a list.
pub fn cons_list(elem: a, list: List<a>) -> List<a> {
fail
}

Expand Down Expand Up @@ -280,6 +271,16 @@ pub fn null_list(list: List<a>) -> Bool {
fail
}

/// <small>Minimum Plutus Version</small> | <small>1</small>
/// --- | ---
///
/// Select a branch to continue with depending on whether the list is empty or not.
pub fn choose_list(list: List<a>, when_empty: b, when_non_empty: b) -> b {
fail
}

// ## Data

/// <small>Minimum Plutus Version</small> | <small>1</small>
/// --- | ---
///
Expand Down Expand Up @@ -391,78 +392,116 @@ pub fn choose_data(
fail
}

// ## Pair

/// <small>Minimum Plutus Version</small> | <small>1</small>
/// --- | ---
///
/// Construct a Data from a pair of elements.
pub fn mk_pair_data(left: Data, right: Data) -> Pair<Data, Data> {
pub fn new_pair(left: Data, right: Data) -> Pair<Data, Data> {
fail
}

/// <small>Minimum Plutus Version</small> | <small>1</small>
/// --- | ---
///
/// Construct an empty list of Data.
pub fn mk_nil_data() -> List<Data> {
/// Construct an empty list of pairs of data.
pub fn new_pairs() -> Pairs<Data, Data> {
fail
}

/// <small>Minimum Plutus Version</small> | <small>1</small>
/// --- | ---
///
/// Construct an empty list of pairs of data.
pub fn mk_nil_pair_data() -> List<Pair<Data, Data>> {
/// Get the first element of a pair.
pub fn fst_pair(pair: Pair<a, b>) -> a {
fail
}

/// <small>Minimum Plutus Version</small> | <small>1</small>
/// --- | ---
///
/// Continue with the continuation when the given term is Void.
pub fn choose_void(void: Void, when_void: a) -> a {
/// Get the second element of a pair.
pub fn snd_pair(pair: Pair<a, b>) -> b {
fail
}

// ## Crypto

// ### Hashing

/// <small>Minimum Plutus Version</small> | <small>1</small>
/// --- | ---
///
/// Trace the provided message, and continue with the continuation.
pub fn debug(message: String, continuation: a) -> a {
/// Calculate the blake2b-256 hash digest value of a given bytearray. Output is always 32-byte long.
pub fn blake2b_256(preimage: ByteArray) -> ByteArray {
fail
}

/// <small>Minimum Plutus Version</small> | <small>1</small>
/// <small>Minimum Plutus Version</small> | <small>3</small>
/// --- | ---
///
/// Get the first element of a pair.
pub fn fst_pair(pair: Pair<a, b>) -> a {
/// Calculate the blake2b-224 hash digest value of a given bytearray. Output is always 28-byte long.
pub fn blake2b_224(preimage: ByteArray) -> ByteArray {
fail
}

/// <small>Minimum Plutus Version</small> | <small>1</small>
/// --- | ---
///
/// Get the second element of a pair.
pub fn snd_pair(pair: Pair<a, b>) -> b {
/// Calculate the SHA2-256 hash digest value of a given bytearray. Output is always 32-byte long.
pub fn sha2_256(preimage: ByteArray) -> ByteArray {
fail
}

/// <small>Minimum Plutus Version</small> | <small>1</small>
/// --- | ---
///
/// Select a branch to continue with depending on whether the list is empty or not.
pub fn choose_list(list: List<a>, when_empty: b, when_non_empty: b) -> b {
/// Calculate the SHA3-256 hash digest value of a given bytearray. Output is always 32-byte long.
pub fn sha3_256(preimage: ByteArray) -> ByteArray {
fail
}

// ### ECDSA

/// <small>Minimum Plutus Version</small> | <small>1</small>
/// --- | ---
///
/// Push an element in front of a list.
pub fn cons_list(elem: a, list: List<a>) -> List<a> {
/// Verify an Ed25519 signature from a associated verification key.
pub fn verify_ed25519_signature(
verification_key: ByteArray,
message: ByteArray,
signature: ByteArray,
) -> ByteArray {
fail
}

/// <small>Minimum Plutus Version</small> | <small>2</small>
/// --- | ---
///
/// Verify an ECDSA-SECP256k1 signature from a associated verification key.
pub fn verify_ecdsa_secp256k1_signature(
verification_key: ByteArray,
message: ByteArray,
signature: ByteArray,
) -> ByteArray {
fail
}

/// <small>Minimum Plutus Version</small> | <small>2</small>
/// --- | ---
///
/// Verify a SCHNORR-SECP256k1 signature from a associated verification key.
pub fn verify_schnorr_secp256k1_signature(
verification_key: ByteArray,
message: ByteArray,
signature: ByteArray,
) -> ByteArray {
fail
}

// ### Pairing

/// <small>Minimum Plutus Version</small> | <small>3</small>
/// --- | ---
pub fn bls12_381_g1_add(a: G1Element, b: G1Element) -> G1Element {
Expand Down Expand Up @@ -574,37 +613,28 @@ pub fn bls12_381_final_verify(a: MillerLoopResult, b: MillerLoopResult) -> Bool
fail
}

/// <small>Minimum Plutus Version</small> | <small>3</small>
// ## Miscellaneous

/// <small>Minimum Plutus Version</small> | <small>1</small>
/// --- | ---
///
/// Convert a [ByteArray](../aiken.html#ByteArray) to an integer value. The first argument
/// specifies the endianness:
///
/// boolean value | endianness
/// ---- | ----
/// True | Big endian
/// False | Little endian
pub fn bytearray_to_integer(endianness: Bool, bytes: ByteArray) -> Int {
/// Continue with the continuation when the given term is Void.
pub fn choose_void(void: Void, when_void: a) -> a {
fail
}

/// <small>Minimum Plutus Version</small> | <small>3</small>
/// <small>Minimum Plutus Version</small> | <small>1</small>
/// --- | ---
///
/// Convert an integer value into a [ByteArray](../aiken.html#ByteArray).
///
/// - The first arguments / specifies the endianness:
///
/// boolean value | endianness
/// ---- | ----
/// True | Big endian
/// False | Little endian
/// Trace the provided message, and continue with the continuation.
pub fn debug(message: String, continuation: a) -> a {
fail
}

/// <small>Minimum Plutus Version</small> | <small>1</small>
/// --- | ---
///
/// - The second argument indicates the target `size` (in bytes) of the final [ByteArray](../aiken.html#ByteArray). This allows to allocate a specific number of bytes in advance. The function fails if the given value cannot fit in the requested size or if the `value` is negative. However, a size of 0 will yield a [ByteArray](../aiken.html#ByteArray) that is precisely as large as necessary to fit the `value`.
pub fn integer_to_bytearray(
endianness: Bool,
size: Int,
value: Int,
) -> ByteArray {
/// Return first computation when the condition is true, and the second otherwise.
pub fn if_then_else(condition: Bool, when_true: a, when_false: a) -> a {
fail
}

0 comments on commit e658c8a

Please sign in to comment.