Skip to content

Commit 17d0ac3

Browse files
apply codereview
1 parent e876b1a commit 17d0ac3

File tree

5 files changed

+18
-9
lines changed

5 files changed

+18
-9
lines changed

motoko/encrypted-notes-dapp-vetkd/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ This example requires an installation of:
2424
- [x] Clone the example dapp project: `git clone https://github.com/dfinity/examples`
2525

2626
## Step 1: Choose which implementation to use by setting a respective environment variable.
27-
27+
2828
For **Motoko** deployment use:
2929

3030
```sh
@@ -50,13 +50,13 @@ _Note_: see [Troubleshooting](#troubleshooting) in case of problems.
5050
dfx start --clean
5151
```
5252

53-
> ![TIP]
53+
> [!TIP]
5454
> If you see an error `Failed to set socket of tcp builder to 0.0.0.0:8000`, make sure that the port `8000` is not occupied, e.g., by the previously run Docker command (you might want to stop the Docker daemon whatsoever for this step).
5555
5656

5757
## Step 5: Install a local [Internet Identity (II)](https://wiki.internetcomputer.org/wiki/What_is_Internet_Identity) canister:
5858

59-
> ![TIP]
59+
> [!TIP]
6060
> If you have multiple `dfx` identities set up, ensure you are using the identity you intend to use with the `--identity` flag.
6161
6262
1. To install and deploy a canister run:

motoko/threshold-schnorr/README.md

+9-4
Original file line numberDiff line numberDiff line change
@@ -39,24 +39,29 @@ Begin by opening a terminal window.
3939

4040
## Step 1: Setup the project environment
4141

42-
Navigate into the folder containing the project's files, start a local instance of the Internet Computer and deploy the project with the commands:
42+
Navigate into the folder containing the project's files, start a local instance of the Internet Computer and with the commands:
4343

4444
```bash
4545
cd examples/motoko/threshold-schnorr
4646
dfx start --background
47+
```
48+
49+
#### What this does
50+
- `dfx start --background` starts a local instance of the IC via the IC SDK
51+
52+
## Step 2: Deploy the canisters
53+
54+
```bash
4755
make deploy
4856
```
4957

5058
To test (includes deploying):
5159
```bash
52-
cd examples/motoko/threshold-schnorr
53-
dfx start --background
5460
npm install @noble/curves
5561
make test
5662
```
5763

5864
#### What this does
59-
- `dfx start --background` starts a local instance of the IC via the IC SDK
6065
- `make deploy` deploys the canister code on the local version of the IC
6166
- `npm install @noble/curves` installs a test javascript dependency
6267
- `make test` deploys and tests the canister code on the local version of the IC

motoko/token_transfer/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ URLs:
137137

138138
## Step 7: Verify that the ledger canister is healthy and working as expected by using the command
139139

140-
> ![TIP]
140+
> [!TIP]
141141
> [Learn more about how to interact with the ICRC-1 ledger](https://internetcomputer.org/docs/current/developer-docs/defi/icrc-1/using-icrc1-ledger#icrc-1-and-icrc-1-extension-endpoints).
142142
143143
````bash

motoko/token_transfer_from/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ URLs:
151151

152152
## Step 7: Verify that the ledger canister is healthy and working as expected by using the command
153153

154-
> ![TIP]
154+
> [!TIP]
155155
> [Learn more about how to interact with the ICRC-1 ledger](https://internetcomputer.org/docs/current/developer-docs/defi/icrc-1/using-icrc1-ledger#icrc-1-and-icrc-1-extension-endpoints).
156156
157157
````bash

motoko/vetkd/README.md

+4
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,14 @@ Additionally, the repository provides:
1111

1212
Because the `ic-vetkd-utils` are not yet published as NPM package at [npmjs.com](https://npmjs.com), a respective package file (`ic-vetkd-utils-0.1.0.tgz`) is included in this repository.
1313

14+
---
15+
1416
## Disclaimer
1517

1618
The implementation of [the proposed vetKD system API](https://github.com/dfinity/interface-spec/pull/158) used in this example is **unsafe**, e.g., we hard-code a master secret key, rather than using a master secret key that is distributed among sufficiently many Internet Computer nodes through distributed key generation. **Do not use this in production or for sensitive data**! This example is solely provided **for demonstration purposes** to collect feedback on the mentioned vetKD system API. See also the respective disclaimer [in the system API canister implementation](https://github.com/dfinity/examples/blob/master/rust/vetkd/src/system_api/src/lib.rs#L19-L26).
1719

20+
---
21+
1822
### Prerequisites
1923
This example requires an installation of:
2024

0 commit comments

Comments
 (0)