Documentation for agents: an index at /llms.txt, every docs page in one file at /llms-full.txt, and Markdown for any docs page by adding .md to its URL.

Skip to Content
ensforgeSDK

plan.list

Lists the saved plans of this client's chain and of its chains, newest first. Parameters, return value, errors and examples for plan.list in @ensforge/sdk.

ReadBatchablestable
Since v1.0.0View source

Lists the saved plans of this client's chain and of its chains, newest first.

When to use

Use to offer unfinished registrations or migrations after a reload.

Details

  • Filter by the account that prepared them and by status (pending, completed, failed).

Signature

function list(client: Like, options: list.Options): Promise<list.ReturnType>

Call it as ens.plan.list(options) on a client, or Actions.plan.list(client, options).

plan.list.request(options) builds a deferred read for Actions.batch. See Look up many at once.

Parameters

OptionTypeDefaultDescription
accountstringOnly plans prepared for this account.
statusPlan.Record["status"]Only plans with this status.

Returns

Resolves to readonly Plan.Record[]. The saved plans, newest first.

FieldTypeDescription
planPlan
status"pending" | "completed" | "failed"pending while steps remain, completed once every step is submitted.
submittedReadonly<globalThis.Record<string, readonly Hex[]>>Transaction hashes per submitted step id.
bundlesReadonly<globalThis.Record<string, string>>EIP-5792 bundle id per step sent in a bundle.
references (optional)Readonly<globalThis.Record<string, string>>Route references per step sent through via (e.g. UserOperation hashes).
error (optional)stringMessage of the last failure.
updatedAtnumberUnix time in milliseconds.

Errors

ErrorCodesWhen
InvalidInputErrorINVALID_ADDRESSan invalid account.
PlanErrorPLAN_INVALIDa saved plan cannot be read.
NetworkErrorRPC_REQUEST_FAILED, RPC_TIMEOUT, RATE_LIMITEDthe RPC request fails.

It can also fail with the errors every read can (Errors.CommonError: ConfigError, ContractRevertError, InternalError, NetworkError).

See How errors work.

Examples

Listing unfinished plans
const records = await ens.plan.list({ status: "failed" })

See also

Was this page helpful?