Dispatch
The dispatch contract keeps track of the agent <> scanner links. An agent can be run by multiple scanners and a scanner can run multiple agents.
Links between scanners and agents are managed by the DISPATCHER_ROLE which could be given to a future contract that defines some rules to link/unlink (for example reacting to stake variations).
In order to be linked, both agents and scanners have to be enabled and staked over their minimum defined stake.
This contract includes a "hash" mechanism that can be used to produce agent hash or scanner hash. These hash identify the state of the relations for an object and change if one of the associated values changes. For example, if a scanner is linked to an agent, and the agent is updated, the scanner hash will be affected. If an agent is added, removed, or change its enable/disable status, the scanner hash will also be affected.
These hash functions should only be called as part of RPC calls, and not during transaction execution. They are here to help the scanner entity detect changes if event subscriptions are missing or failing.
_agents
contract AgentRegistry _agents
_scanners
contract ScannerRegistry _scanners
version
string version
scannerToAgents
mapping(uint256 => struct EnumerableSet.UintSet) scannerToAgents
agentToScanners
mapping(uint256 => struct EnumerableSet.UintSet) agentToScanners
Disabled
error Disabled(string name)
InvalidId
error InvalidId(string name, uint256 id)
AlreadyLinked
event AlreadyLinked(uint256 agentId, uint256 scannerId, bool enable)
Link
event Link(uint256 agentId, uint256 scannerId, bool enable)
constructor
constructor(address forwarder) public
initialize
function initialize(address __manager, address __router, address __agents, address __scanners) public
Initializer method, access point to initialize inheritance tree.
| Name | Type | Description |
|---|---|---|
| __manager | address | address of AccessManager. |
| __router | address | address of Router. |
| __agents | address | address of AgentRegistry. |
| __scanners | address | address of ScannerRegistry. |
agentRegistry
function agentRegistry() public view returns (contract AgentRegistry)
Getter for AgentRegistry.
| Name | Type | Description |
|---|---|---|
| [0] | contract AgentRegistry | AgentRegistry. |
scannerRegistry
function scannerRegistry() public view returns (contract ScannerRegistry)
Getter for ScannerRegistry.
| Name | Type | Description |
|---|---|---|
| [0] | contract ScannerRegistry | ScannerRegistry. |
numAgentsFor
function numAgentsFor(uint256 scannerId) public view returns (uint256)
Get total agents linked to a scanner.
helper for external iteration.
| Name | Type | Description |
|---|---|---|
| scannerId | uint256 | ERC1155 token id of the scanner. |
| Name | Type | Description |
|---|---|---|
| [0] | uint256 | total agents linked to a scanner |
numScannersFor
function numScannersFor(uint256 agentId) public view returns (uint256)
Get total scanners where an agent is running in.
helper for external iteration.
| Name | Type | Description |
|---|---|---|
| agentId | uint256 | ERC1155 token id of the agent. |
| Name | Type | Description |
|---|---|---|
| [0] | uint256 | total scanners running an scanner |
agentAt
function agentAt(uint256 scannerId, uint256 pos) public view returns (uint256)
Get agentId linked to a scanner in certain position.
helper for external iteration.
| Name | Type | Description |
|---|---|---|
| scannerId | uint256 | ERC1155 token id of the scanner. |
| pos | uint256 | index for iteration. |
| Name | Type | Description |
|---|---|---|
| [0] | uint256 | ERC1155 token id of the agent. |
agentRefAt
function agentRefAt(uint256 scannerId, uint256 pos) external view returns (bool registered, address owner, uint256 agentId, uint256 agentVersion, string metadata, uint256[] chainIds, bool enabled)
Get data of an agent linked to a scanner at a certain position.
helper for external iteration.
| Name | Type | Description |
|---|---|---|
| scannerId | uint256 | ERC1155 token id of the scanner. |
| pos | uint256 | index for iteration. |
| Name | Type | Description |
|---|---|---|
| registered | bool | bool if agent exists, false otherwise. |
| owner | address | address. |
| agentId | uint256 | ERC1155 token id of the agent. |
| agentVersion | uint256 | agent version number. |
| metadata | string | IPFS pointer for agent metadata. |
| chainIds | uint256[] | ordered array of chainId were the agent wants to run. |
| enabled | bool | bool if agent is enabled, false otherwise. |
scannerAt
function scannerAt(uint256 agentId, uint256 pos) public view returns (uint256)
Get scannerId running an agent at a certain position.
helper for external iteration.
| Name | Type | Description |
|---|---|---|
| agentId | uint256 | ERC1155 token id of the scanner. |
| pos | uint256 | index for iteration. |
| Name | Type | Description |
|---|---|---|
| [0] | uint256 | ERC1155 token id of the scanner. |
scannerRefAt
function scannerRefAt(uint256 agentId, uint256 pos) external view returns (bool registered, uint256 scannerId, address owner, uint256 chainId, string metadata, bool enabled)
Get data of ascanner running an agent at a certain position.
helper for external iteration.
| Name | Type | Description |
|---|---|---|
| agentId | uint256 | ERC1155 token id of the agent. |
| pos | uint256 | index for iteration. |
| Name | Type | Description |
|---|---|---|
| registered | bool | true if scanner is registered. |
| scannerId | uint256 | ERC1155 token id of the scanner. |
| owner | address | address. |
| chainId | uint256 | that the scanner monitors. |
| metadata | string | IPFS pointer for agent metadata. |
| enabled | bool | true if scanner is enabled, false otherwise. |
areTheyLinked
function areTheyLinked(uint256 agentId, uint256 scannerId) external view returns (bool)
Returns true if scanner and agents are linked, false otherwise.
link
function link(uint256 agentId, uint256 scannerId) public
Assigns the job of running an agent to a scanner.
currently only allowed for DISPATCHER_ROLE (Assigner software). emits Link(agentId, scannerId, true) event.
| Name | Type | Description |
|---|---|---|
| agentId | uint256 | ERC1155 token id of the agent. |
| scannerId | uint256 | ERC1155 token id of the scanner. |
unlink
function unlink(uint256 agentId, uint256 scannerId) public
Unassigns the job of running an agent to a scanner.
currently only allowed for DISPATCHER_ROLE (Assigner software). emits Link(agentId, scannerId, false) event.
| Name | Type | Description |
|---|---|---|
| agentId | uint256 | ERC1155 token id of the agent. |
| scannerId | uint256 | ERC1155 token id of the scanner. |
setAgentRegistry
function setAgentRegistry(address newAgentRegistry) public
Sets agent registry address.
only DEFAULT_ADMIN_ROLE (governance).
| Name | Type | Description |
|---|---|---|
| newAgentRegistry | address | agent of the new AgentRegistry. |
setScannerRegistry
function setScannerRegistry(address newScannerRegistry) public
Sets scanner registry address.
only DEFAULT_ADMIN_ROLE (governance).
| Name | Type | Description |
|---|---|---|
| newScannerRegistry | address | agent of the new ScannerRegistry. |
agentHash
function agentHash(uint256 agentId) external view returns (uint256 length, bytes32 manifest)
Method to hash the amount of scanners an agent is running in, and their status
method marked for deprecation in next version.
scannerHash
function scannerHash(uint256 scannerId) external view returns (uint256 length, bytes32 manifest)
method used by Scanner Node software to know if their list of assigned agents has changed, their enabled state or version has changed so they can start managing changes (loading new agent images, removing not assigned agents, updating agents...).
| Name | Type | Description |
|---|---|---|
| scannerId | uint256 | ERC1155 token id of the scanner. |
| Name | Type | Description |
|---|---|---|
| length | uint256 | amount of agents. |
| manifest | bytes32 | keccak256 of list of agents, list of agentVersion and list of enabled states. |
__gap
uint256[48] __gap