SynthetixDebtShare

Description

Source: contracts/SynthetixDebtShare.sol

Structs

PeriodBalance

_Source

Field	Type	Description
amount	uint128	TBA
periodId	uint128	TBA

Variables

CONTRACT_NAME

_Source

Type: bytes32

authorizedBrokers

_Source

Type: mapping(address => bool)

authorizedToSnapshot

_Source

Type: mapping(address => bool)

balances

_Source

Type: mapping(address => struct SynthetixDebtShare.PeriodBalance[])

currentPeriodId

_Source

Type: uint128

decimals

_Source

Type: uint8

isInitialized

_Source

Type: bool

name

_Source

Type: string

symbol

_Source

Type: string

totalSupplyOnPeriod

_Source

Type: mapping(uint256 => uint256)

Constructor

constructor

_Source

Details

Signature

constructor(address _owner, address _resolver)

Visibility

public

State Mutability

``

Views

allowance

_Source

Details

Signature

allowance(address, address spender) view returns (uint256)

Visibility

public

State Mutability

view

approve

_Source

Details

Signature

approve(address, uint256) pure returns (bool)

Visibility

external

State Mutability

pure

balanceOf

_Source

Details

Signature

balanceOf(address account) view returns (uint256)

Visibility

public

State Mutability

view

balanceOfOnPeriod

_Source

Details

Signature

balanceOfOnPeriod(address account, uint256 periodId) view returns (uint256)

Visibility

public

State Mutability

view

Requires

• require(..., "SynthetixDebtShare: not found in recent history")

resolverAddressesRequired

_Source

Details

Signature

resolverAddressesRequired() view returns (bytes32[] addresses)

Visibility

public

State Mutability

view

sharePercent

_Source

Details

Signature

sharePercent(address account) view returns (uint256)

Visibility

external

State Mutability

view

sharePercentOnPeriod

_Source

Details

Signature

sharePercentOnPeriod(address account, uint256 periodId) view returns (uint256)

Visibility

public

State Mutability

view

totalSupply

_Source

Details

Signature

totalSupply() view returns (uint256)

Visibility

public

State Mutability

view

transfer

_Source

Details

Signature

transfer(address, uint256) pure returns (bool)

Visibility

external

State Mutability

pure

Restricted Functions

addAuthorizedBroker

_Source

Details

Signature

addAuthorizedBroker(address target)

Visibility

external

State Mutability

``

Modifiers

• onlyOwner

Emits

• ChangeAuthorizedBroker

addAuthorizedToSnapshot

_Source

Details

Signature

addAuthorizedToSnapshot(address target)

Visibility

external

State Mutability

``

Modifiers

• onlyOwner

Emits

• ChangeAuthorizedToSnapshot

burnShare

_Source

Details

Signature

burnShare(address account, uint256 amount)

Visibility

external

State Mutability

``

Requires

• require(..., "ERC20: burn from zero address")

Modifiers

• onlyIssuer

Emits

• Transfer

• Burn

finishSetup

_Source

Details

Signature

finishSetup()

Visibility

external

State Mutability

``

Modifiers

• onlyOwner

importAddresses

_Source

Details

Signature

importAddresses(address[] accounts, uint256[] amounts)

Visibility

external

State Mutability

``

Modifiers

• onlyOwner

• onlySetup

mintShare

_Source

Details

Signature

mintShare(address account, uint256 amount)

Visibility

external

State Mutability

``

Requires

• require(..., "ERC20: mint to the zero address")

Modifiers

• onlyIssuer

Emits

• Transfer

• Mint

removeAuthorizedBroker

_Source

Details

Signature

removeAuthorizedBroker(address target)

Visibility

external

State Mutability

``

Modifiers

• onlyOwner

Emits

• ChangeAuthorizedBroker

removeAuthorizedToSnapshot

_Source

Details

Signature

removeAuthorizedToSnapshot(address target)

Visibility

external

State Mutability

``

Modifiers

• onlyOwner

Emits

• ChangeAuthorizedToSnapshot

takeSnapshot

_Source

Details

Signature

takeSnapshot(uint128 id)

Visibility

external

State Mutability

``

Requires

• require(..., "period id must always increase")

Modifiers

• onlyAuthorizedToSnapshot

transferFrom

_Source

Details

Signature

transferFrom(address from, address to, uint256 amount) returns (bool)

Visibility

external

State Mutability

``

Requires

• require(..., "ERC20: send to the zero address")

Modifiers

• onlyAuthorizedBrokers

Emits

• Transfer

Internal Functions

_deductBalance

_Source

Details

Signature

_deductBalance(address account, uint256 amount)

Visibility

internal

State Mutability

``

Requires

• require(..., "SynthetixDebtShare: account has no share to deduct")

_increaseBalance

_Source

Details

Signature

_increaseBalance(address account, uint256 amount)

Visibility

internal

State Mutability

``

Modifiers

onlyAuthorizedBrokers

_Source

onlyAuthorizedToSnapshot

_Source

onlyIssuer

_Source

onlySetup

_Source

Events

Burn

_Source

Signature: Burn(address account, uint256 amount)

ChangeAuthorizedBroker

_Source

Signature: ChangeAuthorizedBroker(address authorizedBroker, bool authorized)

ChangeAuthorizedToSnapshot

_Source

Signature: ChangeAuthorizedToSnapshot(address authorizedToSnapshot, bool authorized)

Mint

_Source

Signature: Mint(address account, uint256 amount)

Transfer

_Source

Signature: Transfer(address from, address to, uint256 value)