chore: CRP-2823 minor refactoring for dev docs (#138)

- Omit root from root IBE public key. 
- Reorganize timelock example to show as less use case related info as
possible for decryption.

Author: altkdf

examples/basic_ibe/backend/backend.did

@@ -10,9 +10,9 @@ type SendMessageRequest = record {
   receiver : principal;
 };
 service : (text) -> {
+  get_ibe_public_key : () -> (blob);
   get_my_encrypted_ibe_key : (blob) -> (blob);
   get_my_messages : () -> (Inbox) query;
-  get_root_ibe_public_key : () -> (blob);
   remove_my_message_by_index : (nat64) -> (Result);
   send_message : (SendMessageRequest) -> (Result);
 }

examples/basic_ibe/backend/src/lib.rs

@@ -68,7 +68,7 @@ fn send_message(request: SendMessageRequest) -> Result<(), String> {
 }
 
 #[update]
-async fn get_root_ibe_public_key() -> VetKeyPublicKey {
+async fn get_ibe_public_key() -> VetKeyPublicKey {
     let request = VetKDPublicKeyArgs {
         canister_id: None,
         context: DOMAIN_SEPARATOR.as_bytes().to_vec(),

examples/basic_ibe/frontend/src/main.ts

@@ -17,7 +17,6 @@ import {
 import { AuthClient } from "@dfinity/auth-client";
 import type { ActorSubclass } from "@dfinity/agent";
 
-// Store the IBE key in memory
 let ibePrivateKey: VetKey | undefined = undefined;
 let ibePublicKey: DerivedPublicKey | undefined = undefined;
 let myPrincipal: Principal | undefined = undefined;
@@ -47,11 +46,10 @@ function getBasicIbeCanister(): ActorSubclass<_SERVICE> {
     return basicIbeCanister;
 }
 
-// Get the root IBE public key
-async function getRootIbePublicKey(): Promise<DerivedPublicKey> {
+async function getIbePublicKey(): Promise<DerivedPublicKey> {
     if (ibePublicKey) return ibePublicKey;
     ibePublicKey = DerivedPublicKey.deserialize(
-        new Uint8Array(await getBasicIbeCanister().get_root_ibe_public_key()),
+        new Uint8Array(await getBasicIbeCanister().get_ibe_public_key()),
     );
     return ibePublicKey;
 }
@@ -60,7 +58,7 @@ async function encrypt(
     cleartext: Uint8Array,
     receiver: Principal,
 ): Promise<Uint8Array> {
-    const publicKey = await getRootIbePublicKey();
+    const publicKey = await getIbePublicKey();
     const ciphertext = IbeCiphertext.encrypt(
         publicKey,
         IbeIdentity.fromPrincipal(receiver),
@@ -70,7 +68,6 @@ async function encrypt(
     return ciphertext.serialize();
 }
 
-// Get the user's encrypted IBE key
 async function getMyIbePrivateKey(): Promise<VetKey> {
     if (ibePrivateKey) return ibePrivateKey;
 
@@ -85,7 +82,7 @@ async function getMyIbePrivateKey(): Promise<VetKey> {
         );
         ibePrivateKey = new EncryptedVetKey(encryptedKey).decryptAndVerify(
             transportSecretKey,
-            await getRootIbePublicKey(),
+            await getIbePublicKey(),
             new Uint8Array(myPrincipal.toUint8Array()),
         );
         return ibePrivateKey;
@@ -99,7 +96,6 @@ async function decryptMessage(encryptedMessage: Uint8Array): Promise<string> {
     return new TextDecoder().decode(plaintext);
 }
 
-// Send a message
 async function sendMessage() {
     const message = prompt("Enter your message:");
     if (!message) throw Error("Message is required");

examples/basic_ibe/src/declarations/basic_ibe/basic_ibe.did

@@ -10,9 +10,9 @@ type SendMessageRequest = record {
   receiver : principal;
 };
 service : (text) -> {
+  get_ibe_public_key : () -> (blob);
   get_my_encrypted_ibe_key : (blob) -> (blob);
   get_my_messages : () -> (Inbox) query;
-  get_root_ibe_public_key : () -> (blob);
   remove_my_message_by_index : (nat64) -> (Result);
   send_message : (SendMessageRequest) -> (Result);
 }

examples/basic_ibe/src/declarations/basic_ibe/basic_ibe.did.d.ts

@@ -15,12 +15,12 @@ export interface SendMessageRequest {
   'receiver' : Principal,
 }
 export interface _SERVICE {
+  'get_ibe_public_key' : ActorMethod<[], Uint8Array | number[]>,
   'get_my_encrypted_ibe_key' : ActorMethod<
     [Uint8Array | number[]],
     Uint8Array | number[]
   >,
   'get_my_messages' : ActorMethod<[], Inbox>,
-  'get_root_ibe_public_key' : ActorMethod<[], Uint8Array | number[]>,
   'remove_my_message_by_index' : ActorMethod<[bigint], Result>,
   'send_message' : ActorMethod<[SendMessageRequest], Result>,
 }

examples/basic_ibe/src/declarations/basic_ibe/basic_ibe.did.js

@@ -11,13 +11,13 @@ export const idlFactory = ({ IDL }) => {
     'receiver' : IDL.Principal,
   });
   return IDL.Service({
+    'get_ibe_public_key' : IDL.Func([], [IDL.Vec(IDL.Nat8)], []),
     'get_my_encrypted_ibe_key' : IDL.Func(
         [IDL.Vec(IDL.Nat8)],
         [IDL.Vec(IDL.Nat8)],
         [],
       ),
     'get_my_messages' : IDL.Func([], [Inbox], ['query']),
-    'get_root_ibe_public_key' : IDL.Func([], [IDL.Vec(IDL.Nat8)], []),
     'remove_my_message_by_index' : IDL.Func([IDL.Nat64], [Result], []),
     'send_message' : IDL.Func([SendMessageRequest], [Result], []),
   });

examples/basic_timelock_ibe/backend/backend.did

@@ -20,8 +20,8 @@ type Result = variant { Ok : nat; Err : text };
 type Result_1 = variant { Ok; Err : text };
 service : (text) -> {
   create_lot : (text, text, nat16) -> (Result);
+  get_ibe_public_key : () -> (blob);
   get_lots : () -> (OpenLotsResponse, ClosedLotsResponse) query;
-  get_root_ibe_public_key : () -> (blob);
   place_bid : (nat, blob) -> (Result_1);
-  start_with_interval_secs : (nat64) -> ();
+  start_lot_closing_timer_job_with_interval_secs : (nat64) -> ();
 }