refactor(heyauthn): update tests and doc

semaphore-protocol · Jan 12, 2024 · c8da0dc · c8da0dc
1 parent 2b05a94
commit c8da0dc
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 15 deletions.
diff --git a/packages/heyauthn/README.md b/packages/heyauthn/README.md
@@ -101,16 +101,13 @@ import { Group } from "@semaphore-protocol/group"
 import { generateProof } from "@semaphore-protocol/proof"
 import { utils } from "ethers"
 
-const group = new Group("42")
+const group = new Group()
 
 group.addMembers(memberList)
 
-const signal = utils.formatBytes32String("Hey anon!")
+const message = utils.formatBytes32String("Hey anon!")
 
-generateProof(identity, group, group.id, "42", {
-    zkeyFilePath: "./semaphore.zkey",
-    wasmFilePath: "./semaphore.wasm"
-})
+generateProof(identity, group, message, group.root)
 ```
 
 ## Authors

diff --git a/packages/heyauthn/src/heyAuthn.ts → packages/heyauthn/src/hey-authn.ts b/packages/heyauthn/src/heyAuthn.ts → packages/heyauthn/src/hey-authn.ts
diff --git a/packages/heyauthn/src/index.ts b/packages/heyauthn/src/index.ts
@@ -1,6 +1,6 @@
 import { Identity } from "@semaphore-protocol/identity"
 import { GenerateAuthenticationOptionsOpts, GenerateRegistrationOptionsOpts } from "@simplewebauthn/server"
-import HeyAuthn from "./heyAuthn"
+import HeyAuthn from "./hey-authn"
 
 export {
     HeyAuthn,

diff --git a/packages/heyauthn/src/heyAuthn.test.ts → packages/heyauthn/tests/index.test.ts b/packages/heyauthn/src/heyAuthn.test.ts → packages/heyauthn/tests/index.test.ts
@@ -4,7 +4,7 @@ import {
     GenerateRegistrationOptionsOpts as RegistrationOptions
 } from "@simplewebauthn/server"
 
-import HeyAuthn from "./heyAuthn"
+import { HeyAuthn } from "../src"
 
 jest.mock("@simplewebauthn/browser", () => ({
     startRegistration: async () => ({
@@ -52,9 +52,8 @@ describe("HeyAuthn", () => {
             const { identity } = await HeyAuthn.fromRegister(options)
             const expectedIdentity = new Identity("my-new-credential")
 
-            expect(expectedIdentity.trapdoor).toEqual(identity.trapdoor)
-            expect(expectedIdentity.nullifier).toEqual(identity.nullifier)
-            expect(expectedIdentity.commitment).toEqual(identity.commitment)
+            expect(identity.secretScalar).toEqual(expectedIdentity.secretScalar)
+            expect(identity.commitment).toEqual(expectedIdentity.commitment)
         })
     })
 
@@ -67,9 +66,8 @@ describe("HeyAuthn", () => {
             const { identity } = await HeyAuthn.fromAuthenticate(options)
             const expectedIdentity = new Identity("my-existing-credential")
 
-            expect(expectedIdentity.trapdoor).toEqual(identity.trapdoor)
-            expect(expectedIdentity.nullifier).toEqual(identity.nullifier)
-            expect(expectedIdentity.commitment).toEqual(identity.commitment)
+            expect(identity.secretScalar).toEqual(expectedIdentity.secretScalar)
+            expect(identity.commitment).toEqual(expectedIdentity.commitment)
         })
     })
 })
diff --git a/packages/heyauthn/tsconfig.json b/packages/heyauthn/tsconfig.json
@@ -1,4 +1,4 @@
 {
     "extends": "../../tsconfig.json",
-    "include": ["src", "rollup.config.ts"]
+    "include": ["src", "tests", "rollup.config.ts"]
 }