package tezos-protocol-alpha

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

Like Make_indexed_data_storage, adding tracking of storage cost.

Parameters

module C : Raw_context.T
module I : INDEX

Signature

include Storage_sigs.Non_iterable_indexed_carbonated_data_storage with type t = C.t with type key = I.t with type value = V.t
type t = C.t
type context = t
type key = I.t

An abstract type for keys

type value = V.t

The type of values

Tells if a given key is already bound to a storage bucket. Consumes Gas_repr.read_bytes_cost Z.zero.

Retrieve a value from the storage bucket at a given key ; returns Storage_errorMissing_key if the key is not set ; returns Storage_errorCorrupted_data if the deserialisation fails. Consumes Gas_repr.read_bytes_cost <size of the value>.

Retrieve a value from the storage bucket at a given key ; returns None if the value is not set ; returns Storage_error Corrupted_data if the deserialisation fails. Consumes Gas_repr.read_bytes_cost <size of the value> if present or Gas_repr.read_bytes_cost Z.zero.

Updates the content of a bucket ; returns A Storage_Error Missing_key if the value does not exists. Consumes serialization cost. Consumes Gas_repr.write_bytes_cost <size of the new value>. Returns the difference from the old to the new size.

Allocates a storage bucket at the given key and initializes it ; returns a Storage_errorExisting_key if the bucket exists. Consumes serialization cost. Consumes Gas_repr.write_bytes_cost <size of the value>. Returns the size.

Allocates a storage bucket at the given key and initializes it with a value ; just updates it if the bucket exists. Consumes serialization cost. Consumes Gas_repr.write_bytes_cost <size of the new value>. Returns the difference from the old (maybe 0) to the new size, and a boolean indicating if a value was already associated to this key.

When the value is Some v, allocates the data and initializes it with v ; just updates it if the bucket exists. When the value is None, delete the storage bucket when the value ; does nothing if the bucket does not exists. Consumes serialization cost. Consumes the same gas cost as either remove or init_set. Returns the difference from the old (maybe 0) to the new size, and a boolean indicating if a value was already associated to this key.

Delete a storage bucket and its contents ; returns a Storage_errorMissing_key if the bucket does not exists. Consumes Gas_repr.write_bytes_cost Z.zero. Returns the freed size.

Removes a storage bucket and its contents ; does nothing if the bucket does not exists. Consumes Gas_repr.write_bytes_cost Z.zero. Returns the freed size, and a boolean indicating if a value was already associated to this key.

val keys_unaccounted : context -> key list Tezos_protocol_environment_alpha.Lwt.t

Returns the list of all storage bucket keys. Not carbonated (i.e. gas is not consumed); use with care.

list_key_values ?offset ?length storage lists the key and value pairs of each entry in the given storage. The first offset values are ignored (if passed). Negative offsets are treated as 0. There will be no more than length values in the result list (if passed). Negative values are treated as 0.

The returned context takes into account gas consumption of traversing the keys and loading values.

Returns true iff context is empty. Consumes Gas_repr.read_bytes_cost Z.zero.

clear storage removes all values from the storage. Consumes Gas_repr.write_bytes_cost Z.zero .

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