Lelantos SDK

Appearance

@lelantos-org/sdk / index / DepositQuote

Interface: DepositQuote ​

Defined in: @lelantos-org/sdk/dist/wallet/types/quotes.d.ts:78

What deposit(args) would pull, charge and do right now, including the per-token figures a deposit form sizes balances and Permit2 setup against.

Rejects as deposit would before signing: FEE_ASSET_NOT_QUOTED, INVALID_ARGUMENT for a refused fee asset or a bad amount, UNSUPPORTED_OPERATION for native without an adapter.

Properties ​

allowanceSetupAvailable ​

ts
allowanceSetupAvailable: boolean;

Defined in: @lelantos-org/sdk/dist/wallet/types/quotes.d.ts:102

Not native, the adapter supports AllowanceTransfer, and some pull's allowance does not cover it: setupDepositAllowance would move later deposits onto the allowance path.

amount ​

ts
amount: Money;

Defined in: @lelantos-org/sdk/dist/wallet/types/quotes.d.ts:85

The principal: the new note's value.

asset ​

ts
asset: AssetInfo;

Defined in: @lelantos-org/sdk/dist/wallet/types/quotes.d.ts:80

feeAsset ​

ts
feeAsset: AssetInfo;

Defined in: @lelantos-org/sdk/dist/wallet/types/quotes.d.ts:82

The asset paying the relayer: asset unless another was chosen.

fees ​

ts
fees: FeeBreakdown;

Defined in: @lelantos-org/sdk/dist/wallet/types/quotes.d.ts:87

Protocol fee in asset (charged on top), relayer fee in feeAsset.

feeSharesToken ​

ts
feeSharesToken: boolean;

Defined in: @lelantos-org/sdk/dist/wallet/types/quotes.d.ts:95

The fee draws on the deposited token's balance and allowance (pulls.length === 1).

kind ​

ts
readonly kind: "depositQuote";

Defined in: @lelantos-org/sdk/dist/wallet/types/quotes.d.ts:79

native ​

ts
native: boolean;

Defined in: @lelantos-org/sdk/dist/wallet/types/quotes.d.ts:83

principal ​

ts
principal: TokenAmount;

Defined in: @lelantos-org/sdk/dist/wallet/types/quotes.d.ts:89

amount + fees.protocol in base units of asset: what the principal's pull is sized to.

pulls ​

ts
pulls: DepositPull[];

Defined in: @lelantos-org/sdk/dist/wallet/types/quotes.d.ts:91

Per distinct token, the deposited token first. One entry unless the fee's token differs.

quotedAt ​

ts
quotedAt: number;

Defined in: @lelantos-org/sdk/dist/wallet/types/quotes.d.ts:106

Unix seconds. Yield figures drift with the pool's rate; re-quote rather than cache long.

separateFee ​

ts
separateFee: boolean;

Defined in: @lelantos-org/sdk/dist/wallet/types/quotes.d.ts:93

The pool pulls the relayer's note on its own (a two-entry batch permit).

strategy ​

ts
strategy: DepositStrategy;

Defined in: @lelantos-org/sdk/dist/wallet/types/quotes.d.ts:97

deposit's path right now: native, allowance (every pull covered) or witness.

sufficientBalance ​

ts
sufficientBalance: boolean | undefined;

Defined in: @lelantos-org/sdk/dist/wallet/types/quotes.d.ts:104

Every pull's balance is known and covers its amount; undefined when one is unknown.