Skip to content

Update documentation #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
+2,430 −2,430
Open

Update documentation #3

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e5bf42a
Update README.md
TimaxLacs Jan 31, 2024
2438a84
commit message
TimaxLacs Jan 31, 2024
d4970ae
commit message 1
TimaxLacs Jan 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -115,7 +115,7 @@ Genesis: [QmYubyVNfghD4xCrTFj26zBwrF9s5GJhi1TmxvrwmJCipr](http://cloudflare-ipfs

Build: ```make install```

Run: ```cyber start ```
Run: ```deepchain start ```

To use as CLI with remote node:
```
@@ -158,19 +158,19 @@ _________________________________________________________

### Follow Hero and get HYDROGEN:
```
cyber tx staking delegate bostromvaloper1hmkqhy8ygl6tnl5g8tc503rwrmmrkjcqf92r73 1000000000boot --from <name> --chain-id bostrom --gas 200000 --gas-prices 0.01boot --yes --node https://rpc.bostrom.cybernode.ai:443
deepchain tx staking delegate bostromvaloper1hmkqhy8ygl6tnl5g8tc503rwrmmrkjcqf92r73 1000000000boot --from <name> --chain-id deep --gas 200000 --gas-prices 0.01boot --yes --node https://rpc.bostrom.cybernode.ai:443
```

### Investmint HYDROGEN to get resources:
```
cyber tx resources investmint 1000000000hydrogen millivolt 86400 --from <name> --chain-id bostrom --gas 200000 --gas-prices 0.01boot --yes --node https://rpc.bostrom.cybernode.ai:443
deepchain tx resources investmint 1000000000hydrogen millivolt 86400 --from <name> --chain-id deep --gas 200000 --gas-prices 0.01boot --yes --node https://rpc.bostrom.cybernode.ai:443

cyber tx resources investmint 1000000000hydrogen milliampere 86400 --from <name> --chain-id bostrom --gas 200000 --gas-prices 0.01boot --yes --node https://rpc.bostrom.cybernode.ai:443
deepchain tx resources investmint 1000000000hydrogen milliampere 86400 --from <name> --chain-id deep --gas 200000 --gas-prices 0.01boot --yes --node https://rpc.bostrom.cybernode.ai:443
```

### Cyberlink and Search:
```
cyber tx graph cyberlink QmdVWtX17m7UvF8FcvNLTJxcpxv2fSJd7Z3VBoYxxW9Qpu Qmb9xPYYwHt1F3bQysKCZzXRzAT8QLvAyMe5DyPy4rene8 --from <name> --chain-id bostrom --yes --node https://rpc.bostrom.cybernode.ai:443
deepchain tx graph cyberlink QmdVWtX17m7UvF8FcvNLTJxcpxv2fSJd7Z3VBoYxxW9Qpu Qmb9xPYYwHt1F3bQysKCZzXRzAT8QLvAyMe5DyPy4rene8 --from <name> --chain-id deep --yes --node https://rpc.bostrom.cybernode.ai:443

curl https://lcd.bostrom.cybernode.ai/rank/search?cid=QmdVWtX17m7UvF8FcvNLTJxcpxv2fSJd7Z3VBoYxxW9Qpu
```
46 changes: 23 additions & 23 deletions docs/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
# Documentation [WIP]

## Contents

1. **[Run validator guide](run_validator.md)**
2. **[Use CLI guide](ultimate-commands-guide.md)**
3. **[Setup daemon config guide](setup_cyber_configuration.md)**
4. **[Setup local dev environment guide](setup_dev_env.md)**
5. **Deploy contract guide**
6. **Create proposal guide**
7. **[Supported GPUs list](supported_gpu_list.md)**
8. **Network upgrade guide**
9. **[Keystore guide](keystore.md)**
10. **[Multisig guide](multisig_guide.md)**
11. **[Ledger guide](cyber_Ledger_guide.md)**
12. **Tendermint KMS guide**
13. **Modules documentation**
- **graph**
- **rank**
- **[bandwidth](../x/bandwidth/spec/README.md)**
- **[cyberbank](../x/cyberbank/spec/README.md)**
- **[resources](../x/resources/spec/README.md)**
- **dmn**
# Documentation [WIP]
## Contents
1. **[Run validator guide](run_validator.md)**
2. **[Use CLI guide](ultimate-commands-guide.md)**
3. **[Setup daemon config guide](setup_cyber_configuration.md)**
4. **[Setup local dev environment guide](setup_dev_env.md)**
5. **Deploy contract guide**
6. **Create proposal guide**
7. **[Supported GPUs list](supported_gpu_list.md)**
8. **Network upgrade guide**
9. **[Keystore guide](keystore.md)**
10. **[Multisig guide](multisig_guide.md)**
11. **[Ledger guide](cyber_Ledger_guide.md)**
12. **Tendermint KMS guide**
13. **Modules documentation**
- **graph**
- **rank**
- **[bandwidth](../x/bandwidth/spec/README.md)**
- **[cyberbank](../x/cyberbank/spec/README.md)**
- **[resources](../x/resources/spec/README.md)**
- **dmn**
- **staking**
138 changes: 69 additions & 69 deletions docs/cyber_Ledger_guide.md
View file
Original file line number Diff line number Diff line change
@@ -1,69 +1,69 @@
# Ledger nano Support

It is possible to use your Ledger device with cyber to store keys and sign transactions.

## Cyberd CLI & Ledger Nano

How to get started. First of all, you'll need a couple of things to be done:

+ A running and synced cyber node (how to: [here](https://github.com/cybercongress/go-cyber/blob/bostrom-dev/docs/run_validator.md) and [here](https://github.com/cybercongress/go-cyber/blob/main/docs/ultimate-commands-guide.md))

+ [Setup](https://support.ledger.com/hc/en-us/articles/360000613793-Set-up-as-new-device) your Ledger device and [install Cosmos app on it](https://github.com/cosmos/ledger-cosmos/blob/master/README.md#installing) (the latest firmware for Ledger and Cosmos app required)

It is necessary to verify that cyber is built with netgo and Ledger tags. To check that, we can run: `cyber version --long`.

## Add your Ledger key

If you have set up your Ledger device on a different machine then the one running cyber, it is necessary to make sure that the Ledger device is generally working on this machine. A great way to do so is installing [Ledger Live](https://shop.ledger.com/pages/ledger-live) on the machine and trying to connect your Ledger device to it. This will show possible issues and error codes to work with ([Fix connection issues](https://support.ledger.com/hc/en-us/articles/115005165269-Fix-connection-issues) guide from Ledger).
When you made sure that your Ledger device is successfully interacting with your machine do the following:

+ Connect and unlock your Ledger device
+ Open the Cosmos app on your Ledger
+ Create an account in cyber from your Ledger key

For account creation run:

``` js
cyber keys add <your_key_name> --ledger
```

After submitting this command your Ledger device should show a generated address and will wait for confirmation. Hit confirm the button and in the console, you'll see the following output:

``` js
- name: <your_key_name>
type: ledger
address: cyber1gw5kdey7fs9wvh05w66s034s24tjdvxcp5fhkz
pubkey: cyberpub1addwnpepq0lfpdumac47nyel06u95czd4026ahzmjr8stsx4h65kw3dhh60py0m7k6r
mnemonic: ""
threshold: 0
pubkeys: []
```

By default, the `...keys add` command with account and index set to 0 of [bip44](https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki) derivation path is used. To add more than one key account and/or index it must be specified separately in the following way:

``` js
cyber keys add <your_key2_name> --ledger --account 1 --index 1
```

You don't need to remember which numbers for account and index you've used, it will be matched to <your_key_name> automatically.

## Confirm your address

To make sure you have added everything correctly just run:

``` js
cyber keys show <key_name> -d
```

It's necessary to confirm that the key on your Ledger matches the one shown in the console.

## Signing transactions

You are now ready to sign and send transactions. This could be done by using the `tx bank send` command. Your Ledger device should be connected and unlocked at this step. Run the following to send some CYB tokens:

``` js
cyber tx bank send <from_key_name> <destination_address> <ammount>cyb --chain-id <current_chain_id>
```

`<from_key_name>` is your ledger key name, `<destination_address>` is the address of the recipient in the following format: `cyber1wq7p5qfygxr37vqqufhj5fzwlg55zmm4w0p8sw`.
When prompted with `confirm transaction before signing`, answer Y. Your Ledger will ask to approve the transaction. Make sure you'll inspect the transaction JSON before signing it. When the transaction is signed on the Ledger, usually, the output will show up in the console.
# Ledger nano Support
It is possible to use your Ledger device with deep to store keys and sign transactions.
## Cyberd CLI & Ledger Nano
How to get started. First of all, you'll need a couple of things to be done:
+ A running and synced deep node (how to: [here](https://github.com/cybercongress/go-cyber/blob/bostrom-dev/docs/run_validator.md) and [here](https://github.com/cybercongress/go-cyber/blob/main/docs/ultimate-commands-guide.md))
+ [Setup](https://support.ledger.com/hc/en-us/articles/360000613793-Set-up-as-new-device) your Ledger device and [install Cosmos app on it](https://github.com/cosmos/ledger-cosmos/blob/master/README.md#installing) (the latest firmware for Ledger and Cosmos app required)
It is necessary to verify that cyber is built with netgo and Ledger tags. To check that, we can run: `deepchain version --long`.
## Add your Ledger key
If you have set up your Ledger device on a different machine then the one running cyber, it is necessary to make sure that the Ledger device is generally working on this machine. A great way to do so is installing [Ledger Live](https://shop.ledger.com/pages/ledger-live) on the machine and trying to connect your Ledger device to it. This will show possible issues and error codes to work with ([Fix connection issues](https://support.ledger.com/hc/en-us/articles/115005165269-Fix-connection-issues) guide from Ledger).
When you made sure that your Ledger device is successfully interacting with your machine do the following:
+ Connect and unlock your Ledger device
+ Open the Cosmos app on your Ledger
+ Create an account in cyber from your Ledger key
For account creation run:
``` js
deepchain keys add <your_key_name> --ledger
```
After submitting this command your Ledger device should show a generated address and will wait for confirmation. Hit confirm the button and in the console, you'll see the following output:
``` js
- name: <your_key_name>
type: ledger
address: cyber1gw5kdey7fs9wvh05w66s034s24tjdvxcp5fhkz
pubkey: cyberpub1addwnpepq0lfpdumac47nyel06u95czd4026ahzmjr8stsx4h65kw3dhh60py0m7k6r
mnemonic: ""
threshold: 0
pubkeys: []
```
By default, the `...keys add` command with account and index set to 0 of [bip44](https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki) derivation path is used. To add more than one key account and/or index it must be specified separately in the following way:
``` js
deepchain keys add <your_key2_name> --ledger --account 1 --index 1
```
You don't need to remember which numbers for account and index you've used, it will be matched to <your_key_name> automatically.
## Confirm your address
To make sure you have added everything correctly just run:
``` js
deepchain keys show <key_name> -d
```
It's necessary to confirm that the key on your Ledger matches the one shown in the console.
## Signing transactions
You are now ready to sign and send transactions. This could be done by using the `tx bank send` command. Your Ledger device should be connected and unlocked at this step. Run the following to send some CYB tokens:
``` js
deepchain tx bank send <from_key_name> <destination_address> <ammount>cyb --chain-id <current_chain_id>
```
`<from_key_name>` is your ledger key name, `<destination_address>` is the address of the recipient in the following format: `cyber1wq7p5qfygxr37vqqufhj5fzwlg55zmm4w0p8sw`.
When prompted with `confirm transaction before signing`, answer Y. Your Ledger will ask to approve the transaction. Make sure you'll inspect the transaction JSON before signing it. When the transaction is signed on the Ledger, usually, the output will show up in the console.
Loading