Skip to main content

SteerPeriphery.sol

Details

You can use this contract to enumerate strategy and vault details but also create, join, and leave vaultsThis contract is not intended to hold any tokens in between two or more transactions, it only hold tokens transiently within a single transaction and transfers the tokens in the same transaction.This function should be used when doing protocol integrations

Methods

algebraVaultDetailsByAddress(address)

Solidity

function algebraVaultDetailsByAddress(address vault) external view returns (struct IMultiPositionManager.AlgebraVaultDetails details)

Parameters

NameTypeDescription
vaultaddressundefined

Returns

NameTypeDescription
detailsIMultiPositionManager.AlgebraVaultDetailsundefined

createVaultAndDepositGas(tuple)

Solidity

function createVaultAndDepositGas(ISteerPeriphery.CVDGParams cvdgParams) external payable returns (address newVault)

Parameters

NameTypeDescription
cvdgParamsISteerPeriphery.CVDGParamsundefined

Returns

NameTypeDescription
newVaultaddressundefined

createVaultAndStrategy(tuple)

Solidity

function createVaultAndStrategy(ISteerPeriphery.CVSParams cvsParams) external payable returns (uint256 tokenId, address newVault)

Parameters

NameTypeDescription
cvsParamsISteerPeriphery.CVSParamsundefined

Returns

NameTypeDescription
tokenIduint256undefined
newVaultaddressundefined

createVaultStrategyAndRegisterJob(tuple)

Solidity

function createVaultStrategyAndRegisterJob(ISteerPeriphery.CVSRJParams cvsrjParams) external payable returns (uint256 tokenId, address newVault)

Parameters

NameTypeDescription
cvsrjParamsISteerPeriphery.CVSRJParamsundefined

Returns

NameTypeDescription
tokenIduint256undefined
newVaultaddressundefined

deposit(address,uint256,uint256,uint256,uint256,address)

Solidity

function deposit(address vaultAddress, uint256 amount0Desired, uint256 amount1Desired, uint256 amount0Min, uint256 amount1Min, address to) external nonpayable
Details

Deposits tokens in proportion to the vault's current holdings.These tokens sit in the vault and are not used for liquidity on Uniswap until the next rebalance.

Parameters

NameTypeDescription
vaultAddressaddressThe address of the vault to deposit to
amount0Desireduint256Max amount of token0 to deposit
amount1Desireduint256Max amount of token1 to deposit
amount0Minuint256Revert if resulting amount0 is less than this
amount1Minuint256Revert if resulting amount1 is less than this
toaddressRecipient of shares

depositAndStake(address,uint256,uint256,uint256,uint256,uint256)

Solidity

function depositAndStake(address vaultAddress, uint256 amount0Desired, uint256 amount1Desired, uint256 amount0Min, uint256 amount1Min, uint256 poolId) external nonpayable
Details

Deposits tokens in proportion to the vault's current holdings and stake the share.These tokens sit in the vault and are not used for liquidity on Uniswap until the next rebalance.

Parameters

NameTypeDescription
vaultAddressaddressThe address of the vault to deposit to
amount0Desireduint256Max amount of token0 to deposit
amount1Desireduint256Max amount of token1 to deposit
amount0Minuint256Revert if resulting amount0 is less than this
amount1Minuint256Revert if resulting amount1 is less than this
poolIduint256The id of the pool in which the share should be staked

initialize(address,address,address,address,string)

Solidity

function initialize(address _strategyRegistry, address _vaultRegistry, address _gasVault, address _stakingRewards, string _nodeConfig) external nonpayable

Parameters

NameTypeDescription
_strategyRegistryaddressundefined
_vaultRegistryaddressundefined
_gasVaultaddressundefined
_stakingRewardsaddressundefined
_nodeConfigstringundefined

nodeConfig()

The IPFS reference of the node configuration.

Solidity

function nodeConfig() external view returns (string)

Returns

NameTypeDescription
_0stringundefined

owner()

Solidity

function owner() external view returns (address)
Details

Returns the address of the current owner.

Returns

NameTypeDescription
_0addressundefined

renounceOwnership()

Solidity

function renounceOwnership() external nonpayable
Details

Leaves the contract without owner. It will not be possible to call onlyOwner functions anymore. Can only be called by the current owner. NOTE: Renouncing ownership will leave the contract without an owner, thereby removing any functionality that is only available to the owner.

setNodeConfig(string)

Solidity

function setNodeConfig(string _nodeConfig) external nonpayable
Details

Only for ownerSets the config for node

Parameters

NameTypeDescription
_nodeConfigstringundefined

strategiesByCreator(address)

Solidity

function strategiesByCreator(address creator) external view returns (struct IStrategyRegistry.RegisteredStrategy[])
Details

Get the strategies by creator

Parameters

NameTypeDescription
creatoraddressThe creator of the strategies

Returns

NameTypeDescription
_0IStrategyRegistry.RegisteredStrategy[]The List of strategies created by the creator

transferOwnership(address)

Solidity

function transferOwnership(address newOwner) external nonpayable
Details

Transfers ownership of the contract to a new account (newOwner). Can only be called by the current owner.

Parameters

NameTypeDescription
newOwneraddressundefined

upgradeTo(address)

Solidity

function upgradeTo(address newImplementation) external nonpayable
Details

Upgrade the implementation of the proxy to newImplementation. Calls {_authorizeUpgrade}. Emits an {Upgraded} event.

Parameters

NameTypeDescription
newImplementationaddressundefined

upgradeToAndCall(address,bytes)

Solidity

function upgradeToAndCall(address newImplementation, bytes data) external payable
Details

Upgrade the implementation of the proxy to newImplementation, and subsequently execute the function call encoded in data. Calls {_authorizeUpgrade}. Emits an {Upgraded} event.

Parameters

NameTypeDescription
newImplementationaddressundefined
databytesundefined

vaultBalancesByAddressWithFees(address)

Solidity

function vaultBalancesByAddressWithFees(address vault) external nonpayable returns (struct IMultiPositionManager.VaultBalance balances)

Parameters

NameTypeDescription
vaultaddressundefined

Returns

NameTypeDescription
balancesIMultiPositionManager.VaultBalanceundefined

vaultDetailsByAddress(address)

Solidity

function vaultDetailsByAddress(address vault) external view returns (struct IMultiPositionManager.VaultDetails details)

Parameters

NameTypeDescription
vaultaddressundefined

Returns

NameTypeDescription
detailsIMultiPositionManager.VaultDetailsundefined

vaultsByStrategy(uint256)

Solidity

function vaultsByStrategy(uint256 strategyId) external view returns (struct IVaultRegistry.VaultData[])
Details

Get the vaults using a given strategy

Parameters

NameTypeDescription
strategyIduint256The strategyId (ERC-721 tokenId)

Returns

NameTypeDescription
_0IVaultRegistry.VaultData[]The List of vault details using the strategy

Events

AdminChanged

Solidity

event AdminChanged(address previousAdmin, address newAdmin)

Parameters

NameTypeDescription
previousAdminaddressundefined
newAdminaddressundefined

BeaconUpgraded

Solidity

event BeaconUpgraded(address indexed beacon)

Parameters

NameTypeDescription
beacon indexedaddressundefined

OwnershipTransferred

Solidity

event OwnershipTransferred(address indexed previousOwner, address indexed newOwner)

Parameters

NameTypeDescription
previousOwner indexedaddressundefined
newOwner indexedaddressundefined

Upgraded

Solidity

event Upgraded(address indexed implementation)

Parameters

NameTypeDescription
implementation indexedaddressundefined