package tezos-protocol-alpha
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=43723d096307603703a1a89ed1b2eb202b365f5e7824b96b0cbf813b343a6cf7
sha512=b2a637f2e965000d3d49ad85277ca24d6cb07a1a7cf2bc69d296d8b03ad78c3eaa8e21e94b9162e62c2e11649cd03bc845b2a3dafe623b91065df69d47dc8e4f
doc/tezos-protocol-alpha.raw/Tezos_raw_protocol_alpha/Alpha_context/Big_map/index.html
Module Alpha_context.Big_mapSource
Big maps are a data structure storing key-value associations, just like regular maps, but here the whole content of the structure is not loaded in memory when interacting with it. They are thus suitable for a Michelson contract, for instance, when there are a lot of bindings, but only a few items are accessed at each contract call.
val fresh :
temporary:bool ->
context ->
(context * Id.t) Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.tCreate a fresh big map in the context.
val mem :
context ->
Id.t ->
Script_expr_hash.t ->
(context * bool) Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.tCarbonated membership of a key (from its hash) in a big map.
val get_opt :
context ->
Id.t ->
Script_expr_hash.t ->
(context * Script.expr option)
Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.tCarbonated retrieval of the value associated to a key (from its hash) in a big map, if any.
val exists :
context ->
Id.t ->
(context * (Script.expr * Script.expr) option)
Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.tCarbonated retrieval of the key and value types of the bindings in a big map referenced by its identifier, if this identifier is actually bound to a big map in the context.
val list_key_values :
?offset:int ->
?length:int ->
context ->
Id.t ->
(context * (Script_expr_hash.t * Script.expr) list)
Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.tlist_key_values ?offset ?length ctxt id lists the key hash and value for each entry in big map id. 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.
type update = {key : Script_repr.expr;(*The key is ignored by an update but is shown in the receipt.
*)key_hash : Script_expr_hash.t;value : Script_repr.expr option;
}The type of big map updates. When value = None, the potential binding associated to the key will be removed.
The types of keys and values in a big map.