feat: update readme with new publish steps (#129)

* feat: update readme with new publish steps

Adding the automatic formatting post-publish reduces git diff noise
The name change is because the old file was manually named and imported

* fix: update pnpm lockfile

* fix: update filename

The import was renamed, but the filename was missed!

* chore: add run command to build

pnpm I think has the npm compat built in where the special scripts
can run without the run command.

It's probably better to not rely on that!

Author: cpb8010

README.md

@@ -141,9 +141,9 @@ This monorepo is comprised of the following packages, products, and examples:
 
    ```bash
    # Compile and deploy contracts
-   cd packages/contracts
-   pnpm build
+   pnpm --dir packages/contracts run build
    pnpm --dir packages/contracts run publish ../sdk/src/abi
+   pnpm run format-abi
    pnpm --dir packages/contracts run deploy --file ../auth-server/stores/local-node.json
    ```
 

package.json

@@ -17,6 +17,7 @@
     "fmt": "pnpm prettier --write .",
     "lint": "pnpm run lint:eslint && pnpm run lint:markdown && pnpm run lint:spelling && pnpm run lint:prettier",
     "lint:fix": "pnpm eslint --fix --ignore-pattern 'packages/*' --ignore-pattern 'examples/*' . && pnpm nx affected -t lint --fix && pnpm prettier --write . | grep -v 'unchanged' | xargs",
+    "format-abi": "pnpm eslint --fix packages/sdk/src/abi && pnpm nx affected -t lint --fix && pnpm prettier --write packages/sdk/src/abi | grep -v 'unchanged' | xargs",
     "lint:eslint": "pnpm nx run-many -t lint --all && pnpm eslint --ignore-pattern 'packages/*' --ignore-pattern 'examples/*' .",
     "lint:markdown": "markdownlint-cli2 '**/*.md'",
     "lint:spelling": "cspell .",

packages/auth-server/composables/useRecoveryGuardian.ts

@@ -2,7 +2,7 @@ import type { Account, Address, Chain, Client, Hex, Transport } from "viem";
 import { encodeFunctionData, keccak256, pad, toHex } from "viem";
 import { waitForTransactionReceipt } from "viem/actions";
 import { getGeneralPaymasterInput, sendTransaction } from "viem/zksync";
-import { GuardianRecoveryModuleAbi } from "zksync-sso/abi";
+import { GuardianRecoveryValidatorAbi } from "zksync-sso/abi";
 import { confirmGuardian as sdkConfirmGuardian } from "zksync-sso/client";
 import { base64UrlToUint8Array, getPublicKeyBytesFromPasskeySignature } from "zksync-sso/utils";
 
@@ -25,7 +25,7 @@ export const useRecoveryGuardian = () => {
       const client = getPublicClient({ chainId: defaultChain.id });
       return await client.readContract({
         address: contractsByChain[defaultChain.id].recovery,
-        abi: GuardianRecoveryModuleAbi,
+        abi: GuardianRecoveryValidatorAbi,
         functionName: "guardianOf",
         args: [keccak256(toHex(window.location.origin)), guardianAddress],
       });
@@ -45,7 +45,7 @@ export const useRecoveryGuardian = () => {
       const client = getPublicClient({ chainId: defaultChain.id });
       const data = await client.readContract({
         address: contractsByChain[defaultChain.id].recovery,
-        abi: GuardianRecoveryModuleAbi,
+        abi: GuardianRecoveryValidatorAbi,
         functionName: "guardiansFor",
         args: [keccak256(toHex(window.location.origin)), guardedAccount],
       });
@@ -70,7 +70,7 @@ export const useRecoveryGuardian = () => {
       const client = getPublicClient({ chainId: defaultChain.id });
       return await client.readContract({
         address: contractsByChain[defaultChain.id].recovery,
-        abi: GuardianRecoveryModuleAbi,
+        abi: GuardianRecoveryValidatorAbi,
         functionName: "getPendingRecoveryData",
         args: [keccak256(toHex(window.location.origin)), account],
       });
@@ -125,7 +125,7 @@ export const useRecoveryGuardian = () => {
     const client = getClient({ chainId: defaultChain.id });
     const tx = await client.writeContract({
       address: contractsByChain[defaultChain.id].recovery,
-      abi: GuardianRecoveryModuleAbi,
+      abi: GuardianRecoveryValidatorAbi,
       functionName: "discardRecovery",
       args: [keccak256(toHex(window.location.origin))],
     });
@@ -144,7 +144,7 @@ export const useRecoveryGuardian = () => {
     ] as const;
 
     const calldata = encodeFunctionData({
-      abi: GuardianRecoveryModuleAbi,
+      abi: GuardianRecoveryValidatorAbi,
       functionName: "initRecovery",
       args: [
         accountToRecover,
@@ -173,13 +173,13 @@ export const useRecoveryGuardian = () => {
     const [requestValidityTime, requestDelayTime] = await Promise.all([
       client.readContract({
         address: contractsByChain[defaultChain.id].recovery,
-        abi: GuardianRecoveryModuleAbi,
+        abi: GuardianRecoveryValidatorAbi,
         functionName: "REQUEST_VALIDITY_TIME",
         args: [],
       }),
       client.readContract({
         address: contractsByChain[defaultChain.id].recovery,
-        abi: GuardianRecoveryModuleAbi,
+        abi: GuardianRecoveryValidatorAbi,
         functionName: "REQUEST_DELAY_TIME",
         args: [],
       }),
@@ -208,7 +208,7 @@ export const useRecoveryGuardian = () => {
 
     const eventsFilter = {
       address: contractsByChain[defaultChain.id].recovery,
-      abi: GuardianRecoveryModuleAbi,
+      abi: GuardianRecoveryValidatorAbi,
       args,
       fromBlock: validFromBlock,
       toBlock: "latest",

packages/auth-server/stores/local-node.json

@@ -1,4 +1,5 @@
 {
+  "beacon": "0x5df1462218fe444FA4CD486f4d7A837A82b3B026",
   "session": "0xcc8bD0d99CF35e5F07d5FbbFd8f7B628010E52C2",
   "passkey": "0xDdB1e5ECd29aAC588E0fb0a7eAB1b589fE7D7dcD",
   "accountFactory": "0x940adFE6B30536D22eD78870aA79c9DC0835556C",

packages/contracts

@@ -1,4 +1,4 @@
-export const GuardianRecoveryModuleAbi = [
+export const GuardianRecoveryValidatorAbi = [
   {
     inputs: [],
     stateMutability: "nonpayable",

…es/sdk/src/abi/GuardianRecoveryModule.ts …sdk/src/abi/GuardianRecoveryValidator.tspackages/sdk/src/abi/GuardianRecoveryModule.ts renamed to packages/sdk/src/abi/GuardianRecoveryValidator.ts packages/sdk/src/abi/GuardianRecoveryModule.ts renamed to packages/sdk/src/abi/GuardianRecoveryValidator.ts

@@ -102,7 +102,7 @@ export const SsoAccountAbi = [
   },
   {
     inputs: [],
-    name: "InvalidShortString",
+    name: "INVALID_ACCOUNT_KEYS",
     type: "error",
   },
   {
@@ -154,17 +154,6 @@ export const SsoAccountAbi = [
     name: "OWNER_NOT_FOUND",
     type: "error",
   },
-  {
-    inputs: [
-      {
-        internalType: "string",
-        name: "str",
-        type: "string",
-      },
-    ],
-    name: "StringTooLong",
-    type: "error",
-  },
   {
     inputs: [
       {
@@ -217,12 +206,6 @@ export const SsoAccountAbi = [
     name: "BatchCallFailure",
     type: "event",
   },
-  {
-    anonymous: false,
-    inputs: [],
-    name: "EIP712DomainChanged",
-    type: "event",
-  },
   {
     anonymous: false,
     inputs: [
@@ -403,49 +386,6 @@ export const SsoAccountAbi = [
     stateMutability: "payable",
     type: "function",
   },
-  {
-    inputs: [],
-    name: "eip712Domain",
-    outputs: [
-      {
-        internalType: "bytes1",
-        name: "fields",
-        type: "bytes1",
-      },
-      {
-        internalType: "string",
-        name: "name",
-        type: "string",
-      },
-      {
-        internalType: "string",
-        name: "version",
-        type: "string",
-      },
-      {
-        internalType: "uint256",
-        name: "chainId",
-        type: "uint256",
-      },
-      {
-        internalType: "address",
-        name: "verifyingContract",
-        type: "address",
-      },
-      {
-        internalType: "bytes32",
-        name: "salt",
-        type: "bytes32",
-      },
-      {
-        internalType: "uint256[]",
-        name: "extensions",
-        type: "uint256[]",
-      },
-    ],
-    stateMutability: "view",
-    type: "function",
-  },
   {
     inputs: [
       {
@@ -646,32 +586,6 @@ export const SsoAccountAbi = [
     stateMutability: "payable",
     type: "function",
   },
-  {
-    inputs: [
-      {
-        components: [
-          {
-            internalType: "bytes32",
-            name: "signedHash",
-            type: "bytes32",
-          },
-        ],
-        internalType: "struct ERC1271Handler.SsoMessage",
-        name: "ssoMessage",
-        type: "tuple",
-      },
-    ],
-    name: "getEip712Hash",
-    outputs: [
-      {
-        internalType: "bytes32",
-        name: "",
-        type: "bytes32",
-      },
-    ],
-    stateMutability: "view",
-    type: "function",
-  },
   {
     inputs: [
       {
@@ -1192,19 +1106,6 @@ export const SsoAccountAbi = [
     stateMutability: "nonpayable",
     type: "function",
   },
-  {
-    inputs: [],
-    name: "ssoMessageTypeHash",
-    outputs: [
-      {
-        internalType: "bytes32",
-        name: "",
-        type: "bytes32",
-      },
-    ],
-    stateMutability: "pure",
-    type: "function",
-  },
   {
     inputs: [
       {

packages/sdk/src/abi/SsoAccount.ts

@@ -1,5 +1,5 @@
 export { AAFactoryAbi } from "./AAFactory.js";
-export { GuardianRecoveryModuleAbi } from "./GuardianRecoveryModule.js";
+export { GuardianRecoveryValidatorAbi } from "./GuardianRecoveryValidator.js";
 export { SessionKeyValidatorAbi } from "./SessionKeyValidator.js";
 export { SsoAccountAbi } from "./SsoAccount.js";
 export { WebAuthValidatorAbi } from "./WebAuthValidator.js";

packages/sdk/src/abi/index.ts

@@ -2,7 +2,7 @@ import { type Account, type Address, type Chain, type Client, encodeFunctionData
 import { waitForTransactionReceipt } from "viem/actions";
 import { getGeneralPaymasterInput, sendTransaction } from "viem/zksync";
 
-import { GuardianRecoveryModuleAbi } from "../../../abi/GuardianRecoveryModule.js";
+import { GuardianRecoveryValidatorAbi } from "../../../abi/GuardianRecoveryValidator.js";
 import { noThrow } from "../../../utils/helpers.js";
 
 export type ProposeGuardianArgs = {
@@ -35,7 +35,7 @@ export const proposeGuardian = async <
   }
 
   const callData = encodeFunctionData({
-    abi: GuardianRecoveryModuleAbi,
+    abi: GuardianRecoveryValidatorAbi,
     functionName: "proposeGuardian",
     args: [keccak256(toHex(origin)), args.newGuardian],
   });
@@ -91,7 +91,7 @@ export const confirmGuardian = async <
     }
   }
   const callData = encodeFunctionData({
-    abi: GuardianRecoveryModuleAbi,
+    abi: GuardianRecoveryValidatorAbi,
     functionName: "addGuardian",
     args: [keccak256(toHex(origin)), args.accountToGuard],
   });
@@ -147,7 +147,7 @@ export const removeGuardian = async <
     }
   }
   const callData = encodeFunctionData({
-    abi: GuardianRecoveryModuleAbi,
+    abi: GuardianRecoveryValidatorAbi,
     functionName: "removeGuardian",
     args: [keccak256(toHex(origin)), args.guardian],
   });