viem 2.53.1 → 2.54.0

package/_types/actions/token/getMetadata.d.ts

@@ -0,0 +1,43 @@
+import type { Account } from '../../accounts/types.js';
+import type { Client } from '../../clients/createClient.js';
+import type { Transport } from '../../clients/transports/createTransport.js';
+import type { Tokens } from '../../tokens/defineToken.js';
+import type { Chain } from '../../types/chain.js';
+import { type ReadParameters, type TokenParameter } from './internal.js';
+/**
+ * Gets the metadata (`decimals`, `name`, `symbol`) of an ERC-20 token.
+ *
+ * Fields declared on the Client's `tokens` array are used as-is; any missing
+ * field is fetched from the token contract.
+ *
+ * @example
+ * ```ts
+ * import { createClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { token } from 'viem/actions'
+ *
+ * const client = createClient({ chain: mainnet, transport: http() })
+ *
+ * const metadata = await token.getMetadata(client, {
+ *   token: '0x...',
+ * })
+ * ```
+ *
+ * @param client - Client.
+ * @param parameters - Parameters.
+ * @returns The token metadata (`decimals`, `name`, `symbol`).
+ */
+export declare function getMetadata<chain extends Chain | undefined, account extends Account | undefined, tokens extends Tokens | undefined = undefined>(client: Client<Transport, chain, account, undefined, undefined, tokens>, parameters: getMetadata.Parameters<chain, tokens>): Promise<getMetadata.ReturnValue>;
+export declare namespace getMetadata {
+    type Args<chain extends Chain | undefined = Chain | undefined, tokens extends Tokens | undefined = Tokens | undefined> = TokenParameter<chain, tokens>;
+    type Parameters<chain extends Chain | undefined = Chain | undefined, tokens extends Tokens | undefined = Tokens | undefined> = Omit<ReadParameters, 'account'> & Args<chain, tokens>;
+    type ReturnValue = {
+        /** Number of decimals the token uses. */
+        decimals: number;
+        /** Human-readable name of the token. */
+        name: string;
+        /** Ticker symbol of the token. */
+        symbol: string;
+    };
+}
+//# sourceMappingURL=getMetadata.d.ts.map

package/_types/actions/token/getMetadata.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getMetadata.d.ts","sourceRoot":"","sources":["../../../actions/token/getMetadata.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAA;AACtD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,+BAA+B,CAAA;AAC3D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,6CAA6C,CAAA;AAE5E,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,6BAA6B,CAAA;AACzD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAA;AAEjD,OAAO,EAEL,KAAK,cAAc,EAEnB,KAAK,cAAc,EACpB,MAAM,eAAe,CAAA;AAEtB;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAsB,WAAW,CAC/B,KAAK,SAAS,KAAK,GAAG,SAAS,EAC/B,OAAO,SAAS,OAAO,GAAG,SAAS,EACnC,MAAM,SAAS,MAAM,GAAG,SAAS,GAAG,SAAS,EAE7C,MAAM,EAAE,MAAM,CAAC,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,CAAC,EACvE,UAAU,EAAE,WAAW,CAAC,UAAU,CAAC,KAAK,EAAE,MAAM,CAAC,GAChD,OAAO,CAAC,WAAW,CAAC,WAAW,CAAC,CAkClC;AAED,yBAAiB,WAAW,CAAC;IAC3B,KAAY,IAAI,CACd,KAAK,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EACnD,MAAM,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,IACpD,cAAc,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;IACjC,KAAY,UAAU,CACpB,KAAK,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EACnD,MAAM,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,IACpD,IAAI,CAAC,cAAc,EAAE,SAAS,CAAC,GAAG,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;IACzD,KAAY,WAAW,GAAG;QACxB,yCAAyC;QACzC,QAAQ,EAAE,MAAM,CAAA;QAChB,wCAAwC;QACxC,IAAI,EAAE,MAAM,CAAA;QACZ,kCAAkC;QAClC,MAAM,EAAE,MAAM,CAAA;KACf,CAAA;CACF"}

package/_types/actions/token/getTotalSupply.d.ts

@@ -0,0 +1,63 @@
+import type { Account } from '../../accounts/types.js';
+import type { Client } from '../../clients/createClient.js';
+import type { Transport } from '../../clients/transports/createTransport.js';
+import type { Tokens } from '../../tokens/defineToken.js';
+import type { Chain } from '../../types/chain.js';
+import { type Amount, type ReadParameters, type TokenParameters } from './internal.js';
+/**
+ * Gets the total supply of an ERC-20 token.
+ *
+ * @example
+ * ```ts
+ * import { createClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { token } from 'viem/actions'
+ *
+ * const client = createClient({ chain: mainnet, transport: http() })
+ *
+ * const totalSupply = await token.getTotalSupply(client, {
+ *   token: '0x...',
+ * })
+ * ```
+ *
+ * @param client - Client.
+ * @param parameters - Parameters.
+ * @returns The token total supply, in base units and human-readable form.
+ */
+export declare function getTotalSupply<chain extends Chain | undefined, account extends Account | undefined, tokens extends Tokens | undefined = undefined>(client: Client<Transport, chain, account, undefined, undefined, tokens>, parameters: getTotalSupply.Parameters<chain, tokens>): Promise<getTotalSupply.ReturnValue>;
+export declare namespace getTotalSupply {
+    type Args<chain extends Chain | undefined = Chain | undefined, tokens extends Tokens | undefined = Tokens | undefined> = TokenParameters<chain, tokens>;
+    type Parameters<chain extends Chain | undefined = Chain | undefined, tokens extends Tokens | undefined = Tokens | undefined> = Omit<ReadParameters, 'account'> & Args<chain, tokens>;
+    type ReturnValue = Amount;
+    /**
+     * Defines a call to the `totalSupply` function.
+     *
+     * Can be passed as a parameter to `multicall`, `simulateContract`, or any
+     * other action that accepts a contract call. The token is selected by `token`
+     * symbol (resolved from the client's `tokens` array) or contract address.
+     *
+     * @param client - Client.
+     * @param args - Arguments.
+     * @returns The call.
+     */
+    function call<chain extends Chain | undefined, account extends Account | undefined, tokens extends Tokens | undefined = undefined>(client: Client<Transport, chain, account, undefined, undefined, tokens>, args: Args<chain, tokens>): {
+        abi: [{
+            readonly type: "function";
+            readonly name: "totalSupply";
+            readonly stateMutability: "view";
+            readonly inputs: readonly [];
+            readonly outputs: readonly [{
+                readonly type: "uint256";
+            }];
+        }];
+        functionName: "totalSupply";
+    } & {
+        args?: readonly [] | undefined;
+    } & {
+        address: import("abitype").Address;
+    } & {
+        data: import("../../index.js").Hex;
+        to: import("abitype").Address;
+    };
+}
+//# sourceMappingURL=getTotalSupply.d.ts.map

package/_types/actions/token/getTotalSupply.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getTotalSupply.d.ts","sourceRoot":"","sources":["../../../actions/token/getTotalSupply.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAA;AACtD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,+BAA+B,CAAA;AAC3D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,6CAA6C,CAAA;AAE5E,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,6BAA6B,CAAA;AACzD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAA;AAEjD,OAAO,EACL,KAAK,MAAM,EAEX,KAAK,cAAc,EAGnB,KAAK,eAAe,EAErB,MAAM,eAAe,CAAA;AAEtB;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAsB,cAAc,CAClC,KAAK,SAAS,KAAK,GAAG,SAAS,EAC/B,OAAO,SAAS,OAAO,GAAG,SAAS,EACnC,MAAM,SAAS,MAAM,GAAG,SAAS,GAAG,SAAS,EAE7C,MAAM,EAAE,MAAM,CAAC,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,CAAC,EACvE,UAAU,EAAE,cAAc,CAAC,UAAU,CAAC,KAAK,EAAE,MAAM,CAAC,GACnD,OAAO,CAAC,cAAc,CAAC,WAAW,CAAC,CAarC;AAED,yBAAiB,cAAc,CAAC;IAC9B,KAAY,IAAI,CACd,KAAK,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EACnD,MAAM,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,IACpD,eAAe,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;IAClC,KAAY,UAAU,CACpB,KAAK,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EACnD,MAAM,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,IACpD,IAAI,CAAC,cAAc,EAAE,SAAS,CAAC,GAAG,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;IACzD,KAAY,WAAW,GAAG,MAAM,CAAA;IAEhC;;;;;;;;;;OAUG;IACH,SAAgB,IAAI,CAClB,KAAK,SAAS,KAAK,GAAG,SAAS,EAC/B,OAAO,SAAS,OAAO,GAAG,SAAS,EACnC,MAAM,SAAS,MAAM,GAAG,SAAS,GAAG,SAAS,EAE7C,MAAM,EAAE,MAAM,CAAC,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,CAAC,EACvE,IAAI,EAAE,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC;;;;;;;;;;;;;;;;;;MAQ1B;CACF"}

package/_types/actions/token/index.d.ts

@@ -0,0 +1,9 @@
+export { approve } from './approve.js';
+export { approveSync } from './approveSync.js';
+export { getAllowance } from './getAllowance.js';
+export { getBalance } from './getBalance.js';
+export { getMetadata } from './getMetadata.js';
+export { getTotalSupply } from './getTotalSupply.js';
+export { transfer } from './transfer.js';
+export { transferSync } from './transferSync.js';
+//# sourceMappingURL=index.d.ts.map

package/_types/actions/token/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../actions/token/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AACtC,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAC9C,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAC5C,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAC9C,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AACxC,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA"}

package/_types/actions/token/internal.d.ts

@@ -0,0 +1,168 @@
+import type { Abi, AbiStateMutability, Address } from 'abitype';
+import type { Account } from '../../accounts/types.js';
+import type { Client } from '../../clients/createClient.js';
+import type { Transport } from '../../clients/transports/createTransport.js';
+import type { ResolvedToken, Token, Tokens } from '../../tokens/defineToken.js';
+import type { Chain } from '../../types/chain.js';
+import type { ContractFunctionName, ContractFunctionParameters, ExtractAbiItem } from '../../types/contract.js';
+import type { Hex } from '../../types/misc.js';
+import type { UnionPick } from '../../types/utils.js';
+import type { ReadContractParameters as viem_ReadContractParameters } from '../public/readContract.js';
+import type { WriteContractSyncParameters as viem_WriteContractSyncParameters } from '../wallet/writeContractSync.js';
+/**
+ * Union of symbols of the Client's declared `tokens` whose `addresses` include
+ * the Client's `chain.id`. Collapses to `never` when there is no chain mapping
+ * (no `tokens`, no `chain`, a widened `chain.id`, or widened token symbols).
+ *
+ * @internal
+ */
+export type TokenName<chain extends Chain | undefined, tokens extends Tokens | undefined> = chain extends {
+    id: infer chainId extends number;
+} ? number extends chainId ? never : tokens extends Tokens ? TokenSymbolForChain<tokens[number], chainId> : never : never;
+type TokenSymbolForChain<token, chainId extends number> = token extends Token ? chainId extends keyof token['addresses'] ? token['symbol'] extends string ? string extends token['symbol'] ? never : Lowercase<token['symbol']> : never : never : never;
+/**
+ * Selects an ERC-20 token by `token`, which is either the symbol of a token
+ * declared on the Client's `tokens` array or a contract `address`.
+ *
+ * When `token` is a declared symbol (or an address that matches a declared
+ * token), token metadata is resolved from the Client's `tokens` array.
+ */
+export type TokenParameter<chain extends Chain | undefined, tokens extends Tokens | undefined> = {
+    /**
+     * Token to operate on: either the symbol of a token declared on the Client's
+     * `tokens` array (with an address for the Client's `chain.id`), or a
+     * contract `address`.
+     */
+    token: TokenName<chain, tokens> | Address;
+};
+export type TokenParameters<chain extends Chain | undefined, tokens extends Tokens | undefined> = TokenParameter<chain, tokens> & {
+    /**
+     * Decimals used to convert between base units and the human-readable amount.
+     * Inferred from the Client's `tokens` array when `token` matches a declared
+     * token; otherwise fetched from the token contract when needed.
+     */
+    decimals?: number | undefined;
+};
+/**
+ * A token amount, expressed both in the token's base units (`amount`) and as a
+ * human-readable decimal string (`formatted`, derived from the token's
+ * `decimals`).
+ */
+export type Amount = {
+    /** Amount in the token's base units. */
+    amount: bigint;
+    /** Token decimals used to derive `formatted`. */
+    decimals: number;
+    /** Amount formatted as a human-readable decimal string. */
+    formatted: string;
+};
+/** A write amount: a base-unit bigint, or an explicit formatted helper. */
+export type AmountInput = bigint | {
+    /** Token decimals used to parse `formatted`. */
+    decimals?: number | undefined;
+    /** Human-readable decimal amount. */
+    formatted: string;
+};
+/**
+ * Shapes a base-unit value into an {@link Amount} (base units, `decimals`, and
+ * human-readable `formatted` string).
+ *
+ * @param amount - Amount in base units.
+ * @param decimals - Token decimals used to format the amount.
+ * @returns The {@link Amount}.
+ */
+export declare function toAmount(amount: bigint, decimals: number): Amount;
+/**
+ * Resolves a write amount to base units.
+ *
+ * @param amount - Base-unit amount, or formatted helper.
+ * @param decimals - Token decimals used to parse formatted amounts.
+ * @returns Amount in base units.
+ */
+export declare function toBaseUnits(amount: AmountInput, decimals: number | undefined): bigint;
+/**
+ * Requires resolved token decimals for parsing or formatting amounts.
+ *
+ * @param decimals - Token decimals.
+ * @returns Token decimals.
+ * @internal
+ */
+export declare function requireTokenDecimals(decimals: number | undefined): number;
+/**
+ * Resolves the decimals used for formatting a write amount.
+ *
+ * @param amount - Base-unit amount, or formatted helper.
+ * @param decimals - Token decimals.
+ * @returns Token decimals, overridden by the formatted helper when present.
+ */
+export declare function resolveAmountDecimals(amount: AmountInput, decimals: number | undefined): number | undefined;
+/**
+ * Resolves the token contract `address` and `decimals` from a `token`, which is
+ * either the symbol of a token declared on the client's `tokens` array or a
+ * contract `address`.
+ *
+ * When `token` is a declared symbol, the `address` and `decimals` are resolved
+ * from the Client's `tokens` array for the Client's `chain.id` (`decimals` can
+ * be overridden via the explicit `decimals`). When `token` is an address, its
+ * `decimals` is inferred from the Client's `tokens` array when the address
+ * matches a declared token, otherwise taken from the explicit `decimals`.
+ *
+ * @param client - Client.
+ * @param parameters - Parameters.
+ * @returns The resolved `address` and `decimals`.
+ */
+export declare function resolveToken(client: Client<Transport, Chain | undefined>, parameters: resolveToken.Parameters): {
+    address: Address;
+    decimals: number | undefined;
+};
+export declare namespace resolveToken {
+    type Parameters = {
+        /** Decimals, if provided explicitly. */
+        decimals?: number | undefined;
+        /** Token symbol (declared on the client's `tokens` array) or contract address. */
+        token: string;
+    };
+}
+/**
+ * Finds the declared token on the Client's `tokens` array matching `token`
+ * (either a token symbol or contract `address`), resolved to a {@link ResolvedToken}
+ * for the Client's `chain.id`. Returns `undefined` when no declared token
+ * matches, or the matching token has no address for the Client's chain.
+ *
+ * @param client - Client.
+ * @param token - Token symbol (declared on the client's `tokens` array) or contract address.
+ * @returns The matching resolved token config, or `undefined`.
+ */
+export declare function findDeclaredToken(client: Client<Transport, Chain | undefined>, token: string): ResolvedToken | undefined;
+/**
+ * Resolves token decimals, fetching from the token contract when they are not
+ * provided explicitly or declared on the client.
+ * @internal
+ */
+export declare function resolveTokenWithDecimals(client: Client<Transport, Chain | undefined>, parameters: resolveToken.Parameters): Promise<{
+    address: Address;
+    decimals: number;
+}>;
+/**
+ * Picks the transaction-override fields shared by write actions, so the
+ * action-specific args (`token`, `amount`, `to`, etc.) don't leak into
+ * `estimateContractGas` / `simulateContract` requests. @internal
+ */
+export declare function pickWriteParameters(parameters: Record<string, unknown>): {
+    account: unknown;
+    chain: unknown;
+    gas: unknown;
+    maxFeePerGas: unknown;
+    maxPriorityFeePerGas: unknown;
+    nonce: unknown;
+};
+export type ReadParameters = Pick<viem_ReadContractParameters<never, never, never>, 'account' | 'blockNumber' | 'blockOverrides' | 'blockTag' | 'stateOverride'>;
+export type WriteParameters<chain extends Chain | undefined = Chain | undefined, account extends Account | undefined = Account | undefined> = UnionPick<viem_WriteContractSyncParameters<never, never, never, chain, account>, 'account' | 'chain' | 'gas' | 'maxFeePerGas' | 'maxPriorityFeePerGas' | 'nonce' | 'throwOnReceiptRevert'>;
+export declare function defineCall<const abi extends Abi, const functionName extends ContractFunctionName<abi, AbiStateMutability>, call extends ContractFunctionParameters<abi, AbiStateMutability, functionName>>(call: call | ContractFunctionParameters<abi, AbiStateMutability, functionName>): ContractFunctionParameters<[
+    ExtractAbiItem<abi, functionName>
+], AbiStateMutability, functionName> & {
+    data: Hex;
+    to: Address;
+};
+export {};
+//# sourceMappingURL=internal.d.ts.map

package/_types/actions/token/internal.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"internal.d.ts","sourceRoot":"","sources":["../../../actions/token/internal.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,kBAAkB,EAAE,OAAO,EAAE,MAAM,SAAS,CAAA;AAC/D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAA;AACtD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,+BAA+B,CAAA;AAC3D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,6CAA6C,CAAA;AAE5E,OAAO,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,6BAA6B,CAAA;AAC/E,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAA;AACjD,OAAO,KAAK,EACV,oBAAoB,EACpB,0BAA0B,EAC1B,cAAc,EACf,MAAM,yBAAyB,CAAA;AAChC,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,qBAAqB,CAAA;AAC9C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AAMrD,OAAO,KAAK,EAAE,sBAAsB,IAAI,2BAA2B,EAAE,MAAM,2BAA2B,CAAA;AAEtG,OAAO,KAAK,EAAE,2BAA2B,IAAI,gCAAgC,EAAE,MAAM,gCAAgC,CAAA;AAErH;;;;;;GAMG;AACH,MAAM,MAAM,SAAS,CACnB,KAAK,SAAS,KAAK,GAAG,SAAS,EAC/B,MAAM,SAAS,MAAM,GAAG,SAAS,IAC/B,KAAK,SAAS;IAAE,EAAE,EAAE,MAAM,OAAO,SAAS,MAAM,CAAA;CAAE,GAClD,MAAM,SAAS,OAAO,GACpB,KAAK,GACL,MAAM,SAAS,MAAM,GACnB,mBAAmB,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,GAC5C,KAAK,GACT,KAAK,CAAA;AAET,KAAK,mBAAmB,CAAC,KAAK,EAAE,OAAO,SAAS,MAAM,IAAI,KAAK,SAAS,KAAK,GACzE,OAAO,SAAS,MAAM,KAAK,CAAC,WAAW,CAAC,GACtC,KAAK,CAAC,QAAQ,CAAC,SAAS,MAAM,GAC5B,MAAM,SAAS,KAAK,CAAC,QAAQ,CAAC,GAC5B,KAAK,GACL,SAAS,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,GAC5B,KAAK,GACP,KAAK,GACP,KAAK,CAAA;AAET;;;;;;GAMG;AACH,MAAM,MAAM,cAAc,CACxB,KAAK,SAAS,KAAK,GAAG,SAAS,EAC/B,MAAM,SAAS,MAAM,GAAG,SAAS,IAC/B;IACF;;;;OAIG;IACH,KAAK,EAAE,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,OAAO,CAAA;CAC1C,CAAA;AAED,MAAM,MAAM,eAAe,CACzB,KAAK,SAAS,KAAK,GAAG,SAAS,EAC/B,MAAM,SAAS,MAAM,GAAG,SAAS,IAC/B,cAAc,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG;IAClC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAC9B,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB,wCAAwC;IACxC,MAAM,EAAE,MAAM,CAAA;IACd,iDAAiD;IACjD,QAAQ,EAAE,MAAM,CAAA;IAChB,2DAA2D;IAC3D,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,2EAA2E;AAC3E,MAAM,MAAM,WAAW,GACnB,MAAM,GACN;IACE,gDAAgD;IAChD,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC7B,qCAAqC;IACrC,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAEL;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAEjE;AAED;;;;;;GAMG;AACH,wBAAgB,WAAW,CACzB,MAAM,EAAE,WAAW,EACnB,QAAQ,EAAE,MAAM,GAAG,SAAS,GAC3B,MAAM,CAIR;AAED;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,CAMzE;AAED;;;;;;GAMG;AACH,wBAAgB,qBAAqB,CACnC,MAAM,EAAE,WAAW,EACnB,QAAQ,EAAE,MAAM,GAAG,SAAS,GAC3B,MAAM,GAAG,SAAS,CAGpB;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,YAAY,CAC1B,MAAM,EAAE,MAAM,CAAC,SAAS,EAAE,KAAK,GAAG,SAAS,CAAC,EAC5C,UAAU,EAAE,YAAY,CAAC,UAAU,GAClC;IAAE,OAAO,EAAE,OAAO,CAAC;IAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,CAmBpD;AAED,yBAAiB,YAAY,CAAC;IAC5B,KAAY,UAAU,GAAG;QACvB,wCAAwC;QACxC,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;QAC7B,kFAAkF;QAClF,KAAK,EAAE,MAAM,CAAA;KACd,CAAA;CACF;AAED;;;;;;;;;GASG;AACH,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,MAAM,CAAC,SAAS,EAAE,KAAK,GAAG,SAAS,CAAC,EAC5C,KAAK,EAAE,MAAM,GACZ,aAAa,GAAG,SAAS,CAc3B;AAmDD;;;;GAIG;AACH,wBAAsB,wBAAwB,CAC5C,MAAM,EAAE,MAAM,CAAC,SAAS,EAAE,KAAK,GAAG,SAAS,CAAC,EAC5C,UAAU,EAAE,YAAY,CAAC,UAAU,GAClC,OAAO,CAAC;IAAE,OAAO,EAAE,OAAO,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC,CAWjD;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;;;;;;;EAItE;AAED,MAAM,MAAM,cAAc,GAAG,IAAI,CAC/B,2BAA2B,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,EAChD,SAAS,GAAG,aAAa,GAAG,gBAAgB,GAAG,UAAU,GAAG,eAAe,CAC5E,CAAA;AAED,MAAM,MAAM,eAAe,CACzB,KAAK,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EACnD,OAAO,SAAS,OAAO,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,IACvD,SAAS,CACX,gCAAgC,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,EACnE,SAAS,GACT,OAAO,GACP,KAAK,GACL,cAAc,GACd,sBAAsB,GACtB,OAAO,GACP,sBAAsB,CACzB,CAAA;AAED,wBAAgB,UAAU,CACxB,KAAK,CAAC,GAAG,SAAS,GAAG,EACrB,KAAK,CAAC,YAAY,SAAS,oBAAoB,CAAC,GAAG,EAAE,kBAAkB,CAAC,EACxE,IAAI,SAAS,0BAA0B,CACrC,GAAG,EACH,kBAAkB,EAClB,YAAY,CACb,EAED,IAAI,EACA,IAAI,GACJ,0BAA0B,CAAC,GAAG,EAAE,kBAAkB,EAAE,YAAY,CAAC,GACpE,0BAA0B,CAC3B;IAAC,cAAc,CAAC,GAAG,EAAE,YAAY,CAAC;CAAC,EACnC,kBAAkB,EAClB,YAAY,CACb,GAAG;IACF,IAAI,EAAE,GAAG,CAAA;IACT,EAAE,EAAE,OAAO,CAAA;CACZ,CAMA"}

package/_types/actions/token/transfer.d.ts

@@ -0,0 +1,288 @@
+import type { Address } from 'abitype';
+import type { Account } from '../../accounts/types.js';
+import type { Client } from '../../clients/createClient.js';
+import type { Transport } from '../../clients/transports/createTransport.js';
+import { erc20Abi } from '../../constants/abis.js';
+import type { BaseErrorType } from '../../errors/base.js';
+import type { Tokens } from '../../tokens/defineToken.js';
+import type { Chain } from '../../types/chain.js';
+import type { Log } from '../../types/log.js';
+import { type SimulateContractReturnType } from '../public/simulateContract.js';
+import type { WriteContractReturnType } from '../wallet/writeContract.js';
+import { writeContract } from '../wallet/writeContract.js';
+import type { writeContractSync } from '../wallet/writeContractSync.js';
+import { type AmountInput, type TokenParameter, type WriteParameters } from './internal.js';
+/**
+ * Transfers ERC-20 tokens to another address.
+ *
+ * Pass `from` to transfer on behalf of another address using an allowance
+ * (calls `transferFrom`); otherwise transfers from the caller (calls
+ * `transfer`).
+ *
+ * @example
+ * ```ts
+ * import { createClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { privateKeyToAccount } from 'viem/accounts'
+ * import { token } from 'viem/actions'
+ *
+ * const client = createClient({
+ *   account: privateKeyToAccount('0x...'),
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ *
+ * const hash = await token.transfer(client, {
+ *   amount: 100000000n,
+ *   to: '0x...',
+ *   token: '0x...',
+ * })
+ * ```
+ *
+ * @example
+ * ```ts
+ * // Transfer on behalf of another address (via an allowance).
+ * const hash = await token.transfer(client, {
+ *   amount: 100000000n,
+ *   from: '0x...',
+ *   to: '0x...',
+ *   token: '0x...',
+ * })
+ * ```
+ *
+ * @param client - Client.
+ * @param parameters - Parameters.
+ * @returns The transaction hash.
+ */
+export declare function transfer<chain extends Chain | undefined, account extends Account | undefined, tokens extends Tokens | undefined = undefined>(client: Client<Transport, chain, account, undefined, undefined, tokens>, parameters: transfer.Parameters<chain, account, tokens>): Promise<transfer.ReturnValue>;
+export declare namespace transfer {
+    type Args<chain extends Chain | undefined = Chain | undefined, tokens extends Tokens | undefined = Tokens | undefined> = {
+        /** Amount to transfer in base units, or as a formatted helper. */
+        amount: AmountInput;
+        /** Address to transfer tokens from (uses an allowance via `transferFrom`). */
+        from?: Address | undefined;
+        /** Address to transfer tokens to. */
+        to: Address;
+    } & TokenParameter<chain, tokens>;
+    type Parameters<chain extends Chain | undefined = Chain | undefined, account extends Account | undefined = Account | undefined, tokens extends Tokens | undefined = Tokens | undefined> = WriteParameters<chain, account> & Args<chain, tokens>;
+    type ReturnValue = WriteContractReturnType;
+    type ErrorType = BaseErrorType;
+    /** @internal */
+    function inner<action extends typeof writeContract | typeof writeContractSync, chain extends Chain | undefined, account extends Account | undefined, tokens extends Tokens | undefined = undefined>(action: action, client: Client<Transport, chain, account, undefined, undefined, tokens>, parameters: transfer.Parameters<chain, account, tokens>): Promise<ReturnType<action>>;
+    /**
+     * Defines a call to the `transfer` (or `transferFrom`, when `from` is given)
+     * function.
+     *
+     * Can be passed as a parameter to `estimateContractGas`, `simulateContract`,
+     * `sendCalls`, `sendTransaction` (`calls`), or `multicall`. The token is
+     * selected by `token`, which is either a token symbol (resolved from the
+     * client's `tokens` array) or a contract `address`; `amount.decimals`
+     * is inferred from declared client tokens when omitted.
+     *
+     * @param client - Client.
+     * @param parameters - Parameters.
+     * @returns The call.
+     */
+    function call<chain extends Chain | undefined, account extends Account | undefined, tokens extends Tokens | undefined = undefined>(client: Client<Transport, chain, account, undefined, undefined, tokens>, parameters: Args<chain, tokens>): {
+        abi: [{
+            readonly type: "function";
+            readonly name: "transfer";
+            readonly stateMutability: "nonpayable";
+            readonly inputs: readonly [{
+                readonly name: "recipient";
+                readonly type: "address";
+            }, {
+                readonly name: "amount";
+                readonly type: "uint256";
+            }];
+            readonly outputs: readonly [{
+                readonly type: "bool";
+            }];
+        } | {
+            readonly type: "function";
+            readonly name: "transferFrom";
+            readonly stateMutability: "nonpayable";
+            readonly inputs: readonly [{
+                readonly name: "sender";
+                readonly type: "address";
+            }, {
+                readonly name: "recipient";
+                readonly type: "address";
+            }, {
+                readonly name: "amount";
+                readonly type: "uint256";
+            }];
+            readonly outputs: readonly [{
+                readonly type: "bool";
+            }];
+        }];
+        functionName: "transfer" | "transferFrom";
+    } & {
+        args: readonly [recipient: `0x${string}`, amount: bigint] | readonly [sender: `0x${string}`, recipient: `0x${string}`, amount: bigint];
+    } & {
+        address: Address;
+    } & {
+        data: import("../../index.js").Hex;
+        to: Address;
+    };
+    /**
+     * Estimates the gas required to transfer ERC-20 tokens. `amount.decimals` is
+     * inferred from declared client tokens when omitted.
+     *
+     * @param client - Client.
+     * @param parameters - Parameters.
+     * @returns The gas estimate.
+     */
+    function estimateGas<chain extends Chain | undefined, account extends Account | undefined, tokens extends Tokens | undefined = undefined>(client: Client<Transport, chain, account, undefined, undefined, tokens>, parameters: transfer.Parameters<chain, account, tokens>): Promise<bigint>;
+    /**
+     * Simulates a transfer of ERC-20 tokens. `amount.decimals` is inferred from
+     * declared client tokens when omitted.
+     *
+     * @param client - Client.
+     * @param parameters - Parameters.
+     * @returns The simulation result and write request.
+     */
+    function simulate<chain extends Chain | undefined, account extends Account | undefined, tokens extends Tokens | undefined = undefined>(client: Client<Transport, chain, account, undefined, undefined, tokens>, parameters: transfer.Parameters<chain, account, tokens>): Promise<SimulateContractReturnType<typeof erc20Abi, 'transfer' | 'transferFrom'>>;
+    /**
+     * Extracts the `Transfer` event from logs.
+     *
+     * @param logs - The logs.
+     * @returns The `Transfer` event.
+     */
+    function extractEvent(logs: Log[]): Log<bigint, number, false, undefined, true, readonly [{
+        readonly type: "event";
+        readonly name: "Approval";
+        readonly inputs: readonly [{
+            readonly indexed: true;
+            readonly name: "owner";
+            readonly type: "address";
+        }, {
+            readonly indexed: true;
+            readonly name: "spender";
+            readonly type: "address";
+        }, {
+            readonly indexed: false;
+            readonly name: "value";
+            readonly type: "uint256";
+        }];
+    }, {
+        readonly type: "event";
+        readonly name: "Transfer";
+        readonly inputs: readonly [{
+            readonly indexed: true;
+            readonly name: "from";
+            readonly type: "address";
+        }, {
+            readonly indexed: true;
+            readonly name: "to";
+            readonly type: "address";
+        }, {
+            readonly indexed: false;
+            readonly name: "value";
+            readonly type: "uint256";
+        }];
+    }, {
+        readonly type: "function";
+        readonly name: "allowance";
+        readonly stateMutability: "view";
+        readonly inputs: readonly [{
+            readonly name: "owner";
+            readonly type: "address";
+        }, {
+            readonly name: "spender";
+            readonly type: "address";
+        }];
+        readonly outputs: readonly [{
+            readonly type: "uint256";
+        }];
+    }, {
+        readonly type: "function";
+        readonly name: "approve";
+        readonly stateMutability: "nonpayable";
+        readonly inputs: readonly [{
+            readonly name: "spender";
+            readonly type: "address";
+        }, {
+            readonly name: "amount";
+            readonly type: "uint256";
+        }];
+        readonly outputs: readonly [{
+            readonly type: "bool";
+        }];
+    }, {
+        readonly type: "function";
+        readonly name: "balanceOf";
+        readonly stateMutability: "view";
+        readonly inputs: readonly [{
+            readonly name: "account";
+            readonly type: "address";
+        }];
+        readonly outputs: readonly [{
+            readonly type: "uint256";
+        }];
+    }, {
+        readonly type: "function";
+        readonly name: "decimals";
+        readonly stateMutability: "view";
+        readonly inputs: readonly [];
+        readonly outputs: readonly [{
+            readonly type: "uint8";
+        }];
+    }, {
+        readonly type: "function";
+        readonly name: "name";
+        readonly stateMutability: "view";
+        readonly inputs: readonly [];
+        readonly outputs: readonly [{
+            readonly type: "string";
+        }];
+    }, {
+        readonly type: "function";
+        readonly name: "symbol";
+        readonly stateMutability: "view";
+        readonly inputs: readonly [];
+        readonly outputs: readonly [{
+            readonly type: "string";
+        }];
+    }, {
+        readonly type: "function";
+        readonly name: "totalSupply";
+        readonly stateMutability: "view";
+        readonly inputs: readonly [];
+        readonly outputs: readonly [{
+            readonly type: "uint256";
+        }];
+    }, {
+        readonly type: "function";
+        readonly name: "transfer";
+        readonly stateMutability: "nonpayable";
+        readonly inputs: readonly [{
+            readonly name: "recipient";
+            readonly type: "address";
+        }, {
+            readonly name: "amount";
+            readonly type: "uint256";
+        }];
+        readonly outputs: readonly [{
+            readonly type: "bool";
+        }];
+    }, {
+        readonly type: "function";
+        readonly name: "transferFrom";
+        readonly stateMutability: "nonpayable";
+        readonly inputs: readonly [{
+            readonly name: "sender";
+            readonly type: "address";
+        }, {
+            readonly name: "recipient";
+            readonly type: "address";
+        }, {
+            readonly name: "amount";
+            readonly type: "uint256";
+        }];
+        readonly outputs: readonly [{
+            readonly type: "bool";
+        }];
+    }], "Transfer">;
+}
+//# sourceMappingURL=transfer.d.ts.map

package/_types/actions/token/transfer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transfer.d.ts","sourceRoot":"","sources":["../../../actions/token/transfer.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,SAAS,CAAA;AACtC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAA;AACtD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,+BAA+B,CAAA;AAC3D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,6CAA6C,CAAA;AAC5E,OAAO,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAA;AAClD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAA;AACzD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,6BAA6B,CAAA;AACzD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAA;AACjD,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,oBAAoB,CAAA;AAG7C,OAAO,EACL,KAAK,0BAA0B,EAEhC,MAAM,+BAA+B,CAAA;AACtC,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,4BAA4B,CAAA;AACzE,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAC1D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAA;AACvE,OAAO,EACL,KAAK,WAAW,EAIhB,KAAK,cAAc,EAEnB,KAAK,eAAe,EACrB,MAAM,eAAe,CAAA;AAEtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,wBAAsB,QAAQ,CAC5B,KAAK,SAAS,KAAK,GAAG,SAAS,EAC/B,OAAO,SAAS,OAAO,GAAG,SAAS,EACnC,MAAM,SAAS,MAAM,GAAG,SAAS,GAAG,SAAS,EAE7C,MAAM,EAAE,MAAM,CAAC,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,CAAC,EACvE,UAAU,EAAE,QAAQ,CAAC,UAAU,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,CAAC,GACtD,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,CAE/B;AAED,yBAAiB,QAAQ,CAAC;IACxB,KAAY,IAAI,CACd,KAAK,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EACnD,MAAM,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,IACpD;QACF,kEAAkE;QAClE,MAAM,EAAE,WAAW,CAAA;QACnB,8EAA8E;QAC9E,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;QAC1B,qCAAqC;QACrC,EAAE,EAAE,OAAO,CAAA;KACZ,GAAG,cAAc,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;IACjC,KAAY,UAAU,CACpB,KAAK,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EACnD,OAAO,SAAS,OAAO,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,EACzD,MAAM,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,IACpD,eAAe,CAAC,KAAK,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;IACzD,KAAY,WAAW,GAAG,uBAAuB,CAAA;IAEjD,KAAY,SAAS,GAAG,aAAa,CAAA;IAErC,gBAAgB;IAChB,SAAsB,KAAK,CACzB,MAAM,SAAS,OAAO,aAAa,GAAG,OAAO,iBAAiB,EAC9D,KAAK,SAAS,KAAK,GAAG,SAAS,EAC/B,OAAO,SAAS,OAAO,GAAG,SAAS,EACnC,MAAM,SAAS,MAAM,GAAG,SAAS,GAAG,SAAS,EAE7C,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,CAAC,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,CAAC,EACvE,UAAU,EAAE,QAAQ,CAAC,UAAU,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,CAAC,GACtD,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAK7B;IAED;;;;;;;;;;;;;OAaG;IACH,SAAgB,IAAI,CAClB,KAAK,SAAS,KAAK,GAAG,SAAS,EAC/B,OAAO,SAAS,OAAO,GAAG,SAAS,EACnC,MAAM,SAAS,MAAM,GAAG,SAAS,GAAG,SAAS,EAE7C,MAAM,EAAE,MAAM,CAAC,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,CAAC,EACvE,UAAU,EAAE,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAGhC;IAED;;;;;;;OAOG;IACH,SAAsB,WAAW,CAC/B,KAAK,SAAS,KAAK,GAAG,SAAS,EAC/B,OAAO,SAAS,OAAO,GAAG,SAAS,EACnC,MAAM,SAAS,MAAM,GAAG,SAAS,GAAG,SAAS,EAE7C,MAAM,EAAE,MAAM,CAAC,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,CAAC,EACvE,UAAU,EAAE,QAAQ,CAAC,UAAU,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,CAAC,GACtD,OAAO,CAAC,MAAM,CAAC,CAKjB;IAED;;;;;;;OAOG;IACH,SAAsB,QAAQ,CAC5B,KAAK,SAAS,KAAK,GAAG,SAAS,EAC/B,OAAO,SAAS,OAAO,GAAG,SAAS,EACnC,MAAM,SAAS,MAAM,GAAG,SAAS,GAAG,SAAS,EAE7C,MAAM,EAAE,MAAM,CAAC,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,CAAC,EACvE,UAAU,EAAE,QAAQ,CAAC,UAAU,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,CAAC,GACtD,OAAO,CACR,0BAA0B,CAAC,OAAO,QAAQ,EAAE,UAAU,GAAG,cAAc,CAAC,CACzE,CAKA;IAED;;;;;OAKG;IACH,SAAgB,YAAY,CAAC,IAAI,EAAE,GAAG,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oBASvC;CACF"}