@rocketh/doc 0.10.8 → 0.10.10
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/cli.cjs +0 -0
- package/dist/esm/cli.d.ts +3 -0
- package/dist/esm/cli.d.ts.map +1 -0
- package/dist/esm/cli.js +22 -0
- package/dist/esm/cli.js.map +1 -0
- package/dist/esm/index.d.ts +17 -0
- package/dist/esm/index.d.ts.map +1 -0
- package/dist/esm/index.js +259 -0
- package/dist/esm/index.js.map +1 -0
- package/dist/esm/types.d.ts +60 -0
- package/dist/esm/types.d.ts.map +1 -0
- package/dist/esm/types.js +2 -0
- package/dist/esm/types.js.map +1 -0
- package/package.json +11 -16
- package/src/cli.ts +3 -3
- package/src/index.ts +2 -2
package/dist/cli.cjs
CHANGED
|
File without changes
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../../src/cli.ts"],"names":[],"mappings":""}
|
package/dist/esm/cli.js
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
#! /usr/bin/env node
|
|
2
|
+
import { readAndResolveConfig } from 'rocketh';
|
|
3
|
+
import { run } from './index.js';
|
|
4
|
+
import { Command } from 'commander';
|
|
5
|
+
import pkg from '../package.json' with { type: 'json' };
|
|
6
|
+
const commandName = pkg.name;
|
|
7
|
+
const program = new Command();
|
|
8
|
+
program
|
|
9
|
+
.name(commandName)
|
|
10
|
+
.description('generate doc from deployments and provided templates')
|
|
11
|
+
.version(pkg.version)
|
|
12
|
+
.option('-d, --deployments <value>', 'folder where deployments are saved')
|
|
13
|
+
.option('-o, --output <value>', 'folder where to generate docs')
|
|
14
|
+
.option('-t, --template <value>', 'template used to generate docs')
|
|
15
|
+
.option('--except-suffix <suffix, suffix....>', 'ignore contract that ends with the provided suffixes')
|
|
16
|
+
.requiredOption('-n, --network <value>', 'network context to use')
|
|
17
|
+
.parse(process.argv);
|
|
18
|
+
const options = program.opts();
|
|
19
|
+
options.exceptSuffix = options.exceptSuffix?.split(',') || [];
|
|
20
|
+
const resolvedConfig = readAndResolveConfig({ ...options, ignoreMissingRPC: true });
|
|
21
|
+
run(resolvedConfig, options);
|
|
22
|
+
//# sourceMappingURL=cli.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"cli.js","sourceRoot":"","sources":["../../src/cli.ts"],"names":[],"mappings":";AACA,OAAO,EAAC,oBAAoB,EAAC,MAAM,SAAS,CAAC;AAC7C,OAAO,EAAC,GAAG,EAAC,MAAM,YAAY,CAAC;AAC/B,OAAO,EAAC,OAAO,EAAC,MAAM,WAAW,CAAC;AAClC,OAAO,GAAG,MAAM,iBAAiB,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAC;AAItD,MAAM,WAAW,GAAG,GAAG,CAAC,IAAI,CAAC;AAE7B,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;AAC9B,OAAO;KACL,IAAI,CAAC,WAAW,CAAC;KACjB,WAAW,CAAC,sDAAsD,CAAC;KACnE,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC;KACpB,MAAM,CAAC,2BAA2B,EAAE,oCAAoC,CAAC;KACzE,MAAM,CAAC,sBAAsB,EAAE,+BAA+B,CAAC;KAC/D,MAAM,CAAC,wBAAwB,EAAE,gCAAgC,CAAC;KAClE,MAAM,CAAC,sCAAsC,EAAE,sDAAsD,CAAC;KACtG,cAAc,CAAC,uBAAuB,EAAE,wBAAwB,CAAC;KACjE,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AAEtB,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;AAC/B,OAAO,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,EAAE,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;AAC9D,MAAM,cAAc,GAAG,oBAAoB,CAAC,EAAC,GAAI,OAAyB,EAAE,gBAAgB,EAAE,IAAI,EAAC,CAAC,CAAC;AACrG,GAAG,CAAC,cAAc,EAAE,OAAqB,CAAC,CAAC"}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import type { Deployment, ResolvedConfig, Artifact, Abi, UnknownDeployments } from 'rocketh';
|
|
2
|
+
import { DocumentationData } from './types.js';
|
|
3
|
+
export * from './types.js';
|
|
4
|
+
export type RunOptions = {
|
|
5
|
+
template?: string;
|
|
6
|
+
output?: string;
|
|
7
|
+
exceptSuffix?: string[];
|
|
8
|
+
};
|
|
9
|
+
export declare function run(config: ResolvedConfig, options: RunOptions): Promise<void>;
|
|
10
|
+
export declare function generate({ deployments }: {
|
|
11
|
+
deployments: UnknownDeployments;
|
|
12
|
+
chainId?: string;
|
|
13
|
+
}, options: RunOptions): Promise<void>;
|
|
14
|
+
export declare function runFromFolder(folder: string, options: RunOptions): Promise<void>;
|
|
15
|
+
export declare function generateFromDeployments(deployments: UnknownDeployments, options: RunOptions): Promise<void>;
|
|
16
|
+
export declare function generateDocumentationData(name: string, deploymentOrArfifact: Partial<Deployment<Abi>> & Artifact<Abi>): DocumentationData;
|
|
17
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACX,UAAU,EACV,cAAc,EAEd,QAAQ,EACR,GAAG,EACH,kBAAkB,EAKlB,MAAM,SAAS,CAAC;AAQjB,OAAO,EAAC,iBAAiB,EAAqD,MAAM,YAAY,CAAC;AAEjG,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,cAAc,EAAE,OAAO,EAAE,UAAU,iBAMpE;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"}
|
|
@@ -0,0 +1,259 @@
|
|
|
1
|
+
import fs from 'fs-extra';
|
|
2
|
+
import { loadDeployments } from 'rocketh';
|
|
3
|
+
import Handlebars from 'handlebars';
|
|
4
|
+
import path from 'path';
|
|
5
|
+
import { Fragment, FunctionFragment } from 'ethers';
|
|
6
|
+
import { dirname } from 'path';
|
|
7
|
+
import { fileURLToPath } from 'url';
|
|
8
|
+
export * from './types.js';
|
|
9
|
+
const __dirname = dirname(fileURLToPath(import.meta.url));
|
|
10
|
+
function filter(options, name) {
|
|
11
|
+
if (options.exceptSuffix) {
|
|
12
|
+
for (const suffix of options.exceptSuffix) {
|
|
13
|
+
if (name.endsWith(suffix)) {
|
|
14
|
+
return false;
|
|
15
|
+
}
|
|
16
|
+
}
|
|
17
|
+
}
|
|
18
|
+
return true;
|
|
19
|
+
}
|
|
20
|
+
export async function run(config, options) {
|
|
21
|
+
const { deployments, chainId } = loadDeployments(config.deployments, config.network.name);
|
|
22
|
+
if (!chainId) {
|
|
23
|
+
throw new Error(`no chainId found for ${config.network.name}`);
|
|
24
|
+
}
|
|
25
|
+
generate({ deployments }, options);
|
|
26
|
+
}
|
|
27
|
+
export async function generate({ deployments }, options) {
|
|
28
|
+
if (!deployments || Object.keys(deployments).length === 0) {
|
|
29
|
+
console.log(`no deployments to export`);
|
|
30
|
+
return;
|
|
31
|
+
}
|
|
32
|
+
const toDocument = {};
|
|
33
|
+
for (const name of Object.keys(deployments)) {
|
|
34
|
+
if (!filter(options, name)) {
|
|
35
|
+
continue;
|
|
36
|
+
}
|
|
37
|
+
const deployment = deployments[name];
|
|
38
|
+
toDocument[name] = deployment;
|
|
39
|
+
}
|
|
40
|
+
return generateFromDeployments(toDocument, options);
|
|
41
|
+
}
|
|
42
|
+
export async function runFromFolder(folder, options) {
|
|
43
|
+
const files = fs.readdirSync(folder);
|
|
44
|
+
const deployments = {};
|
|
45
|
+
for (const file of files) {
|
|
46
|
+
if (file.endsWith('.json')) {
|
|
47
|
+
const name = path.basename(file, '.json');
|
|
48
|
+
if (!filter(options, name)) {
|
|
49
|
+
continue;
|
|
50
|
+
}
|
|
51
|
+
const deploymentString = fs.readFileSync(path.join(folder, file), 'utf-8');
|
|
52
|
+
const deployment = JSON.parse(deploymentString);
|
|
53
|
+
deployments[name] = deployment;
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
return generateFromDeployments(deployments, options);
|
|
57
|
+
}
|
|
58
|
+
// export async function runFromArtifacts(folder: string, options: {template?: string; outputFolder?: string}) {
|
|
59
|
+
// const files = fs.readdirSync(folder);
|
|
60
|
+
// const deployments: UnknownDeployments = {};
|
|
61
|
+
// for (const file of files) {
|
|
62
|
+
// if (file.endsWith('.json')) {
|
|
63
|
+
// const deploymentString = fs.readFileSync(path.join(folder, file), 'utf-8');
|
|
64
|
+
// const deployment = JSON.parse(deploymentString);
|
|
65
|
+
// deployments[path.basename(file, '.json')] = deployment;
|
|
66
|
+
// }
|
|
67
|
+
// }
|
|
68
|
+
// return generateFromDeployments(deployments, options);
|
|
69
|
+
// }
|
|
70
|
+
export async function generateFromDeployments(deployments, options) {
|
|
71
|
+
const outputFolder = options.output || 'docs';
|
|
72
|
+
const templateFilepath = options.template || path.join(__dirname, '../public/default_templates/{{contracts}}.hbs');
|
|
73
|
+
const templateName = path.basename(templateFilepath, '.hbs');
|
|
74
|
+
const templateContent = fs.readFileSync(templateFilepath, 'utf-8');
|
|
75
|
+
const template = Handlebars.compile(templateContent);
|
|
76
|
+
const deploymentsList = [];
|
|
77
|
+
for (const name of Object.keys(deployments)) {
|
|
78
|
+
const deployment = deployments[name];
|
|
79
|
+
const data = generateDocumentationData(name, deployment);
|
|
80
|
+
deploymentsList.push(data);
|
|
81
|
+
}
|
|
82
|
+
fs.emptyDirSync(outputFolder);
|
|
83
|
+
if (templateName === '{{contracts}}') {
|
|
84
|
+
for (const deployment of deploymentsList) {
|
|
85
|
+
const generated = template(deployment);
|
|
86
|
+
if (generated.trim() !== '') {
|
|
87
|
+
fs.writeFileSync(path.join(outputFolder, deployment.name + '.md'), generated);
|
|
88
|
+
}
|
|
89
|
+
}
|
|
90
|
+
}
|
|
91
|
+
else {
|
|
92
|
+
const generated = template({ contracts: deploymentsList });
|
|
93
|
+
fs.writeFileSync(path.join(outputFolder, templateName + '.md'), generated);
|
|
94
|
+
}
|
|
95
|
+
}
|
|
96
|
+
export function generateDocumentationData(name, deploymentOrArfifact) {
|
|
97
|
+
const abi = deploymentOrArfifact.abi;
|
|
98
|
+
const abiMap = new Map();
|
|
99
|
+
for (const abiElement of abi) {
|
|
100
|
+
switch (abiElement.type) {
|
|
101
|
+
case 'constructor':
|
|
102
|
+
abiMap.set('constructor', abiElement);
|
|
103
|
+
break;
|
|
104
|
+
case 'error':
|
|
105
|
+
abiMap.set(abiElement.name, abiElement);
|
|
106
|
+
break;
|
|
107
|
+
case 'event':
|
|
108
|
+
abiMap.set(abiElement.name, abiElement);
|
|
109
|
+
break;
|
|
110
|
+
case 'function':
|
|
111
|
+
abiMap.set(abiElement.name, abiElement);
|
|
112
|
+
break;
|
|
113
|
+
}
|
|
114
|
+
}
|
|
115
|
+
const errors = [];
|
|
116
|
+
const events = [];
|
|
117
|
+
const methods = [];
|
|
118
|
+
if (deploymentOrArfifact.userdoc?.errors) {
|
|
119
|
+
// we loop only through userdoc
|
|
120
|
+
for (const errorSignature of Object.keys(deploymentOrArfifact.userdoc.errors)) {
|
|
121
|
+
const errorName = errorSignature.indexOf('(') > 0 ? errorSignature.slice(0, errorSignature.indexOf('(')) : errorSignature;
|
|
122
|
+
const abi = abiMap.get(errorName);
|
|
123
|
+
if (!abi) {
|
|
124
|
+
continue;
|
|
125
|
+
}
|
|
126
|
+
const fullFormat = Fragment.from(abi).format('full');
|
|
127
|
+
const paramNames = abi.inputs.map((v, index) => v.name || `_${index}`);
|
|
128
|
+
const errorFromUserDoc = deploymentOrArfifact.userdoc.errors[errorSignature];
|
|
129
|
+
const errorFromDevDoc = deploymentOrArfifact.devdoc?.errors?.[errorSignature];
|
|
130
|
+
const params = [];
|
|
131
|
+
if (errorFromDevDoc) {
|
|
132
|
+
for (const doc of errorFromDevDoc) {
|
|
133
|
+
if (doc.params) {
|
|
134
|
+
for (const paramName of paramNames || Object.keys(doc.params)) {
|
|
135
|
+
params.push({ name: paramName, description: doc.params[paramName] });
|
|
136
|
+
}
|
|
137
|
+
// TODO what if same name
|
|
138
|
+
// TODO what is the array for ? (look at solidity doc)
|
|
139
|
+
}
|
|
140
|
+
}
|
|
141
|
+
}
|
|
142
|
+
const notice = [];
|
|
143
|
+
if (errorFromUserDoc) {
|
|
144
|
+
for (const doc of errorFromUserDoc) {
|
|
145
|
+
if (doc.notice) {
|
|
146
|
+
const notes = doc.notice.split('\\');
|
|
147
|
+
for (const note of notes) {
|
|
148
|
+
if (note != '') {
|
|
149
|
+
notice.push(note);
|
|
150
|
+
}
|
|
151
|
+
}
|
|
152
|
+
}
|
|
153
|
+
}
|
|
154
|
+
}
|
|
155
|
+
errors.push({
|
|
156
|
+
name: errorName,
|
|
157
|
+
signature: errorSignature,
|
|
158
|
+
abi: abi,
|
|
159
|
+
fullFormat,
|
|
160
|
+
notice,
|
|
161
|
+
params,
|
|
162
|
+
});
|
|
163
|
+
}
|
|
164
|
+
}
|
|
165
|
+
if (deploymentOrArfifact.userdoc?.events) {
|
|
166
|
+
// we loop only through userdoc
|
|
167
|
+
for (const eventSignature of Object.keys(deploymentOrArfifact.userdoc.events)) {
|
|
168
|
+
const eventName = eventSignature.indexOf('(') > 0 ? eventSignature.slice(0, eventSignature.indexOf('(')) : eventSignature;
|
|
169
|
+
const abi = abiMap.get(eventName);
|
|
170
|
+
if (!abi) {
|
|
171
|
+
continue;
|
|
172
|
+
}
|
|
173
|
+
const fullFormat = Fragment.from(abi).format('full');
|
|
174
|
+
const paramNames = abi.inputs.map((v, index) => v.name || `_${index}`);
|
|
175
|
+
const eventFromUserDoc = deploymentOrArfifact.userdoc.events[eventSignature];
|
|
176
|
+
const eventFromDevDoc = deploymentOrArfifact.devdoc?.events?.[eventSignature];
|
|
177
|
+
const params = [];
|
|
178
|
+
if (eventFromDevDoc?.params) {
|
|
179
|
+
for (const paramName of paramNames || Object.keys(eventFromDevDoc.params)) {
|
|
180
|
+
params.push({ name: paramName, description: eventFromDevDoc.params[paramName] });
|
|
181
|
+
}
|
|
182
|
+
}
|
|
183
|
+
events.push({
|
|
184
|
+
name: eventName,
|
|
185
|
+
signature: eventSignature,
|
|
186
|
+
abi: abi,
|
|
187
|
+
fullFormat,
|
|
188
|
+
notice: eventFromUserDoc.notice,
|
|
189
|
+
params,
|
|
190
|
+
});
|
|
191
|
+
}
|
|
192
|
+
}
|
|
193
|
+
if (deploymentOrArfifact.userdoc?.methods) {
|
|
194
|
+
// we loop only through userdoc
|
|
195
|
+
for (const methodSignature of Object.keys(deploymentOrArfifact.userdoc.methods)) {
|
|
196
|
+
const methodName = methodSignature.indexOf('(') > 0 ? methodSignature.slice(0, methodSignature.indexOf('(')) : methodSignature;
|
|
197
|
+
const abi = abiMap.get(methodName);
|
|
198
|
+
if (!abi) {
|
|
199
|
+
continue;
|
|
200
|
+
}
|
|
201
|
+
const fullFormat = Fragment.from(abi).format('full');
|
|
202
|
+
const paramNames = abi ? abi.inputs.map((v, index) => v.name || `_${index}`) : undefined;
|
|
203
|
+
const returnNames = abi && 'outputs' in abi ? abi.outputs.map((v, index) => v.name || `_${index}`) : undefined;
|
|
204
|
+
const methodFromUserDoc = deploymentOrArfifact.userdoc.methods[methodSignature];
|
|
205
|
+
const methodFromDevDoc = deploymentOrArfifact.devdoc?.methods?.[methodSignature];
|
|
206
|
+
const params = [];
|
|
207
|
+
if (methodFromDevDoc?.params) {
|
|
208
|
+
for (const paramName of paramNames || Object.keys(methodFromDevDoc.params)) {
|
|
209
|
+
params.push({ name: paramName, description: methodFromDevDoc.params[paramName] });
|
|
210
|
+
}
|
|
211
|
+
}
|
|
212
|
+
const returns = [];
|
|
213
|
+
if (methodFromDevDoc?.returns) {
|
|
214
|
+
for (const returnName of returnNames || Object.keys(methodFromDevDoc.returns)) {
|
|
215
|
+
returns.push({ name: returnName, description: methodFromDevDoc.returns[returnName] });
|
|
216
|
+
}
|
|
217
|
+
}
|
|
218
|
+
if (methodName === 'constructor') {
|
|
219
|
+
methods.push({
|
|
220
|
+
type: 'constructor',
|
|
221
|
+
name: 'constructor',
|
|
222
|
+
abi: abi,
|
|
223
|
+
signature: methodSignature,
|
|
224
|
+
fullFormat,
|
|
225
|
+
notice: methodFromUserDoc.notice,
|
|
226
|
+
params,
|
|
227
|
+
returns,
|
|
228
|
+
});
|
|
229
|
+
}
|
|
230
|
+
else {
|
|
231
|
+
const selector = FunctionFragment.from(abi).selector;
|
|
232
|
+
methods.push({
|
|
233
|
+
type: 'function',
|
|
234
|
+
name: methodName,
|
|
235
|
+
abi: abi,
|
|
236
|
+
signature: methodSignature,
|
|
237
|
+
fullFormat,
|
|
238
|
+
bytes4: selector,
|
|
239
|
+
notice: methodFromUserDoc.notice,
|
|
240
|
+
params,
|
|
241
|
+
returns,
|
|
242
|
+
});
|
|
243
|
+
}
|
|
244
|
+
}
|
|
245
|
+
}
|
|
246
|
+
const data = {
|
|
247
|
+
name,
|
|
248
|
+
address: deploymentOrArfifact.address,
|
|
249
|
+
abi,
|
|
250
|
+
author: deploymentOrArfifact.devdoc?.author,
|
|
251
|
+
title: deploymentOrArfifact.devdoc?.title,
|
|
252
|
+
notice: deploymentOrArfifact.userdoc?.notice,
|
|
253
|
+
errors,
|
|
254
|
+
events,
|
|
255
|
+
methods,
|
|
256
|
+
};
|
|
257
|
+
return data;
|
|
258
|
+
}
|
|
259
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,UAAU,CAAC;AAa1B,OAAO,EAAC,eAAe,EAAC,MAAM,SAAS,CAAC;AACxC,OAAO,UAAU,MAAM,YAAY,CAAC;AACpC,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAC,QAAQ,EAAE,gBAAgB,EAAC,MAAM,QAAQ,CAAC;AAClD,OAAO,EAAC,OAAO,EAAC,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAC,aAAa,EAAC,MAAM,KAAK,CAAC;AAIlC,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,MAAsB,EAAE,OAAmB;IACpE,MAAM,EAAC,WAAW,EAAE,OAAO,EAAC,GAAG,eAAe,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACxF,IAAI,CAAC,OAAO,EAAE,CAAC;QACd,MAAM,IAAI,KAAK,CAAC,wBAAwB,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;IAChE,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,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YACrD,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,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YACrD,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,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YACrD,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,UAAU,KAAK,aAAa,EAAE,CAAC;gBAClC,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,gBAAgB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,QAAyB,CAAC;gBACtE,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"}
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
import type { NoticeUserDoc, Abi, AbiConstructor, AbiFunction, AbiError, AbiEvent } from 'rocketh';
|
|
2
|
+
export type ParamDoc = {
|
|
3
|
+
name: string | `_${number}`;
|
|
4
|
+
description: string;
|
|
5
|
+
};
|
|
6
|
+
export type ReturnDoc = {
|
|
7
|
+
name: string | `_${number}`;
|
|
8
|
+
description: string;
|
|
9
|
+
};
|
|
10
|
+
export type EventDoc = NoticeUserDoc & {
|
|
11
|
+
readonly name: string;
|
|
12
|
+
readonly signature: string;
|
|
13
|
+
readonly abi: AbiEvent;
|
|
14
|
+
readonly fullFormat: string;
|
|
15
|
+
readonly details?: string;
|
|
16
|
+
readonly params?: ParamDoc[];
|
|
17
|
+
};
|
|
18
|
+
export type ErrorDoc = {
|
|
19
|
+
readonly name: string;
|
|
20
|
+
readonly signature: string;
|
|
21
|
+
readonly abi: AbiError;
|
|
22
|
+
readonly fullFormat: string;
|
|
23
|
+
readonly notice?: string[];
|
|
24
|
+
readonly params?: ParamDoc[];
|
|
25
|
+
};
|
|
26
|
+
type NonConstructorMethodDoc = NoticeUserDoc & {
|
|
27
|
+
readonly type: 'function';
|
|
28
|
+
readonly name: string;
|
|
29
|
+
readonly signature: string;
|
|
30
|
+
readonly bytes4: `0x${string}`;
|
|
31
|
+
readonly abi: AbiFunction;
|
|
32
|
+
readonly fullFormat: string;
|
|
33
|
+
readonly details?: string;
|
|
34
|
+
readonly params?: ParamDoc[];
|
|
35
|
+
readonly returns?: ReturnDoc[];
|
|
36
|
+
};
|
|
37
|
+
export type ConstructorDoc = NoticeUserDoc & {
|
|
38
|
+
readonly type: 'constructor';
|
|
39
|
+
readonly name: 'constructor';
|
|
40
|
+
readonly signature: string;
|
|
41
|
+
readonly abi: AbiConstructor;
|
|
42
|
+
readonly fullFormat: string;
|
|
43
|
+
readonly details?: string;
|
|
44
|
+
readonly params?: ParamDoc[];
|
|
45
|
+
readonly returns?: ReturnDoc[];
|
|
46
|
+
};
|
|
47
|
+
export type MethodDoc = NonConstructorMethodDoc | ConstructorDoc;
|
|
48
|
+
export type DocumentationData = {
|
|
49
|
+
readonly name: string;
|
|
50
|
+
readonly abi: Abi;
|
|
51
|
+
readonly events: EventDoc[];
|
|
52
|
+
readonly methods: MethodDoc[];
|
|
53
|
+
readonly errors: ErrorDoc[];
|
|
54
|
+
readonly address?: string;
|
|
55
|
+
readonly title?: string;
|
|
56
|
+
readonly author?: string;
|
|
57
|
+
readonly notice?: string;
|
|
58
|
+
};
|
|
59
|
+
export {};
|
|
60
|
+
//# sourceMappingURL=types.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,aAAa,EAAE,GAAG,EAAE,cAAc,EAAE,WAAW,EAAE,QAAQ,EAAE,QAAQ,EAAC,MAAM,SAAS,CAAC;AAEjG,MAAM,MAAM,QAAQ,GAAG;IAAC,IAAI,EAAE,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;IAAC,WAAW,EAAE,MAAM,CAAA;CAAC,CAAC;AAC1E,MAAM,MAAM,SAAS,GAAG;IAAC,IAAI,EAAE,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;IAAC,WAAW,EAAE,MAAM,CAAA;CAAC,CAAC;AAE3E,MAAM,MAAM,QAAQ,GAAG,aAAa,GAAG;IACtC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,GAAG,EAAE,QAAQ,CAAC;IACvB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG;IACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,GAAG,EAAE,QAAQ,CAAC;IACvB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAG3B,QAAQ,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,CAAC;CAC7B,CAAC;AAEF,KAAK,uBAAuB,GAAG,aAAa,GAAG;IAC9C,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;IAC1B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,MAAM,EAAE,KAAK,MAAM,EAAE,CAAC;IAC/B,QAAQ,CAAC,GAAG,EAAE,WAAW,CAAC;IAC1B,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,CAAC;IAC7B,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,EAAE,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,aAAa,GAAG;IAC5C,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC;IAC7B,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC;IAC7B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,GAAG,EAAE,cAAc,CAAC;IAC7B,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,CAAC;IAC7B,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,EAAE,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG,uBAAuB,GAAG,cAAc,CAAC;AAEjE,MAAM,MAAM,iBAAiB,GAAG;IAC/B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC;IAClB,QAAQ,CAAC,MAAM,EAAE,QAAQ,EAAE,CAAC;IAC5B,QAAQ,CAAC,OAAO,EAAE,SAAS,EAAE,CAAC;IAC9B,QAAQ,CAAC,MAAM,EAAE,QAAQ,EAAE,CAAC;IAC5B,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":""}
|
package/package.json
CHANGED
|
@@ -1,26 +1,21 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@rocketh/doc",
|
|
3
|
-
"version": "0.10.
|
|
3
|
+
"version": "0.10.10",
|
|
4
4
|
"description": "can generate doc from rocketh deployments and provided template",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"access": "public"
|
|
7
7
|
},
|
|
8
8
|
"type": "module",
|
|
9
|
-
"
|
|
10
|
-
"
|
|
11
|
-
"types": "dist/index.d.ts",
|
|
9
|
+
"module": "dist/esm/index.js",
|
|
10
|
+
"types": "dist/esm/index.d.ts",
|
|
12
11
|
".": {
|
|
13
|
-
"require": {
|
|
14
|
-
"types": "./dist/index.d.ts",
|
|
15
|
-
"default": "./dist/index.cjs"
|
|
16
|
-
},
|
|
17
12
|
"import": {
|
|
18
|
-
"types": "./dist/index.d.ts",
|
|
19
|
-
"default": "./dist/index.
|
|
13
|
+
"types": "./dist/esm/index.d.ts",
|
|
14
|
+
"default": "./dist/esm/index.js"
|
|
20
15
|
}
|
|
21
16
|
},
|
|
22
17
|
"bin": {
|
|
23
|
-
"rocketh-doc": "dist/cli.
|
|
18
|
+
"rocketh-doc": "dist/esm/cli.js"
|
|
24
19
|
},
|
|
25
20
|
"files": [
|
|
26
21
|
"dist",
|
|
@@ -29,13 +24,13 @@
|
|
|
29
24
|
],
|
|
30
25
|
"devDependencies": {
|
|
31
26
|
"@types/node": "^20.14.8",
|
|
32
|
-
"
|
|
27
|
+
"as-soon": "^0.0.11",
|
|
33
28
|
"rimraf": "^5.0.7",
|
|
34
29
|
"typescript": "^5.5.2",
|
|
35
|
-
"rocketh": "0.10.
|
|
30
|
+
"rocketh": "0.10.16"
|
|
36
31
|
},
|
|
37
32
|
"peerDependencies": {
|
|
38
|
-
"rocketh": "0.10.
|
|
33
|
+
"rocketh": "0.10.16"
|
|
39
34
|
},
|
|
40
35
|
"dependencies": {
|
|
41
36
|
"@types/fs-extra": "^11.0.4",
|
|
@@ -45,7 +40,7 @@
|
|
|
45
40
|
"handlebars": "^4.7.8"
|
|
46
41
|
},
|
|
47
42
|
"scripts": {
|
|
48
|
-
"build": "
|
|
49
|
-
"dev": "
|
|
43
|
+
"build": "tsc --project tsconfig.json",
|
|
44
|
+
"dev": "as-soon -w src pnpm build"
|
|
50
45
|
}
|
|
51
46
|
}
|
package/src/cli.ts
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
#! /usr/bin/env node
|
|
2
2
|
import {readAndResolveConfig} from 'rocketh';
|
|
3
|
-
import {run} from '.';
|
|
3
|
+
import {run} from './index.js';
|
|
4
4
|
import {Command} from 'commander';
|
|
5
|
-
import pkg from '../package.json';
|
|
5
|
+
import pkg from '../package.json' with {type: 'json'};
|
|
6
6
|
import {ConfigOptions} from 'rocketh';
|
|
7
|
-
import {RunOptions} from '.';
|
|
7
|
+
import {RunOptions} from './index.js';
|
|
8
8
|
|
|
9
9
|
const commandName = pkg.name;
|
|
10
10
|
|
package/src/index.ts
CHANGED
|
@@ -18,9 +18,9 @@ import {Fragment, FunctionFragment} from 'ethers';
|
|
|
18
18
|
import {dirname} from 'path';
|
|
19
19
|
import {fileURLToPath} from 'url';
|
|
20
20
|
|
|
21
|
-
import {DocumentationData, ErrorDoc, EventDoc, MethodDoc, ParamDoc, ReturnDoc} from './types';
|
|
21
|
+
import {DocumentationData, ErrorDoc, EventDoc, MethodDoc, ParamDoc, ReturnDoc} from './types.js';
|
|
22
22
|
|
|
23
|
-
export * from './types';
|
|
23
|
+
export * from './types.js';
|
|
24
24
|
|
|
25
25
|
const __dirname = dirname(fileURLToPath(import.meta.url));
|
|
26
26
|
|