Skip to content

Commit cbcbccb

Browse files
Merge pull request #519 from ProvableHQ/gh-issue-cleanup-Oct25
Fixing various issues from Github
2 parents 37135a4 + df452a9 commit cbcbccb

25 files changed

+255
-3115
lines changed

β€Ždocumentation/cli/01_account.mdβ€Ž

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ We urge you to exercise caution when managing your private keys. `leo account` c
1717
* [`import`](#leo-account-import) - Derive and Aleo account from a private key.
1818
* [`sign`](#leo-account-sign) - Sign a message using your Aleo private key.
1919
* [`verify`](#leo-account-verify) - Verify a message and signature from an Aleo address.
20+
* [`decrypt`](#leo-account-decrypt) - Decrypt record ciphertexts using your Aleo private key or view key.
2021

2122
 
2223

@@ -174,3 +175,42 @@ Specifies the message that was signed.
174175
#### `-r`
175176
Parses the message as bytes instead of Aleo literals.
176177

178+
179+
180+
## `leo account decrypt`
181+
182+
[Back to Top](#subcommands)
183+
184+
Use this command to decrypt a record ciphertext using your Aleo private key or view key.
185+
186+
To decrypt a record ciphertext using your private key, run the following command
187+
```bash
188+
leo account decrypt --ciphertext <CIPHERTEXT> -k <KEY>
189+
```
190+
where `<CIPHERTEXT>` is the ciphertext of a record, and `<KEY>` is private key of the record's owner.
191+
192+
Optionally, you can specify a path to a file containing the key rather than the key itself:
193+
```bash
194+
leo account decrypt --ciphertext <CIPHERTEXT> -f <PATH_TO_KEYFILE>
195+
```
196+
197+
If you do not specify either the key or key file, the CLI will attempt use the `PRIVATE_KEY` and `VIEW_KEY` environment variables.
198+
199+
If the private key does not correspond to the owner of the record, the decryption will fail.
200+
201+
### Flags:
202+
#### `-c <CIPHERTEXT>`
203+
:::info
204+
This flag is required!
205+
:::
206+
Specifies the record ciphertext to decrypt.
207+
208+
#### `-k <KEY>`
209+
Specifies the private key or view key to use for decryption. This will raise an error if you also pass the `-f` flag.
210+
211+
#### `-f <KEY_FILE>`
212+
Specifies the path to a file containing the private key or view key. This will raise an error if you also pass the `-k` flag.
213+
214+
#### `--network <NETWORK>`
215+
Specifies the network to deploy to. Overrides any `NETWORK` environment variable set manually or in a `.env` file. Valid network names are `testnet`, `mainnet`, and `canary`.
216+

β€Ždocumentation/cli/06_deploy.mdβ€Ž

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,13 +87,13 @@ Specifies the network to deploy to. Overrides any `NETWORK` environment variable
8787
The endpoint to deploy to. Overrides any `ENDPOINT` environment variable set manually or in a `.env` file.
8888

8989
**Common Endpoints:**
90-
90+
<!-- markdown-link-check-disable -->
9191
| Network | Endpoint |
9292
|:---------:|:------:|
9393
| Devnet (local) | https://localhost:3030 |
9494
| Testnet | https://api.explorer.provable.com/v1|
9595
| Mainnet | https://api.explorer.provable.com/v1|
96-
96+
<!-- markdown-link-check-enable -->
9797

9898
#### `--devnet`
9999
Specifies whether the network being deployed to is a devnet. If not set, defaults to the `DEVNET` environment variable.

β€Ždocumentation/cli/07_devnet.mdβ€Ž

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,11 @@ sidebar_label: Devnet
1010
:::tip
1111
Use this command to initialize a local devnet
1212
:::
13-
13+
<!-- markdown-link-check-disable -->
1414
:::info
1515
The default ENDPOINT for a local devnet is `http://localhost:3030`
1616
:::
17+
<!-- markdown-link-check-enable -->
1718

1819
To intialize a local devnet, run the following command:
1920
```bash
@@ -36,10 +37,10 @@ Specifies which features of snarkOS to use (e.g. `test_network`)
3637

3738
#### `--install`
3839
Installs (or reinstalls) snarkOS at the provided `--snarkos` path with the given `--snarkos-features`.
39-
40+
<!-- markdown-link-check-disable -->
4041
#### `--snarkos-version <SNARKOS_VERSION>`
4142
Specifies which version of snarkOS to use or install. Defaults to latest version on [crates.io](https://crates.io/crates/snarkos)
42-
43+
<!-- markdown-link-check-enable -->
4344
#### `--consensus-heights <CONSENSUS_HEIGHTS> `
4445
Optional blocks heights to use for each successive consensus upgrade. Must have `--snarkos-features test_network` enabled as well.
4546

β€Ždocumentation/cli/08_execute.mdβ€Ž

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -88,14 +88,13 @@ Specifies the network to deploy to. Overrides any `NETWORK` environment variable
8888
The endpoint to deploy to. Overrides any `ENDPOINT` environment variable set manually or in a `.env` file.
8989

9090
**Common Endpoints:**
91-
91+
<!-- markdown-link-check-disable -->
9292
| Network | Endpoint |
9393
|:---------:|:------:|
9494
| Devnet (local) | https://localhost:3030 |
9595
| Testnet | https://api.explorer.provable.com/v1|
9696
| Mainnet | https://api.explorer.provable.com/v1|
97-
98-
97+
<!-- markdown-link-check-enable -->
9998
#### `--devnet`
10099
Specifies whether the network being deployed to is a devnet. If not set, defaults to the `DEVNET` environment variable.
101100

β€Ždocumentation/cli/15_upgrade.mdβ€Ž

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,13 @@ Specifies the network to deploy to. Overrides any `NETWORK` environment variable
2323
The endpoint to deploy to. Overrides any `ENDPOINT` environment variable set manually or in a `.env` file.
2424

2525
**Common Endpoints:**
26-
26+
<!-- markdown-link-check-disable -->
2727
| Network | Endpoint |
2828
|:---------:|:------:|
2929
| Devnet (local) | https://localhost:3030 |
3030
| Testnet | https://api.explorer.provable.com/v1|
3131
| Mainnet | https://api.explorer.provable.com/v1|
32-
32+
<!-- markdown-link-check-enable -->
3333

3434
#### `--devnet`
3535
Specifies whether the network being deployed to is a devnet. If not set, defaults to the `DEVNET` environment variable.

β€Ždocumentation/deprecated/sdk/00_sdk_overview.mdβ€Ž

Lines changed: 0 additions & 98 deletions
This file was deleted.

β€Ždocumentation/deprecated/sdk/python/00_aleo_sdk.mdβ€Ž

Lines changed: 0 additions & 62 deletions
This file was deleted.

β€Ždocumentation/deprecated/sdk/python/01_zkml_transpiler.mdβ€Ž

Lines changed: 0 additions & 85 deletions
This file was deleted.

0 commit comments

Comments
Β (0)