vBase

ERC20 token traded on the CryptoSwap pool

Methods

DEFAULT_ADMIN_ROLE

function DEFAULT_ADMIN_ROLE() external view returns (bytes32)

Returns

Name	Type	Description
_0	bytes32	undefined

EMERGENCY_ADMIN

function EMERGENCY_ADMIN() external view returns (bytes32)

Returns

Name	Type	Description
_0	bytes32	undefined

GOVERNANCE

function GOVERNANCE() external view returns (bytes32)

Returns

Name	Type	Description
_0	bytes32	undefined

aggregator

function aggregator() external view returns (contract AggregatorV3Interface)

Returns

Name	Type	Description
_0	contract AggregatorV3Interface	undefined

allowance

function allowance(address, address) external view returns (uint256)

Parameters

Name	Type	Description
_0	address	undefined
_1	address	undefined

Returns

Name	Type	Description
_0	uint256	undefined

approve

function approve(address spender, uint256 amount) external nonpayable returns (bool)

Sets amount as the allowance of spender over the caller's tokens. Returns a boolean value indicating whether the operation succeeded. IMPORTANT: Beware that changing an allowance with this method brings the risk that someone may use both the old and the new allowance by unfortunate transaction ordering. One possible solution to mitigate this race condition is to first reduce the spender's allowance to 0 and set the desired value afterwards: https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729 Emits an {Approval} event.

Parameters

Name	Type	Description
spender	address	undefined
amount	uint256	undefined

Returns

Name	Type	Description
_0	bool	undefined

balanceOf

function balanceOf(address) external view returns (uint256)

Parameters

Name	Type	Description
_0	address	undefined

Returns

Name	Type	Description
_0	uint256	undefined

burn

function burn(uint256 amount) external nonpayable

Parameters

Name	Type	Description
amount	uint256	undefined

decimals

function decimals() external view returns (uint8)

Returns

Name	Type	Description
_0	uint8	undefined

getIndexPrice

function getIndexPrice() external view returns (int256)

Returns

Name	Type	Description
_0	int256	undefined

getRoleAdmin

function getRoleAdmin(bytes32 role) external view returns (bytes32)

Returns the admin role that controls role. See {grantRole} and {revokeRole}. To change a role's admin, use {_setRoleAdmin}.

Parameters

Name	Type	Description
role	bytes32	undefined

Returns

Name	Type	Description
_0	bytes32	undefined

gracePeriod

function gracePeriod() external view returns (uint256)

Returns

Name	Type	Description
_0	uint256	undefined

grantRole

function grantRole(bytes32 role, address account) external nonpayable

Grants role to account. If account had not been already granted role, emits a {RoleGranted} event. Requirements: - the caller must have role's admin role. May emit a {RoleGranted} event.

Parameters

Name	Type	Description
role	bytes32	undefined
account	address	undefined

hasRole

function hasRole(bytes32 role, address account) external view returns (bool)

Returns true if account has been granted role.

Parameters

Name	Type	Description
role	bytes32	undefined
account	address	undefined

Returns

Name	Type	Description
_0	bool	undefined

heartBeat

function heartBeat() external view returns (uint256)

Returns

Name	Type	Description
_0	uint256	undefined

isEmergencyAdmin

function isEmergencyAdmin(address account) external view returns (bool)

Parameters

Name	Type	Description
account	address	undefined

Returns

Name	Type	Description
_0	bool	undefined

isGovernor

function isGovernor(address account) external view returns (bool)

Parameters

Name	Type	Description
account	address	undefined

Returns

Name	Type	Description
_0	bool	undefined

mint

function mint(uint256 amount) external nonpayable

Parameters

Name	Type	Description
amount	uint256	undefined

name

function name() external view returns (string)

Returns

Name	Type	Description
_0	string	undefined

perp

function perp() external view returns (address)

Returns

Name	Type	Description
_0	address	undefined

renounceRole

function renounceRole(bytes32 role, address account) external nonpayable

Revokes role from the calling account. Roles are often managed via {grantRole} and {revokeRole}: this function's purpose is to provide a mechanism for accounts to lose their privileges if they are compromised (such as when a trusted device is misplaced). If the calling account had been revoked role, emits a {RoleRevoked} event. Requirements: - the caller must be account. May emit a {RoleRevoked} event.

Parameters

Name	Type	Description
role	bytes32	undefined
account	address	undefined

revokeRole

function revokeRole(bytes32 role, address account) external nonpayable

Revokes role from account. If account had been granted role, emits a {RoleRevoked} event. Requirements: - the caller must have role's admin role. May emit a {RoleRevoked} event.

Parameters

Name	Type	Description
role	bytes32	undefined
account	address	undefined

sequencerUptimeFeed

function sequencerUptimeFeed() external view returns (contract AggregatorV3Interface)

Returns

Name	Type	Description
_0	contract AggregatorV3Interface	undefined

setGracePeriod

function setGracePeriod(uint256 newGracePeriod) external nonpayable

Parameters

Name	Type	Description
newGracePeriod	uint256	undefined

setHeartBeat

function setHeartBeat(uint256 newHeartBeat) external nonpayable

Parameters

Name	Type	Description
newHeartBeat	uint256	undefined

setSequencerUptimeFeed

function setSequencerUptimeFeed(contract AggregatorV3Interface newSequencerUptimeFeed) external nonpayable

Parameters

Name	Type	Description
newSequencerUptimeFeed	contract AggregatorV3Interface	undefined

supportsInterface

function supportsInterface(bytes4 interfaceId) external view returns (bool)

See {IERC165-supportsInterface}.

Parameters

Name	Type	Description
interfaceId	bytes4	undefined

Returns

Name	Type	Description
_0	bool	undefined

symbol

function symbol() external view returns (string)

Returns

Name	Type	Description
_0	string	undefined

totalSupply

function totalSupply() external view returns (uint256)

Returns

Name	Type	Description
_0	uint256	undefined

transfer

function transfer(address to, uint256 amount) external nonpayable returns (bool)

Moves amount tokens from the caller's account to to. Returns a boolean value indicating whether the operation succeeded. Emits a {Transfer} event.

Parameters

Name	Type	Description
to	address	undefined
amount	uint256	undefined

Returns

Name	Type	Description
_0	bool	undefined

transferFrom

function transferFrom(address from, address to, uint256 amount) external nonpayable returns (bool)

Moves amount tokens from from to to using the allowance mechanism. amount is then deducted from the caller's allowance. Returns a boolean value indicating whether the operation succeeded. Emits a {Transfer} event.

Parameters

Name	Type	Description
from	address	undefined
to	address	undefined
amount	uint256	undefined

Returns

Name	Type	Description
_0	bool	undefined

transferPerpOwner

function transferPerpOwner(address recipient) external nonpayable

Transfer perp accountCan only be used at deployment as Perpetual can't transfer ownership afterwards

Parameters

Name	Type	Description
recipient	address	Account granted perp access control

Events

Approval

event Approval(address indexed owner, address indexed spender, uint256 value)

Parameters

Name	Type	Description
owner indexed	address	undefined
spender indexed	address	undefined
value	uint256	undefined

GracePeriodUpdated

event GracePeriodUpdated(uint256 newGracePeriod)

Emitted when grace period is updated

Parameters

Name	Type	Description
newGracePeriod	uint256	undefined

HeartBeatUpdated

event HeartBeatUpdated(uint256 newHeartBeat)

Emitted when oracle heart beat is updated

Parameters

Name	Type	Description
newHeartBeat	uint256	undefined

PerpOwnerTransferred

event PerpOwnerTransferred(address indexed sender, address indexed recipient)

Parameters

Name	Type	Description
sender indexed	address	undefined
recipient indexed	address	undefined

RoleAdminChanged

event RoleAdminChanged(bytes32 indexed role, bytes32 indexed previousAdminRole, bytes32 indexed newAdminRole)

Parameters

Name	Type	Description
role indexed	bytes32	undefined
previousAdminRole indexed	bytes32	undefined
newAdminRole indexed	bytes32	undefined

RoleGranted

event RoleGranted(bytes32 indexed role, address indexed account, address indexed sender)

Parameters

Name	Type	Description
role indexed	bytes32	undefined
account indexed	address	undefined
sender indexed	address	undefined

RoleRevoked

event RoleRevoked(bytes32 indexed role, address indexed account, address indexed sender)

Parameters

Name	Type	Description
role indexed	bytes32	undefined
account indexed	address	undefined
sender indexed	address	undefined

SequencerUptimeFeedUpdated

event SequencerUptimeFeedUpdated(contract AggregatorV3Interface newSequencerUptimeFeed)

Emitted when sequencer uptime feed is updated

Parameters

Name	Type	Description
newSequencerUptimeFeed	contract AggregatorV3Interface	undefined

Transfer

event Transfer(address indexed from, address indexed to, uint256 value)

Parameters

Name	Type	Description
from indexed	address	undefined
to indexed	address	undefined
value	uint256	undefined

Errors

PerpOwnable_NotOwner

error PerpOwnable_NotOwner()

Emitted when the sender is not perp

PerpOwnable_TransferZeroAddress

error PerpOwnable_TransferZeroAddress()

Emitted when the proposed address is equal to the zero address

VBase_DataNotFresh

error VBase_DataNotFresh()

Emitted when the latest round's data is older than the oracle's max refresh time

VBase_GracePeriodNotOver

error VBase_GracePeriodNotOver()

Emitted when Zksync sequencer hasn't been back up for long enough

VBase_IncorrectGracePeriod

error VBase_IncorrectGracePeriod()

Emitted when proposed grace period is outside of the bounds

VBase_IncorrectHeartBeat

error VBase_IncorrectHeartBeat()

Emitted when the proposed heart beat is less than 1 sec second

VBase_InsufficientPrecision

error VBase_InsufficientPrecision()

Emitted when the proposed aggregators decimals are less than PRECISION

VBase_InvalidRoundPrice

error VBase_InvalidRoundPrice()

Emitted when the latest round's price is invalid

VBase_InvalidRoundTimestamp

error VBase_InvalidRoundTimestamp()

Emitted when the latest round is incomplete

VBase_SequencerDown

error VBase_SequencerDown()

Emitted when Zksync sequencer is down

VBase_SequencerUptimeFeedZeroAddress

error VBase_SequencerUptimeFeedZeroAddress()

Emitted when proposed sequencer uptime feed address is equal to the zero address