Aura on Ethereum
Deployments
Action: deposit
Parameters
| Name | Type | Description |
|---|---|---|
targets | string[] (required) | Pool name | Pool bpt | Pool id |
tokens | string[] (optional) | Token symbol | Token address |
Each Aura pool is connected to exactly one Balancer Pool token (BPT) and we allow specifying the deposit targets using any of the following identifiers:
- BPT symbol (
Poolname). - BPT address (
Poolbpt). - Aura pool ID (
Poolid).
TARGET_BPT below refers to the address of Aura pool's BPT.
TARGET_ID below refers to the Aura pool ID.TARGET_REWARDER below refers to the auraBaseRewardPool contract address
for the target Aura pool.
TOKEN below refers to the ERC-20 token address of each element given in
tokens. If tokens is not specified then the pool tokens of each TARGET
are considered.
TARGET_BPT · approve
Approve Booster to spend TARGET_BPT tokens on behalf of the avatar.
-
Contract:
TARGET_BPT -
Function:
approve(address,uint256)Parameter Constraint spenderequal to Boosteramount-
TOKEN · approve
Approve RewardPoolDepositWrapper to spend TOKEN tokens on behalf of the avatar.
-
Contract:
TOKEN -
Function:
approve(address,uint256)Parameter Constraint spenderequal to RewardPoolDepositWrapperamount-
Booster · deposit
Deposit TARGET_BPT tokens to the corresponding Aura pool and receive TARGET_REWARDER tokens in exchange.
-
Contract:
Booster -
Function:
deposit(uint256,uint256,bool)Parameter Constraint pidequal to TARGET_IDamount- stake-
RewardPoolDepositWrapper · depositSingle
Deposit TOKEN tokens to the corresponding Aura pool and receive TARGET_REWARDER tokens in exchange.
-
Contract:
RewardPoolDepositWrapper -
Function:
depositSingle(address,address,uint256,bytes32,(address[],uint256[],bytes,bool))Parameter Constraint rewardPoolAddressequal to TARGET_REWARDERinputTokenequal to TOKENinputAmount- balancerPoolIdequal to balancerPoolIdrequest.assets- request.maxAmountsIn- request.userData- request.fromInternalBalance-
TARGET_REWARDER · withdrawAndUnwrap
Redeem TARGET_REWARDER tokens and withdraw and unwrap TARGET_BPT tokens.
-
Contract:
TARGET_REWARDER -
Function:
withdrawAndUnwrap(uint256,bool)Parameter Constraint amount- claim-
TARGET_REWARDER · getReward
Claim Pool rewards.
-
Contract:
TARGET_REWARDER -
Function:
getReward()Parameter Constraint N/A N/A
TARGET_REWARDER · getReward(address,bool)
Claim Pool rewards of a specific account.
-
Contract:
TARGET_REWARDER -
Function:
getReward(address,bool)Parameter Constraint accountequal to AVATARclaimExtras-
Action: stake
Parameters:
| Name | Type | Constraint |
|---|---|---|
targets | string[] (required) | StakeToken symbols | StakeToken addresses |
Target: BAL
If the BAL token is given as an element of targets, the following functions will be allowed:
BAL · approve
Approve BalDepositorWrapper to spend BAL tokens on behalf of avatar.
-
Contract:
BAL -
Function:
approve(address,uint256)Parameter Constraint spenderequal to BalDepositorWrapperamount-
BalDepositorWrapper · deposit
Mint and optionally stake auraBAL using BAL.
-
Contract:
BalDepositorWrapper -
Function:
deposit(uint256,uint256,bool,address)Parameter Constraint amount- minOut- lock- stakeAddressequal to ( 0x0000000000000000000000000000000000000000orAuraBalBaseRewardPoolorAuraBalStaker) -
If the
stakeAddressis:0x0000000000000000000000000000000000000000: mintauraBAL.AuraBalBaseRewardPool: mintauraBAL, stake it and receiveAuraBalBaseRewardPooltokens in exchange.AuraBalStaker: mintauraBAL, stake it and receivestkauraBALtokens in exchange.
AuraBalBaseRewardPool · withdraw
Redeem AuraBalBaseRewardPool tokens and receive auraBAL tokens in exchange.
-
Contract:
AuraBalBaseRewardPool -
Function:
withdraw(uint256,bool)Parameter Constraint amount- claim-
AuraBalBaseRewardPool · getReward
Claim auraBAL staking rewards.
-
Contract:
AuraBalBaseRewardPool -
Function:
getReward()Parameter Constraint N/A N/A
stkauraBAL · withdraw
Redeem stkauraBAL tokens and receive auraBAL tokens in exchange.
-
Contract:
stkauraBAL -
Function:
withdraw(uint256,address,address)Parameter Constraint amount- receiverequal to AVATARownerequal to AVATAR
stkauraBAL · redeem
Redeem stkauraBAL tokens and receive auraBAL tokens in exchange (it is called when MAX underlying amount is withdrawn).
-
Contract:
stkauraBAL -
Function:
redeem(uint256,address,address)Parameter Constraint amount- receiverequal to AVATARownerequal to AVATAR
AuraBalVirtualBalanceRewardPool · getReward
Claim auraBAL compounding rewards.
-
Contract:
AuraBalVirtualBalanceRewardPool -
Function:
getReward()Parameter Constraint N/A N/A
Target: B-80BAL-20WETH
If the B-80BAL-20WETH token is given as an element of targets, the following functions will be allowed:
B-80BAL-20WETH · approve
Approve AuraBalBptDepositor to spend B-80BAL-20WETH tokens on behalf of avatar.
-
Contract:
B-80BAL-20WETH -
Function:
approve(address,uint256)Parameter Constraint spenderequal to AuraBalBptDepositoramount-
AuraBalBptDepositor · deposit
Mint and optionally stake auraBAL using B-80BAL-20WETH.
-
Contract:
AuraBalBptDepositor -
Function:
deposit(uint256,uint256,bool,address)Parameter Constraint amount- minOut- lock- stakeAddressequal to ( 0x0000000000000000000000000000000000000000orAuraBalBaseRewardPoolorAuraBalStaker) -
If the
stakeAddressis:0x0000000000000000000000000000000000000000: mintauraBAL.AuraBalBaseRewardPool: mintauraBAL, stake it and receiveAuraBalBaseRewardPooltokens in exchange.AuraBalStaker: mintauraBAL, stake it and receivestkauraBALtokens in exchange.
AuraBalBaseRewardPool · withdraw
Redeem AuraBalBaseRewardPool tokens and receive auraBAL tokens in exchange.
-
Contract:
AuraBalBaseRewardPool -
Function:
withdraw(uint256,bool)Parameter Constraint amount- claim-
AuraBalBaseRewardPool · getReward
Claim auraBAL staking rewards.
-
Contract:
AuraBalBaseRewardPool -
Function:
getReward()Parameter Constraint N/A N/A
stkauraBAL · withdraw
Redeem stkauraBAL tokens and receive auraBAL tokens in exchange.
-
Contract:
stkauraBAL -
Function:
withdraw(uint256,address,address)Parameter Constraint amount- receiverequal to AVATARownerequal to AVATAR
stkauraBAL · redeem
Redeem stkauraBAL tokens and receive auraBAL tokens in exchange (it is called when MAX underlying amount is withdrawn).
-
Contract:
stkauraBAL -
Function:
redeem(uint256,address,address)Parameter Constraint amount- receiverequal to AVATARownerequal to AVATAR
AuraBalVirtualBalanceRewardPool · getReward
Claim auraBAL compounding rewards.
-
Contract:
AuraBalVirtualBalanceRewardPool -
Function:
getReward()Parameter Constraint N/A N/A
Target: auraBAL
If the auraBAL token is given as an element of targets, the following functions will be allowed:
auraBAL · approve(spender: AuraBalBaseRewardPool)
Approve AuraBalBaseRewardPool to spend auraBAL tokens on behalf of avatar.
-
Contract:
auraBAL -
Function:
approve(address,uint256)Parameter Constraint spenderequal to AuraBalBaseRewardPoolamount-
AuraBalBaseRewardPool · stake
Stake auraBAL tokens and receive AuraBalBaseRewardPool tokens in exchange.
-
Contract:
auraBAL -
Function:
stake(uint256)Parameter Constraint amount-
auraBAL · approve(spender: stkauraBAL)
Approve stkauraBAL to spend auraBAL tokens on behalf of avatar.
-
Contract:
auraBAL -
Function:
approve(address,uint256)Parameter Constraint spenderequal to stkauraBALamount-
stkauraBAL · deposit
Deposit auraBAL tokens and receive stkauraBAL tokens in exchange.
-
Contract:
stkauraBAL -
Function:
deposit(uint256,address)Parameter Constraint amount- receiverequal to AVATAR
AuraBalBaseRewardPool · withdraw
Redeem AuraBalBaseRewardPool tokens and receive auraBAL tokens in exchange.
-
Contract:
AuraBalBaseRewardPool -
Function:
withdraw(uint256,bool)Parameter Constraint amount- claim-
AuraBalBaseRewardPool · getReward
Claim auraBAL staking rewards.
-
Contract:
AuraBalBaseRewardPool -
Function:
getReward()Parameter Constraint N/A N/A
stkauraBAL · withdraw
Redeem stkauraBAL tokens and receive auraBAL tokens in exchange.
-
Contract:
stkauraBAL -
Function:
withdraw(uint256,address,address)Parameter Constraint amount- receiverequal to AVATARownerequal to AVATAR
stkauraBAL · redeem
Redeem stkauraBAL tokens and receive auraBAL tokens in exchange (it is called when MAX underlying amount is withdrawn).
-
Contract:
stkauraBAL -
Function:
redeem(uint256,address,address)Parameter Constraint amount- receiverequal to AVATARownerequal to AVATAR
AuraBalVirtualBalanceRewardPool · getReward
Claim auraBAL compounding rewards.
-
Contract:
AuraBalVirtualBalanceRewardPool -
Function:
getReward()Parameter Constraint N/A N/A
Action: lock
Parameters:
N/A.
AURA · approve
Approve vlAURA to spend AURA tokens on behalf of the avatar.
-
Contract:
AURA -
Function:
approve(address,uint256)Parameter Constraint spenderequal to vlAURAamount-
vlAURA · lock
Lock AURA tokens and receive vlAURA tokens in exchange.
-
Contract:
vlAURA -
Function:
lock(address,unit256)Parameter Constraint accountequal to AVATARamount-
vlAURA · processExpiredLocks
Process expired AURA locks.
-
Contract:
vlAURA -
Function:
processExpiredLocks(bool)Parameter Constraint relock-
vlAURA · getReward
Claim AURA locking rewards.
-
Contract:
vlAURA -
Function:
getReward(address)Parameter Constraint accountequal to AVATAR