deposit: Deposit templates

The deposit namespace emits deposit programs from protocol templates listed under DepositKey. Compile with baseDirs: [...deposit.DEPOSIT_BASE_DIRS], or COMPOSED_BASE_DIRS for a swap-then-deposit program.

import { deposit } from "@eco-incorp/sauce";

This page covers sdk/dist/deposit/templates.d.ts.

Generated from the type declarations shipped in @eco-incorp/sauce 0.99.4. Each entry shows the package authors’ JSDoc and declaration for this SDK version. For runtime compatibility and deployed addresses, see architecture and deployments.

`deposit.DEPOSIT_TEMPLATES`

Variable · sdk/dist/deposit/templates.d.ts

DEPOSIT_TEMPLATES: Readonly<Record<DepositKey, DepositTemplate>>

`deposit.depositTemplateFor`

Function · sdk/dist/deposit/templates.d.ts Looks up a template by protocol:action, throwing (and listing every registered key) rather than letting a caller emit a program that would misbehave on-chain - same posture as toSwapParams’s guard on UndispatchablePoolType.

export declare function depositTemplateFor(protocol: string, action: string): DepositTemplate;

`deposit.listDepositTemplates`

Function · sdk/dist/deposit/templates.d.ts

export declare function listDepositTemplates(): readonly DepositTemplate[];

`deposit.DepositKey`

Type · sdk/dist/deposit/templates.d.ts

export type DepositKey = "weth:wrap" | "weth:unwrap" | "aave-v3:supply" | "aave-v3:withdraw" | "spark:supply" | "spark:withdraw" | "compound-v3:supply" | "euler-v2:deposit" | "erc4626:deposit" | "lido:stake" | "lido:wrap";

Sauce SDK

@eco-incorp/sauce

@eco-incorp/sauce-compiler

deposit: Deposit templates

`deposit.DEPOSIT_TEMPLATES`

`deposit.depositTemplateFor`

`deposit.listDepositTemplates`

`deposit.DepositKey`

​deposit.DEPOSIT_TEMPLATES

​deposit.depositTemplateFor

​deposit.listDepositTemplates

​deposit.DepositKey

`deposit.DEPOSIT_TEMPLATES`

`deposit.depositTemplateFor`

`deposit.listDepositTemplates`

`deposit.DepositKey`