Enter a Yield
actions_enterConstruct unsigned transactions to stake or deposit into a yield. Does NOT execute — the user must sign each transaction exactly as returned (never modify unsignedTransaction). Amounts are human-readable strings ("1.5" = 1.5 tokens, not wei). Submit transactions in stepIndex order; for the synchronous execution pattern, wait for on-chain confirmation before submitting the next one. For ERC-4626 vaults (including RWAs like Midas), inspect yields_get → mechanics.arguments.enter.fields[] to discover yield-specific options (e.g. useMaxAllowance, receiverAddress).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| amount | Yes | Token units e.g. "1.5" for 1.5 ETH | |
| address | Yes | Wallet address that will own the position. | |
| yieldId | Yes | Yield ID from yields_get_all e.g. "ethereum-eth-lido-staking". | |
| inputToken | No | Deposit token address, for yields that accept more than one deposit token. Required when yields_get → mechanics.arguments.enter.fields[] lists an inputToken field with required: true; that field's options[] holds the valid addresses, which also appear as yields_get → inputTokens[].address. Use "0x" to deposit the network's native token. | |
| executionMode | No | Transaction execution mode. Defaults to "individual". "batched" is reserved for future use — batch mode is not yet available across all yields and should not be used until fully enabled. | |
| receiverAddress | No | Optional. ERC-4626 vault convenience field. Address that should receive the minted vault shares. Defaults to the position owner (`address`). Honored only when listed in yields_get enter schema. | |
| useMaxAllowance | No | Optional. ERC-4626 vault convenience flag. true = approve the maximum (uint256 max) allowance, so subsequent deposits skip a fresh APPROVAL step. false = approve only the exact amount being deposited. Honored only when listed in yields_get enter schema. | |
| validatorAddress | No | Validator to delegate to. Required when yields_get returns mechanics.requiresValidatorSelection=true. | |
| inputTokenNetwork | No | Network of the input token e.g. "ethereum". Only for cross-chain deposits, where the deposit token is not on the vault's own network. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| type | Yes | ||
| amount | Yes | ||
| intent | Yes | ||
| status | Yes | ||
| address | Yes | ||
| yieldId | Yes | ||
| amountRaw | Yes | ||
| amountUsd | Yes | ||
| createdAt | Yes | ||
| completedAt | Yes | ||
| rawArguments | Yes | ||
| transactions | Yes | ||
| executionPattern | Yes |