Add compatibility warning to confidential token wrapper (#134)

* Add minting wrap note

* Update contracts/token/extensions/ConfidentialFungibleTokenERC20Wrapper.sol

* remove gen-nav

* add gen-nav as local file

* move warning to the top

---------

Co-authored-by: Arr00 <13561405+arr00@users.noreply.github.com>

Author: james-toussaint

contracts/token/extensions/ConfidentialFungibleTokenERC20Wrapper.sol

@@ -14,6 +14,9 @@ import {ConfidentialFungibleToken} from "./../ConfidentialFungibleToken.sol";
  * @dev A wrapper contract built on top of {ConfidentialFungibleToken} that allows wrapping an `ERC20` token
  * into a confidential fungible token. The wrapper contract implements the `IERC1363Receiver` interface
  * which allows users to transfer `ERC1363` tokens directly to the wrapper with a callback to wrap the tokens.
+ *
+ * WARNING: Minting assumes the full amount of the underlying token transfer has been received, hence some non-standard
+ * tokens such as fee-on-transfer or other deflationary-type tokens are not supported by this wrapper.
  */
 abstract contract ConfidentialFungibleTokenERC20Wrapper is ConfidentialFungibleToken, IERC1363Receiver {
     IERC20 private immutable _underlying;

scripts/gen-nav.js

@@ -0,0 +1,75 @@
+#!/usr/bin/env node
+
+const path = require('path');
+const glob = require('glob');
+const startCase = require('lodash.startcase');
+
+const baseDir = process.argv[2];
+
+const files = glob.sync(baseDir + '/**/*.adoc').map(f => path.relative(baseDir, f));
+
+console.log('.API');
+
+function getPageTitle(directory) {
+  switch (directory) {
+    case 'metatx':
+      return 'Meta Transactions';
+    default:
+      return startCase(directory);
+  }
+}
+
+const menuItems = files.reduce(
+  (acc, file) => {
+    let current = acc;
+    const doc = file.replace(baseDir, '');
+
+    const keys = doc
+      .split('/')
+      .filter(Boolean)
+      .map(k => k.replace('.adoc', ''));
+
+    for (let i = 0; i < keys.length; i++) {
+      current = current.items[keys[i]] ??= {
+        name: startCase(keys[i]),
+        dir: keys[i],
+        items: {},
+        doc,
+      };
+    }
+
+    return acc;
+  },
+  {
+    items: {},
+  },
+);
+
+const arrayifyItems = items =>
+  Object.entries(items).map(([k, v]) => {
+    if (Object.keys(v.items ?? {}).length > 0) return [v, arrayifyItems(v.items)];
+    return [k, v];
+  });
+
+const isString = v => typeof v === 'string';
+
+const sortItems = items =>
+  items.sort(([a], [b]) =>
+    (isString(a) ? a : a.name).toLowerCase().localeCompare(isString(b) ? b : b.name, undefined, { numeric: true }),
+  );
+
+const print = (items, level = 1) => {
+  items.forEach(([k, v]) => {
+    if (v.doc || k?.doc)
+      console.log(`${'*'.repeat(level)} xref:${v.doc || k.doc}[${getPageTitle(isString(k) ? k : k.name)}]`);
+    else console.log(`${'*'.repeat(level)} ${getPageTitle(isString(k) ? k : k.name)}`);
+    if (Array.isArray(v)) print(v, level + 1);
+  });
+};
+
+print(
+  sortItems(arrayifyItems(menuItems.items)).map(([k, v]) => {
+    if (v?.length > 0) return [k, sortItems(v)];
+    return [k, v];
+  }),
+);