viem 2.55.17 → 2.55.19

package/tempo/actions/multisig.ts

@@ -0,0 +1,356 @@
+import type { Address } from 'abitype'
+import { MultisigConfig } from 'ox/tempo'
+import type { Account } from '../../accounts/types.js'
+import type { ReadContractReturnType } from '../../actions/public/readContract.js'
+import { readContract } from '../../actions/public/readContract.js'
+import type { WriteContractReturnType } from '../../actions/wallet/writeContract.js'
+import { writeContract } from '../../actions/wallet/writeContract.js'
+import { writeContractSync } from '../../actions/wallet/writeContractSync.js'
+import type { Client } from '../../clients/createClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import type { BaseErrorType } from '../../errors/base.js'
+import type { Chain } from '../../types/chain.js'
+import type { GetEventArgs } from '../../types/contract.js'
+import type { Log } from '../../types/log.js'
+import type { Compute } from '../../types/utils.js'
+import { parseEventLogs } from '../../utils/abi/parseEventLogs.js'
+import * as Abis from '../Abis.js'
+import * as Addresses from '../Addresses.js'
+import type { ReadParameters, WriteParameters } from '../internal/types.js'
+import { defineCall } from '../internal/utils.js'
+import type { TransactionReceipt } from '../Transaction.js'
+
+/**
+ * Checks whether an address is an initialized native multisig account.
+ *
+ * @example
+ * ```ts
+ * import { createClient, http } from 'viem'
+ * import { tempo } from 'viem/chains'
+ * import { Actions } from 'viem/tempo'
+ *
+ * const client = createClient({
+ *   chain: tempo,
+ *   transport: http(),
+ * })
+ *
+ * const initialized = await Actions.multisig.isInitialized(client, {
+ *   account: '0x...',
+ * })
+ * ```
+ *
+ * @param client - Client.
+ * @param parameters - Parameters.
+ * @returns Whether the account is an initialized native multisig account.
+ */
+export async function isInitialized<
+  chain extends Chain | undefined,
+  account extends Account | undefined,
+>(
+  client: Client<Transport, chain, account>,
+  parameters: isInitialized.Parameters,
+): Promise<isInitialized.ReturnValue> {
+  const { account, ...rest } = parameters
+  return readContract(client, {
+    ...rest,
+    ...isInitialized.call({ account }),
+  })
+}
+
+export namespace isInitialized {
+  export type Parameters = ReadParameters & Args
+
+  export type Args = {
+    /** Account address. */
+    account: Address
+  }
+
+  export type ReturnValue = ReadContractReturnType<
+    typeof Abis.nativeMultisig,
+    'isMultisigAccount',
+    never
+  >
+
+  /**
+   * Defines a call to the precompile's `isMultisigAccount` function.
+   *
+   * Can be passed to [`multicall`](https://viem.sh/docs/contract/multicall).
+   *
+   * @param args - Arguments.
+   * @returns The call.
+   */
+  export function call(args: Args) {
+    return defineCall({
+      address: Addresses.nativeMultisig,
+      abi: Abis.nativeMultisig,
+      args: [args.account],
+      functionName: 'isMultisigAccount',
+    })
+  }
+}
+
+/**
+ * Gets the current configuration for an initialized native multisig account.
+ *
+ * @example
+ * ```ts
+ * import { createClient, http } from 'viem'
+ * import { tempo } from 'viem/chains'
+ * import { Actions } from 'viem/tempo'
+ *
+ * const client = createClient({
+ *   chain: tempo,
+ *   transport: http(),
+ * })
+ *
+ * const config = await Actions.multisig.getConfig(client, {
+ *   account: '0x...',
+ * })
+ * ```
+ *
+ * @param client - Client.
+ * @param parameters - Parameters.
+ * @returns The current version, threshold, and owners.
+ */
+export async function getConfig<
+  chain extends Chain | undefined,
+  account extends Account | undefined,
+>(
+  client: Client<Transport, chain, account>,
+  parameters: getConfig.Parameters,
+): Promise<getConfig.ReturnValue> {
+  const { account, ...rest } = parameters
+  return readContract(client, {
+    ...rest,
+    ...getConfig.call({ account }),
+  })
+}
+
+export namespace getConfig {
+  export type Parameters = ReadParameters & Args
+
+  export type Args = {
+    /** Initialized multisig account address. */
+    account: Address
+  }
+
+  export type ReturnValue = ReadContractReturnType<
+    typeof Abis.nativeMultisig,
+    'getConfig',
+    never
+  >
+
+  /**
+   * Defines a call to the `getConfig` function.
+   *
+   * Can be passed to [`multicall`](https://viem.sh/docs/contract/multicall).
+   *
+   * @param args - Arguments.
+   * @returns The call.
+   */
+  export function call(args: Args) {
+    return defineCall({
+      address: Addresses.nativeMultisig,
+      abi: Abis.nativeMultisig,
+      args: [args.account],
+      functionName: 'getConfig',
+    })
+  }
+}
+
+/**
+ * Replaces the current configuration for a native multisig account.
+ *
+ * The transaction must be authorized directly by the account's current owner
+ * quorum. Local owner-signing flows can include {@link updateConfig.call} in a
+ * prepared transaction before collecting approvals.
+ *
+ * @example
+ * ```ts
+ * import { createClient, http } from 'viem'
+ * import { sendTransactionSync } from 'viem/actions'
+ * import { tempoLocalnet } from 'viem/chains'
+ * import { Account, Actions } from 'viem/tempo'
+ *
+ * const owner = Account.fromSecp256k1(
+ *   '0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80',
+ * )
+ * const account = Account.fromMultisig({ owners: [owner] })
+ * const client = createClient({
+ *   chain: tempoLocalnet,
+ *   transport: http(),
+ * })
+ *
+ * await sendTransactionSync(client, {
+ *   account,
+ *   to: account.address,
+ * })
+ *
+ * const hash = await Actions.multisig.updateConfig(client, {
+ *   account,
+ *   threshold: 1,
+ *   owners: [{ owner: owner.address, weight: 1 }],
+ * })
+ * ```
+ *
+ * @param client - Client.
+ * @param parameters - Parameters.
+ * @returns The transaction hash.
+ */
+export async function updateConfig<
+  chain extends Chain | undefined,
+  account extends Account | undefined,
+>(
+  client: Client<Transport, chain, account>,
+  parameters: updateConfig.Parameters<chain, account>,
+): Promise<updateConfig.ReturnValue> {
+  return updateConfig.inner(writeContract, client, parameters)
+}
+
+export namespace updateConfig {
+  export type Parameters<
+    chain extends Chain | undefined = Chain | undefined,
+    account extends Account | undefined = Account | undefined,
+  > = WriteParameters<chain, account> & Args
+
+  export type Args = {
+    /** New multisig owners and their weights. */
+    owners: MultisigConfig.Config['owners']
+    /** New signature weight required to authorize the account. */
+    threshold: MultisigConfig.Config['threshold']
+  }
+
+  export type ReturnValue = WriteContractReturnType
+
+  // TODO: exhaustive error type
+  export type ErrorType = BaseErrorType
+
+  /** @internal */
+  export async function inner<
+    action extends typeof writeContract | typeof writeContractSync,
+    chain extends Chain | undefined,
+    account extends Account | undefined,
+  >(
+    action: action,
+    client: Client<Transport, chain, account>,
+    parameters: Parameters<chain, account>,
+  ): Promise<ReturnType<action>> {
+    const { owners, threshold, ...rest } = parameters
+    return (await action(client, {
+      ...rest,
+      ...updateConfig.call({ owners, threshold }),
+    } as never)) as never
+  }
+
+  /**
+   * Defines a call to the `updateConfig` function.
+   *
+   * Can be passed as a parameter to:
+   * - [`estimateContractGas`](https://viem.sh/docs/contract/estimateContractGas): estimate gas
+   * - [`simulateContract`](https://viem.sh/docs/contract/simulateContract): simulate the update
+   * - [`sendCalls`](https://viem.sh/docs/actions/wallet/sendCalls): include the update in a call batch
+   *
+   * @example
+   * ```ts
+   * import { Actions } from 'viem/tempo'
+   *
+   * const call = Actions.multisig.updateConfig.call({
+   *   threshold: 1,
+   *   owners: [{ owner: '0x...', weight: 1 }],
+   * })
+   * ```
+   *
+   * @param args - New multisig configuration.
+   * @returns The call.
+   */
+  export function call(args: Args) {
+    const config = MultisigConfig.from(args)
+    return defineCall({
+      address: Addresses.nativeMultisig,
+      abi: Abis.nativeMultisig,
+      args: [config.threshold, config.owners],
+      functionName: 'updateConfig',
+    })
+  }
+
+  /**
+   * Extracts the `MultisigConfigUpdated` event from logs.
+   *
+   * @param logs - Transaction logs.
+   * @returns The configuration update event.
+   */
+  export function extractEvent(logs: Log[]) {
+    const [log] = parseEventLogs({
+      abi: Abis.nativeMultisig,
+      logs,
+      eventName: 'MultisigConfigUpdated',
+      strict: true,
+    })
+    if (!log) throw new Error('`MultisigConfigUpdated` event not found.')
+    return log
+  }
+}
+
+/**
+ * Replaces a native multisig configuration and waits for confirmation.
+ *
+ * @example
+ * ```ts
+ * import { createWalletClient, custom, type EIP1193Provider } from 'viem'
+ * import { tempo } from 'viem/chains'
+ * import { Actions } from 'viem/tempo'
+ *
+ * declare const provider: EIP1193Provider
+ *
+ * const client = createWalletClient({
+ *   account: '0x...',
+ *   chain: tempo,
+ *   transport: custom(provider),
+ * })
+ *
+ * const { receipt } = await Actions.multisig.updateConfigSync(client, {
+ *   threshold: 1,
+ *   owners: [{ owner: '0x...', weight: 1 }],
+ * })
+ * ```
+ *
+ * @param client - Client.
+ * @param parameters - Parameters.
+ * @returns The updated configuration event and transaction receipt.
+ */
+export async function updateConfigSync<
+  chain extends Chain | undefined,
+  account extends Account | undefined,
+>(
+  client: Client<Transport, chain, account>,
+  parameters: updateConfigSync.Parameters<chain, account>,
+): Promise<updateConfigSync.ReturnValue> {
+  const { throwOnReceiptRevert = true, ...rest } = parameters
+  const receipt = await updateConfig.inner(writeContractSync, client, {
+    ...rest,
+    throwOnReceiptRevert,
+  } as never)
+  const { args } = updateConfig.extractEvent(receipt.logs)
+  return { ...args, receipt } as never
+}
+
+export namespace updateConfigSync {
+  export type Parameters<
+    chain extends Chain | undefined = Chain | undefined,
+    account extends Account | undefined = Account | undefined,
+  > = updateConfig.Parameters<chain, account>
+
+  export type Args = updateConfig.Args
+
+  export type ReturnValue = Compute<
+    GetEventArgs<
+      typeof Abis.nativeMultisig,
+      'MultisigConfigUpdated',
+      { IndexedOnly: false; Required: true }
+    > & {
+      receipt: TransactionReceipt
+    }
+  >
+
+  export type ErrorType = updateConfig.ErrorType
+}

package/tempo/actions/zone.ts

@@ -76,8 +76,6 @@ export type EncryptedPayload = {
 export type PreparedEncryptedDeposit = {
   /** Amount of tokens to deposit. */
   amount: bigint
-  /** Refund recipient on the parent chain if the deposit bounces. */
-  bouncebackRecipient: Address
   /** Parent chain ID (e.g. `42431` for moderato). */
   chainId: number
   /** Encrypted deposit payload. */
@@ -88,6 +86,8 @@ export type PreparedEncryptedDeposit = {
   portalAddress: Address
   /** Address that will call the Zone portal. */
   sender: Address
+  /** Refund recipient on the parent chain if the deposit bounces. */
+  tempoRefundRecipient: Address
   /** Token address or ID to deposit. */
   token: TokenId.TokenIdOrAddress
   /** Zone ID (e.g. `7`). */
@@ -153,12 +153,13 @@ export async function deposit<
   if (!account_) throw new Error('`account` is required.')
 
   const recipient = parameters.recipient ?? account_.address
-  const bouncebackRecipient = parameters.bouncebackRecipient ?? account_.address
+  const tempoRefundRecipient =
+    parameters.tempoRefundRecipient ?? account_.address
   const args = {
     ...parameters,
-    bouncebackRecipient,
     chainId,
     recipient,
+    tempoRefundRecipient,
   }
   return sendTransaction(client, {
     ...rest,
@@ -172,18 +173,16 @@ export namespace deposit {
     chain extends Chain | undefined = Chain | undefined,
     account extends Account | undefined = Account | undefined,
   > = WriteParameters<chain, account> &
-    Omit<Args, 'bouncebackRecipient' | 'chainId' | 'recipient'> & {
-      /** Refund recipient on the parent chain. @default `account.address` */
-      bouncebackRecipient?: Address | undefined
+    Omit<Args, 'chainId' | 'recipient' | 'tempoRefundRecipient'> & {
       /** Recipient address in the zone. @default `account.address` */
       recipient?: Address | undefined
+      /** Refund recipient on the parent chain. @default `account.address` */
+      tempoRefundRecipient?: Address | undefined
     }
 
   export type Args = {
     /** Amount of tokens to deposit. */
     amount: bigint
-    /** Refund recipient on the parent chain if the deposit bounces. */
-    bouncebackRecipient: Address
     /** Parent chain ID (e.g. `42431` for moderato). */
     chainId: number
     /** Optional deposit memo. @default `0x00...00` */
@@ -192,6 +191,8 @@ export namespace deposit {
     portalAddress?: Address | undefined
     /** Recipient address in the zone. */
     recipient: Address
+    /** Refund recipient on the parent chain if the deposit bounces. */
+    tempoRefundRecipient: Address
     /** Token address or ID to deposit. */
     token: TokenId.TokenIdOrAddress
     /** Zone ID (e.g. `7`). */
@@ -212,10 +213,10 @@ export namespace deposit {
   export function calls(args: Args) {
     const {
       amount,
-      bouncebackRecipient,
       chainId,
       memo = zeroHash,
       recipient,
+      tempoRefundRecipient,
       token,
       zoneId,
     } = args
@@ -232,7 +233,7 @@ export namespace deposit {
       address: portalAddress,
       abi: ZoneAbis.zonePortal,
       functionName: 'deposit',
-      args: [tokenAddress, recipient, amount, memo, bouncebackRecipient],
+      args: [tokenAddress, recipient, amount, memo, tempoRefundRecipient],
     })
     return [approveCall, depositCall]
   }
@@ -286,12 +287,13 @@ export async function depositSync<
   if (!account_) throw new Error('`account` is required.')
 
   const recipient = parameters.recipient ?? account_.address
-  const bouncebackRecipient = parameters.bouncebackRecipient ?? account_.address
+  const tempoRefundRecipient =
+    parameters.tempoRefundRecipient ?? account_.address
   const args = {
     ...parameters,
-    bouncebackRecipient,
     chainId,
     recipient,
+    tempoRefundRecipient,
   }
   const receipt = await sendTransactionSync(client, {
     ...rest,
@@ -478,7 +480,8 @@ export async function encryptedDeposit<
   const account_ = account ? parseAccount(account) : undefined
   if (!account_) throw new Error('`account` is required.')
 
-  const bouncebackRecipient = parameters.bouncebackRecipient ?? account_.address
+  const tempoRefundRecipient =
+    parameters.tempoRefundRecipient ?? account_.address
 
   if ('encrypted' in parameters) {
     if (parameters.chainId !== chainId) {
@@ -490,7 +493,7 @@ export async function encryptedDeposit<
       ...pickWriteParameters(parameters as never),
       calls: encryptedDeposit.calls({
         ...parameters,
-        bouncebackRecipient,
+        tempoRefundRecipient,
       }),
     } as never) as never
   }
@@ -499,11 +502,11 @@ export async function encryptedDeposit<
 
   const prepared = await encryptedDeposit.prepare(client, {
     amount: parameters.amount,
-    bouncebackRecipient,
     memo: parameters.memo,
     portalAddress: parameters.portalAddress,
     recipient,
     sender: account_.address,
+    tempoRefundRecipient,
     token: parameters.token,
     zoneId: parameters.zoneId,
   })
@@ -522,16 +525,16 @@ export namespace encryptedDeposit {
     (
       | (Omit<
           Args,
-          | 'bouncebackRecipient'
           | 'chainId'
           | 'encrypted'
           | 'keyIndex'
           | 'recipient'
+          | 'tempoRefundRecipient'
         > & {
-          /** Refund recipient on the parent chain. @default `account.address` */
-          bouncebackRecipient?: Address | undefined
           /** Recipient address in the zone. @default `account.address` */
           recipient?: Address | undefined
+          /** Refund recipient on the parent chain. @default `account.address` */
+          tempoRefundRecipient?: Address | undefined
         })
       | PreparedEncryptedDeposit
     )
@@ -539,8 +542,6 @@ export namespace encryptedDeposit {
   export type Args = {
     /** Amount of tokens to deposit. */
     amount: bigint
-    /** Refund recipient on the parent chain if the deposit bounces. */
-    bouncebackRecipient: Address
     /** Parent chain ID (e.g. `42431` for moderato). */
     chainId: number
     /** Encrypted deposit payload. */
@@ -553,6 +554,8 @@ export namespace encryptedDeposit {
     portalAddress?: Address | undefined
     /** Recipient address in the zone. */
     recipient: Address
+    /** Refund recipient on the parent chain if the deposit bounces. */
+    tempoRefundRecipient: Address
     /** Token address or ID to deposit. */
     token: TokenId.TokenIdOrAddress
     /** Zone ID (e.g. `7`). */
@@ -581,9 +584,9 @@ export namespace encryptedDeposit {
    * const prepared = await Actions.zone.encryptedDeposit.prepare(client, {
    *   token: '0x20c0...0001',
    *   amount: 1_000_000n,
-   *   bouncebackRecipient: '0x...',
    *   recipient: '0x...',
    *   sender: '0x...',
+   *   tempoRefundRecipient: '0x...',
    *   zoneId: 7,
    * })
    * ```
@@ -604,11 +607,11 @@ export namespace encryptedDeposit {
 
     const {
       amount,
-      bouncebackRecipient,
       memo,
       portalAddress: portalAddress_,
       recipient,
       sender: sender_ = client.account?.address,
+      tempoRefundRecipient,
       token,
       zoneId,
       ...rest
@@ -634,12 +637,12 @@ export namespace encryptedDeposit {
 
     return {
       amount,
-      bouncebackRecipient,
       chainId,
       encrypted,
       keyIndex,
       portalAddress,
       sender,
+      tempoRefundRecipient,
       token,
       zoneId,
     }
@@ -661,8 +664,6 @@ export namespace encryptedDeposit {
     export type Args = {
       /** Amount of tokens to deposit. */
       amount: bigint
-      /** Refund recipient on the parent chain if the deposit bounces. */
-      bouncebackRecipient: Address
       /** Optional deposit memo. @default `0x00...00` */
       memo?: Hex.Hex | undefined
       /** Zone portal address. @default resolved via the portal registry. */
@@ -671,6 +672,8 @@ export namespace encryptedDeposit {
       recipient: Address
       /** Address that will call the Zone portal. */
       sender: Address
+      /** Refund recipient on the parent chain if the deposit bounces. */
+      tempoRefundRecipient: Address
       /** Token address or ID to deposit. */
       token: TokenId.TokenIdOrAddress
       /** Zone ID (e.g. `7`). */
@@ -796,10 +799,10 @@ export namespace encryptedDeposit {
   export function calls(args: Args | PreparedEncryptedDeposit) {
     const {
       amount,
-      bouncebackRecipient,
       chainId,
       encrypted,
       keyIndex,
+      tempoRefundRecipient,
       token,
       zoneId,
     } = args
@@ -828,7 +831,7 @@ export namespace encryptedDeposit {
         amount,
         keyIndex,
         encryptedPayload,
-        bouncebackRecipient,
+        tempoRefundRecipient,
       ],
     })
     return [approveCall, depositCall]
@@ -882,7 +885,8 @@ export async function encryptedDepositSync<
   const account_ = account ? parseAccount(account) : undefined
   if (!account_) throw new Error('`account` is required.')
 
-  const bouncebackRecipient = parameters.bouncebackRecipient ?? account_.address
+  const tempoRefundRecipient =
+    parameters.tempoRefundRecipient ?? account_.address
 
   if ('encrypted' in parameters) {
     if (parameters.chainId !== chainId) {
@@ -896,7 +900,7 @@ export async function encryptedDepositSync<
       throwOnReceiptRevert,
       calls: encryptedDeposit.calls({
         ...parameters,
-        bouncebackRecipient,
+        tempoRefundRecipient,
       }),
     } as never)
     return { receipt }
@@ -906,11 +910,11 @@ export async function encryptedDepositSync<
 
   const prepared = await encryptedDeposit.prepare(client, {
     amount: parameters.amount,
-    bouncebackRecipient,
     memo: parameters.memo,
     portalAddress: parameters.portalAddress,
     recipient,
     sender: account_.address,
+    tempoRefundRecipient,
     token: parameters.token,
     zoneId: parameters.zoneId,
   })