From 65c2eb2f6ad408c10d043c57093b321776586d66 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Thu, 11 Jan 2024 18:20:32 +0100 Subject: [PATCH 1/5] doc: link to list of public RPC nodes --- docs/introduction/howtouse.rst | 7 ++++++- docs/user/client-configuration.rst | 2 +- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/introduction/howtouse.rst b/docs/introduction/howtouse.rst index 7d8c77dd2fd3..23126a8f72c0 100644 --- a/docs/introduction/howtouse.rst +++ b/docs/introduction/howtouse.rst @@ -252,7 +252,12 @@ Client Octez client can be used to interact with the node, it can query its status or ask the node to perform some actions. -For example, after starting your node you can check if it has finished + +.. note:: + + The rest of this page assumes that you have launched a local node, as explained in the previous section. But it is useful to know that the client can be configured to interact with a public node instead, either using :doc:`the configuration file <../user/client-configuration>` or by supplying option ``-E `` with `a public RPC node `__. + +After starting your local node you can check if it has finished synchronizing (see :doc:`../shell/sync`) using:: octez-client bootstrapped diff --git a/docs/user/client-configuration.rst b/docs/user/client-configuration.rst index 1e760b8e122f..07b8dcb6d538 100644 --- a/docs/user/client-configuration.rst +++ b/docs/user/client-configuration.rst @@ -10,7 +10,7 @@ can be customized by supplying **options** on the command line when running the A subset of these aspects can be customized by specifying parameters in a **configuration file** for the client. These include, for example: -- the address and port of a Tezos node to connect to, as an RPC endpoint (by default, the local node) +- the address and port of a Tezos node to connect to, as an RPC endpoint (by default, the local node; but it can be another node, see `a list of public RPC nodes `__) - the directory where the client stores data - the number of confirmation blocks needed before an operation is considered included - the files defining bootstrap accounts and protocol constants, when running in :doc:`mockup mode <./mockup>`. -- GitLab From 17acd4787e55c7409fc827e401ffb7e8e79c56a3 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Fri, 19 Jan 2024 13:48:49 +0100 Subject: [PATCH 2/5] doc: print location before Odoc errors --- docs/Makefile | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/Makefile b/docs/Makefile index c832cf3fbaa5..276528ebf7b9 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -78,7 +78,7 @@ manuals: \ .PHONY: odoc odoc: cd $$(pwd)/.. ; dune build @doc >docs/odoc.log 2>&1; \ - RESULT=$$?; (grep '^Error:' docs/odoc.log || true); exit $$RESULT + RESULT=$$?; (grep -B1 '^Error:' docs/odoc.log || true); exit $$RESULT @rm -rf $$(pwd)/_build/api/odoc @mkdir -p $$(pwd)/_build/api @cp -r $$(pwd)/../_build/default/_doc $$(pwd)/_build/api/odoc @@ -93,7 +93,7 @@ odoc-lite: @echo "Running odoc in $(TMPDOCDIR), with build directory $(TOPBUILDDIR_ABS) and outputs in $(TMPDOCDIR)/odoc.log" ODOC_WARN_ERROR=true dune build @doc --build-dir=$(TOPBUILDDIR_ABS) --root=$(TMPDOCDIR) >$(TMPDOCDIR)/odoc.log 2>&1; \ RESULT=$$?; \ - (grep '^Error:' $(TMPDOCDIR)/odoc.log || true) ; \ + (grep -B1 '^Error:' $(TMPDOCDIR)/odoc.log || true) ; \ exit $$RESULT rm -rf $(CURDIR)/_build/api/odoc mkdir -p $(CURDIR)/_build/api -- GitLab From ab6c959183cefea73a212d14ee538b621de7e56a Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Tue, 23 Jan 2024 15:37:50 +0100 Subject: [PATCH 3/5] doc: link to Octez package registry for static binaries --- docs/introduction/howtoget.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/introduction/howtoget.rst b/docs/introduction/howtoget.rst index 4defef21d088..1483fed2f1ad 100644 --- a/docs/introduction/howtoget.rst +++ b/docs/introduction/howtoget.rst @@ -50,8 +50,8 @@ However, if you encounter problems when performing one of the installation scena Getting static binaries ----------------------- -You can get static Linux binaries from the -`latest release in the tezos-packaging repository `__. +You can get static Linux binaries of the latest release from the +`Octez package registry `__. This repository provides static binaries for x86_64 and arm64 architectures. Since these binaries are static, they can be used on any Linux distribution without any additional prerequisites. -- GitLab From e9a4db76b76d8ddc4d7a745032bbda3d18e7b976 Mon Sep 17 00:00:00 2001 From: Anastasia Courtney Date: Mon, 29 Jan 2024 13:26:05 +0000 Subject: [PATCH 4/5] alpha/protocol: typo fixes and unfinished comments - Fixed "does not exist(s)" in multiple comments - Finished unfinished comments regarding add_or_remove functions in storage signatures --- .../lib_client/michelson_v1_entrypoints.mli | 4 +- .../lib_delegate/baking_simulator.ml | 2 +- src/proto_alpha/lib_protocol/storage_sigs.ml | 44 +++++++++---------- 3 files changed, 25 insertions(+), 25 deletions(-) diff --git a/src/proto_alpha/lib_client/michelson_v1_entrypoints.mli b/src/proto_alpha/lib_client/michelson_v1_entrypoints.mli index 230b8edc998b..9c59d1dd72c3 100644 --- a/src/proto_alpha/lib_client/michelson_v1_entrypoints.mli +++ b/src/proto_alpha/lib_client/michelson_v1_entrypoints.mli @@ -25,7 +25,7 @@ open Protocol -(** Returns [Some type] if the contract has an entrypoint of type [type]. None if it does not exists. *) +(** Returns [Some type] if the contract has an entrypoint of type [type]. None if it does not exist. *) val script_entrypoint_type : #Protocol_client_context.rpc_context -> chain:Chain_services.chain -> @@ -34,7 +34,7 @@ val script_entrypoint_type : entrypoint:Alpha_context.Entrypoint.t -> Alpha_context.Script.expr option tzresult Lwt.t -(** Returns [Some type] if the script has an entrypoint of type [type]. None if it does not exists. *) +(** Returns [Some type] if the script has an entrypoint of type [type]. None if it does not exist. *) val contract_entrypoint_type : #Protocol_client_context.rpc_context -> chain:Chain_services.chain -> diff --git a/src/proto_alpha/lib_delegate/baking_simulator.ml b/src/proto_alpha/lib_delegate/baking_simulator.ml index 7fe5c0fab8e9..2ad8e1c0a85b 100644 --- a/src/proto_alpha/lib_delegate/baking_simulator.ml +++ b/src/proto_alpha/lib_delegate/baking_simulator.ml @@ -36,7 +36,7 @@ let () = `Permanent ~id:"Client_baking_simulator.failed_to_checkout_context" ~title:"Failed to checkout context" - ~description:"The given context hash does not exists in the context." + ~description:"The given context hash does not exist in the context." ~pp:(fun ppf () -> Format.fprintf ppf "Failed to checkout the context") Data_encoding.unit (function Failed_to_checkout_context -> Some () | _ -> None) diff --git a/src/proto_alpha/lib_protocol/storage_sigs.ml b/src/proto_alpha/lib_protocol/storage_sigs.ml index 162f7953df1a..48cbc76adbc4 100644 --- a/src/proto_alpha/lib_protocol/storage_sigs.ml +++ b/src/proto_alpha/lib_protocol/storage_sigs.ml @@ -55,7 +55,7 @@ module type Single_data_storage = sig val init : context -> value -> Raw_context.t tzresult Lwt.t (** Updates the content of the bucket ; returns a {!Storage_Error - Missing_key} if the value does not exists *) + Missing_key} if the value does not exist *) val update : context -> value -> Raw_context.t tzresult Lwt.t (** Allocates the data and initializes it with a value ; just @@ -64,16 +64,16 @@ module type Single_data_storage = sig (** 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. *) + value is [None], deletes the storage bucket ; does + nothing if the bucket does not exist. *) val add_or_remove : context -> value option -> Raw_context.t Lwt.t (** Delete the storage bucket ; returns a {!Storage_error - Missing_key} if the bucket does not exists *) + Missing_key} if the bucket does not exist *) val remove_existing : context -> Raw_context.t tzresult Lwt.t (** Removes the storage bucket and its contents ; does nothing if - the bucket does not exists *) + the bucket does not exist *) val remove : context -> Raw_context.t Lwt.t end @@ -104,7 +104,7 @@ module type Non_iterable_indexed_data_storage = sig val find : context -> key -> value option tzresult Lwt.t (** Updates the content of a bucket ; returns A {!Storage_Error - Missing_key} if the value does not exists. *) + Missing_key} if the value does not exist. *) val update : context -> key -> value -> Raw_context.t tzresult Lwt.t (** Allocates a storage bucket at the given key and initializes it ; @@ -117,16 +117,16 @@ module type Non_iterable_indexed_data_storage = sig (** 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. *) + value is [None], deletes the storage bucket ; does + nothing if the bucket does not exist. *) val add_or_remove : context -> key -> value option -> Raw_context.t Lwt.t (** Delete a storage bucket and its contents ; returns a - {!Storage_error Missing_key} if the bucket does not exists. *) + {!Storage_error Missing_key} if the bucket does not exist. *) val remove_existing : context -> key -> Raw_context.t tzresult Lwt.t (** Removes a storage bucket and its contents ; does nothing if the - bucket does not exists. *) + bucket does not exist. *) val remove : context -> key -> Raw_context.t Lwt.t end @@ -161,7 +161,7 @@ module type Non_iterable_indexed_carbonated_data_storage = sig val find : context -> key -> (Raw_context.t * value option) tzresult Lwt.t (** Updates the content of a bucket ; returns A {!Storage_Error - Missing_key} if the value does not exists. + Missing_key} if the value does not exist. Consumes serialization cost. Consumes [Gas_repr.write_bytes_cost ]. Returns the difference from the old to the new size. *) @@ -185,8 +185,8 @@ module type Non_iterable_indexed_carbonated_data_storage = sig (** 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. + value is [None], deletes the storage bucket ; does + nothing if the bucket does not exist 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 @@ -198,13 +198,13 @@ module type Non_iterable_indexed_carbonated_data_storage = sig (Raw_context.t * int * bool) tzresult Lwt.t (** Delete a storage bucket and its contents ; returns a - {!Storage_error Missing_key} if the bucket does not exists. + {!Storage_error Missing_key} if the bucket does not exist. Consumes [Gas_repr.write_bytes_cost Z.zero]. Returns the freed size. *) val remove_existing : context -> key -> (Raw_context.t * int) tzresult Lwt.t (** Removes a storage bucket and its contents ; does nothing if the - bucket does not exists. + bucket does not exist. 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. *) @@ -322,12 +322,12 @@ module type Indexed_data_storage_with_local_context = sig (** 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], deletes the storage bucket; it does - nothing if the bucket does not exists. *) + value is [None], deletes the storage bucket ; it does + nothing if the bucket does not exist. *) val add_or_remove : context -> value option -> context Lwt.t (** Delete the storage bucket ; returns a {!Storage_error - Missing_key} if the bucket does not exists *) + Missing_key} if the bucket does not exist *) val remove_existing : context -> context tzresult Lwt.t (** Removes the storage bucket and its contents; does nothing if @@ -375,13 +375,13 @@ module type Data_set_storage = sig (** The type of elements. *) type elt - (** Tells if a elt is a member of the set *) + (** Tells if an elt is a member of the set *) val mem : context -> elt -> bool Lwt.t - (** Adds a elt is a member of the set *) + (** Adds an elt as a member of the set *) val add : context -> elt -> Raw_context.t Lwt.t - (** Removes a elt of the set ; does nothing if not a member *) + (** Removes an elt from the set ; does nothing if not a member *) val remove : context -> elt -> Raw_context.t Lwt.t (** Returns the elements of the set, deserialized in a list in no @@ -419,7 +419,7 @@ module type Carbonated_data_set_storage = sig (** Adds an elt as a member of the set. Consumes [Gas_repr.write_bytes_cost ]. - Returns the the new size. *) + Returns the new size. *) val init : context -> elt -> (Raw_context.t * int) tzresult Lwt.t (** Adds an elt as a member of the set. -- GitLab From 87ae8d1572b18a7fcacd0ab36e57d84933e1a3c5 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Mon, 29 Jan 2024 17:13:11 +0100 Subject: [PATCH 5/5] doc: fix link to shell openAPI --- docs/api/openapi.rst | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/api/openapi.rst b/docs/api/openapi.rst index 7b9ef9555f4a..0018aa806351 100644 --- a/docs/api/openapi.rst +++ b/docs/api/openapi.rst @@ -51,9 +51,7 @@ Shell RPCs The node provides some RPCs which are independent of the protocol. Their OpenAPI specification can be found at: -- `rpc-openapi.json (version 18.1) `_ - -- `rpc-openapi-rc.json (version 19.0~rc1) `_ +- `rpc-openapi.json (version 19) `_ .. TODO tezos/tezos#2170: add/remove section(s) -- GitLab