All pages
Powered by GitBook
1 of 7

XVS Bridge

Loading...

Loading...

XVSProxyOFTDest

XVSProxyOFTDest

XVSProxyOFTDest contract builds upon the functionality of its parent contract, BaseXVSProxyOFT, and focuses on managing token transfers to the destination chain. It provides functions to check eligibility and perform the actual token transfers while maintaining strict access controls and pausing mechanisms.

Solidity API

dropFailedMessage

Clear failed messages from the storage.

Parameters

📅 Events

  • Emits DropFailedMessage on clearance of failed message.

⛔️ Access Requirements

  • Only owner

circulatingSupply

Returns the total circulating supply of the token on the destination chain i.e (total supply).

Return Values

XVSBridgeAdmin

XVSBridgeAdmin

The XVSBridgeAdmin contract extends a parent contract AccessControlledV8 for access control, and it manages an external contract called XVSProxyOFT. It maintains a registry of function signatures and names, allowing for dynamic function handling i.e checking of access control of interaction with only owner functions.

Solidity API

functionRegistry

A mapping keeps track of function signature associated with function name string.

mapping(bytes4 => string) functionRegistry

fallback

Invoked when called function does not exist in the contract.

fallback(bytes data) external returns (bytes)

Return Values

Name
Type
Description

[0]

bytes

Response of low level call.

⛔️ Access Requirements

  • Controlled by AccessControlManager.

setTrustedRemoteAddress

Sets trusted remote on particular chain.

function setTrustedRemoteAddress(uint16 remoteChainId_, bytes remoteAddress_) external

Parameters

Name
Type
Description

remoteChainId_

uint16

Chain Id of the destination chain.

remoteAddress_

bytes

Address of the destination bridge.

⛔️ Access Requirements

  • Controlled by AccessControlManager.

❌ Errors

  • ZeroAddressNotAllowed is thrown when remoteAddress_ contract address is zero.

upsertSignature

A setter for the registry of functions that are allowed to be executed from proposals.

function upsertSignature(string[] signatures_, bool[] active_) external

Parameters

Name
Type
Description

signatures_

string[]

Function signature to be added or removed.

active_

bool[]

bool value, should be true to add function.

📅 Events

  • Emits FunctionRegistryChanged if bool value of function changes.

⛔️ Access Requirements

  • Only owner.

transferBridgeOwnership

This function transfers the ownership of the bridge from this contract to new owner.

function transferBridgeOwnership(address newOwner_) external

Parameters

Name
Type
Description

newOwner_

address

New owner of the XVS Bridge.

⛔️ Access Requirements

  • Controlled by AccessControlManager.

isTrustedRemote

Returns true if remote address is trustedRemote corresponds to chainId_.

function isTrustedRemote(uint16 remoteChainId_, bytes remoteAddress_) external returns (bool)

Parameters

Name
Type
Description

remoteChainId_

uint16

Chain Id of the destination chain.

remoteAddress_

bytes

Address of the destination bridge.

Return Values

Name
Type
Description

[0]

bool

Bool indicating whether the remote chain is trusted or not.

❌ Errors

  • ZeroAddressNotAllowed is thrown when remoteAddress_ contract address is zero.

renounceOwnership

Empty implementation of renounce ownership to avoid any mishappening.

function renounceOwnership() public

XVS

XVS

XVS contract serves as a customized ERC-20 token with additional minting and burning functionality. It also incorporates access control features provided by the "TokenController" contract to ensure proper governance and restrictions on minting and burning operations.

Solidity API

mint

Creates amount_ tokens and assigns them to account_, increasing the total supply. Checks access and eligibility.

function mint(address account_, uint256 amount_) external

Parameters

Name
Type
Description

account_

address

Address to which tokens are assigned.

amount_

uint256

Amount of tokens to be assigned.

📅 Events

  • Emits MintLimitDecreased with new available limit.

⛔️ Access Requirements

  • Controlled by AccessControlManager.

❌ Errors

  • MintLimitExceed is thrown when minting amount exceeds the maximum cap.

burn

Destroys amount_ tokens from account_, reducing the total supply. Checks access and eligibility.

function burn(address account_, uint256 amount_) external

Parameters

Name
Type
Description

account_

address

Address from which tokens be destroyed.

amount_

uint256

Amount of tokens to be destroyed.

📅 Events

  • Emits MintLimitIncreased with new available limit.

⛔️ Access Requirements

  • Controlled by AccessControlManager.

Loading...