Merge pull request #76 from MetaMask/refactor/rename-signatory-signer

Rename Signatory to Signer

Author: hanzel98

packages/delegation-toolkit/README.md

@@ -3,68 +3,75 @@
 The MetaMask Delegation Toolkit is a [Viem](https://viem.sh)-based collection of tools for integrating MetaMask embedded smart account and create frictionless new experiences based on granular permission sharing and trust.
 
 ## Features
+
 ---
+
 - **Smart Account Support**: Provides high-level API for deploying, and managing MetaMask smart account.
 - **Delegation Framework Support**: Comprehensive support for [ERC-7710](https://eips.ethereum.org/EIPS/eip-7710) to create, manage, and redeem delegations.
 - **Prebuilt Caveat Enforcers**: Prebuilt caveat enforcers for adding restrictions and conditions to delegations.
 - **Modular and Extensible**: Enables configuration of custom bundlers, paymasters, signers, and specialized caveat enforcers.
 - and many more...
 
-
 ## Installation
+
 ---
 
 Yarn:
+
 ```sh
 yarn add @metamask/delegation-toolkit
 ```
 
 Npm:
+
 ```sh
 npm install @metamask/delegation-toolkit
 ```
 
-## Overview 
+## Overview
+
 ---
 
 ```ts
-import { createPublicClient, http } from "viem";
-import { sepolia as chain } from "viem/chains";
-import { privateKeyToAccount } from "viem/accounts";
+import { createPublicClient, http } from 'viem';
+import { sepolia as chain } from 'viem/chains';
+import { privateKeyToAccount } from 'viem/accounts';
 import {
   Implementation,
   toMetaMaskSmartAccount,
-} from "@metamask/delegation-toolkit";
+} from '@metamask/delegation-toolkit';
 
 const publicClient = createPublicClient({
   chain,
   transport: http(),
 });
 
-const account = privateKeyToAccount("0x...");
+const account = privateKeyToAccount('0x...');
 
 const smartAccount = await toMetaMaskSmartAccount({
   client: publicClient,
   implementation: Implementation.Hybrid,
   deployParams: [account.address, [], [], []],
-  deploySalt: "0x",
-  signatory: { account },
+  deploySalt: '0x',
+  signer: { account },
 });
 ```
 
-
 ## Documentation
+
 ---
+
 [Head to our documentation](https://docs.gator.metamask.io) to learn more about the Delegation Toolkit.
 
 ## Contributing
+
 ---
 
 If you are interested in contributing, please [see the contribution guide](/CONTRIBUTING.md#Contributing).
 
-
 ## Useful Links
+
 - [Delegation Toolkit Quick start](https://docs.metamask.io/delegation-toolkit/get-started/quickstart/)
 - [Delegation Toolkit CLI Quick start](https://docs.metamask.io/delegation-toolkit/development/get-started/cli-quickstart/)
 - [Scaffold ETH extension](https://github.com/metamask/gator-extension)
-- [API reference](https://docs.metamask.io/delegation-toolkit/development/reference/)
+- [API reference](https://docs.metamask.io/delegation-toolkit/development/reference/)

packages/delegation-toolkit/src/index.ts

@@ -22,11 +22,11 @@ export type {
   MetaMaskSmartAccountImplementation,
   ToMetaMaskSmartAccountReturnType,
   MetaMaskSmartAccount,
-  WalletSignatoryConfig,
-  AccountSignatoryConfig,
-  WebAuthnSignatoryConfig,
-  HybridSignatoryConfig,
-  MultiSigSignatoryConfig,
+  WalletSignerConfig,
+  AccountSignerConfig,
+  WebAuthnSignerConfig,
+  HybridSignerConfig,
+  MultiSigSignerConfig,
   Delegation,
   Caveat,
 } from './types';

…ages/delegation-toolkit/src/signatory.ts packages/delegation-toolkit/src/signer.tspackages/delegation-toolkit/src/signatory.ts renamed to packages/delegation-toolkit/src/signer.ts packages/delegation-toolkit/src/signatory.ts renamed to packages/delegation-toolkit/src/signer.ts

@@ -10,13 +10,13 @@ import type { SignReturnType as WebAuthnSignReturnType } from 'webauthn-p256';
 import { Implementation } from './constants';
 import { aggregateSignature } from './signatures';
 import type {
-  AccountSignatoryConfig,
-  HybridSignatoryConfig,
-  InternalSignatory,
-  MultiSigSignatoryConfig,
-  SignatoryConfigByImplementation,
-  Stateless7702SignatoryConfig,
-  WalletSignatoryConfig,
+  AccountSignerConfig,
+  HybridSignerConfig,
+  InternalSigner,
+  MultiSigSignerConfig,
+  SignerConfigByImplementation,
+  Stateless7702SignerConfig,
+  WalletSignerConfig,
 } from './types';
 import {
   createDummyWebAuthnSignature,
@@ -27,9 +27,9 @@ import {
 const EOA_STUB_SIGNATURE =
   '0x000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000011b' as const;
 
-const resolveSignatoryFromWalletConfig = (
-  config: WalletSignatoryConfig,
-): InternalSignatory => {
+const resolveSignerFromWalletConfig = (
+  config: WalletSignerConfig,
+): InternalSigner => {
   return {
     signMessage: config.walletClient.signMessage,
     signTypedData: async (typedData) => {
@@ -40,22 +40,20 @@ const resolveSignatoryFromWalletConfig = (
   };
 };
 
-const resolveSignatoryFromAccountConfig = (config: AccountSignatoryConfig) => {
+const resolveSignerFromAccountConfig = (config: AccountSignerConfig) => {
   return {
     signMessage: config.account.signMessage,
     signTypedData: config.account.signTypedData,
     getStubSignature: async () => EOA_STUB_SIGNATURE,
   };
 };
 
-const resolveHybridSignatory = (
-  config: HybridSignatoryConfig,
-): InternalSignatory => {
+const resolveHybridSigner = (config: HybridSignerConfig): InternalSigner => {
   if ('walletClient' in config) {
-    return resolveSignatoryFromWalletConfig(config);
+    return resolveSignerFromWalletConfig(config);
   } else if ('account' in config) {
     const { signMessage, signTypedData, getStubSignature } =
-      resolveSignatoryFromAccountConfig(config);
+      resolveSignerFromAccountConfig(config);
     if (!signMessage) {
       throw new Error('Account does not support signMessage');
     }
@@ -100,23 +98,23 @@ const resolveHybridSignatory = (
   };
 };
 
-const resolveMultiSigSignatory = (
-  config: MultiSigSignatoryConfig,
-): InternalSignatory => {
-  const resolvedSignatories = config.map((signatory) => {
-    let individualSignMessage: InternalSignatory['signMessage'];
-    let individualSignTypedData: InternalSignatory['signTypedData'];
+const resolveMultiSigSigner = (
+  config: MultiSigSignerConfig,
+): InternalSigner => {
+  const resolvedSigners = config.map((signer) => {
+    let individualSignMessage: InternalSigner['signMessage'];
+    let individualSignTypedData: InternalSigner['signTypedData'];
     let address: Address;
-    if ('walletClient' in signatory) {
+    if ('walletClient' in signer) {
       const { signMessage, signTypedData } =
-        resolveSignatoryFromWalletConfig(signatory);
+        resolveSignerFromWalletConfig(signer);
       individualSignMessage = signMessage;
       individualSignTypedData = signTypedData;
 
-      address = signatory.walletClient.account.address;
+      address = signer.walletClient.account.address;
     } else {
       const { signMessage, signTypedData } =
-        resolveSignatoryFromAccountConfig(signatory);
+        resolveSignerFromAccountConfig(signer);
       if (!signMessage) {
         throw new Error('Account does not support signMessage');
       }
@@ -127,7 +125,7 @@ const resolveMultiSigSignatory = (
       individualSignMessage = signMessage;
       individualSignTypedData = signTypedData;
 
-      address = signatory.account.address;
+      address = signer.account.address;
     }
     return {
       address,
@@ -137,7 +135,7 @@ const resolveMultiSigSignatory = (
   });
 
   const signMessage = async (args: { message: SignableMessage }) => {
-    const addressAndSignatures = resolvedSignatories.map(
+    const addressAndSignatures = resolvedSigners.map(
       async ({ individualSignMessage, address }) => ({
         signature: await individualSignMessage(args),
         signer: address,
@@ -158,7 +156,7 @@ const resolveMultiSigSignatory = (
   >(
     typedDataDefinition: TypedDataDefinition<TTypedData, TPrimaryType>,
   ) => {
-    const addressAndSignatures = resolvedSignatories.map(
+    const addressAndSignatures = resolvedSigners.map(
       async ({ individualSignTypedData, address }) => ({
         signature: await individualSignTypedData(typedDataDefinition),
         signer: address,
@@ -174,7 +172,7 @@ const resolveMultiSigSignatory = (
   };
 
   const getStubSignature = async () =>
-    concat(resolvedSignatories.map(() => EOA_STUB_SIGNATURE));
+    concat(resolvedSigners.map(() => EOA_STUB_SIGNATURE));
 
   return {
     signMessage,
@@ -183,14 +181,14 @@ const resolveMultiSigSignatory = (
   };
 };
 
-const resolveStateless7702Signatory = (
-  config: Stateless7702SignatoryConfig,
-): InternalSignatory => {
+const resolveStateless7702Signer = (
+  config: Stateless7702SignerConfig,
+): InternalSigner => {
   if ('walletClient' in config) {
-    return resolveSignatoryFromWalletConfig(config);
+    return resolveSignerFromWalletConfig(config);
   } else if ('account' in config) {
     const { signMessage, signTypedData, getStubSignature } =
-      resolveSignatoryFromAccountConfig(config);
+      resolveSignerFromAccountConfig(config);
     if (!signMessage) {
       throw new Error('Account does not support signMessage');
     }
@@ -205,26 +203,22 @@ const resolveStateless7702Signatory = (
     };
   }
 
-  throw new Error('Invalid signatory config');
+  throw new Error('Invalid signer config');
 };
 
-export const resolveSignatory = <
-  TImplementation extends Implementation,
->(config: {
+export const resolveSigner = <TImplementation extends Implementation>(config: {
   implementation: TImplementation;
-  signatory: SignatoryConfigByImplementation<TImplementation>;
-}): InternalSignatory => {
+  signer: SignerConfigByImplementation<TImplementation>;
+}): InternalSigner => {
   const { implementation } = config;
 
   if (implementation === Implementation.Hybrid) {
-    return resolveHybridSignatory(config.signatory as HybridSignatoryConfig);
+    return resolveHybridSigner(config.signer as HybridSignerConfig);
   } else if (implementation === Implementation.MultiSig) {
-    return resolveMultiSigSignatory(
-      config.signatory as MultiSigSignatoryConfig,
-    );
+    return resolveMultiSigSigner(config.signer as MultiSigSignerConfig);
   } else if (implementation === Implementation.Stateless7702) {
-    return resolveStateless7702Signatory(
-      config.signatory as Stateless7702SignatoryConfig,
+    return resolveStateless7702Signer(
+      config.signer as Stateless7702SignerConfig,
     );
   }
   throw new Error(`Implementation type '${implementation}' not supported`);

packages/delegation-toolkit/src/toMetaMaskSmartAccount.ts

@@ -20,7 +20,7 @@ import {
 import { entryPointGetNonce as _getNonce } from './DelegationFramework/EntryPoint/read';
 import { getDeleGatorEnvironment } from './delegatorEnvironment';
 import { encodeCallsForCaller } from './encodeCalls';
-import { resolveSignatory } from './signatory';
+import { resolveSigner } from './signer';
 import type {
   Call,
   ToMetaMaskSmartAccountParameters,
@@ -59,9 +59,9 @@ export async function toMetaMaskSmartAccount<
     throw new Error('Chain not specified');
   }
 
-  const signatory = resolveSignatory({
+  const signer = resolveSigner({
     implementation,
-    signatory: params.signatory,
+    signer: params.signer,
   });
 
   const environment = params.environment ?? getDeleGatorEnvironment(chain.id);
@@ -132,7 +132,7 @@ export async function toMetaMaskSmartAccount<
       signature: '0x',
     });
 
-    const signature = signatory.signTypedData({
+    const signature = signer.signTypedData({
       domain: {
         chainId: chainId ?? chain.id,
         name: 'DelegationManager',
@@ -156,7 +156,7 @@ export async function toMetaMaskSmartAccount<
       signature: '0x',
     });
 
-    const signature = await signatory.signTypedData({
+    const signature = await signer.signTypedData({
       domain: {
         chainId: chainId ?? chain.id,
         name: contractName,
@@ -195,7 +195,7 @@ export async function toMetaMaskSmartAccount<
     getNonce,
     signUserOperation,
     signDelegation,
-    ...signatory,
+    ...signer,
   });
 
   // Override isDeployed only for EIP-7702 implementation to check proper delegation code