Merge pull request #194 from argentlabs/beta-ww-sdk

Beta - `connectAndSignSession` for `WebWallet`

Author: Aleksandar Cakalic

.github/workflows/release.yml

@@ -5,6 +5,7 @@ on:
       - develop
       - main
       - beta-braavos-mobile
+      - beta-ww-sdk
       - hotfix\/v[0-9]+.[0-9]+.[0-9]+
 
 jobs:

.releaserc

@@ -12,6 +12,10 @@
     {
       "name": "beta-braavos-mobile",
       "prerelease": true
+    },
+    {
+      "name": "beta-ww-sdk",
+      "prerelease": true
     }
   ],
   "plugins": [

package.json

@@ -1,6 +1,6 @@
 {
   "name": "starknetkit",
-  "version": "2.7.0",
+  "version": "2.8.0-beta-ww-sdk.1",
   "repository": "github:argentlabs/starknetkit",
   "private": false,
   "browser": {
@@ -117,7 +117,7 @@
     "zod": "^3.20.6"
   },
   "peerDependencies": {
-    "starknet": "^6.9.0"
+    "starknet": "^6.11.0"
   },
   "gitHead": "b16688a8638cc138938e74e1a39d004760165d75"
 }

pnpm-lock.yaml

@@ -0,0 +1,9 @@
+export class ConnectAndSignSessionError extends Error {
+  code: string
+
+  constructor(message: string, code: string) {
+    super(message)
+    this.name = "ConnectAndSignSessionError"
+    this.code = code
+  }
+}

src/connectors/webwallet/errors/index.ts

@@ -0,0 +1,40 @@
+import { z } from "zod"
+import { CallSchema, typedDataSchema } from "../../../types/window"
+
+export const connectAndSignSessionInputSchema = z.object({
+  callbackData: z.string().optional(),
+  approvalRequests: z.array(
+    z.object({
+      tokenAddress: z.string(),
+      amount: z.string(),
+      spender: z.string(),
+    }),
+  ),
+  sessionTypedData: typedDataSchema,
+})
+
+export const connectAndSignSessionOutputSchema = z.object({
+  account: z.string().array().optional(),
+  chainId: z.string().optional(),
+  signature: z.string().array().optional(),
+  approvalTransactionHash: z.string().optional(),
+  deploymentPayload: z.any().optional(),
+  approvalRequestsCalls: z.array(CallSchema).optional(),
+  errorCode: z
+    .enum([
+      "USER_REJECTED",
+      "ACCOUNT_NOT_DEPLOYED",
+      "NOT_ENOUGH_BALANCE",
+      "NOT_ENOUGH_BALANCE_DEPLOYMENT",
+      "GENERIC_ERROR",
+    ])
+    .optional(),
+})
+
+export type ConnectAndSignSessionInput = z.infer<
+  typeof connectAndSignSessionInputSchema
+>
+
+export type ConnectAndSignSessionOutput = z.infer<
+  typeof connectAndSignSessionOutputSchema
+>

src/connectors/webwallet/helpers/schema.ts

@@ -11,6 +11,10 @@ import {
   deployAccountContractSchema,
 } from "../../../types/window"
 import { DEFAULT_WEBWALLET_URL } from "../constants"
+import {
+  connectAndSignSessionInputSchema,
+  connectAndSignSessionOutputSchema,
+} from "./schema"
 
 const t = initTRPC.create({
   isServer: false,
@@ -84,6 +88,10 @@ const appRouter = t.router({
       }),
     )
     .mutation(async () => ({})),
+  connectAndSignSession: t.procedure
+    .input(connectAndSignSessionInputSchema)
+    .output(connectAndSignSessionOutputSchema)
+    .mutation(async () => ({})),
   enable: t.procedure.output(z.string()).mutation(async () => ""),
   execute: t.procedure
     .input(StarknetMethodArgumentsSchemas.execute)

src/connectors/webwallet/helpers/trpc.ts

@@ -5,11 +5,12 @@ import {
   type RpcTypeToMessageMap,
   type AccountChangeEventHandler,
   type StarknetWindowObject,
+  type TypedData,
 } from "@starknet-io/types-js"
 import {
   Account,
-  AccountInterface,
-  ProviderInterface,
+  type AccountInterface,
+  type ProviderInterface,
   type ProviderOptions,
 } from "starknet"
 import {
@@ -28,10 +29,13 @@ import {
 import { DEFAULT_WEBWALLET_ICON, DEFAULT_WEBWALLET_URL } from "./constants"
 import { openWebwallet } from "./helpers/openWebwallet"
 import { setPopupOptions } from "./helpers/trpc"
-import type {
-  Theme,
-  WebWalletStarknetWindowObject,
+import {
+  type Theme,
+  type WebWalletStarknetWindowObject,
 } from "./starknetWindowObject/argentStarknetWindowObject"
+import type { ApprovalRequest } from "./starknetWindowObject/types"
+import type { TRPCClientError } from "@trpc/client"
+import { ConnectAndSignSessionError } from "./errors"
 
 let _wallet: StarknetWindowObject | null = null
 let _address: string | null = null
@@ -57,21 +61,25 @@ export class WebWalletConnector extends Connector {
   }
 
   async ready(): Promise<boolean> {
-    if (!_wallet) {
-      this._wallet = null
-      _address = null
-      return false
+    if (!this._wallet) {
+      await this.ensureWallet()
     }
 
-    this._wallet = _wallet
-    try {
-      const permissions = await this._wallet.request({
-        type: "wallet_getPermissions",
-      })
+    if (!this._wallet) {
+      this._wallet = null
+      _address = null
 
-      return (permissions as Permission[]).includes(Permission.ACCOUNTS)
-    } catch {
       return false
+    } else {
+      try {
+        const permissions = await this._wallet.request({
+          type: "wallet_getPermissions",
+        })
+
+        return (permissions as Permission[]).includes(Permission.ACCOUNTS)
+      } catch {
+        return false
+      }
     }
   }
 
@@ -107,6 +115,48 @@ export class WebWalletConnector extends Connector {
     return "Powered by Argent"
   }
 
+  async connectAndSignSession({
+    callbackData,
+    approvalRequests,
+    sessionTypedData,
+  }: {
+    callbackData?: string
+    approvalRequests: ApprovalRequest[]
+    sessionTypedData: TypedData
+  }) {
+    await this.ensureWallet()
+
+    if (!this._wallet) {
+      throw new ConnectorNotFoundError()
+    }
+
+    try {
+      return await (
+        this._wallet as WebWalletStarknetWindowObject
+      ).connectAndSignSession({
+        callbackData,
+        approvalRequests,
+        sessionTypedData,
+      })
+    } catch (error) {
+      if (
+        error instanceof Error &&
+        (error.constructor.name === "TRPCClientError" ||
+          error.name === "TRPCClientError")
+      ) {
+        const trpcError = error as TRPCClientError<any>
+
+        const message =
+          trpcError.shape.data.webwalletErrorMessage || trpcError.message
+        const code =
+          trpcError.shape.data.webwalletErrorCode || trpcError.shape.message
+
+        throw new ConnectAndSignSessionError(message, code)
+      }
+      throw new Error(error instanceof Error ? error.message : String(error))
+    }
+  }
+
   async connect(_args: ConnectArgs = {}): Promise<ConnectorData> {
     await this.ensureWallet()
 
@@ -240,4 +290,5 @@ export class WebWalletConnector extends Connector {
   }
 }
 
-export type { WebWalletStarknetWindowObject }
+export type { WebWalletStarknetWindowObject, ApprovalRequest }
+export { ConnectAndSignSessionError }

src/connectors/webwallet/index.ts

@@ -3,6 +3,7 @@ import type {
   NetworkChangeEventHandler,
   RpcTypeToMessageMap,
   StarknetWindowObject,
+  TypedData,
   WalletEvents,
 } from "@starknet-io/types-js"
 import type { CreateTRPCProxyClient } from "@trpc/client"
@@ -13,7 +14,9 @@ import {
   SIGN_MESSAGE_POPUP_HEIGHT,
   SIGN_MESSAGE_POPUP_WIDTH,
 } from "../helpers/popupSizes"
+import type { ConnectAndSignSessionOutput } from "../helpers/schema"
 import { setPopupOptions, type AppRouter } from "../helpers/trpc"
+import type { ApprovalRequest } from "./types"
 
 export const userEventHandlers: WalletEvents[] = []
 
@@ -52,6 +55,15 @@ export type WebWalletStarknetWindowObject = StarknetWindowObject & {
     account?: string[]
     chainId?: string
   }>
+  connectAndSignSession({
+    callbackData,
+    approvalRequests,
+    sessionTypedData,
+  }: {
+    callbackData?: string
+    approvalRequests: ApprovalRequest[]
+    sessionTypedData: TypedData
+  }): Promise<ConnectAndSignSessionOutput>
 }
 
 export const getArgentStarknetWindowObject = (
@@ -67,6 +79,10 @@ export const getArgentStarknetWindowObject = (
       const { theme } = props
       return proxyLink.connectWebwallet.mutate({ theme })
     },
+    connectAndSignSession: (props) => {
+      console.log("connectAndSignSession", props)
+      return proxyLink.connectAndSignSession.mutate(props)
+    },
     connectWebwalletSSO: (token, authorizedPartyId) => {
       return proxyLink.connectWebwalletSSO.mutate({ token, authorizedPartyId })
     },

src/connectors/webwallet/starknetWindowObject/argentStarknetWindowObject.ts

@@ -0,0 +1,9 @@
+export type Hex = `0x${string}`
+
+export type Address = Hex
+
+export type ApprovalRequest = {
+  tokenAddress: Address
+  amount: string
+  spender: Address
+}