Create a "deposit" transaction

post https://api.valha.xyz/v0/{chain}/pools/{pool_address}/deposit

BETA FEATURE - Please contact team to be whitelisted.

Create transaction objects to interact with an EVM blockchain for a specified user.

Path Params

chain

string

required

Defaults to ethereum

The blockchain that will be used for this request.

pool_address

string

required

Defaults to 0xdf0770df86a8034b3efef0a1bb3c889b8332ff56

The address of the pool that will be used for this request.

Body Params

To create deposit interaction objects, the body of the request depends on the type of pool that you are trying to interact with.

If pool type is not identified as AMM Pool in "Retrieve pools from a protocol route" then you should enter as parameters:

user
amount

If pool type is identified as AMM Pool in "Retrieve pools from a protocol route" then you should enter as parameters:

user
tokens (addresses of the underlying tokens)
amounts_desired (underlying tokens amounts that you want to deposit in)
amounts_minimum (underlying tokens minimum amounts that you want to deposit in)

Be careful in the latter case, the orders inside the array has an impact on which amounts are assigned to each tokens. (Ex.: {tokens: [token_a, token_b], amounts_desired: [amount_desired_token_a, amount_desired_token_b], amounts_minimum: [amount_minimum_token_a, amount_minimum_token_b]})

BETA FEATURE - You can execute crosschain action by specifying the bridge object as parameter. Be careful, it is still a beta feature that may return an error if no route is found to bridge the asset.

user

string

required

Defaults to 0x45E954acf1Efc374478dF69B45f12AEFD8AE51a3

amount

number

Defaults to 20

tokens

array of strings

Please specify the addresses of the underlying tokens in the same order as the amounts.

tokens

amounts_desired

array of numbers

amounts_desired

amounts_minimum

array of numbers

amounts_minimum

disable_check

boolean

Defaults to true

If selected to true, the API will not check if the provided user's address has enought token to perform the action.

maximum_approval

boolean

Defaults to false

If selected to true, the API will put the maximum amount for the approval action.

estimate_gas

boolean

Defaults to false

BETA FEATURE (only Ethereum, Polygon and Arbitrum chains for now) - If selected to true, the API will return the gas limit necessary for the action.

bridge

object

BETA FEATURE - If you want to do a crosschain deposit, you must specify the information from the origin chain, token and the amount to be received.

get_quote

boolean

Defaults to false

BETA FEATURE - If selected to true, the API will return the estimation of token you will receive with this action in a specific "estimate" object. Be careful, this option changes the return type of the API to have two objects: "estimate" and "transactions".

estimate_return

boolean

Defaults to false

BETA FEATURE - If selected to true, the API will return the estimation of rewards you will receive with this action in a specific "estimate" object and the gas cost of the action (from approval to the action). Be careful, this option changes the return type of the API to have two objects: "estimate" and "transactions".

ranges

array of strings

Necessary only if you want to specify the range in which you deposit (ex.: Uniswap v3, Atlendis, etc)

ranges

range_id

string

It can be an address or an id number.

referral

string

Please specify the address, the string or the referral number you want to specify into the action. This referral code will be provided to the protocol for the action.

fee_recipient

string

The address that should receive affiliate fees specified in the fee parameters.

fee

number

The percentage (denoted as a decimal between 0 - 1.0 where 1.0 represents 100% and 0.01 represents 1%) of the amount that should be attributed to fee_recipient as affiliate fees.

Responses

`approveTx` might be `null` if there is no need for an approval.

xxxxxxxxxx
curl --request POST \
     --url https://api.valha.xyz/v0/ethereum/pools/0xdf0770df86a8034b3efef0a1bb3c889b8332ff56/deposit \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "user": "0x45E954acf1Efc374478dF69B45f12AEFD8AE51a3",
  "amount": 20,
  "disable_check": true,
  "maximum_approval": false,
  "estimate_gas": false,
  "get_quote": false,
  "estimate_return": false
}
'

200approveTx might be null if there is no need for an approval.

400

`approveTx` might be `null` if there is no need for an approval.