PChainStakeMirror#

function activate(
) external;

Activates PChainStakeMirror contract - enable mirroring.

Only governance can call this.

function balanceHistoryCleanup(
    address _owner,
    uint256 _count
) external returns (
    uint256);

Delete balance checkpoints that expired (i.e. are before cleanupBlockNumber). Method can only be called from the cleanerContract (which may be a proxy to external cleaners).

function balanceOf(
    address _owner
) public view returns (
    uint256);

Queries the token balance of _owner at current block.

function balanceOfAt(
    address _owner,
    uint256 _blockNumber
) public view returns (
    uint256);

Queries the token balance of _owner at a specific _blockNumber.

function batchVotePowerOfAt(
    bytes20[] _owners,
    uint256 _blockNumber
) external view returns (
    uint256[] _votePowers);

Return vote powers for several node ids in a batch.

function cancelGovernanceCall(
    bytes4 _selector
) external;

Cancel a timelocked governance call before it has been executed.

Only governance can call this method.

function cleanupBlockNumber(
) external view returns (
    uint256);

Get the current cleanup block number set with setCleanupBlockNumber.

constructor(
    address _governance,
    contract FlareDaemon _flareDaemon,
    address _addressUpdater,
    uint256 _maxUpdatesPerBlock
) public;

Initializes the contract with default parameters

function daemonize(
) external returns (
    bool);

Implement this function to receive a trigger from the FlareDaemon. The trigger method is called by the validator right at the end of block state transition.

Only flare daemon can call this. Reduce balances and vote powers for stakes that just ended.

function deactivate(
) external;

Deactivates PChainStakeMirror contract - disable mirroring.

Only governance can call this.

function executeGovernanceCall(
    bytes4 _selector
) external;

Execute the timelocked governance calls once the timelock period expires.

Only executor can call this method.

function getAddressUpdater(
) public view returns (
    address _addressUpdater);

Returns the configured address updater.

function getContractName(
) external pure returns (
    string);

Implement this function to allow updating daemonized contracts through the AddressUpdater.

function getTransactionHashList(
    uint256 _endTime
) external view returns (
    bytes32[]);

Returns the list of transaction hashes of stakes that end at given _endTime.

function governance(
) public view returns (
    address);

Returns the current effective governance address.

function isActiveStakeMirrored(
    bytes32 _txId,
    bytes20 _inputAddress
) external view returns (
    bool);

Method for checking if active stake (stake start time <= block.timestamp < stake end time) was already mirrored.

function mirrorStake(
    struct IPChainStakeMirrorVerifier.PChainStake _stakeData,
    bytes32[] _merkleProof
) external;

Method for P-chain stake mirroring using PChainStake data and Merkle proof.

function revokeStake(
    bytes32 _txId,
    bytes20 _inputAddress,
    uint256 _endTime,
    uint256 _endTimeTxHashIndex
) external;

Revokes stake in case of invalid stakes - voting should be reset first, so that Merkle root is not valid and it cannot be used for mirroring again.

Only governance can call this.

function setCleanerContract(
    address _cleanerContract
) external;

Set the contract that is allowed to call history cleaning methods.

Only governance can call this.

function setCleanupBlockNumber(
    uint256 _blockNumber
) external;

Set the cleanup block number. Historic data for the blocks before cleanupBlockNumber can be erased. History before that block should never be used since it can be inconsistent. In particular, cleanup block number must be lower than the current vote power block.

The method can be called only by cleanupBlockNumberManager.

function setMaxUpdatesPerBlock(
    uint256 _maxUpdatesPerBlock
) external;

Sets max number of updates (stake ends) per block (a daemonize call).

Only governance can call this.

function stakesHistoryCleanup(
    address _owner,
    uint256 _count
) external returns (
    uint256);

Delete stakes checkpoints that expired (i.e. are before cleanupBlockNumber). Method can only be called from the cleanerContract (which may be a proxy to external cleaners).

function stakesOf(
    address _owner
) external view returns (
    bytes20[] _nodeIds,
    uint256[] _amounts);

Get the amounts and node ids being staked to by a vote power owner.

function stakesOfAt(
    address _owner,
    uint256 _blockNumber
) external view returns (
    bytes20[] _nodeIds,
    uint256[] _amounts);

Get the amounts and node ids being staked to by a vote power owner, at a given block.

function switchToFallbackMode(
) external returns (
    bool);

This function will be called after an error is caught in daemonize. It will switch the contract to a simpler fallback mode, which hopefully works when full mode doesn't. Not every contract needs to support fallback mode (FtsoManager does), so this method may be empty. Switching back to normal mode is left to the contract (typically a governed method call). This function may be called due to low-gas error, so it shouldn't use more than ~30.000 gas.

Only flare daemon can call this.

function switchToProductionMode(
) external;

Enter the production mode after all the initial governance settings have been set. This enables timelocks and the governance can be obtained afterward by calling governanceSettings.getGovernanceAddress(). Emits GovernedProductionModeEntered.

function totalSupply(
) public view returns (
    uint256);

Total amount of tokens at current block.

function totalSupplyAt(
    uint256 _blockNumber
) public view returns (
    uint256);

Total amount of tokens at a specific _blockNumber.

function totalSupplyCacheCleanup(
    uint256 _blockNumber
) external returns (
    uint256);

Delete total supply cache entry that expired (i.e. is before cleanupBlockNumber). Method can only be called from the cleanerContract (which may be a proxy to external cleaners).

function totalSupplyHistoryCleanup(
    uint256 _count
) external returns (
    uint256);

Delete total supply checkpoints that expired (i.e. are before cleanupBlockNumber). Method can only be called from the cleanerContract (which may be a proxy to external cleaners).

function totalVotePower(
) external view returns (
    uint256);

Get the current total vote power.

function totalVotePowerAt(
    uint256 _blockNumber
) external view returns (
    uint256);

Get the total vote power at block _blockNumber

function totalVotePowerAtCached(
    uint256 _blockNumber
) external returns (
    uint256);

Get the total vote power at block _blockNumber using cache. It tries to read the cached value and if not found, reads the actual value and stores it in cache. Can only be used if _blockNumber is in the past, otherwise reverts.

function updateContractAddresses(
    bytes32[] _contractNameHashes,
    address[] _contractAddresses
) external;

External method called from AddressUpdater only.

function votePowerCacheCleanup(
    bytes20 _nodeId,
    uint256 _blockNumber
) external returns (
    uint256);

Delete vote power cache entry that expired (i.e. is before cleanupBlockNumber). Method can only be called from the cleanerContract (which may be a proxy to external cleaners).

function votePowerFromTo(
    address _owner,
    bytes20 _nodeId
) external view returns (
    uint256 _votePower);

Get current staked vote power from _owner staked to _nodeId.

function votePowerFromToAt(
    address _owner,
    bytes20 _nodeId,
    uint256 _blockNumber
) external view returns (
    uint256 _votePower);

Get current staked vote power from _owner staked to _nodeId at _blockNumber.

function votePowerHistoryCleanup(
    bytes20 _nodeId,
    uint256 _count
) external returns (
    uint256);

Delete vote power checkpoints that expired (i.e. are before cleanupBlockNumber). Method can only be called from the cleanerContract (which may be a proxy to external cleaners).

function votePowerOf(
    bytes20 _nodeId
) external view returns (
    uint256);

Get the current vote power of _nodeId.

function votePowerOfAt(
    bytes20 _nodeId,
    uint256 _blockNumber
) external view returns (
    uint256);

Get the vote power of _nodeId at block _blockNumber

function votePowerOfAtCached(
    bytes20 _nodeId,
    uint256 _blockNumber
) external returns (
    uint256);

Get the vote power of _owner at block _blockNumber using cache. It tries to read the cached value and if not found, reads the actual value and stores it in cache. Can only be used if _blockNumber is in the past, otherwise reverts.

modifier notBeforeCleanupBlock(    uint256 _blockNumber)

This method cannot be called for _blockNumber lower than the current cleanup block number.

modifier onlyAddressUpdater()

Only the AdressUpdater contract can call this method. Its address is set at construction time but it can also update itself.

modifier onlyCleaner()

Only the cleanerContract can call this method.

modifier onlyFlareDaemon()

Only the flareDaemon can call this method.

modifier whenActive()

This method can only be called when the PChainStakeMirror is active.

    bool active

Indicates if stakes can be mirrored.

    contract IAddressBinder addressBinder

The contract used for converting P-chain address to C-chain address - both derived from the same public key.

    address cleanerContract

Address of the contract that is allowed to call methods for history cleaning.

    address cleanupBlockNumberManager

The contract that is allowed to set cleanupBlockNumber. Usually this will be an instance of CleanupBlockNumberManager.

    mapping(uint256 => bytes32[]) endTimeToTransactionHashList

Mapping from stake end time to the list of tx hashes - keccak256(abi.encode(txId, inputAddress))

    contract FlareDaemon flareDaemon

The FlareDaemon contract, set at construction time.

    contract IGovernanceSettings governanceSettings

Governance Settings.

    contract IIGovernanceVotePower governanceVotePower

The contract to use for governance vote power and delegation. Here only to properly update governance VP at stake start/end, all actual operations go directly to governance VP contract.

    uint256 maxUpdatesPerBlock

Max number of stake ends that Flare daemon updates per block.

    uint256 nextTimestampToTrigger

Indicates timestamp of stake ends that Flare daemon will trigger next.

    bool productionMode

When true, governance is enabled and cannot be disabled. See switchToProductionMode.

    mapping(bytes4 => struct GovernedBase.TimelockedCall) timelockedCalls

List of pending timelocked governance calls.

    mapping(bytes32 => struct PChainStakeMirror.PChainStakingData) transactionHashToPChainStakingData

Return staking data for given tx hash - keccak256(abi.encode(txId, inputAddress))

    contract IIPChainStakeMirrorVerifier verifier

The contract used for P-chain stake verifications.