跳转至主要内容

Generate deposit calldata – Earn API

更新于
Jul 31, 2026

概述

Returns one ready-to-sign selfBatchDeposit transaction on the strategy's chain, covering local vault deposits plus per-remote-chain CCTP burns. The matching intent (kind deposit) is written server-side; do not post an intent separately. No auth; no request body (the id is in the path).

Strategy must be pending_setup (top-ups are not supported).

Timing: expiresAt is an advisory ~1h plan-freshness bound. The intent itself has a 30-day TTL; regenerating an unchanged plan within it returns the same intentId, and regenerating after expiry or fulfillment mints a new one. A strategy that has never received a deposit is purged about one hour after it was last touched, taking its intent with it; calling this endpoint refreshes that hour. If signing takes longer than an hour (e.g. a multisig), regenerate at least hourly until the transaction is broadcast.

Approve vault share tokens and USDC before calling: live allowances affect vault selection, and approvalsNeeded reflects what is still missing.

Submit the returned 数据 verbatim (re-encoding breaks intent attribution) and use gasHint as the gas limit (wallet re-estimates can run out of gas).

Endpoint

POST https://earn-api.quicknode.dev/functions/v1/api/v1/strategies/{id}/calldata/deposit

Authorization

Include the published apikey header. This endpoint is public and does not require a SIWE signature.

Rate limits

This operation belongs to the calldata rate-limit bucket. It allows 10 requests per 60 seconds, keyed by strategy+ip. A coarser limit of approximately 30 requests per 60 seconds also applies per IP across deposit, withdrawal, and claim calldata requests.

参数

ParameterLocation类型Required描述
idpath字符串Strategy UUID.

Request body

Deposit calldata request body. Public (no SIWE). The deposit endpoint takes no parameters, so send no body or an empty JSON object ({}).

Example request

curl --request POST \
--url 'https://earn-api.quicknode.dev/functions/v1/api/v1/strategies/<PENDING_STRATEGY_ID>/calldata/deposit' \
--header 'Accept: application/json' \
--header 'apikey: <EARN_PUBLIC_API_KEY>' \
--header 'Content-Type: application/json' \
--data '{}'

回复

Field类型Required描述
kindstring (deposit)Identifies the response as a deposit calldata plan.
交易array<object>Exactly one transaction, on the strategy's chain.
approvalsNeededarray<object>Token allowances that must be granted before submitting the deposit transaction.
expiresAt字符串~1h ADVISORY plan-freshness bound. NOT the intent attribution window (the intent carries a 30-day TTL). Regenerate after this passes; regeneration within the intent TTL returns the same `intentId`.
计划对象The deposit allocation plan.
transactions[].chainId整数Chain on which to submit the transaction.
transactions[].to字符串Quicknode Earn proxy address on `chainId`.
transactions[].data字符串Transaction calldata. Submit it verbatim.
transactions[].value字符串Native-token value. Always `"0"`.
transactions[].intentId字符串Intent UUID used to track the transaction.
transactions[].kindstring (deposit)Transaction intent kind.
transactions[].description字符串Human-readable transaction summary.
transactions[].gasHintstring | nullRecommended gas limit, or `null` when it cannot be estimated.
transactions[].gasHintReason字符串`approvals_required` or `estimation_failed` when `gasHint` is `null`.
approvalsNeeded[].chainId整数Chain where approval is required.
approvalsNeeded[].token字符串Token contract requiring an allowance.
approvalsNeeded[].spender字符串Quicknode Earn proxy address.
approvalsNeeded[].currentAllowance字符串Current allowance in token base units.
approvalsNeeded[].requiredAllowance字符串Required allowance in token base units.
approvalsNeeded[].tx对象Ready-to-sign token approval transaction.
approvalsNeeded[].tx.to字符串Token contract receiving the approval call.
approvalsNeeded[].tx.data字符串ABI-encoded approval calldata.
approvalsNeeded[].tx.value字符串Native-token value, normally `"0"`.
plan.totalUsdc字符串Total allocated USDC as a six-decimal base-unit string.
plan.vaultsarray<string>Local-chain vault addresses.
plan.amountsarray<string>Base-unit amounts aligned with `plan.vaults`.
plan.burnsarray<object>Combined CCTP burns for remote chains.
plan.burns[].destDomain整数CCTP destination domain.
plan.burns[].mintRecipient字符串Bytes32-padded mint recipient.
plan.burns[].destinationCaller字符串Bytes32-padded destination caller.
plan.burns[].amount字符串Burn amount in USDC base units.
plan.burns[].maxFee字符串Maximum CCTP fee in base units.
plan.burns[].minFinalityThreshold整数Minimum CCTP finality threshold.
plan.burnVaultBreakdownarray<array<object>>Destination vault allocations aligned with `plan.burns`.
plan.burnVaultBreakdown[][].vault字符串Destination vault address.
plan.burnVaultBreakdown[][].amount字符串Vault allocation in USDC base units.
plan.burnVaultBreakdown[][].name字符串Destination vault name.
plan.burnVaultBreakdown[][].apy数字Destination vault APY percentage.
plan.apys对象Map of vault keys to APY percentages.
plan.vaultNames对象Map of vault keys to vault names.
plan.chainIds对象Map of vault keys to chain IDs.

Example response

{
"kind": "deposit",
"transactions": [
{
"chainId": 8453,
"to": "0x48b415841165304f7EfaA7D5dD5FC65cc7B4bd8e",
"data": "0x5a6b7c8d0000000000000000000000000000000000000000000000000000000000000060",
"value": "0",
"intentId": "7f3a1c2b-0000-4000-8000-000000000abc",
"kind": "deposit",
"description": "Deposit $1000 into 2 vault(s), bridging to 1 chain(s)",
"gasHint": "480000"
}
],
"approvalsNeeded": [],
"plan": {
"totalUsdc": "1000000000",
"vaults": ["0x616a4e1db48e22028f6bbf20444cd3b8e3273738"],
"amounts": ["600000000"],
"burns": [
{
"destDomain": 3,
"mintRecipient": "0x00000000000000000000000048b415841165304f7efaa7d5dd5fc65cc7b4bd8e",
"destinationCaller": "0x00000000000000000000000048b415841165304f7efaa7d5dd5fc65cc7b4bd8e",
"amount": "400000000",
"maxFee": "0",
"minFinalityThreshold": 2000
}
],
"burnVaultBreakdown": [
[
{
"vault": "0x1a996cb54bb95462040408c06122d45d6cdb6096",
"amount": "400000000",
"name": "Gauntlet USDC Core",
"apy": 5.117
}
]
],
"apys": {
"8453:0x616a4e1db48e22028f6bbf20444cd3b8e3273738": 6.482,
"42161:0x1a996cb54bb95462040408c06122d45d6cdb6096": 5.117
},
"vaultNames": {
"8453:0x616a4e1db48e22028f6bbf20444cd3b8e3273738": "Seamless USDC Vault",
"42161:0x1a996cb54bb95462040408c06122d45d6cdb6096": "Gauntlet USDC Core"
},
"chainIds": {
"8453:0x616a4e1db48e22028f6bbf20444cd3b8e3273738": 8453,
"42161:0x1a996cb54bb95462040408c06122d45d6cdb6096": 42161
}
},
"expiresAt": "2026-07-07T19:00:00.000Z"
}

HTTP responses

状态描述
200One deposit transaction, approvals needed, plan transparency, and an advisory expiry.
400One of: the strategy is not `pending_setup` (`invalid_state`); no eligible vaults (`no_eligible_vaults`); gas estimation failed (`gas_estimation_failed`, the tx would revert, usually unfunded or unapproved); or a malformed JSON body (`invalid_request`).
404Resource not found.
429Rate limit exceeded. `Retry-After` (seconds) tells you when to retry. Reads, feedback, and push writes are keyed per IP; create/update/delete are keyed per wallet+IP; deposit/withdraw/claim calldata is keyed per strategy+IP.
500Internal error, or `burn_route_unavailable` when a required remote chain has no CCTP burn route configured.
503The hide list could not be loaded (`hide_lookup_failed`, fails closed).
OpenAPI source

This page is based on operation depositCalldata in the Earn OpenAPI 3.1 specification.