@etherisc/gif-next 0.0.2-a1053ad-624 → 0.0.2-a25e4b8-781

package/README.md

@@ -51,7 +51,7 @@ hh docgen
 The resulting markdown files are written to `docs`
 
 
-### Deployment 
+### Full protocol deployment 
 
 Install the dependencies before running the script below for the first time.
 
@@ -81,6 +81,25 @@ Environment variables:
 - `WALLET_MNEMONIC` the mnemonic of the wallet to use for deployment (required for mumbai and mainnet)
 - `ETHERSCAN_API_KEY` `POLYGONSCAN_API_KEY` the api key for etherscan/polygonscan (required for mumbai and mainnet)
 
+### Create a new instance
+
+Requires previous step to be completed. 
+
+```bash
+# set appropriate values vor env variables (see below)
+
+hh run --network <networkname> scripts/new_instance.ts
+```
+
+Currently an HD wallet is expected to be used for the deployment. The mnemonic of the wallet needs to be provided via the `WALLET_MNEMONIC` environment variable. 
+The instance owner will be the 11th address of the wallet.
+
+Environment variables:
+
+- `WEB3_INFURA_PROJECT_ID` set to infura project id (required for mumbai and mainnet)
+- `WALLET_MNEMONIC` the mnemonic of the wallet to use for deployment (required for mumbai and mainnet)
+- `REGISTRY_ADDRESS` the address of the registry that is already deployed and configured and has a valid master instance
+
 
 ### Console
 
@@ -119,7 +138,11 @@ forge test -vvvv --mt test_decimals
 # provide gas report for a single test
 forge test --mt test_decimals --gas-report
 
+# provide code coverage report
 forge coverage
+forge coverage --report lcov 
+
+
 ```
 
 Chisel session
@@ -415,3 +438,46 @@ Distribution Service
 - registered via registry service by registry owner
 - registers distribution components for registered products via registry service by distribution owner (distribution owner role is permissend by the product's instance)
 - registers distributors for registered distribution components via registry service
+
+## Contract Organisation
+
+now 
+
+contracts
+  components
+  instance
+  registry
+  shared
+  types
+
+
+contracts
+  component
+    pool
+      Pool.sol
+      PoolService.sol
+    oracle
+    distribution
+    product
+      Product.sol
+      ProductService.sol
+    Component.sol
+    ComponentService.sol
+  instance
+    Instance.sol
+    InstanceAccessManager.sol
+    InstanceReader.sol
+    InstanceService.sol
+    InstanceServiceManager.sol
+  registry
+    ChainNft.sol
+    Registry.sol
+    RegistryService.sol
+    RegistryServiceManager.sol
+  shared
+    Registerable.sol
+    RegisterableUpgradable.sol
+  type
+    NftId.sol
+    ObjectType.sol
+

package/artifacts/contracts/components/Component.sol/Component.dbg.json

@@ -0,0 +1,4 @@
+{
+  "_format": "hh-sol-dbg-1",
+  "buildInfo": "../../../build-info/e54a45d99367d9556932f13b1554e20b.json"
+}

package/artifacts/contracts/{instance/service/IComponentOwnerService.sol/IComponentOwnerService.json → components/Component.sol/Component.json}

@@ -1,8 +1,68 @@
 {
   "_format": "hh-sol-artifact-1",
-  "contractName": "IComponentOwnerService",
-  "sourceName": "contracts/instance/service/IComponentOwnerService.sol",
+  "contractName": "Component",
+  "sourceName": "contracts/components/Component.sol",
   "abi": [
+    {
+      "inputs": [
+        {
+          "internalType": "address",
+          "name": "authority",
+          "type": "address"
+        }
+      ],
+      "name": "AccessManagedInvalidAuthority",
+      "type": "error"
+    },
+    {
+      "inputs": [
+        {
+          "internalType": "address",
+          "name": "caller",
+          "type": "address"
+        },
+        {
+          "internalType": "uint32",
+          "name": "delay",
+          "type": "uint32"
+        }
+      ],
+      "name": "AccessManagedRequiredDelay",
+      "type": "error"
+    },
+    {
+      "inputs": [
+        {
+          "internalType": "address",
+          "name": "caller",
+          "type": "address"
+        }
+      ],
+      "name": "AccessManagedUnauthorized",
+      "type": "error"
+    },
+    {
+      "inputs": [
+        {
+          "internalType": "address",
+          "name": "target",
+          "type": "address"
+        }
+      ],
+      "name": "AddressEmptyCode",
+      "type": "error"
+    },
+    {
+      "inputs": [
+        {
+          "internalType": "address",
+          "name": "account",
+          "type": "address"
+        }
+      ],
+      "name": "AddressInsufficientBalance",
+      "type": "error"
+    },
     {
       "inputs": [
         {
@@ -19,6 +79,75 @@
       "name": "ErrorAlreadyLinked",
       "type": "error"
     },
+    {
+      "inputs": [
+        {
+          "internalType": "address",
+          "name": "caller",
+          "type": "address"
+        }
+      ],
+      "name": "ErrorComponentNotProductService",
+      "type": "error"
+    },
+    {
+      "inputs": [],
+      "name": "ErrorComponentProductNftAlreadySet",
+      "type": "error"
+    },
+    {
+      "inputs": [
+        {
+          "internalType": "address",
+          "name": "caller",
+          "type": "address"
+        },
+        {
+          "internalType": "uint64",
+          "name": "requiredRoleIdNum",
+          "type": "uint64"
+        }
+      ],
+      "name": "ErrorComponentUnauthorized",
+      "type": "error"
+    },
+    {
+      "inputs": [
+        {
+          "internalType": "address",
+          "name": "newWallet",
+          "type": "address"
+        }
+      ],
+      "name": "ErrorComponentWalletAddressIsSameAsCurrent",
+      "type": "error"
+    },
+    {
+      "inputs": [
+        {
+          "internalType": "address",
+          "name": "oldWallet",
+          "type": "address"
+        },
+        {
+          "internalType": "address",
+          "name": "newWallet",
+          "type": "address"
+        },
+        {
+          "internalType": "uint256",
+          "name": "allowance",
+          "type": "uint256"
+        },
+        {
+          "internalType": "uint256",
+          "name": "balance",
+          "type": "uint256"
+        }
+      ],
+      "name": "ErrorComponentWalletAllowanceTooSmall",
+      "type": "error"
+    },
     {
       "inputs": [
         {
@@ -52,6 +181,17 @@
       "name": "ErrorNotRegistry",
       "type": "error"
     },
+    {
+      "inputs": [
+        {
+          "internalType": "address",
+          "name": "registryAddress",
+          "type": "address"
+        }
+      ],
+      "name": "ErrorRegisterableNotRegistry",
+      "type": "error"
+    },
     {
       "inputs": [],
       "name": "ErrorRegistryAddressZero",
@@ -73,31 +213,122 @@
       "name": "ErrorRegistryNotInitialized",
       "type": "error"
     },
+    {
+      "inputs": [],
+      "name": "FailedInnerCall",
+      "type": "error"
+    },
+    {
+      "inputs": [],
+      "name": "InvalidInitialization",
+      "type": "error"
+    },
+    {
+      "inputs": [],
+      "name": "NotInitializing",
+      "type": "error"
+    },
+    {
+      "inputs": [
+        {
+          "internalType": "address",
+          "name": "token",
+          "type": "address"
+        }
+      ],
+      "name": "SafeERC20FailedOperation",
+      "type": "error"
+    },
     {
       "anonymous": false,
       "inputs": [
         {
           "indexed": false,
-          "internalType": "Version",
+          "internalType": "address",
+          "name": "authority",
+          "type": "address"
+        }
+      ],
+      "name": "AuthorityUpdated",
+      "type": "event"
+    },
+    {
+      "anonymous": false,
+      "inputs": [
+        {
+          "indexed": false,
+          "internalType": "uint64",
           "name": "version",
-          "type": "uint24"
-        },
+          "type": "uint64"
+        }
+      ],
+      "name": "Initialized",
+      "type": "event"
+    },
+    {
+      "anonymous": false,
+      "inputs": [
+        {
+          "indexed": false,
+          "internalType": "address",
+          "name": "newWallet",
+          "type": "address"
+        }
+      ],
+      "name": "LogComponentWalletAddressChanged",
+      "type": "event"
+    },
+    {
+      "anonymous": false,
+      "inputs": [
         {
           "indexed": false,
           "internalType": "address",
-          "name": "implementation",
+          "name": "from",
           "type": "address"
         },
         {
           "indexed": false,
           "internalType": "address",
-          "name": "activatedBy",
+          "name": "to",
           "type": "address"
+        },
+        {
+          "indexed": false,
+          "internalType": "uint256",
+          "name": "amount",
+          "type": "uint256"
         }
       ],
-      "name": "LogVersionableInitialized",
+      "name": "LogComponentWalletTokensTransferred",
       "type": "event"
     },
+    {
+      "inputs": [],
+      "name": "REGISTERABLE_LOCATION_V1",
+      "outputs": [
+        {
+          "internalType": "bytes32",
+          "name": "",
+          "type": "bytes32"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
+    {
+      "inputs": [],
+      "name": "authority",
+      "outputs": [
+        {
+          "internalType": "address",
+          "name": "",
+          "type": "address"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
     {
       "inputs": [],
       "name": "getInitialInfo",
@@ -155,25 +386,12 @@
     },
     {
       "inputs": [],
-      "name": "getInitializedVersion",
+      "name": "getInstance",
       "outputs": [
         {
-          "internalType": "uint64",
-          "name": "",
-          "type": "uint64"
-        }
-      ],
-      "stateMutability": "view",
-      "type": "function"
-    },
-    {
-      "inputs": [],
-      "name": "getMajorVersion",
-      "outputs": [
-        {
-          "internalType": "VersionPart",
-          "name": "majorVersion",
-          "type": "uint8"
+          "internalType": "contract IInstance",
+          "name": "instance",
+          "type": "address"
         }
       ],
       "stateMutability": "view",
@@ -220,63 +438,51 @@
     },
     {
       "inputs": [],
-      "name": "getRegistry",
+      "name": "getProductNftId",
       "outputs": [
         {
-          "internalType": "contract IRegistry",
-          "name": "",
-          "type": "address"
+          "internalType": "NftId",
+          "name": "productNftId",
+          "type": "uint96"
         }
       ],
       "stateMutability": "view",
       "type": "function"
     },
     {
-      "inputs": [
-        {
-          "internalType": "ObjectType",
-          "name": "cType",
-          "type": "uint8"
-        }
-      ],
-      "name": "getRoleForType",
+      "inputs": [],
+      "name": "getRegistry",
       "outputs": [
         {
-          "internalType": "RoleId",
-          "name": "role",
-          "type": "uint64"
+          "internalType": "contract IRegistry",
+          "name": "",
+          "type": "address"
         }
       ],
-      "stateMutability": "pure",
+      "stateMutability": "view",
       "type": "function"
     },
     {
       "inputs": [],
-      "name": "getVersion",
+      "name": "getToken",
       "outputs": [
         {
-          "internalType": "Version",
-          "name": "",
-          "type": "uint24"
+          "internalType": "contract IERC20Metadata",
+          "name": "token",
+          "type": "address"
         }
       ],
-      "stateMutability": "pure",
+      "stateMutability": "view",
       "type": "function"
     },
     {
-      "inputs": [
-        {
-          "internalType": "uint256",
-          "name": "index",
-          "type": "uint256"
-        }
-      ],
-      "name": "getVersion",
+      "inputs": [],
+      "name": "getWallet",
       "outputs": [
         {
-          "internalType": "Version",
-          "name": "version",
-          "type": "uint24"
+          "internalType": "address",
+          "name": "walletAddress",
+          "type": "address"
         }
       ],
       "stateMutability": "view",
@@ -284,82 +490,40 @@
     },
     {
       "inputs": [],
-      "name": "getVersionCount",
+      "name": "isConsumingScheduledOp",
       "outputs": [
         {
-          "internalType": "uint256",
-          "name": "numberOfVersions",
-          "type": "uint256"
+          "internalType": "bytes4",
+          "name": "",
+          "type": "bytes4"
         }
       ],
       "stateMutability": "view",
       "type": "function"
     },
     {
-      "inputs": [
-        {
-          "internalType": "Version",
-          "name": "version",
-          "type": "uint24"
-        }
-      ],
-      "name": "getVersionInfo",
-      "outputs": [
-        {
-          "components": [
-            {
-              "internalType": "Version",
-              "name": "version",
-              "type": "uint24"
-            },
-            {
-              "internalType": "address",
-              "name": "implementation",
-              "type": "address"
-            },
-            {
-              "internalType": "address",
-              "name": "activatedBy",
-              "type": "address"
-            },
-            {
-              "internalType": "Timestamp",
-              "name": "activatedAt",
-              "type": "uint40"
-            },
-            {
-              "internalType": "Blocknumber",
-              "name": "activatedIn",
-              "type": "uint32"
-            }
-          ],
-          "internalType": "struct IVersionable.VersionInfo",
-          "name": "versionInfo",
-          "type": "tuple"
-        }
-      ],
-      "stateMutability": "view",
+      "inputs": [],
+      "name": "linkToRegisteredNftId",
+      "outputs": [],
+      "stateMutability": "nonpayable",
+      "type": "function"
+    },
+    {
+      "inputs": [],
+      "name": "lock",
+      "outputs": [],
+      "stateMutability": "nonpayable",
       "type": "function"
     },
     {
       "inputs": [
         {
           "internalType": "address",
-          "name": "implementation",
+          "name": "newAuthority",
           "type": "address"
-        },
-        {
-          "internalType": "address",
-          "name": "activatedBy",
-          "type": "address"
-        },
-        {
-          "internalType": "bytes",
-          "name": "activationData",
-          "type": "bytes"
         }
       ],
-      "name": "initialize",
+      "name": "setAuthority",
       "outputs": [],
       "stateMutability": "nonpayable",
       "type": "function"
@@ -367,25 +531,12 @@
     {
       "inputs": [
         {
-          "internalType": "Version",
-          "name": "version",
-          "type": "uint24"
-        }
-      ],
-      "name": "isInitialized",
-      "outputs": [
-        {
-          "internalType": "bool",
-          "name": "",
-          "type": "bool"
+          "internalType": "NftId",
+          "name": "productNftId",
+          "type": "uint96"
         }
       ],
-      "stateMutability": "view",
-      "type": "function"
-    },
-    {
-      "inputs": [],
-      "name": "linkToRegisteredNftId",
+      "name": "setProductNftId",
       "outputs": [],
       "stateMutability": "nonpayable",
       "type": "function"
@@ -393,12 +544,12 @@
     {
       "inputs": [
         {
-          "internalType": "contract IBaseComponent",
-          "name": "component",
+          "internalType": "address",
+          "name": "newWallet",
           "type": "address"
         }
       ],
-      "name": "lock",
+      "name": "setWallet",
       "outputs": [],
       "stateMutability": "nonpayable",
       "type": "function"
@@ -423,40 +574,11 @@
       "type": "function"
     },
     {
-      "inputs": [
-        {
-          "internalType": "contract IBaseComponent",
-          "name": "component",
-          "type": "address"
-        }
-      ],
+      "inputs": [],
       "name": "unlock",
       "outputs": [],
       "stateMutability": "nonpayable",
       "type": "function"
-    },
-    {
-      "inputs": [
-        {
-          "internalType": "address",
-          "name": "implementation",
-          "type": "address"
-        },
-        {
-          "internalType": "address",
-          "name": "activatedBy",
-          "type": "address"
-        },
-        {
-          "internalType": "bytes",
-          "name": "upgradeData",
-          "type": "bytes"
-        }
-      ],
-      "name": "upgrade",
-      "outputs": [],
-      "stateMutability": "nonpayable",
-      "type": "function"
     }
   ],
   "bytecode": "0x",

package/artifacts/contracts/components/Distribution.sol/Distribution.dbg.json

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/87bb0e6336af67aff324941d5e57b181.json"
+  "buildInfo": "../../../build-info/e54a45d99367d9556932f13b1554e20b.json"
 }