@etherisc/gif-next 0.0.2-cff6256-424 → 0.0.2-d086e6d-456

package/README.md

@@ -1,5 +1,23 @@
 # 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
@@ -51,7 +69,7 @@ hh docgen
 The resulting markdown files are written to `docs`
 
 
-### Deployment 
+### Full protocol deployment 
 
 Install the dependencies before running the script below for the first time.
 
@@ -81,6 +99,25 @@ Environment variables:
 - `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)
 
+### Create a new instance
+
+Requires previous step to be completed. 
+
+```bash
+# set appropriate values vor env variables (see below)
+
+hh run --network <networkname> scripts/new_instance.ts
+```
+
+Currently an HD wallet is expected to be used for the deployment. The mnemonic of the wallet needs to be provided via the `WALLET_MNEMONIC` environment variable. 
+The instance owner will be the 11th address of the wallet.
+
+Environment variables:
+
+- `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)
+- `REGISTRY_ADDRESS` the address of the registry that is already deployed and configured and has a valid master instance
+
 
 ### Console
 
@@ -373,9 +410,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
 
@@ -419,3 +515,46 @@ 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
+
+## Contract Organisation
+
+now 
+
+contracts
+  components
+  instance
+  registry
+  shared
+  types
+
+
+contracts
+  component
+    pool
+      Pool.sol
+      PoolService.sol
+    oracle
+    distribution
+    product
+      Product.sol
+      ProductService.sol
+    Component.sol
+    ComponentService.sol
+  instance
+    Instance.sol
+    InstanceAccessManager.sol
+    InstanceReader.sol
+    InstanceService.sol
+    InstanceServiceManager.sol
+  registry
+    ChainNft.sol
+    Registry.sol
+    RegistryService.sol
+    RegistryServiceManager.sol
+  shared
+    Registerable.sol
+    RegisterableUpgradable.sol
+  type
+    NftId.sol
+    ObjectType.sol
+

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

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