Skip to content

Commit f629cdc

Browse files
Updates Quickstart guide with new CLI workflows. (#255)
* Adds link to typeform for ext. Validators. * Updates quickstart with new CLI workflows.
1 parent d5e9517 commit f629cdc

File tree

1 file changed

+65
-62
lines changed

1 file changed

+65
-62
lines changed

content/basics/quickstart.md

+65-62
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,14 @@ The Entropy network provides threshold signing as a service. That means multiple
1717

1818
The command-line interface (CLI) is the most straightforward way to interact with Entropy from your device.
1919

20-
1. Ensure you have Node.js version 20.9.0 or above:
20+
1. Ensure you have Node.js version `20.x.x` or above:
2121

2222
```shell
2323
node --version
2424
```
2525

2626
```output
27-
v22.2.0
27+
v23.1.0
2828
```
2929

3030
1. Install the Entropy CLI globally using NPM:
@@ -33,33 +33,52 @@ The command-line interface (CLI) is the most straightforward way to interact wit
3333
npm install --global @entropyxyz/cli
3434
```
3535

36-
1. Run the CLI using `entropy tui`:
36+
1. Test that the CLI is installed by requesting the CLI version:
37+
38+
39+
```shell
40+
entropy --version
41+
```
42+
43+
```output
44+
v0.1.0
45+
```
46+
47+
Next, you'll create an Entropy account.
48+
49+
## 2. Create an account
50+
51+
You need funds to interact with the Entropy network. Your funds are stored in an account. You can have multiple accounts.
52+
53+
1. Open the Entropy CLI text-based user interface (TUI):
3754
3855
```shell
3956
entropy tui
4057
```
4158
4259
```output
43-
@@@@@@@@@@ @@@@@@@@@@ @@@@@ @@@@@@@@@@@ @@@@@@@@@ @@@@@@@@@@ @@@@@ @@@@@
44-
@@@@@@@@@@ @@@@@@@@@@ @@@@@ @@@@@@@@@@@ @@@@@@@@@ @@@@@@@@@@ @@@@@ @@@@@
45-
@@@@@@@@@@ @@@@@@@@@@ @@@@@@@ @@@@@@@@@@@ @@@@@@@@@ @@@@@@@@@@ @@@@@ @@@@@
46-
@@@@@ @@@@ @@@@@ @@@@ @@@@@@@ @@@@@ @@@@@ @@@@ @@@@ @@@@@ @@@@ @@@@@ @@@@@
47-
@@@@@ @@@@ @@@@@ @@@@ @@@@@ @@@@@ @@@@@ @@@@ @@@@ @@@@@ @@@@ @@@@@ @@@@@
48-
@@@@@ @@@@ @@@@@ @@@@ @@@@@ @@@@@ @@@@@ @@@@ @@@@ @@@@@ @@@@ @@@@@ @@@@@
49-
@@@@@@@@@@ @@@@@ @@@@ @@@@@ @@@@@ @@@@ @@@@ @@@@@ @@@@ @@@@@ @@@@@
50-
@@@@@@@@@@ @@@@@ @@@@ @@@@@ @@@@@ @@@@ @@@@ @@@@@ @@@@ @@@@@ @@@@@
51-
@@@@@ @@@@@ @@@@ @@@@@ @@@@@ @@@@ @@@@ @@@@@ @@@@ @@@@@ @@@@@
52-
@@@@@ @@@@ @@@@@ @@@@ @@@@@ @@@@@ @@@@ @@@@ @@@@@ @@@@ @@@@@ @@@@@
53-
@@@@@ @@@@ @@@@@ @@@@ @@@@@ @@@@@ @@@@ @@@@ @@@@@ @@@@ @@@@@ @@@@@
54-
@@@@@ @@@@ @@@@@ @@@@ @@@@@ @@@@@ @@@@ @@@@ @@@@@ @@@@ @@@@@ @@@@@
55-
@@@@@@@@@@ @@@@@ @@@@ @@@@@@@ @@@@@ @@@@@@@@@ @@@@@@@@@@ @@@@@@@@@@@
56-
@@@@@@@@@@ @@@@@ @@@@ @@@@@@@ @@@@@ @@@@@@@@@ @@@@@@@@@@ @@@@@@@@@@@
57-
@@@@@@ TEST
58-
@@@@@@ *NET
59-
@@@@@@ ENTROPY-CLI
60-
@@@@@@
60+
@@@@@@@@@@ @@@@@@@@@@ @@@@@ @@@@@@@@@@@ @@@@@@@@@ @@@@@@@@@@ @@@@@ @@@@@
61+
@@@@@@@@@@ @@@@@@@@@@ @@@@@ @@@@@@@@@@@ @@@@@@@@@ @@@@@@@@@@ @@@@@ @@@@@
62+
@@@@@@@@@@ @@@@@@@@@@ @@@@@@@ @@@@@@@@@@@ @@@@@@@@@ @@@@@@@@@@ @@@@@ @@@@@
63+
@@@@@ @@@@ @@@@@ @@@@ @@@@@@@ @@@@@ @@@@@ @@@@ @@@@ @@@@@ @@@@ @@@@@ @@@@@
64+
@@@@@ @@@@ @@@@@ @@@@ @@@@@ @@@@@ @@@@@ @@@@ @@@@ @@@@@ @@@@ @@@@@ @@@@@
65+
@@@@@ @@@@ @@@@@ @@@@ @@@@@ @@@@@ @@@@@ @@@@ @@@@ @@@@@ @@@@ @@@@@ @@@@@
66+
@@@@@@@@@@ @@@@@ @@@@ @@@@@ @@@@@ @@@@ @@@@ @@@@@ @@@@ @@@@@ @@@@@
67+
@@@@@@@@@@ @@@@@ @@@@ @@@@@ @@@@@ @@@@ @@@@ @@@@@ @@@@ @@@@@ @@@@@
68+
@@@@@ @@@@@ @@@@ @@@@@ @@@@@ @@@@ @@@@ @@@@@ @@@@ @@@@@ @@@@@
69+
@@@@@ @@@@ @@@@@ @@@@ @@@@@ @@@@@ @@@@ @@@@ @@@@@ @@@@ @@@@@ @@@@@
70+
@@@@@ @@@@ @@@@@ @@@@ @@@@@ @@@@@ @@@@ @@@@ @@@@@ @@@@ @@@@@ @@@@@
71+
@@@@@ @@@@ @@@@@ @@@@ @@@@@ @@@@@ @@@@ @@@@ @@@@@ @@@@ @@@@@ @@@@@
72+
@@@@@@@@@@ @@@@@ @@@@ @@@@@@@ @@@@@ @@@@@@@@@ @@@@@@@@@@ @@@@@@@@@@@
73+
@@@@@@@@@@ @@@@@ @@@@ @@@@@@@ @@@@@ @@@@@@@@@ @@@@@@@@@@ @@@@@@@@@@@
74+
@@@@@@ TEST
75+
@@@@@@ *NET
76+
@@@@@@ ENTROPY-CLI
77+
@@@@@@ COREv0.3.0
78+
6179
? Select Action (Use arrow keys)
6280
❯ Manage Accounts
81+
Entropy Faucet
6382
Balance
6483
Register
6584
Sign
@@ -69,36 +88,15 @@ The command-line interface (CLI) is the most straightforward way to interact wit
6988
Exit
7089
```
7190
72-
{{< callout type="info" >}}
73-
**Closing the CLI**: You can close the CLI tool anytime by pressing `CTRL` + `c`. This will halt the CLI process and return you to your normal terminal window.
74-
{{< /callout >}}
75-
76-
Next, you'll create an Entropy account.
77-
78-
## 2. Create an account
79-
80-
You need funds to interact with the Entropy network. Your funds are stored in an account. You can have multiple accounts.
81-
8291
1. Select **Manage Accounts**.
8392
1. Select **Create/Import Account**.
84-
1. Type `n` and press `ENTER` when asked _Would you like to import a key?_:
85-
86-
```output
87-
? Would you like to import a key? n
88-
```
89-
90-
1. Enter the name of your new account. The CLI will output some information about it:
93+
1. Type `n` and press `ENTER` when asked _Would you like to import your own seed?_:
9194
9295
```output
93-
New account:
94-
{
95-
name: MyFirstAccount
96-
address: 5HMnksPMRPqsDqyCj31VoQFgpiswsr12bk2YTyfMUEKCm2bv
97-
}
96+
? Would you like to import your own seed? (y/N) n
9897
```
9998
100-
Make a note of the `address` field. You'll need that in the next step.
101-
99+
1. Enter the name of your new account.
102100
1. Type `Y` and press `ENTER` to return to the main menu.
103101
104102
Next up, you'll request some funds to play around with.
@@ -107,20 +105,18 @@ Next up, you'll request some funds to play around with.
107105

108106
Funds for testing are available from the CLI's built-in faucet.
109107
110-
1. Navigate to **Manage Accounts** and then **Select Account**.
111-
1. Select the account you want to receive test funds.
112-
1. Go back the main TUI menu and select **Entropy Faucet**.
108+
1. Select **Entropy Faucet** from the main menu.
113109
114-
The CLI will request `2` test tokens from the Entropy network and forward them to your selected account. This equates to `20,000,000,000` bits, which is enough to perform transactions like registering an account and deploying a program.
110+
The CLI will request `2` test tokens from the Entropy network and send them to your selected account. This equates to `20,000,000,000` bits, which is enough to perform actions like registering an account, transferring funds, and deploying a program.
115111
116-
Once you have been sent some funds, you can check your balance in the CLI.
112+
```output
113+
⠧ Funding account…
114+
```
117115
118-
1. Return to the main menue and select **Balance**.
119-
1. The CLI should show your balance:
116+
1. Once you have been sent some funds, the CLI will output a success message:
120117
121118
```output
122-
? Select Action Balance
123-
Entropy Account [Andre] (5F3xmKa3WRkoHR4o6XjFQaWF2EskhtSh4ST5wY5cfsD9JYbC) has a balance of: 20,000,000,000 BITS
119+
Account: 5EFDfxft4oZYvjj35TWttFkkKZSHUDVnBRmp3eMQQcpt9zku has been successfully funded with 20,000,000,000 BITS
124120
```
125121
126122
Next, you'll register your account on the Entropy network.
@@ -129,7 +125,7 @@ Next, you'll register your account on the Entropy network.
129125

130126
Registering an account is a feature unique to Entropy. Without going into too much detail, it advertises to the network that you own _this_ account and that you're ready to start signing things.
131127
132-
1. Back at the main menu within the CLI, select **Register**:
128+
1. Back at the main menu, select **Register**:
133129
134130
```output
135131
? Select Action
@@ -146,8 +142,8 @@ Registering an account is a feature unique to Entropy. Without going into too mu
146142
1. The CLI will send your selected account information to the network. The network will then register your account as long as you have enough funds.
147143
148144
```output
149-
Attempting to register the address: 5Dcps2RdXPQfiJBxxDnrF8iDzDHcnZC8rb5mcJ3xicqzhYbv
150-
Your address 5Dcps2RdXPQfiJBxxDnrF8iDzDHcnZC8rb5mcJ3xicqzhYbv has been successfully registered.
145+
Attempting to register the address: 5EFDfxft4oZYvjj35TWttFkkKZSHUDVnBRmp3eMQQcpt9zku
146+
Your address 5EFDfxft4oZYvjj35TWttFkkKZSHUDVnBRmp3eMQQcpt9zku has been successfully registered.
151147
```
152148
153149
1. Press `Y` to go back to the main menu.
@@ -170,21 +166,29 @@ Next up, we'll attempt to get a signature from the network!
170166
Exit
171167
```
172168

173-
1. Select **Sign With Adapter**.
174-
1. Select **Text Input**.
175169
1. The CLI will prompt you to enter a message in the default terminal-based text editor on your system:
176170

177171
```output
178172
? Enter the message you wish to sign (this will open your default editor): Press <enter> to launch your preferred editor.
179173
```
180174

175+
{{< callout "info" >}}
176+
You can set your terminal's preferred editor by changing the `EDITOR` environment variable:
177+
178+
```shell
179+
# Set default text-editor to Neovim.
180+
export EDITOR='nvim'
181+
```
182+
{{< /callout >}}
183+
181184
1. Press `ENTER` to open a text editor.
182185
1. Within your text editor, enter a message. It doesn't matter what the message is at this point.
183186
1. Once you have finished entering your message into the text editor, save and quit the text editor.
184-
1. The CLI will output a `base64` encoded string:
187+
1. The CLI will output the verifying key used to sign the message and the signature of the message itself:
185188

186189
```output
187-
signature: 0x4dc30d4b250900148b1facd054fdc611bd1c4103bf20409bf57fa04db5ba8fd00515ef9c497223e174ebad2bf69830997256c4081868b9f7f4b1f729eb8662ad00
190+
verifying key: 0x03aee03ad9862e9f31d06f7d1b4b388ad1c66152ad17f919fc16fcc75929b08db3
191+
signature: 0xe78fce90707f824530677ba91ef90d3be4418da3eb10b3233709553b4355f1973b21e88d285e04ba323c8fe0d079a4f027c840a23cc57590371d57c95ed9eaa901
188192
```
189193

190194
Congratulations! You just received a signature from the Entropy network using the CLI!
@@ -194,4 +198,3 @@ So, what was all that about? While this quickstart guide didn't go into much det
194198
## Next steps
195199
196200
There's much more to come from Entropy! Next, you should check out the [Entrosplainer]({{< relref "./entrosplainer.md" >}}), an end-to-end explanation of what Entropy is, why it's necessary, and how it works!
197-

0 commit comments

Comments
 (0)