Skip to content

Commit

Permalink
apply codereview
Browse files Browse the repository at this point in the history
  • Loading branch information
jessiemongeon1 committed Dec 19, 2024
1 parent e876b1a commit 17d0ac3
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 9 deletions.
6 changes: 3 additions & 3 deletions motoko/encrypted-notes-dapp-vetkd/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ This example requires an installation of:
- [x] Clone the example dapp project: `git clone https://github.com/dfinity/examples`

## Step 1: Choose which implementation to use by setting a respective environment variable.

For **Motoko** deployment use:

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

> ![TIP]
> [!TIP]
> 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).

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

> ![TIP]
> [!TIP]
> If you have multiple `dfx` identities set up, ensure you are using the identity you intend to use with the `--identity` flag.
1. To install and deploy a canister run:
Expand Down
13 changes: 9 additions & 4 deletions motoko/threshold-schnorr/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,24 +39,29 @@ Begin by opening a terminal window.

## Step 1: Setup the project environment

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

```bash
cd examples/motoko/threshold-schnorr
dfx start --background
```

#### What this does
- `dfx start --background` starts a local instance of the IC via the IC SDK

## Step 2: Deploy the canisters

```bash
make deploy
```

To test (includes deploying):
```bash
cd examples/motoko/threshold-schnorr
dfx start --background
npm install @noble/curves
make test
```

#### What this does
- `dfx start --background` starts a local instance of the IC via the IC SDK
- `make deploy` deploys the canister code on the local version of the IC
- `npm install @noble/curves` installs a test javascript dependency
- `make test` deploys and tests the canister code on the local version of the IC
Expand Down
2 changes: 1 addition & 1 deletion motoko/token_transfer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ URLs:

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

> ![TIP]
> [!TIP]
> [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).
````bash
Expand Down
2 changes: 1 addition & 1 deletion motoko/token_transfer_from/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ URLs:

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

> ![TIP]
> [!TIP]
> [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).
````bash
Expand Down
4 changes: 4 additions & 0 deletions motoko/vetkd/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,14 @@ Additionally, the repository provides:

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.

---

## Disclaimer

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).

---

### Prerequisites
This example requires an installation of:

Expand Down

0 comments on commit 17d0ac3

Please sign in to comment.