Skip to content

Commit c03841a

Browse files
committed
Tons of fixes
1 parent 5e6eb58 commit c03841a

30 files changed

+447
-406
lines changed

README.md

Lines changed: 37 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,73 +1,79 @@
1-
![Secret Network](logo.png)
1+
![Secret Network](header.png)
22

33
<p align="center">
44
Secret Network secures the decentralized web
55
</p>
66

7+
## What is Secret Network?
8+
79
Want to build a better internet? Solve for privacy.
810

911
Secret Network is a blockchain-based, open-source protocol that lets anyone perform computations on encrypted data, bringing privacy to smart contracts and public blockchains. Our mission: to improve the adoption and usability of decentralized technologies for the benefit of all.
1012

11-
Mainnet is out! Get the latest version [HERE.](https://github.com/scrtlabs/SecretNetwork/releases/latest).
13+
Mainnet is out! Get the [latest version](https://github.com/scrtlabs/SecretNetwork/releases/latest).
1214

1315
[![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md)
1416

15-
# Community
17+
## Community
1618

1719
- [Homepage](https://scrt.network)
1820
- [Blog](https://blog.scrt.network)
1921
- [Forum](https://forum.scrt.network)
20-
- [Wiki](https://docs.scrt.network)
22+
- [Docs](https://docs.scrt.network)
2123
- [Discord](https://chat.scrt.network)
2224
- [Twitter](https://twitter.com/SecretNetwork)
23-
- [Community Telegram Channel](https://t.me/SCRTnetwork)
24-
- [Community Secret Nodes Telegram](https://t.me/secretnodes)
25+
- [Telegram](https://t.me/SCRTnetwork)
26+
- [Community Telegram of Secret Nodes](https://t.me/secretnodes)
2527

26-
# Block Explorers
28+
## Block Explorers
2729

2830
Secret Network uses the SCRT coin (Secret) for fees, staking, governance, and to secure the network. View transactions, validators, governance proposals, and more using the following Secret Network block explorers:
2931

3032
- [secretnodes](https://secretnodes.com)
33+
- [Mintscan](https://mintscan.io/secret)
3134

32-
# Wallets
35+
## Wallets
3336

34-
- [Ledger Nano S and Ledger Nano X](docs/guides/ledger-nano.md)
37+
- [Ledger Nano S and Ledger Nano X](./docs/guides/ledger-nano.md)
3538
- [Keplr](https://wallet.keplr.app)
3639
- [Math Wallet](https://mathwallet.org/secretnetwork-wallet/)
3740
- [Citadel.one](https://app.citadel.one)
3841

39-
# Blockchain REST Providers
42+
## Blockchain REST Providers
4043

41-
- [SecretAPI.io by ChainofSecrets.org](https://secretapi.io)
44+
- Community API by Secret Infrastructure
45+
- [https://api.scrt.network](https://api.scrt.network) (LCD - Light Client Daemon)
46+
- [https://api.scrt.network:26657](https://api.scrt.network:26657) (RPC - Remote Procedure Call)
47+
- [Figment](https://datahub.figment.io/)
4248

43-
# Docs
49+
## Docs
4450

45-
- [Install the `secretcli` light client (Windows, Mac & Linux)](docs/cli/install-cli.md)
46-
- [How to use the `secretcli` light client](docs/cli/secretcli.md)
47-
- [How to participate in on-chain governance](docs/protocol/governance.md)
48-
- [How to run a full node on mainnet](docs/node-guides/run-full-node-mainnet.md)
49-
- [How to run an LCD server](docs/lcd-server-example.md)
50-
- [Ledger Nano S (and X) support](docs/guides/ledger-nano.md)
51-
- [How to join as a mainnet validator](docs/node-guides/join-validator-mainnet.md)
52-
- [How to backup a validator](docs/backup/backup-a-validator.md)
53-
- [How to backup Full Nodes](docs/backup/backup-a-full-node.mdd)
54-
- [How to backup Wallets](docs/backup/wallets.md)
55-
- [How to migrate a validator to a new machine](docs/node-guides/migrate-a-validator.md)
56-
- [How to setup SGX on your machine](docs/node-guides/setup-sgx.md)
57-
- [How to verify the SGX setup on your machine](docs/node-guides/verify-sgx.md)
58-
- [How to use SecretJS to develop Secret dApps](https://github.com/scrtlabs/enigma-blockchain-contracts-guide/blob/master/cosmwasm-js.md)
51+
- [Install the `secretcli` light client (Windows, Mac & Linux)](./docs/cli/install-cli.md)
52+
- [How to use the `secretcli` light client](./docs/cli/secretcli.md)
53+
- [How to participate in on-chain governance](./docs/guides/governance.md)
54+
- [How to run a full node on mainnet](./docs/node-guides/run-full-node-mainnet.md)
55+
- [How to run an LCD server](./docs/lcd-server-example.md)
56+
- [Ledger Nano S (and X) support](./docs/guides/ledger-nano.md)
57+
- [How to join as a mainnet validator](./docs/node-guides/join-validator-mainnet.md)
58+
- [How to backup a validator](./docs/backup//backup-a-validator.md)
59+
- [How to backup a full nodes)](./docs/backup/backup-a-full-node.md)
60+
- [How to backup a wallet)](./docs/backup/wallets.md)
61+
- [How to migrate a validator to a new machine](./docs/node-guides/migrate-a-validator.md)
62+
- [How to setup SGX on your machine](./docs/node-guides/setup-sgx.md)
63+
- [How to verify the SGX setup on your machine](./docs/node-guides/verify-sgx.md)
64+
- [How to use SecretJS to develop Secret dApps](./docs/cli/secretcli.md)
5965

60-
# Implementation Discussions
66+
## Implementation Discussions
6167

6268
- [An Update on the Encryption Protocol](https://forum.scrt.network/t/an-update-on-the-encryption-protocol/1641)
6369
- [Hard Forks and Network Upgrades](https://forum.scrt.network/t/hard-forks-and-network-upgrades/1670)
64-
- [Dont trust, verify (an untrusted host)](https://forum.scrt.network/t/dont-trust-verify-an-untrusted-host/1669)
70+
- [Don't trust, verify (an untrusted host)](https://forum.scrt.network/t/dont-trust-verify-an-untrusted-host/1669)
6571
- [Secret Contracts on Secret Network](https://forum.scrt.network/t/secret-contracts-on-enigma-blockchain/1284)
6672
- [Network key management/agreement](https://forum.scrt.network/t/network-key-management-agreement/1324)
6773
- [Input/Output/State Encryption/Decryption protocol](https://forum.scrt.network/t/input-output-state-encryption-decryption-protocol/1325)
68-
- [Why the Cosmos move doesnt mean were leaving Ethereum](https://forum.scrt.network/t/why-the-cosmos-move-doesnt-mean-were-leaving-ethereum/1301)
74+
- [Why the Cosmos move doesn't mean we're leaving Ethereum](https://forum.scrt.network/t/why-the-cosmos-move-doesnt-mean-were-leaving-ethereum/1301)
6975
- [(Dev discussion/Issue) WASM implementation](https://forum.scrt.network/t/dev-discussion-issue-wasm-implementation/1303)
7076

71-
# License
77+
## License
7278

73-
Secret Network is free software: you can redistribute it and/or modify it under the terms of the [GNU Affero General Public License](LICENSE) as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. The GNU Affero General Public License is based on the GNU GPL but has an additional term to allow users who interact with the licensed software over a network to receive the source for that program.
79+
SecretNetwork is free software: you can redistribute it and/or modify it under the terms of the [GNU Affero General Public License](https://github.com/SecretFoundation/docs/blob/main/LICENSE) as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. The GNU Affero General Public License is based on the GNU GPL, but has an additional term to allow users who interact with the licensed software over a network to receive the source for that program.

docs/.vuepress/config.js

Lines changed: 31 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@ module.exports = {
2020
collapsable: true, // optional, defaults to true
2121
sidebarDepth: 1, // optional, defaults to 1
2222
children: [
23+
{
24+
title: "Home",
25+
path: "/",
26+
},
2327
{
2428
title: "Overview",
2529
path: "/overview",
@@ -77,26 +81,26 @@ module.exports = {
7781
path: "/dev/privacy-model-of-secret-contracts.md",
7882
},
7983
{
80-
title: "Development Guide",
84+
title: "Developing Secret Contracts",
8185
path: "/dev/developing-secret-contracts.md",
8286
},
8387
{
84-
title: "Quickstart",
88+
title: "Secret Contracts Quickstart",
8589
path: "/dev/quickstart.md",
8690
},
8791
{
88-
title: "SecretJS",
89-
path: "/dev/secret-js",
92+
title: "Secret Tutorials",
93+
path: "/dev/tutorials.md",
9094
},
9195
{
92-
title: "Tutorials",
93-
path: "/dev/tutorials.md",
96+
title: "SecretJS",
97+
path: "/dev/secret-js",
9498
},
9599
],
96100
},
97101
{
98102
title: "Secret CLI", // required
99-
path: "/cli/secretcli", // optional, link of the title, which should be an absolute path and must exist
103+
// path: "/cli/install-cli", // optional, link of the title, which should be an absolute path and must exist
100104
collapsable: true, // optional, defaults to true
101105
sidebarDepth: 1, // optional, defaults to 1
102106
children: [
@@ -105,7 +109,7 @@ module.exports = {
105109
path: "/cli/install-cli",
106110
},
107111
{
108-
title: "Secret CLI",
112+
title: "Using Secret CLI",
109113
path: "/cli/secretcli",
110114
},
111115
{
@@ -117,14 +121,18 @@ module.exports = {
117121
{
118122
title: "Node Operators", // requireds
119123
collapsable: true, // optional, defaults to true
120-
path: "/node-guides/run-full-node-mainnet", // optional, link of the title, which should be an absolute path and must exist
124+
// path: "/node-guides/secret-nodes", // optional, link of the title, which should be an absolute path and must exist
121125
sidebarDepth: 1, // optional, defaults to 1
122126
children: [
123127
{
124128
title: "Mainnet",
125129
path: "/node-guides/secret-nodes",
126130
sidebarDepth: 1,
127131
children: [
132+
{
133+
title: "Introduction",
134+
path: "/node-guides/secret-nodes",
135+
},
128136
{
129137
title: "Hardware Compliance",
130138
path: "/node-guides/hardware-compliance",
@@ -141,6 +149,10 @@ module.exports = {
141149
title: "Run Full Node",
142150
path: "/node-guides/run-full-node-mainnet",
143151
},
152+
{
153+
title: "Run a LCD Server",
154+
path: "/node-guides/lcd-server-example",
155+
},
144156
{
145157
title: "Basic Security",
146158
path: "/node-guides/basic-security",
@@ -184,10 +196,10 @@ module.exports = {
184196
title: "Prune Everything Nodes",
185197
path: "/node-guides/prune-everything",
186198
},
187-
{
188-
title: "Active Node Peers",
189-
//path: '/node-guides/active-node-peers'
190-
},
199+
// {
200+
// title: "Active Node Peers",
201+
// //path: '/node-guides/active-node-peers'
202+
// },
191203
{
192204
title: "Quick Sync",
193205
path: "/node-guides/quick-sync",
@@ -212,7 +224,7 @@ module.exports = {
212224
},
213225
{
214226
title: "Backup", // required
215-
path: "/", // optional, link of the title, which should be an absolute path and must exist
227+
path: "/backup/backup-a-validator", // optional, link of the title, which should be an absolute path and must exist
216228
collapsable: true, // optional, defaults to true
217229
sidebarDepth: 1, // optional, defaults to 1
218230
children: [
@@ -235,11 +247,12 @@ module.exports = {
235247
],
236248
},
237249
{
238-
title: "Delegators",
250+
title: "Delegating (CLI)",
239251
path: "/node-guides/delegating-mainnet",
240252
},
241253
{
242254
title: "Testnet",
255+
path: "/testnet/install_cli",
243256
sidebarDepth: 1,
244257
collapsable: true, // optional, defaults to trues
245258
children: [
@@ -284,10 +297,11 @@ module.exports = {
284297
},
285298
{
286299
title: "Protocol", // required
287-
path: "/protocol/intro", // optional, link of the title, which should be an absolute path and must exist
300+
// path: "/protocol/intro", // optional, link of the title, which should be an absolute path and must exist
288301
collapsable: true, // optional, defaults to true
289-
sidebarDepth: 0, // optional, defaults to 1
302+
sidebarDepth: 1, // optional, defaults to 1
290303
children: [
304+
"/protocol/intro",
291305
"/protocol/components",
292306
"/protocol/encryption-specs",
293307
"/protocol/transactions",

docs/backup/backup-a-full-node.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Backup a Full Node
1+
# Full Node Backup
22

33
Why you might want to backup your node ID:
44

@@ -12,12 +12,12 @@ To see the associated public key:
1212
secretd tendermint show-validator
1313
```
1414

15-
# Full Node Private key
15+
## Full Node Private key
1616

1717
1. Backup `~/.secretd/config/node_key.json`.
1818

1919

20-
# Full Node Data
20+
## Full Node Data
2121

2222
1. Gracefully shut down the node:
2323

docs/backup/backup-a-validator.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Backup a Validator
1+
# Validator Backup
22

33
It is **CRUCIAL** to backup your validator's private key. It's the only way to restore your validator in an event of a disaster.
44

docs/backup/wallets.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
# How to backup Wallets
22

3-
- [Wallet](#wallet)
4-
- [Mnemonics](#mnemonics)
5-
- [Export](#export)
6-
73
## Mnemonics
84

95
When you create a new key, you'll receive the mnemonic phrase that can be used to restore that key. Backup the mnemonic phrase:

docs/cli/install-cli.md

Lines changed: 80 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,90 @@
1-
# Install the `secretcli` Secret Network light client
1+
# Install Secret CLI
22

3-
1. Get the latest release of `secretcli` for your OS [HERE](https://github.com/scrtlabs/SecretNetwork/releases/latest)
3+
`secretcli` is the Secret Network light client, a command-line interface tool for interacting with nodes running on the Secret Network.
44

5-
2) Install:
5+
To install it, follow these instructions:
66

7-
- Mac/Windows: Rename it from `secretcli-${VERSION}-${OS}` to `secretcli` or `secretcli.exe` and put it in your path
8-
- Ubuntu/Debian: `sudo dpkg -i secret*.deb`
7+
## Download
98

10-
Note - The home directory for the CLI is now `~/.secretd` due to recent changes in the Cosmos SDK. More info can be found [HERE](https://github.com/scrtlabs/SupernovaDocs/blob/master/app%20developers/cli.md)
9+
Get the latest release of `secretcli` for your OS [HERE](https://github.com/scrtlabs/SecretNetwork/releases/latest).
1110

12-
3. Configure:
11+
## Install
1312

14-
```bash
15-
secretcli config chain-id secret-4
16-
secretcli config output json
17-
secretcli config node http://api.scrt.network:26657
18-
```
13+
- Mac/Windows: Rename it from `secretcli-${VERSION}-${OS}` to `secretcli` or `secretcli.exe` and put it in your path
14+
- Ubuntu/Debian: `sudo dpkg -i secret*.deb`
1915

20-
There are two options for getting your own secret node:
16+
Note - The home directory for the CLI is now `~/.secretd` due to recent changes in the Cosmos SDK. More info can be found [HERE](https://github.com/scrtlabs/SupernovaDocs/blob/master/app%20developers/cli.md).
2117

22-
1. [Rent or use a free-tier node from figment](https://figment.io/datahub/secret-network/)
23-
2. [Set up your own node](https://docs.scrt.network/node-guides/run-full-node-mainnet.html)
18+
## Configure
2419

25-
4. Check the installation:
20+
```bash
21+
secretcli config chain-id secret-4
22+
secretcli config output json
23+
secretcli config node http://api.scrt.network:26657
24+
```
2625

27-
```bash
28-
secretcli status
29-
```
26+
There are two options for getting your own secret node:
27+
28+
1. [Rent or use a free-tier node from figment](https://figment.io/datahub/secret-network/)
29+
30+
- In the list of provided endpoints, pick a Secret RPC one starting with `secret-4`
31+
- Add the port `:443` and API key when configuring the URL:
32+
33+
```bash
34+
secretcli config node https://secret-4--rpc--full.datahub.figment.io:443/apikey/abcdefghijklmnopqrstuvwxyz123456789
35+
```
36+
37+
2. [Set up your own node](../node-guides/run-full-node-mainnet.md)
38+
39+
## Check the installation
40+
41+
```bash
42+
secretcli status
43+
```
44+
45+
```json
46+
{
47+
"NodeInfo": {
48+
"protocol_version": {
49+
"p2p": "8",
50+
"block": "11",
51+
"app": "0"
52+
},
53+
"id": "d023c405ea78c2a99550f8fa5a5d493806c77371",
54+
"listen_addr": "tcp://xx.xx.xx.xx:26656",
55+
"network": "secret-4",
56+
...
57+
```
58+
59+
## Shells Completion Scripts
60+
61+
Completion scripts for popular UNIX shell interpreters such as `Bash` and `Zsh`
62+
can be generated through the `completion` command, which is available for both the
63+
`secretd` and `secretcli`.
64+
65+
If you want to generate `Bash` completion scripts run the following command:
66+
67+
```bash
68+
secretd completion > secretd_completion
69+
secretcli completion > secretcli_completion
70+
```
71+
72+
If you want to generate `Zsh` completion scripts run the following command:
73+
74+
```bash
75+
secretd completion --zsh > secretd_completion
76+
secretcli completion --zsh > secretcli_completion
77+
```
78+
79+
::: tip Note
80+
On most UNIX systems, such scripts may be loaded in `.bashrc` or
81+
`.bash_profile` to enable Bash autocompletion:
82+
83+
```bash
84+
echo '. secretd_completion' >> ~/.bashrc
85+
echo '. secretcli_completion' >> ~/.bashrc
86+
```
87+
88+
Refer to the user's manual of your interpreter provided by your
89+
operating system for information on how to enable shell autocompletion.
90+
:::

0 commit comments

Comments
 (0)