cocktail

Vodka cocktail provides utility functions to build Aiken onchain code

All onchain utility functions are grouped with a naming convention of vodka_<type>, and all can be imported directly with use cocktail

Cardano data types

Address - use vodka_address
Value - use vodka_value

Transaction types

extra_signatories - Documentation
inputs - Documentation
outputs - Documentation
mints - Documentation
validity_range - Documentation
Redeemers - Documentation

Constants

address_payment_key: fn(Address) -> ByteArray

Documentation please refer to vodka_address

address_pub_key: fn(Address) -> Option<VerificationKeyHash>

Documentation please refer to vodka_address

address_script_hash: fn(Address) -> Option<ScriptHash>

Documentation please refer to vodka_address

all_key_signed: fn(List<ByteArray>, List<ByteArray>) -> Bool

Documentation please refer to vodka_extra_signatories

check_policy_only_burn: fn(Value, PolicyId) -> Bool

Documentation please refer to vodka_mints

compare_address: fn(Address, Address) -> Ordering

Documentation please refer to vodka_address

compare_output_reference: fn(ScriptPurpose, ScriptPurpose) -> Ordering

Documentation please refer to vodka_redeemers

compare_script_address: fn(Address, Address) -> Ordering

Documentation please refer to vodka_address

convert_int_to_bytes: fn(Int) -> ByteArray

Documentation please refer to vodka_converter

delegate_stake_and_vote_certificate: fn(
  List<Certificate>,
  Credential,
  StakePoolId,
  DelegateRepresentative,
) -> Bool

Documentation please refer to vodka_certificate

delegate_stake_certificate: fn(List<Certificate>, Credential, StakePoolId) ->
  Bool

Documentation please refer to vodka_certificate

delegate_vote_certificate: fn(
  List<Certificate>,
  Credential,
  DelegateRepresentative,
) -> Bool

Documentation please refer to vodka_certificate

get_all_value_from: fn(List<Input>, Address) -> Value

Documentation please refer to vodka_value

get_all_value_to: fn(List<Output>, Address) -> Value

Documentation please refer to vodka_value

get_number_digit: fn(Int) -> Int

Documentation please refer to vodka_converter

group_inputs: fn(List<Input>, fn(Input) -> Bool) -> (List<Input>, List<Input>)

Documentation please refer to vodka_inputs

group_inputs_2: fn(List<Input>, fn(Input) -> Bool, fn(Input) -> Bool) ->
  (List<Input>, List<Input>, List<Input>)

Documentation please refer to vodka_inputs

group_outputs: fn(List<Output>, fn(Output) -> Bool) ->
  (List<Output>, List<Output>)

Documentation please refer to vodka_outputs

group_outputs_2: fn(List<Output>, fn(Output) -> Bool, fn(Output) -> Bool) ->
  (List<Output>, List<Output>, List<Output>)

Documentation please refer to vodka_outputs

i_at: fn(Address) -> fn(Input) -> Bool

Documentation please refer to vodka_inputs

i_at_with: fn(Address, PolicyId, AssetName) -> fn(Input) -> Bool

Documentation please refer to vodka_inputs

i_at_with_policy: fn(Address, PolicyId) -> fn(Input) -> Bool

Documentation please refer to vodka_inputs

i_with: fn(PolicyId, AssetName) -> fn(Input) -> Bool

Documentation please refer to vodka_inputs

i_with_policy: fn(PolicyId) -> fn(Input) -> Bool

Documentation please refer to vodka_inputs

input_inline_datum: fn(Input) -> Data

Documentation please refer to vodka_inputs

inputs_at: fn(List<Input>, Address) -> List<Input>

Documentation please refer to vodka_inputs

inputs_at_with: fn(List<Input>, Address, PolicyId, AssetName) -> List<Input>

Documentation please refer to vodka_inputs

inputs_at_with_policy: fn(List<Input>, Address, PolicyId) -> List<Input>

Documentation please refer to vodka_inputs

inputs_token_quantity: fn(List<Input>, (PolicyId, AssetName)) -> Int

Documentation please refer to vodka_inputs

inputs_value: fn(List<Input>) -> Value

Documentation please refer to vodka_value

inputs_with: fn(List<Input>, PolicyId, AssetName) -> List<Input>

Documentation please refer to vodka_inputs

inputs_with_policy: fn(List<Input>, PolicyId) -> List<Input>

Documentation please refer to vodka_inputs

key_signed: fn(List<ByteArray>, ByteArray) -> Bool

Documentation please refer to vodka_extra_signatories

o_at: fn(Address) -> fn(Output) -> Bool

Documentation please refer to vodka_outputs

o_at_with: fn(Address, PolicyId, AssetName) -> fn(Output) -> Bool

Documentation please refer to vodka_outputs

o_at_with_policy: fn(Address, PolicyId) -> fn(Output) -> Bool

Documentation please refer to vodka_outputs

o_with: fn(PolicyId, AssetName) -> fn(Output) -> Bool

Documentation please refer to vodka_outputs

o_with_policy: fn(PolicyId) -> fn(Output) -> Bool

Documentation please refer to vodka_outputs

one_of_keys_signed: fn(List<ByteArray>, List<ByteArray>) -> Bool

Documentation please refer to vodka_extra_signatories

only_input_datum_with: fn(List<Input>, PolicyId, AssetName) -> Data

Documentation please refer to vodka_inputs

only_minted_token: fn(Value, PolicyId, AssetName, Int) -> Bool

Documentation please refer to vodka_mints

output_inline_datum: fn(Output) -> Data

Documentation please refer to vodka_outputs

outputs_at: fn(List<Output>, Address) -> List<Output>

Documentation please refer to vodka_outputs

outputs_at_with: fn(List<Output>, Address, PolicyId, AssetName) -> List<Output>

Documentation please refer to vodka_outputs

outputs_at_with_policy: fn(List<Output>, Address, PolicyId) -> List<Output>

Documentation please refer to vodka_outputs

outputs_value: fn(List<Output>) -> Value

Documentation please refer to vodka_value

outputs_with: fn(List<Output>, PolicyId, AssetName) -> List<Output>

Documentation please refer to vodka_outputs

outputs_with_policy: fn(List<Output>, PolicyId) -> List<Output>

Documentation please refer to vodka_outputs

policy_only_minted_token: fn(Value, PolicyId, AssetName, Int) -> Bool

Documentation please refer to vodka_mints

redeemer_from: fn(
  Pairs<ScriptPurpose, Redeemer>,
  List<Input>,
  OutputReference,
  Address,
) -> Option<Redeemer>

Documentation please refer to vodka_redeemers

register_drep_certificate: fn(List<Certificate>, Credential, Lovelace) -> Bool

Documentation please refer to vodka_certificate

register_stake_certificate: fn(List<Certificate>, Credential) -> Bool

Documentation please refer to vodka_certificate

token_minted: fn(Value, PolicyId, AssetName, Int) -> Bool

Documentation please refer to vodka_mints

unregister_drep_certificate: fn(List<Certificate>, Credential, Lovelace) -> Bool

Documentation please refer to vodka_certificate

unregister_stake_certificate: fn(List<Certificate>, Credential) -> Bool

Documentation please refer to vodka_certificate

valid_after: fn(ValidityRange, Int) -> Bool

Documentation please refer to vodka_validity_range

valid_before: fn(ValidityRange, Int) -> Bool

Documentation please refer to vodka_validity_range

value_geq: fn(Value, Value) -> Bool

Documentation please refer to vodka_value

value_length: fn(Value) -> Int

Documentation please refer to vodka_value

value_policy_info: fn(Value, ByteArray) -> Option<(ByteArray, ByteArray, Int)>

Documentation please refer to vodka_value

value_tokens: fn(Value) -> List<(ByteArray, ByteArray, Int)>

Documentation please refer to vodka_value

verify_pub_keys: fn(List<VerificationKey>, List<VerificationKeyHash>) -> Bool

Documentation please refer to vodka_crypto

verify_signatures: fn(List<VerificationKey>, ByteArray, List<ByteArray>) -> Bool

Documentation please refer to vodka_crypto

withdrawal_redeemer: fn(Pairs<ScriptPurpose, Redeemer>, ByteArray) ->
  Option<Redeemer>

Documentation please refer to vodka_redeemers

withdrawal_script_validated: fn(Pairs<Credential, Lovelace>, ScriptHash) -> Bool

Documentation please refer to vodka_withdrawals

cocktail

Cardano data types

Transaction types

Constants

address_payment_key: fn(Address) -> ByteArray

address_pub_key: fn(Address) -> Option<VerificationKeyHash>

address_script_hash: fn(Address) -> Option<ScriptHash>

all_key_signed: fn(List<ByteArray>, List<ByteArray>) -> Bool

check_policy_only_burn: fn(Value, PolicyId) -> Bool

compare_address: fn(Address, Address) -> Ordering

compare_output_reference: fn(ScriptPurpose, ScriptPurpose) -> Ordering

compare_script_address: fn(Address, Address) -> Ordering

convert_int_to_bytes: fn(Int) -> ByteArray

delegate_stake_and_vote_certificate: fn( List<Certificate>, Credential, StakePoolId, DelegateRepresentative, ) -> Bool

delegate_stake_certificate: fn(List<Certificate>, Credential, StakePoolId) -> Bool

delegate_vote_certificate: fn( List<Certificate>, Credential, DelegateRepresentative, ) -> Bool

get_all_value_from: fn(List<Input>, Address) -> Value

get_all_value_to: fn(List<Output>, Address) -> Value

get_number_digit: fn(Int) -> Int

group_inputs: fn(List<Input>, fn(Input) -> Bool) -> (List<Input>, List<Input>)

group_inputs_2: fn(List<Input>, fn(Input) -> Bool, fn(Input) -> Bool) -> (List<Input>, List<Input>, List<Input>)

group_outputs: fn(List<Output>, fn(Output) -> Bool) -> (List<Output>, List<Output>)

group_outputs_2: fn(List<Output>, fn(Output) -> Bool, fn(Output) -> Bool) -> (List<Output>, List<Output>, List<Output>)

i_at: fn(Address) -> fn(Input) -> Bool

i_at_with: fn(Address, PolicyId, AssetName) -> fn(Input) -> Bool

i_at_with_policy: fn(Address, PolicyId) -> fn(Input) -> Bool

i_with: fn(PolicyId, AssetName) -> fn(Input) -> Bool

i_with_policy: fn(PolicyId) -> fn(Input) -> Bool

input_inline_datum: fn(Input) -> Data

inputs_at: fn(List<Input>, Address) -> List<Input>

inputs_at_with: fn(List<Input>, Address, PolicyId, AssetName) -> List<Input>

inputs_at_with_policy: fn(List<Input>, Address, PolicyId) -> List<Input>

inputs_token_quantity: fn(List<Input>, (PolicyId, AssetName)) -> Int

inputs_value: fn(List<Input>) -> Value

inputs_with: fn(List<Input>, PolicyId, AssetName) -> List<Input>

inputs_with_policy: fn(List<Input>, PolicyId) -> List<Input>

key_signed: fn(List<ByteArray>, ByteArray) -> Bool

o_at: fn(Address) -> fn(Output) -> Bool

o_at_with: fn(Address, PolicyId, AssetName) -> fn(Output) -> Bool

o_at_with_policy: fn(Address, PolicyId) -> fn(Output) -> Bool

o_with: fn(PolicyId, AssetName) -> fn(Output) -> Bool

o_with_policy: fn(PolicyId) -> fn(Output) -> Bool

one_of_keys_signed: fn(List<ByteArray>, List<ByteArray>) -> Bool

only_input_datum_with: fn(List<Input>, PolicyId, AssetName) -> Data

only_minted_token: fn(Value, PolicyId, AssetName, Int) -> Bool

output_inline_datum: fn(Output) -> Data

outputs_at: fn(List<Output>, Address) -> List<Output>

outputs_at_with: fn(List<Output>, Address, PolicyId, AssetName) -> List<Output>

outputs_at_with_policy: fn(List<Output>, Address, PolicyId) -> List<Output>

outputs_value: fn(List<Output>) -> Value

outputs_with: fn(List<Output>, PolicyId, AssetName) -> List<Output>

outputs_with_policy: fn(List<Output>, PolicyId) -> List<Output>

policy_only_minted_token: fn(Value, PolicyId, AssetName, Int) -> Bool

redeemer_from: fn( Pairs<ScriptPurpose, Redeemer>, List<Input>, OutputReference, Address, ) -> Option<Redeemer>

register_drep_certificate: fn(List<Certificate>, Credential, Lovelace) -> Bool

register_stake_certificate: fn(List<Certificate>, Credential) -> Bool

token_minted: fn(Value, PolicyId, AssetName, Int) -> Bool

unregister_drep_certificate: fn(List<Certificate>, Credential, Lovelace) -> Bool

unregister_stake_certificate: fn(List<Certificate>, Credential) -> Bool

valid_after: fn(ValidityRange, Int) -> Bool

valid_before: fn(ValidityRange, Int) -> Bool

value_geq: fn(Value, Value) -> Bool

value_length: fn(Value) -> Int

value_policy_info: fn(Value, ByteArray) -> Option<(ByteArray, ByteArray, Int)>

value_tokens: fn(Value) -> List<(ByteArray, ByteArray, Int)>

verify_pub_keys: fn(List<VerificationKey>, List<VerificationKeyHash>) -> Bool

verify_signatures: fn(List<VerificationKey>, ByteArray, List<ByteArray>) -> Bool

withdrawal_redeemer: fn(Pairs<ScriptPurpose, Redeemer>, ByteArray) -> Option<Redeemer>

withdrawal_script_validated: fn(Pairs<Credential, Lovelace>, ScriptHash) -> Bool