@etherisc/gif-next 0.0.2-cc253b3 → 0.0.2-cd89a0b-062

package/README.md

@@ -1,5 +1,32 @@
 # gif-next (Generic Insurance Framework next version)
 
+## Add OpenZeppelin V5 Dependencies
+
+```shell
+forge install openzeppelin-contracts-500=OpenZeppelin/openzeppelin-contracts@v5.0.0
+cd cd lib/openzeppelin-contracts-500
+git checkout tags/v5.0.0
+cd ../..
+```
+
+See `remappings.txt` to see how to work with different OpenZeppelin versions in parallel
+
+```
+cat remappings.txt 
+@openzeppelin5/contracts/=lib/openzeppelin-contracts-500/contracts/
+@openzeppelin/contracts/=lib/openzeppelin-contracts/contracts/
+@openzeppelin/contracts-upgradeable/=lib/openzeppelin-contracts-upgradeable/contracts/
+```
+
+
+## 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
@@ -15,15 +42,33 @@ npm run coverage
 
 ### Deployment 
 
+Install the dependencies before running the script below for the first time.
+
+```bash
+npm install
 ```
-hh run --network <networkname> scripts/deploy.ts
+
+The deploy script will deploy all required contracts and create a test instance with a test product and a test pool. 
+
+```bash
+# run deployment on a locally created ganache instance
+export SKIP_VERIFICATION=true
+hh run scripts/deploy_all.ts
 ```
 
-Networks:
-- hardhat (dynamically created network - https://hardhat.org/hardhat-network/docs/overview)
-- anvil (anvsil chain running in container next when using devcontainer)
-- mumbai (polygon testnet, requires WEB3_INFURA_PROJECT_ID)
-- mainnet (polygon mainnet, requires WEB3_INFURA_PROJECT_ID)
+```bash
+# set appropriate values vor env variables (see below)
+
+# run deployment on another network
+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
@@ -48,6 +93,9 @@ https://hardhat.org/hardhat-runner/docs/guides/compile-contracts
 ```shell
 forge build
 
+# contract sizes
+forge build --sizes | grep Instance
+
 forge test
 
 # run single test case
@@ -119,9 +167,148 @@ uint256 lifetime =365*24*3600;
 uint256 policyNftId = ps.createApplicationForBundle(customer, bundleNftId, sumInsuredAmount, premiumAmount, lifetime);
 
 ```
+### Library Linking
+
+https://ethereum.stackexchange.com/questions/153411/does-foundry-support-dynamical-library-linking-in-solidity
 
+```toml
+# foundry.toml
+
+[profile.default]
+  # expected format(example below): libraries = ["<path>:<lib name>:<address>"]
+  libraries = ["src/libraries/MyLibrary.sol:MyLibrary:0x..."]
+```
 
 ### Documentation
 
 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`.
+
+
+### Adding Brownie (Legacy)
+
+python3 is already installed
+
+```bash
+npm install -g ganache
+sudo apt update
+sudo apt install python3-pip
+pip install eth-brownie
+brownie pm install OpenZeppelin/openzeppelin-contracts@4.9.3
+brownie pm install OpenZeppelin/openzeppelin-contracts@5.0.0
+```
+
+```bash
+brownie compile --all
+brownie console
+```
+
+```python
+registry_owner = accounts[0]
+instance_owner = accounts[1]
+product_owner = accounts[2]
+
+# deploy libs and helper contracts
+nft_id_lib = NftIdLib.deploy({'from': registry_owner})
+ufixed_math_lib = UFixedMathLib.deploy({'from': registry_owner})
+test_fee = TestFee.deploy({'from': registry_owner})
+
+# deploy registry and a token
+registry = Registry.deploy({'from': registry_owner})
+nft = ChainNft.deploy(registry, {'from': registry_owner})
+registry.initialize(nft,  {'from': registry_owner})
+token = TestUsdc.deploy({'from': registry_owner})
+
+# deploy services
+component_owner_service = ComponentOwnerService.deploy(registry, {'from': registry_owner})
+product_service = ProductService.deploy(registry, {'from': registry_owner})
+
+# deploy an instance
+instance = Instance.deploy(registry, component_owner_service, product_service, {'from': instance_owner})
+
+# deploy product
+pool = TestPool.deploy(registry, instance, token, {'from': product_owner})
+policy_fee = test_fee.createFee(1, -1, 0)
+product = TestProduct.deploy(registry, instance, token, pool, policy_fee, {'from': product_owner})
+
+# grant roles
+pool_owner_role = instance.getRoleForName("PoolOwner")
+product_owner_role = instance.getRoleForName("ProductOwner")
+instance.grantRole(pool_owner_role, product_owner, {'from': instance_owner})
+instance.grantRole(product_owner_role, product_owner, {'from': instance_owner})
+
+# register objects
+instance.register()
+component_owner_service.register(pool, {'from': product_owner})
+component_owner_service.register(product, {'from': product_owner})
+
+instance_id = instance.getNftId()
+pool_id = pool.getNftId()
+product_id = product.getNftId()
+```
+
+## Registry and Services
+
+### Principles
+
+- 1 service per object type and major version
+- registry service guards write access to registry
+- all other objects registered via registry service
+- root object for the complete tree is the protocol object
+- under the root object a single registry object is registered (= global registry/ethereum mainnet)
+
+
+### Service Responsibilities
+
+Registry Service
+
+- deployed and registered during bootstrapping of registry
+- used to register tokens and other services by registry owner
+- an object may only be registered by the service designated by the type of the object
+- to register an object the parent object needs already be registered
+- the type of the object to be registered needs to match a valid child type/parent type combination
+
+Instance Service
+
+- deploys master instance during its own bootstrapping (if allowed by contract size)
+- registered via registry service by registry owner
+- registeres master instance during its own registration by regsitry owner
+- deploys and registeres new instances (= instance factory) by instance owner (instance owner is a permissionless role, anybody may creates a new instance)
+- provides upgrade functionality to instance owners
+
+Product Service
+
+- registered via registry service by registry owner
+- registers products for registered instances via registry service by product owner (product owner role is permissend by the product's instance)
+- registers applications/policies for registered products via registry service
+
+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

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

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

package/artifacts/contracts/components/{IProduct.sol/IProductComponent.json → BaseComponent.sol/BaseComponent.json}

@@ -1,41 +1,39 @@
 {
   "_format": "hh-sol-artifact-1",
-  "contractName": "IProductComponent",
-  "sourceName": "contracts/components/IProduct.sol",
+  "contractName": "BaseComponent",
+  "sourceName": "contracts/components/BaseComponent.sol",
   "abi": [
+    {
+      "inputs": [],
+      "name": "InvalidInitialization",
+      "type": "error"
+    },
+    {
+      "inputs": [],
+      "name": "NotInitializing",
+      "type": "error"
+    },
     {
       "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"
+          "internalType": "uint64",
+          "name": "version",
+          "type": "uint64"
         }
       ],
-      "name": "LogDebug",
+      "name": "Initialized",
       "type": "event"
     },
     {
       "inputs": [],
-      "name": "getData",
+      "name": "REGISTERABLE_LOCATION_V1",
       "outputs": [
         {
-          "internalType": "bytes",
-          "name": "data",
-          "type": "bytes"
+          "internalType": "bytes32",
+          "name": "",
+          "type": "bytes32"
         }
       ],
       "stateMutability": "view",
@@ -43,12 +41,54 @@
     },
     {
       "inputs": [],
-      "name": "getInitialOwner",
+      "name": "getInitialInfo",
       "outputs": [
         {
-          "internalType": "address",
-          "name": "initialOwner",
-          "type": "address"
+          "components": [
+            {
+              "internalType": "NftId",
+              "name": "nftId",
+              "type": "uint96"
+            },
+            {
+              "internalType": "NftId",
+              "name": "parentNftId",
+              "type": "uint96"
+            },
+            {
+              "internalType": "ObjectType",
+              "name": "objectType",
+              "type": "uint8"
+            },
+            {
+              "internalType": "bool",
+              "name": "isInterceptor",
+              "type": "bool"
+            },
+            {
+              "internalType": "address",
+              "name": "objectAddress",
+              "type": "address"
+            },
+            {
+              "internalType": "address",
+              "name": "initialOwner",
+              "type": "address"
+            },
+            {
+              "internalType": "bytes",
+              "name": "data",
+              "type": "bytes"
+            }
+          ],
+          "internalType": "struct IRegistry.ObjectInfo",
+          "name": "",
+          "type": "tuple"
+        },
+        {
+          "internalType": "bytes",
+          "name": "data",
+          "type": "bytes"
         }
       ],
       "stateMutability": "view",
@@ -86,7 +126,7 @@
       "outputs": [
         {
           "internalType": "address",
-          "name": "owner",
+          "name": "",
           "type": "address"
         }
       ],
@@ -95,12 +135,12 @@
     },
     {
       "inputs": [],
-      "name": "getParentNftId",
+      "name": "getRegistry",
       "outputs": [
         {
-          "internalType": "NftId",
-          "name": "parentNftId",
-          "type": "uint96"
+          "internalType": "contract IRegistry",
+          "name": "registry",
+          "type": "address"
         }
       ],
       "stateMutability": "view",
@@ -108,12 +148,12 @@
     },
     {
       "inputs": [],
-      "name": "getPoolNftId",
+      "name": "getToken",
       "outputs": [
         {
-          "internalType": "NftId",
-          "name": "poolNftId",
-          "type": "uint96"
+          "internalType": "contract IERC20Metadata",
+          "name": "token",
+          "type": "address"
         }
       ],
       "stateMutability": "view",
@@ -121,11 +161,11 @@
     },
     {
       "inputs": [],
-      "name": "getRegistry",
+      "name": "getWallet",
       "outputs": [
         {
-          "internalType": "contract IRegistry",
-          "name": "registry",
+          "internalType": "address",
+          "name": "walletAddress",
           "type": "address"
         }
       ],
@@ -134,33 +174,20 @@
     },
     {
       "inputs": [],
-      "name": "getType",
-      "outputs": [
-        {
-          "internalType": "uint256",
-          "name": "objectType",
-          "type": "uint256"
-        }
-      ],
-      "stateMutability": "view",
+      "name": "lock",
+      "outputs": [],
+      "stateMutability": "nonpayable",
       "type": "function"
     },
     {
-      "inputs": [],
-      "name": "isRegisterable",
-      "outputs": [
+      "inputs": [
         {
-          "internalType": "bool",
-          "name": "",
-          "type": "bool"
+          "internalType": "bytes4",
+          "name": "interfaceId",
+          "type": "bytes4"
         }
       ],
-      "stateMutability": "pure",
-      "type": "function"
-    },
-    {
-      "inputs": [],
-      "name": "isRegistered",
+      "name": "supportsInterface",
       "outputs": [
         {
           "internalType": "bool",
@@ -173,14 +200,8 @@
     },
     {
       "inputs": [],
-      "name": "register",
-      "outputs": [
-        {
-          "internalType": "NftId",
-          "name": "nftId",
-          "type": "uint96"
-        }
-      ],
+      "name": "unlock",
+      "outputs": [],
       "stateMutability": "nonpayable",
       "type": "function"
     }

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

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