@etherisc/gif-next 0.0.2-e5a2253-213 → 0.0.2-e69072e-892

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

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

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

@@ -1,55 +1,66 @@
 {
   "_format": "hh-sol-artifact-1",
-  "contractName": "BaseComponent",
-  "sourceName": "contracts/components/BaseComponent.sol",
+  "contractName": "Component",
+  "sourceName": "contracts/components/Component.sol",
   "abi": [
     {
       "inputs": [
         {
           "internalType": "address",
-          "name": "target",
+          "name": "authority",
           "type": "address"
         }
       ],
-      "name": "AddressEmptyCode",
+      "name": "AccessManagedInvalidAuthority",
       "type": "error"
     },
     {
       "inputs": [
         {
           "internalType": "address",
-          "name": "account",
+          "name": "caller",
           "type": "address"
+        },
+        {
+          "internalType": "uint32",
+          "name": "delay",
+          "type": "uint32"
         }
       ],
-      "name": "AddressInsufficientBalance",
+      "name": "AccessManagedRequiredDelay",
       "type": "error"
     },
     {
       "inputs": [
         {
           "internalType": "address",
-          "name": "registry",
+          "name": "caller",
           "type": "address"
-        },
+        }
+      ],
+      "name": "AccessManagedUnauthorized",
+      "type": "error"
+    },
+    {
+      "inputs": [
         {
-          "internalType": "NftId",
-          "name": "nftId",
-          "type": "uint96"
+          "internalType": "address",
+          "name": "target",
+          "type": "address"
         }
       ],
-      "name": "ErrorAlreadyLinked",
+      "name": "AddressEmptyCode",
       "type": "error"
     },
     {
       "inputs": [
         {
           "internalType": "address",
-          "name": "caller",
+          "name": "account",
           "type": "address"
         }
       ],
-      "name": "ErrorBaseComponentNotProductService",
+      "name": "AddressInsufficientBalance",
       "type": "error"
     },
     {
@@ -58,25 +69,46 @@
           "internalType": "address",
           "name": "caller",
           "type": "address"
-        },
+        }
+      ],
+      "name": "ErrorComponentNotChainNft",
+      "type": "error"
+    },
+    {
+      "inputs": [
         {
-          "internalType": "uint64",
-          "name": "requiredRoleIdNum",
-          "type": "uint64"
+          "internalType": "NftId",
+          "name": "instanceNftId",
+          "type": "uint96"
         }
       ],
-      "name": "ErrorBaseComponentUnauthorized",
+      "name": "ErrorComponentNotInstance",
       "type": "error"
     },
     {
       "inputs": [
         {
           "internalType": "address",
-          "name": "newWallet",
+          "name": "caller",
           "type": "address"
         }
       ],
-      "name": "ErrorBaseComponentWalletAddressIsSameAsCurrent",
+      "name": "ErrorComponentNotProductService",
+      "type": "error"
+    },
+    {
+      "inputs": [],
+      "name": "ErrorComponentProductNftAlreadySet",
+      "type": "error"
+    },
+    {
+      "inputs": [],
+      "name": "ErrorComponentWalletAddressIsSameAsCurrent",
+      "type": "error"
+    },
+    {
+      "inputs": [],
+      "name": "ErrorComponentWalletAddressZero",
       "type": "error"
     },
     {
@@ -102,72 +134,56 @@
           "type": "uint256"
         }
       ],
-      "name": "ErrorBaseComponentWalletAllowanceTooSmall",
+      "name": "ErrorComponentWalletAllowanceTooSmall",
       "type": "error"
     },
     {
       "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"
     },
     {
@@ -196,6 +212,19 @@
       "name": "SafeERC20FailedOperation",
       "type": "error"
     },
+    {
+      "anonymous": false,
+      "inputs": [
+        {
+          "indexed": false,
+          "internalType": "address",
+          "name": "authority",
+          "type": "address"
+        }
+      ],
+      "name": "AuthorityUpdated",
+      "type": "event"
+    },
     {
       "anonymous": false,
       "inputs": [
@@ -212,6 +241,12 @@
     {
       "anonymous": false,
       "inputs": [
+        {
+          "indexed": false,
+          "internalType": "address",
+          "name": "oldWallet",
+          "type": "address"
+        },
         {
           "indexed": false,
           "internalType": "address",
@@ -219,7 +254,7 @@
           "type": "address"
         }
       ],
-      "name": "LogBaseComponentWalletAddressChanged",
+      "name": "LogComponentWalletAddressChanged",
       "type": "event"
     },
     {
@@ -244,9 +279,35 @@
           "type": "uint256"
         }
       ],
-      "name": "LogBaseComponentWalletTokensTransferred",
+      "name": "LogComponentWalletTokensTransferred",
       "type": "event"
     },
+    {
+      "inputs": [],
+      "name": "COMPONENT_LOCATION_V1",
+      "outputs": [
+        {
+          "internalType": "bytes32",
+          "name": "",
+          "type": "bytes32"
+        }
+      ],
+      "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",
@@ -260,6 +321,19 @@
       "stateMutability": "view",
       "type": "function"
     },
+    {
+      "inputs": [],
+      "name": "authority",
+      "outputs": [
+        {
+          "internalType": "address",
+          "name": "",
+          "type": "address"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
     {
       "inputs": [],
       "name": "getInitialInfo",
@@ -303,13 +377,8 @@
             }
           ],
           "internalType": "struct IRegistry.ObjectInfo",
-          "name": "",
+          "name": "info",
           "type": "tuple"
-        },
-        {
-          "internalType": "bytes",
-          "name": "data",
-          "type": "bytes"
         }
       ],
       "stateMutability": "view",
@@ -338,7 +407,7 @@
           "type": "string"
         }
       ],
-      "stateMutability": "pure",
+      "stateMutability": "view",
       "type": "function"
     },
     {
@@ -393,6 +462,19 @@
       "stateMutability": "view",
       "type": "function"
     },
+    {
+      "inputs": [],
+      "name": "getRegistryAddress",
+      "outputs": [
+        {
+          "internalType": "address",
+          "name": "",
+          "type": "address"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
     {
       "inputs": [],
       "name": "getToken",
@@ -419,6 +501,156 @@
       "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",
+      "outputs": [
+        {
+          "internalType": "bytes4",
+          "name": "",
+          "type": "bytes4"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
+    {
+      "inputs": [],
+      "name": "isNftInterceptor",
+      "outputs": [
+        {
+          "internalType": "bool",
+          "name": "isInterceptor",
+          "type": "bool"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
     {
       "inputs": [],
       "name": "linkToRegisteredNftId",
@@ -433,6 +665,55 @@
       "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": [
+        {
+          "internalType": "address",
+          "name": "newAuthority",
+          "type": "address"
+        }
+      ],
+      "name": "setAuthority",
+      "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/2d0d5ac9f3af33498ef492a7caeac063.json"
+  "buildInfo": "../../../build-info/a8e58e3e317904030d8bf765133d5722.json"
 }