@etherisc/gif-next 0.0.2-ebbe63d → 0.0.2-f824182-503

package/README.md

@@ -2,7 +2,7 @@
 
 ## Hardhat 
 
-### Commands
+### NPM Commands
 
 ```shell
 npm run build
@@ -13,6 +13,30 @@ npm run test-with-gas
 npm run coverage
 ```
 
+### Deployment 
+
+```
+hh run --network <networkname> scripts/deploy.ts
+```
+
+Networks:
+- hardhat (dynamically created network - https://hardhat.org/hardhat-network/docs/overview)
+- anvil (anvsil chain running in container next when using devcontainer)
+- mumbai (polygon testnet, requires WEB3_INFURA_PROJECT_ID)
+- mainnet (polygon mainnet, requires WEB3_INFURA_PROJECT_ID)
+
+
+### Console
+
+```
+hh console --network <networkname>
+
+me = hre.ethers.Wallet.fromPhrase('...')
+provider = hre.ethers.provider
+await provider.getBalance(me)
+```
+
+
 ### Documentation
 
 https://hardhat.org/hardhat-runner/docs/guides/compile-contracts
@@ -25,9 +49,104 @@ https://hardhat.org/hardhat-runner/docs/guides/compile-contracts
 forge build
 
 forge test
+
+# run single test case
+forge test --mt test_decimals
+
+# run single test case with substantial logginglogging
+# to include logs as well use -vvvvv
+forge test -vvvv --mt test_decimals
+
+# provide gas report for a single test
+forge test --mt test_decimals --gas-report
+
+forge coverage
+```
+
+Chisel session
+```typescript
+import "./contracts/components/Component.sol";
+import "./contracts/components/IPool.sol";
+import "./contracts/components/IProduct.sol";
+import "./contracts/components/Pool.sol";
+import "./contracts/components/Product.sol";
+import "./contracts/instance/access/Access.sol";
+import "./contracts/instance/access/IAccess.sol";
+import "./contracts/instance/component/ComponentModule.sol";
+import "./contracts/instance/component/IComponent.sol";
+import "./contracts/instance/IInstance.sol";
+import "./contracts/instance/policy/IPolicy.sol";
+import "./contracts/instance/policy/PolicyModule.sol";
+import "./contracts/instance/product/IProductService.sol";
+import "./contracts/instance/product/ProductService.sol";
+import "./contracts/registry/IRegistry.sol";
+
+import {Instance} from "./contracts/instance/Instance.sol";
+import {Registry} from "./contracts/registry/Registry.sol";
+import {DeployAll} from "./scripts/DeployAll.s.sol";
+import {TestPool} from "./test_forge/mock/TestPool.sol";
+import {TestProduct} from "./test_forge/mock/TestProduct.sol";
+
+string memory instanceOwnerName = "instanceOwner";
+address instanceOwner = vm.addr(uint256(keccak256(abi.encodePacked(instanceOwnerName))));
+
+string memory productOwnerName = "productOwner";
+address productOwner = vm.addr(uint256(keccak256(abi.encodePacked(productOwnerName))));
+
+string memory poolOwnerName = "poolOwner";
+address poolOwner = vm.addr(uint256(keccak256(abi.encodePacked(poolOwnerName))));
+
+string memory customerName = "customer";
+address customer = vm.addr(uint256(keccak256(abi.encodePacked(customerName))));
+
+DeployAll deployer = new DeployAll();
+(
+    Registry registry, 
+    Instance instance, 
+    TestProduct product,
+    TestPool pool
+) = deployer.run(
+    instanceOwner,
+    productOwner,
+    poolOwner);
+
+ProductService ps = ProductService(address(registry));
+
+uint256 bundleNftId = 99;
+uint256 sumInsuredAmount = 1000*10**6;
+uint256 premiumAmount = 110*10**6;
+uint256 lifetime =365*24*3600;
+uint256 policyNftId = ps.createApplicationForBundle(customer, bundleNftId, sumInsuredAmount, premiumAmount, lifetime);
+
 ```
 
+
 ### Documentation
 
 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/). 
+
+### Automatic code formatting
+
+We use prettier and the solidity plugin to format the code automatically. 
+The plugin is configured to use the style guide mentioned above.
+To execute format checks run `npm run styleCheck`.
+To execute formatting run `npm run styleFix`.
+
+### Linting 
+
+We use solhint to lint the code.
+To execute linting run `npm run lint`.

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

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

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

@@ -0,0 +1,205 @@
+{
+  "_format": "hh-sol-artifact-1",
+  "contractName": "Component",
+  "sourceName": "contracts/components/Component.sol",
+  "abi": [
+    {
+      "anonymous": false,
+      "inputs": [
+        {
+          "indexed": false,
+          "internalType": "uint256",
+          "name": "idx",
+          "type": "uint256"
+        },
+        {
+          "indexed": false,
+          "internalType": "address",
+          "name": "module",
+          "type": "address"
+        },
+        {
+          "indexed": false,
+          "internalType": "string",
+          "name": "comment",
+          "type": "string"
+        }
+      ],
+      "name": "LogDebug",
+      "type": "event"
+    },
+    {
+      "inputs": [],
+      "name": "getData",
+      "outputs": [
+        {
+          "internalType": "bytes",
+          "name": "data",
+          "type": "bytes"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
+    {
+      "inputs": [],
+      "name": "getInitialOwner",
+      "outputs": [
+        {
+          "internalType": "address",
+          "name": "deployer",
+          "type": "address"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
+    {
+      "inputs": [],
+      "name": "getInstance",
+      "outputs": [
+        {
+          "internalType": "contract IInstance",
+          "name": "instance",
+          "type": "address"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
+    {
+      "inputs": [],
+      "name": "getNftId",
+      "outputs": [
+        {
+          "internalType": "NftId",
+          "name": "nftId",
+          "type": "uint96"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
+    {
+      "inputs": [],
+      "name": "getOwner",
+      "outputs": [
+        {
+          "internalType": "address",
+          "name": "owner",
+          "type": "address"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
+    {
+      "inputs": [],
+      "name": "getParentNftId",
+      "outputs": [
+        {
+          "internalType": "NftId",
+          "name": "",
+          "type": "uint96"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
+    {
+      "inputs": [],
+      "name": "getRegistry",
+      "outputs": [
+        {
+          "internalType": "contract IRegistry",
+          "name": "registry",
+          "type": "address"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
+    {
+      "inputs": [],
+      "name": "getToken",
+      "outputs": [
+        {
+          "internalType": "contract IERC20Metadata",
+          "name": "token",
+          "type": "address"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
+    {
+      "inputs": [],
+      "name": "getType",
+      "outputs": [
+        {
+          "internalType": "ObjectType",
+          "name": "objectType",
+          "type": "uint8"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
+    {
+      "inputs": [],
+      "name": "getWallet",
+      "outputs": [
+        {
+          "internalType": "address",
+          "name": "walletAddress",
+          "type": "address"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
+    {
+      "inputs": [],
+      "name": "isRegisterable",
+      "outputs": [
+        {
+          "internalType": "bool",
+          "name": "",
+          "type": "bool"
+        }
+      ],
+      "stateMutability": "pure",
+      "type": "function"
+    },
+    {
+      "inputs": [],
+      "name": "isRegistered",
+      "outputs": [
+        {
+          "internalType": "bool",
+          "name": "",
+          "type": "bool"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
+    {
+      "inputs": [],
+      "name": "register",
+      "outputs": [
+        {
+          "internalType": "NftId",
+          "name": "componentId",
+          "type": "uint96"
+        }
+      ],
+      "stateMutability": "nonpayable",
+      "type": "function"
+    }
+  ],
+  "bytecode": "0x",
+  "deployedBytecode": "0x",
+  "linkReferences": {},
+  "deployedLinkReferences": {}
+}

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

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

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

@@ -0,0 +1,35 @@
+{
+  "_format": "hh-sol-artifact-1",
+  "contractName": "InstanceLinked",
+  "sourceName": "contracts/components/Component.sol",
+  "abi": [
+    {
+      "inputs": [
+        {
+          "internalType": "address",
+          "name": "instance",
+          "type": "address"
+        }
+      ],
+      "stateMutability": "nonpayable",
+      "type": "constructor"
+    },
+    {
+      "inputs": [],
+      "name": "getInstance",
+      "outputs": [
+        {
+          "internalType": "contract IInstance",
+          "name": "instance",
+          "type": "address"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    }
+  ],
+  "bytecode": "0x608060405234801561001057600080fd5b50604051610249380380610249833981810160405281019061003291906100db565b806000806101000a81548173ffffffffffffffffffffffffffffffffffffffff021916908373ffffffffffffffffffffffffffffffffffffffff16021790555050610108565b600080fd5b600073ffffffffffffffffffffffffffffffffffffffff82169050919050565b60006100a88261007d565b9050919050565b6100b88161009d565b81146100c357600080fd5b50565b6000815190506100d5816100af565b92915050565b6000602082840312156100f1576100f0610078565b5b60006100ff848285016100c6565b91505092915050565b610132806101176000396000f3fe6080604052348015600f57600080fd5b506004361060285760003560e01c8063de7b5d1414602d575b600080fd5b60336047565b604051603e919060e3565b60405180910390f35b60008060009054906101000a900473ffffffffffffffffffffffffffffffffffffffff16905090565b600073ffffffffffffffffffffffffffffffffffffffff82169050919050565b6000819050919050565b600060af60ab60a7846070565b6090565b6070565b9050919050565b600060bf82609a565b9050919050565b600060cf8260b6565b9050919050565b60dd8160c6565b82525050565b600060208201905060f6600083018460d6565b9291505056fea2646970667358221220fcb5a0020aae4f4c62be3c6596d758b295998722c0558cf6dbbf52e3b5809cf564736f6c63430008140033",
+  "deployedBytecode": "0x6080604052348015600f57600080fd5b506004361060285760003560e01c8063de7b5d1414602d575b600080fd5b60336047565b604051603e919060e3565b60405180910390f35b60008060009054906101000a900473ffffffffffffffffffffffffffffffffffffffff16905090565b600073ffffffffffffffffffffffffffffffffffffffff82169050919050565b6000819050919050565b600060af60ab60a7846070565b6090565b6070565b9050919050565b600060bf82609a565b9050919050565b600060cf8260b6565b9050919050565b60dd8160c6565b82525050565b600060208201905060f6600083018460d6565b9291505056fea2646970667358221220fcb5a0020aae4f4c62be3c6596d758b295998722c0558cf6dbbf52e3b5809cf564736f6c63430008140033",
+  "linkReferences": {},
+  "deployedLinkReferences": {}
+}

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

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

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

@@ -0,0 +1,255 @@
+{
+  "_format": "hh-sol-artifact-1",
+  "contractName": "IPoolComponent",
+  "sourceName": "contracts/components/IPool.sol",
+  "abi": [
+    {
+      "anonymous": false,
+      "inputs": [
+        {
+          "indexed": false,
+          "internalType": "uint256",
+          "name": "idx",
+          "type": "uint256"
+        },
+        {
+          "indexed": false,
+          "internalType": "address",
+          "name": "module",
+          "type": "address"
+        },
+        {
+          "indexed": false,
+          "internalType": "string",
+          "name": "comment",
+          "type": "string"
+        }
+      ],
+      "name": "LogDebug",
+      "type": "event"
+    },
+    {
+      "inputs": [],
+      "name": "getData",
+      "outputs": [
+        {
+          "internalType": "bytes",
+          "name": "data",
+          "type": "bytes"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
+    {
+      "inputs": [],
+      "name": "getInitialOwner",
+      "outputs": [
+        {
+          "internalType": "address",
+          "name": "initialOwner",
+          "type": "address"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
+    {
+      "inputs": [],
+      "name": "getInstance",
+      "outputs": [
+        {
+          "internalType": "contract IInstance",
+          "name": "instance",
+          "type": "address"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
+    {
+      "inputs": [],
+      "name": "getNftId",
+      "outputs": [
+        {
+          "internalType": "NftId",
+          "name": "nftId",
+          "type": "uint96"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
+    {
+      "inputs": [],
+      "name": "getOwner",
+      "outputs": [
+        {
+          "internalType": "address",
+          "name": "owner",
+          "type": "address"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
+    {
+      "inputs": [],
+      "name": "getParentNftId",
+      "outputs": [
+        {
+          "internalType": "NftId",
+          "name": "parentNftId",
+          "type": "uint96"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
+    {
+      "inputs": [],
+      "name": "getPerformanceFee",
+      "outputs": [
+        {
+          "components": [
+            {
+              "internalType": "UFixed",
+              "name": "fractionalFee",
+              "type": "uint256"
+            },
+            {
+              "internalType": "uint256",
+              "name": "fixedFee",
+              "type": "uint256"
+            }
+          ],
+          "internalType": "struct Fee",
+          "name": "performanceFee",
+          "type": "tuple"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
+    {
+      "inputs": [],
+      "name": "getRegistry",
+      "outputs": [
+        {
+          "internalType": "contract IRegistry",
+          "name": "registry",
+          "type": "address"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
+    {
+      "inputs": [],
+      "name": "getStakingFee",
+      "outputs": [
+        {
+          "components": [
+            {
+              "internalType": "UFixed",
+              "name": "fractionalFee",
+              "type": "uint256"
+            },
+            {
+              "internalType": "uint256",
+              "name": "fixedFee",
+              "type": "uint256"
+            }
+          ],
+          "internalType": "struct Fee",
+          "name": "stakingFee",
+          "type": "tuple"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
+    {
+      "inputs": [],
+      "name": "getToken",
+      "outputs": [
+        {
+          "internalType": "contract IERC20Metadata",
+          "name": "token",
+          "type": "address"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
+    {
+      "inputs": [],
+      "name": "getType",
+      "outputs": [
+        {
+          "internalType": "ObjectType",
+          "name": "objectType",
+          "type": "uint8"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
+    {
+      "inputs": [],
+      "name": "getWallet",
+      "outputs": [
+        {
+          "internalType": "address",
+          "name": "walletAddress",
+          "type": "address"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
+    {
+      "inputs": [],
+      "name": "isRegisterable",
+      "outputs": [
+        {
+          "internalType": "bool",
+          "name": "",
+          "type": "bool"
+        }
+      ],
+      "stateMutability": "pure",
+      "type": "function"
+    },
+    {
+      "inputs": [],
+      "name": "isRegistered",
+      "outputs": [
+        {
+          "internalType": "bool",
+          "name": "",
+          "type": "bool"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
+    {
+      "inputs": [],
+      "name": "register",
+      "outputs": [
+        {
+          "internalType": "NftId",
+          "name": "nftId",
+          "type": "uint96"
+        }
+      ],
+      "stateMutability": "nonpayable",
+      "type": "function"
+    }
+  ],
+  "bytecode": "0x",
+  "deployedBytecode": "0x",
+  "linkReferences": {},
+  "deployedLinkReferences": {}
+}

package/artifacts/contracts/components/IProduct.sol/IProductComponent.dbg.json

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