viem 0.0.0-main.20240526T170333 → 0.0.0-main.20240527T071914

package/experimental/eip3074/constants/abis.ts

@@ -1,119 +0,0 @@
-export const invokerAbi = [
-  {
-    type: 'function',
-    name: 'execute',
-    inputs: [
-      {
-        name: 'execData',
-        type: 'bytes',
-        internalType: 'bytes',
-      },
-      {
-        name: 'signature',
-        type: 'tuple',
-        internalType: 'struct Auth.Signature',
-        components: [
-          {
-            name: 'signer',
-            type: 'address',
-            internalType: 'address',
-          },
-          {
-            name: 'yParity',
-            type: 'uint8',
-            internalType: 'uint8',
-          },
-          {
-            name: 'r',
-            type: 'bytes32',
-            internalType: 'bytes32',
-          },
-          {
-            name: 's',
-            type: 'bytes32',
-            internalType: 'bytes32',
-          },
-        ],
-      },
-    ],
-    outputs: [],
-    stateMutability: 'nonpayable',
-  },
-  {
-    type: 'function',
-    name: 'getDigest',
-    inputs: [
-      {
-        name: 'execData',
-        type: 'bytes',
-        internalType: 'bytes',
-      },
-      {
-        name: 'nonce',
-        type: 'uint256',
-        internalType: 'uint256',
-      },
-    ],
-    outputs: [
-      {
-        name: 'digest',
-        type: 'bytes32',
-        internalType: 'bytes32',
-      },
-    ],
-    stateMutability: 'view',
-  },
-  {
-    type: 'function',
-    name: 'multiSend',
-    inputs: [
-      {
-        name: 'transactions',
-        type: 'bytes',
-        internalType: 'bytes',
-      },
-    ],
-    outputs: [],
-    stateMutability: 'payable',
-  },
-  {
-    type: 'function',
-    name: 'nextNonce',
-    inputs: [
-      {
-        name: '',
-        type: 'address',
-        internalType: 'address',
-      },
-    ],
-    outputs: [
-      {
-        name: '',
-        type: 'uint256',
-        internalType: 'uint256',
-      },
-    ],
-    stateMutability: 'view',
-  },
-  {
-    type: 'error',
-    name: 'BadAuth',
-    inputs: [],
-  },
-  {
-    type: 'error',
-    name: 'InvalidNonce',
-    inputs: [
-      {
-        name: 'authority',
-        type: 'address',
-        internalType: 'address',
-      },
-      {
-        name: 'attempted',
-        type: 'uint256',
-        internalType: 'uint256',
-      },
-    ],
-  },
-] as const

package/experimental/eip3074/decorators/eip3074.ts

@@ -1,58 +0,0 @@
-import type { Client } from '../../../clients/createClient.js'
-import type { Transport } from '../../../clients/transports/createTransport.js'
-import type { Account } from '../../../types/account.js'
-import type { Chain } from '../../../types/chain.js'
-import {
-  type SignAuthMessageParameters,
-  type SignAuthMessageReturnType,
-  signAuthMessage,
-} from '../actions/signAuthMessage.js'
-
-export type WalletActionsEip3074<
-  chain extends Chain | undefined = Chain | undefined,
-  account extends Account | undefined = Account | undefined,
-> = {
-  signAuthMessage: <
-    chainOverride extends Chain | undefined = undefined,
-    accountOverride extends Account | undefined = undefined,
-  >(
-    parameters: SignAuthMessageParameters<
-      chain,
-      account,
-      chainOverride,
-      accountOverride
-    >,
-  ) => Promise<SignAuthMessageReturnType>
-}
-
-/**
- * A suite of EIP-3074 Wallet Actions.
- *
- * - Docs: https://viem.sh/experimental
- *
- * @example
- * import { createPublicClient, createWalletClient, http } from 'viem'
- * import { mainnet } from 'viem/chains'
- * import { walletActionsEip3074 } from 'viem/experimental'
- *
- * const walletClient = createWalletClient({
- *   chain: mainnet,
- *   transport: http(),
- * }).extend(walletActionsEip3074())
- *
- * const signature = await walletClient.signAuthMessage({...})
- */
-export function walletActionsEip3074() {
-  return <
-    transport extends Transport,
-    chain extends Chain | undefined = Chain | undefined,
-    account extends Account | undefined = Account | undefined,
-  >(
-    client: Client<transport, chain, account>,
-  ): WalletActionsEip3074<chain, account> => {
-    return {
-      signAuthMessage: (parameters) =>
-        signAuthMessage(client as any, parameters),
-    }
-  }
-}

package/experimental/eip3074/invokers/coders/batchInvokerCoder.ts

@@ -1,46 +0,0 @@
-import type { Address } from 'abitype'
-import { readContract } from '../../../../actions/public/readContract.js'
-import type { Hex } from '../../../../types/misc.js'
-import { encodeAbiParameters } from '../../../../utils/abi/encodeAbiParameters.js'
-import { encodePacked } from '../../../../utils/abi/encodePacked.js'
-import { concat } from '../../../../utils/data/concat.js'
-import { size } from '../../../../utils/data/size.js'
-import { invokerAbi } from '../../constants/abis.js'
-import { defineInvokerCoder } from './defineInvokerCoder.js'
-
-type Calls = readonly {
-  to: Address
-  data?: Hex | undefined
-  value?: bigint | undefined
-}[]
-
-export type BatchInvokerArgs = Calls
-
-export function batchInvokerCoder() {
-  return defineInvokerCoder({
-    async toExecData(
-      args: BatchInvokerArgs,
-      { authority, client, invokerAddress },
-    ) {
-      const nonce = await readContract(client, {
-        abi: invokerAbi,
-        address: invokerAddress,
-        functionName: 'nextNonce',
-        args: [authority],
-      })
-
-      const calls = concat(
-        args.map(({ data = '0x', to, value = 0n }) =>
-          encodePacked(
-            ['uint8', 'address', 'uint256', 'uint256', 'bytes'],
-            [2, to, value, BigInt(size(data)), data],
-          ),
-        ),
-      )
-      return encodeAbiParameters(
-        [{ type: 'uint256' }, { type: 'bytes' }],
-        [nonce, calls],
-      )
-    },
-  })
-}

package/experimental/eip3074/invokers/coders/defineInvokerCoder.ts

@@ -1,20 +0,0 @@
-import type { Address } from 'abitype'
-import type { Client } from '../../../../clients/createClient.js'
-import type { Hex } from '../../../../types/misc.js'
-
-export type InvokerCoder<args = unknown> = {
-  toExecData: (
-    args: args,
-    options: { authority: Address; client: Client; invokerAddress: Hex },
-  ) => Promise<Hex>
-}
-
-export type DefineInvokerCoderParameters<args = unknown> = InvokerCoder<args>
-
-export type DefineInvokerCoderReturnType<args = unknown> = InvokerCoder<args>
-
-export function defineInvokerCoder<args>(
-  parameters: DefineInvokerCoderParameters<args>,
-): DefineInvokerCoderReturnType<args> {
-  return parameters
-}

package/experimental/eip3074/invokers/getInvoker.ts

@@ -1,192 +0,0 @@
-import type { Address } from 'abitype'
-import {
-  type GetTransactionCountErrorType,
-  getTransactionCount,
-} from '../../../actions/public/getTransactionCount.js'
-import {
-  type WriteContractErrorType,
-  writeContract,
-} from '../../../actions/wallet/writeContract.js'
-import type { Client } from '../../../clients/createClient.js'
-import type { Transport } from '../../../clients/transports/createTransport.js'
-import type { ErrorType } from '../../../errors/utils.js'
-import type { Account, LocalAccount } from '../../../types/account.js'
-import type { Chain, GetChainParameter } from '../../../types/chain.js'
-import type { Hex } from '../../../types/misc.js'
-import type { IsUndefined } from '../../../types/utils.js'
-import { parseAccount } from '../../../utils/accounts.js'
-import {
-  type IsAddressEqualErrorType,
-  isAddressEqual,
-} from '../../../utils/address/isAddressEqual.js'
-import { getAction } from '../../../utils/getAction.js'
-import {
-  type Keccak256ErrorType,
-  keccak256,
-} from '../../../utils/hash/keccak256.js'
-import {
-  type ParseSignatureErrorType,
-  parseSignature,
-} from '../../../utils/signature/parseSignature.js'
-import {
-  type SignAuthMessageErrorType,
-  signAuthMessage,
-} from '../actions/signAuthMessage.js'
-import { invokerAbi } from '../constants/abis.js'
-import type { InvokerCoder } from './coders/defineInvokerCoder.js'
-
-type GetExecutorParameter<
-  TAccount extends Account | undefined = Account | undefined,
-  TAccountOverride extends Account | Address | undefined = Account | Address,
-  TRequired extends boolean = true,
-> = IsUndefined<TAccount> extends true
-  ? TRequired extends true
-    ? { executor: TAccountOverride | Account | Address }
-    : { executor?: TAccountOverride | Account | Address | undefined }
-  : { executor?: TAccountOverride | Account | Address | undefined }
-
-export type InvokerExecuteParameters<
-  account extends Account | undefined = Account | undefined,
-  chain extends Chain | undefined = Chain | undefined,
-  chainOverride extends Chain | undefined = Chain | undefined,
-  args = unknown,
-> = {
-  args: args
-  authority: Account | Address
-  signature: Hex
-} & GetExecutorParameter<account> &
-  GetChainParameter<chain, chainOverride>
-
-export type InvokerExecuteErrorType =
-  | WriteContractErrorType
-  | ParseSignatureErrorType
-  | ErrorType
-
-export type InvokerSignParameters<
-  account extends Account | undefined = Account | undefined,
-  chain extends Chain | undefined = Chain | undefined,
-  chainOverride extends Chain | undefined = Chain | undefined,
-  args = unknown,
-> = {
-  args: args
-  authority: LocalAccount
-} & GetExecutorParameter<account, Account | Address, false> &
-  GetChainParameter<chain, chainOverride>
-
-export type InvokerSignErrorType =
-  | GetTransactionCountErrorType
-  | SignAuthMessageErrorType
-  | Keccak256ErrorType
-  | IsAddressEqualErrorType
-  | ErrorType
-
-export type Invoker<
-  account extends Account | undefined = Account | undefined,
-  chain extends Chain | undefined = Chain | undefined,
-  args = unknown,
-> = {
-  address: Address
-  execute<chainOverride extends Chain | undefined = undefined>(
-    parameters: InvokerExecuteParameters<account, chain, chainOverride, args>,
-  ): Promise<Hex>
-  sign<chainOverride extends Chain | undefined = undefined>(
-    parameters: InvokerSignParameters<account, chain, chainOverride, args>,
-  ): Promise<Hex>
-}
-
-export type GetInvokerParameters<
-  account extends Account | undefined = Account | undefined,
-  chain extends Chain | undefined = Chain | undefined,
-  args = unknown,
-> = {
-  address: Address
-  client: Client<Transport, chain, account>
-  coder: InvokerCoder<args>
-}
-
-export type GetInvokerErrorType = ErrorType
-
-export type InvokerArgs<invoker extends Invoker<any, any, any> = Invoker> =
-  invoker extends Invoker<any, any, infer args> ? args : unknown
-
-export function getInvoker<
-  account extends Account | undefined,
-  chain extends Chain | undefined,
-  args,
->(
-  parameters: GetInvokerParameters<account, chain, args>,
-): Invoker<account, chain, args> {
-  const { address, client, coder } = parameters
-  return {
-    address,
-    async execute(parameters) {
-      const {
-        executor: executor_ = client.account,
-        authority: authority_,
-        args,
-        chain = client.chain,
-        signature,
-      } = parameters
-      const authority = parseAccount(authority_!)
-      const executor = parseAccount(executor_!)
-
-      const execData = await coder.toExecData(args, {
-        authority: authority.address,
-        client,
-        invokerAddress: address,
-      })
-
-      const { r, s, yParity } = parseSignature(signature)
-      return getAction(
-        client,
-        writeContract,
-        'writeContract',
-      )({
-        abi: invokerAbi,
-        address,
-        account: executor,
-        chain,
-        functionName: 'execute',
-        args: [execData, { signer: authority.address, r, s, yParity }],
-      })
-    },
-    async sign(parameters) {
-      const {
-        args,
-        authority,
-        executor: executor_ = client.account,
-        chain = client.chain,
-      } = parameters
-      const executor = parseAccount(executor_!)
-      const [execData, nonce] = await Promise.all([
-        await coder.toExecData(args, {
-          authority: authority.address,
-          client,
-          invokerAddress: address,
-        }),
-        getAction(
-          client,
-          getTransactionCount,
-          'getTransactionCount',
-        )({
-          address: authority.address,
-          blockTag: 'pending',
-        }),
-      ])
-      const signature = await getAction(
-        client,
-        signAuthMessage,
-        'signAuthMessage',
-      )({
-        account: authority,
-        chain,
-        commit: keccak256(execData),
-        invokerAddress: address,
-        nonce: isAddressEqual(authority.address, executor.address)
-          ? nonce + 1
-          : nonce,
-      })
-      return signature
-    },
-  }
-}

package/experimental/eip3074/utils/recoverAuthMessageAddress.ts

@@ -1,29 +0,0 @@
-import type { Address } from 'abitype'
-
-import type { ByteArray, Hex, Signature } from '../../../types/misc.js'
-
-import type { ErrorType } from '../../../errors/utils.js'
-import { keccak256 } from '../../../utils/hash/keccak256.js'
-import {
-  type RecoverAddressErrorType,
-  recoverAddress,
-} from '../../../utils/signature/recoverAddress.js'
-import { type ToAuthMessageParameters, toAuthMessage } from './toAuthMessage.js'
-
-export type RecoverAuthMessageAddressParameters = ToAuthMessageParameters & {
-  signature: Hex | ByteArray | Signature
-}
-
-export type RecoverAuthMessageAddressReturnType = Address
-
-export type RecoverAuthMessageAddressErrorType =
-  | RecoverAddressErrorType
-  | ErrorType
-
-export async function recoverAuthMessageAddress({
-  signature,
-  ...parameters
-}: RecoverAuthMessageAddressParameters): Promise<RecoverAuthMessageAddressReturnType> {
-  const hash = keccak256(toAuthMessage(parameters))
-  return recoverAddress({ hash, signature })
-}

package/experimental/eip3074/utils/signAuthMessage.ts

@@ -1,40 +0,0 @@
-import { type SignErrorType, sign } from '../../../accounts/utils/sign.js'
-import type { ErrorType } from '../../../errors/utils.js'
-import type { Hex } from '../../../types/misc.js'
-import { keccak256 } from '../../../utils/hash/keccak256.js'
-import {
-  type SerializeSignatureErrorType,
-  serializeSignature,
-} from '../../../utils/signature/serializeSignature.js'
-import {
-  type ToAuthMessageErrorType,
-  type ToAuthMessageParameters,
-  toAuthMessage,
-} from './toAuthMessage.js'
-
-export type SignAuthMessageParameters = ToAuthMessageParameters & {
-  /** The private key to sign with. */
-  privateKey: Hex
-}
-
-export type SignAuthMessageReturnType = Hex
-
-export type SignAuthMessageErrorType =
-  | SignErrorType
-  | ToAuthMessageErrorType
-  | SerializeSignatureErrorType
-  | ErrorType
-
-/**
- * Computes a EIP-3074 authorization signature in format: `keccak256(MAGIC || chainId || nonce || invokerAddress || commit))`.
- */
-export async function signAuthMessage(
-  parameters: SignAuthMessageParameters,
-): Promise<SignAuthMessageReturnType> {
-  const { privateKey } = parameters
-  const signature = await sign({
-    hash: keccak256(toAuthMessage(parameters)),
-    privateKey,
-  })
-  return serializeSignature(signature)
-}

package/experimental/eip3074/utils/toAuthMessage.ts

@@ -1,50 +0,0 @@
-import type { Address } from 'abitype'
-import type { ErrorType } from '../../../errors/utils.js'
-import type { Hash } from '../../../types/misc.js'
-import {
-  type EncodePackedErrorType,
-  encodePacked,
-} from '../../../utils/abi/encodePacked.js'
-import { type PadHexErrorType, padHex } from '../../../utils/data/pad.js'
-import {
-  type NumberToHexErrorType,
-  numberToHex,
-} from '../../../utils/encoding/toHex.js'
-import type { Keccak256ErrorType } from '../../../utils/hash/keccak256.js'
-
-export type ToAuthMessageParameters = {
-  chainId: number
-  commit: Hash
-  invokerAddress: Address
-  nonce: number
-}
-
-export type ToAuthMessageReturnType = Hash
-
-export type ToAuthMessageErrorType =
-  | Keccak256ErrorType
-  | EncodePackedErrorType
-  | NumberToHexErrorType
-  | PadHexErrorType
-  | ErrorType
-
-/**
- * Returns the message to be signed for EIP-3074 authorization.
- */
-export function toAuthMessage({
-  chainId,
-  commit,
-  invokerAddress,
-  nonce,
-}: ToAuthMessageParameters): ToAuthMessageReturnType {
-  return encodePacked(
-    ['uint8', 'bytes32', 'uint256', 'bytes32', 'bytes32'],
-    [
-      0x04, // MAGIC
-      numberToHex(chainId, { size: 32 }),
-      BigInt(nonce),
-      padHex(invokerAddress, { size: 32 }),
-      commit,
-    ],
-  )
-}

package/experimental/eip3074/utils/verifyAuthMessage.ts

@@ -1,46 +0,0 @@
-import type { Address } from 'abitype'
-
-import type { ErrorType } from '../../../errors/utils.js'
-import {
-  type GetAddressErrorType,
-  getAddress,
-} from '../../../utils/address/getAddress.js'
-import {
-  type IsAddressEqualErrorType,
-  isAddressEqual,
-} from '../../../utils/address/isAddressEqual.js'
-import {
-  type RecoverAuthMessageAddressErrorType,
-  type RecoverAuthMessageAddressParameters,
-  recoverAuthMessageAddress,
-} from './recoverAuthMessageAddress.js'
-
-export type VerifyAuthMessageParameters =
-  RecoverAuthMessageAddressParameters & {
-    /** The address that signed the original auth message. */
-    address: Address
-  }
-
-export type VerifyAuthMessageReturnType = boolean
-
-export type VerifyAuthMessageErrorType =
-  | IsAddressEqualErrorType
-  | GetAddressErrorType
-  | RecoverAuthMessageAddressErrorType
-  | ErrorType
-
-/**
- * Verify that a auth message was signed by the provided address.
- *
- * @param parameters - {@link VerifyAuthMessageParameters}
- * @returns Whether or not the signature is valid. {@link VerifyAuthMessageReturnType}
- */
-export async function verifyAuthMessage({
-  address,
-  ...parameters
-}: VerifyAuthMessageParameters): Promise<VerifyAuthMessageReturnType> {
-  return isAddressEqual(
-    getAddress(address),
-    await recoverAuthMessageAddress(parameters),
-  )
-}