@abstract-foundation/agw-client/src/actions/signTransaction.ts

Abstract Global Wallet Client SDK

import {
  type Account,
  type Address,
  BaseError,
  type Client,
  encodeAbiParameters,
  type Hex,
  parseAbiParameters,
  type PublicClient,
  type Transport,
  type UnionRequiredBy,
  type WalletClient,
} from 'viem';
import { getChainId, readContract, signTypedData } from 'viem/actions';
import { assertCurrentChain, getAction, parseAccount } from 'viem/utils';
import {
  type ChainEIP712,
  type SignEip712TransactionParameters,
  type SignEip712TransactionReturnType,
  type TransactionRequestEIP712,
} from 'viem/zksync';

import AGWAccountAbi from '../abis/AGWAccount.js';
import {
  assertEip712Request,
  type AssertEip712RequestParameters,
} from '../eip712.js';
import { AccountNotFoundError } from '../errors/account.js';
import { assertSessionKeyPolicies } from '../sessionValidator.js';
import type { CustomPaymasterHandler } from '../types/customPaymaster.js';
import { VALID_CHAINS } from '../utils.js';
import { transformHexValues } from '../utils.js';
import { signPrivyTransaction } from './sendPrivyTransaction.js';

export async function signTransaction<
  chain extends ChainEIP712 | undefined = ChainEIP712 | undefined,
  account extends Account | undefined = Account | undefined,
  chainOverride extends ChainEIP712 | undefined = ChainEIP712 | undefined,
>(
  client: Client<Transport, ChainEIP712, Account>,
  signerClient: WalletClient<Transport, ChainEIP712, Account>,
  publicClient: PublicClient<Transport, ChainEIP712>,
  args: SignEip712TransactionParameters<chain, account, chainOverride>,
  validator: Address,
  validationHookData: Record<string, Hex> = {},
  customPaymasterHandler: CustomPaymasterHandler | undefined = undefined,
  isPrivyCrossApp = false,
): Promise<SignEip712TransactionReturnType> {
  const chain = client.chain;

  if (isPrivyCrossApp) {
    return signPrivyTransaction(client, args);
  }

  if (!chain?.serializers?.transaction)
    throw new BaseError('transaction serializer not found on chain.');

  const { transaction, customSignature } = await signEip712TransactionInternal(
    client,
    signerClient,
    publicClient,
    args,
    validator,
    validationHookData,
    customPaymasterHandler,
  );

  return chain.serializers.transaction(
    {
      ...transaction,
      customSignature,
      type: 'eip712',
    } as any,
    { r: '0x0', s: '0x0', v: 0n },
  ) as SignEip712TransactionReturnType;
}

export async function signEip712TransactionInternal<
  chain extends ChainEIP712 | undefined = ChainEIP712 | undefined,
  account extends Account | undefined = Account | undefined,
  chainOverride extends ChainEIP712 | undefined = ChainEIP712 | undefined,
>(
  client: Client<Transport, ChainEIP712, Account>,
  signerClient: WalletClient<Transport, ChainEIP712, Account>,
  publicClient: PublicClient<Transport, ChainEIP712>,
  args: SignEip712TransactionParameters<chain, account, chainOverride>,
  validator: Address,
  validationHookData: Record<string, Hex> = {},
  customPaymasterHandler: CustomPaymasterHandler | undefined = undefined,
): Promise<{
  transaction: UnionRequiredBy<TransactionRequestEIP712, 'from'> & {
    chainId: number;
  };
  customSignature: Hex;
}> {
  // ensure the transaction type is set to eip712
  args.type = 'eip712';

  const {
    account: account_ = client.account,
    chain = client.chain,
    ...transaction
  } = args;

  transformHexValues(transaction, [
    'value',
    'nonce',
    'maxFeePerGas',
    'maxPriorityFeePerGas',
    'gas',
    'chainId',
    'gasPerPubdata',
  ]);

  if (!account_)
    throw new AccountNotFoundError({
      docsPath: '/docs/actions/wallet/signTransaction',
    });
  const smartAccount = parseAccount(account_);
  const useSignerAddress =
    (transaction as any).from === signerClient.account.address;
  const fromAccount = useSignerAddress ? signerClient.account : smartAccount;

  assertEip712Request({
    account: fromAccount,
    chain,
    ...(transaction as AssertEip712RequestParameters),
  });

  if (!chain || VALID_CHAINS[chain.id] === undefined) {
    throw new BaseError('Invalid chain specified');
  }

  if (!chain?.custom?.getEip712Domain)
    throw new BaseError('`getEip712Domain` not found on chain.');

  const chainId = await getAction(client, getChainId, 'getChainId')({});
  if (chain !== null)
    assertCurrentChain({
      currentChainId: chainId,
      chain: chain,
    });

  await assertSessionKeyPolicies(
    publicClient,
    chainId,
    fromAccount,
    transaction,
  );

  const transactionWithPaymaster = await getTransactionWithPaymasterData(
    chainId,
    fromAccount,
    transaction,
    customPaymasterHandler,
  );

  if (transactionWithPaymaster.data === undefined) {
    // serializer turns undefined into 0x00 which causes issues sending
    // eth to contracts that don't have a fallback function
    transactionWithPaymaster.data = '0x';
  }

  const eip712Domain = chain?.custom.getEip712Domain({
    ...transactionWithPaymaster,
    type: 'eip712',
  });

  const rawSignature = await signTypedData(signerClient, {
    ...eip712Domain,
    account: signerClient.account,
  });

  let signature;
  if (useSignerAddress) {
    signature = rawSignature;
  } else {
    const hookData: Hex[] = [];
    if (!useSignerAddress) {
      const validationHooks = await getAction(
        client,
        readContract,
        'readContract',
      )({
        address: client.account.address,
        abi: AGWAccountAbi,
        functionName: 'listHooks',
        args: [true],
      });
      for (const hook of validationHooks) {
        hookData.push(validationHookData[hook] ?? '0x');
      }
    }
    // Match the expect signature format of the AGW smart account
    signature = encodeAbiParameters(
      parseAbiParameters(['bytes', 'address', 'bytes[]']),
      [rawSignature, validator, hookData],
    );
  }

  return {
    transaction: transactionWithPaymaster,
    customSignature: signature,
  };
}

async function getTransactionWithPaymasterData(
  chainId: number,
  fromAccount: Account,
  transaction: TransactionRequestEIP712,
  customPaymasterHandler: CustomPaymasterHandler | undefined = undefined,
): Promise<
  UnionRequiredBy<TransactionRequestEIP712, 'from'> & { chainId: number }
> {
  if (
    customPaymasterHandler &&
    !transaction.paymaster &&
    !transaction.paymasterInput
  ) {
    const paymasterResult = await customPaymasterHandler({
      chainId,
      from: fromAccount.address,
      data: transaction.data,
      gas: transaction.gas ?? 0n,
      gasPrice: transaction.gasPrice ?? 0n,
      gasPerPubdata: transaction.gasPerPubdata ?? 0n,
      maxFeePerGas: transaction.maxFeePerGas ?? 0n,
      maxPriorityFeePerGas: transaction.maxPriorityFeePerGas ?? 0n,
      nonce: transaction.nonce ?? 0,
      to: transaction.to ?? '0x0',
      value: transaction.value ?? 0n,
    });
    return {
      ...transaction,
      ...paymasterResult,
      from: fromAccount.address,
      chainId,
    };
  }
  return {
    ...transaction,
    from: fromAccount.address,
    chainId,
  };
}