Module ConfigV2

Module ConfigV2 

Source
Expand description

Generated by the following Solidity interface…

library Common {
    struct CIDV1 {
        bytes4 prefixes;
        bytes32 hash;
    }
}

library IConfigV2 {
    type AccessTypeV2 is uint8;
}

library IOfferV2 {
    type ResourceType is uint8;
    struct ResourceRequirement {
        bytes32 resourceId;
        ResourceType ty;
        uint256 quantity;
    }
}

interface ConfigV2 {
    error InvalidInitialization();
    error NotInitializing();
    error OwnableInvalidOwner(address owner);
    error OwnableUnauthorizedAccount(address account);

    event AppCIDChanged(Common.CIDV1 newAppCID);
    event Initialized(uint64 version);
    event OwnershipTransferred(address indexed previousOwner, address indexed newOwner);
    event ProviderAddedToAccessList(address provider);
    event ProviderRemovedFromAccessList(address provider);
    event ProvidersAccessTypeChanged(IConfigV2.AccessTypeV2 newAccessType);

    function addProviderToAccessList(address provider) external;
    function appCID() external view returns (Common.CIDV1 memory);
    function changeProvidersAccessType(IConfigV2.AccessTypeV2 accessType) external;
    function creationBlock() external view returns (uint256);
    function isProviderAllowed(address account) external view returns (bool);
    function maxWorkersPerProvider() external view returns (uint256);
    function owner() external view returns (address);
    function paymentToken() external view returns (address);
    function pricePerEpoch() external view returns (uint256);
    function providersAccessType() external view returns (IConfigV2.AccessTypeV2);
    function removeProviderFromAccessList(address provider) external;
    function renounceOwnership() external;
    function requiredResources() external view returns (IOfferV2.ResourceRequirement[] memory);
    function setAppCID(Common.CIDV1 memory appCID_) external;
    function targetWorkers() external view returns (uint256);
    function transferOwnership(address newOwner) external;
}

…which was generated by the following JSON ABI:

[
  {
    "type": "function",
    "name": "addProviderToAccessList",
    "inputs": [
      {
        "name": "provider",
        "type": "address",
        "internalType": "address"
      }
    ],
    "outputs": [],
    "stateMutability": "nonpayable"
  },
  {
    "type": "function",
    "name": "appCID",
    "inputs": [],
    "outputs": [
      {
        "name": "",
        "type": "tuple",
        "internalType": "struct Common.CIDV1",
        "components": [
          {
            "name": "prefixes",
            "type": "bytes4",
            "internalType": "bytes4"
          },
          {
            "name": "hash",
            "type": "bytes32",
            "internalType": "bytes32"
          }
        ]
      }
    ],
    "stateMutability": "view"
  },
  {
    "type": "function",
    "name": "changeProvidersAccessType",
    "inputs": [
      {
        "name": "accessType",
        "type": "uint8",
        "internalType": "enum IConfigV2.AccessTypeV2"
      }
    ],
    "outputs": [],
    "stateMutability": "nonpayable"
  },
  {
    "type": "function",
    "name": "creationBlock",
    "inputs": [],
    "outputs": [
      {
        "name": "",
        "type": "uint256",
        "internalType": "uint256"
      }
    ],
    "stateMutability": "view"
  },
  {
    "type": "function",
    "name": "isProviderAllowed",
    "inputs": [
      {
        "name": "account",
        "type": "address",
        "internalType": "address"
      }
    ],
    "outputs": [
      {
        "name": "",
        "type": "bool",
        "internalType": "bool"
      }
    ],
    "stateMutability": "view"
  },
  {
    "type": "function",
    "name": "maxWorkersPerProvider",
    "inputs": [],
    "outputs": [
      {
        "name": "",
        "type": "uint256",
        "internalType": "uint256"
      }
    ],
    "stateMutability": "view"
  },
  {
    "type": "function",
    "name": "owner",
    "inputs": [],
    "outputs": [
      {
        "name": "",
        "type": "address",
        "internalType": "address"
      }
    ],
    "stateMutability": "view"
  },
  {
    "type": "function",
    "name": "paymentToken",
    "inputs": [],
    "outputs": [
      {
        "name": "",
        "type": "address",
        "internalType": "contract IERC20"
      }
    ],
    "stateMutability": "view"
  },
  {
    "type": "function",
    "name": "pricePerEpoch",
    "inputs": [],
    "outputs": [
      {
        "name": "",
        "type": "uint256",
        "internalType": "uint256"
      }
    ],
    "stateMutability": "view"
  },
  {
    "type": "function",
    "name": "providersAccessType",
    "inputs": [],
    "outputs": [
      {
        "name": "",
        "type": "uint8",
        "internalType": "enum IConfigV2.AccessTypeV2"
      }
    ],
    "stateMutability": "view"
  },
  {
    "type": "function",
    "name": "removeProviderFromAccessList",
    "inputs": [
      {
        "name": "provider",
        "type": "address",
        "internalType": "address"
      }
    ],
    "outputs": [],
    "stateMutability": "nonpayable"
  },
  {
    "type": "function",
    "name": "renounceOwnership",
    "inputs": [],
    "outputs": [],
    "stateMutability": "nonpayable"
  },
  {
    "type": "function",
    "name": "requiredResources",
    "inputs": [],
    "outputs": [
      {
        "name": "",
        "type": "tuple[]",
        "internalType": "struct IOfferV2.ResourceRequirement[]",
        "components": [
          {
            "name": "resourceId",
            "type": "bytes32",
            "internalType": "bytes32"
          },
          {
            "name": "ty",
            "type": "uint8",
            "internalType": "enum IOfferV2.ResourceType"
          },
          {
            "name": "quantity",
            "type": "uint256",
            "internalType": "uint256"
          }
        ]
      }
    ],
    "stateMutability": "view"
  },
  {
    "type": "function",
    "name": "setAppCID",
    "inputs": [
      {
        "name": "appCID_",
        "type": "tuple",
        "internalType": "struct Common.CIDV1",
        "components": [
          {
            "name": "prefixes",
            "type": "bytes4",
            "internalType": "bytes4"
          },
          {
            "name": "hash",
            "type": "bytes32",
            "internalType": "bytes32"
          }
        ]
      }
    ],
    "outputs": [],
    "stateMutability": "nonpayable"
  },
  {
    "type": "function",
    "name": "targetWorkers",
    "inputs": [],
    "outputs": [
      {
        "name": "",
        "type": "uint256",
        "internalType": "uint256"
      }
    ],
    "stateMutability": "view"
  },
  {
    "type": "function",
    "name": "transferOwnership",
    "inputs": [
      {
        "name": "newOwner",
        "type": "address",
        "internalType": "address"
      }
    ],
    "outputs": [],
    "stateMutability": "nonpayable"
  },
  {
    "type": "event",
    "name": "AppCIDChanged",
    "inputs": [
      {
        "name": "newAppCID",
        "type": "tuple",
        "indexed": false,
        "internalType": "struct Common.CIDV1",
        "components": [
          {
            "name": "prefixes",
            "type": "bytes4",
            "internalType": "bytes4"
          },
          {
            "name": "hash",
            "type": "bytes32",
            "internalType": "bytes32"
          }
        ]
      }
    ],
    "anonymous": false
  },
  {
    "type": "event",
    "name": "Initialized",
    "inputs": [
      {
        "name": "version",
        "type": "uint64",
        "indexed": false,
        "internalType": "uint64"
      }
    ],
    "anonymous": false
  },
  {
    "type": "event",
    "name": "OwnershipTransferred",
    "inputs": [
      {
        "name": "previousOwner",
        "type": "address",
        "indexed": true,
        "internalType": "address"
      },
      {
        "name": "newOwner",
        "type": "address",
        "indexed": true,
        "internalType": "address"
      }
    ],
    "anonymous": false
  },
  {
    "type": "event",
    "name": "ProviderAddedToAccessList",
    "inputs": [
      {
        "name": "provider",
        "type": "address",
        "indexed": false,
        "internalType": "address"
      }
    ],
    "anonymous": false
  },
  {
    "type": "event",
    "name": "ProviderRemovedFromAccessList",
    "inputs": [
      {
        "name": "provider",
        "type": "address",
        "indexed": false,
        "internalType": "address"
      }
    ],
    "anonymous": false
  },
  {
    "type": "event",
    "name": "ProvidersAccessTypeChanged",
    "inputs": [
      {
        "name": "newAccessType",
        "type": "uint8",
        "indexed": false,
        "internalType": "enum IConfigV2.AccessTypeV2"
      }
    ],
    "anonymous": false
  },
  {
    "type": "error",
    "name": "InvalidInitialization",
    "inputs": []
  },
  {
    "type": "error",
    "name": "NotInitializing",
    "inputs": []
  },
  {
    "type": "error",
    "name": "OwnableInvalidOwner",
    "inputs": [
      {
        "name": "owner",
        "type": "address",
        "internalType": "address"
      }
    ]
  },
  {
    "type": "error",
    "name": "OwnableUnauthorizedAccount",
    "inputs": [
      {
        "name": "account",
        "type": "address",
        "internalType": "address"
      }
    ]
  }
]

Structs§

AppCIDChanged
Event with signature AppCIDChanged((bytes4,bytes32)) and selector 0xc820a66d3bdd50a45cf12cda6dc8ec9e94fb5123edd7da736eea18316f8523a0.
ConfigV2Instance
A ConfigV2 instance.
Initialized
Event with signature Initialized(uint64) and selector 0xc7f505b2f371ae2175ee4913f4499e1f2633a7b5936321eed1cdaeb6115181d2.
InvalidInitialization
Custom error with signature InvalidInitialization() and selector 0xf92ee8a9.
NotInitializing
Custom error with signature NotInitializing() and selector 0xd7e6bcf8.
OwnableInvalidOwner
Custom error with signature OwnableInvalidOwner(address) and selector 0x1e4fbdf7.
OwnableUnauthorizedAccount
Custom error with signature OwnableUnauthorizedAccount(address) and selector 0x118cdaa7.
OwnershipTransferred
Event with signature OwnershipTransferred(address,address) and selector 0x8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e0.
ProviderAddedToAccessList
Event with signature ProviderAddedToAccessList(address) and selector 0x4c26e4de691e265be6cf03e639754839907bf74687cd524a6734851331527ffd.
ProviderRemovedFromAccessList
Event with signature ProviderRemovedFromAccessList(address) and selector 0x38fb081a0b484406977bd94ff8edb79be44b5ca514130361182516b39e2c4528.
ProvidersAccessTypeChanged
Event with signature ProvidersAccessTypeChanged(uint8) and selector 0x1f5a251428f76335a835fcae94ab6a9bcf09ac33bd3c782eb6a81bdf878a7393.
addProviderToAccessListCall
Function with signature addProviderToAccessList(address) and selector 0x73134c15.
addProviderToAccessListReturn
Container type for the return parameters of the addProviderToAccessList(address) function.
appCIDCall
Function with signature appCID() and selector 0x9bc66868.
appCIDReturn
Container type for the return parameters of the appCID() function.
changeProvidersAccessTypeCall
Function with signature changeProvidersAccessType(uint8) and selector 0x636fcefb.
changeProvidersAccessTypeReturn
Container type for the return parameters of the changeProvidersAccessType(uint8) function.
creationBlockCall
Function with signature creationBlock() and selector 0x17634514.
creationBlockReturn
Container type for the return parameters of the creationBlock() function.
isProviderAllowedCall
Function with signature isProviderAllowed(address) and selector 0x3e8ae1ae.
isProviderAllowedReturn
Container type for the return parameters of the isProviderAllowed(address) function.
maxWorkersPerProviderCall
Function with signature maxWorkersPerProvider() and selector 0x8a0c725b.
maxWorkersPerProviderReturn
Container type for the return parameters of the maxWorkersPerProvider() function.
ownerCall
Function with signature owner() and selector 0x8da5cb5b.
ownerReturn
Container type for the return parameters of the owner() function.
paymentTokenCall
Function with signature paymentToken() and selector 0x3013ce29.
paymentTokenReturn
Container type for the return parameters of the paymentToken() function.
pricePerEpochCall
Function with signature pricePerEpoch() and selector 0x5fc8f59c.
pricePerEpochReturn
Container type for the return parameters of the pricePerEpoch() function.
providersAccessTypeCall
Function with signature providersAccessType() and selector 0xd4773ff0.
providersAccessTypeReturn
Container type for the return parameters of the providersAccessType() function.
removeProviderFromAccessListCall
Function with signature removeProviderFromAccessList(address) and selector 0x444e6a5a.
removeProviderFromAccessListReturn
Container type for the return parameters of the removeProviderFromAccessList(address) function.
renounceOwnershipCall
Function with signature renounceOwnership() and selector 0x715018a6.
renounceOwnershipReturn
Container type for the return parameters of the renounceOwnership() function.
requiredResourcesCall
Function with signature requiredResources() and selector 0x4e4d7af8.
requiredResourcesReturn
Container type for the return parameters of the requiredResources() function.
setAppCIDCall
Function with signature setAppCID((bytes4,bytes32)) and selector 0x176474cf.
setAppCIDReturn
Container type for the return parameters of the setAppCID((bytes4,bytes32)) function.
targetWorkersCall
Function with signature targetWorkers() and selector 0x2943dcab.
targetWorkersReturn
Container type for the return parameters of the targetWorkers() function.
transferOwnershipCall
Function with signature transferOwnership(address) and selector 0xf2fde38b.
transferOwnershipReturn
Container type for the return parameters of the transferOwnership(address) function.

Enums§

ConfigV2Calls
Container for all the ConfigV2 function calls.
ConfigV2Errors
Container for all the ConfigV2 custom errors.
ConfigV2Events
Container for all the ConfigV2 events.

Statics§

BYTECODE
The creation / init bytecode of the contract.
DEPLOYED_BYTECODE
The runtime bytecode of the contract, as deployed on the network.

Functions§

deploy
Deploys this contract using the given provider and constructor arguments, if any.
deploy_builder
Creates a RawCallBuilder for deploying this contract using the given provider and constructor arguments, if any.
new
Creates a new wrapper around an on-chain ConfigV2 contract instance.