Module 1-Inputs.Ledger

type key
type token_id
type token_id_set
type index = int
type t

no deriving, purposely; signatures that include this one may add deriving

module Addr = Location.Addr
module Path : Merkle_path.S with type hash := Hash.t
module Location = Location
include Syncable_intf.S with type root_hash := Hash.t and type hash := Hash.t and type account := Account.t and type addr := Addr.t and type path = Path.t and type t := t
include Ppx_sexp_conv_lib.Sexpable.S with type t := t
val t_of_sexp : Sexplib0__.Sexp.t -> t
val sexp_of_t : t -> Sexplib0__.Sexp.t
type path = Path.t
val depth : t -> int
val num_accounts : t -> int
val merkle_path_at_addr_exn : t -> Addr.t -> path
val get_inner_hash_at_addr_exn : t -> Addr.t -> Hash.t
val set_inner_hash_at_addr_exn : t -> Addr.t -> Hash.t -> unit
val set_all_accounts_rooted_at_exn : t -> Addr.t -> Account.t list -> unit
val set_batch_accounts : t -> (Addr.t * Account.t) list -> unit
val get_all_accounts_rooted_at_exn : t -> Addr.t -> (Addr.t * Account.t) list

Get all of the accounts that are in a subtree of the underlying Merkle tree rooted at `address`. The accounts are ordered by their addresses.

val make_space_for : t -> int -> unit
val to_list : t -> Account.t list

list of accounts in the ledger

val iteri : t -> f:( index -> Account.t -> unit ) -> unit

iterate over all indexes and accounts

val foldi : t -> init:'accum -> f:( Addr.t -> 'accum -> Account.t -> 'accum ) -> 'accum

fold over accounts in the ledger, passing the Merkle address

val foldi_with_ignored_accounts : t -> Account_id.Set.t -> init:'accum -> f:( Addr.t -> 'accum -> Account.t -> 'accum ) -> 'accum

the set of account_ids are ledger elements to skip during the fold, because they're in a mask

val fold_until : t -> init:'accum -> f:( 'accum -> Account.t -> ( 'accum, 'stop ) Base.Continue_or_stop.t ) -> finish:( 'accum -> 'stop ) -> 'stop

fold over accounts until stop condition reached when calling f; calls finish for result

val accounts : t -> Account_id.Set.t

set of account ids associated with accounts

val token_owner : t -> token_id -> Account_id.t option

Get the account id that owns a token.

val token_owners : t -> Account_id.Set.t

Get the set of all accounts which own a token.

val tokens : t -> key -> token_id_set

Get all of the tokens for which a public key has accounts.

val location_of_account : t -> Account_id.t -> Location.t option
val location_of_account_batch : t -> Account_id.t list -> (Account_id.t * Location.t option) list
val get_or_create_account : t -> Account_id.t -> Account.t -> ([ `Added | `Existed ] * Location.t) Core.Or_error.t

This may return an error if the ledger is full.

val close : t -> unit

the ledger should not be used after calling close

val last_filled : t -> Location.t option

for account locations in the ledger, the last (rightmost) filled location

val get_uuid : t -> Uuid.t
val get_directory : t -> string option

return Some directory for ledgers that use a file system, else None

val get : t -> Location.t -> Account.t option
val get_batch : t -> Location.t list -> (Location.t * Account.t option) list
val set : t -> Location.t -> Account.t -> unit
val set_batch : t -> (Location.t * Account.t) list -> unit
val get_at_index_exn : t -> int -> Account.t
val set_at_index_exn : t -> int -> Account.t -> unit
val index_of_account_exn : t -> Account_id.t -> int
val merkle_root : t -> Hash.t

meant to be a fast operation: the root hash is stored, rather than calculated dynamically

val merkle_path : t -> Location.t -> Path.t
val merkle_path_at_index_exn : t -> int -> Path.t
val remove_accounts_exn : t -> Account_id.t list -> unit
val detached_signal : t -> unit Async_kernel.Deferred.t

Triggers when the ledger has been detached and should no longer be accessed.