@etherisc/gif-next 0.0.2-ce8407f-016 → 0.0.2-ce87da3-250

package/README.md

@@ -1,4 +1,17 @@
-# gif-next (Generic Insurance Framework next version)
+# 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
 
@@ -40,7 +53,18 @@ npm run test-with-gas
 npm run coverage
 ```
 
-### Deployment 
+### Docgen
+
+Produce `solidty-docgen` documentation using the command below.
+
+```shell
+hh docgen
+```
+
+The resulting markdown files are written to `docs`
+
+
+### Full protocol deployment 
 
 Install the dependencies before running the script below for the first time.
 
@@ -70,6 +94,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
 
@@ -108,7 +151,11 @@ forge test -vvvv --mt test_decimals
 # provide gas report for a single test
 forge test --mt test_decimals --gas-report
 
+# provide code coverage report
 forge coverage
+forge coverage --report lcov 
+
+
 ```
 
 Chisel session
@@ -272,6 +319,157 @@ pool_id = pool.getNftId()
 product_id = product.getNftId()
 ```
 
+## Objects
+
+### Registry
+
+Mandatory properties
+
+* One registry per chain
+* Global registry: the registry on mainnet
+* One entry per protocol object
+* Once registered object properties are immutable
+* Globally unique NFT minted per protocol object (chain id is embedded in NFT id)
+* Object ownership defined by NFT ownernship
+* Typed objects (instance, product, policy, ...)
+* Each object has parent object (only one exception: protocol object does not have parent object)
+* Parent object type is defined by type of child object
+
+Object properties (for smart contracts)
+* Objects that represent a smart contract record its contract address
+* With one exception (see next point) smart contract addresses refer to the address on the same chain as the registry
+* The global registry also holds entries for all the registries on different chains than mainnet, in these cases the addresses refer to the chains of these chain specific registries (this is the only case where registered addresses do not refer to the same chain)
+
+Optional properties
+
+* Objects can have names
+* Object names are unique per chain
+* Objects may define an intercepting property, in which case a predefined smart contract is involved in NFT transfers of the objects NFT (transfer may trigger actions, transfer may be blocked etc)
+* 
+
+Ownership property
+
+* Object ownership defined by ownership of NFT representing the object
+* Protocol
+  * Fixed/predefined owner (address without private key)
+* Registry
+  * Allows registration of token and services (per major release)
+  * May transfer ownership
+* Token
+  * Fixed/predefined owner (address without private key)
+  * TODO add whitelisting for token per major release
+* Service
+  * Allows upgrades of services as long as major version is same
+  * Until further notice the same entity as the registry owner
+  * May transfer ownership
+* Instance
+  * Granting/revoking of roles (both default + custom)
+  * Management of custom roles and targets
+  * May lock instance and/or components
+  * May transfer ownership
+* Component (Product, Pool, Distribution, Oracle)
+  * Register component
+  * Set component wallet (which receives fees, holds funds)
+  * May lock component
+  * May transfer ownership
+  * Additional use case specific features
+* Policy
+  * Represents policy holder
+  * Receive payouts (GIF default behaviour)
+  * May transfer ownership
+* Bundle
+  * Represents funds owner
+  * May withdraw funds not locked by active policies
+  * May transfer ownership
+* Distributor
+  * Receives commissions from sales (GIF default behaviour)
+  * May transfer ownership
+
+Intercepting property
+  * Service owner is indirectly owner of service manager contract
+
+* Instance
+  * intercepts transfer of instance owner (new owner needs access manager admin rights for custom roles and targets)
+  * intercepts transfer of components, to do what? check that new owner has necessary roles?
+* Product
+  * intercepts transfer of policies (use case specific: eg. limit/disallow transfers)
+* Pool:
+  * intercepts transfer of bundles (use case specific: eg. limit/disallow transfers)
+* Distribution
+  * intercepts transfer of distributors (bookkeeping: only one distributor per address allowed)
+* Oracle
+  * likely meaningless
+
+
+### Instance
+
+### 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
+
+### Oracle
+
 ## Registry and Services
 
 ### Principles
@@ -312,3 +510,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/411935aa5ced2268e7cc8aae71d3a605.json"
+}