From dfd24be79f39d1ef49eaa2a6eb06d190ef06d669 Mon Sep 17 00:00:00 2001 From: Jessie Mongeon Date: Wed, 31 Jan 2024 13:23:52 -0600 Subject: [PATCH 1/2] VetKD revisions --- .../integrations/vetkeys/index.md | 6 ++-- .../{using-vetkeys.md => using-vetkeys.mdx} | 29 +++++++++++-------- 2 files changed, 20 insertions(+), 15 deletions(-) rename docs/developer-docs/integrations/vetkeys/{using-vetkeys.md => using-vetkeys.mdx} (69%) diff --git a/docs/developer-docs/integrations/vetkeys/index.md b/docs/developer-docs/integrations/vetkeys/index.md index 49d7a895a5..9e2ae55288 100644 --- a/docs/developer-docs/integrations/vetkeys/index.md +++ b/docs/developer-docs/integrations/vetkeys/index.md @@ -1,15 +1,15 @@ # Overview -The vetKeys feature is in ongoing development on the Internet Computer Protocol (ICP). It stands for ‘Verifiable Encrypted Threshold Keys’ and enables a number of cryptographic functionalities on ICP. The primary motivation for vetKeys is to facilitate onchain encryption, as such the primer is focused with that example in mind. . +The vetKeys feature is in ongoing development on ICP. It stands for ‘Verifiable Encrypted Threshold Keys’ and enables a number of cryptographic functionalities on ICP. The primary motivation for vetKeys is to facilitate on-chain encryption, as such the primer is focused with that example in mind. -To dive into the technical overview, please refer to the: +To dive into the technical overview, please refer to: - [vetKeys technology overview](technology-overview.md). - [vetKeys primer](https://internetcomputer.org/blog/features/vetkey-primer). ## Using vetKeys -As this feature is still in development, a brief demo for using the API exists. Instructions for this demo can be found [here](using-vetkeys.md). +As this feature is still in development, a [brief demo for using the API exists](using-vetkeys.md). ## References - [Forum post](https://forum.dfinity.org/t/threshold-key-derivation-privacy-on-the-ic/16560). diff --git a/docs/developer-docs/integrations/vetkeys/using-vetkeys.md b/docs/developer-docs/integrations/vetkeys/using-vetkeys.mdx similarity index 69% rename from docs/developer-docs/integrations/vetkeys/using-vetkeys.md rename to docs/developer-docs/integrations/vetkeys/using-vetkeys.mdx index 50c8b46fc1..e61e16145e 100644 --- a/docs/developer-docs/integrations/vetkeys/using-vetkeys.md +++ b/docs/developer-docs/integrations/vetkeys/using-vetkeys.mdx @@ -1,8 +1,11 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + # vetKeys API demo ## Overview -This demo provides a canister (`src/system_api`) that offers the vetKD system API proposed in https://github.com/dfinity/interface-spec/pull/158, implemented demonstration, testing, and initial devlopment purposes. We stress that it does not offer security yet as no threshold cryptography is used yet to secure the key. +This demo provides a canister (`src/system_api`) that offers the [proposed vetKD system API](https://github.com/dfinity/interface-spec/pull/158), implemented demonstration, testing, and initial development purposes. We stress that it does not offer security yet as no threshold cryptography is used yet to secure the key. This demo uses files found in [this repository](https://github.com/dfinity/examples/tree/master/rust/vetkd). @@ -15,39 +18,41 @@ This demo uses files found in [this repository](https://github.com/dfinity/examp ### Step 1: Begin by cloning the Github repository containing this project: -``` -git clone https://github.com/dfinity/examples/ -``` - -Then navigate into the directory specifically for this project: - -For Motoko deployment: + + ``` +git clone https://github.com/dfinity/examples/ cd examples/motoko/vetkd ``` -For Rust deployment: + + + ``` +git clone https://github.com/dfinity/examples/ cd examples/rust/vetkd ``` + + + ### Step 2: Then, start a local instance of the Internet Computer: ```sh dfx start --clean --background ``` -### Step 3: Ensure the Canister SDK (dfx) uses the canister IDs that are hard-coded in the Rust source code: +### Step 3: Ensure the dfx uses the canister IDs that are hard-coded in the source code: ```sh dfx canister create system_api --specified-id s55qq-oqaaa-aaaaa-aaakq-cai ``` -Without this, the Canister SDK (dfx) may use different canister IDs for the `system_api` and `app_backend` canisters in your local environment. +Without this, the dfx may use different canister IDs for the `system_api` and `app_backend` canisters. -### Step 4: Ensure that the required node modules are available in your project directory, if needed, by running the following command: +### Step 4: Ensure that the required node modules are available in your project directory: ```sh npm install From f7c30d1416e08b58b172fdbb1c59050089c19806 Mon Sep 17 00:00:00 2001 From: Jessie Mongeon <133128541+jessiemongeon1@users.noreply.github.com> Date: Wed, 31 Jan 2024 15:23:44 -0600 Subject: [PATCH 2/2] Update index.md --- docs/developer-docs/integrations/vetkeys/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/developer-docs/integrations/vetkeys/index.md b/docs/developer-docs/integrations/vetkeys/index.md index 9e2ae55288..93a2286e55 100644 --- a/docs/developer-docs/integrations/vetkeys/index.md +++ b/docs/developer-docs/integrations/vetkeys/index.md @@ -9,7 +9,7 @@ To dive into the technical overview, please refer to: ## Using vetKeys -As this feature is still in development, a [brief demo for using the API exists](using-vetkeys.md). +As this feature is still in development, a [brief demo for using the API exists](using-vetkeys.mdx). ## References - [Forum post](https://forum.dfinity.org/t/threshold-key-derivation-privacy-on-the-ic/16560).