permissionless 0.1.19 → 0.1.21

package/accounts/kernel/utils/getNonceKey.ts

@@ -0,0 +1,32 @@
+import { type Address, concatHex, maxUint16, pad, toHex } from "viem"
+import { VALIDATOR_MODE, VALIDATOR_TYPE } from "../constants"
+import { type KernelVersion } from "../signerToEcdsaKernelSmartAccount"
+
+export const getNonceKeyWithEncoding = (
+    accountVerion: KernelVersion,
+    validatorAddress: Address,
+    nonceKey = 0n
+) => {
+    if (accountVerion === "0.2.2") {
+        return nonceKey
+    }
+
+    if (nonceKey > maxUint16)
+        throw new Error(
+            `nonce key must be equal or less than 2 bytes(maxUint16) for Kernel version ${accountVerion}`
+        )
+
+    const validatorMode = VALIDATOR_MODE.DEFAULT
+    const validatorType = VALIDATOR_TYPE.ROOT
+    const encoding = pad(
+        concatHex([
+            validatorMode, // 1 byte
+            validatorType, // 1 byte
+            validatorAddress, // 20 bytes
+            toHex(nonceKey, { size: 2 }) // 2 byte
+        ]),
+        { size: 24 }
+    ) // 24 bytes
+    const encodedNonceKey = BigInt(encoding)
+    return encodedNonceKey
+}

package/accounts/kernel/utils/signMessage.ts

@@ -0,0 +1,48 @@
+import {
+    type Account,
+    type Chain,
+    type Client,
+    type LocalAccount,
+    type SignMessageParameters,
+    type SignMessageReturnType,
+    type Transport,
+    hashMessage,
+    publicActions
+} from "viem"
+import { signMessage as _signMessage } from "viem/actions"
+import { type WrapMessageHashParams, wrapMessageHash } from "./wrapMessageHash"
+
+export async function signMessage<
+    TChain extends Chain | undefined,
+    TAccount extends Account | undefined
+>(
+    client: Client<Transport, TChain, TAccount>,
+    {
+        account: account_ = client.account,
+        message,
+        accountAddress,
+        accountVersion
+    }: SignMessageParameters<TAccount> & WrapMessageHashParams
+): Promise<SignMessageReturnType> {
+    if (accountVersion === "0.2.2") {
+        return _signMessage(client, {
+            account: account_ as LocalAccount,
+            message
+        })
+    }
+
+    const wrappedMessageHash = wrapMessageHash(hashMessage(message), {
+        accountVersion,
+        accountAddress,
+        chainId: client.chain
+            ? client.chain.id
+            : await client.extend(publicActions).getChainId()
+    })
+
+    const signature = await _signMessage(client, {
+        account: account_ as LocalAccount,
+        message: { raw: wrappedMessageHash }
+    })
+
+    return signature
+}

package/accounts/kernel/utils/signTypedData.ts

@@ -0,0 +1,74 @@
+import {
+    type Account,
+    type Chain,
+    type Client,
+    type LocalAccount,
+    type SignTypedDataParameters,
+    type SignTypedDataReturnType,
+    type Transport,
+    type TypedData,
+    getTypesForEIP712Domain,
+    hashTypedData,
+    publicActions,
+    validateTypedData
+} from "viem"
+
+import {
+    signMessage as _signMessage,
+    signTypedData as _signTypedData
+} from "viem/actions"
+import { type WrapMessageHashParams, wrapMessageHash } from "./wrapMessageHash"
+
+export async function signTypedData<
+    const typedData extends TypedData | Record<string, unknown>,
+    primaryType extends keyof typedData | "EIP712Domain",
+    chain extends Chain | undefined,
+    account extends Account | undefined
+>(
+    client: Client<Transport, chain, account>,
+    parameters: SignTypedDataParameters<typedData, primaryType, account> &
+        WrapMessageHashParams
+): Promise<SignTypedDataReturnType> {
+    const {
+        account: account_,
+        accountAddress,
+        accountVersion,
+        ...typedData
+    } = parameters as unknown as SignTypedDataParameters & WrapMessageHashParams
+    if (accountVersion === "0.2.2") {
+        return _signTypedData(client, { account: account_, ...typedData })
+    }
+    const { message, primaryType, types: _types, domain } = typedData
+    const types = {
+        EIP712Domain: getTypesForEIP712Domain({
+            domain: domain
+        }),
+        ..._types
+    }
+
+    // Need to do a runtime validation check on addresses, byte ranges, integer ranges, etc
+    // as we can't statically check this with TypeScript.
+    validateTypedData({
+        domain,
+        message,
+        primaryType,
+        types
+    })
+
+    const typedHash = hashTypedData({ message, primaryType, types, domain })
+
+    const wrappedMessageHash = wrapMessageHash(typedHash, {
+        accountVersion,
+        accountAddress,
+        chainId: client.chain
+            ? client.chain.id
+            : await client.extend(publicActions).getChainId()
+    })
+
+    const signature = await _signMessage(client, {
+        account: account_ as LocalAccount,
+        message: { raw: wrappedMessageHash }
+    })
+
+    return signature
+}

package/accounts/kernel/utils/wrapMessageHash.ts

@@ -0,0 +1,38 @@
+import {
+    type Hex,
+    concatHex,
+    encodeAbiParameters,
+    keccak256,
+    stringToHex
+} from "viem"
+import { type Address, domainSeparator } from "viem"
+
+export type WrapMessageHashParams = {
+    accountVersion: string
+    accountAddress: Address
+    chainId?: number
+}
+
+export const wrapMessageHash = (
+    messageHash: Hex,
+    { accountAddress, accountVersion, chainId }: WrapMessageHashParams
+) => {
+    const _domainSeparator = domainSeparator({
+        domain: {
+            name: "Kernel",
+            version: accountVersion,
+            chainId,
+            verifyingContract: accountAddress
+        }
+    })
+    const wrappedMessageHash = keccak256(
+        encodeAbiParameters(
+            [{ type: "bytes32" }, { type: "bytes32" }],
+            [keccak256(stringToHex("Kernel(bytes32 hash)")), messageHash]
+        )
+    )
+    const digest = keccak256(
+        concatHex(["0x1901", _domainSeparator, wrappedMessageHash])
+    )
+    return digest
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "permissionless",
-    "version": "0.1.19",
+    "version": "0.1.21",
     "author": "Pimlico",
     "homepage": "https://docs.pimlico.io/permissionless",
     "repository": "github:pimlicolabs/permissionless.js",