eip-712 signer sdk (#344)

* Add yarn lock

* sdk: add support for EIP712 signing

* tests: add eip712 encoder tests

* remove eslint from tests

* Add test setup for full integration test

* Fix SignTypedMessageLib tests

* add a chai failing test

* fix integration test hardhat setup

* scopeSignTypedMessage tests

* format files

* use renamed AbiType

* Add MockEIP712Encoder test contract to expose EIP712Encoder functions

* fix: replace ParameterType with AbiType in app components

* docs: replace ParameterType with AbiType in examples and components

---------

Co-authored-by: Jan-Felix <jfschwarz@users.noreply.github.com>
Co-authored-by: Cristóvão <cristovaoth@users.noreply.github.com>

Author: cristovaoth

packages/app/components/permissions/ConditionView/ConditionHeader.tsx

@@ -1,4 +1,4 @@
-import { Condition, Operator, ParameterType } from "zodiac-roles-sdk"
+import { AbiType, Condition, Operator } from "zodiac-roles-sdk"
 import { AbiFunction, AbiParameter } from "viem"
 import { ReactNode } from "react"
 import { BsLightningCharge } from "react-icons/bs"
@@ -28,16 +28,15 @@ const ConditionHeader: React.FC<Props> = ({
   const paramName =
     paramIndex !== undefined ? abi?.name || `[${paramIndex}]` : "" // e.g.: array elements don't have a param name
 
-  const paramTypeLabel =
-    !abi || "inputs" in abi ? ParameterType[paramType] : abi.type
+  const paramTypeLabel = !abi || "inputs" in abi ? AbiType[paramType] : abi.type
 
   const abiMismatch = abi && condition && !matchesAbi(condition, abi)
 
   const operatorLabel = OperatorLabels[operator] || Operator[operator]
 
   // only conditions that aren't used are collapsible
   const isCollapsible =
-    paramType >= ParameterType.Tuple &&
+    paramType >= AbiType.Tuple &&
     !(
       condition.operator >= Operator.Matches &&
       condition.operator <= Operator.ArraySubset
@@ -74,7 +73,7 @@ const ConditionHeader: React.FC<Props> = ({
               >
                 {paramTypeLabel}
                 <BsLightningCharge />
-                {ParameterType[paramType]}
+                {AbiType[paramType]}
               </Flex>
             ) : (
               paramTypeLabel

packages/app/components/permissions/ConditionView/index.tsx

@@ -1,4 +1,4 @@
-import { Condition, Operator, ParameterType } from "zodiac-roles-sdk"
+import { AbiType, Condition, Operator } from "zodiac-roles-sdk"
 import { Fragment, ReactNode } from "react"
 import { AbiFunction, AbiParameter, decodeAbiParameters, toHex } from "viem"
 
@@ -21,7 +21,7 @@ export interface Props {
 }
 
 const ConditionView: React.FC<Props> = ({ condition, paramIndex, abi }) => {
-  if (condition.paramType === ParameterType.Calldata) {
+  if (condition.paramType === AbiType.Calldata) {
     return (
       <CalldataConditionView
         condition={condition}
@@ -186,7 +186,7 @@ export const ChildConditions: React.FC<
 > = ({ condition, paramIndex, abi, separator }) => {
   const { children, operator } = condition
   const childrenLength = children?.length || 0
-  const isCalldataCondition = condition.paramType === ParameterType.Calldata
+  const isCalldataCondition = condition.paramType === AbiType.Calldata
   const isLogicalCondition =
     operator >= Operator.And && operator <= Operator.Nor
 

packages/app/components/permissions/ConditionView/utils.ts

@@ -1,27 +1,27 @@
 import { arrayElementType, isStaticType } from "@/utils/abi"
 import { AbiFunction, AbiParameter } from "viem"
-import { Condition, Operator, ParameterType } from "zodiac-roles-sdk"
+import { AbiType, Condition, Operator } from "zodiac-roles-sdk"
 
 /** Validates if the given ABI fragments matches the condition node's paramType */
 export const matchesAbi = (
   condition: Condition,
   abi: AbiFunction | AbiParameter
 ): boolean => {
   switch (condition.paramType) {
-    case ParameterType.None:
+    case AbiType.None:
       return true
-    case ParameterType.Static:
+    case AbiType.Static:
       return abi.type !== "function" && isStaticType(abi)
-    case ParameterType.Dynamic:
+    case AbiType.Dynamic:
       return abi.type === "function" || !isStaticType(abi)
-    case ParameterType.Tuple:
+    case AbiType.Tuple:
       return "components" in abi && !!abi.components && !arrayElementType(abi)
-    case ParameterType.Array:
+    case AbiType.Array:
       const elementType = arrayElementType(abi)
       return !!elementType
-    case ParameterType.Calldata:
+    case AbiType.Calldata:
       abi.type === "bytes" || abi.type === "function"
-    case ParameterType.AbiEncoded:
+    case AbiType.AbiEncoded:
       return abi.type === "bytes"
   }
 }

packages/app/components/permissions/schema.ts

@@ -3,7 +3,7 @@ import z from "zod"
 import {
   Condition,
   Operator,
-  ParameterType,
+  AbiType,
   Clearance,
   ExecutionOptions,
 } from "zodiac-roles-sdk"
@@ -26,7 +26,7 @@ export const zHex = z
   .transform((value) => value.toLowerCase() as `0x${string}`)
 
 const zCondition = z.object({
-  paramType: z.nativeEnum(ParameterType),
+  paramType: z.nativeEnum(AbiType),
   operator: z.nativeEnum(Operator),
   compValue: zHex.optional(),
   children: z.lazy(() => z.array(zCondition)).optional(),

packages/deployments/src/types.ts

@@ -15,7 +15,7 @@ export enum Clearance {
   Function = 2,
 }
 
-export enum ParameterType {
+export enum AbiType {
   None = 0,
   Static = 1,
   Dynamic = 2,
@@ -132,7 +132,7 @@ export interface Function {
 }
 
 export interface Condition {
-  paramType: ParameterType
+  paramType: AbiType
   operator: Operator
   compValue?: `0x${string}`
   children?: readonly Condition[]

packages/docs/components/conditionsExamples/index.tsx

@@ -1,5 +1,5 @@
 "use client";
-import { Condition, Operator, ParameterType } from "zodiac-roles-sdk";
+import { AbiType, Condition, Operator } from "zodiac-roles-sdk";
 import AbiTree from "@/components/tree/AbiTree";
 import ConditionTree, { gatherNodeIds } from "@/components/tree/ConditionTree";
 import clsx from "clsx";
@@ -144,93 +144,93 @@ const balancerSwapInputs = [
 ];
 
 const balancerSwapCondition: Condition = {
-  paramType: ParameterType.Calldata,
+  paramType: AbiType.Calldata,
   operator: Operator.Matches,
   children: [
     {
-      paramType: ParameterType.Tuple,
+      paramType: AbiType.Tuple,
       operator: Operator.Matches,
       children: [
         {
           // poolId
-          paramType: ParameterType.Static,
+          paramType: AbiType.Static,
           operator: Operator.EqualTo,
           compValue:
             "0x0b09dea16768f0799065c475be02919503cb2a3500020000000000000000001a",
         },
         {
           // kind
-          paramType: ParameterType.Static,
+          paramType: AbiType.Static,
           operator: Operator.Pass,
         },
         {
           // assetIn
-          paramType: ParameterType.None,
+          paramType: AbiType.None,
           operator: Operator.Or,
           children: [
             {
-              paramType: ParameterType.Static,
+              paramType: AbiType.Static,
               operator: Operator.EqualTo,
               compValue: "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2",
             }, // WETH
             {
-              paramType: ParameterType.Static,
+              paramType: AbiType.Static,
               operator: Operator.EqualTo,
               compValue: "0x6b175474e89094c44da98b954eedeac495271d0f",
             }, // DAI
           ],
         },
         {
           // assetOut
-          paramType: ParameterType.None,
+          paramType: AbiType.None,
           operator: Operator.Or,
           children: [
             {
-              paramType: ParameterType.Static,
+              paramType: AbiType.Static,
               operator: Operator.EqualTo,
               compValue: "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2",
             }, // WETH
             {
-              paramType: ParameterType.Static,
+              paramType: AbiType.Static,
               operator: Operator.EqualTo,
               compValue: "0x6b175474e89094c44da98b954eedeac495271d0f",
             }, // DAI
           ],
         },
         {
           // amount
-          paramType: ParameterType.Static,
+          paramType: AbiType.Static,
           operator: Operator.Pass,
         },
         {
           // userDatq
-          paramType: ParameterType.Dynamic,
+          paramType: AbiType.Dynamic,
           operator: Operator.Pass,
         },
       ],
     },
     {
-      paramType: ParameterType.Tuple,
+      paramType: AbiType.Tuple,
       operator: Operator.Matches,
       children: [
         {
           // sender
-          paramType: ParameterType.Static,
+          paramType: AbiType.Static,
           operator: Operator.EqualToAvatar,
         },
         {
           // fromInternalBalance
-          paramType: ParameterType.Static,
+          paramType: AbiType.Static,
           operator: Operator.Pass,
         },
         {
           // recipient
-          paramType: ParameterType.Static,
+          paramType: AbiType.Static,
           operator: Operator.EqualToAvatar,
         },
         {
           // toInternalBalance
-          paramType: ParameterType.Static,
+          paramType: AbiType.Static,
           operator: Operator.Pass,
         },
       ],

packages/docs/components/tree/ConditionTree/index.tsx

@@ -1,5 +1,5 @@
 import React from "react";
-import { Condition, Operator, ParameterType } from "zodiac-roles-sdk";
+import { AbiType, Condition, Operator } from "zodiac-roles-sdk";
 import styles from "./styles.module.css";
 import Tree, { TreeProps } from "../Tree";
 import Node from "../Node/index";
@@ -16,7 +16,7 @@ const ConditionTree: React.FC<Props & TreeProps> = ({ condition, ...rest }) => {
     path = "0",
     abiPath = "0"
   ) => {
-    const isNotPlucking = condition.paramType === ParameterType.None;
+    const isNotPlucking = condition.paramType === AbiType.None;
     return (
       <Node
         key={path}
@@ -47,7 +47,7 @@ const ConditionHead: React.FC<{ condition: Condition }> = ({ condition }) => (
         {hexEllipsis(condition.compValue)}
       </code>
     )}
-    <code className={styles.type}>{ParameterType[condition.paramType]}</code>
+    <code className={styles.type}>{AbiType[condition.paramType]}</code>
   </div>
 );
 
@@ -56,7 +56,7 @@ export const gatherNodeIds = (
   path = "0",
   abiPath = "0"
 ): string[] => {
-  const isNotPlucking = condition.paramType === ParameterType.None;
+  const isNotPlucking = condition.paramType === AbiType.None;
   return [
     abiPath,
     ...(condition.children?.flatMap((child, index) =>

packages/docs/content/sdk/architecture.mdx

@@ -16,11 +16,11 @@ This layer has diffing & patching functions on role configurations, operating on
     {
       selector: "0x84e9bd7e",
       condition: {
-        paramType: ParameterType.Calldata,
+        paramType: AbiType.Calldata,
         operator: Operator.Matches,
         children: [
           {
-            paramType: ParameterType.Static,
+            paramType: AbiType.Static,
             operator: Operator.EqualTo,
             compValue: defaultAbiCoder.encode(["address"], ["0x4F2083f5fBede34C2714aFfb3105539775f7FE64"]),
           }

packages/evm/contracts/test/MockEIP712Encoder.sol

@@ -0,0 +1,25 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+pragma solidity >=0.8.21 <0.9.0;
+
+import "../periphery/EIP712Encoder.sol";
+
+/**
+ * @title MockEIP712Encoder - Test wrapper for EIP712Encoder
+ * @dev Exposes internal EIP712Encoder functions for integration testing
+ */
+contract MockEIP712Encoder {
+    function hashTypedMessage(
+        bytes calldata domain,
+        bytes calldata message,
+        EIP712Encoder.Types calldata types
+    ) external pure returns (bytes32) {
+        return EIP712Encoder.hashTypedMessage(domain, message, types);
+    }
+
+    function hashTypedDomain(
+        bytes calldata data,
+        EIP712Encoder.Types calldata types
+    ) external pure returns (bytes32) {
+        return EIP712Encoder.hashTypedDomain(data, types);
+    }
+}

packages/evm/contracts/test/MultiSend.sol

@@ -1,11 +1,6 @@
 // SPDX-License-Identifier: LGPL-3.0-only
 pragma solidity >=0.8.17 <0.9.0;
 
-/// @title Multi Send - Allows to batch multiple transactions into one.
-/// @author Nick Dodson - <nick.dodson@consensys.net>
-/// @author Gonçalo Sá - <goncalo.sa@consensys.net>
-/// @author Stefan George - <stefan@gnosis.io>
-/// @author Richard Meissner - <richard@gnosis.io>
 contract MultiSend {
     address private immutable multisendSingleton;