@1inch/solidity-utils 5.2.3 → 5.3.0

package/docgen/templates/common.hbs

@@ -0,0 +1,38 @@
+{{h}} {{name}}
+
+{{#if signature}}
+```solidity
+{{{signature}}}
+```
+{{/if}}
+{{{natspec.notice}}}
+
+{{#if natspec.dev}}
+_{{{natspec.dev}}}_
+{{/if}}
+
+{{#if params}}
+{{#if (arrayHasDescriptions params)}}
+{{h 2}} Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+{{#each params}}
+| {{name}} | {{type}} | {{{joinLines natspec}}} |
+{{/each}}
+{{/if}}
+{{/if}}
+
+{{#if returns}}
+{{#if (arrayHasDescriptions returns)}}
+
+{{h 2}} Return Values
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+{{#each returns}}
+{{#if name}}{{name}}{{else}}[{{@index}}]{{/if}} | {{type}} | {{{joinLines natspec}}} |
+{{/each}}
+{{/if}}
+{{/if}}
+

package/docgen/templates/contract.hbs

@@ -0,0 +1,73 @@
+{{>common}}
+
+{{#if types}}
+{{h 2}} Types list
+{{#each types}}
+- [{{name}}](#{{lower name}})
+{{/each}}
+{{/if}}
+
+{{#if functions}}
+{{h 2}} Functions list
+{{#each functions}}
+{{>signature}}
+{{/each}}
+{{/if}}
+
+{{#if events}}
+{{h 2}} Events list
+{{#each events}}
+{{>signature}}
+{{/each}}
+{{/if}}
+
+{{#if errors}}
+{{h 2}} Errors list
+{{#each errors}}
+{{>signature}}
+{{/each}}
+{{/if}}
+
+{{#if types}}
+{{h 2}} Types
+{{#hsection}}
+{{#each types}}
+{{>item}}
+{{/each}}
+{{/hsection}}
+{{/if}}
+
+{{#if functions}}
+{{h 2}} Functions
+{{#hsection}}
+{{#each functions}}
+{{>function}}
+{{/each}}
+{{/hsection}}
+{{/if}}
+
+{{#if events}}
+{{h 2}} Events
+{{#hsection}}
+{{#each events}}
+{{>common}}
+{{/each}}
+{{/hsection}}
+{{/if}}
+
+{{#if errors}}
+{{h 2}} Errors
+{{#hsection}}
+{{#each errors}}
+{{>common}}
+{{/each}}
+{{/hsection}}
+{{/if}}
+
+{{!--
+{{#each items}}
+{{#hsection}}
+{{>item}}
+{{/hsection}}
+{{/each}}
+--}}

package/docgen/templates/enum.hbs

@@ -0,0 +1,9 @@
+{{>common}}
+
+```solidity
+enum {{name}} {
+{{#each members}}
+  {{name}}{{#unless @last}},{{/unless}}
+{{/each}}
+}
+```

package/docgen/templates/error.hbs

@@ -0,0 +1 @@
+{{>common}}

package/docgen/templates/event.hbs

@@ -0,0 +1 @@
+{{>common}}

package/docgen/templates/function.hbs

@@ -0,0 +1 @@
+{{>common}}

package/docgen/templates/helpers.js

@@ -0,0 +1,76 @@
+exports.lower = lower;
+exports.isContract = isContract;
+exports.getFunctionsToDisplay = getFunctionsToDisplay;
+exports.findContractById = findContractById;
+exports.arrayHasDescriptions = arrayHasDescriptions;
+// exports
+
+function lower (text) {
+    if (typeof text === 'string') {
+        return text.toLowerCase();
+    }
+}
+
+function isContract(item){
+    return item != undefined && item.nodeType === 'ContractDefinition';
+}
+
+function arrayHasDescriptions(items){
+    if (items != undefined){
+        return items.map(item => item.natspec).filter(natspec => natspec !== undefined).length > 0;
+    }
+    return false;
+}
+
+function getFunctionsToDisplay (baseContractIds, allContracts){
+    const resultMap = [];
+    if (baseContractIds.length > 0){
+        primaryContractFns = getContractFunctions(baseContractIds[0], allContracts);
+        primaryContractFns.map(fn => resultMap.push({id: baseContractIds[0], fnId: fn.id, selector: fn.functionSelector, name: fn.name}));
+
+        for(let i=1; i < baseContractIds.length; i++) {
+            const baseContractId = baseContractIds[i];
+            const functions = getContractFunctions(baseContractId, allContracts);
+
+            const newFn = functions.filter(fn => {
+                //console.log(fn);
+                //console.log(baseContractId, fn.id, fn.name, fn.functionSelector);
+                const exclude = fn.kind === 'constructor' && !(fn.visibility === 'public' || fn.visibility === 'external');
+                const include = resultMap.find(item => item.selector === fn.functionSelector);
+                return !exclude && !include;
+            });
+
+            newFn.map(fn => resultMap.push({id: fn.scope, fnId: fn.id, selector: fn.functionSelector, name: fn.name}));
+        }
+    }
+
+    resultArray = Object.values(resultMap.reduce((acc, item) => {
+        if (!acc[item.id]) {
+            acc[item.id] = {
+                id: item.id,
+                functions: []
+            };
+        }
+        acc[item.id].functions.push({
+            fnId: item.fnId,
+            selector: item.selector,
+            name: item.name
+        });
+        return acc;
+    }, {}));
+
+    //console.log(resultArray);
+
+    return resultArray;
+}
+
+function findContractById (id, allContracts) {
+    return allContracts.find(contract => contract.id === id);
+}
+
+// helpers
+
+getContractFunctions = (id, allContracts) => {
+    const contract = findContractById(id, allContracts);
+    return contract ? contract.functions : [];
+}

package/docgen/templates/modifier.hbs

@@ -0,0 +1 @@
+{{>common}}

package/docgen/templates/page.hbs

@@ -0,0 +1,7 @@
+{{#each items}}
+
+{{#hsection}}
+{{>item}}
+{{/hsection}}
+
+{{/each}}

package/docgen/templates/signature.hbs

@@ -0,0 +1 @@
+- [{{name}}({{#each parameters.parameters}}{{name}}{{#unless @last}}, {{/unless}}{{/each}}) {{visibility}}](#{{lower name}})

package/docgen/templates/struct.hbs

@@ -0,0 +1,9 @@
+{{>common}}
+
+```solidity
+struct {{name}} {
+{{#each members}}
+  {{{typeName.typeDescriptions.typeString}}} {{name}};
+{{/each}}
+}
+```

package/docgen/templates/user-defined-value-type.hbs

@@ -0,0 +1 @@
+{{>common}}

package/docgen/templates/variable.hbs

@@ -0,0 +1 @@
+{{>common}}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@1inch/solidity-utils",
-  "version": "5.2.3",
+  "version": "5.3.0",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",
   "exports": {
@@ -103,6 +103,7 @@
     "contracts/interfaces",
     "contracts/libraries",
     "contracts/mixins",
-    "contracts/mocks"
+    "contracts/mocks",
+    "docgen/templates"
   ]
 }

package/utils/README.md

@@ -35,7 +35,7 @@ const { oneInchTemplates } = require('@1inch/solidity-utils/docgen');
 module.exports = {
 ...
     docgen: {
-        outputDir: "docs", // Can be omitted, docs used by default
+        outputDir: 'docs', // Can be omitted, docs used by default
         templates: oneInchTemplates(), // 1inch templates
         pages: 'files', // Doc output format for 1inch templates
         exclude: ['mocks', 'test'], // Directories to exclude from generation