Skip to content

Commit

Permalink
chore: update documentation from cosmos-sdk/docs (#271)
Browse files Browse the repository at this point in the history
* chore: Sync docs from cosmos-sdk/docs

* Delete docs/build/tooling/03-hubl.md

* Delete versioned_docs/version-0.52/build/tooling/03-hubl.md

---------

Co-authored-by: tac0turtle <[email protected]>
Co-authored-by: Julien Robert <[email protected]>
  • Loading branch information
3 people authored Jan 31, 2025
1 parent cdbf6c3 commit e40a5d5
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 155 deletions.
2 changes: 0 additions & 2 deletions docs/build/migrations/02-upgrading.md
Original file line number Diff line number Diff line change
Expand Up @@ -1236,8 +1236,6 @@ For example, assuming you put all your proto files in subfolders inside your roo

If you are using a custom folder structure for your proto files, please reorganize them so that their OS path matches their proto package name.

This is to allow the proto FileDescriptSets to be correctly registered, and this standardized OS import paths allows [Hubl](https://github.com/cosmos/cosmos-sdk/tree/main/tools/hubl) to reflectively talk to any chain.

#### `{accepts,implements}_interface` proto annotations

The SDK is normalizing the strings inside the Protobuf `accepts_interface` and `implements_interface` annotations. We require them to be fully-scoped names. They will soon be used by code generators like Pulsar and Telescope to match which messages can or cannot be packed inside `Any`s.
Expand Down
73 changes: 0 additions & 73 deletions docs/build/tooling/03-hubl.md

This file was deleted.

1 change: 0 additions & 1 deletion docs/build/tooling/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ This includes tools for development, operating a node, and ease of use of a Cosm

* [Cosmovisor](./01-cosmovisor.md)
* [Confix](./02-confix.md)
* [Hubl](./03-hubl.md)
* [Rosetta](https://docs.cosmos.network/main/run-node/rosetta)

## Other Tools
Expand Down
6 changes: 1 addition & 5 deletions docs/learn/advanced/17-autocli.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ The keyring is then converted to the `client/v2/autocli/keyring` interface.
If no keyring is provided, the `autocli` generated command will not be able to sign transactions, but will still be able to query the chain.

:::tip
The Cosmos SDK keyring and Hubl keyring both implement the `client/v2/autocli/keyring` interface, thanks to the following wrapper:
The Cosmos SDK keyring implements the `client/v2/autocli/keyring` interface, thanks to the following wrapper:

```go
keyring.NewAutoCLIKeyring(kb)
Expand Down Expand Up @@ -283,10 +283,6 @@ According to the [Cobra documentation](https://pkg.go.dev/github.com/spf13/cobra

`autocli` lets you generate CLI to your Cosmos SDK-based applications without any cobra boilerplate. It allows you to easily generate CLI commands and flags from your protobuf messages, and provides many options for customising the behavior of your CLI application.

To further enhance your CLI experience with Cosmos SDK-based blockchains, you can use `hubl`. `hubl` is a tool that allows you to query any Cosmos SDK-based blockchain using the new AutoCLI feature of the Cosmos SDK. With `hubl`, you can easily configure a new chain and query modules with just a few simple commands.

For more information on `hubl`, including how to configure a new chain and query a module, see the [Hubl documentation](https://docs.cosmos.network/main/build/tooling/hubl).

# Off-Chain

Off-chain is a `client/v2` package providing functionalities for allowing to sign and verify files with two commands:
Expand Down
13 changes: 12 additions & 1 deletion docs/user/run-node/00-keyring.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,14 @@ is a list of the most popular operating systems and their respective passwords m
* GNU/Linux:
* [libsecret](https://gitlab.gnome.org/GNOME/libsecret)
* [kwallet](https://api.kde.org/frameworks/kwallet/html/index.html)
* [keyctl](https://www.kernel.org/doc/html/latest/security/keys/core.html)

GNU/Linux distributions that use GNOME as default desktop environment typically come with
[Seahorse](https://wiki.gnome.org/Apps/Seahorse). Users of KDE based distributions are
commonly provided with [KDE Wallet Manager](https://userbase.kde.org/KDE_Wallet_Manager).
Whilst the former is in fact a `libsecret` convenient frontend, the latter is a `kwallet`
client.
client. `keyctl` is a secure backend leverages the Linux's kernel security key management system
to store cryptographic keys securely in memory.

`os` is the default option since operating system's default credentials managers are
designed to meet users' most common needs and provide them with a comfortable
Expand Down Expand Up @@ -93,6 +95,15 @@ GNU/Linux distributions that ships KDE as default desktop environment. Please re
[KWallet Handbook](https://docs.kde.org/stable5/en/kwalletmanager/kwallet5/index.html) for more
information.

### The `keyctl` backend

The *Kernel Key Retention Service* is a security facility that
has been added to the Linux kernel relatively recently. It allows sensitive
cryptographic data such as passwords, private key, authentication tokens, etc
to be stored securely in memory.

The `keyctl` backend is available on Linux platforms only.

### The `test` backend

The `test` backend is a password-less variation of the `file` backend. Keys are stored
Expand Down
73 changes: 0 additions & 73 deletions versioned_docs/version-0.52/build/tooling/03-hubl.md

This file was deleted.

0 comments on commit e40a5d5

Please sign in to comment.