From 6017718c877141536779b44cf399fa2823919c98 Mon Sep 17 00:00:00 2001 From: Nicolas Ayache Date: Wed, 20 Apr 2022 09:53:03 +0200 Subject: [PATCH 1/3] Proto: docstring for Bootstrap_storage. --- src/proto_alpha/lib_protocol/bootstrap_storage.mli | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/proto_alpha/lib_protocol/bootstrap_storage.mli b/src/proto_alpha/lib_protocol/bootstrap_storage.mli index 3b72ec8ca940..91cfc6967c61 100644 --- a/src/proto_alpha/lib_protocol/bootstrap_storage.mli +++ b/src/proto_alpha/lib_protocol/bootstrap_storage.mli @@ -2,6 +2,7 @@ (* *) (* Open Source License *) (* Copyright (c) 2018 Dynamic Ledger Solutions, Inc. *) +(* Copyright (c) 2022 Nomadic Labs *) (* *) (* Permission is hereby granted, free of charge, to any person obtaining a *) (* copy of this software and associated documentation files (the "Software"),*) @@ -23,6 +24,10 @@ (* *) (*****************************************************************************) +(** This module provides functions that can be used in a private network to + delay initial rewarding, typically when waiting for more bakers to join the + network. *) + val init : Raw_context.t -> typecheck: -- GitLab From 294ee3bd7a97a8f7ab5e27134706e8163ce8c74e Mon Sep 17 00:00:00 2001 From: Nicolas Ayache Date: Wed, 20 Apr 2022 10:07:53 +0200 Subject: [PATCH 2/3] Proto: docstring for Delegate_activation_storage. --- .../lib_protocol/delegate_activation_storage.mli | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/src/proto_alpha/lib_protocol/delegate_activation_storage.mli b/src/proto_alpha/lib_protocol/delegate_activation_storage.mli index 28f43fcf597a..9f5f0e47969a 100644 --- a/src/proto_alpha/lib_protocol/delegate_activation_storage.mli +++ b/src/proto_alpha/lib_protocol/delegate_activation_storage.mli @@ -23,6 +23,13 @@ (* *) (*****************************************************************************) +(** This module provides functions related to delegates' activity. + + Typically, they can be used to deactivate a delegate that has not shown + activity for a certain number of cycles, and to reactivate it when + appropriate. +*) + val is_inactive : Raw_context.t -> Signature.Public_key_hash.t -> bool tzresult Lwt.t -- GitLab From fc9cdf61ec84e96fa2eadf5a4b6299296b13cefe Mon Sep 17 00:00:00 2001 From: Nicolas Ayache Date: Wed, 20 Apr 2022 11:15:12 +0200 Subject: [PATCH 3/3] Proto: docstring for Commitment_repr. --- src/proto_alpha/lib_protocol/commitment_repr.mli | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/proto_alpha/lib_protocol/commitment_repr.mli b/src/proto_alpha/lib_protocol/commitment_repr.mli index edca4134d844..e9a5d5db3103 100644 --- a/src/proto_alpha/lib_protocol/commitment_repr.mli +++ b/src/proto_alpha/lib_protocol/commitment_repr.mli @@ -2,6 +2,7 @@ (* *) (* Open Source License *) (* Copyright (c) 2018 Dynamic Ledger Solutions, Inc. *) +(* Copyright (c) 2022 Nomadic Labs *) (* *) (* Permission is hereby granted, free of charge, to any person obtaining a *) (* copy of this software and associated documentation files (the "Software"),*) @@ -23,6 +24,8 @@ (* *) (*****************************************************************************) +(** This type represents a commitment to an amount of tokens which can be claimed + by a fund raiser after the blockchain is deployed. *) type t = { blinded_public_key_hash : Blinded_public_key_hash.t; amount : Tez_repr.t; -- GitLab