viem 2.42.1 → 2.43.0

package/tempo/actions/faucet.ts

@@ -0,0 +1,119 @@
+import type { Address } from 'abitype'
+import type { Account } from '../../accounts/types.js'
+import { parseAccount } from '../../accounts/utils/parseAccount.js'
+import { waitForTransactionReceipt } from '../../actions/public/waitForTransactionReceipt.js'
+import type { Client } from '../../clients/createClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import type { Chain } from '../../types/chain.js'
+import type { Hash } from '../../types/misc.js'
+import type { TransactionReceipt } from '../Transaction.js'
+
+/**
+ * Funds an account with an initial amount of set token(s)
+ * on Tempo's testnet.
+ *
+ * @example
+ * ```ts
+ * import { createClient, http } from 'viem'
+ * import { tempo } from 'tempo.ts/chains'
+ * import { Actions } from 'tempo.ts/viem'
+ *
+ * const client = createClient({
+ *   chain: tempo({ feeToken: '0x20c0000000000000000000000000000000000001' }),
+ *   transport: http(),
+ * })
+ *
+ * const hashes = await Actions.faucet.fund(client, {
+ *   account: '0xdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef',
+ * })
+ * ```
+ *
+ * @param client - Client.
+ * @param parameters - Parameters.
+ * @returns The transaction hash.
+ */
+export async function fund<chain extends Chain | undefined>(
+  client: Client<Transport, chain>,
+  parameters: fund.Parameters,
+): Promise<fund.ReturnValue> {
+  const account = parseAccount(parameters.account)
+  return client.request<{
+    Method: 'tempo_fundAddress'
+    Parameters: [address: Address]
+    ReturnType: readonly Hash[]
+  }>({
+    method: 'tempo_fundAddress',
+    params: [account.address],
+  })
+}
+
+export declare namespace fund {
+  export type Parameters = {
+    /** Account to fund. */
+    account: Account | Address
+  }
+
+  export type ReturnValue = readonly Hash[]
+}
+
+/**
+ * Funds an account with an initial amount of set token(s)
+ * on Tempo's testnet. Waits for the transactions to be included
+ * on a block before returning a response.
+ *
+ * @example
+ * ```ts
+ * import { createClient, http } from 'viem'
+ * import { tempo } from 'tempo.ts/chains'
+ * import { Actions } from 'tempo.ts/viem'
+ *
+ * const client = createClient({
+ *   chain: tempo({ feeToken: '0x20c0000000000000000000000000000000000001' }),
+ *   transport: http(),
+ * })
+ *
+ * const hashes = await Actions.faucet.fundSync(client, {
+ *   account: '0xdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef',
+ * })
+ * ```
+ *
+ * @param client - Client.
+ * @param parameters - Parameters.
+ * @returns The transaction hash.
+ */
+export async function fundSync<chain extends Chain | undefined>(
+  client: Client<Transport, chain>,
+  parameters: fundSync.Parameters,
+): Promise<fundSync.ReturnValue> {
+  const { timeout = 10_000 } = parameters
+  const account = parseAccount(parameters.account)
+  const hashes = await client.request<{
+    Method: 'tempo_fundAddress'
+    Parameters: [address: Address]
+    ReturnType: readonly Hash[]
+  }>({
+    method: 'tempo_fundAddress',
+    params: [account.address],
+  })
+  const receipts = await Promise.all(
+    hashes.map((hash) =>
+      waitForTransactionReceipt(client, {
+        hash,
+        checkReplacement: false,
+        timeout,
+      }),
+    ),
+  )
+  return receipts
+}
+
+export declare namespace fundSync {
+  export type Parameters = {
+    /** Account to fund. */
+    account: Account | Address
+    /** Timeout. */
+    timeout?: number | undefined
+  }
+
+  export type ReturnValue = readonly TransactionReceipt[]
+}

package/tempo/actions/fee.ts

@@ -0,0 +1,366 @@
+import type { Address } from 'abitype'
+import { TokenId } from 'ox/tempo'
+import type { Account } from '../../accounts/types.js'
+import { parseAccount } from '../../accounts/utils/parseAccount.js'
+import { readContract } from '../../actions/public/readContract.js'
+import type { WatchContractEventParameters } from '../../actions/public/watchContractEvent.js'
+import { watchContractEvent } from '../../actions/public/watchContractEvent.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 { zeroAddress } from '../../constants/address.js'
+import type { BaseErrorType } from '../../errors/base.js'
+import type { Chain } from '../../types/chain.js'
+import type { ExtractAbiItem, GetEventArgs } from '../../types/contract.js'
+import type { Log, Log as viem_Log } from '../../types/log.js'
+import type { Compute, UnionOmit } 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 {
+  GetAccountParameter,
+  ReadParameters,
+  WriteParameters,
+} from '../internal/types.js'
+import { defineCall } from '../internal/utils.js'
+import type { TransactionReceipt } from '../Transaction.js'
+
+/**
+ * Gets the user's default fee token.
+ *
+ * @example
+ * ```ts
+ * import { createClient, http } from 'viem'
+ * import { tempo } from 'tempo.ts/chains'
+ * import { Actions } from 'tempo.ts/viem'
+ * import { privateKeyToAccount } from 'viem/accounts'
+ *
+ * const client = createClient({
+ *   account: privateKeyToAccount('0x...'),
+ *   chain: tempo({ feeToken: '0x20c0000000000000000000000000000000000001' })
+ *   transport: http(),
+ * })
+ *
+ * const { address, id } = await Actions.fee.getUserToken(client)
+ * ```
+ *
+ * @param client - Client.
+ * @param parameters - Parameters.
+ * @returns The transaction hash.
+ */
+export async function getUserToken<
+  chain extends Chain | undefined,
+  account extends Account | undefined,
+>(
+  client: Client<Transport, chain, account>,
+  ...parameters: account extends Account
+    ? [getUserToken.Parameters<account>] | []
+    : [getUserToken.Parameters<account>]
+): Promise<getUserToken.ReturnValue> {
+  const { account: account_ = client.account, ...rest } = parameters[0] ?? {}
+  if (!account_) throw new Error('account is required.')
+  const account = parseAccount(account_)
+  const address = await readContract(client, {
+    ...rest,
+    ...getUserToken.call({ account: account.address }),
+  })
+  if (address === zeroAddress) return null
+  return {
+    address,
+    id: TokenId.fromAddress(address),
+  }
+}
+
+export namespace getUserToken {
+  export type Parameters<
+    account extends Account | undefined = Account | undefined,
+  > = ReadParameters & GetAccountParameter<account>
+
+  export type Args = {
+    /** Account address. */
+    account: Address
+  }
+
+  export type ReturnValue = Compute<{
+    address: Address
+    id: bigint
+  } | null>
+
+  /**
+   * Defines a call to the `userTokens` function.
+   *
+   * @param args - Arguments.
+   * @returns The call.
+   */
+  export function call(args: Args) {
+    const { account } = args
+    return defineCall({
+      address: Addresses.feeManager,
+      abi: Abis.feeManager,
+      args: [account],
+      functionName: 'userTokens',
+    })
+  }
+}
+
+/**
+ * Sets the user's default fee token.
+ *
+ * @example
+ * ```ts
+ * import { createClient, http } from 'viem'
+ * import { tempo } from 'tempo.ts/chains'
+ * import { Actions } from 'tempo.ts/viem'
+ * import { privateKeyToAccount } from 'viem/accounts'
+ *
+ * const client = createClient({
+ *   account: privateKeyToAccount('0x...'),
+ *   chain: tempo({ feeToken: '0x20c0000000000000000000000000000000000001' })
+ *   transport: http(),
+ * })
+ *
+ * const hash = await Actions.fee.setUserToken(client, {
+ *   token: '0x...',
+ * })
+ * ```
+ *
+ * @param client - Client.
+ * @param parameters - Parameters.
+ * @returns The transaction hash.
+ */
+export async function setUserToken<
+  chain extends Chain | undefined,
+  account extends Account | undefined,
+>(
+  client: Client<Transport, chain, account>,
+  parameters: setUserToken.Parameters<chain, account>,
+): Promise<setUserToken.ReturnValue> {
+  return setUserToken.inner(writeContract, client, parameters)
+}
+
+export namespace setUserToken {
+  export type Parameters<
+    chain extends Chain | undefined = Chain | undefined,
+    account extends Account | undefined = Account | undefined,
+  > = WriteParameters<chain, account> & Args
+
+  export type Args = {
+    /** Address or ID of the TIP20 token. */
+    token: TokenId.TokenIdOrAddress
+  }
+
+  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: setUserToken.Parameters<chain, account>,
+  ): Promise<ReturnType<action>> {
+    const { token, ...rest } = parameters
+    const call = setUserToken.call({ token })
+    return (await action(client, {
+      ...rest,
+      ...call,
+    } as never)) as never
+  }
+
+  /**
+   * Defines a call to the `setUserToken` function.
+   *
+   * Can be passed as a parameter to:
+   * - [`estimateContractGas`](https://viem.sh/docs/contract/estimateContractGas): estimate the gas cost of the call
+   * - [`simulateContract`](https://viem.sh/docs/contract/simulateContract): simulate the call
+   * - [`sendCalls`](https://viem.sh/docs/actions/wallet/sendCalls): send multiple calls
+   *
+   * @example
+   * ```ts
+   * import { createClient, http, walletActions } from 'viem'
+   * import { tempo } from 'tempo.ts/chains'
+   * import { Actions } from 'tempo.ts/viem'
+   *
+   * const client = createClient({
+   *   chain: tempo({ feeToken: '0x20c0000000000000000000000000000000000001' })
+   *   transport: http(),
+   * }).extend(walletActions)
+   *
+   * const { result } = await client.sendCalls({
+   *   calls: [
+   *     actions.fee.setUserToken.call({
+   *       token: '0x20c0...beef',
+   *     }),
+   *     actions.fee.setUserToken.call({
+   *       token: '0x20c0...babe',
+   *     }),
+   *   ]
+   * })
+   * ```
+   *
+   * @param args - Arguments.
+   * @returns The call.
+   */
+  export function call(args: Args) {
+    const { token } = args
+    return defineCall({
+      address: Addresses.feeManager,
+      abi: Abis.feeManager,
+      functionName: 'setUserToken',
+      args: [TokenId.toAddress(token)],
+    })
+  }
+
+  export function extractEvent(logs: Log[]) {
+    const [log] = parseEventLogs({
+      abi: Abis.feeManager,
+      logs,
+      eventName: 'UserTokenSet',
+      strict: true,
+    })
+    if (!log) throw new Error('`UserTokenSet` event not found.')
+    return log
+  }
+}
+
+/**
+ * Sets the user's default fee token.
+ *
+ * @example
+ * ```ts
+ * import { createClient, http } from 'viem'
+ * import { tempo } from 'tempo.ts/chains'
+ * import { Actions } from 'tempo.ts/viem'
+ * import { privateKeyToAccount } from 'viem/accounts'
+ *
+ * const client = createClient({
+ *   account: privateKeyToAccount('0x...'),
+ *   chain: tempo({ feeToken: '0x20c0000000000000000000000000000000000001' })
+ *   transport: http(),
+ * })
+ *
+ * const result = await Actions.fee.setUserTokenSync(client, {
+ *   token: '0x...',
+ * })
+ * ```
+ *
+ * @param client - Client.
+ * @param parameters - Parameters.
+ * @returns The transaction receipt and event data.
+ */
+export async function setUserTokenSync<
+  chain extends Chain | undefined,
+  account extends Account | undefined,
+>(
+  client: Client<Transport, chain, account>,
+  parameters: setUserTokenSync.Parameters<chain, account>,
+): Promise<setUserTokenSync.ReturnValue> {
+  const { throwOnReceiptRevert = true, ...rest } = parameters
+  const receipt = await setUserToken.inner(writeContractSync, client, {
+    ...rest,
+    throwOnReceiptRevert,
+  } as never)
+  const { args } = setUserToken.extractEvent(receipt.logs)
+  return {
+    ...args,
+    receipt,
+  } as never
+}
+
+export namespace setUserTokenSync {
+  export type Parameters<
+    chain extends Chain | undefined = Chain | undefined,
+    account extends Account | undefined = Account | undefined,
+  > = setUserToken.Parameters<chain, account>
+
+  export type Args = setUserToken.Args
+
+  export type ReturnValue = Compute<
+    GetEventArgs<
+      typeof Abis.feeManager,
+      'UserTokenSet',
+      { IndexedOnly: false; Required: true }
+    > & {
+      receipt: TransactionReceipt
+    }
+  >
+
+  // TODO: exhaustive error type
+  export type ErrorType = BaseErrorType
+}
+
+/**
+ * Watches for user token set events.
+ *
+ * @example
+ * ```ts
+ * import { createClient, http } from 'viem'
+ * import { tempo } from 'tempo.ts/chains'
+ * import { Actions } from 'tempo.ts/viem'
+ *
+ * const client = createClient({
+ *   chain: tempo({ feeToken: '0x20c0000000000000000000000000000000000001' })
+ *   transport: http(),
+ * })
+ *
+ * const unwatch = actions.fee.watchSetUserToken(client, {
+ *   onUserTokenSet: (args, log) => {
+ *     console.log('User token set:', args)
+ *   },
+ * })
+ * ```
+ *
+ * @param client - Client.
+ * @param parameters - Parameters.
+ * @returns A function to unsubscribe from the event.
+ */
+export function watchSetUserToken<
+  chain extends Chain | undefined,
+  account extends Account | undefined,
+>(
+  client: Client<Transport, chain, account>,
+  parameters: watchSetUserToken.Parameters,
+) {
+  const { onUserTokenSet, ...rest } = parameters
+  return watchContractEvent(client, {
+    ...rest,
+    address: Addresses.feeManager,
+    abi: Abis.feeManager,
+    eventName: 'UserTokenSet',
+    onLogs: (logs) => {
+      for (const log of logs) onUserTokenSet(log.args, log)
+    },
+    strict: true,
+  })
+}
+
+export declare namespace watchSetUserToken {
+  export type Args = GetEventArgs<
+    typeof Abis.feeManager,
+    'UserTokenSet',
+    { IndexedOnly: false; Required: true }
+  >
+
+  export type Log = viem_Log<
+    bigint,
+    number,
+    false,
+    ExtractAbiItem<typeof Abis.feeManager, 'UserTokenSet'>,
+    true
+  >
+
+  export type Parameters = UnionOmit<
+    WatchContractEventParameters<typeof Abis.feeManager, 'UserTokenSet', true>,
+    'abi' | 'address' | 'batch' | 'eventName' | 'onLogs' | 'strict'
+  > & {
+    /** Callback to invoke when a user token is set. */
+    onUserTokenSet: (args: Args, log: Log) => void
+  }
+}

package/tempo/actions/index.ts

@@ -0,0 +1,9 @@
+// biome-ignore lint/performance/noBarrelFile: _
+export * as amm from './amm.js'
+export * as dex from './dex.js'
+export * as faucet from './faucet.js'
+export * as fee from './fee.js'
+export * as nonce from './nonce.js'
+export * as policy from './policy.js'
+export * as reward from './reward.js'
+export * as token from './token.js'