zksync-sso 0.0.0-beta.1 → 0.0.0-beta.11

package/.npmignore

@@ -7,4 +7,11 @@
 !README.md
 
 # Ignore unnecessary files
+.gitignore
+.lintstagedrc.js
+eslint.config.js
+prepare-package.mjs
+project.json
+tsconfig.json
+tsconfig.base.json
 *.tsbuildinfo

package/README.md

@@ -1,3 +1,98 @@
-# zksync-sso-sdk
+# zksync-sso SDK
 
-ZKsync SSO SDK
+[![License](https://img.shields.io/badge/license-MIT-blue)](LICENSE-MIT)
+
+A user & developer friendly modular smart account implementation on ZKsync;
+simplifying user authentication, session management, and transaction processing.
+
+## Features and Goals
+
+<!-- prettier-ignore -->
+> ZKsync SSO is under active development and is not yet feature
+> complete. Use it to improve your development applications and tooling. Please
+> do not use it in production environments.
+
+- 🧩 Modular smart accounts based on
+  [ERC-7579](https://eips.ethereum.org/EIPS/eip-7579#modules)
+- 🔑 Passkey authentication (no seed phrases)
+- ⏰ Sessions w/ easy configuration and management
+- 💰 Integrated paymaster support
+- ❤️‍🩹 Account recovery _(Coming Soon)_
+- 💻 Simple SDKs : JavaScript, iOS/Android _(Coming Soon)_
+- 🤝 Open-source authentication server
+- 🎓 Examples to get started quickly
+
+## Getting started
+
+Install the ZKsync SSO SDK package:
+
+```sh
+npm i zksync-sso
+```
+
+Add ZKsync SSO connector to your app (using `wagmi`):
+
+```ts
+import { zksyncSsoConnector, callPolicy } from "zksync-sso/connector";
+import { zksyncSepoliaTestnet } from "viem/chains";
+import { createConfig, connect } from "@wagmi/core";
+import { erc20Abi } from "viem";
+
+const ssoConnector = zksyncSsoConnector({
+  // Optional session configuration, if omitted user will have to sign every transaction via Auth Server
+  session: {
+    expiry: "1 day",
+
+    // Allow up to 0.1 ETH to be spend in gas fees
+    feeLimit: parseEther("0.1"),
+
+    transfers: [
+      // Allow ETH transfers of up to 0.1 ETH to specific address
+      {
+        to: "0x188bd99cd7D4d78d4E605Aeea12C17B32CC3135A",
+        valueLimit: parseEther("0.1"),
+      },
+    ],
+
+    // Allow calling specific smart contracts (e.g. ERC20 transfer):
+    contractCalls: [
+      callPolicy({
+        address: "0xa1cf087DB965Ab02Fb3CFaCe1f5c63935815f044",
+        abi: erc20Abi,
+        functionName: "transfer",
+        constraints: [
+          // Only allow transfers to this address. Or any address if omitted
+          {
+            index: 0, // First argument of erc20 transfer function, recipient address
+            value: "0x6cC8cf7f6b488C58AA909B77E6e65c631c204784",
+          },
+
+          // Allow transfering up to 0.2 tokens per hour
+          // until the session expires
+          {
+            index: 1,
+            limit: {
+                limit: parseUnits("0.2", TOKEN.decimals),
+                period: "1 hour",
+            },
+          },
+        ],
+      }),
+    ],
+   },
+});
+
+const wagmiConfig = createConfig({
+  connectors: [ssoConnector],
+  ..., // your wagmi config https://wagmi.sh/core/api/createConfig
+});
+
+const connectWithSSO = () => {
+  connect(wagmiConfig, {
+    connector: ssoConnector,
+    chainId: zksyncSepoliaTestnet.id, // or another chain id that has SSO support
+  });
+};
+```
+
+[Find more information here in our docs.](https://docs.zksync.io/build/zksync-sso)

package/dist/_cjs/abi/{Factory.js → AAFactory.js}

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FactoryAbi = void 0;
-exports.FactoryAbi = [
+exports.AAFactoryAbi = void 0;
+exports.AAFactoryAbi = [
     {
         inputs: [
             {
@@ -11,7 +11,7 @@ exports.FactoryAbi = [
             },
             {
                 internalType: "address",
-                name: "implementation",
+                name: "_beacon",
                 type: "address",
             },
         ],
@@ -19,23 +19,15 @@ exports.FactoryAbi = [
         type: "constructor",
     },
     {
-        anonymous: false,
         inputs: [
             {
-                indexed: true,
-                internalType: "address",
-                name: "previousOwner",
-                type: "address",
-            },
-            {
-                indexed: true,
                 internalType: "address",
-                name: "newOwner",
+                name: "account",
                 type: "address",
             },
         ],
-        name: "OwnershipTransferred",
-        type: "event",
+        name: "ACCOUNT_ALREADY_EXISTS",
+        type: "error",
     },
     {
         anonymous: false,
@@ -43,26 +35,32 @@ exports.FactoryAbi = [
             {
                 indexed: true,
                 internalType: "address",
-                name: "implementation",
+                name: "accountAddress",
                 type: "address",
             },
+            {
+                indexed: false,
+                internalType: "bytes32",
+                name: "uniqueAccountId",
+                type: "bytes32",
+            },
         ],
-        name: "Upgraded",
+        name: "AccountCreated",
         type: "event",
     },
     {
         inputs: [
             {
-                internalType: "string",
-                name: "",
-                type: "string",
+                internalType: "bytes32",
+                name: "accountId",
+                type: "bytes32",
             },
         ],
         name: "accountMappings",
         outputs: [
             {
                 internalType: "address",
-                name: "",
+                name: "deployedAccount",
                 type: "address",
             },
         ],
@@ -70,16 +68,16 @@ exports.FactoryAbi = [
         type: "function",
     },
     {
-        inputs: [
+        inputs: [],
+        name: "beacon",
+        outputs: [
             {
-                internalType: "bytes32",
-                name: "uniqueAccountId",
-                type: "bytes32",
+                internalType: "address",
+                name: "",
+                type: "address",
             },
         ],
-        name: "addNewUniqueId",
-        outputs: [],
-        stateMutability: "nonpayable",
+        stateMutability: "view",
         type: "function",
     },
     {
@@ -99,31 +97,21 @@ exports.FactoryAbi = [
         inputs: [
             {
                 internalType: "bytes32",
-                name: "salt",
+                name: "uniqueId",
                 type: "bytes32",
             },
-            {
-                internalType: "string",
-                name: "uniqueAccountId",
-                type: "string",
-            },
             {
                 internalType: "bytes[]",
                 name: "initialValidators",
                 type: "bytes[]",
             },
-            {
-                internalType: "bytes[]",
-                name: "initialModules",
-                type: "bytes[]",
-            },
             {
                 internalType: "address[]",
                 name: "initialK1Owners",
                 type: "address[]",
             },
         ],
-        name: "deployProxy7579Account",
+        name: "deployProxySsoAccount",
         outputs: [
             {
                 internalType: "address",
@@ -136,62 +124,16 @@ exports.FactoryAbi = [
     },
     {
         inputs: [],
-        name: "implementation",
+        name: "getEncodedBeacon",
         outputs: [
             {
-                internalType: "address",
+                internalType: "bytes",
                 name: "",
-                type: "address",
+                type: "bytes",
             },
         ],
         stateMutability: "view",
         type: "function",
     },
-    {
-        inputs: [],
-        name: "owner",
-        outputs: [
-            {
-                internalType: "address",
-                name: "",
-                type: "address",
-            },
-        ],
-        stateMutability: "view",
-        type: "function",
-    },
-    {
-        inputs: [],
-        name: "renounceOwnership",
-        outputs: [],
-        stateMutability: "nonpayable",
-        type: "function",
-    },
-    {
-        inputs: [
-            {
-                internalType: "address",
-                name: "newOwner",
-                type: "address",
-            },
-        ],
-        name: "transferOwnership",
-        outputs: [],
-        stateMutability: "nonpayable",
-        type: "function",
-    },
-    {
-        inputs: [
-            {
-                internalType: "address",
-                name: "newImplementation",
-                type: "address",
-            },
-        ],
-        name: "upgradeTo",
-        outputs: [],
-        stateMutability: "nonpayable",
-        type: "function",
-    },
 ];
-//# sourceMappingURL=Factory.js.map
+//# sourceMappingURL=AAFactory.js.map

package/dist/_cjs/abi/AAFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AAFactory.js","sourceRoot":"","sources":["../../../src/abi/AAFactory.ts"],"names":[],"mappings":";;;AAAa,QAAA,YAAY,GAAG;IAC1B;QACE,MAAM,EAAE;YACN;gBACE,YAAY,EAAE,SAAS;gBACvB,IAAI,EAAE,0BAA0B;gBAChC,IAAI,EAAE,SAAS;aAChB;YACD;gBACE,YAAY,EAAE,SAAS;gBACvB,IAAI,EAAE,SAAS;gBACf,IAAI,EAAE,SAAS;aAChB;SACF;QACD,eAAe,EAAE,YAAY;QAC7B,IAAI,EAAE,aAAa;KACpB;IACD;QACE,MAAM,EAAE;YACN;gBACE,YAAY,EAAE,SAAS;gBACvB,IAAI,EAAE,SAAS;gBACf,IAAI,EAAE,SAAS;aAChB;SACF;QACD,IAAI,EAAE,wBAAwB;QAC9B,IAAI,EAAE,OAAO;KACd;IACD;QACE,SAAS,EAAE,KAAK;QAChB,MAAM,EAAE;YACN;gBACE,OAAO,EAAE,IAAI;gBACb,YAAY,EAAE,SAAS;gBACvB,IAAI,EAAE,gBAAgB;gBACtB,IAAI,EAAE,SAAS;aAChB;YACD;gBACE,OAAO,EAAE,KAAK;gBACd,YAAY,EAAE,SAAS;gBACvB,IAAI,EAAE,iBAAiB;gBACvB,IAAI,EAAE,SAAS;aAChB;SACF;QACD,IAAI,EAAE,gBAAgB;QACtB,IAAI,EAAE,OAAO;KACd;IACD;QACE,MAAM,EAAE;YACN;gBACE,YAAY,EAAE,SAAS;gBACvB,IAAI,EAAE,WAAW;gBACjB,IAAI,EAAE,SAAS;aAChB;SACF;QACD,IAAI,EAAE,iBAAiB;QACvB,OAAO,EAAE;YACP;gBACE,YAAY,EAAE,SAAS;gBACvB,IAAI,EAAE,iBAAiB;gBACvB,IAAI,EAAE,SAAS;aAChB;SACF;QACD,eAAe,EAAE,MAAM;QACvB,IAAI,EAAE,UAAU;KACjB;IACD;QACE,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE;YACP;gBACE,YAAY,EAAE,SAAS;gBACvB,IAAI,EAAE,EAAE;gBACR,IAAI,EAAE,SAAS;aAChB;SACF;QACD,eAAe,EAAE,MAAM;QACvB,IAAI,EAAE,UAAU;KACjB;IACD;QACE,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,yBAAyB;QAC/B,OAAO,EAAE;YACP;gBACE,YAAY,EAAE,SAAS;gBACvB,IAAI,EAAE,EAAE;gBACR,IAAI,EAAE,SAAS;aAChB;SACF;QACD,eAAe,EAAE,MAAM;QACvB,IAAI,EAAE,UAAU;KACjB;IACD;QACE,MAAM,EAAE;YACN;gBACE,YAAY,EAAE,SAAS;gBACvB,IAAI,EAAE,UAAU;gBAChB,IAAI,EAAE,SAAS;aAChB;YACD;gBACE,YAAY,EAAE,SAAS;gBACvB,IAAI,EAAE,mBAAmB;gBACzB,IAAI,EAAE,SAAS;aAChB;YACD;gBACE,YAAY,EAAE,WAAW;gBACzB,IAAI,EAAE,iBAAiB;gBACvB,IAAI,EAAE,WAAW;aAClB;SACF;QACD,IAAI,EAAE,uBAAuB;QAC7B,OAAO,EAAE;YACP;gBACE,YAAY,EAAE,SAAS;gBACvB,IAAI,EAAE,gBAAgB;gBACtB,IAAI,EAAE,SAAS;aAChB;SACF;QACD,eAAe,EAAE,YAAY;QAC7B,IAAI,EAAE,UAAU;KACjB;IACD;QACE,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,kBAAkB;QACxB,OAAO,EAAE;YACP;gBACE,YAAY,EAAE,OAAO;gBACrB,IAAI,EAAE,EAAE;gBACR,IAAI,EAAE,OAAO;aACd;SACF;QACD,eAAe,EAAE,MAAM;QACvB,IAAI,EAAE,UAAU;KACjB;CACO,CAAC"}