refactor: improve variable namings

apps/dashboard-for-dapps/src/routes/index.tsx

@@ -74,7 +74,7 @@ const useFetchGrants = () => {
     queryKey: ["grants"],
     queryFn: () =>
       idOS.grants.list({
-        grantee: address,
+        granteeAddress: address,
       }),
     select: (data) =>
       data.map((grant) => ({
@@ -331,7 +331,6 @@ function CredentialDetails({
                         <List.Item
                           flexShrink="0"
                           key={key}
-                          role="button"
                           transition="transform 0.2s"
                           cursor="pointer"
                           _hover={{ transform: "scale(1.02)" }}
@@ -424,7 +423,7 @@ function SearchResults({ results }: { results: GrantsWithFormattedLockedUntil })
               pt="4"
               grow
               label="Owner"
-              value={grant.owner}
+              value={grant.ownerAddress}
               truncate
             />
             <DataListItem
@@ -439,7 +438,7 @@ function SearchResults({ results }: { results: GrantsWithFormattedLockedUntil })
               pt="4"
               grow
               label="Grantee"
-              value={grant.grantee}
+              value={grant.granteeAddress}
               truncate
             />
             <DataListItem

apps/idos-data-dashboard/src/core/idos/idos-provider.tsx

@@ -62,7 +62,7 @@ export const Provider = ({ children }: PropsWithChildren) => {
     if (profile) {
       // @ts-expect-error
       await _sdk.setSigner(signer.type, signer.value);
-      const _pk = _sdk.auth.currentUser.publicKey;
+      const _pk = _sdk.auth.currentUser.currentUserPublicKey;
 
       setPublicKey(_pk);
     }

apps/idos-data-dashboard/src/routes/dashboard/credentials/components/delete-credential.tsx

@@ -142,7 +142,7 @@ export const DeleteCredential = ({ isOpen, credential, onClose }: DeleteCredenti
   if (!credential) return null;
 
   const [currentToRevoke] = state;
-  const { grantee } = currentToRevoke ?? {};
+  const { granteeAddress } = currentToRevoke ?? {};
 
   const meta = JSON.parse(credential.public_notes);
 
@@ -172,7 +172,7 @@ export const DeleteCredential = ({ isOpen, credential, onClose }: DeleteCredenti
               <>
                 <Text mb={1}>Revoking grant for grantee:</Text>
                 <Code px={2} py={1} rounded="md" fontSize="sm" bg="neutral.800">
-                  {grantee}
+                  {granteeAddress}
                 </Code>
               </>
             ) : deleteCredential.isPending ? (

apps/idos-data-dashboard/src/routes/dashboard/credentials/components/grants-center.tsx

@@ -34,8 +34,8 @@ type GrantsCenterProps = {
 };
 
 function generateGrantId(grant: idOSGrant): string {
-  const { dataId, grantee, owner, lockedUntil } = grant;
-  return [dataId, grantee, owner, lockedUntil].join("-");
+  const { dataId, granteeAddress, ownerAddress, lockedUntil } = grant;
+  return [dataId, granteeAddress, ownerAddress, lockedUntil].join("-");
 }
 
 function timelockToMs(timelock: number): number {
@@ -96,7 +96,7 @@ const Shares = ({ credentialId, grants }: { credentialId: string; grants: idOSGr
                 data-grant={JSON.stringify(grant)}
               >
                 <Td maxW={140}>
-                  <Text isTruncated>{grant.grantee}</Text>
+                  <Text isTruncated>{grant.granteeAddress}</Text>
                 </Td>
                 <Td>
                   <Text>{grant.lockedUntil ? timelockToDate(grant.lockedUntil) : "-"}</Text>

apps/idos-data-dashboard/src/routes/dashboard/credentials/shared/index.ts

@@ -9,11 +9,11 @@ export const useFetchGrants = ({ credentialId }: { credentialId: string }) => {
   const queryClient = useQueryClient();
   const credentials = queryClient.getQueryData<idOSCredentialWithShares[]>(["credentials"]);
 
-  const owner = address?.includes("0x") ? address : publicKey;
+  const ownerAddress = address?.includes("0x") ? address : publicKey;
 
   return useQuery({
     queryKey: ["grants", credentialId],
-    queryFn: () => sdk.grants.list({ owner }),
+    queryFn: () => sdk.grants.list({ ownerAddress }),
     retry: 1,
     select(grants) {
       if (!credentials || !grants) return [];
@@ -34,8 +34,8 @@ export const useRevokeGrant = () => {
   const queryClient = useQueryClient();
 
   return useMutation<{ transactionId: string }, DefaultError, idOSGrant, Ctx>({
-    mutationFn: ({ grantee, dataId, lockedUntil }: idOSGrant) =>
-      sdk.grants.revoke("credentials", dataId, grantee, dataId, lockedUntil),
+    mutationFn: ({ granteeAddress, dataId, lockedUntil }: idOSGrant) =>
+      sdk.grants.revoke("credentials", dataId, granteeAddress, dataId, lockedUntil),
     mutationKey: ["revokeGrant"],
     async onMutate(grant) {
       const previousCredentials =

apps/idos-enclave/src/lib/enclave.js

@@ -48,10 +48,10 @@ export class Enclave {
     });
   }
 
-  storage(humanId, signerAddress, signerPublicKey, expectedUserEncryptionPublicKey) {
+  storage(humanId, signerAddress, signerEncryptionPublicKey, expectedUserEncryptionPublicKey) {
     humanId && this.store.set("human-id", humanId);
     signerAddress && this.store.set("signer-address", signerAddress);
-    signerPublicKey && this.store.set("signer-public-key", signerPublicKey);
+    signerEncryptionPublicKey && this.store.set("signer-public-key", signerEncryptionPublicKey);
 
     const litAttrs = this.store.get("litAttrs");
     this.handlstoreableAttributes(litAttrs);
@@ -248,10 +248,6 @@ export class Enclave {
     }
   }
 
-  messageParent(message) {
-    window.parent.postMessage(message, this.parentOrigin);
-  }
-
   async filterCredentialsByCountries(credentials, countries) {
     const decrypted = await Promise.all(
       credentials.map(async (credential) => ({
@@ -329,7 +325,7 @@ export class Enclave {
           receiverPublicKey,
           senderPublicKey,
           signerAddress,
-          signerPublicKey,
+          signerEncryptionPublicKey,
           mode,
           theme,
           credentials,
@@ -352,7 +348,7 @@ export class Enclave {
           storage: () => [
             humanId,
             signerAddress,
-            signerPublicKey,
+            signerEncryptionPublicKey,
             expectedUserEncryptionPublicKey,
             litAttrs,
             userWallets,

examples/idos-example-dapp/api/EVM.ts

@@ -19,7 +19,7 @@ const evmGranteeSigner = new ethers.Wallet(
 const idosGrantee = await idOSGrantee.init({
   chainType: "EVM",
   granteeSigner: evmGranteeSigner,
-  encryptionSecret: ENCRYPTION_SECRET_KEY,
+  encryptionPrivateKey: ENCRYPTION_SECRET_KEY,
 });
 
 const encryptionPublicKey = idosGrantee.encryptionPublicKey;

examples/idos-example-dapp/api/NEAR.ts

@@ -15,7 +15,7 @@ const nearGranteeSigner = KeyPair.fromString(NEAR_GRANTEE_PRIVATE_KEY);
 const idosGrantee = await idOSGrantee.init({
   chainType: "NEAR",
   granteeSigner: nearGranteeSigner,
-  encryptionSecret: ENCRYPTION_SECRET_KEY,
+  encryptionPrivateKey: ENCRYPTION_SECRET_KEY,
 });
 
 const encryptionPublicKey = idosGrantee.encryptionPublicKey;

examples/idos-example-dapp/src/main.js

@@ -282,7 +282,8 @@ const connectWallet = {
       .h1("eyes", "User's grants to this dApp")
       .wait(
         "awaiting RPC",
-        cache.get("grants") || idos.grants.list({ owner, grantee: granteeInfo.grantee }),
+        cache.get("grants") ||
+          idos.grants.list({ ownerAddress: owner, granteeAddress: granteeInfo.grantee }),
       );
     cache.set("grants", grants);
 

packages/idos-sdk-js/src/lib/auth.ts

@@ -14,8 +14,15 @@ import { implicitAddressFromPublicKey } from "./utils";
 
 export interface AuthUser {
   humanId: string | null;
-  address: string;
-  publicKey?: string;
+  userAddress: string;
+  /**
+   * The public key of the wallet that was used to sign the message.
+   * It's only available when the `signer` is a NEAR wallet.
+   */
+  nearWalletPublicKey?: string;
+  /**
+   * The derived public key of the user from the password / passkey.
+   */
   currentUserPublicKey?: string;
 }
 
@@ -72,7 +79,7 @@ export class Auth {
     this.user = {
       humanId: id,
       currentUserPublicKey: current_public_key,
-      address: currentAddress,
+      userAddress: currentAddress,
     };
   }
 
@@ -208,8 +215,8 @@ export class Auth {
     this.user = {
       humanId: id,
       currentUserPublicKey: current_public_key,
-      address: currentAddress,
-      publicKey,
+      userAddress: currentAddress,
+      nearWalletPublicKey: publicKey,
     };
   }
 }

packages/idos-sdk-js/src/lib/data.ts

@@ -78,18 +78,19 @@ export class Data {
     records: T[],
     synchronous?: boolean,
   ) {
-    let receiverPublicKey: string | undefined;
+    let recipientEncryptionPublicKey: string | undefined;
 
     if (tableName === "credentials") {
-      receiverPublicKey = receiverPublicKey ?? Base64Codec.encode(await this.enclave.ready());
+      recipientEncryptionPublicKey =
+        recipientEncryptionPublicKey ?? Base64Codec.encode(await this.enclave.ready());
       for (const record of records) {
         Object.assign(
           record,
           await this.#buildInsertableIDOSCredential(
             record.human_id,
             record.public_notes,
             record.content,
-            receiverPublicKey, // Encryption
+            recipientEncryptionPublicKey,
           ),
         );
       }
@@ -118,7 +119,7 @@ export class Data {
       tableName === "human_attributes" ? "attributes" : tableName,
     )}`;
 
-    let receiverPublicKey: string | undefined;
+    let recipientEncryptionPublicKey: string | undefined;
 
     const inputs: string[] = ((await this.kwilWrapper.schema) as AnyRecord).data.actions
       .find((action: AnyRecord) => action.name === name)
@@ -131,14 +132,14 @@ export class Data {
     }
 
     if (tableName === "credentials") {
-      receiverPublicKey ??= Base64Codec.encode(await this.enclave.ready());
+      recipientEncryptionPublicKey ??= Base64Codec.encode(await this.enclave.ready());
       Object.assign(
         record,
         await this.#buildInsertableIDOSCredential(
           (record as AnyRecord).human_id,
           (record as AnyRecord).public_notes,
           (record as AnyRecord).content,
-          receiverPublicKey, // Encryption
+          recipientEncryptionPublicKey,
         ),
       );
     }
@@ -259,21 +260,21 @@ export class Data {
     description?: string,
     synchronous?: boolean,
   ): Promise<T> {
-    if (!this.enclave.encryptionPublicKey) await this.enclave.ready();
+    if (!this.enclave.userEncryptionPublicKey) await this.enclave.ready();
 
-    let receiverPublicKey: string | undefined;
+    let recipientEncryptionPublicKey: string | undefined;
     // biome-ignore lint/suspicious/noExplicitAny: using any to avoid type errors for now.
     const record: any = recordLike;
 
     if (tableName === "credentials") {
-      receiverPublicKey ??= Base64Codec.encode(await this.enclave.ready());
+      recipientEncryptionPublicKey ??= Base64Codec.encode(await this.enclave.ready());
       Object.assign(
         record,
         await this.#buildInsertableIDOSCredential(
           record.human_id,
           record.public_notes,
           record.content,
-          receiverPublicKey, // Encryption
+          recipientEncryptionPublicKey,
         ),
       );
     }
@@ -291,7 +292,7 @@ export class Data {
   async share(
     tableName: string,
     recordId: string,
-    receiverPublicKey: string,
+    granteeEncryptionPublicKey: string,
     synchronous?: boolean,
   ): Promise<{ id: string }> {
     const name = this.singularize(tableName);
@@ -306,7 +307,7 @@ export class Data {
           record.human_id,
           "",
           record.content,
-          receiverPublicKey, // Encryption
+          granteeEncryptionPublicKey,
         ),
       );
     }
@@ -337,15 +338,15 @@ export class Data {
     return await this.delete(tableName, recordId, undefined, synchronous);
   }
 
-  async addWriteGrant(grantee: string, synchronous?: boolean) {
+  async addWriteGrant(granteeAddress: string, synchronous?: boolean) {
     return await this.kwilWrapper.execute(
       "add_write_grant",
       [
         {
-          wg_grantee: grantee,
+          wg_grantee: granteeAddress,
         },
       ],
-      `Grant ${grantee} write access to your idOS credentials`,
+      `Grant ${granteeAddress} write access to your idOS credentials`,
       synchronous,
     );
   }
@@ -354,8 +355,8 @@ export class Data {
     return await this.kwilWrapper.call("has_write_grant_given_by", { human_id: humanId });
   }
 
-  async hasWriteGrantGivenTo(grantee: string) {
-    return await this.kwilWrapper.call("has_write_grant_given_to", { grantee });
+  async hasWriteGrantGivenTo(granteeAddress: string) {
+    return await this.kwilWrapper.call("has_write_grant_given_to", { grantee: granteeAddress });
   }
 
   async #buildInsertableIDOSCredential(