@etherisc/gif-next 0.0.2-d086e6d-456 → 0.0.2-d1f0662-893

package/README.md

@@ -1,23 +1,6 @@
 # GIF-Next (Generic Insurance Framework, next version)
 
 
-```mermaid
-  graph TD
-      IInstance --> IRegisterable
-      IInstance --> ITransferInterceptor
-      IInstance --> IAccessManaged
-      IPoolComponent --> IComponent
-      IComponent --> IRegisterable
-      IComponent --> ITransferInterceptor
-      IComponent --> IAccessManaged
-      IRegistryService --> IService
-      IService-->IRegisterable
-      IService-->IVersionable
-      IService-->IAccessManaged
-      IRegisterable-->INftOwnable
-      INftOwnable-->IERC165
-```
-
 ## Add OpenZeppelin V5 Dependencies
 
 ```shell
@@ -45,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
@@ -237,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
 
@@ -262,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
 
@@ -410,65 +387,6 @@ 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

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

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/6d337e35e1a2e4e40425b57181471e9c.json"
+  "buildInfo": "../../../build-info/85066c6f3c5dc0f34dc544d5ab504181.json"
 }

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

@@ -137,6 +137,11 @@
       "name": "ErrorComponentWalletAllowanceTooSmall",
       "type": "error"
     },
+    {
+      "inputs": [],
+      "name": "ErrorComponentWalletNotComponent",
+      "type": "error"
+    },
     {
       "inputs": [
         {
@@ -238,6 +243,19 @@
       "name": "Initialized",
       "type": "event"
     },
+    {
+      "anonymous": false,
+      "inputs": [
+        {
+          "indexed": false,
+          "internalType": "uint256",
+          "name": "limit",
+          "type": "uint256"
+        }
+      ],
+      "name": "LogComponentTokenHandlerApproved",
+      "type": "event"
+    },
     {
       "anonymous": false,
       "inputs": [
@@ -321,6 +339,19 @@
       "stateMutability": "view",
       "type": "function"
     },
+    {
+      "inputs": [
+        {
+          "internalType": "uint256",
+          "name": "spendingLimitAmount",
+          "type": "uint256"
+        }
+      ],
+      "name": "approveTokenHandler",
+      "outputs": [],
+      "stateMutability": "nonpayable",
+      "type": "function"
+    },
     {
       "inputs": [],
       "name": "authority",
@@ -514,11 +545,11 @@
     },
     {
       "inputs": [],
-      "name": "getRegistryAddress",
+      "name": "getToken",
       "outputs": [
         {
-          "internalType": "address",
-          "name": "",
+          "internalType": "contract IERC20Metadata",
+          "name": "token",
           "type": "address"
         }
       ],
@@ -527,11 +558,11 @@
     },
     {
       "inputs": [],
-      "name": "getToken",
+      "name": "getTokenHandler",
       "outputs": [
         {
-          "internalType": "contract IERC20Metadata",
-          "name": "token",
+          "internalType": "contract TokenHandler",
+          "name": "tokenHandler",
           "type": "address"
         }
       ],

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

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/6d337e35e1a2e4e40425b57181471e9c.json"
+  "buildInfo": "../../../build-info/85066c6f3c5dc0f34dc544d5ab504181.json"
 }

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

@@ -137,6 +137,27 @@
       "name": "ErrorComponentWalletAllowanceTooSmall",
       "type": "error"
     },
+    {
+      "inputs": [],
+      "name": "ErrorComponentWalletNotComponent",
+      "type": "error"
+    },
+    {
+      "inputs": [
+        {
+          "internalType": "address",
+          "name": "distributor",
+          "type": "address"
+        },
+        {
+          "internalType": "NftId",
+          "name": "distributorNftId",
+          "type": "uint96"
+        }
+      ],
+      "name": "ErrorDistributionAlreadyDistributor",
+      "type": "error"
+    },
     {
       "inputs": [
         {
@@ -238,6 +259,19 @@
       "name": "Initialized",
       "type": "event"
     },
+    {
+      "anonymous": false,
+      "inputs": [
+        {
+          "indexed": false,
+          "internalType": "uint256",
+          "name": "limit",
+          "type": "uint256"
+        }
+      ],
+      "name": "LogComponentTokenHandlerApproved",
+      "type": "event"
+    },
     {
       "anonymous": false,
       "inputs": [
@@ -353,6 +387,19 @@
       "stateMutability": "view",
       "type": "function"
     },
+    {
+      "inputs": [
+        {
+          "internalType": "uint256",
+          "name": "spendingLimitAmount",
+          "type": "uint256"
+        }
+      ],
+      "name": "approveTokenHandler",
+      "outputs": [],
+      "stateMutability": "nonpayable",
+      "type": "function"
+    },
     {
       "inputs": [],
       "name": "authority",
@@ -743,19 +790,6 @@
       "stateMutability": "view",
       "type": "function"
     },
-    {
-      "inputs": [],
-      "name": "getRegistryAddress",
-      "outputs": [
-        {
-          "internalType": "address",
-          "name": "",
-          "type": "address"
-        }
-      ],
-      "stateMutability": "view",
-      "type": "function"
-    },
     {
       "inputs": [],
       "name": "getSetupInfo",
@@ -838,6 +872,19 @@
       "stateMutability": "view",
       "type": "function"
     },
+    {
+      "inputs": [],
+      "name": "getTokenHandler",
+      "outputs": [
+        {
+          "internalType": "contract TokenHandler",
+          "name": "tokenHandler",
+          "type": "address"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
     {
       "inputs": [],
       "name": "getWallet",

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

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/6d337e35e1a2e4e40425b57181471e9c.json"
+  "buildInfo": "../../../build-info/85066c6f3c5dc0f34dc544d5ab504181.json"
 }

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

@@ -115,6 +115,11 @@
       "name": "ErrorComponentWalletAllowanceTooSmall",
       "type": "error"
     },
+    {
+      "inputs": [],
+      "name": "ErrorComponentWalletNotComponent",
+      "type": "error"
+    },
     {
       "inputs": [
         {
@@ -177,6 +182,19 @@
       "name": "AuthorityUpdated",
       "type": "event"
     },
+    {
+      "anonymous": false,
+      "inputs": [
+        {
+          "indexed": false,
+          "internalType": "uint256",
+          "name": "limit",
+          "type": "uint256"
+        }
+      ],
+      "name": "LogComponentTokenHandlerApproved",
+      "type": "event"
+    },
     {
       "anonymous": false,
       "inputs": [
@@ -221,6 +239,19 @@
       "name": "LogComponentWalletTokensTransferred",
       "type": "event"
     },
+    {
+      "inputs": [
+        {
+          "internalType": "uint256",
+          "name": "spendingLimitAmount",
+          "type": "uint256"
+        }
+      ],
+      "name": "approveTokenHandler",
+      "outputs": [],
+      "stateMutability": "nonpayable",
+      "type": "function"
+    },
     {
       "inputs": [],
       "name": "authority",
@@ -414,11 +445,11 @@
     },
     {
       "inputs": [],
-      "name": "getRegistryAddress",
+      "name": "getToken",
       "outputs": [
         {
-          "internalType": "address",
-          "name": "",
+          "internalType": "contract IERC20Metadata",
+          "name": "token",
           "type": "address"
         }
       ],
@@ -427,11 +458,11 @@
     },
     {
       "inputs": [],
-      "name": "getToken",
+      "name": "getTokenHandler",
       "outputs": [
         {
-          "internalType": "contract IERC20Metadata",
-          "name": "token",
+          "internalType": "contract TokenHandler",
+          "name": "tokenHandler",
           "type": "address"
         }
       ],

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

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/6d337e35e1a2e4e40425b57181471e9c.json"
+  "buildInfo": "../../../build-info/85066c6f3c5dc0f34dc544d5ab504181.json"
 }

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

@@ -115,6 +115,11 @@
       "name": "ErrorComponentWalletAllowanceTooSmall",
       "type": "error"
     },
+    {
+      "inputs": [],
+      "name": "ErrorComponentWalletNotComponent",
+      "type": "error"
+    },
     {
       "inputs": [
         {
@@ -177,6 +182,19 @@
       "name": "AuthorityUpdated",
       "type": "event"
     },
+    {
+      "anonymous": false,
+      "inputs": [
+        {
+          "indexed": false,
+          "internalType": "uint256",
+          "name": "limit",
+          "type": "uint256"
+        }
+      ],
+      "name": "LogComponentTokenHandlerApproved",
+      "type": "event"
+    },
     {
       "anonymous": false,
       "inputs": [
@@ -240,6 +258,19 @@
       "name": "LogDistributorUpdated",
       "type": "event"
     },
+    {
+      "inputs": [
+        {
+          "internalType": "uint256",
+          "name": "spendingLimitAmount",
+          "type": "uint256"
+        }
+      ],
+      "name": "approveTokenHandler",
+      "outputs": [],
+      "stateMutability": "nonpayable",
+      "type": "function"
+    },
     {
       "inputs": [],
       "name": "authority",
@@ -611,19 +642,6 @@
       "stateMutability": "view",
       "type": "function"
     },
-    {
-      "inputs": [],
-      "name": "getRegistryAddress",
-      "outputs": [
-        {
-          "internalType": "address",
-          "name": "",
-          "type": "address"
-        }
-      ],
-      "stateMutability": "view",
-      "type": "function"
-    },
     {
       "inputs": [],
       "name": "getSetupInfo",
@@ -706,6 +724,19 @@
       "stateMutability": "view",
       "type": "function"
     },
+    {
+      "inputs": [],
+      "name": "getTokenHandler",
+      "outputs": [
+        {
+          "internalType": "contract TokenHandler",
+          "name": "tokenHandler",
+          "type": "address"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
     {
       "inputs": [],
       "name": "getWallet",

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

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/6d337e35e1a2e4e40425b57181471e9c.json"
+  "buildInfo": "../../../build-info/85066c6f3c5dc0f34dc544d5ab504181.json"
 }