diff --git a/motoko/encrypted-notes-dapp-vetkd/README.md b/motoko/encrypted-notes-dapp-vetkd/README.md index 1c2ecec80..fa94ca70e 100644 --- a/motoko/encrypted-notes-dapp-vetkd/README.md +++ b/motoko/encrypted-notes-dapp-vetkd/README.md @@ -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 @@ -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: diff --git a/motoko/threshold-schnorr/README.md b/motoko/threshold-schnorr/README.md index f4ae0c23b..6d3d3521e 100644 --- a/motoko/threshold-schnorr/README.md +++ b/motoko/threshold-schnorr/README.md @@ -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 diff --git a/motoko/token_transfer/README.md b/motoko/token_transfer/README.md index 95ad249d8..e22559f42 100644 --- a/motoko/token_transfer/README.md +++ b/motoko/token_transfer/README.md @@ -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 diff --git a/motoko/token_transfer_from/README.md b/motoko/token_transfer_from/README.md index 0bc1270f4..ee7e34874 100644 --- a/motoko/token_transfer_from/README.md +++ b/motoko/token_transfer_from/README.md @@ -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 diff --git a/motoko/vetkd/README.md b/motoko/vetkd/README.md index a7c5a5be1..764e30862 100644 --- a/motoko/vetkd/README.md +++ b/motoko/vetkd/README.md @@ -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: