Solidity API

SpanningERC20Record

Implementation of the {ISpanningERC20} interface.

bytes32 token_

constructor(string name, string symbol, address delegate, bytes32 token) public

Creates the instance and assigns required values.

Name	Type	Description
name	string	- Desired name for the token
symbol	string	- Desired symbol for the token
delegate	address	- Legacy (local) address for the Spanning Delegate
token	bytes32	- Address for the state-storage of a token contract

function updateRecords() public virtual returns (bool)

_Pulls read-only information relevant to the domain ownership from the appropriate middleware node or domain

Note: This function should be called prior to reading any information through this domain, to ensure data is up to date_

Name	Type	Description
[0]	bool	bool - Indicates whether the operation succeeded

function _duringTokenMint(bytes32 senderAddress, bytes32 receiverAddress, uint256 amount) internal virtual

Function override that hooks into the mint lifecycle

Name	Type	Description
senderAddress	bytes32	- Unused
receiverAddress	bytes32	- Address to receive the minted tokens
amount	uint256	- Amount of token to mint

function _duringTokenBurn(bytes32 senderAddress, bytes32 receiverAddress, uint256 amount) internal virtual

Function override that hooks into the burn lifecycle

Name	Type	Description
senderAddress	bytes32	- Address that the token is burned from
receiverAddress	bytes32	- Unused
amount	uint256	- Amount of token to burn

function _duringTokenTransfer(bytes32 senderAddress, bytes32 receiverAddress, uint256 amount) internal virtual

Function override that hooks into the transfer lifecycle

Name	Type	Description
senderAddress	bytes32	- Address initiating the transfer
receiverAddress	bytes32	- Address to receive the transfer
amount	uint256	- Amount of token to transfer

function _duringTokenApprove(bytes32 senderAddress, bytes32 receiverAddress, uint256 amount) internal virtual

Function override that hooks into the approve lifecycle

Name	Type	Description
senderAddress	bytes32	- Address of the allowance sender
receiverAddress	bytes32	- Address of the allowance receiver
amount	uint256	- Amount of allowance to issue

function updateTokenAddress(bytes32 newTokenAddress) public

Update the contract's token Address.

Name	Type	Description
newTokenAddress	bytes32	- Desired address for the token contract

function getTokenAddress() public view returns (bytes32)

Name	Type	Description
[0]	bytes32	bytes32 - Address for the state-storage of a token contract