{ "contractName": "DepositFactoryAuthority", "abi": [ { "constant": false, "inputs": [ { "internalType": "address", "name": "_factory", "type": "address" } ], "name": "initialize", "outputs": [], "payable": false, "stateMutability": "nonpayable", "type": "function" } ], "metadata": "{\"compiler\":{\"version\":\"0.5.17+commit.d19bba13\"},\"language\":\"Solidity\",\"output\":{\"abi\":[{\"constant\":false,\"inputs\":[{\"internalType\":\"address\",\"name\":\"_factory\",\"type\":\"address\"}],\"name\":\"initialize\",\"outputs\":[],\"payable\":false,\"stateMutability\":\"nonpayable\",\"type\":\"function\"}],\"devdoc\":{\"details\":\"Secured by setting the depositFactory address and using the onlyFactory modifier on functions requiring restriction.\",\"methods\":{\"initialize(address)\":{\"details\":\"Since this function is not access-controlled, it should be called transactionally with contract instantiation. In cases where a regular contract directly inherits from DepositFactoryAuthority, that should happen in the constructor. In cases where the inheritor is binstead used via a clone factory, the same function that creates a new clone should also trigger initialization.\"}},\"title\":\"Deposit Factory Authority\"},\"userdoc\":{\"methods\":{\"initialize(address)\":{\"notice\":\"Set the address of the System contract on contract initialization.\"}},\"notice\":\"Contract to secure function calls to the Deposit Factory.\"}},\"settings\":{\"compilationTarget\":{\"/home/runner/work/tbtc/tbtc/solidity/contracts/system/DepositFactoryAuthority.sol\":\"DepositFactoryAuthority\"},\"evmVersion\":\"istanbul\",\"libraries\":{},\"optimizer\":{\"enabled\":true,\"runs\":200},\"remappings\":[]},\"sources\":{\"/home/runner/work/tbtc/tbtc/solidity/contracts/system/DepositFactoryAuthority.sol\":{\"keccak256\":\"0xd8e81ec58dea6a6bcc554e8c7e6c58898ab11a410c3f61224330cbe833992add\",\"urls\":[\"bzz-raw://9d2b23cf1e2f98eb77acf6ae62933e48494113e1d6091146459fd79a635f1dcf\",\"dweb:/ipfs/QmPK3nTmcrScDavDSXGHvonhfik3BJ55qhwSnUmhzL5QUE\"]}},\"version\":1}", "bytecode": "0x60806040526000805460ff1916905534801561001a57600080fd5b5061018b8061002a6000396000f3fe608060405234801561001057600080fd5b506004361061002b5760003560e01c8063c4d66de814610030575b600080fd5b6100566004803603602081101561004657600080fd5b50356001600160a01b0316610058565b005b6001600160a01b03811661009d5760405162461bcd60e51b815260040180806020018281038252602381526020018061010f6023913960400191505060405180910390fd5b60005460ff16156100df5760405162461bcd60e51b81526004018080602001828103825260258152602001806101326025913960400191505060405180910390fd5b6000805460ff196001600160a01b0390931661010002610100600160a81b03199091161791909116600117905556fe466163746f72792063616e6e6f7420626520746865207a65726f20616464726573732e466163746f72792063616e206f6e6c7920626520696e697469616c697a6564206f6e63652ea265627a7a72315820ffed1ae8ffa1ca629b4574af16d1ab3e561b37e9074dc7f0fcb5c7a729c37f4764736f6c63430005110032", "deployedBytecode": "0x608060405234801561001057600080fd5b506004361061002b5760003560e01c8063c4d66de814610030575b600080fd5b6100566004803603602081101561004657600080fd5b50356001600160a01b0316610058565b005b6001600160a01b03811661009d5760405162461bcd60e51b815260040180806020018281038252602381526020018061010f6023913960400191505060405180910390fd5b60005460ff16156100df5760405162461bcd60e51b81526004018080602001828103825260258152602001806101326025913960400191505060405180910390fd5b6000805460ff196001600160a01b0390931661010002610100600160a81b03199091161791909116600117905556fe466163746f72792063616e6e6f7420626520746865207a65726f20616464726573732e466163746f72792063616e206f6e6c7920626520696e697469616c697a6564206f6e63652ea265627a7a72315820ffed1ae8ffa1ca629b4574af16d1ab3e561b37e9074dc7f0fcb5c7a729c37f4764736f6c63430005110032", "sourceMap": "274:1296:18:-;;;342:5;313:34;;-1:-1:-1;;313:34:18;;;274:1296;5:2:-1;;;;30:1;27;20:12;5:2;274:1296:18;;;;;;;", "deployedSourceMap": "274:1296:18:-;;;;8:9:-1;5:2;;;30:1;27;20:12;5:2;274:1296:18;;;;;;;;;;;;;;;;;;;947:271;;;;;;13:2:-1;8:3;5:11;2:2;;;29:1;26;19:12;2:2;-1:-1;947:271:18;-1:-1:-1;;;;;947:271:18;;:::i;:::-;;;-1:-1:-1;;;;;1010:22:18;;1002:70;;;;-1:-1:-1;;;1002:70:18;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;1091:12;;;;1090:13;1082:63;;;;-1:-1:-1;;;1082:63:18;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;1156:15;:26;;-1:-1:-1;;;;;;;1156:26:18;;;;;-1:-1:-1;;;;;;1156:26:18;;;;1192:19;;;;1156:15;1192:19;;;947:271::o", "source": "pragma solidity 0.5.17;\n\n/// @title Deposit Factory Authority\n/// @notice Contract to secure function calls to the Deposit Factory.\n/// @dev Secured by setting the depositFactory address and using the onlyFactory\n/// modifier on functions requiring restriction.\ncontract DepositFactoryAuthority {\n bool internal _initialized = false;\n address internal _depositFactory;\n\n /// @notice Set the address of the System contract on contract\n /// initialization.\n /// @dev Since this function is not access-controlled, it should be called\n /// transactionally with contract instantiation. In cases where a\n /// regular contract directly inherits from DepositFactoryAuthority,\n /// that should happen in the constructor. In cases where the inheritor\n /// is binstead used via a clone factory, the same function that\n /// creates a new clone should also trigger initialization.\n function initialize(address _factory) public {\n require(_factory != address(0), \"Factory cannot be the zero address.\");\n require(!_initialized, \"Factory can only be initialized once.\");\n\n _depositFactory = _factory;\n _initialized = true;\n }\n\n /// @notice Function modifier ensures modified function is only called by set deposit factory.\n modifier onlyFactory() {\n require(_initialized, \"Factory initialization must have been called.\");\n require(\n msg.sender == _depositFactory,\n \"Caller must be depositFactory contract\"\n );\n _;\n }\n}\n", "sourcePath": "/home/runner/work/tbtc/tbtc/solidity/contracts/system/DepositFactoryAuthority.sol", "ast": { "absolutePath": "/home/runner/work/tbtc/tbtc/solidity/contracts/system/DepositFactoryAuthority.sol", "exportedSymbols": { "DepositFactoryAuthority": [ 6251 ] }, "id": 6252, "nodeType": "SourceUnit", "nodes": [ { "id": 6199, "literals": [ "solidity", "0.5", ".17" ], "nodeType": "PragmaDirective", "src": "0:23:18" }, { "baseContracts": [], "contractDependencies": [], "contractKind": "contract", "documentation": "@title Deposit Factory Authority\n @notice Contract to secure function calls to the Deposit Factory.\n @dev Secured by setting the depositFactory address and using the onlyFactory\n modifier on functions requiring restriction.", "fullyImplemented": true, "id": 6251, "linearizedBaseContracts": [ 6251 ], "name": "DepositFactoryAuthority", "nodeType": "ContractDefinition", "nodes": [ { "constant": false, "id": 6202, "name": "_initialized", "nodeType": "VariableDeclaration", "scope": 6251, "src": "313:34:18", "stateVariable": true, "storageLocation": "default", "typeDescriptions": { "typeIdentifier": "t_bool", "typeString": "bool" }, "typeName": { "id": 6200, "name": "bool", "nodeType": "ElementaryTypeName", "src": "313:4:18", "typeDescriptions": { "typeIdentifier": "t_bool", "typeString": "bool" } }, "value": { "argumentTypes": null, "hexValue": "66616c7365", "id": 6201, "isConstant": false, "isLValue": false, "isPure": true, "kind": "bool", "lValueRequested": false, "nodeType": "Literal", "src": "342:5:18", "subdenomination": null, "typeDescriptions": { "typeIdentifier": "t_bool", "typeString": "bool" }, "value": "false" }, "visibility": "internal" }, { "constant": false, "id": 6204, "name": "_depositFactory", "nodeType": "VariableDeclaration", "scope": 6251, "src": "353:32:18", "stateVariable": true, "storageLocation": "default", "typeDescriptions": { "typeIdentifier": "t_address", "typeString": "address" }, "typeName": { "id": 6203, "name": "address", "nodeType": "ElementaryTypeName", "src": "353:7:18", "stateMutability": "nonpayable", "typeDescriptions": { "typeIdentifier": "t_address", "typeString": "address" } }, "value": null, "visibility": "internal" }, { "body": { "id": 6232, "nodeType": "Block", "src": "992:226:18", "statements": [ { "expression": { "argumentTypes": null, "arguments": [ { "argumentTypes": null, "commonType": { "typeIdentifier": "t_address", "typeString": "address" }, "id": 6214, "isConstant": false, "isLValue": false, "isPure": false, "lValueRequested": false, "leftExpression": { "argumentTypes": null, "id": 6210, "name": "_factory", "nodeType": "Identifier", "overloadedDeclarations": [], "referencedDeclaration": 6206, "src": "1010:8:18", "typeDescriptions": { "typeIdentifier": "t_address", "typeString": "address" } }, "nodeType": "BinaryOperation", "operator": "!=", "rightExpression": { "argumentTypes": null, "arguments": [ { "argumentTypes": null, "hexValue": "30", "id": 6212, "isConstant": false, "isLValue": false, "isPure": true, "kind": "number", "lValueRequested": false, "nodeType": "Literal", "src": "1030:1:18", "subdenomination": null, "typeDescriptions": { "typeIdentifier": "t_rational_0_by_1", "typeString": "int_const 0" }, "value": "0" } ], "expression": { "argumentTypes": [ { "typeIdentifier": "t_rational_0_by_1", "typeString": "int_const 0" } ], "id": 6211, "isConstant": false, "isLValue": false, "isPure": true, "lValueRequested": false, "nodeType": "ElementaryTypeNameExpression", "src": "1022:7:18", "typeDescriptions": { "typeIdentifier": "t_type$_t_address_$", "typeString": "type(address)" }, "typeName": "address" }, "id": 6213, "isConstant": false, "isLValue": false, "isPure": true, "kind": "typeConversion", "lValueRequested": false, "names": [], "nodeType": "FunctionCall", "src": "1022:10:18", "typeDescriptions": { "typeIdentifier": "t_address_payable", "typeString": "address payable" } }, "src": "1010:22:18", "typeDescriptions": { "typeIdentifier": "t_bool", "typeString": "bool" } }, { "argumentTypes": null, "hexValue": "466163746f72792063616e6e6f7420626520746865207a65726f20616464726573732e", "id": 6215, "isConstant": false, "isLValue": false, "isPure": true, "kind": "string", "lValueRequested": false, "nodeType": "Literal", "src": "1034:37:18", "subdenomination": null, "typeDescriptions": { "typeIdentifier": "t_stringliteral_2bd3cbc23ffb44d3580484075b016a2d908a32b5541fab8a3134aa94a7c5ffa6", "typeString": "literal_string \"Factory cannot be the zero address.\"" }, "value": "Factory cannot be the zero address." } ], "expression": { "argumentTypes": [ { "typeIdentifier": "t_bool", "typeString": "bool" }, { "typeIdentifier": "t_stringliteral_2bd3cbc23ffb44d3580484075b016a2d908a32b5541fab8a3134aa94a7c5ffa6", "typeString": "literal_string \"Factory cannot be the zero address.\"" } ], "id": 6209, "name": "require", "nodeType": "Identifier", "overloadedDeclarations": [ 18363, 18364 ], "referencedDeclaration": 18364, "src": "1002:7:18", "typeDescriptions": { "typeIdentifier": "t_function_require_pure$_t_bool_$_t_string_memory_ptr_$returns$__$", "typeString": "function (bool,string memory) pure" } }, "id": 6216, "isConstant": false, "isLValue": false, "isPure": false, "kind": "functionCall", "lValueRequested": false, "names": [], "nodeType": "FunctionCall", "src": "1002:70:18", "typeDescriptions": { "typeIdentifier": "t_tuple$__$", "typeString": "tuple()" } }, "id": 6217, "nodeType": "ExpressionStatement", "src": "1002:70:18" }, { "expression": { "argumentTypes": null, "arguments": [ { "argumentTypes": null, "id": 6220, "isConstant": false, "isLValue": false, "isPure": false, "lValueRequested": false, "nodeType": "UnaryOperation", "operator": "!", "prefix": true, "src": "1090:13:18", "subExpression": { "argumentTypes": null, "id": 6219, "name": "_initialized", "nodeType": "Identifier", "overloadedDeclarations": [], "referencedDeclaration": 6202, "src": "1091:12:18", "typeDescriptions": { "typeIdentifier": "t_bool", "typeString": "bool" } }, "typeDescriptions": { "typeIdentifier": "t_bool", "typeString": "bool" } }, { "argumentTypes": null, "hexValue": "466163746f72792063616e206f6e6c7920626520696e697469616c697a6564206f6e63652e", "id": 6221, "isConstant": false, "isLValue": false, "isPure": true, "kind": "string", "lValueRequested": false, "nodeType": "Literal", "src": "1105:39:18", "subdenomination": null, "typeDescriptions": { "typeIdentifier": "t_stringliteral_ce00edb2a923848081003b8039d197b6044b329e1d83ed238dca317d015c0159", "typeString": "literal_string \"Factory can only be initialized once.\"" }, "value": "Factory can only be initialized once." } ], "expression": { "argumentTypes": [ { "typeIdentifier": "t_bool", "typeString": "bool" }, { "typeIdentifier": "t_stringliteral_ce00edb2a923848081003b8039d197b6044b329e1d83ed238dca317d015c0159", "typeString": "literal_string \"Factory can only be initialized once.\"" } ], "id": 6218, "name": "require", "nodeType": "Identifier", "overloadedDeclarations": [ 18363, 18364 ], "referencedDeclaration": 18364, "src": "1082:7:18", "typeDescriptions": { "typeIdentifier": "t_function_require_pure$_t_bool_$_t_string_memory_ptr_$returns$__$", "typeString": "function (bool,string memory) pure" } }, "id": 6222, "isConstant": false, "isLValue": false, "isPure": false, "kind": "functionCall", "lValueRequested": false, "names": [], "nodeType": "FunctionCall", "src": "1082:63:18", "typeDescriptions": { "typeIdentifier": "t_tuple$__$", "typeString": "tuple()" } }, "id": 6223, "nodeType": "ExpressionStatement", "src": "1082:63:18" }, { "expression": { "argumentTypes": null, "id": 6226, "isConstant": false, "isLValue": false, "isPure": false, "lValueRequested": false, "leftHandSide": { "argumentTypes": null, "id": 6224, "name": "_depositFactory", "nodeType": "Identifier", "overloadedDeclarations": [], "referencedDeclaration": 6204, "src": "1156:15:18", "typeDescriptions": { "typeIdentifier": "t_address", "typeString": "address" } }, "nodeType": "Assignment", "operator": "=", "rightHandSide": { "argumentTypes": null, "id": 6225, "name": "_factory", "nodeType": "Identifier", "overloadedDeclarations": [], "referencedDeclaration": 6206, "src": "1174:8:18", "typeDescriptions": { "typeIdentifier": "t_address", "typeString": "address" } }, "src": "1156:26:18", "typeDescriptions": { "typeIdentifier": "t_address", "typeString": "address" } }, "id": 6227, "nodeType": "ExpressionStatement", "src": "1156:26:18" }, { "expression": { "argumentTypes": null, "id": 6230, "isConstant": false, "isLValue": false, "isPure": false, "lValueRequested": false, "leftHandSide": { "argumentTypes": null, "id": 6228, "name": "_initialized", "nodeType": "Identifier", "overloadedDeclarations": [], "referencedDeclaration": 6202, "src": "1192:12:18", "typeDescriptions": { "typeIdentifier": "t_bool", "typeString": "bool" } }, "nodeType": "Assignment", "operator": "=", "rightHandSide": { "argumentTypes": null, "hexValue": "74727565", "id": 6229, "isConstant": false, "isLValue": false, "isPure": true, "kind": "bool", "lValueRequested": false, "nodeType": "Literal", "src": "1207:4:18", "subdenomination": null, "typeDescriptions": { "typeIdentifier": "t_bool", "typeString": "bool" }, "value": "true" }, "src": "1192:19:18", "typeDescriptions": { "typeIdentifier": "t_bool", "typeString": "bool" } }, "id": 6231, "nodeType": "ExpressionStatement", "src": "1192:19:18" } ] }, "documentation": "@notice Set the address of the System contract on contract\n initialization.\n @dev Since this function is not access-controlled, it should be called\n transactionally with contract instantiation. In cases where a\n regular contract directly inherits from DepositFactoryAuthority,\n that should happen in the constructor. In cases where the inheritor\n is binstead used via a clone factory, the same function that\n creates a new clone should also trigger initialization.", "id": 6233, "implemented": true, "kind": "function", "modifiers": [], "name": "initialize", "nodeType": "FunctionDefinition", "parameters": { "id": 6207, "nodeType": "ParameterList", "parameters": [ { "constant": false, "id": 6206, "name": "_factory", "nodeType": "VariableDeclaration", "scope": 6233, "src": "967:16:18", "stateVariable": false, "storageLocation": "default", "typeDescriptions": { "typeIdentifier": "t_address", "typeString": "address" }, "typeName": { "id": 6205, "name": "address", "nodeType": "ElementaryTypeName", "src": "967:7:18", "stateMutability": "nonpayable", "typeDescriptions": { "typeIdentifier": "t_address", "typeString": "address" } }, "value": null, "visibility": "internal" } ], "src": "966:18:18" }, "returnParameters": { "id": 6208, "nodeType": "ParameterList", "parameters": [], "src": "992:0:18" }, "scope": 6251, "src": "947:271:18", "stateMutability": "nonpayable", "superFunction": null, "visibility": "public" }, { "body": { "id": 6249, "nodeType": "Block", "src": "1346:222:18", "statements": [ { "expression": { "argumentTypes": null, "arguments": [ { "argumentTypes": null, "id": 6236, "name": "_initialized", "nodeType": "Identifier", "overloadedDeclarations": [], "referencedDeclaration": 6202, "src": "1364:12:18", "typeDescriptions": { "typeIdentifier": "t_bool", "typeString": "bool" } }, { "argumentTypes": null, "hexValue": "466163746f727920696e697469616c697a6174696f6e206d7573742068617665206265656e2063616c6c65642e", "id": 6237, "isConstant": false, "isLValue": false, "isPure": true, "kind": "string", "lValueRequested": false, "nodeType": "Literal", "src": "1378:47:18", "subdenomination": null, "typeDescriptions": { "typeIdentifier": "t_stringliteral_ec839c8c5c6b5e827d48fd88aa465bf1aeb67fc299bceed306c2fedd287c2af1", "typeString": "literal_string \"Factory initialization must have been called.\"" }, "value": "Factory initialization must have been called." } ], "expression": { "argumentTypes": [ { "typeIdentifier": "t_bool", "typeString": "bool" }, { "typeIdentifier": "t_stringliteral_ec839c8c5c6b5e827d48fd88aa465bf1aeb67fc299bceed306c2fedd287c2af1", "typeString": "literal_string \"Factory initialization must have been called.\"" } ], "id": 6235, "name": "require", "nodeType": "Identifier", "overloadedDeclarations": [ 18363, 18364 ], "referencedDeclaration": 18364, "src": "1356:7:18", "typeDescriptions": { "typeIdentifier": "t_function_require_pure$_t_bool_$_t_string_memory_ptr_$returns$__$", "typeString": "function (bool,string memory) pure" } }, "id": 6238, "isConstant": false, "isLValue": false, "isPure": false, "kind": "functionCall", "lValueRequested": false, "names": [], "nodeType": "FunctionCall", "src": "1356:70:18", "typeDescriptions": { "typeIdentifier": "t_tuple$__$", "typeString": "tuple()" } }, "id": 6239, "nodeType": "ExpressionStatement", "src": "1356:70:18" }, { "expression": { "argumentTypes": null, "arguments": [ { "argumentTypes": null, "commonType": { "typeIdentifier": "t_address", "typeString": "address" }, "id": 6244, "isConstant": false, "isLValue": false, "isPure": false, "lValueRequested": false, "leftExpression": { "argumentTypes": null, "expression": { "argumentTypes": null, "id": 6241, "name": "msg", "nodeType": "Identifier", "overloadedDeclarations": [], "referencedDeclaration": 18360, "src": "1457:3:18", "typeDescriptions": { "typeIdentifier": "t_magic_message", "typeString": "msg" } }, "id": 6242, "isConstant": false, "isLValue": false, "isPure": false, "lValueRequested": false, "memberName": "sender", "nodeType": "MemberAccess", "referencedDeclaration": null, "src": "1457:10:18", "typeDescriptions": { "typeIdentifier": "t_address_payable", "typeString": "address payable" } }, "nodeType": "BinaryOperation", "operator": "==", "rightExpression": { "argumentTypes": null, "id": 6243, "name": "_depositFactory", "nodeType": "Identifier", "overloadedDeclarations": [], "referencedDeclaration": 6204, "src": "1471:15:18", "typeDescriptions": { "typeIdentifier": "t_address", "typeString": "address" } }, "src": "1457:29:18", "typeDescriptions": { "typeIdentifier": "t_bool", "typeString": "bool" } }, { "argumentTypes": null, "hexValue": "43616c6c6572206d757374206265206465706f736974466163746f727920636f6e7472616374", "id": 6245, "isConstant": false, "isLValue": false, "isPure": true, "kind": "string", "lValueRequested": false, "nodeType": "Literal", "src": "1500:40:18", "subdenomination": null, "typeDescriptions": { "typeIdentifier": "t_stringliteral_e0ecc7208047a6683867d6b9737c2935cc89cb774fe5f25ab7ade7c78861ee44", "typeString": "literal_string \"Caller must be depositFactory contract\"" }, "value": "Caller must be depositFactory contract" } ], "expression": { "argumentTypes": [ { "typeIdentifier": "t_bool", "typeString": "bool" }, { "typeIdentifier": "t_stringliteral_e0ecc7208047a6683867d6b9737c2935cc89cb774fe5f25ab7ade7c78861ee44", "typeString": "literal_string \"Caller must be depositFactory contract\"" } ], "id": 6240, "name": "require", "nodeType": "Identifier", "overloadedDeclarations": [ 18363, 18364 ], "referencedDeclaration": 18364, "src": "1436:7:18", "typeDescriptions": { "typeIdentifier": "t_function_require_pure$_t_bool_$_t_string_memory_ptr_$returns$__$", "typeString": "function (bool,string memory) pure" } }, "id": 6246, "isConstant": false, "isLValue": false, "isPure": false, "kind": "functionCall", "lValueRequested": false, "names": [], "nodeType": "FunctionCall", "src": "1436:114:18", "typeDescriptions": { "typeIdentifier": "t_tuple$__$", "typeString": "tuple()" } }, "id": 6247, "nodeType": "ExpressionStatement", "src": "1436:114:18" }, { "id": 6248, "nodeType": "PlaceholderStatement", "src": "1560:1:18" } ] }, "documentation": "@notice Function modifier ensures modified function is only called by set deposit factory.", "id": 6250, "name": "onlyFactory", "nodeType": "ModifierDefinition", "parameters": { "id": 6234, "nodeType": "ParameterList", "parameters": [], "src": "1343:2:18" }, "src": "1323:245:18", "visibility": "internal" } ], "scope": 6252, "src": "274:1296:18" } ], "src": "0:1571:18" }, "legacyAST": { "attributes": { "absolutePath": "/home/runner/work/tbtc/tbtc/solidity/contracts/system/DepositFactoryAuthority.sol", "exportedSymbols": { "DepositFactoryAuthority": [ 6251 ] } }, "children": [ { "attributes": { "literals": [ "solidity", "0.5", ".17" ] }, "id": 6199, "name": "PragmaDirective", "src": "0:23:18" }, { "attributes": { "baseContracts": [ null ], "contractDependencies": [ null ], "contractKind": "contract", "documentation": "@title Deposit Factory Authority\n @notice Contract to secure function calls to the Deposit Factory.\n @dev Secured by setting the depositFactory address and using the onlyFactory\n modifier on functions requiring restriction.", "fullyImplemented": true, "linearizedBaseContracts": [ 6251 ], "name": "DepositFactoryAuthority", "scope": 6252 }, "children": [ { "attributes": { "constant": false, "name": "_initialized", "scope": 6251, "stateVariable": true, "storageLocation": "default", "type": "bool", "visibility": "internal" }, "children": [ { "attributes": { "name": "bool", "type": "bool" }, "id": 6200, "name": "ElementaryTypeName", "src": "313:4:18" }, { "attributes": { "argumentTypes": null, "hexvalue": "66616c7365", "isConstant": false, "isLValue": false, "isPure": true, "lValueRequested": false, "subdenomination": null, "token": "bool", "type": "bool", "value": "false" }, "id": 6201, "name": "Literal", "src": "342:5:18" } ], "id": 6202, "name": "VariableDeclaration", "src": "313:34:18" }, { "attributes": { "constant": false, "name": "_depositFactory", "scope": 6251, "stateVariable": true, "storageLocation": "default", "type": "address", "value": null, "visibility": "internal" }, "children": [ { "attributes": { "name": "address", "stateMutability": "nonpayable", "type": "address" }, "id": 6203, "name": "ElementaryTypeName", "src": "353:7:18" } ], "id": 6204, "name": "VariableDeclaration", "src": "353:32:18" }, { "attributes": { "documentation": "@notice Set the address of the System contract on contract\n initialization.\n @dev Since this function is not access-controlled, it should be called\n transactionally with contract instantiation. In cases where a\n regular contract directly inherits from DepositFactoryAuthority,\n that should happen in the constructor. In cases where the inheritor\n is binstead used via a clone factory, the same function that\n creates a new clone should also trigger initialization.", "implemented": true, "isConstructor": false, "kind": "function", "modifiers": [ null ], "name": "initialize", "scope": 6251, "stateMutability": "nonpayable", "superFunction": null, "visibility": "public" }, "children": [ { "children": [ { "attributes": { "constant": false, "name": "_factory", "scope": 6233, "stateVariable": false, "storageLocation": "default", "type": "address", "value": null, "visibility": "internal" }, "children": [ { "attributes": { "name": "address", "stateMutability": "nonpayable", "type": "address" }, "id": 6205, "name": "ElementaryTypeName", "src": "967:7:18" } ], "id": 6206, "name": "VariableDeclaration", "src": "967:16:18" } ], "id": 6207, "name": "ParameterList", "src": "966:18:18" }, { "attributes": { "parameters": [ null ] }, "children": [], "id": 6208, "name": "ParameterList", "src": "992:0:18" }, { "children": [ { "children": [ { "attributes": { "argumentTypes": null, "isConstant": false, "isLValue": false, "isPure": false, "isStructConstructorCall": false, "lValueRequested": false, "names": [ null ], "type": "tuple()", "type_conversion": false }, "children": [ { "attributes": { "argumentTypes": [ { "typeIdentifier": "t_bool", "typeString": "bool" }, { "typeIdentifier": "t_stringliteral_2bd3cbc23ffb44d3580484075b016a2d908a32b5541fab8a3134aa94a7c5ffa6", "typeString": "literal_string \"Factory cannot be the zero address.\"" } ], "overloadedDeclarations": [ 18363, 18364 ], "referencedDeclaration": 18364, "type": "function (bool,string memory) pure", "value": "require" }, "id": 6209, "name": "Identifier", "src": "1002:7:18" }, { "attributes": { "argumentTypes": null, "commonType": { "typeIdentifier": "t_address", "typeString": "address" }, "isConstant": false, "isLValue": false, "isPure": false, "lValueRequested": false, "operator": "!=", "type": "bool" }, "children": [ { "attributes": { "argumentTypes": null, "overloadedDeclarations": [ null ], "referencedDeclaration": 6206, "type": "address", "value": "_factory" }, "id": 6210, "name": "Identifier", "src": "1010:8:18" }, { "attributes": { "argumentTypes": null, "isConstant": false, "isLValue": false, "isPure": true, "isStructConstructorCall": false, "lValueRequested": false, "names": [ null ], "type": "address payable", "type_conversion": true }, "children": [ { "attributes": { "argumentTypes": [ { "typeIdentifier": "t_rational_0_by_1", "typeString": "int_const 0" } ], "isConstant": false, "isLValue": false, "isPure": true, "lValueRequested": false, "type": "type(address)", "value": "address" }, "id": 6211, "name": "ElementaryTypeNameExpression", "src": "1022:7:18" }, { "attributes": { "argumentTypes": null, "hexvalue": "30", "isConstant": false, "isLValue": false, "isPure": true, "lValueRequested": false, "subdenomination": null, "token": "number", "type": "int_const 0", "value": "0" }, "id": 6212, "name": "Literal", "src": "1030:1:18" } ], "id": 6213, "name": "FunctionCall", "src": "1022:10:18" } ], "id": 6214, "name": "BinaryOperation", "src": "1010:22:18" }, { "attributes": { "argumentTypes": null, "hexvalue": "466163746f72792063616e6e6f7420626520746865207a65726f20616464726573732e", "isConstant": false, "isLValue": false, "isPure": true, "lValueRequested": false, "subdenomination": null, "token": "string", "type": "literal_string \"Factory cannot be the zero address.\"", "value": "Factory cannot be the zero address." }, "id": 6215, "name": "Literal", "src": "1034:37:18" } ], "id": 6216, "name": "FunctionCall", "src": "1002:70:18" } ], "id": 6217, "name": "ExpressionStatement", "src": "1002:70:18" }, { "children": [ { "attributes": { "argumentTypes": null, "isConstant": false, "isLValue": false, "isPure": false, "isStructConstructorCall": false, "lValueRequested": false, "names": [ null ], "type": "tuple()", "type_conversion": false }, "children": [ { "attributes": { "argumentTypes": [ { "typeIdentifier": "t_bool", "typeString": "bool" }, { "typeIdentifier": "t_stringliteral_ce00edb2a923848081003b8039d197b6044b329e1d83ed238dca317d015c0159", "typeString": "literal_string \"Factory can only be initialized once.\"" } ], "overloadedDeclarations": [ 18363, 18364 ], "referencedDeclaration": 18364, "type": "function (bool,string memory) pure", "value": "require" }, "id": 6218, "name": "Identifier", "src": "1082:7:18" }, { "attributes": { "argumentTypes": null, "isConstant": false, "isLValue": false, "isPure": false, "lValueRequested": false, "operator": "!", "prefix": true, "type": "bool" }, "children": [ { "attributes": { "argumentTypes": null, "overloadedDeclarations": [ null ], "referencedDeclaration": 6202, "type": "bool", "value": "_initialized" }, "id": 6219, "name": "Identifier", "src": "1091:12:18" } ], "id": 6220, "name": "UnaryOperation", "src": "1090:13:18" }, { "attributes": { "argumentTypes": null, "hexvalue": "466163746f72792063616e206f6e6c7920626520696e697469616c697a6564206f6e63652e", "isConstant": false, "isLValue": false, "isPure": true, "lValueRequested": false, "subdenomination": null, "token": "string", "type": "literal_string \"Factory can only be initialized once.\"", "value": "Factory can only be initialized once." }, "id": 6221, "name": "Literal", "src": "1105:39:18" } ], "id": 6222, "name": "FunctionCall", "src": "1082:63:18" } ], "id": 6223, "name": "ExpressionStatement", "src": "1082:63:18" }, { "children": [ { "attributes": { "argumentTypes": null, "isConstant": false, "isLValue": false, "isPure": false, "lValueRequested": false, "operator": "=", "type": "address" }, "children": [ { "attributes": { "argumentTypes": null, "overloadedDeclarations": [ null ], "referencedDeclaration": 6204, "type": "address", "value": "_depositFactory" }, "id": 6224, "name": "Identifier", "src": "1156:15:18" }, { "attributes": { "argumentTypes": null, "overloadedDeclarations": [ null ], "referencedDeclaration": 6206, "type": "address", "value": "_factory" }, "id": 6225, "name": "Identifier", "src": "1174:8:18" } ], "id": 6226, "name": "Assignment", "src": "1156:26:18" } ], "id": 6227, "name": "ExpressionStatement", "src": "1156:26:18" }, { "children": [ { "attributes": { "argumentTypes": null, "isConstant": false, "isLValue": false, "isPure": false, "lValueRequested": false, "operator": "=", "type": "bool" }, "children": [ { "attributes": { "argumentTypes": null, "overloadedDeclarations": [ null ], "referencedDeclaration": 6202, "type": "bool", "value": "_initialized" }, "id": 6228, "name": "Identifier", "src": "1192:12:18" }, { "attributes": { "argumentTypes": null, "hexvalue": "74727565", "isConstant": false, "isLValue": false, "isPure": true, "lValueRequested": false, "subdenomination": null, "token": "bool", "type": "bool", "value": "true" }, "id": 6229, "name": "Literal", "src": "1207:4:18" } ], "id": 6230, "name": "Assignment", "src": "1192:19:18" } ], "id": 6231, "name": "ExpressionStatement", "src": "1192:19:18" } ], "id": 6232, "name": "Block", "src": "992:226:18" } ], "id": 6233, "name": "FunctionDefinition", "src": "947:271:18" }, { "attributes": { "documentation": "@notice Function modifier ensures modified function is only called by set deposit factory.", "name": "onlyFactory", "visibility": "internal" }, "children": [ { "attributes": { "parameters": [ null ] }, "children": [], "id": 6234, "name": "ParameterList", "src": "1343:2:18" }, { "children": [ { "children": [ { "attributes": { "argumentTypes": null, "isConstant": false, "isLValue": false, "isPure": false, "isStructConstructorCall": false, "lValueRequested": false, "names": [ null ], "type": "tuple()", "type_conversion": false }, "children": [ { "attributes": { "argumentTypes": [ { "typeIdentifier": "t_bool", "typeString": "bool" }, { "typeIdentifier": "t_stringliteral_ec839c8c5c6b5e827d48fd88aa465bf1aeb67fc299bceed306c2fedd287c2af1", "typeString": "literal_string \"Factory initialization must have been called.\"" } ], "overloadedDeclarations": [ 18363, 18364 ], "referencedDeclaration": 18364, "type": "function (bool,string memory) pure", "value": "require" }, "id": 6235, "name": "Identifier", "src": "1356:7:18" }, { "attributes": { "argumentTypes": null, "overloadedDeclarations": [ null ], "referencedDeclaration": 6202, "type": "bool", "value": "_initialized" }, "id": 6236, "name": "Identifier", "src": "1364:12:18" }, { "attributes": { "argumentTypes": null, "hexvalue": "466163746f727920696e697469616c697a6174696f6e206d7573742068617665206265656e2063616c6c65642e", "isConstant": false, "isLValue": false, "isPure": true, "lValueRequested": false, "subdenomination": null, "token": "string", "type": "literal_string \"Factory initialization must have been called.\"", "value": "Factory initialization must have been called." }, "id": 6237, "name": "Literal", "src": "1378:47:18" } ], "id": 6238, "name": "FunctionCall", "src": "1356:70:18" } ], "id": 6239, "name": "ExpressionStatement", "src": "1356:70:18" }, { "children": [ { "attributes": { "argumentTypes": null, "isConstant": false, "isLValue": false, "isPure": false, "isStructConstructorCall": false, "lValueRequested": false, "names": [ null ], "type": "tuple()", "type_conversion": false }, "children": [ { "attributes": { "argumentTypes": [ { "typeIdentifier": "t_bool", "typeString": "bool" }, { "typeIdentifier": "t_stringliteral_e0ecc7208047a6683867d6b9737c2935cc89cb774fe5f25ab7ade7c78861ee44", "typeString": "literal_string \"Caller must be depositFactory contract\"" } ], "overloadedDeclarations": [ 18363, 18364 ], "referencedDeclaration": 18364, "type": "function (bool,string memory) pure", "value": "require" }, "id": 6240, "name": "Identifier", "src": "1436:7:18" }, { "attributes": { "argumentTypes": null, "commonType": { "typeIdentifier": "t_address", "typeString": "address" }, "isConstant": false, "isLValue": false, "isPure": false, "lValueRequested": false, "operator": "==", "type": "bool" }, "children": [ { "attributes": { "argumentTypes": null, "isConstant": false, "isLValue": false, "isPure": false, "lValueRequested": false, "member_name": "sender", "referencedDeclaration": null, "type": "address payable" }, "children": [ { "attributes": { "argumentTypes": null, "overloadedDeclarations": [ null ], "referencedDeclaration": 18360, "type": "msg", "value": "msg" }, "id": 6241, "name": "Identifier", "src": "1457:3:18" } ], "id": 6242, "name": "MemberAccess", "src": "1457:10:18" }, { "attributes": { "argumentTypes": null, "overloadedDeclarations": [ null ], "referencedDeclaration": 6204, "type": "address", "value": "_depositFactory" }, "id": 6243, "name": "Identifier", "src": "1471:15:18" } ], "id": 6244, "name": "BinaryOperation", "src": "1457:29:18" }, { "attributes": { "argumentTypes": null, "hexvalue": "43616c6c6572206d757374206265206465706f736974466163746f727920636f6e7472616374", "isConstant": false, "isLValue": false, "isPure": true, "lValueRequested": false, "subdenomination": null, "token": "string", "type": "literal_string \"Caller must be depositFactory contract\"", "value": "Caller must be depositFactory contract" }, "id": 6245, "name": "Literal", "src": "1500:40:18" } ], "id": 6246, "name": "FunctionCall", "src": "1436:114:18" } ], "id": 6247, "name": "ExpressionStatement", "src": "1436:114:18" }, { "id": 6248, "name": "PlaceholderStatement", "src": "1560:1:18" } ], "id": 6249, "name": "Block", "src": "1346:222:18" } ], "id": 6250, "name": "ModifierDefinition", "src": "1323:245:18" } ], "id": 6251, "name": "ContractDefinition", "src": "274:1296:18" } ], "id": 6252, "name": "SourceUnit", "src": "0:1571:18" }, "compiler": { "name": "solc", "version": "0.5.17+commit.d19bba13.Emscripten.clang" }, "networks": {}, "schemaVersion": "3.3.4", "updatedAt": "2021-11-23T11:52:09.285Z", "devdoc": { "details": "Secured by setting the depositFactory address and using the onlyFactory modifier on functions requiring restriction.", "methods": { "initialize(address)": { "details": "Since this function is not access-controlled, it should be called transactionally with contract instantiation. In cases where a regular contract directly inherits from DepositFactoryAuthority, that should happen in the constructor. In cases where the inheritor is binstead used via a clone factory, the same function that creates a new clone should also trigger initialization." } }, "title": "Deposit Factory Authority" }, "userdoc": { "methods": { "initialize(address)": { "notice": "Set the address of the System contract on contract initialization." } }, "notice": "Contract to secure function calls to the Deposit Factory." } }