@etherisc/gif-next 0.0.2-4e6a781-730 → 0.0.2-4e99ed1-062

package/README.md

@@ -1,5 +1,6 @@
 # GIF-Next (Generic Insurance Framework, next version)
 
+
 ## Add OpenZeppelin V5 Dependencies
 
 ```shell
@@ -27,6 +28,10 @@ This repository uses submodules. To checkout or update to the latest submodules,
 git submodule update --recursive
 ```
 
+## Example components
+
+A (very early) example of a product and a pool can be found in the [gif-next-sandbox repository](https://github.com/etherisc/gif-next-sandbox). 
+
 ## Hardhat 
 
 ### NPM Commands
@@ -219,17 +224,7 @@ https://book.getfoundry.sh/reference/
 
 ## Style Guide
 
-Solidity code is to be written according to the [Solidity Style Guide](https://docs.soliditylang.org/en/latest/style-guide.html).
-
-Documentation of the code should be written inline using [NatSpec](https://docs.soliditylang.org/en/latest/natspec-format.html).
-
-### Naming conventions
-
-Additionally, we use the following naming conventions:
-
-- Function arguments and return types: If using custom data types, make the name include the type by appending the Type to the argument name, e.g. `function getInfo(NftId bundleNftId)` instead of `function getInfo(NftId bundleId)`. Background: Custom data types are lost when using the ABI or Typescript binding classes (e.g. instead of `NftID` a `uint96` is used), so the type needs to be included in the name to make it clear what the argument is without having to look at the documentation or checking the solidity source code. 
-- When naming a field or an attribute `id` and the context is not clear, call it `nftId` instead so its clear what type if id it is as there will be multiple ids for different kind of objects. Example: if you the function has a bundle nft id and a policy nft id as arguments, call them `bundleNftId` and `policyNftId` instead of `id` and `policyId`. In case of doubt, be a bit more verbose for the sake of clarity. 
-- When naming things, remember that the code will likely be used in Javascript/Typescript as well, so avoid names that are reserved in Javascript/Typescript. A list of reserved words in Javascript can be found [here](https://www.w3schools.com/js/js_reserved.asp) and a list of reserved words in Typescript can be found [here](https://www.tektutorialshub.com/typescript/identifiers-keywords-in-typescript/). 
+Please see https://docs.etherisc.com/gif-next/3.x/ for style guide and general coding rules. 
 
 ### Automatic code formatting
 
@@ -244,7 +239,7 @@ We use solhint to lint the code.
 To execute linting run `npm run lint`.
 
 
-### Adding Brownie (Legacy)
+### Adding Brownie (Legacy - don't do that :wink: )
 
 python3 is already installed
 
@@ -394,7 +389,7 @@ Intercepting property
 
 ### Pool
 
-### Distribution
+### Distribution
 
 ### Oracle
 

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

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

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

@@ -67,16 +67,11 @@
       "inputs": [
         {
           "internalType": "address",
-          "name": "registry",
+          "name": "caller",
           "type": "address"
-        },
-        {
-          "internalType": "NftId",
-          "name": "nftId",
-          "type": "uint96"
         }
       ],
-      "name": "ErrorAlreadyLinked",
+      "name": "ErrorComponentNotChainNft",
       "type": "error"
     },
     {
@@ -85,11 +80,6 @@
           "internalType": "NftId",
           "name": "instanceNftId",
           "type": "uint96"
-        },
-        {
-          "internalType": "address",
-          "name": "instance",
-          "type": "address"
         }
       ],
       "name": "ErrorComponentNotInstance",
@@ -112,29 +102,7 @@
       "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"
-        }
-      ],
+      "inputs": [],
       "name": "ErrorComponentWalletAddressIsSameAsCurrent",
       "type": "error"
     },
@@ -172,66 +140,50 @@
     {
       "inputs": [
         {
-          "internalType": "address",
-          "name": "contractAddress",
-          "type": "address"
+          "internalType": "NftId",
+          "name": "nftId",
+          "type": "uint96"
         }
       ],
-      "name": "ErrorContractNotRegistered",
+      "name": "ErrorNftOwnableAlreadyLinked",
       "type": "error"
     },
     {
       "inputs": [
         {
           "internalType": "address",
-          "name": "account",
+          "name": "contractAddress",
           "type": "address"
         }
       ],
-      "name": "ErrorNotOwner",
+      "name": "ErrorNftOwnableContractNotRegistered",
       "type": "error"
     },
     {
-      "inputs": [
-        {
-          "internalType": "address",
-          "name": "registryAddress",
-          "type": "address"
-        }
-      ],
-      "name": "ErrorNotRegistry",
+      "inputs": [],
+      "name": "ErrorNftOwnableInitialOwnerZero",
       "type": "error"
     },
     {
       "inputs": [
         {
           "internalType": "address",
-          "name": "registryAddress",
+          "name": "account",
           "type": "address"
         }
       ],
-      "name": "ErrorRegisterableNotRegistry",
-      "type": "error"
-    },
-    {
-      "inputs": [],
-      "name": "ErrorRegistryAddressZero",
+      "name": "ErrorNftOwnableNotOwner",
       "type": "error"
     },
     {
       "inputs": [
         {
           "internalType": "address",
-          "name": "registry",
+          "name": "registryAddress",
           "type": "address"
         }
       ],
-      "name": "ErrorRegistryAlreadyInitialized",
-      "type": "error"
-    },
-    {
-      "inputs": [],
-      "name": "ErrorRegistryNotInitialized",
+      "name": "ErrorNotRegistry",
       "type": "error"
     },
     {
@@ -289,6 +241,12 @@
     {
       "anonymous": false,
       "inputs": [
+        {
+          "indexed": false,
+          "internalType": "address",
+          "name": "oldWallet",
+          "type": "address"
+        },
         {
           "indexed": false,
           "internalType": "address",
@@ -326,7 +284,20 @@
     },
     {
       "inputs": [],
-      "name": "CONTRACT_LOCATION_V1",
+      "name": "COMPONENT_LOCATION_V1",
+      "outputs": [
+        {
+          "internalType": "bytes32",
+          "name": "",
+          "type": "bytes32"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
+    {
+      "inputs": [],
+      "name": "NFT_OWNABLE_STORAGE_LOCATION_V1",
       "outputs": [
         {
           "internalType": "bytes32",
@@ -363,6 +334,56 @@
       "stateMutability": "view",
       "type": "function"
     },
+    {
+      "inputs": [],
+      "name": "getComponentInfo",
+      "outputs": [
+        {
+          "components": [
+            {
+              "internalType": "string",
+              "name": "name",
+              "type": "string"
+            },
+            {
+              "internalType": "contract IERC20Metadata",
+              "name": "token",
+              "type": "address"
+            },
+            {
+              "internalType": "contract TokenHandler",
+              "name": "tokenHandler",
+              "type": "address"
+            },
+            {
+              "internalType": "address",
+              "name": "wallet",
+              "type": "address"
+            },
+            {
+              "internalType": "Amount",
+              "name": "balanceAmount",
+              "type": "uint96"
+            },
+            {
+              "internalType": "Amount",
+              "name": "feeAmount",
+              "type": "uint96"
+            },
+            {
+              "internalType": "bytes",
+              "name": "data",
+              "type": "bytes"
+            }
+          ],
+          "internalType": "struct IComponents.ComponentInfo",
+          "name": "info",
+          "type": "tuple"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
     {
       "inputs": [],
       "name": "getInitialInfo",
@@ -413,19 +434,6 @@
       "stateMutability": "view",
       "type": "function"
     },
-    {
-      "inputs": [],
-      "name": "getInitialOwner",
-      "outputs": [
-        {
-          "internalType": "address",
-          "name": "",
-          "type": "address"
-        }
-      ],
-      "stateMutability": "view",
-      "type": "function"
-    },
     {
       "inputs": [],
       "name": "getInstance",
@@ -439,19 +447,6 @@
       "stateMutability": "view",
       "type": "function"
     },
-    {
-      "inputs": [],
-      "name": "getInstanceService",
-      "outputs": [
-        {
-          "internalType": "contract IInstanceService",
-          "name": "",
-          "type": "address"
-        }
-      ],
-      "stateMutability": "view",
-      "type": "function"
-    },
     {
       "inputs": [],
       "name": "getName",
@@ -506,10 +501,10 @@
     },
     {
       "inputs": [],
-      "name": "getProductService",
+      "name": "getRegistry",
       "outputs": [
         {
-          "internalType": "contract IProductService",
+          "internalType": "contract IRegistry",
           "name": "",
           "type": "address"
         }
@@ -519,10 +514,10 @@
     },
     {
       "inputs": [],
-      "name": "getRegistry",
+      "name": "getRegistryAddress",
       "outputs": [
         {
-          "internalType": "contract IRegistry",
+          "internalType": "address",
           "name": "",
           "type": "address"
         }
@@ -556,6 +551,130 @@
       "stateMutability": "view",
       "type": "function"
     },
+    {
+      "inputs": [
+        {
+          "internalType": "address",
+          "name": "registry",
+          "type": "address"
+        },
+        {
+          "internalType": "NftId",
+          "name": "instanceNftId",
+          "type": "uint96"
+        },
+        {
+          "internalType": "string",
+          "name": "name",
+          "type": "string"
+        },
+        {
+          "internalType": "address",
+          "name": "token",
+          "type": "address"
+        },
+        {
+          "internalType": "ObjectType",
+          "name": "componentType",
+          "type": "uint8"
+        },
+        {
+          "internalType": "bool",
+          "name": "isInterceptor",
+          "type": "bool"
+        },
+        {
+          "internalType": "address",
+          "name": "initialOwner",
+          "type": "address"
+        },
+        {
+          "internalType": "bytes",
+          "name": "registryData",
+          "type": "bytes"
+        }
+      ],
+      "name": "initializeComponent",
+      "outputs": [],
+      "stateMutability": "nonpayable",
+      "type": "function"
+    },
+    {
+      "inputs": [],
+      "name": "initializeERC165",
+      "outputs": [],
+      "stateMutability": "nonpayable",
+      "type": "function"
+    },
+    {
+      "inputs": [
+        {
+          "internalType": "address",
+          "name": "initialOwner",
+          "type": "address"
+        },
+        {
+          "internalType": "address",
+          "name": "registryAddress",
+          "type": "address"
+        }
+      ],
+      "name": "initializeNftOwnable",
+      "outputs": [],
+      "stateMutability": "nonpayable",
+      "type": "function"
+    },
+    {
+      "inputs": [
+        {
+          "internalType": "address",
+          "name": "registryAddress",
+          "type": "address"
+        },
+        {
+          "internalType": "NftId",
+          "name": "parentNftId",
+          "type": "uint96"
+        },
+        {
+          "internalType": "ObjectType",
+          "name": "objectType",
+          "type": "uint8"
+        },
+        {
+          "internalType": "bool",
+          "name": "isInterceptor",
+          "type": "bool"
+        },
+        {
+          "internalType": "address",
+          "name": "initialOwner",
+          "type": "address"
+        },
+        {
+          "internalType": "bytes",
+          "name": "registryData",
+          "type": "bytes"
+        }
+      ],
+      "name": "initializeRegisterable",
+      "outputs": [],
+      "stateMutability": "nonpayable",
+      "type": "function"
+    },
+    {
+      "inputs": [
+        {
+          "internalType": "address",
+          "name": "registryAddress",
+          "type": "address"
+        }
+      ],
+      "name": "initializeRegistryLinked",
+      "outputs": [],
+      "stateMutability": "nonpayable",
+      "type": "function"
+    },
     {
       "inputs": [],
       "name": "isConsumingScheduledOp",
@@ -569,6 +688,19 @@
       "stateMutability": "view",
       "type": "function"
     },
+    {
+      "inputs": [],
+      "name": "isNftInterceptor",
+      "outputs": [
+        {
+          "internalType": "bool",
+          "name": "isInterceptor",
+          "type": "bool"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
     {
       "inputs": [],
       "name": "linkToRegisteredNftId",
@@ -583,6 +715,60 @@
       "stateMutability": "nonpayable",
       "type": "function"
     },
+    {
+      "inputs": [
+        {
+          "internalType": "address",
+          "name": "to",
+          "type": "address"
+        },
+        {
+          "internalType": "uint256",
+          "name": "tokenId",
+          "type": "uint256"
+        }
+      ],
+      "name": "nftMint",
+      "outputs": [],
+      "stateMutability": "nonpayable",
+      "type": "function"
+    },
+    {
+      "inputs": [
+        {
+          "internalType": "address",
+          "name": "from",
+          "type": "address"
+        },
+        {
+          "internalType": "address",
+          "name": "to",
+          "type": "address"
+        },
+        {
+          "internalType": "uint256",
+          "name": "tokenId",
+          "type": "uint256"
+        }
+      ],
+      "name": "nftTransferFrom",
+      "outputs": [],
+      "stateMutability": "nonpayable",
+      "type": "function"
+    },
+    {
+      "inputs": [
+        {
+          "internalType": "bytes4",
+          "name": "interfaceId",
+          "type": "bytes4"
+        }
+      ],
+      "name": "registerInterface",
+      "outputs": [],
+      "stateMutability": "nonpayable",
+      "type": "function"
+    },
     {
       "inputs": [
         {

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

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