createLightAccountClient

Call Signature

1 function createLightAccountClient<TSigner>(
2   params,
3 ): Promise<
4   AlchemySmartAccountClient<
5     undefined | Chain,
6     LightAccount<TSigner>,
7     LightAccountClientActions<TSigner>
8   >
9 >;

Defined in: account-kit/smart-contracts/dist/types/src/light-account/clients/client.d.ts:11

Type Parameters

Type Parameter	Default type
`TSigner` extends `SmartAccountSigner`<`any`>	`SmartAccountSigner`<`any`>

Parameters

Parameter	Type
`params`	`Omit`<`CreateLightAccountParams`<`HttpTransport`, `TSigner`>, `"transport"`> & `Omit`<`AlchemySmartAccountClientConfig`<`Chain`, `LightAccount`<`TSigner`>>, `"account"`> & `object`

Returns

Promise<AlchemySmartAccountClient<undefined | Chain, LightAccount<TSigner>, LightAccountClientActions<TSigner>>>

Call Signature

1 function createLightAccountClient<TChain, TSigner, TTransport>(
2   args,
3 ): Promise<
4   SmartAccountClient<
5     CustomTransport,
6     TChain,
7     LightAccount<TSigner>,
8     SmartAccountClientActions<Chain, SmartContractAccount> &
9       LightAccountClientActions<TSigner, LightAccount<TSigner>>
10   >
11 >;

Defined in: account-kit/smart-contracts/dist/types/src/light-account/clients/client.d.ts:14

Type Parameters

Type Parameter	Default type
`TChain` extends `undefined` \| `Chain`	`undefined` \| `Chain`
`TSigner` extends `SmartAccountSigner`<`any`>	`SmartAccountSigner`<`any`>
`TTransport` extends `Transport`	`Transport`

Parameters

Parameter Type

Parameter	Type
`args`	`object` & `Omit`<`CreateLightAccountParams`<`TTransport`, `TSigner`>, `"chain"` \| `"transport"`> & `Omit`<{ `account?`: `SmartContractAccount`; `addBreadCrumb?`: <`T`>(`crumb`) => `T`; `cacheTime?`: `number`; `chain?`: `Chain` \| `TChain`; `customMiddleware?`: `ClientMiddlewareFn`<`undefined` \| `UserOperationContext`>; `dummyPaymasterAndData?`: `ClientMiddlewareFn`<`undefined` \| `UserOperationContext`>; `feeEstimator?`: `ClientMiddlewareFn`<`undefined` \| `UserOperationContext`>; `gasEstimator?`: `ClientMiddlewareFn`<`undefined` \| `UserOperationContext`>; `key?`: `string`; `name?`: `string`; `opts?`: { `feeOptions?`: { `callGasLimit?`: { `max?`: `number` \| `bigint` \| `0x${(...)}`; `min?`: `number` \| `bigint` \| `0x${(...)}`; `multiplier?`: `number`; }; `maxFeePerGas?`: { `max?`: `number` \| `bigint` \| `0x${(...)}`; `min?`: `number` \| `bigint` \| `0x${(...)}`; `multiplier?`: `number`; }; `maxPriorityFeePerGas?`: { `max?`: `number` \| `bigint` \| `0x${(...)}`; `min?`: `number` \| `bigint` \| `0x${(...)}`; `multiplier?`: `number`; }; `paymasterPostOpGasLimit?`: { `max?`: `number` \| `bigint` \| `0x${(...)}`; `min?`: `number` \| `bigint` \| `0x${(...)}`; `multiplier?`: `number`; }; `paymasterVerificationGasLimit?`: { `max?`: `number` \| `bigint` \| `0x${(...)}`; `min?`: `number` \| `bigint` \| `0x${(...)}`; `multiplier?`: `number`; }; `preVerificationGas?`: { `max?`: `number` \| `bigint` \| `0x${(...)}`; `min?`: `number` \| `bigint` \| `0x${(...)}`; `multiplier?`: `number`; }; `verificationGasLimit?`: { `max?`: `number` \| `bigint` \| `0x${(...)}`; `min?`: `number` \| `bigint` \| `0x${(...)}`; `multiplier?`: `number`; }; }; `txMaxRetries?`: `number`; `txRetryIntervalMs?`: `number`; `txRetryMultiplier?`: `number`; }; `paymasterAndData?`: `ClientMiddlewareFn`<`undefined` \| `UserOperationContext`>; `pollingInterval?`: `number`; `signUserOperation?`: `ClientMiddlewareFn`<`undefined` \| `UserOperationContext`>; `transport`: `TTransport`; `type?`: `string`; `userOperationSimulator?`: `ClientMiddlewareFn`<`undefined` \| `UserOperationContext`>; }, `"account"` \| `"chain"` \| `"transport"`> & `NotType`<`TTransport`, `AlchemyTransport`>

args

object & Omit<CreateLightAccountParams<TTransport, TSigner>, "chain" | "transport"> & Omit<{ account?: SmartContractAccount; addBreadCrumb?: <T>(crumb) => T; cacheTime?: number; chain?: Chain | TChain; customMiddleware?: ClientMiddlewareFn<undefined | UserOperationContext>; dummyPaymasterAndData?: ClientMiddlewareFn<undefined | UserOperationContext>; feeEstimator?: ClientMiddlewareFn<undefined | UserOperationContext>; gasEstimator?: ClientMiddlewareFn<undefined | UserOperationContext>; key?: string; name?: string; opts?: { feeOptions?: { callGasLimit?: { max?: number | bigint | `0x${(...)}`; min?: number | bigint | `0x${(...)}`; multiplier?: number; }; maxFeePerGas?: { max?: number | bigint | `0x${(...)}`; min?: number | bigint | `0x${(...)}`; multiplier?: number; }; maxPriorityFeePerGas?: { max?: number | bigint | `0x${(...)}`; min?: number | bigint | `0x${(...)}`; multiplier?: number; }; paymasterPostOpGasLimit?: { max?: number | bigint | `0x${(...)}`; min?: number | bigint | `0x${(...)}`; multiplier?: number; }; paymasterVerificationGasLimit?: { max?: number | bigint | `0x${(...)}`; min?: number | bigint | `0x${(...)}`; multiplier?: number; }; preVerificationGas?: { max?: number | bigint | `0x${(...)}`; min?: number | bigint | `0x${(...)}`; multiplier?: number; }; verificationGasLimit?: { max?: number | bigint | `0x${(...)}`; min?: number | bigint | `0x${(...)}`; multiplier?: number; }; }; txMaxRetries?: number; txRetryIntervalMs?: number; txRetryMultiplier?: number; }; paymasterAndData?: ClientMiddlewareFn<undefined | UserOperationContext>; pollingInterval?: number; signUserOperation?: ClientMiddlewareFn<undefined | UserOperationContext>; transport: TTransport; type?: string; userOperationSimulator?: ClientMiddlewareFn<undefined | UserOperationContext>; }, "account" | "chain" | "transport"> & NotType<TTransport, AlchemyTransport>

Returns

Promise<SmartAccountClient<CustomTransport, TChain, LightAccount<TSigner>, SmartAccountClientActions<Chain, SmartContractAccount> & LightAccountClientActions<TSigner, LightAccount<TSigner>>>>