Updates Service Provider Guide #826

toschdev · 2021-04-21T09:53:51Z

Closes: #824

Description

/docs/gaia-tutorials/installation.md
/docs/gaia-tutorials/join-mainnet.md
/docs/resources/service-providers.md

For contributor use:

Targeted PR against correct branch (see CONTRIBUTING.md)
Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
Code follows the module structure standards.
Wrote unit and integration tests
Updated relevant documentation (docs/) or specification (x/<module>/spec/)
Added relevant godoc comments.
Added a relevant changelog entry to the Unreleased section in CHANGELOG.md
Re-reviewed Files changed in the Github PR explorer

For admin use:

Added appropriate labels to PR (ex. WIP, R4R, docs, etc)
Reviewers assigned
Squashed all commits, uses message "Merge pull request #XYZ: [title]" (coding standards)

…er docs

toschdev · 2021-04-21T11:08:59Z

docs/gaia-tutorials/join-mainnet.md

@@ -208,8 +245,4 @@ invariant broken:
 ```

 When submitting a invariant-broken transaction, transaction fee tokens are not
-deducted as the blockchain will halt (aka. this is a free transaction). 
-
-## Upgrade to Validator Node


The Full Node setup should be providing the setup how to create a Full Node.
Opening REST API, GRPC and remote access are all suggestions that are not for a validator node, which should have different security setups. Therefore upgrading an open Full Node to a Validator Node should not be emphasized in this setup.

alessio · 2021-04-26T11:27:08Z

Looks good to me!

zmanian · 2021-04-26T13:37:40Z

Some gaps I see here.

We should provide some guidance on enabling state sync. What should the settings be on both existing nodes and on full node?
It seems like we are recommending prune everything but generally default is the best setting for most people.
we are recommending polling the rest api for balance changes but the web socket and event system is workable but the query syntax confuses people and this is a good place to have an example query.

zmanian · 2021-04-26T13:38:14Z

Happy to merge this and improve it later with the above

toschdev · 2021-04-26T14:40:58Z

Thanks for the suggestions @zmanian
I am planning to add an own section for state sync but not in this PR

Good hint for the websocket, I will add an example. I agree, that merging now and adding more info later would be best right now, since I know a few parties waiting for these changes already.

barriebyron

tiny contributions for grammar, thank you for doing this work, I am always learning.

docs/gaia-tutorials/installation.md

docs/gaia-tutorials/join-mainnet.md

docs/gaia-tutorials/installation.md

docs/gaia-tutorials/join-mainnet.md

docs/resources/service-providers.md

Co-authored-by: Barrie Byron <barrie.byron@tendermint.com>

toschdev · 2021-04-26T18:01:11Z

Thanks so much @barriebyron for the review 🙏

shahankhatch

This is wonderful @toschdev. Thanks @barriebyron and @zmanian for comments too.

shahankhatch · 2021-04-26T18:22:57Z

docs/gaia-tutorials/installation.md

@@ -21,7 +21,7 @@ source ~/.bash_profile
 ```

 ::: tip
-**Go 1.15+** is required for the Cosmos SDK.
+**Go 1.16+** or later is required for the Cosmos SDK.


Gaia is still on 1.15 until 1.16 is properly integrated into actions and tests

shahankhatch · 2021-04-26T18:23:19Z

docs/gaia-tutorials/installation.md

 build_tags: netgo,ledger
-go: go version go1.12.5 darwin/amd64
+go: go version go1.16 darwin/amd64


Same comment as before, we are on go1.15

shahankhatch · 2021-04-26T18:26:32Z

docs/gaia-tutorials/join-mainnet.md


-minimum-gas-prices = ""
+minimum-gas-prices = "0.025uatom"


I suggest matching what's written as the example's text, e.g., is "10uatom" written as "10utom"? Is 0.025uatom the official recommendation? If there's an official standard, perhaps a link could be helpful.

Yes, it's actually in the same document a few lines below

End of chapter a note on gas and fees. So I thought let's make it even more clear. Having no input is actually dangerous (because of transaction flood) - so let's add it to the code snipped directly.
https://github.com/cosmos/gaia/blob/main/docs/gaia-tutorials/join-mainnet.md#a-note-on-gas-and-fees

Speaking about this, we could consider making this default into the bootstrapped app.toml file.

shahankhatch · 2021-04-26T18:28:49Z

docs/gaia-tutorials/join-mainnet.md


-By default every node is in `PruneSyncable` mode. If you would like to change your nodes pruning strategy then you must do so when the node is initialized. For example, if you would like to change your node to the `PruneEverything` mode then you can pass the `---pruning everything` flag when you call `gaiad start`.
+By default every node is in `default` mode. This is the recommended setting for most environments.
+If you would like to change your nodes pruning strategy then you must do so when the node is initialized. Passing a flag when starting `gaia` will always override settings in the `app.toml` file, if you would like to change your node to the `everything` mode then you can pass the `---pruning everything` flag when you call `gaiad start`.


Re: only when the node is initialized. Do you mean when the node is started? Or after initialization i.e., gaiad init, sets the mode in stone? Does the command line argument then modify the behaviour after it's started the first time?

shahankhatch · 2021-04-26T18:29:32Z

docs/gaia-tutorials/join-mainnet.md


-By default every node is in `PruneSyncable` mode. If you would like to change your nodes pruning strategy then you must do so when the node is initialized. For example, if you would like to change your node to the `PruneEverything` mode then you can pass the `---pruning everything` flag when you call `gaiad start`.
+By default every node is in `default` mode. This is the recommended setting for most environments.
+If you would like to change your nodes pruning strategy then you must do so when the node is initialized. Passing a flag when starting `gaia` will always override settings in the `app.toml` file, if you would like to change your node to the `everything` mode then you can pass the `---pruning everything` flag when you call `gaiad start`.

 > Note: When you are pruning state you will not be able to query the heights that are not in your store.


I believe that it is possible but only by specifying a node target that has a different pruning strategy.

shahankhatch · 2021-04-26T19:07:36Z

docs/resources/service-providers.md

@@ -4,79 +4,194 @@ order: 5

 # Service Providers

-We define 'service providers' as entities providing services for end-users that involve some form of interaction with a Cosmos-SDK based blockchain (this includes the Cosmos Hub). More specifically, this document will be focused around interactions with tokens.
+'Service Providers' are defined as entities that provide services for end-users that involve some form of interaction with the Cosmos Hub. More specifically, this document is focused on interactions with tokens.


Suggest adding, "for example, exchanges".

shahankhatch · 2021-04-26T19:08:44Z

docs/resources/service-providers.md


-We will describe the steps to run and interact with a full-node for the Cosmos Hub. For other SDK-based blockchain, the process should be similar. 
+- Full Nodes: Interact with the blockchain. 
+- REST Server: Serve as a relayer for HTTP calls.


Suggest changing the term relayer as it overlaps with IBC's relayer terminology.

shahankhatch · 2021-04-26T19:10:19Z

docs/resources/service-providers.md

+
+When choosing to remote access a Full Node and gaiad, you need a Full Node running and gaia installed on your local machine.
+
+`gaiad` is the tool that enables you to interact with the node that runs on the Cosmos Hub network, whether you run it yourself or not.


This line could be moved earlier.

how far earlier do you have in mind? Beginning of this chapter or even at the start of the whole article?

Updates installation, join-mainnet and first start for service provid…

cc9e477

…er docs

toschdev added WIP scope: docs Improvements or additions to documentation labels Apr 21, 2021

Tobias Schwarz added 3 commits April 21, 2021 12:08

Modifies service providers doc

a82c035

Updates Service Providers remote access gaia

018860f

Remove validator step from full-node setup

3c7e1b1

toschdev commented Apr 21, 2021

View reviewed changes

Tobias Schwarz added 9 commits April 21, 2021 13:22

Updates service provider guide rest api documentation

55aa44d

Updates to go v1.16 on gaia v4.2.1

8f9c581

Changes format on the join-mainnet guide

76ab39d

Updates to go v1.16 and wording in the join-mainnet documentation

3e603b2

Updates CLI commands

2f940bf

Adds more descriptive CLI command output

8f9e634

Adds more account cli details

5904635

Adds index with links

cd39eb9

Remove transaction signing for now

9bc239a

toschdev removed the WIP label Apr 26, 2021

toschdev marked this pull request as ready for review April 26, 2021 08:55

toschdev requested review from alessio, alexanderbez, jgimeno, shahankhatch and zmanian as code owners April 26, 2021 08:55

Adds sentence that default pruning is recommended for most setups

53a9bfd

barriebyron reviewed Apr 26, 2021

View reviewed changes

Apply suggestions from code review

81b203d

Co-authored-by: Barrie Byron <barrie.byron@tendermint.com>

toschdev requested a review from barriebyron April 26, 2021 19:05

shahankhatch approved these changes Apr 26, 2021

View reviewed changes

Tobias Schwarz added 2 commits April 27, 2021 10:15

Use go1.15

7c7080c

Remove relayer as word for http calls

417fc70

toschdev merged commit 5b3c805 into main Apr 27, 2021

toschdev deleted the service-provider-guide branch April 27, 2021 08:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Updates Service Provider Guide #826

Updates Service Provider Guide #826

toschdev commented Apr 21, 2021 •

edited

Loading

toschdev Apr 21, 2021

alessio commented Apr 26, 2021

zmanian commented Apr 26, 2021

zmanian commented Apr 26, 2021

toschdev commented Apr 26, 2021

barriebyron left a comment

toschdev commented Apr 26, 2021

shahankhatch left a comment

shahankhatch Apr 26, 2021

shahankhatch Apr 26, 2021

shahankhatch Apr 26, 2021

toschdev Apr 26, 2021

toschdev Apr 26, 2021

shahankhatch Apr 26, 2021

shahankhatch Apr 26, 2021

shahankhatch Apr 26, 2021

shahankhatch Apr 26, 2021

shahankhatch Apr 26, 2021

toschdev Apr 26, 2021


		When choosing to remote access a Full Node and gaiad, you need a Full Node running and gaia installed on your local machine.

		`gaiad` is the tool that enables you to interact with the node that runs on the Cosmos Hub network, whether you run it yourself or not.


		minimum-gas-prices = ""
		minimum-gas-prices = "0.025uatom"

Updates Service Provider Guide #826

Updates Service Provider Guide #826

Conversation

toschdev commented Apr 21, 2021 • edited Loading

Description

Choose a reason for hiding this comment

alessio commented Apr 26, 2021

zmanian commented Apr 26, 2021

zmanian commented Apr 26, 2021

toschdev commented Apr 26, 2021

barriebyron left a comment

Choose a reason for hiding this comment

toschdev commented Apr 26, 2021

shahankhatch left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

toschdev commented Apr 21, 2021 •

edited

Loading