@etherisc/gif-next 0.0.2-90f8ffc-398 → 0.0.2-9105e58-225

package/README.md

@@ -1,5 +1,18 @@
 # GIF-Next (Generic Insurance Framework, next version)
 
+
+```mermaid
+  graph TD
+      IPoolComponent --> IComponent
+      IComponent --> IRegisterable
+      IComponent --> ITransferInterceptor
+      IRegistryService --> IService
+      IService-->IRegisterable
+      IService-->IVersionable
+      IRegisterable-->INftOwnable
+      INftOwnable-->IERC165
+```
+
 ## Add OpenZeppelin V5 Dependencies
 
 ```shell
@@ -392,9 +405,68 @@ Intercepting property
 
 ### Product
 
+### Payout Handling
+
+Pool specifies **retention level**.
+Retention level defines up to which percentage of the sum insured the pool is payout out using its own/current funds.
+Depending on the amount of a new payout the poolService decides to either execute the payout directly or to add the payout as a pending payout with a notification of the pool.
+
+The sequence below sketches the small payout flow (payout < retention amount)
+- retention level: 30%
+- sum insured: 1000
+- payout: 200
+
+```mermaid
+sequenceDiagram
+  participant customer
+  participant product
+  participant claimService
+  participant poolService
+  participant pool
+  product->>claimService: createPayout()
+  claimService ->> poolService: requestPayout()
+  poolService -->> pool: verifyPayout() *
+  poolService ->> poolService: processPayout()
+  poolService ->> customer: transfer token for payout
+  poolService ->> claimService: payoutExecuted()
+  poolService -->> customer: payoutExecutedCallback() **
+```
+
+*: if pool is configured to verify payouts before execution
+
+**: callback only if customer is contract (IPolicyHolder)
+
+The sequence below sketches the call flow for payouts larger than the retention amount
+- retention level: 30%
+- sum insured: 1000
+- payout: 500
+  * locally available: 300
+  * via policy (re-insurance): 200
+
+```mermaid
+sequenceDiagram 
+  participant customer
+  participant product
+  participant claimService
+  participant poolService
+  participant pool
+  pool ->> reinsuranceProduct: applyForPolicy()
+  product->>claimService: createPayout()
+  claimService ->> poolService: requestPayout()
+  poolService ->> pool: pendingPayoutAdded()
+  pool ->> pool: getReinsurancePolicy()
+  pool ->> reinsuranceProduct: claim()
+  reinsuranceProduct -->> reinsurancePool: createPayout
+  reinsurancePool ->> pool: transfer token for payout
+  reinsurancePool ->> pool: payoutExecutedCallback()
+  pool ->> poolService: processPendingPayout()
+  poolService ->> customer: transfer token for payout
+  poolService ->> claimService: payoutExecuted()
+```
+
 ### 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/16b4fe59ceb1260fdacb3925f49e52b3.json"
+  "buildInfo": "../../../build-info/a4fdb8c51f2726ede9f66aef21053805.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"
     },
     {
@@ -172,34 +167,39 @@
     {
       "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": [],
+      "name": "ErrorNftOwnableInitialOwnerZero",
       "type": "error"
     },
     {
       "inputs": [
         {
           "internalType": "address",
-          "name": "registryAddress",
+          "name": "account",
           "type": "address"
         }
       ],
-      "name": "ErrorNotRegistry",
+      "name": "ErrorNftOwnableNotOwner",
       "type": "error"
     },
     {
@@ -210,28 +210,18 @@
           "type": "address"
         }
       ],
-      "name": "ErrorRegisterableNotRegistry",
-      "type": "error"
-    },
-    {
-      "inputs": [],
-      "name": "ErrorRegistryAddressZero",
+      "name": "ErrorNotRegistry",
       "type": "error"
     },
     {
       "inputs": [
         {
           "internalType": "address",
-          "name": "registry",
+          "name": "registryAddress",
           "type": "address"
         }
       ],
-      "name": "ErrorRegistryAlreadyInitialized",
-      "type": "error"
-    },
-    {
-      "inputs": [],
-      "name": "ErrorRegistryNotInitialized",
+      "name": "ErrorRegisterableNotRegistry",
       "type": "error"
     },
     {
@@ -337,6 +327,19 @@
       "stateMutability": "view",
       "type": "function"
     },
+    {
+      "inputs": [],
+      "name": "NFT_OWNABLE_STORAGE_LOCATION_V1",
+      "outputs": [
+        {
+          "internalType": "bytes32",
+          "name": "",
+          "type": "bytes32"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
     {
       "inputs": [],
       "name": "REGISTERABLE_LOCATION_V1",
@@ -415,11 +418,11 @@
     },
     {
       "inputs": [],
-      "name": "getInitialOwner",
+      "name": "getInstance",
       "outputs": [
         {
-          "internalType": "address",
-          "name": "",
+          "internalType": "contract IInstance",
+          "name": "instance",
           "type": "address"
         }
       ],
@@ -428,11 +431,11 @@
     },
     {
       "inputs": [],
-      "name": "getInstance",
+      "name": "getInstanceReader",
       "outputs": [
         {
-          "internalType": "contract IInstance",
-          "name": "instance",
+          "internalType": "contract InstanceReader",
+          "name": "reader",
           "type": "address"
         }
       ],
@@ -530,6 +533,38 @@
       "stateMutability": "view",
       "type": "function"
     },
+    {
+      "inputs": [],
+      "name": "getRegistryAddress",
+      "outputs": [
+        {
+          "internalType": "address",
+          "name": "",
+          "type": "address"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
+    {
+      "inputs": [
+        {
+          "internalType": "ObjectType",
+          "name": "domain",
+          "type": "uint8"
+        }
+      ],
+      "name": "getServiceAddress",
+      "outputs": [
+        {
+          "internalType": "address",
+          "name": "service",
+          "type": "address"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
     {
       "inputs": [],
       "name": "getToken",
@@ -556,6 +591,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": "data",
+          "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": "data",
+          "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 +728,19 @@
       "stateMutability": "view",
       "type": "function"
     },
+    {
+      "inputs": [],
+      "name": "isNftInterceptor",
+      "outputs": [
+        {
+          "internalType": "bool",
+          "name": "isInterceptor",
+          "type": "bool"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
     {
       "inputs": [],
       "name": "linkToRegisteredNftId",
@@ -583,6 +755,42 @@
       "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/16b4fe59ceb1260fdacb3925f49e52b3.json"
+  "buildInfo": "../../../build-info/a4fdb8c51f2726ede9f66aef21053805.json"
 }