ox/dist/core/StateOverrides.d.ts

Ethereum Standard Library

import type * as Address from './Address.js';
import type * as Hex from './Hex.js';
import type { Compute, OneOf } from './internal/types.js';
/**
 * State override set to specify state to be ephemerally overridden prior to executing a call.
 */
export type StateOverrides<bigintType = bigint> = Compute<{
    [address: Address.Address]: AccountOverrides<bigintType>;
}>;
/**
 * RPC state overrides.
 */
export type Rpc = StateOverrides<Hex.Hex>;
/**
 * Details of an account to be overridden.
 */
export type AccountOverrides<bigintType = bigint> = Compute<{
    /** Balance to set for the account. */
    balance?: bigintType | undefined;
    /** Code to set for the account. */
    code?: Hex.Hex | undefined;
    /** Address to move the precompile to. */
    movePrecompileToAddress?: Address.Address | undefined;
    /** Nonce to set for the account. */
    nonce?: bigintType | undefined;
} & OneOf<{
    /** Key-value mapping to override all slots in the account storage. */
    state?: AccountStorage | undefined;
} | {
    /** Key-value mapping to override individual slots in the account storage. */
    stateDiff?: AccountStorage | undefined;
}>>;
/**
 * RPC account overrides.
 */
export type RpcAccountOverrides = AccountOverrides<Hex.Hex>;
/**
 * Key-value mapping to override all slots in the account storage before executing the call.
 */
export type AccountStorage = Compute<{
    [slot: Hex.Hex]: Hex.Hex;
}>;
/**
 * Converts an {@link ox#StateOverrides.Rpc} to an {@link ox#StateOverrides.StateOverrides}.
 *
 * @example
 * ```ts twoslash
 * import { StateOverrides } from 'ox'
 *
 * const stateOverrides = StateOverrides.fromRpc({
 *   '0x0000000000000000000000000000000000000000': {
 *     balance: '0x1'
 *   }
 * })
 * ```
 *
 * @param rpcStateOverrides - The RPC state overrides to convert.
 * @returns An instantiated {@link ox#StateOverrides.StateOverrides}.
 */
export declare function fromRpc(rpcStateOverrides: Rpc): StateOverrides;
/**
 * Converts an {@link ox#StateOverrides.StateOverrides} to an {@link ox#StateOverrides.Rpc}.
 *
 * @example
 * ```ts twoslash
 * import { StateOverrides } from 'ox'
 *
 * const stateOverrides = StateOverrides.toRpc({
 *   '0x0000000000000000000000000000000000000000': {
 *     balance: 1n
 *   }
 * })
 * ```
 *
 * @param stateOverrides - The state overrides to convert.
 * @returns An instantiated {@link ox#StateOverrides.Rpc}.
 */
export declare function toRpc(stateOverrides: toRpc.Input): Rpc;
export declare namespace toRpc {
    /** Numberish input accepted by {@link ox#StateOverrides.(toRpc:function)}. */
    type Input = StateOverrides<Hex.Hex | bigint | number>;
}
//# sourceMappingURL=StateOverrides.d.ts.map