package tezos-protocol-alpha

  1. Overview
  2. Docs
package tezos-protocol-alpha
Legend:
Library
Module
Module type
Parameter
Class
Class type

This module defines identifiers for two basic types of contracts. It also specifies how to compute originated contract's hash from origination nonce.

A contract is simply an account on the blockchain ledger. There are two types of contracts:

  • implicit contracts represent accounts of users of the blockchain;
  • originated are special accounts with a Michelson script attached to them. Every time a transaction is sent to an originated account, its associated script is run in order to trigger some action in response.

An implicit account is identified by the hash of the public key which was used to create it. The owner of the corresponding private key is the holder of the account. An originated contract's hash is derived from its origination nonce (see below).

include Tezos_protocol_environment_alpha.Compare.S with type t := t
val (=) : t -> t -> bool
val (<>) : t -> t -> bool
val (<) : t -> t -> bool
val (<=) : t -> t -> bool
val (>=) : t -> t -> bool
val (>) : t -> t -> bool
val compare : t -> t -> int
val equal : t -> t -> bool
val max : t -> t -> t
val min : t -> t -> t
val in_memory_size : t -> Cache_memory_helpers.sint

Originated contracts

val originated_contract : Origination_nonce.t -> t

originated_contract nonce is the contract address originated from nonce.

val originated_contracts : since:Origination_nonce.t -> until:Origination_nonce.t -> Contract_hash.t list

originated_contracts ~since ~until is the contract addresses originated from since until until. The operation hash of nonce since and until must be the same or it will fail with an assert. since < until or the returned list is empty

Human readable notation

type Tezos_protocol_environment_alpha.Error_monad.error +=
  1. | Invalid_contract_notation of string
val to_b58check : t -> string

Serializers

implicit_encoding is an encoding for public key hashes compatible with the encoding of contracts in the specific case of implicit accounts.

originated_encoding is an encoding for contract hashes that is compatible with the encoding of contracts in the specific case of originated accounts.

val cases : ('a -> t option) -> (t -> 'a) -> 'a Tezos_protocol_environment_alpha.Data_encoding.case list

cases f g exports the Data_encoding.cases used to define encoding.

The only reason why we export that is to let Destination_repr.encoding use it. This allows the latter to be compatible with encoding, which is of key importance for backward compatibility reasons.

module Index : Storage_description.INDEX with type t = t
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct