IAnchorFactory

Variables

AnchorInfo

struct AnchorInfo {
    uint8 version;
    address anchor;
    address committee;
    address deployer;
};

Stores the descriptive information of an anchor. It can be fetched via fetchInfo.

Params

Name	Type	Description
version	uint8	The version of the anchor contract
anchor	address	The address of the anchor
committee	address	The committee of the anchor
deployer	address	The initial deployer of the anchor

Events

AnchorDeployed

event AnchorDeployed(
    address indexed deployer,
    uint32 anchorId,
    address anchor,
    address committee
);

Emitted when a new anchor deployed.

Params

Name	Type	Description
deployer	address	The deployer of the anchor
anchorId	uint32	The unique identification of the anchor
anchor	address	The address of the anchor
committee	address	The committee of the anchor

Functions

messenger

function messenger(
) external view returns (address)

Returns the messenger address on the local blockchain. Any anchor deployed through this AnchorFactory will be initially connected to this messenger.

Return Values

Type	Description
address	The address of the messenger

totalAnchors

function totalAnchors(
) external view returns (uint32)

Returns the total number of anchors which have been deployed.

Return Values

Type	Description
uint32	The total number of anchors which have been deployed via the AnchorFactory

fetchId

function fetchId(
    address anchor
) external view returns (uint32)

Returns the unique identification of the input anchor. Each identification is unique on the local blockchain and can be passed as a key to fetch the description information of the corresponding anchor.

Params

Name	Type	Description
anchor	address	The address for which the unique identification will be fetched

Return Values

Type	Description
uint32	The unique identification of the input anchor

fetchInfo

function fetchInfo(
    uint32 id
) external view returns (AnchorInfo memory)

Returns the description information of the anchor with the input identification.

Params

Name	Type	Description
id	uint32	The unique identification for which the description information will be fetched