Skip to content

getPlanSteps

Return the ordered, sanitized steps an integrator can present to a user.

Import

ts
import { getPlanSteps } from "@0xcurvy/curvy-sdk/actions";

Usage

ts
const result = getPlanSteps(plan);

Signature

ts
function getPlanSteps<C extends DraftCommand>(plan: Plan<C>): PlanStep[]

Returns

PlanStep[]

The action resolves or returns the value shown in the signature.

Parameters

plan

  • Type: Plan<C>
  • Required: yes

A plan whose sanitized command and wait metadata should be returned.

ts
const result = getPlanSteps(
  plan, 
);

Errors

Errors from config resolution and the underlying SDK operation are propagated to the caller.

Source

packages/@0xcurvy/sdk/src/actions/planner/getPlanSteps.ts