@rocketh/doc 0.17.6 → 0.17.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +7 -6
- package/dist/index.js.map +1 -1
- package/package.json +12 -11
- package/src/index.ts +7 -7
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACX,UAAU,EACV,QAAQ,EACR,GAAG,EACH,kBAAkB,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACX,UAAU,EACV,QAAQ,EACR,GAAG,EACH,kBAAkB,EAKlB,kBAAkB,EAClB,MAAM,qBAAqB,CAAC;AAQ7B,OAAO,EAAC,iBAAiB,EAAqD,MAAM,YAAY,CAAC;AAGjG,cAAc,YAAY,CAAC;AAI3B,MAAM,MAAM,UAAU,GAAG;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;CAAC,CAAC;AAavF,wBAAsB,GAAG,CAAC,MAAM,EAAE,kBAAkB,EAAE,eAAe,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,iBAMjG;AAED,wBAAsB,QAAQ,CAC7B,EAAC,WAAW,EAAC,EAAE;IAAC,WAAW,EAAE,kBAAkB,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAA;CAAC,EAClE,OAAO,EAAE,UAAU,iBAiBnB;AAED,wBAAsB,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,iBAiBtE;AAgBD,wBAAsB,uBAAuB,CAAC,WAAW,EAAE,kBAAkB,EAAE,OAAO,EAAE,UAAU,iBA0BjG;AAED,wBAAgB,yBAAyB,CACxC,IAAI,EAAE,MAAM,EACZ,oBAAoB,EAAE,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,GAAG,QAAQ,CAAC,GAAG,CAAC,GAC5D,iBAAiB,CAkLnB"}
|
package/dist/index.js
CHANGED
|
@@ -2,9 +2,10 @@ import fs from 'fs-extra';
|
|
|
2
2
|
import { loadDeploymentsFromFiles } from '@rocketh/node';
|
|
3
3
|
import Handlebars from 'handlebars';
|
|
4
4
|
import path from 'path';
|
|
5
|
-
import { Fragment, FunctionFragment } from 'ethers';
|
|
6
5
|
import { dirname } from 'path';
|
|
7
6
|
import { fileURLToPath } from 'url';
|
|
7
|
+
import { formatAbiItem } from 'abitype';
|
|
8
|
+
import { toFunctionSelector } from 'viem';
|
|
8
9
|
export * from './types.js';
|
|
9
10
|
const __dirname = dirname(fileURLToPath(import.meta.url));
|
|
10
11
|
function filter(options, name) {
|
|
@@ -123,7 +124,7 @@ export function generateDocumentationData(name, deploymentOrArfifact) {
|
|
|
123
124
|
if (!abi) {
|
|
124
125
|
continue;
|
|
125
126
|
}
|
|
126
|
-
const fullFormat =
|
|
127
|
+
const fullFormat = formatAbiItem(abi);
|
|
127
128
|
const paramNames = abi.inputs.map((v, index) => v.name || `_${index}`);
|
|
128
129
|
const errorFromUserDoc = deploymentOrArfifact.userdoc.errors[errorSignature];
|
|
129
130
|
const errorFromDevDoc = deploymentOrArfifact.devdoc?.errors?.[errorSignature];
|
|
@@ -170,7 +171,7 @@ export function generateDocumentationData(name, deploymentOrArfifact) {
|
|
|
170
171
|
if (!abi) {
|
|
171
172
|
continue;
|
|
172
173
|
}
|
|
173
|
-
const fullFormat =
|
|
174
|
+
const fullFormat = formatAbiItem(abi);
|
|
174
175
|
const paramNames = abi.inputs.map((v, index) => v.name || `_${index}`);
|
|
175
176
|
const eventFromUserDoc = deploymentOrArfifact.userdoc.events[eventSignature];
|
|
176
177
|
const eventFromDevDoc = deploymentOrArfifact.devdoc?.events?.[eventSignature];
|
|
@@ -198,7 +199,7 @@ export function generateDocumentationData(name, deploymentOrArfifact) {
|
|
|
198
199
|
if (!abi) {
|
|
199
200
|
continue;
|
|
200
201
|
}
|
|
201
|
-
const fullFormat =
|
|
202
|
+
const fullFormat = formatAbiItem(abi);
|
|
202
203
|
const paramNames = abi ? abi.inputs.map((v, index) => v.name || `_${index}`) : undefined;
|
|
203
204
|
const returnNames = abi && 'outputs' in abi ? abi.outputs.map((v, index) => v.name || `_${index}`) : undefined;
|
|
204
205
|
const methodFromUserDoc = deploymentOrArfifact.userdoc.methods[methodSignature];
|
|
@@ -215,7 +216,7 @@ export function generateDocumentationData(name, deploymentOrArfifact) {
|
|
|
215
216
|
returns.push({ name: returnName, description: methodFromDevDoc.returns[returnName] });
|
|
216
217
|
}
|
|
217
218
|
}
|
|
218
|
-
if (
|
|
219
|
+
if (abi.type === 'constructor') {
|
|
219
220
|
methods.push({
|
|
220
221
|
type: 'constructor',
|
|
221
222
|
name: 'constructor',
|
|
@@ -228,7 +229,7 @@ export function generateDocumentationData(name, deploymentOrArfifact) {
|
|
|
228
229
|
});
|
|
229
230
|
}
|
|
230
231
|
else {
|
|
231
|
-
const selector =
|
|
232
|
+
const selector = toFunctionSelector(abi);
|
|
232
233
|
methods.push({
|
|
233
234
|
type: 'function',
|
|
234
235
|
name: methodName,
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,UAAU,CAAC;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,UAAU,CAAC;AAY1B,OAAO,EAAC,wBAAwB,EAAC,MAAM,eAAe,CAAC;AACvD,OAAO,UAAU,MAAM,YAAY,CAAC;AACpC,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAC,OAAO,EAAC,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAC,aAAa,EAAC,MAAM,KAAK,CAAC;AAClC,OAAO,EAAC,aAAa,EAAC,MAAM,SAAS,CAAC;AAGtC,OAAO,EAAC,kBAAkB,EAAC,MAAM,MAAM,CAAC;AAExC,cAAc,YAAY,CAAC;AAE3B,MAAM,SAAS,GAAG,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AAI1D,SAAS,MAAM,CAAC,OAAmB,EAAE,IAAY;IAChD,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;QAC1B,KAAK,MAAM,MAAM,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;YAC3C,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC3B,OAAO,KAAK,CAAC;YACd,CAAC;QACF,CAAC;IACF,CAAC;IACD,OAAO,IAAI,CAAC;AACb,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,GAAG,CAAC,MAA0B,EAAE,eAAuB,EAAE,OAAmB;IACjG,MAAM,EAAC,WAAW,EAAE,OAAO,EAAC,GAAG,MAAM,wBAAwB,CAAC,MAAM,CAAC,WAAW,EAAE,eAAe,CAAC,CAAC;IACnG,IAAI,CAAC,OAAO,EAAE,CAAC;QACd,MAAM,IAAI,KAAK,CAAC,wBAAwB,eAAe,EAAE,CAAC,CAAC;IAC5D,CAAC;IACD,QAAQ,CAAC,EAAC,WAAW,EAAC,EAAE,OAAO,CAAC,CAAC;AAClC,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,QAAQ,CAC7B,EAAC,WAAW,EAAsD,EAClE,OAAmB;IAEnB,IAAI,CAAC,WAAW,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC3D,OAAO,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAC;QACxC,OAAO;IACR,CAAC;IAED,MAAM,UAAU,GAAuB,EAAE,CAAC;IAC1C,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;QAC7C,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC;YAC5B,SAAS;QACV,CAAC;QACD,MAAM,UAAU,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;QACrC,UAAU,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC;IAC/B,CAAC;IAED,OAAO,uBAAuB,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;AACrD,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,MAAc,EAAE,OAAmB;IACtE,MAAM,KAAK,GAAG,EAAE,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IACrC,MAAM,WAAW,GAAuB,EAAE,CAAC;IAC3C,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QAC1B,IAAI,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;YAC5B,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;YAC1C,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC;gBAC5B,SAAS;YACV,CAAC;YAED,MAAM,gBAAgB,GAAG,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC;YAC3E,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;YAChD,WAAW,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC;QAChC,CAAC;IACF,CAAC;IAED,OAAO,uBAAuB,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;AACtD,CAAC;AAED,gHAAgH;AAChH,yCAAyC;AACzC,+CAA+C;AAC/C,+BAA+B;AAC/B,kCAAkC;AAClC,iFAAiF;AACjF,sDAAsD;AACtD,6DAA6D;AAC7D,MAAM;AACN,KAAK;AAEL,yDAAyD;AACzD,IAAI;AAEJ,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAAC,WAA+B,EAAE,OAAmB;IACjG,MAAM,YAAY,GAAG,OAAO,CAAC,MAAM,IAAI,MAAM,CAAC;IAC9C,MAAM,gBAAgB,GAAG,OAAO,CAAC,QAAQ,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,+CAA+C,CAAC,CAAC;IACnH,MAAM,YAAY,GAAG,IAAI,CAAC,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC,CAAC;IAC7D,MAAM,eAAe,GAAG,EAAE,CAAC,YAAY,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;IACnE,MAAM,QAAQ,GAAG,UAAU,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;IAErD,MAAM,eAAe,GAAwB,EAAE,CAAC;IAChD,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;QAC7C,MAAM,UAAU,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;QACrC,MAAM,IAAI,GAAG,yBAAyB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QACzD,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAED,EAAE,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;IAC9B,IAAI,YAAY,KAAK,eAAe,EAAE,CAAC;QACtC,KAAK,MAAM,UAAU,IAAI,eAAe,EAAE,CAAC;YAC1C,MAAM,SAAS,GAAG,QAAQ,CAAC,UAAU,CAAC,CAAC;YACvC,IAAI,SAAS,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;gBAC7B,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,UAAU,CAAC,IAAI,GAAG,KAAK,CAAC,EAAE,SAAS,CAAC,CAAC;YAC/E,CAAC;QACF,CAAC;IACF,CAAC;SAAM,CAAC;QACP,MAAM,SAAS,GAAG,QAAQ,CAAC,EAAC,SAAS,EAAE,eAAe,EAAC,CAAC,CAAC;QACzD,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,YAAY,GAAG,KAAK,CAAC,EAAE,SAAS,CAAC,CAAC;IAC5E,CAAC;AACF,CAAC;AAED,MAAM,UAAU,yBAAyB,CACxC,IAAY,EACZ,oBAA8D;IAE9D,MAAM,GAAG,GAAG,oBAAoB,CAAC,GAAG,CAAC;IACrC,MAAM,MAAM,GAAG,IAAI,GAAG,EAA8D,CAAC;IACrF,KAAK,MAAM,UAAU,IAAI,GAAG,EAAE,CAAC;QAC9B,QAAQ,UAAU,CAAC,IAAI,EAAE,CAAC;YACzB,KAAK,aAAa;gBACjB,MAAM,CAAC,GAAG,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC;gBACtC,MAAM;YACP,KAAK,OAAO;gBACX,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;gBACxC,MAAM;YACP,KAAK,OAAO;gBACX,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;gBACxC,MAAM;YACP,KAAK,UAAU;gBACd,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;gBACxC,MAAM;QACR,CAAC;IACF,CAAC;IAED,MAAM,MAAM,GAAe,EAAE,CAAC;IAC9B,MAAM,MAAM,GAAe,EAAE,CAAC;IAC9B,MAAM,OAAO,GAAgB,EAAE,CAAC;IAEhC,IAAI,oBAAoB,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC;QAC1C,+BAA+B;QAC/B,KAAK,MAAM,cAAc,IAAI,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAC/E,MAAM,SAAS,GACd,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,EAAE,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC;YAEzG,MAAM,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC,SAAS,CAAa,CAAC;YAC9C,IAAI,CAAC,GAAG,EAAE,CAAC;gBACV,SAAS;YACV,CAAC;YACD,MAAM,UAAU,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC;YACtC,MAAM,UAAU,GAAG,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,IAAI,KAAK,EAAE,CAAC,CAAC;YAEvE,MAAM,gBAAgB,GAAG,oBAAoB,CAAC,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;YAC7E,MAAM,eAAe,GAAG,oBAAoB,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,cAAc,CAAC,CAAC;YAC9E,MAAM,MAAM,GAAe,EAAE,CAAC;YAC9B,IAAI,eAAe,EAAE,CAAC;gBACrB,KAAK,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;oBACnC,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;wBAChB,KAAK,MAAM,SAAS,IAAI,UAAU,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;4BAC/D,MAAM,CAAC,IAAI,CAAC,EAAC,IAAI,EAAE,SAAS,EAAE,WAAW,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,EAAC,CAAC,CAAC;wBACpE,CAAC;wBACD,yBAAyB;wBACzB,sDAAsD;oBACvD,CAAC;gBACF,CAAC;YACF,CAAC;YACD,MAAM,MAAM,GAAa,EAAE,CAAC;YAC5B,IAAI,gBAAgB,EAAE,CAAC;gBACtB,KAAK,MAAM,GAAG,IAAI,gBAAgB,EAAE,CAAC;oBACpC,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;wBAChB,MAAM,KAAK,GAAG,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;wBACrC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;4BAC1B,IAAI,IAAI,IAAI,EAAE,EAAE,CAAC;gCAChB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;4BACnB,CAAC;wBACF,CAAC;oBACF,CAAC;gBACF,CAAC;YACF,CAAC;YAED,MAAM,CAAC,IAAI,CAAC;gBACX,IAAI,EAAE,SAAS;gBACf,SAAS,EAAE,cAAc;gBACzB,GAAG,EAAE,GAAG;gBACR,UAAU;gBACV,MAAM;gBACN,MAAM;aACN,CAAC,CAAC;QACJ,CAAC;IACF,CAAC;IAED,IAAI,oBAAoB,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC;QAC1C,+BAA+B;QAC/B,KAAK,MAAM,cAAc,IAAI,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAC/E,MAAM,SAAS,GACd,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,EAAE,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC;YAEzG,MAAM,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC,SAAS,CAAa,CAAC;YAC9C,IAAI,CAAC,GAAG,EAAE,CAAC;gBACV,SAAS;YACV,CAAC;YACD,MAAM,UAAU,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC;YACtC,MAAM,UAAU,GAAG,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,IAAI,KAAK,EAAE,CAAC,CAAC;YAEvE,MAAM,gBAAgB,GAAG,oBAAoB,CAAC,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;YAC7E,MAAM,eAAe,GAAG,oBAAoB,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,cAAc,CAAC,CAAC;YAC9E,MAAM,MAAM,GAAe,EAAE,CAAC;YAC9B,IAAI,eAAe,EAAE,MAAM,EAAE,CAAC;gBAC7B,KAAK,MAAM,SAAS,IAAI,UAAU,IAAI,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,EAAE,CAAC;oBAC3E,MAAM,CAAC,IAAI,CAAC,EAAC,IAAI,EAAE,SAAS,EAAE,WAAW,EAAE,eAAe,CAAC,MAAM,CAAC,SAAS,CAAC,EAAC,CAAC,CAAC;gBAChF,CAAC;YACF,CAAC;YAED,MAAM,CAAC,IAAI,CAAC;gBACX,IAAI,EAAE,SAAS;gBACf,SAAS,EAAE,cAAc;gBACzB,GAAG,EAAE,GAAe;gBACpB,UAAU;gBACV,MAAM,EAAE,gBAAgB,CAAC,MAAM;gBAC/B,MAAM;aACN,CAAC,CAAC;QACJ,CAAC;IACF,CAAC;IAED,IAAI,oBAAoB,CAAC,OAAO,EAAE,OAAO,EAAE,CAAC;QAC3C,+BAA+B;QAC/B,KAAK,MAAM,eAAe,IAAI,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YACjF,MAAM,UAAU,GACf,eAAe,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,EAAE,eAAe,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC;YAE7G,MAAM,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC,UAAU,CAAiC,CAAC;YACnE,IAAI,CAAC,GAAG,EAAE,CAAC;gBACV,SAAS;YACV,CAAC;YACD,MAAM,UAAU,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC;YACtC,MAAM,UAAU,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YACzF,MAAM,WAAW,GAAG,GAAG,IAAI,SAAS,IAAI,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAE/G,MAAM,iBAAiB,GAAG,oBAAoB,CAAC,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;YAChF,MAAM,gBAAgB,GAAG,oBAAoB,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC,eAAe,CAAC,CAAC;YACjF,MAAM,MAAM,GAAe,EAAE,CAAC;YAC9B,IAAI,gBAAgB,EAAE,MAAM,EAAE,CAAC;gBAC9B,KAAK,MAAM,SAAS,IAAI,UAAU,IAAI,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,EAAE,CAAC;oBAC5E,MAAM,CAAC,IAAI,CAAC,EAAC,IAAI,EAAE,SAAS,EAAE,WAAW,EAAE,gBAAgB,CAAC,MAAM,CAAC,SAAS,CAAC,EAAC,CAAC,CAAC;gBACjF,CAAC;YACF,CAAC;YACD,MAAM,OAAO,GAAgB,EAAE,CAAC;YAChC,IAAI,gBAAgB,EAAE,OAAO,EAAE,CAAC;gBAC/B,KAAK,MAAM,UAAU,IAAI,WAAW,IAAI,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,EAAE,CAAC;oBAC/E,OAAO,CAAC,IAAI,CAAC,EAAC,IAAI,EAAE,UAAU,EAAE,WAAW,EAAE,gBAAgB,CAAC,OAAO,CAAC,UAAU,CAAC,EAAC,CAAC,CAAC;gBACrF,CAAC;YACF,CAAC;YAED,IAAI,GAAG,CAAC,IAAI,KAAK,aAAa,EAAE,CAAC;gBAChC,OAAO,CAAC,IAAI,CAAC;oBACZ,IAAI,EAAE,aAAa;oBACnB,IAAI,EAAE,aAAa;oBACnB,GAAG,EAAE,GAAqB;oBAC1B,SAAS,EAAE,eAAe;oBAC1B,UAAU;oBACV,MAAM,EAAE,iBAAiB,CAAC,MAAM;oBAChC,MAAM;oBACN,OAAO;iBACP,CAAC,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACP,MAAM,QAAQ,GAAG,kBAAkB,CAAC,GAAG,CAAC,CAAC;gBACzC,OAAO,CAAC,IAAI,CAAC;oBACZ,IAAI,EAAE,UAAU;oBAChB,IAAI,EAAE,UAAU;oBAChB,GAAG,EAAE,GAAkB;oBACvB,SAAS,EAAE,eAAe;oBAC1B,UAAU;oBACV,MAAM,EAAE,QAAQ;oBAChB,MAAM,EAAE,iBAAiB,CAAC,MAAM;oBAChC,MAAM;oBACN,OAAO;iBACP,CAAC,CAAC;YACJ,CAAC;QACF,CAAC;IACF,CAAC;IAED,MAAM,IAAI,GAAsB;QAC/B,IAAI;QACJ,OAAO,EAAE,oBAAoB,CAAC,OAAO;QACrC,GAAG;QACH,MAAM,EAAE,oBAAoB,CAAC,MAAM,EAAE,MAAM;QAC3C,KAAK,EAAE,oBAAoB,CAAC,MAAM,EAAE,KAAK;QACzC,MAAM,EAAE,oBAAoB,CAAC,OAAO,EAAE,MAAM;QAC5C,MAAM;QACN,MAAM;QACN,OAAO;KACP,CAAC;IACF,OAAO,IAAI,CAAC;AACb,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@rocketh/doc",
|
|
3
|
-
"version": "0.17.
|
|
3
|
+
"version": "0.17.8",
|
|
4
4
|
"description": "can generate doc from rocketh deployments and provided template",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"access": "public"
|
|
@@ -25,23 +25,24 @@
|
|
|
25
25
|
"public",
|
|
26
26
|
"src"
|
|
27
27
|
],
|
|
28
|
+
"dependencies": {
|
|
29
|
+
"@types/fs-extra": "^11.0.4",
|
|
30
|
+
"abitype": "^1.2.1",
|
|
31
|
+
"commander": "^14.0.2",
|
|
32
|
+
"fs-extra": "^11.3.2",
|
|
33
|
+
"handlebars": "^4.7.8",
|
|
34
|
+
"viem": "^2.41.2",
|
|
35
|
+
"@rocketh/core": "0.17.6"
|
|
36
|
+
},
|
|
28
37
|
"devDependencies": {
|
|
29
38
|
"@types/node": "^24.10.2",
|
|
30
39
|
"as-soon": "^0.0.11",
|
|
31
40
|
"rimraf": "^6.1.2",
|
|
32
41
|
"typescript": "^5.9.3",
|
|
33
|
-
"@rocketh/
|
|
34
|
-
"@rocketh/node": "0.17.6"
|
|
42
|
+
"@rocketh/node": "0.17.8"
|
|
35
43
|
},
|
|
36
44
|
"peerDependencies": {
|
|
37
|
-
"@rocketh/node": "0.17.
|
|
38
|
-
},
|
|
39
|
-
"dependencies": {
|
|
40
|
-
"@types/fs-extra": "^11.0.4",
|
|
41
|
-
"commander": "^14.0.2",
|
|
42
|
-
"ethers": "^6.16.0",
|
|
43
|
-
"fs-extra": "^11.3.2",
|
|
44
|
-
"handlebars": "^4.7.8"
|
|
45
|
+
"@rocketh/node": "0.17.8"
|
|
45
46
|
},
|
|
46
47
|
"scripts": {
|
|
47
48
|
"build": "tsc --project tsconfig.json",
|
package/src/index.ts
CHANGED
|
@@ -8,17 +8,17 @@ import type {
|
|
|
8
8
|
AbiFunction,
|
|
9
9
|
AbiError,
|
|
10
10
|
AbiEvent,
|
|
11
|
-
UserConfig,
|
|
12
11
|
ResolvedUserConfig,
|
|
13
12
|
} from '@rocketh/core/types';
|
|
14
13
|
import {loadDeploymentsFromFiles} from '@rocketh/node';
|
|
15
14
|
import Handlebars from 'handlebars';
|
|
16
15
|
import path from 'path';
|
|
17
|
-
import {Fragment, FunctionFragment} from 'ethers';
|
|
18
16
|
import {dirname} from 'path';
|
|
19
17
|
import {fileURLToPath} from 'url';
|
|
18
|
+
import {formatAbiItem} from 'abitype';
|
|
20
19
|
|
|
21
20
|
import {DocumentationData, ErrorDoc, EventDoc, MethodDoc, ParamDoc, ReturnDoc} from './types.js';
|
|
21
|
+
import {toFunctionSelector} from 'viem';
|
|
22
22
|
|
|
23
23
|
export * from './types.js';
|
|
24
24
|
|
|
@@ -164,7 +164,7 @@ export function generateDocumentationData(
|
|
|
164
164
|
if (!abi) {
|
|
165
165
|
continue;
|
|
166
166
|
}
|
|
167
|
-
const fullFormat =
|
|
167
|
+
const fullFormat = formatAbiItem(abi);
|
|
168
168
|
const paramNames = abi.inputs.map((v, index) => v.name || `_${index}`);
|
|
169
169
|
|
|
170
170
|
const errorFromUserDoc = deploymentOrArfifact.userdoc.errors[errorSignature];
|
|
@@ -216,7 +216,7 @@ export function generateDocumentationData(
|
|
|
216
216
|
if (!abi) {
|
|
217
217
|
continue;
|
|
218
218
|
}
|
|
219
|
-
const fullFormat =
|
|
219
|
+
const fullFormat = formatAbiItem(abi);
|
|
220
220
|
const paramNames = abi.inputs.map((v, index) => v.name || `_${index}`);
|
|
221
221
|
|
|
222
222
|
const eventFromUserDoc = deploymentOrArfifact.userdoc.events[eventSignature];
|
|
@@ -249,7 +249,7 @@ export function generateDocumentationData(
|
|
|
249
249
|
if (!abi) {
|
|
250
250
|
continue;
|
|
251
251
|
}
|
|
252
|
-
const fullFormat =
|
|
252
|
+
const fullFormat = formatAbiItem(abi);
|
|
253
253
|
const paramNames = abi ? abi.inputs.map((v, index) => v.name || `_${index}`) : undefined;
|
|
254
254
|
const returnNames = abi && 'outputs' in abi ? abi.outputs.map((v, index) => v.name || `_${index}`) : undefined;
|
|
255
255
|
|
|
@@ -268,7 +268,7 @@ export function generateDocumentationData(
|
|
|
268
268
|
}
|
|
269
269
|
}
|
|
270
270
|
|
|
271
|
-
if (
|
|
271
|
+
if (abi.type === 'constructor') {
|
|
272
272
|
methods.push({
|
|
273
273
|
type: 'constructor',
|
|
274
274
|
name: 'constructor',
|
|
@@ -280,7 +280,7 @@ export function generateDocumentationData(
|
|
|
280
280
|
returns,
|
|
281
281
|
});
|
|
282
282
|
} else {
|
|
283
|
-
const selector =
|
|
283
|
+
const selector = toFunctionSelector(abi);
|
|
284
284
|
methods.push({
|
|
285
285
|
type: 'function',
|
|
286
286
|
name: methodName,
|