feat(app,iam): using did session to sign challenges (passportxyz#1936)

* feat(app,iam): using did session to sign challenges * feat(iam): fall back to old challenge signature when necessary
pariyagood · Nov 27, 2023 · 74189b6 · 74189b6
1 parent 7261a02
commit 74189b6
Show file tree

Hide file tree

Showing 46 changed files with 1,785 additions and 363 deletions.
diff --git a/app/__test-fixtures__/contextTestHelpers.tsx b/app/__test-fixtures__/contextTestHelpers.tsx
@@ -233,6 +233,7 @@ const datastoreConnectionContext = {
   disconnect: jest.fn(),
   dbAccessToken: "token",
   dbAccessTokenStatus: "idle" as DbAuthTokenStatus,
+  did: jest.fn() as any,
 };
 
 export const renderWithContext = (

diff --git a/app/__tests__/components/GenericPlatform.test.tsx b/app/__tests__/components/GenericPlatform.test.tsx
@@ -8,7 +8,7 @@ const { Ens } = platforms;
 import { CeramicContextState } from "../../context/ceramicContext";
 import { mockAddress } from "../../__test-fixtures__/onboardHookValues";
 import { UN_SUCCESSFUL_ENS_RESULT, SUCCESFUL_ENS_RESULTS } from "../../__test-fixtures__/verifiableCredentialResults";
-import { fetchVerifiableCredential } from "@gitcoin/passport-identity/dist/commonjs/src/credentials";
+import { fetchVerifiableCredential } from "@gitcoin/passport-identity";
 import { makeTestCeramicContext, renderWithContext } from "../../__test-fixtures__/contextTestHelpers";
 import { JsonRpcSigner } from "@ethersproject/providers";
 import { mock } from "jest-mock-extended";
@@ -24,11 +24,12 @@ jest.mock("@didtools/cacao", () => ({
   },
 }));
 
-jest.mock("@gitcoin/passport-identity/dist/commonjs/src/credentials", () => ({
+jest.mock("@gitcoin/passport-identity", () => ({
   fetchVerifiableCredential: jest.fn(),
 }));
 
 jest.mock("../../utils/helpers.tsx", () => ({
+  createSignedPayload: jest.fn(),
   generateUID: jest.fn(),
   getProviderSpec: jest.fn(),
   difference: (setA: any, setB: any) => ({

diff --git a/app/__tests__/components/ProviderCards/BrightidCard.test.tsx b/app/__tests__/components/ProviderCards/BrightidCard.test.tsx
@@ -6,13 +6,13 @@ import { mockAddress, mockWallet } from "../../../__test-fixtures__/onboardHookV
 import { STAMP_PROVIDERS } from "../../../config/providers";
 import { brightidStampFixture } from "../../../__test-fixtures__/databaseStorageFixtures";
 import { SUCCESFUL_BRIGHTID_RESULT } from "../../../__test-fixtures__/verifiableCredentialResults";
-import { fetchVerifiableCredential } from "@gitcoin/passport-identity/dist/commonjs/src/credentials";
+import { fetchVerifiableCredential } from "@gitcoin/passport-identity";
 import { mock } from "jest-mock-extended";
 import { JsonRpcSigner } from "@ethersproject/providers";
 import { makeTestCeramicContext, renderWithContext } from "../../../__test-fixtures__/contextTestHelpers";
 import { CeramicContextState } from "../../../context/ceramicContext";
 
-jest.mock("@gitcoin/passport-identity/dist/commonjs/src/credentials", () => ({
+jest.mock("@gitcoin/passport-identity", () => ({
   fetchVerifiableCredential: jest.fn(),
 }));
 

diff --git a/app/__tests__/components/ProviderCards/EnsCard.test.tsx b/app/__tests__/components/ProviderCards/EnsCard.test.tsx
@@ -8,12 +8,12 @@ import { mockAddress } from "../../../__test-fixtures__/onboardHookValues";
 import { STAMP_PROVIDERS } from "../../../config/providers";
 import { ensStampFixture } from "../../../__test-fixtures__/databaseStorageFixtures";
 import { SUCCESFUL_ENS_RESULT } from "../../../__test-fixtures__/verifiableCredentialResults";
-import { fetchVerifiableCredential } from "@gitcoin/passport-identity/dist/commonjs/src/credentials";
+import { fetchVerifiableCredential } from "@gitcoin/passport-identity";
 import { makeTestCeramicContext, renderWithContext } from "../../../__test-fixtures__/contextTestHelpers";
 import { JsonRpcSigner } from "@ethersproject/providers";
 import { mock } from "jest-mock-extended";
 
-jest.mock("@gitcoin/passport-identity/dist/commonjs/src/credentials", () => ({
+jest.mock("@gitcoin/passport-identity", () => ({
   fetchVerifiableCredential: jest.fn(),
 }));
 

diff --git a/app/__tests__/components/ProviderCards/PohCard.test.tsx b/app/__tests__/components/ProviderCards/PohCard.test.tsx
@@ -6,13 +6,13 @@ import { mockAddress, mockWallet } from "../../../__test-fixtures__/onboardHookV
 import { STAMP_PROVIDERS } from "../../../config/providers";
 import { pohStampFixture } from "../../../__test-fixtures__/databaseStorageFixtures";
 import { SUCCESFUL_POH_RESULT } from "../../../__test-fixtures__/verifiableCredentialResults";
-import { fetchVerifiableCredential } from "@gitcoin/passport-identity/dist/commonjs/src/credentials";
+import { fetchVerifiableCredential } from "@gitcoin/passport-identity";
 import { mock } from "jest-mock-extended";
 import { JsonRpcSigner } from "@ethersproject/providers";
 import { makeTestCeramicContext, renderWithContext } from "../../../__test-fixtures__/contextTestHelpers";
 import { CeramicContextState } from "../../../context/ceramicContext";
 
-jest.mock("@gitcoin/passport-identity/dist/commonjs/src/credentials", () => ({
+jest.mock("@gitcoin/passport-identity", () => ({
   fetchVerifiableCredential: jest.fn(),
 }));
 

diff --git a/app/__tests__/components/RefreshMyStampsModalContent.test.tsx b/app/__tests__/components/RefreshMyStampsModalContent.test.tsx
@@ -6,7 +6,7 @@ import { makeTestCeramicContext, renderWithContext } from "../../__test-fixtures
 import { useNavigate } from "react-router-dom";
 import { ValidatedPlatform } from "../../signer/utils";
 
-import { fetchVerifiableCredential } from "@gitcoin/passport-identity/dist/commonjs/src/credentials";
+import { fetchVerifiableCredential } from "@gitcoin/passport-identity";
 import { reduceStampResponse } from "../../utils/helpers";
 import { CredentialResponseBody } from "@gitcoin/passport-types";
 import { IAM_SIGNATURE_TYPE } from "../../config/stamp_config";
@@ -15,7 +15,7 @@ jest.mock("react-router-dom", () => ({
   useNavigate: jest.fn(),
 }));
 
-jest.mock("@gitcoin/passport-identity/dist/commonjs/src/credentials", () => ({
+jest.mock("@gitcoin/passport-identity", () => ({
   fetchVerifiableCredential: jest.fn().mockResolvedValue({ credentials: [] } as unknown as CredentialResponseBody),
 }));
 
@@ -43,11 +43,8 @@ const mockWalletState = {
   address: "0xmyAddress",
 };
 
-const mockSigner = jest.fn();
-
 jest.mock("../../context/walletStore", () => ({
   useWalletStore: (callback: (state: any) => any) => callback(mockWalletState),
-  useSigner: () => mockSigner,
 }));
 
 const validPlatforms: ValidatedPlatform[] = [
@@ -117,7 +114,7 @@ describe("RefreshMyStampsModalContent", () => {
           proofs: {},
           signatureType: IAM_SIGNATURE_TYPE,
         },
-        mockSigner
+        expect.any(Function)
       )
     );
   });

diff --git a/app/__tests__/context/datastoreConnectionContext.test.tsx b/app/__tests__/context/datastoreConnectionContext.test.tsx
@@ -107,32 +107,6 @@ describe("<UserContext>", () => {
     localStorage.setItem("connectedWallets", "[]");
   });
 
-  it("should delete localStorage item if session has expired", async () => {
-    const ceramicConnect = jest.fn().mockResolvedValueOnce({
-      client: {
-        session: {
-          isExpired: true,
-          expireInSecs: 3400,
-        },
-      },
-    });
-    (framework.useViewerConnection as jest.Mock).mockReturnValue([
-      { status: "connecting", selfID: { did: "did:test" } },
-      ceramicConnect,
-      jest.fn(),
-    ]);
-
-    localStorage.setItem("didsession-0xmyAddress", "eyJzZXNzaW9uS2V5U2VlZCI6IlF5cTN4aW9ubGxD...");
-
-    renderTestComponent();
-
-    expect(screen.getByTestId("session-id")).toHaveTextContent("eyJzZXNzaW9uS2V5U2VlZCI6IlF5cTN4aW9ubGxD...");
-
-    screen.getByRole("button").click();
-
-    await waitFor(() => expect(screen.getByTestId("session-id").textContent).toBe(""));
-  });
-
   describe("when using multichain", () => {
     beforeEach(async () => {
       const ceramicConnect = jest.fn().mockResolvedValueOnce({

diff --git a/app/__tests__/context/stampClaimingContext.test.tsx b/app/__tests__/context/stampClaimingContext.test.tsx
@@ -4,17 +4,18 @@ import { makeTestCeramicContext } from "../../__test-fixtures__/contextTestHelpe
 
 import { CeramicContext } from "../../context/ceramicContext";
 import { StampClaimingContext, StampClaimingContextProvider } from "../../context/stampClaimingContext";
-import { fetchVerifiableCredential } from "@gitcoin/passport-identity/dist/commonjs/src/credentials";
+import { fetchVerifiableCredential } from "@gitcoin/passport-identity";
 
 import { PLATFORM_ID } from "@gitcoin/passport-types";
 import { PlatformProps } from "../../components/GenericPlatform";
 import { AppContext, PlatformClass } from "@gitcoin/passport-platforms";
+import { DatastoreConnectionContext, DbAuthTokenStatus } from "../../context/datastoreConnectionContext";
 
 jest.mock("../../utils/helpers", () => ({
   generateUID: jest.fn((length: number) => "some random string"),
 }));
 
-jest.mock("@gitcoin/passport-identity/dist/commonjs/src/credentials", () => ({
+jest.mock("@gitcoin/passport-identity", () => ({
   fetchVerifiableCredential: jest.fn(),
 }));
 
@@ -118,20 +119,40 @@ const mockCeramicContext = makeTestCeramicContext({
 describe("<StampClaimingContext>", () => {
   const renderTestComponent = () =>
     render(
-      <CeramicContext.Provider value={mockCeramicContext}>
-        <StampClaimingContextProvider>
-          <TestingComponent />
-        </StampClaimingContextProvider>
-      </CeramicContext.Provider>
+      <DatastoreConnectionContext.Provider
+        value={{
+          connect: jest.fn(),
+          disconnect: jest.fn(),
+          dbAccessToken: "token",
+          dbAccessTokenStatus: "idle" as DbAuthTokenStatus,
+          did: jest.fn() as any,
+        }}
+      >
+        <CeramicContext.Provider value={mockCeramicContext}>
+          <StampClaimingContextProvider>
+            <TestingComponent />
+          </StampClaimingContextProvider>
+        </CeramicContext.Provider>
+      </DatastoreConnectionContext.Provider>
     );
 
   const renderTestComponentWithEvmStamp = () =>
     render(
-      <CeramicContext.Provider value={mockCeramicContext}>
-        <StampClaimingContextProvider>
-          <TestingComponentWithEvmStamp />
-        </StampClaimingContextProvider>
-      </CeramicContext.Provider>
+      <DatastoreConnectionContext.Provider
+        value={{
+          connect: jest.fn(),
+          disconnect: jest.fn(),
+          dbAccessToken: "token",
+          dbAccessTokenStatus: "idle" as DbAuthTokenStatus,
+          did: jest.fn() as any,
+        }}
+      >
+        <CeramicContext.Provider value={mockCeramicContext}>
+          <StampClaimingContextProvider>
+            <TestingComponentWithEvmStamp />
+          </StampClaimingContextProvider>
+        </CeramicContext.Provider>
+      </DatastoreConnectionContext.Provider>
     );
 
   beforeEach(() => {

diff --git a/app/__tests__/utils/helpers.test.ts b/app/__tests__/utils/helpers.test.ts
@@ -0,0 +1,45 @@
+import { createSignedPayload } from "../../utils/helpers";
+import { Cacao } from "@didtools/cacao";
+
+jest.mock("@didtools/cacao", () => ({
+  Cacao: {
+    fromBlockBytes: jest.fn().mockImplementation((_) => {
+      return {
+        p: {
+          iss: "did:ethr:0x123",
+        },
+      };
+    }),
+  },
+}));
+
+describe("createSignedPayload", () => {
+  it("should sign", async () => {
+    const mockDid = {
+      createDagJWS: () => ({
+        jws: {
+          link: {
+            bytes: [7, 8, 9],
+          },
+          payload: {
+            hello: "world",
+          },
+          signatures: ["0x123"],
+        },
+        cacaoBlock: [0, 1, 2],
+      }),
+    };
+
+    const signedPayload = await createSignedPayload(mockDid as any, { hello: "world" });
+
+    expect(Cacao.fromBlockBytes).toHaveBeenCalledWith([0, 1, 2]);
+
+    expect(signedPayload).toEqual({
+      signatures: ["0x123"],
+      payload: { hello: "world" },
+      cid: [7, 8, 9],
+      cacao: [0, 1, 2],
+      issuer: "did:ethr:0x123",
+    });
+  });
+});
diff --git a/app/components/GenericPlatform.tsx b/app/components/GenericPlatform.tsx
@@ -1,5 +1,5 @@
 // --- Methods
-import React, { createContext, useContext, useEffect, useMemo, useState } from "react";
+import React, { useContext, useEffect, useMemo, useState } from "react";
 
 // --- Datadog
 import { datadogLogs } from "@datadog/browser-logs";
@@ -12,7 +12,7 @@ import {
   PLATFORM_ID,
   StampPatch,
 } from "@gitcoin/passport-types";
-import { fetchVerifiableCredential } from "@gitcoin/passport-identity/dist/commonjs/src/credentials";
+import { fetchVerifiableCredential } from "@gitcoin/passport-identity";
 
 // --- Style Components
 import { SideBarContent } from "./SideBarContent";
@@ -23,7 +23,7 @@ import { JsonOutputModal } from "./JsonOutputModal";
 
 // --- Context
 import { CeramicContext } from "../context/ceramicContext";
-import { useSigner, useWalletStore } from "../context/walletStore";
+import { useWalletStore } from "../context/walletStore";
 import { waitForRedirect } from "../context/stampClaimingContext";
 
 // --- Types
@@ -32,10 +32,11 @@ import { PlatformClass } from "@gitcoin/passport-platforms";
 import { IAM_SIGNATURE_TYPE, iamUrl } from "../config/stamp_config";
 
 // --- Helpers
-import { difference, generateUID } from "../utils/helpers";
+import { createSignedPayload, difference, generateUID } from "../utils/helpers";
 
 import { datadogRum } from "@datadog/browser-rum";
 import { PlatformScoreSpec } from "../context/scorerContext";
+import { useDatastoreConnectionContext } from "../context/datastoreConnectionContext";
 
 export type PlatformProps = {
   platFormGroupSpec: PlatformGroupSpec[];
@@ -68,13 +69,13 @@ export const GenericPlatform = ({
   onClose,
 }: GenericPlatformProps): JSX.Element => {
   const address = useWalletStore((state) => state.address);
-  const signer = useSigner();
   const { handlePatchStamps, verifiedProviderIds, userDid } = useContext(CeramicContext);
   const [isLoading, setLoading] = useState(false);
   const [canSubmit, setCanSubmit] = useState(false);
   const [submitted, setSubmitted] = useState(false);
   const [verificationResponse, setVerificationResponse] = useState<CredentialResponseBody[]>([]);
   const [payloadModalIsOpen, setPayloadModalIsOpen] = useState(false);
+  const { did } = useDatastoreConnectionContext();
   // const { handleFetchCredential } = useContext(StampClaimingContext);
 
   // --- Chakra functions
@@ -153,6 +154,7 @@ export const GenericPlatform = ({
     datadogLogs.logger.info("Saving Stamp", { platform: platform.platformId });
     setLoading(true);
     try {
+      if (!did) throw new Error("No DID found");
       const state = `${platform.path}-` + generateUID(10);
       const providerPayload = (await platform.getProviderPayload({
         state,
@@ -181,7 +183,7 @@ export const GenericPlatform = ({
           proofs: providerPayload,
           signatureType: IAM_SIGNATURE_TYPE,
         },
-        signer as { signMessage: (message: string) => Promise<string> }
+        (data: any) => createSignedPayload(did, data)
       );
 
       const verifiedCredentials =
@@ -246,6 +248,7 @@ export const GenericPlatform = ({
 
       setLoading(false);
     } catch (e) {
+      console.error(e);
       datadogLogs.logger.error("Verification Error", { error: e, platform: platform.platformId });
       doneToast(
         "Verification Failed",