Module Mina_base.Fee_excess

Fee excesses associated with transactions or transitions.

These are represented as a 'left' and 'right' excess, which describe the unresolved fee excesses in the fee tokens of the first (or leftmost) and last (or rightmost) transactions in the transition.

Assumptions: * Transactions are grouped by their fee token. * The 'fee transfer' transaction to dispense those fees is part of this group. * The fee excess for each token is 0 across the group. * No transactions with fees paid in another token are executed while the previous fee token's excess is non-zero.

By maintaining these assumptions, we can ensure that the un-settled fee excesses can be represented by excesses in (at most) 2 tokens. Consider, for example, any consecutive subsequence of the transactions

..txn@2ft@2txn@3txn@3ft@3txn@4ft@4txn@5txn@5ft@5txn@6ft@6..

where txn@i and ft@i are transactions and fee transfers respectively paid in token i. The only groups which may have non-zero fee excesses are those which contain the start and end of the subsequence.

The code below also defines a canonical representation where fewer than 2 tokens have non-zero excesses. See rebalance below for details and the implementation.

module Poly : sig ... end
module Stable : sig ... end
val to_yojson : t -> Yojson.Safe.t
val of_yojson : Yojson.Safe.t -> t Ppx_deriving_yojson_runtime.error_or
val _ : Yojson.Safe.t -> t Ppx_deriving_yojson_runtime.error_or
val compare : t -> t -> int
val equal : t -> t -> bool
val hash_fold_t : Ppx_hash_lib.Std.Hash.state -> t -> Ppx_hash_lib.Std.Hash.state
val hash : t -> Ppx_hash_lib.Std.Hash.hash_value
val t_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> t
val sexp_of_t : t -> Ppx_sexp_conv_lib.Sexp.t
type ('token, 'fee) poly = ( 'token, 'fee ) Poly.t = {
fee_token_l : 'token;
fee_excess_l : 'fee;
fee_token_r : 'token;
fee_excess_r : 'fee;
}
val compare_poly : 'token 'fee. ( 'token -> 'token -> int ) -> ( 'fee -> 'fee -> int ) -> ( 'token, 'fee ) poly -> ( 'token, 'fee ) poly -> int
val equal_poly : 'token 'fee. ( 'token -> 'token -> bool ) -> ( 'fee -> 'fee -> bool ) -> ( 'token, 'fee ) poly -> ( 'token, 'fee ) poly -> bool
val hash_fold_poly : 'token 'fee. ( Ppx_hash_lib.Std.Hash.state -> 'token -> Ppx_hash_lib.Std.Hash.state ) -> ( Ppx_hash_lib.Std.Hash.state -> 'fee -> Ppx_hash_lib.Std.Hash.state ) -> Ppx_hash_lib.Std.Hash.state -> ( 'token, 'fee ) poly -> Ppx_hash_lib.Std.Hash.state
val poly_of_sexp : 'token 'fee. ( Ppx_sexp_conv_lib.Sexp.t -> 'token ) -> ( Ppx_sexp_conv_lib.Sexp.t -> 'fee ) -> Ppx_sexp_conv_lib.Sexp.t -> ( 'token, 'fee ) poly
val sexp_of_poly : 'token 'fee. ( 'token -> Ppx_sexp_conv_lib.Sexp.t ) -> ( 'fee -> Ppx_sexp_conv_lib.Sexp.t ) -> ( 'token, 'fee ) poly -> Ppx_sexp_conv_lib.Sexp.t
val poly_to_yojson : ( 'a -> 'b ) -> ( 'c -> 'b ) -> ( 'a, 'c ) Poly.Stable.Latest.t -> [> `List of [> `Assoc of (string * 'b) list ] list ]
val poly_of_yojson : ( 'a -> ( 'b, string ) Core_kernel__Result.t ) -> ( 'a -> ( 'c, string ) Core_kernel__Result.t ) -> [> `List of [> `Assoc of (string * 'a) list ] list ] -> ( ( 'b, 'c ) Poly.Stable.Latest.t, string ) Core_kernel__Result.t
val var_of_t : t -> var
val assert_equal_checked : var -> var -> unit Snark_params.Tick.Checked.t

Eliminate a fee excess, either by combining it with one to the left/right, or by checking that it is zero.

val rebalance : t -> ( Account_id.Digest.t, Currency.Fee.Signed.t ) poly Base__Or_error.t

Combine the fee excesses from two transitions.

val gen : ( Account_id.Digest.t, Currency.Fee.Signed.t ) poly Core_kernel__Quickcheck.Generator.t