getQuote
Estimate a review screen without exposing note inputs, bearer outputs, or mutable plans.
Import
ts
import { getQuote } from "@0xcurvy/curvy-sdk/actions";Usage
ts
const result = await getQuote({ intent, config });Signature
ts
function getQuote(parameters: EstimateIntentParameters): Promise<Quote>Returns
Promise<Quote>
The action resolves or returns the value shown in the signature.
Parameters
intent
- Type:
Intent - Required: yes
The transfer intent to estimate for the review screen.
ts
const result = await getQuote({
intent,
});accountId
- Type:
string - Required: no
Explicit account guard. This config has one bearer session, so it must be the active account.
ts
const result = await getQuote({
intent,
accountId,
});signal
- Type:
AbortSignal - Required: no
Cancel a superseded estimate; cancelled results are never published.
ts
const result = await getQuote({
intent,
signal,
});minimumInputFinalityPolicy
- Type:
InputFinalityPolicy - Required: no
Integration-level lower bound that account/intent settings cannot weaken.
ts
const result = await getQuote({
intent,
minimumInputFinalityPolicy,
});submissionMode
- Type:
SubmissionMode - Required: no
Override the config's submission path for this estimate and its prepared execution.
ts
const result = await getQuote({
intent,
submissionMode,
});config
- Type:
CurvyConfig - Required: no
Curvy config to use. Defaults to the ambient config.
ts
const result = await getQuote({
intent,
config,
});Errors
Errors from config resolution and the underlying SDK operation are propagated to the caller.