feat: new passkey signature format (#58)

* feat: new passkey signature format

includes the credential id, which is hopefully available

* fix: update to include credential id on creation

Also update contracts locally

* chore: update to latest contracts

* fix: update lockfile from contract dep change

* fix: import for utils

* fix: update signature format tests

It doesn't look correct visually, but it's mocked on both ends
so it's not super clear on what it's testing

* feat: attempt to use new dynamic contract addresses

When deploying the contracts, it should create the file, blocking the build

* fix: provide an example file

Can have a different test to make sure this gets updated or
put the contract build step into the other builds

* fix: add create2 to nft deploy

Try encoding the local contracts directly instead of via env vars
doesn't appear to work locally...

* fix: encode passkey id as bytes

This was correct on creation, but wrong on signing

* chore: update to latest contract

* fix: update hardcoded signatures for passkey view

This was super tough to find and would have been a compile error
had we imported the abi directly from the contracts!

This is something I'm going to look into so we don't lose our minds

* fix: remove debugging changes

You just have to know that the quest address is added via .env.local
so the object in the config isn't used

* feat: attempt to import abi automatically

Having to manually update the ABI kinda defeats the point of type
safety, but it's clear the auto-generated one doesn't play nice
with the existing file so more work will be necessary to update it
so it's compatible

* fix: use view function to get key

Picks up a fix from the publish function for the correct abi

* fix: remove publish from CI

It looks like nuxt builds don't like the poorly formatted json,
so instead of trying to pretty print the abi automatically we'll
rely on the editor tools to do this.

At the very least the publish step is documented?

* fix: update import names

problem was not the file format, but the file name change

* fix: use pnpm run build instead of build

CI is behaving strange?

* fix: use correct contract branch

* fix: pull contract directory in CI

This explains why the build was failing

* feat: setup local node for deploy

This should be fine because we aren't actually using it

* [wip] Add application metadata (#82)

* feat: provide auth-server metadata

Can be helpful for custom auth-server implementions that want extra data

* fix: use a record instead of an array of records

There's not really much extra flexibility here, so just keep it simple

* fix: update demo app with new metadata format

* Update packages/auth-server/components/session/Metadata.vue

---------

Co-authored-by: Nicolas Villanueva <1890113+MexicanAce@users.noreply.github.com>

* fix: update to breaking factory change

This was already fixed during guardian module work

* fix: update ABI

breaking name and argument changes were not published
Added publish step to readme

* fix: update new variable name

now automatically checked via types!

* fix: update test mock

The log parsing format is broken because the return type changed,
but regenerating the log format is non-trival so that can be updated later.

introducing #84

* fix: update account id length

Updating the tests to match

---------

Co-authored-by: Nicolas Villanueva <1890113+MexicanAce@users.noreply.github.com>

Author: cpb8010

.github/workflows/ci.yml

@@ -41,17 +41,17 @@ jobs:
       run: pnpm install -r --frozen-lockfile
       working-directory: packages/contracts
 
-    - name: Build SDK
-      run: pnpm nx build sdk
-
     - name: Build contracts
       run: pnpm build
       working-directory: packages/contracts
 
     - name: Deploy contracts
-      run: pnpm run deploy
+      run: pnpm run deploy --file ../auth-server/stores/local-node.json
       working-directory: packages/contracts
 
+    - name: Build SDK
+      run: pnpm nx build sdk
+
     - name: Install zksync-foundry
       run: |
         wget -qc https://github.com/matter-labs/foundry-zksync/releases/download/nightly/foundry_nightly_linux_amd64.tar.gz -O - | tar -xz
@@ -115,17 +115,17 @@ jobs:
       run: pnpm install -r --frozen-lockfile
       working-directory: packages/contracts
 
-    - name: Build SDK
-      run: pnpm nx build sdk
-
     - name: Build contracts
       run: pnpm build
       working-directory: packages/contracts
 
     - name: Deploy contracts
-      run: pnpm run deploy
+      run: pnpm run deploy --file ../auth-server/stores/local-node.json 
       working-directory: packages/contracts
 
+    - name: Build SDK
+      run: pnpm nx build sdk
+
     - name: Deploy NFT contracts
       run: pnpm nx deploy:local nft-quest-contracts
 

.github/workflows/deploy-auth-server.yml

@@ -17,6 +17,8 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4 # v4
+        with:
+          submodules: recursive
 
       - name: Setup pnpm
         uses: pnpm/action-setup@v4
@@ -29,6 +31,23 @@ jobs:
           node-version: lts/Iron
           cache: 'pnpm'
 
+      # SDK depends on contracts
+      - name: Install contract dependencies
+        run: pnpm install -r --frozen-lockfile
+        working-directory: packages/contracts
+
+      - name: Build contracts
+        run: pnpm run build
+        working-directory: packages/contracts
+
+      # Local node to have target for deploy
+      - name: Era Test Node Action
+        uses: dutterbutter/anvil-zksync-action@v1.1.0
+
+      - name: Deploy contracts
+        run: pnpm run deploy --file ../auth-server/stores/local-node.json
+        working-directory: packages/contracts
+
       - name: Install dependencies
         run: pnpm install -r --frozen-lockfile
 

.github/workflows/deploy-nft-quest.yml

@@ -17,6 +17,8 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4 # v4
+        with:
+          submodules: recursive
 
       - name: Setup pnpm
         uses: pnpm/action-setup@v4
@@ -32,6 +34,23 @@ jobs:
       - name: Install dependencies
         run: pnpm install -r --frozen-lockfile
 
+      # SDK depends on contracts
+      - name: Install contract dependencies
+        run: pnpm install -r --frozen-lockfile
+        working-directory: packages/contracts
+
+      - name: Build contracts
+        run: pnpm build
+        working-directory: packages/contracts
+
+      # Local node to have target for deploy
+      - name: Era Test Node Action
+        uses: dutterbutter/anvil-zksync-action@v1.1.0
+
+      - name: Deploy contracts
+        run: pnpm run deploy --file ../auth-server/stores/local-node.json
+        working-directory: packages/contracts
+
       - name: Build apps
         run: pnpm nx build nft-quest
 

.github/workflows/deploy-package.yml

@@ -14,6 +14,8 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
+        with:
+          submodules: recursive
 
       - name: Setup pnpm
         uses: pnpm/action-setup@v4
@@ -29,6 +31,23 @@ jobs:
       - name: Install dependencies
         run: pnpm install -r --frozen-lockfile
 
+      # SDK depends on contracts
+      - name: Install contract dependencies
+        run: pnpm install -r --frozen-lockfile
+        working-directory: packages/contracts
+
+      - name: Build contracts
+        run: pnpm build
+        working-directory: packages/contracts
+
+      # Local node to have target for deploy
+      - name: Era Test Node Action
+        uses: dutterbutter/anvil-zksync-action@v1.1.0
+
+      - name: Deploy contracts
+        run: pnpm run deploy --file ../auth-server/stores/local-node.json
+        working-directory: packages/contracts
+
       - name: Build the package
         run: pnpm nx build sdk
 

.github/workflows/deploy-preview.yml

@@ -18,6 +18,8 @@ jobs:
       output_urls: "${{ steps.preview_deploy.outputs.urls }}"
     steps:
       - uses: actions/checkout@v4 # v4
+        with:
+          submodules: recursive
 
       - name: Setup pnpm
         uses: pnpm/action-setup@v4
@@ -30,6 +32,23 @@ jobs:
           node-version: lts/Iron
           cache: 'pnpm'
 
+      # SDK depends on contracts
+      - name: Install contract dependencies
+        run: pnpm install -r --frozen-lockfile
+        working-directory: packages/contracts
+
+      - name: Build contracts
+        run: pnpm run build
+        working-directory: packages/contracts
+
+      # Local node to have target for deploy
+      - name: Era Test Node Action
+        uses: dutterbutter/anvil-zksync-action@v1.1.0
+
+      - name: Deploy contracts
+        run: pnpm run deploy --file ../auth-server/stores/local-node.json
+        working-directory: packages/contracts
+
       - name: Install dependencies
         run: pnpm install -r --frozen-lockfile
 

README.md

@@ -143,7 +143,8 @@ This monorepo is comprised of the following packages, products, and examples:
    # Compile and deploy contracts
    cd packages/contracts
    pnpm build
-   pnpm run deploy
+   pnpm --dir packages/contracts run publish ../sdk/src/abi
+   pnpm --dir packages/contracts run deploy --file ../auth-server/stores/local-node.json
    ```
 
 6. Start the demo application:

examples/nft-quest-contracts/deploy/deploy.ts

@@ -17,6 +17,9 @@ export default async function (hre: HardhatRuntimeEnvironment) {
   console.log("PAYMASTER CONTRACT: ", await paymasterContract.getAddress());
 
   if (hre.network.config.ethNetwork.includes("localhost")) {
+    const nftQuestAddress = await nftContract.getAddress();
+    const paymasterContractAddress = await paymasterContract.getAddress();
+
     // Update the .env.local file with the contract addresses for NFT Quest app
     const envFilePath = path.join(__dirname, "../../nft-quest/.env.local");
 
@@ -25,10 +28,8 @@ export default async function (hre: HardhatRuntimeEnvironment) {
       fs.writeFileSync(envFilePath, "", { encoding: "utf8" });
       console.log(`.env.local file has been created at ${envFilePath}`);
     }
-    const nftContractAddress = await nftContract.getAddress();
-    const paymasterContractAddress = await paymasterContract.getAddress();
 
-    const envContent = `NUXT_PUBLIC_CONTRACTS_NFT=${nftContractAddress}\nNUXT_PUBLIC_CONTRACTS_PAYMASTER=${paymasterContractAddress}\n`;
+    const envContent = `NUXT_PUBLIC_CONTRACTS_NFT=${nftQuestAddress}\nNUXT_PUBLIC_CONTRACTS_PAYMASTER=${paymasterContractAddress}\n`;
 
     fs.writeFileSync(envFilePath, envContent, { encoding: "utf8" });
     console.log(`.env.local file has been updated at ${envFilePath}`);

examples/nft-quest-contracts/deploy/utils.ts

@@ -5,7 +5,7 @@ import { Deployer } from "@matterlabs/hardhat-zksync";
 import dotenv from "dotenv";
 import { ethers } from "ethers";
 import * as hre from "hardhat";
-import { Provider, Wallet } from "zksync-ethers";
+import { ContractFactory, Provider, utils, Wallet } from "zksync-ethers";
 
 // Load env file
 dotenv.config();
@@ -105,23 +105,33 @@ export const deployContract = async (contractArtifactName: string, constructorAr
   await verifyEnoughBalance(wallet, deploymentFee);
 
   // Deploy the contract to ZKsync
-  const contract = await deployer.deploy(artifact, constructorArguments);
+  const salt = ethers.hexlify("0x" + "0".repeat(64));
+  const create2Deployer = new ContractFactory(artifact.abi, artifact.bytecode, wallet, "create2");
+  const encodedArgs = create2Deployer.interface.encodeDeploy(constructorArguments);
+  const bytecodeHash = utils.hashBytecode(artifact.bytecode);
+  const standardCreate2Address = utils.create2Address(wallet.address, bytecodeHash, salt, constructorArguments ? encodedArgs : "0x");
+  const accountCode = await wallet.provider.getCode(standardCreate2Address);
+  if (accountCode != "0x") {
+    log(`Contract ${contractArtifactName} already exists!`);
+    return new ethers.Contract(standardCreate2Address, artifact.abi, wallet);
+  }
+
+  const contract = await (constructorArguments ? create2Deployer.deploy(...constructorArguments, { customData: { salt } }) : create2Deployer.deploy({ customData: { salt } }));
   const address = await contract.getAddress();
-  const constructorArgs = contract.interface.encodeDeploy(constructorArguments);
   const fullContractSource = `${artifact.sourceName}:${artifact.contractName}`;
 
   // Display contract deployment info
   log(`\n"${artifact.contractName}" was successfully deployed:`);
   log(` - Contract address: ${address}`);
   log(` - Contract source: ${fullContractSource}`);
-  log(` - Encoded constructor arguments: ${constructorArgs}\n`);
+  log(` - Encoded constructor arguments: ${encodedArgs}\n`);
 
   if (!options?.noVerify && hre.network.config.verifyURL) {
     log(`Requesting contract verification...`);
     await verifyContract({
       address,
       contract: fullContractSource,
-      constructorArguments: constructorArgs,
+      constructorArguments: encodedArgs,
       bytecode: artifact.bytecode,
     });
   }

packages/auth-server/components/session/row/Row.vue

@@ -55,7 +55,7 @@
 <script setup lang="ts">
 import { HandRaisedIcon } from "@heroicons/vue/24/outline";
 import type { Hash } from "viem";
-import { SessionKeyModuleAbi } from "zksync-sso/abi";
+import { SessionKeyValidatorAbi } from "zksync-sso/abi";
 import { type SessionConfig, type SessionState, SessionStatus } from "zksync-sso/utils";
 
 const props = defineProps<{
@@ -100,7 +100,7 @@ const {
   const client = getPublicClient({ chainId: defaultChain.id });
   const res = await client.readContract({
     address: contractsByChain[defaultChain.id].session,
-    abi: SessionKeyModuleAbi,
+    abi: SessionKeyValidatorAbi,
     functionName: "sessionState",
     args: [address.value!, props.session],
   });

packages/auth-server/composables/useAccountCreate.ts

@@ -35,6 +35,7 @@ export const useAccountCreate = (_chainId: MaybeRef<SupportedChainId>) => {
     const deployerClient = getThrowAwayClient({ chainId: chainId.value });
 
     const deployedAccount = await deployAccount(deployerClient, {
+      credentialId,
       credentialPublicKey,
       uniqueAccountId: credentialId,
       contracts: contractsByChain[chainId.value],