GasVault.sol

Details

vault for storing gas for each strategy. Nodes must still pay gas cost to call, but execution costs will come out of the gas account.

Methods

deposit(address)

Solidity

function deposit(address targetAddress) external payable

Details

deposit more eth to be used in jobs

Parameters

Name	Type	Description
targetAddress	address	undefined

ethBalances(address)

Solidity

function ethBalances(address) external view returns (uint256)

Parameters

Name	Type	Description
_0	address	undefined

Returns

Name	Type	Description
_0	uint256	undefined

initialize(address,address,address)

Solidity

function initialize(address _orchestrator, address _stratRegistry, address _vaultRegistry) external nonpayable

Parameters

Name	Type	Description
_orchestrator	address	undefined
_stratRegistry	address	undefined
_vaultRegistry	address	undefined

orchestrator()

Solidity

function orchestrator() external view returns (contract IOrchestrator)

Returns

Name	Type	Description
_0	contract IOrchestrator	undefined

owner()

Solidity

function owner() external view returns (address)

Details

Returns the address of the current owner.

Returns

Name	Type	Description
_0	address	undefined

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.

returnGas(address,uint256)

Solidity

function returnGas(address targetAddress, uint256 originalGas) external nonpayable

Details

should only ever be called by the orchestrator. Is onlyOrchestrator. This and setAsideGas are used to pull gas from the vault for strategy executions.

Parameters

Name	Type	Description
targetAddress	address	is address actions were performed on
originalGas	uint256	is gas passed in to the action execution order. Used to calculate gas used in the execution.

setAsideGas(address)

Solidity

function setAsideGas(address _targetAddress) external nonpayable returns (uint256)

Details

a function that calls setAsideGas MUST call returnGas! TODO: make this into a flashloan type thing? Have it simply call the orchestrator and then continue with the function?

Parameters

Name	Type	Description
_targetAddress	address	is address actions will be performed on, and address paying gas for those actions.

Returns

Name	Type	Description
_0	uint256	uint256 gasAvailable (representing amount of gas available per Method).

strategyRegistry()

Solidity

function strategyRegistry() external view returns (contract IStrategyRegistry)

Returns

Name	Type	Description
_0	contract IStrategyRegistry	undefined

transactionsRemaining(address,uint256)

Solidity

function transactionsRemaining(address targetAddress, uint256 gasCostEstimate) external view returns (uint256)

Parameters

Name	Type	Description
targetAddress	address	undefined
gasCostEstimate	uint256	represents best guess of gas cost going forwards

Returns

Name	Type	Description
_0	uint256	transactions remaining, assuming max gas is used in each Method

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

Name	Type	Description
newOwner	address	undefined

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

Name	Type	Description
newImplementation	address	undefined

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

Name	Type	Description
newImplementation	address	undefined
data	bytes	undefined

vaultRegistry()

Solidity

function vaultRegistry() external view returns (contract IVaultRegistry)

Returns

Name	Type	Description
_0	contract IVaultRegistry	undefined

withdraw(uint256)

Solidity

function withdraw(uint256 amount) external nonpayable

Details

withdraws eth from vault

Parameters

Name	Type	Description
amount	uint256	undefined

Events

AdminChanged

Solidity

event AdminChanged(address previousAdmin, address newAdmin)

Parameters

Name	Type	Description
previousAdmin	address	undefined
newAdmin	address	undefined

BeaconUpgraded

Solidity

event BeaconUpgraded(address indexed beacon)

Parameters

Name	Type	Description
beacon indexed	address	undefined

OwnershipTransferred

Solidity

event OwnershipTransferred(address indexed previousOwner, address indexed newOwner)

Parameters

Name	Type	Description
previousOwner indexed	address	undefined
newOwner indexed	address	undefined

Upgraded

Solidity

event Upgraded(address indexed implementation)

Parameters

Name	Type	Description
implementation indexed	address	undefined

deposited

Solidity

event deposited(address origin, address target, uint256 amount)

Parameters

Name	Type	Description
origin	address	undefined
target	address	undefined
amount	uint256	undefined

etherUsed

Solidity

event etherUsed(address account, uint256 amount)

Parameters

Name	Type	Description
account	address	undefined
amount	uint256	undefined

withdrawn

Solidity

event withdrawn(address account, uint256 amount)

Parameters

Name	Type	Description
account	address	undefined
amount	uint256	undefined