@etherisc/gif-next 0.0.2-ed4dd55 → 0.0.2-f619be3-760

package/README.md

@@ -1,5 +1,13 @@
 # gif-next (Generic Insurance Framework next version)
 
+## Submodules checkout
+
+This repository uses submodules. To checkout or update to the latest submodules, run the following command after updating to any revision (or checking out the repository)
+
+```shell
+git submodule update --recursive
+```
+
 ## Hardhat 
 
 ### NPM Commands
@@ -26,6 +34,22 @@ Networks:
 - mainnet (polygon mainnet, requires WEB3_INFURA_PROJECT_ID)
 
 
+#### Deply all script
+
+The deploy all script will deploy all required contracts and create a test instance with a test product and a test pool. 
+
+```
+hh run --network <networkname> scripts/deploy_all.ts
+```
+
+Environment variables:
+
+- `SKIP_VERIFICATION` set to `true` to skip etherscan verification (required for ganacht and anvil)
+- `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)
+- `ETHERSCAN_API_KEY` `POLYGONSCAN_API_KEY` the api key for etherscan/polygonscan (required for mumbai and mainnet)
+
+
 ### Console
 
 ```
@@ -125,3 +149,28 @@ uint256 policyNftId = ps.createApplicationForBundle(customer, bundleNftId, sumIn
 
 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/). 
+
+### Automatic code formatting
+
+We use prettier and the solidity plugin to format the code automatically. 
+The plugin is configured to use the style guide mentioned above.
+To execute format checks run `npm run styleCheck`.
+To execute formatting run `npm run styleFix`.
+
+### Linting 
+
+We use solhint to lint the code.
+To execute linting run `npm run lint`.

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

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

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

@@ -72,9 +72,9 @@
       "name": "getNftId",
       "outputs": [
         {
-          "internalType": "uint256",
-          "name": "id",
-          "type": "uint256"
+          "internalType": "NftId",
+          "name": "nftId",
+          "type": "uint96"
         }
       ],
       "stateMutability": "view",
@@ -98,9 +98,9 @@
       "name": "getParentNftId",
       "outputs": [
         {
-          "internalType": "uint256",
+          "internalType": "NftId",
           "name": "",
-          "type": "uint256"
+          "type": "uint96"
         }
       ],
       "stateMutability": "view",
@@ -119,14 +119,40 @@
       "stateMutability": "view",
       "type": "function"
     },
+    {
+      "inputs": [],
+      "name": "getToken",
+      "outputs": [
+        {
+          "internalType": "contract IERC20Metadata",
+          "name": "token",
+          "type": "address"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
     {
       "inputs": [],
       "name": "getType",
       "outputs": [
         {
-          "internalType": "uint256",
+          "internalType": "ObjectType",
           "name": "objectType",
-          "type": "uint256"
+          "type": "uint8"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
+    {
+      "inputs": [],
+      "name": "getWallet",
+      "outputs": [
+        {
+          "internalType": "address",
+          "name": "walletAddress",
+          "type": "address"
         }
       ],
       "stateMutability": "view",
@@ -163,9 +189,9 @@
       "name": "register",
       "outputs": [
         {
-          "internalType": "uint256",
+          "internalType": "NftId",
           "name": "componentId",
-          "type": "uint256"
+          "type": "uint96"
         }
       ],
       "stateMutability": "nonpayable",

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

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

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

@@ -28,8 +28,8 @@
       "type": "function"
     }
   ],
-  "bytecode": "0x608060405234801561001057600080fd5b50604051610249380380610249833981810160405281019061003291906100db565b806000806101000a81548173ffffffffffffffffffffffffffffffffffffffff021916908373ffffffffffffffffffffffffffffffffffffffff16021790555050610108565b600080fd5b600073ffffffffffffffffffffffffffffffffffffffff82169050919050565b60006100a88261007d565b9050919050565b6100b88161009d565b81146100c357600080fd5b50565b6000815190506100d5816100af565b92915050565b6000602082840312156100f1576100f0610078565b5b60006100ff848285016100c6565b91505092915050565b610132806101176000396000f3fe6080604052348015600f57600080fd5b506004361060285760003560e01c8063de7b5d1414602d575b600080fd5b60336047565b604051603e919060e3565b60405180910390f35b60008060009054906101000a900473ffffffffffffffffffffffffffffffffffffffff16905090565b600073ffffffffffffffffffffffffffffffffffffffff82169050919050565b6000819050919050565b600060af60ab60a7846070565b6090565b6070565b9050919050565b600060bf82609a565b9050919050565b600060cf8260b6565b9050919050565b60dd8160c6565b82525050565b600060208201905060f6600083018460d6565b9291505056fea2646970667358221220bde951bc8ba6abd1f6c082d09f1662d4661ec9919761eeebc59aa7dd2acc63ac64736f6c63430008140033",
-  "deployedBytecode": "0x6080604052348015600f57600080fd5b506004361060285760003560e01c8063de7b5d1414602d575b600080fd5b60336047565b604051603e919060e3565b60405180910390f35b60008060009054906101000a900473ffffffffffffffffffffffffffffffffffffffff16905090565b600073ffffffffffffffffffffffffffffffffffffffff82169050919050565b6000819050919050565b600060af60ab60a7846070565b6090565b6070565b9050919050565b600060bf82609a565b9050919050565b600060cf8260b6565b9050919050565b60dd8160c6565b82525050565b600060208201905060f6600083018460d6565b9291505056fea2646970667358221220bde951bc8ba6abd1f6c082d09f1662d4661ec9919761eeebc59aa7dd2acc63ac64736f6c63430008140033",
+  "bytecode": "0x608060405234801561001057600080fd5b5060405161011438038061011483398101604081905261002f91610054565b600080546001600160a01b0319166001600160a01b0392909216919091179055610084565b60006020828403121561006657600080fd5b81516001600160a01b038116811461007d57600080fd5b9392505050565b6082806100926000396000f3fe6080604052348015600f57600080fd5b506004361060285760003560e01c8063de7b5d1414602d575b600080fd5b600054604080516001600160a01b039092168252519081900360200190f3fea264697066735822122073a0ea8fa4352d28b2a129d826cfd42d4c8f65d3a006cdf283aa909e0fac0e4264736f6c63430008140033",
+  "deployedBytecode": "0x6080604052348015600f57600080fd5b506004361060285760003560e01c8063de7b5d1414602d575b600080fd5b600054604080516001600160a01b039092168252519081900360200190f3fea264697066735822122073a0ea8fa4352d28b2a129d826cfd42d4c8f65d3a006cdf283aa909e0fac0e4264736f6c63430008140033",
   "linkReferences": {},
   "deployedLinkReferences": {}
 }

package/artifacts/contracts/components/IPool.sol/IPoolComponent.dbg.json

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

package/artifacts/contracts/components/IPool.sol/IPoolComponent.json

@@ -72,9 +72,9 @@
       "name": "getNftId",
       "outputs": [
         {
-          "internalType": "uint256",
+          "internalType": "NftId",
           "name": "nftId",
-          "type": "uint256"
+          "type": "uint96"
         }
       ],
       "stateMutability": "view",
@@ -98,9 +98,34 @@
       "name": "getParentNftId",
       "outputs": [
         {
-          "internalType": "uint256",
+          "internalType": "NftId",
           "name": "parentNftId",
-          "type": "uint256"
+          "type": "uint96"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
+    {
+      "inputs": [],
+      "name": "getPerformanceFee",
+      "outputs": [
+        {
+          "components": [
+            {
+              "internalType": "UFixed",
+              "name": "fractionalFee",
+              "type": "uint256"
+            },
+            {
+              "internalType": "uint256",
+              "name": "fixedFee",
+              "type": "uint256"
+            }
+          ],
+          "internalType": "struct Fee",
+          "name": "performanceFee",
+          "type": "tuple"
         }
       ],
       "stateMutability": "view",
@@ -119,14 +144,65 @@
       "stateMutability": "view",
       "type": "function"
     },
+    {
+      "inputs": [],
+      "name": "getStakingFee",
+      "outputs": [
+        {
+          "components": [
+            {
+              "internalType": "UFixed",
+              "name": "fractionalFee",
+              "type": "uint256"
+            },
+            {
+              "internalType": "uint256",
+              "name": "fixedFee",
+              "type": "uint256"
+            }
+          ],
+          "internalType": "struct Fee",
+          "name": "stakingFee",
+          "type": "tuple"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
+    {
+      "inputs": [],
+      "name": "getToken",
+      "outputs": [
+        {
+          "internalType": "contract IERC20Metadata",
+          "name": "token",
+          "type": "address"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
     {
       "inputs": [],
       "name": "getType",
       "outputs": [
         {
-          "internalType": "uint256",
+          "internalType": "ObjectType",
           "name": "objectType",
-          "type": "uint256"
+          "type": "uint8"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
+    {
+      "inputs": [],
+      "name": "getWallet",
+      "outputs": [
+        {
+          "internalType": "address",
+          "name": "walletAddress",
+          "type": "address"
         }
       ],
       "stateMutability": "view",
@@ -163,9 +239,9 @@
       "name": "register",
       "outputs": [
         {
-          "internalType": "uint256",
+          "internalType": "NftId",
           "name": "nftId",
-          "type": "uint256"
+          "type": "uint96"
         }
       ],
       "stateMutability": "nonpayable",

package/artifacts/contracts/components/IProduct.sol/IProductComponent.dbg.json

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

package/artifacts/contracts/components/IProduct.sol/IProductComponent.json

@@ -3,104 +3,26 @@
   "contractName": "IProductComponent",
   "sourceName": "contracts/components/IProduct.sol",
   "abi": [
-    {
-      "anonymous": false,
-      "inputs": [
-        {
-          "indexed": false,
-          "internalType": "uint256",
-          "name": "idx",
-          "type": "uint256"
-        },
-        {
-          "indexed": false,
-          "internalType": "address",
-          "name": "module",
-          "type": "address"
-        },
-        {
-          "indexed": false,
-          "internalType": "string",
-          "name": "comment",
-          "type": "string"
-        }
-      ],
-      "name": "LogDebug",
-      "type": "event"
-    },
-    {
-      "inputs": [],
-      "name": "getData",
-      "outputs": [
-        {
-          "internalType": "bytes",
-          "name": "data",
-          "type": "bytes"
-        }
-      ],
-      "stateMutability": "view",
-      "type": "function"
-    },
-    {
-      "inputs": [],
-      "name": "getInitialOwner",
-      "outputs": [
-        {
-          "internalType": "address",
-          "name": "initialOwner",
-          "type": "address"
-        }
-      ],
-      "stateMutability": "view",
-      "type": "function"
-    },
-    {
-      "inputs": [],
-      "name": "getInstance",
-      "outputs": [
-        {
-          "internalType": "contract IInstance",
-          "name": "instance",
-          "type": "address"
-        }
-      ],
-      "stateMutability": "view",
-      "type": "function"
-    },
-    {
-      "inputs": [],
-      "name": "getNftId",
-      "outputs": [
-        {
-          "internalType": "uint256",
-          "name": "nftId",
-          "type": "uint256"
-        }
-      ],
-      "stateMutability": "view",
-      "type": "function"
-    },
     {
       "inputs": [],
-      "name": "getOwner",
+      "name": "getPolicyFee",
       "outputs": [
         {
-          "internalType": "address",
-          "name": "owner",
-          "type": "address"
-        }
-      ],
-      "stateMutability": "view",
-      "type": "function"
-    },
-    {
-      "inputs": [],
-      "name": "getParentNftId",
-      "outputs": [
-        {
-          "internalType": "uint256",
-          "name": "parentNftId",
-          "type": "uint256"
+          "components": [
+            {
+              "internalType": "UFixed",
+              "name": "fractionalFee",
+              "type": "uint256"
+            },
+            {
+              "internalType": "uint256",
+              "name": "fixedFee",
+              "type": "uint256"
+            }
+          ],
+          "internalType": "struct Fee",
+          "name": "policyFee",
+          "type": "tuple"
         }
       ],
       "stateMutability": "view",
@@ -111,22 +33,9 @@
       "name": "getPoolNftId",
       "outputs": [
         {
-          "internalType": "uint256",
+          "internalType": "NftId",
           "name": "poolNftId",
-          "type": "uint256"
-        }
-      ],
-      "stateMutability": "view",
-      "type": "function"
-    },
-    {
-      "inputs": [],
-      "name": "getRegistry",
-      "outputs": [
-        {
-          "internalType": "contract IRegistry",
-          "name": "registry",
-          "type": "address"
+          "type": "uint96"
         }
       ],
       "stateMutability": "view",
@@ -134,55 +43,28 @@
     },
     {
       "inputs": [],
-      "name": "getType",
+      "name": "getProcessingFee",
       "outputs": [
         {
-          "internalType": "uint256",
-          "name": "objectType",
-          "type": "uint256"
+          "components": [
+            {
+              "internalType": "UFixed",
+              "name": "fractionalFee",
+              "type": "uint256"
+            },
+            {
+              "internalType": "uint256",
+              "name": "fixedFee",
+              "type": "uint256"
+            }
+          ],
+          "internalType": "struct Fee",
+          "name": "processingFee",
+          "type": "tuple"
         }
       ],
       "stateMutability": "view",
       "type": "function"
-    },
-    {
-      "inputs": [],
-      "name": "isRegisterable",
-      "outputs": [
-        {
-          "internalType": "bool",
-          "name": "",
-          "type": "bool"
-        }
-      ],
-      "stateMutability": "pure",
-      "type": "function"
-    },
-    {
-      "inputs": [],
-      "name": "isRegistered",
-      "outputs": [
-        {
-          "internalType": "bool",
-          "name": "",
-          "type": "bool"
-        }
-      ],
-      "stateMutability": "view",
-      "type": "function"
-    },
-    {
-      "inputs": [],
-      "name": "register",
-      "outputs": [
-        {
-          "internalType": "uint256",
-          "name": "nftId",
-          "type": "uint256"
-        }
-      ],
-      "stateMutability": "nonpayable",
-      "type": "function"
     }
   ],
   "bytecode": "0x",

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

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