package octez-protocol-alpha-libs

  1. Overview
  2. Docs
Octez protocol alpha libraries

Install

Dune Dependency

Authors

Maintainers

Sources

octez-19.0.tar.gz
sha256=c6df840ebbf115e454db949028c595bec558a59a66cade73b52a6d099d6fa4d4
sha512=d8aee903b9fe130d73176bc8ec38b78c9ff65317da3cb4f3415f09af0c625b4384e7498201fdb61aa39086a7d5d409d0ab3423f9bc3ab989a680cf444a79bc13

doc/octez-protocol-alpha-libs.test-helpers/Tezos_alpha_test_helpers/Contract_helpers/index.html

Module Tezos_alpha_test_helpers.Contract_helpersSource

Sourceval init : unit -> (Block.t * Tezos_raw_protocol_alpha__Alpha_context.public_key_hash * Tezos_protocol_alpha.Protocol.Alpha_context.Contract.t * Tezos_protocol_alpha.Protocol.Alpha_context.Contract.t, Tezos_base.TzPervasives.tztrace) result Lwt.t

Initializes 2 addresses to do only operations plus one that will be used to bake.

Sourceval read_file : string -> string

Return contents of a given file as string.

Sourceval load_script : storage:string -> string -> Tezos_protocol_alpha.Protocol.Alpha_context.Script.t

Loads a script from file.

Sourceval originate_contract_hash : string -> string -> Tezos_protocol_alpha.Protocol.Alpha_context.Contract.t -> Block.t -> Tezos_protocol_alpha.Protocol.Alpha_context.public_key_hash -> (Tezos_protocol_alpha.Protocol.Contract_hash.t * Block.t, Tezos_base.TzPervasives.tztrace) result Lwt.t

Returns a block in which the contract is originated.

Sourceval originate_contract : string -> string -> Tezos_protocol_alpha.Protocol.Alpha_context.Contract.t -> Block.t -> Tezos_protocol_alpha.Protocol.Alpha_context.public_key_hash -> (Tezos_protocol_alpha.Protocol.Alpha_context.Contract.t * Block.t, Tezos_base.TzPervasives.tztrace) result Lwt.t
Sourceval fake_KT1 : Tezos_protocol_alpha.Protocol.Contract_hash.t
Sourceval default_self : Tezos_protocol_alpha.Protocol.Contract_hash.t
Sourceval default_payer : Tezos_base.TzPervasives.Signature.Public_key_hash.t
Sourceval default_sender : Tezos_protocol_alpha.Protocol.Alpha_context.Contract.t
Sourceval default_step_constants : Tezos_protocol_alpha.Protocol.Script_interpreter.step_constants
Sourceval run_script : Tezos_raw_protocol_alpha.Alpha_context.t -> ?logger:Tezos_raw_protocol_alpha.Script_typed_ir.logger -> ?step_constants: Tezos_protocol_alpha.Protocol.Script_interpreter.step_constants -> ?internal:bool -> string -> ?entrypoint:Tezos_protocol_alpha.Protocol.Alpha_context.Entrypoint.t -> storage:string -> parameter:string -> unit -> (Tezos_protocol_alpha.Protocol.Script_interpreter.execution_result * Tezos_raw_protocol_alpha.Alpha_context.context) Tezos_base.TzPervasives.tzresult Lwt.t

Helper function that parses and typechecks a script, its initial storage and parameters from strings. It then executes the typed script with the storage and parameters and returns the result.

The step_constants argument passes in some data which remains constant throughout script's execution, hence the name. This includes addresses of the sender and payer, the address of the smart contract, the amount of Tez transferred to it and so on.

An internal operation is an operation generated by smart contract's execution rather than by an implicit account.

Sourceval originate_contract_from_string_hash : script:string -> storage:string -> source_contract:Tezos_protocol_alpha.Protocol.Alpha_context.Contract.t -> baker:Tezos_protocol_alpha.Protocol.Alpha_context.public_key_hash -> Block.t -> (Tezos_protocol_alpha.Protocol.Contract_hash.t * Tezos_protocol_alpha.Protocol.Alpha_context.Script.t * Block.t, Tezos_base.TzPervasives.tztrace) result Lwt.t
Sourceval originate_contract_from_string : script:string -> storage:string -> source_contract:Tezos_protocol_alpha.Protocol.Alpha_context.Contract.t -> baker:Tezos_protocol_alpha.Protocol.Alpha_context.public_key_hash -> Block.t -> (Tezos_protocol_alpha.Protocol.Alpha_context.Contract.t * Tezos_protocol_alpha.Protocol.Alpha_context.Script.t * Block.t, Tezos_base.TzPervasives.tztrace) result Lwt.t
OCaml

Innovation. Community. Security.