@rocketh/doc 1.0.0-next.1 → 1.0.0-next.3

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.
@@ -0,0 +1 @@
1
+ {"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":""}
@@ -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"}
package/dist/index.d.ts CHANGED
@@ -1,75 +1,17 @@
1
- import { NoticeUserDoc, AbiEvent, AbiError, AbiConstructor, Abi, AbiFunction, ResolvedConfig, UnknownDeployments, Deployment, Artifact } from 'rocketh';
2
-
3
- type ParamDoc = {
4
- name: string | `_${number}`;
5
- description: string;
6
- };
7
- type ReturnDoc = {
8
- name: string | `_${number}`;
9
- description: string;
10
- };
11
- type EventDoc = NoticeUserDoc & {
12
- readonly name: string;
13
- readonly signature: string;
14
- readonly abi: AbiEvent;
15
- readonly fullFormat: string;
16
- readonly details?: string;
17
- readonly params?: ParamDoc[];
18
- };
19
- type ErrorDoc = {
20
- readonly name: string;
21
- readonly signature: string;
22
- readonly abi: AbiError;
23
- readonly fullFormat: string;
24
- readonly notice?: string[];
25
- readonly params?: ParamDoc[];
26
- };
27
- type NonConstructorMethodDoc = NoticeUserDoc & {
28
- readonly type: 'function';
29
- readonly name: string;
30
- readonly signature: string;
31
- readonly bytes4: `0x${string}`;
32
- readonly abi: AbiFunction;
33
- readonly fullFormat: string;
34
- readonly details?: string;
35
- readonly params?: ParamDoc[];
36
- readonly returns?: ReturnDoc[];
37
- };
38
- type ConstructorDoc = NoticeUserDoc & {
39
- readonly type: 'constructor';
40
- readonly name: 'constructor';
41
- readonly signature: string;
42
- readonly abi: AbiConstructor;
43
- readonly fullFormat: string;
44
- readonly details?: string;
45
- readonly params?: ParamDoc[];
46
- readonly returns?: ReturnDoc[];
47
- };
48
- type MethodDoc = NonConstructorMethodDoc | ConstructorDoc;
49
- type DocumentationData = {
50
- readonly name: string;
51
- readonly abi: Abi;
52
- readonly events: EventDoc[];
53
- readonly methods: MethodDoc[];
54
- readonly errors: ErrorDoc[];
55
- readonly address?: string;
56
- readonly title?: string;
57
- readonly author?: string;
58
- readonly notice?: string;
59
- };
60
-
61
- type RunOptions = {
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 = {
62
5
  template?: string;
63
6
  output?: string;
64
7
  exceptSuffix?: string[];
65
8
  };
66
- declare function run(config: ResolvedConfig, options: RunOptions): Promise<void>;
67
- declare function generate({ deployments }: {
9
+ export declare function run(config: ResolvedConfig, options: RunOptions): Promise<void>;
10
+ export declare function generate({ deployments }: {
68
11
  deployments: UnknownDeployments;
69
12
  chainId?: string;
70
13
  }, options: RunOptions): Promise<void>;
71
- declare function runFromFolder(folder: string, options: RunOptions): Promise<void>;
72
- declare function generateFromDeployments(deployments: UnknownDeployments, options: RunOptions): Promise<void>;
73
- declare function generateDocumentationData(name: string, deploymentOrArfifact: Partial<Deployment<Abi>> & Artifact<Abi>): DocumentationData;
74
-
75
- export { type ConstructorDoc, type DocumentationData, type ErrorDoc, type EventDoc, type MethodDoc, type ParamDoc, type ReturnDoc, type RunOptions, generate, generateDocumentationData, generateFromDeployments, run, runFromFolder };
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 @@
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 @@
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,22 +1,22 @@
1
1
  {
2
2
  "name": "@rocketh/doc",
3
- "version": "1.0.0-next.1",
3
+ "version": "1.0.0-next.3",
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
- "main": "dist/esm/index.js",
10
- "module": "dist/esm/index.js",
11
- "types": "dist/esm/index.d.ts",
9
+ "main": "dist/index.js",
10
+ "module": "dist/index.js",
11
+ "types": "dist/index.d.ts",
12
12
  ".": {
13
13
  "import": {
14
- "types": "./dist/esm/index.d.ts",
15
- "default": "./dist/esm/index.js"
14
+ "types": "./dist/index.d.ts",
15
+ "default": "./dist/index.js"
16
16
  }
17
17
  },
18
18
  "bin": {
19
- "rocketh-doc": "dist/esm/cli.js"
19
+ "rocketh-doc": "dist/cli.js"
20
20
  },
21
21
  "files": [
22
22
  "dist",
@@ -24,20 +24,20 @@
24
24
  "src"
25
25
  ],
26
26
  "devDependencies": {
27
- "@types/node": "^20.14.8",
27
+ "@types/node": "^22.13.10",
28
28
  "as-soon": "^0.0.11",
29
- "rimraf": "^5.0.7",
30
- "typescript": "^5.5.2",
31
- "rocketh": "1.0.0-next.1"
29
+ "rimraf": "^6.0.1",
30
+ "typescript": "^5.8.2",
31
+ "rocketh": "1.0.0-next.3"
32
32
  },
33
33
  "peerDependencies": {
34
- "rocketh": "1.0.0-next.1"
34
+ "rocketh": "1.0.0-next.3"
35
35
  },
36
36
  "dependencies": {
37
37
  "@types/fs-extra": "^11.0.4",
38
- "commander": "^12.1.0",
39
- "ethers": "^6.13.1",
40
- "fs-extra": "^11.2.0",
38
+ "commander": "^13.1.0",
39
+ "ethers": "^6.13.5",
40
+ "fs-extra": "^11.3.0",
41
41
  "handlebars": "^4.7.8"
42
42
  },
43
43
  "scripts": {
package/dist/cli.cjs DELETED
@@ -1,86 +0,0 @@
1
- #!/usr/bin/env node
2
- 'use strict';
3
-
4
- var rocketh = require('rocketh');
5
- var index = require('./index.cjs');
6
- var commander = require('commander');
7
- require('fs-extra');
8
- require('handlebars');
9
- require('path');
10
- require('ethers');
11
- require('url');
12
-
13
- var name = "@rocketh/doc";
14
- var version = "0.10.8";
15
- var description = "can generate doc from rocketh deployments and provided template";
16
- var publishConfig = {
17
- access: "public"
18
- };
19
- var type = "module";
20
- var main = "dist/index.cjs";
21
- var module$1 = "dist/index.mjs";
22
- var types = "dist/index.d.ts";
23
- var bin = {
24
- "rocketh-doc": "dist/cli.cjs"
25
- };
26
- var files = [
27
- "dist",
28
- "public",
29
- "src"
30
- ];
31
- var devDependencies = {
32
- "@types/node": "^20.14.8",
33
- pkgroll: "^2.1.1",
34
- rimraf: "^5.0.7",
35
- rocketh: "workspace:*",
36
- typescript: "^5.5.2"
37
- };
38
- var peerDependencies = {
39
- rocketh: "workspace:*"
40
- };
41
- var dependencies = {
42
- "@types/fs-extra": "^11.0.4",
43
- commander: "^12.1.0",
44
- ethers: "^6.13.1",
45
- "fs-extra": "^11.2.0",
46
- handlebars: "^4.7.8"
47
- };
48
- var scripts = {
49
- build: "rimraf dist && pkgroll --sourcemap",
50
- dev: "pkgroll --watch"
51
- };
52
- var pkg = {
53
- name: name,
54
- version: version,
55
- description: description,
56
- publishConfig: publishConfig,
57
- type: type,
58
- main: main,
59
- module: module$1,
60
- types: types,
61
- ".": {
62
- require: {
63
- types: "./dist/index.d.ts",
64
- "default": "./dist/index.cjs"
65
- },
66
- "import": {
67
- types: "./dist/index.d.ts",
68
- "default": "./dist/index.mjs"
69
- }
70
- },
71
- bin: bin,
72
- files: files,
73
- devDependencies: devDependencies,
74
- peerDependencies: peerDependencies,
75
- dependencies: dependencies,
76
- scripts: scripts
77
- };
78
-
79
- const commandName = pkg.name;
80
- const program = new commander.Command();
81
- program.name(commandName).description("generate doc from deployments and provided templates").version(pkg.version).option("-d, --deployments <value>", "folder where deployments are saved").option("-o, --output <value>", "folder where to generate docs").option("-t, --template <value>", "template used to generate docs").option("--except-suffix <suffix, suffix....>", "ignore contract that ends with the provided suffixes").requiredOption("-n, --network <value>", "network context to use").parse(process.argv);
82
- const options = program.opts();
83
- options.exceptSuffix = options.exceptSuffix?.split(",") || [];
84
- const resolvedConfig = rocketh.readAndResolveConfig({ ...options, ignoreMissingRPC: true });
85
- index.run(resolvedConfig, options);
86
- //# sourceMappingURL=cli.cjs.map
package/dist/cli.cjs.map DELETED
@@ -1 +0,0 @@
1
- {"version":3,"file":"cli.cjs","sources":["../src/cli.ts"],"sourcesContent":["#! /usr/bin/env node\nimport {readAndResolveConfig} from 'rocketh';\nimport {run} from '.';\nimport {Command} from 'commander';\nimport pkg from '../package.json';\nimport {ConfigOptions} from 'rocketh';\nimport {RunOptions} from '.';\n\nconst commandName = pkg.name;\n\nconst program = new Command();\nprogram\n\t.name(commandName)\n\t.description('generate doc from deployments and provided templates')\n\t.version(pkg.version)\n\t.option('-d, --deployments <value>', 'folder where deployments are saved')\n\t.option('-o, --output <value>', 'folder where to generate docs')\n\t.option('-t, --template <value>', 'template used to generate docs')\n\t.option('--except-suffix <suffix, suffix....>', 'ignore contract that ends with the provided suffixes')\n\t.requiredOption('-n, --network <value>', 'network context to use')\n\t.parse(process.argv);\n\nconst options = program.opts();\noptions.exceptSuffix = options.exceptSuffix?.split(',') || [];\nconst resolvedConfig = readAndResolveConfig({...(options as ConfigOptions), ignoreMissingRPC: true});\nrun(resolvedConfig, options as RunOptions);\n"],"names":["Command","readAndResolveConfig","run"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAKA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAM,CAAW,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAG,CAAG,CAAA,CAAA,CAAC,IAAI,CAAC;AAC7B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAM,CAAO,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAG,CAAIA,CAAAA,CAAAA,CAAAA,CAAAA,CAAAA,CAAAA,CAAAA,CAAAA,CAAAA,CAAAA,CAAAA,CAAAA,CAAAA,CAAAA,CAAAA,CAAAA,CAAAA,CAAAA,CAAAA,CAAO,EAAE,CAAA;AAC7B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA;AACA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAM,OAAO,CAAG,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAO,CAAC,CAAA,CAAA,CAAA,CAAI,EAAC,CAAA;AAC7B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA;AACA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAM,CAAc,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAGC,CAAO,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA;AAC9BC,CAAAA,CAAAA,CAAAA,CAAAA,CAAAA,CAAAA,CAAAA,CAAAA,CAAG,CAAC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAG,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA"}
package/dist/cli.mjs DELETED
@@ -1,83 +0,0 @@
1
- import { readAndResolveConfig } from 'rocketh';
2
- import { run } from './index.mjs';
3
- import { Command } from 'commander';
4
- import 'fs-extra';
5
- import 'handlebars';
6
- import 'path';
7
- import 'ethers';
8
- import 'url';
9
-
10
- var name = "@rocketh/doc";
11
- var version = "0.10.8";
12
- var description = "can generate doc from rocketh deployments and provided template";
13
- var publishConfig = {
14
- access: "public"
15
- };
16
- var type = "module";
17
- var main = "dist/index.cjs";
18
- var module = "dist/index.mjs";
19
- var types = "dist/index.d.ts";
20
- var bin = {
21
- "rocketh-doc": "dist/cli.cjs"
22
- };
23
- var files = [
24
- "dist",
25
- "public",
26
- "src"
27
- ];
28
- var devDependencies = {
29
- "@types/node": "^20.14.8",
30
- pkgroll: "^2.1.1",
31
- rimraf: "^5.0.7",
32
- rocketh: "workspace:*",
33
- typescript: "^5.5.2"
34
- };
35
- var peerDependencies = {
36
- rocketh: "workspace:*"
37
- };
38
- var dependencies = {
39
- "@types/fs-extra": "^11.0.4",
40
- commander: "^12.1.0",
41
- ethers: "^6.13.1",
42
- "fs-extra": "^11.2.0",
43
- handlebars: "^4.7.8"
44
- };
45
- var scripts = {
46
- build: "rimraf dist && pkgroll --sourcemap",
47
- dev: "pkgroll --watch"
48
- };
49
- var pkg = {
50
- name: name,
51
- version: version,
52
- description: description,
53
- publishConfig: publishConfig,
54
- type: type,
55
- main: main,
56
- module: module,
57
- types: types,
58
- ".": {
59
- require: {
60
- types: "./dist/index.d.ts",
61
- "default": "./dist/index.cjs"
62
- },
63
- "import": {
64
- types: "./dist/index.d.ts",
65
- "default": "./dist/index.mjs"
66
- }
67
- },
68
- bin: bin,
69
- files: files,
70
- devDependencies: devDependencies,
71
- peerDependencies: peerDependencies,
72
- dependencies: dependencies,
73
- scripts: scripts
74
- };
75
-
76
- const commandName = pkg.name;
77
- const program = new Command();
78
- program.name(commandName).description("generate doc from deployments and provided templates").version(pkg.version).option("-d, --deployments <value>", "folder where deployments are saved").option("-o, --output <value>", "folder where to generate docs").option("-t, --template <value>", "template used to generate docs").option("--except-suffix <suffix, suffix....>", "ignore contract that ends with the provided suffixes").requiredOption("-n, --network <value>", "network context to use").parse(process.argv);
79
- const options = program.opts();
80
- options.exceptSuffix = options.exceptSuffix?.split(",") || [];
81
- const resolvedConfig = readAndResolveConfig({ ...options, ignoreMissingRPC: true });
82
- run(resolvedConfig, options);
83
- //# sourceMappingURL=cli.mjs.map
package/dist/cli.mjs.map DELETED
@@ -1 +0,0 @@
1
- {"version":3,"file":"cli.mjs","sources":["../src/cli.ts"],"sourcesContent":["#! /usr/bin/env node\nimport {readAndResolveConfig} from 'rocketh';\nimport {run} from '.';\nimport {Command} from 'commander';\nimport pkg from '../package.json';\nimport {ConfigOptions} from 'rocketh';\nimport {RunOptions} from '.';\n\nconst commandName = pkg.name;\n\nconst program = new Command();\nprogram\n\t.name(commandName)\n\t.description('generate doc from deployments and provided templates')\n\t.version(pkg.version)\n\t.option('-d, --deployments <value>', 'folder where deployments are saved')\n\t.option('-o, --output <value>', 'folder where to generate docs')\n\t.option('-t, --template <value>', 'template used to generate docs')\n\t.option('--except-suffix <suffix, suffix....>', 'ignore contract that ends with the provided suffixes')\n\t.requiredOption('-n, --network <value>', 'network context to use')\n\t.parse(process.argv);\n\nconst options = program.opts();\noptions.exceptSuffix = options.exceptSuffix?.split(',') || [];\nconst resolvedConfig = readAndResolveConfig({...(options as ConfigOptions), ignoreMissingRPC: true});\nrun(resolvedConfig, options as RunOptions);\n"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAKA,MAAM,WAAW,GAAG,GAAG,CAAC,IAAI,CAAC;AAC7B,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAA;AAC7B,OAAA,CAAA,IAAA,CAAA,WAAA,CAAA,CAAA,WAAA,CAAA,sDAAA,CAAA,CAAA,OAAA,CAAA,GAAA,CAAA,OAAA,CAAA,CAAA,MAAA,CAAA,2BAAA,EAAA,oCAAA,CAAA,CAAA,MAAA,CAAA,sBAAA,EAAA,+BAAA,CAAA,CAAA,MAAA,CAAA,wBAAA,EAAA,gCAAA,CAAA,CAAA,MAAA,CAAA,sCAAA,EAAA,sDAAA,CAAA,CAAA,cAAA,CAAA,uBAAA,EAAA,wBAAA,CAAA,CAAA,KAAA,CAAA,OAAA,CAAA,IAAA,CAAA,CAAA;AACA,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,EAAC,CAAA;AAC7B,OAAA,CAAA,YAAA,GAAA,OAAA,CAAA,YAAA,EAAA,KAAA,CAAA,GAAA,CAAA,IAAA,EAAA,CAAA;AACA,MAAM,cAAc,GAAG,oBAAO,CAAA,EAAA,GAAA,OAAA,EAAA,gBAAA,EAAA,IAAA,EAAA,CAAA,CAAA;AAC9B,GAAG,CAAC,cAAG,EAAA,OAAA,CAAA"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../../src/cli.ts"],"names":[],"mappings":""}
@@ -1 +0,0 @@
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"}
@@ -1,17 +0,0 @@
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
@@ -1 +0,0 @@
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"}
@@ -1 +0,0 @@
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"}
@@ -1 +0,0 @@
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"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":""}
package/dist/index.cjs DELETED
@@ -1,248 +0,0 @@
1
- 'use strict';
2
-
3
- var fs = require('fs-extra');
4
- var rocketh = require('rocketh');
5
- var Handlebars = require('handlebars');
6
- var path = require('path');
7
- var ethers = require('ethers');
8
- var url = require('url');
9
-
10
- var _documentCurrentScript = typeof document !== 'undefined' ? document.currentScript : null;
11
- const __dirname$1 = path.dirname(url.fileURLToPath((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.src || new URL('index.cjs', document.baseURI).href))));
12
- function filter(options, name) {
13
- if (options.exceptSuffix) {
14
- for (const suffix of options.exceptSuffix) {
15
- if (name.endsWith(suffix)) {
16
- return false;
17
- }
18
- }
19
- }
20
- return true;
21
- }
22
- async function run(config, options) {
23
- const { deployments, chainId } = rocketh.loadDeployments(config.deployments, config.network.name);
24
- if (!chainId) {
25
- throw new Error(`no chainId found for ${config.network.name}`);
26
- }
27
- generate({ deployments }, options);
28
- }
29
- async function generate({ deployments }, options) {
30
- if (!deployments || Object.keys(deployments).length === 0) {
31
- console.log(`no deployments to export`);
32
- return;
33
- }
34
- const toDocument = {};
35
- for (const name of Object.keys(deployments)) {
36
- if (!filter(options, name)) {
37
- continue;
38
- }
39
- const deployment = deployments[name];
40
- toDocument[name] = deployment;
41
- }
42
- return generateFromDeployments(toDocument, options);
43
- }
44
- async function runFromFolder(folder, options) {
45
- const files = fs.readdirSync(folder);
46
- const deployments = {};
47
- for (const file of files) {
48
- if (file.endsWith(".json")) {
49
- const name = path.basename(file, ".json");
50
- if (!filter(options, name)) {
51
- continue;
52
- }
53
- const deploymentString = fs.readFileSync(path.join(folder, file), "utf-8");
54
- const deployment = JSON.parse(deploymentString);
55
- deployments[name] = deployment;
56
- }
57
- }
58
- return generateFromDeployments(deployments, options);
59
- }
60
- async function generateFromDeployments(deployments, options) {
61
- const outputFolder = options.output || "docs";
62
- const templateFilepath = options.template || path.join(__dirname$1, "../public/default_templates/{{contracts}}.hbs");
63
- const templateName = path.basename(templateFilepath, ".hbs");
64
- const templateContent = fs.readFileSync(templateFilepath, "utf-8");
65
- const template = Handlebars.compile(templateContent);
66
- const deploymentsList = [];
67
- for (const name of Object.keys(deployments)) {
68
- const deployment = deployments[name];
69
- const data = generateDocumentationData(name, deployment);
70
- deploymentsList.push(data);
71
- }
72
- fs.emptyDirSync(outputFolder);
73
- if (templateName === "{{contracts}}") {
74
- for (const deployment of deploymentsList) {
75
- const generated = template(deployment);
76
- if (generated.trim() !== "") {
77
- fs.writeFileSync(path.join(outputFolder, deployment.name + ".md"), generated);
78
- }
79
- }
80
- } else {
81
- const generated = template({ contracts: deploymentsList });
82
- fs.writeFileSync(path.join(outputFolder, templateName + ".md"), generated);
83
- }
84
- }
85
- function generateDocumentationData(name, deploymentOrArfifact) {
86
- const abi = deploymentOrArfifact.abi;
87
- const abiMap = /* @__PURE__ */ new Map();
88
- for (const abiElement of abi) {
89
- switch (abiElement.type) {
90
- case "constructor":
91
- abiMap.set("constructor", abiElement);
92
- break;
93
- case "error":
94
- abiMap.set(abiElement.name, abiElement);
95
- break;
96
- case "event":
97
- abiMap.set(abiElement.name, abiElement);
98
- break;
99
- case "function":
100
- abiMap.set(abiElement.name, abiElement);
101
- break;
102
- }
103
- }
104
- const errors = [];
105
- const events = [];
106
- const methods = [];
107
- if (deploymentOrArfifact.userdoc?.errors) {
108
- for (const errorSignature of Object.keys(deploymentOrArfifact.userdoc.errors)) {
109
- const errorName = errorSignature.indexOf("(") > 0 ? errorSignature.slice(0, errorSignature.indexOf("(")) : errorSignature;
110
- const abi2 = abiMap.get(errorName);
111
- if (!abi2) {
112
- continue;
113
- }
114
- const fullFormat = ethers.Fragment.from(abi2).format("full");
115
- const paramNames = abi2.inputs.map((v, index) => v.name || `_${index}`);
116
- const errorFromUserDoc = deploymentOrArfifact.userdoc.errors[errorSignature];
117
- const errorFromDevDoc = deploymentOrArfifact.devdoc?.errors?.[errorSignature];
118
- const params = [];
119
- if (errorFromDevDoc) {
120
- for (const doc of errorFromDevDoc) {
121
- if (doc.params) {
122
- for (const paramName of paramNames || Object.keys(doc.params)) {
123
- params.push({ name: paramName, description: doc.params[paramName] });
124
- }
125
- }
126
- }
127
- }
128
- const notice = [];
129
- if (errorFromUserDoc) {
130
- for (const doc of errorFromUserDoc) {
131
- if (doc.notice) {
132
- const notes = doc.notice.split("\\");
133
- for (const note of notes) {
134
- if (note != "") {
135
- notice.push(note);
136
- }
137
- }
138
- }
139
- }
140
- }
141
- errors.push({
142
- name: errorName,
143
- signature: errorSignature,
144
- abi: abi2,
145
- fullFormat,
146
- notice,
147
- params
148
- });
149
- }
150
- }
151
- if (deploymentOrArfifact.userdoc?.events) {
152
- for (const eventSignature of Object.keys(deploymentOrArfifact.userdoc.events)) {
153
- const eventName = eventSignature.indexOf("(") > 0 ? eventSignature.slice(0, eventSignature.indexOf("(")) : eventSignature;
154
- const abi2 = abiMap.get(eventName);
155
- if (!abi2) {
156
- continue;
157
- }
158
- const fullFormat = ethers.Fragment.from(abi2).format("full");
159
- const paramNames = abi2.inputs.map((v, index) => v.name || `_${index}`);
160
- const eventFromUserDoc = deploymentOrArfifact.userdoc.events[eventSignature];
161
- const eventFromDevDoc = deploymentOrArfifact.devdoc?.events?.[eventSignature];
162
- const params = [];
163
- if (eventFromDevDoc?.params) {
164
- for (const paramName of paramNames || Object.keys(eventFromDevDoc.params)) {
165
- params.push({ name: paramName, description: eventFromDevDoc.params[paramName] });
166
- }
167
- }
168
- events.push({
169
- name: eventName,
170
- signature: eventSignature,
171
- abi: abi2,
172
- fullFormat,
173
- notice: eventFromUserDoc.notice,
174
- params
175
- });
176
- }
177
- }
178
- if (deploymentOrArfifact.userdoc?.methods) {
179
- for (const methodSignature of Object.keys(deploymentOrArfifact.userdoc.methods)) {
180
- const methodName = methodSignature.indexOf("(") > 0 ? methodSignature.slice(0, methodSignature.indexOf("(")) : methodSignature;
181
- const abi2 = abiMap.get(methodName);
182
- if (!abi2) {
183
- continue;
184
- }
185
- const fullFormat = ethers.Fragment.from(abi2).format("full");
186
- const paramNames = abi2 ? abi2.inputs.map((v, index) => v.name || `_${index}`) : void 0;
187
- const returnNames = abi2 && "outputs" in abi2 ? abi2.outputs.map((v, index) => v.name || `_${index}`) : void 0;
188
- const methodFromUserDoc = deploymentOrArfifact.userdoc.methods[methodSignature];
189
- const methodFromDevDoc = deploymentOrArfifact.devdoc?.methods?.[methodSignature];
190
- const params = [];
191
- if (methodFromDevDoc?.params) {
192
- for (const paramName of paramNames || Object.keys(methodFromDevDoc.params)) {
193
- params.push({ name: paramName, description: methodFromDevDoc.params[paramName] });
194
- }
195
- }
196
- const returns = [];
197
- if (methodFromDevDoc?.returns) {
198
- for (const returnName of returnNames || Object.keys(methodFromDevDoc.returns)) {
199
- returns.push({ name: returnName, description: methodFromDevDoc.returns[returnName] });
200
- }
201
- }
202
- if (methodName === "constructor") {
203
- methods.push({
204
- type: "constructor",
205
- name: "constructor",
206
- abi: abi2,
207
- signature: methodSignature,
208
- fullFormat,
209
- notice: methodFromUserDoc.notice,
210
- params,
211
- returns
212
- });
213
- } else {
214
- const selector = ethers.FunctionFragment.from(abi2).selector;
215
- methods.push({
216
- type: "function",
217
- name: methodName,
218
- abi: abi2,
219
- signature: methodSignature,
220
- fullFormat,
221
- bytes4: selector,
222
- notice: methodFromUserDoc.notice,
223
- params,
224
- returns
225
- });
226
- }
227
- }
228
- }
229
- const data = {
230
- name,
231
- address: deploymentOrArfifact.address,
232
- abi,
233
- author: deploymentOrArfifact.devdoc?.author,
234
- title: deploymentOrArfifact.devdoc?.title,
235
- notice: deploymentOrArfifact.userdoc?.notice,
236
- errors,
237
- events,
238
- methods
239
- };
240
- return data;
241
- }
242
-
243
- exports.generate = generate;
244
- exports.generateDocumentationData = generateDocumentationData;
245
- exports.generateFromDeployments = generateFromDeployments;
246
- exports.run = run;
247
- exports.runFromFolder = runFromFolder;
248
- //# sourceMappingURL=index.cjs.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.cjs","sources":["../src/index.ts"],"sourcesContent":["import fs from 'fs-extra';\nimport type {\n\tDeployment,\n\tResolvedConfig,\n\tNoticeUserDoc,\n\tArtifact,\n\tAbi,\n\tUnknownDeployments,\n\tAbiConstructor,\n\tAbiFunction,\n\tAbiError,\n\tAbiEvent,\n} from 'rocketh';\nimport {loadDeployments} from 'rocketh';\nimport Handlebars from 'handlebars';\nimport path from 'path';\nimport {Fragment, FunctionFragment} from 'ethers';\nimport {dirname} from 'path';\nimport {fileURLToPath} from 'url';\n\nimport {DocumentationData, ErrorDoc, EventDoc, MethodDoc, ParamDoc, ReturnDoc} from './types';\n\nexport * from './types';\n\nconst __dirname = dirname(fileURLToPath(import.meta.url));\n\nexport type RunOptions = {template?: string; output?: string; exceptSuffix?: string[]};\n\nfunction filter(options: RunOptions, name: string): boolean {\n\tif (options.exceptSuffix) {\n\t\tfor (const suffix of options.exceptSuffix) {\n\t\t\tif (name.endsWith(suffix)) {\n\t\t\t\treturn false;\n\t\t\t}\n\t\t}\n\t}\n\treturn true;\n}\n\nexport async function run(config: ResolvedConfig, options: RunOptions) {\n\tconst {deployments, chainId} = loadDeployments(config.deployments, config.network.name);\n\tif (!chainId) {\n\t\tthrow new Error(`no chainId found for ${config.network.name}`);\n\t}\n\tgenerate({deployments}, options);\n}\n\nexport async function generate(\n\t{deployments}: {deployments: UnknownDeployments; chainId?: string},\n\toptions: RunOptions\n) {\n\tif (!deployments || Object.keys(deployments).length === 0) {\n\t\tconsole.log(`no deployments to export`);\n\t\treturn;\n\t}\n\n\tconst toDocument: UnknownDeployments = {};\n\tfor (const name of Object.keys(deployments)) {\n\t\tif (!filter(options, name)) {\n\t\t\tcontinue;\n\t\t}\n\t\tconst deployment = deployments[name];\n\t\ttoDocument[name] = deployment;\n\t}\n\n\treturn generateFromDeployments(toDocument, options);\n}\n\nexport async function runFromFolder(folder: string, options: RunOptions) {\n\tconst files = fs.readdirSync(folder);\n\tconst deployments: UnknownDeployments = {};\n\tfor (const file of files) {\n\t\tif (file.endsWith('.json')) {\n\t\t\tconst name = path.basename(file, '.json');\n\t\t\tif (!filter(options, name)) {\n\t\t\t\tcontinue;\n\t\t\t}\n\n\t\t\tconst deploymentString = fs.readFileSync(path.join(folder, file), 'utf-8');\n\t\t\tconst deployment = JSON.parse(deploymentString);\n\t\t\tdeployments[name] = deployment;\n\t\t}\n\t}\n\n\treturn generateFromDeployments(deployments, options);\n}\n\n// export async function runFromArtifacts(folder: string, options: {template?: string; outputFolder?: string}) {\n// \tconst files = fs.readdirSync(folder);\n// \tconst deployments: UnknownDeployments = {};\n// \tfor (const file of files) {\n// \t\tif (file.endsWith('.json')) {\n// \t\t\tconst deploymentString = fs.readFileSync(path.join(folder, file), 'utf-8');\n// \t\t\tconst deployment = JSON.parse(deploymentString);\n// \t\t\tdeployments[path.basename(file, '.json')] = deployment;\n// \t\t}\n// \t}\n\n// \treturn generateFromDeployments(deployments, options);\n// }\n\nexport async function generateFromDeployments(deployments: UnknownDeployments, options: RunOptions) {\n\tconst outputFolder = options.output || 'docs';\n\tconst templateFilepath = options.template || path.join(__dirname, '../public/default_templates/{{contracts}}.hbs');\n\tconst templateName = path.basename(templateFilepath, '.hbs');\n\tconst templateContent = fs.readFileSync(templateFilepath, 'utf-8');\n\tconst template = Handlebars.compile(templateContent);\n\n\tconst deploymentsList: DocumentationData[] = [];\n\tfor (const name of Object.keys(deployments)) {\n\t\tconst deployment = deployments[name];\n\t\tconst data = generateDocumentationData(name, deployment);\n\t\tdeploymentsList.push(data);\n\t}\n\n\tfs.emptyDirSync(outputFolder);\n\tif (templateName === '{{contracts}}') {\n\t\tfor (const deployment of deploymentsList) {\n\t\t\tconst generated = template(deployment);\n\t\t\tif (generated.trim() !== '') {\n\t\t\t\tfs.writeFileSync(path.join(outputFolder, deployment.name + '.md'), generated);\n\t\t\t}\n\t\t}\n\t} else {\n\t\tconst generated = template({contracts: deploymentsList});\n\t\tfs.writeFileSync(path.join(outputFolder, templateName + '.md'), generated);\n\t}\n}\n\nexport function generateDocumentationData(\n\tname: string,\n\tdeploymentOrArfifact: Partial<Deployment<Abi>> & Artifact<Abi>\n): DocumentationData {\n\tconst abi = deploymentOrArfifact.abi;\n\tconst abiMap = new Map<string, AbiConstructor | AbiError | AbiEvent | AbiFunction>();\n\tfor (const abiElement of abi) {\n\t\tswitch (abiElement.type) {\n\t\t\tcase 'constructor':\n\t\t\t\tabiMap.set('constructor', abiElement);\n\t\t\t\tbreak;\n\t\t\tcase 'error':\n\t\t\t\tabiMap.set(abiElement.name, abiElement);\n\t\t\t\tbreak;\n\t\t\tcase 'event':\n\t\t\t\tabiMap.set(abiElement.name, abiElement);\n\t\t\t\tbreak;\n\t\t\tcase 'function':\n\t\t\t\tabiMap.set(abiElement.name, abiElement);\n\t\t\t\tbreak;\n\t\t}\n\t}\n\n\tconst errors: ErrorDoc[] = [];\n\tconst events: EventDoc[] = [];\n\tconst methods: MethodDoc[] = [];\n\n\tif (deploymentOrArfifact.userdoc?.errors) {\n\t\t// we loop only through userdoc\n\t\tfor (const errorSignature of Object.keys(deploymentOrArfifact.userdoc.errors)) {\n\t\t\tconst errorName =\n\t\t\t\terrorSignature.indexOf('(') > 0 ? errorSignature.slice(0, errorSignature.indexOf('(')) : errorSignature;\n\n\t\t\tconst abi = abiMap.get(errorName) as AbiError;\n\t\t\tif (!abi) {\n\t\t\t\tcontinue;\n\t\t\t}\n\t\t\tconst fullFormat = Fragment.from(abi).format('full');\n\t\t\tconst paramNames = abi.inputs.map((v, index) => v.name || `_${index}`);\n\n\t\t\tconst errorFromUserDoc = deploymentOrArfifact.userdoc.errors[errorSignature];\n\t\t\tconst errorFromDevDoc = deploymentOrArfifact.devdoc?.errors?.[errorSignature];\n\t\t\tconst params: ParamDoc[] = [];\n\t\t\tif (errorFromDevDoc) {\n\t\t\t\tfor (const doc of errorFromDevDoc) {\n\t\t\t\t\tif (doc.params) {\n\t\t\t\t\t\tfor (const paramName of paramNames || Object.keys(doc.params)) {\n\t\t\t\t\t\t\tparams.push({name: paramName, description: doc.params[paramName]});\n\t\t\t\t\t\t}\n\t\t\t\t\t\t// TODO what if same name\n\t\t\t\t\t\t// TODO what is the array for ? (look at solidity doc)\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t\tconst notice: string[] = [];\n\t\t\tif (errorFromUserDoc) {\n\t\t\t\tfor (const doc of errorFromUserDoc) {\n\t\t\t\t\tif (doc.notice) {\n\t\t\t\t\t\tconst notes = doc.notice.split('\\\\');\n\t\t\t\t\t\tfor (const note of notes) {\n\t\t\t\t\t\t\tif (note != '') {\n\t\t\t\t\t\t\t\tnotice.push(note);\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\n\t\t\terrors.push({\n\t\t\t\tname: errorName,\n\t\t\t\tsignature: errorSignature,\n\t\t\t\tabi: abi,\n\t\t\t\tfullFormat,\n\t\t\t\tnotice,\n\t\t\t\tparams,\n\t\t\t});\n\t\t}\n\t}\n\n\tif (deploymentOrArfifact.userdoc?.events) {\n\t\t// we loop only through userdoc\n\t\tfor (const eventSignature of Object.keys(deploymentOrArfifact.userdoc.events)) {\n\t\t\tconst eventName =\n\t\t\t\teventSignature.indexOf('(') > 0 ? eventSignature.slice(0, eventSignature.indexOf('(')) : eventSignature;\n\n\t\t\tconst abi = abiMap.get(eventName) as AbiEvent;\n\t\t\tif (!abi) {\n\t\t\t\tcontinue;\n\t\t\t}\n\t\t\tconst fullFormat = Fragment.from(abi).format('full');\n\t\t\tconst paramNames = abi.inputs.map((v, index) => v.name || `_${index}`);\n\n\t\t\tconst eventFromUserDoc = deploymentOrArfifact.userdoc.events[eventSignature];\n\t\t\tconst eventFromDevDoc = deploymentOrArfifact.devdoc?.events?.[eventSignature];\n\t\t\tconst params: ParamDoc[] = [];\n\t\t\tif (eventFromDevDoc?.params) {\n\t\t\t\tfor (const paramName of paramNames || Object.keys(eventFromDevDoc.params)) {\n\t\t\t\t\tparams.push({name: paramName, description: eventFromDevDoc.params[paramName]});\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tevents.push({\n\t\t\t\tname: eventName,\n\t\t\t\tsignature: eventSignature,\n\t\t\t\tabi: abi as AbiEvent,\n\t\t\t\tfullFormat,\n\t\t\t\tnotice: eventFromUserDoc.notice,\n\t\t\t\tparams,\n\t\t\t});\n\t\t}\n\t}\n\n\tif (deploymentOrArfifact.userdoc?.methods) {\n\t\t// we loop only through userdoc\n\t\tfor (const methodSignature of Object.keys(deploymentOrArfifact.userdoc.methods)) {\n\t\t\tconst methodName =\n\t\t\t\tmethodSignature.indexOf('(') > 0 ? methodSignature.slice(0, methodSignature.indexOf('(')) : methodSignature;\n\n\t\t\tconst abi = abiMap.get(methodName) as AbiFunction | AbiConstructor;\n\t\t\tif (!abi) {\n\t\t\t\tcontinue;\n\t\t\t}\n\t\t\tconst fullFormat = Fragment.from(abi).format('full');\n\t\t\tconst paramNames = abi ? abi.inputs.map((v, index) => v.name || `_${index}`) : undefined;\n\t\t\tconst returnNames = abi && 'outputs' in abi ? abi.outputs.map((v, index) => v.name || `_${index}`) : undefined;\n\n\t\t\tconst methodFromUserDoc = deploymentOrArfifact.userdoc.methods[methodSignature];\n\t\t\tconst methodFromDevDoc = deploymentOrArfifact.devdoc?.methods?.[methodSignature];\n\t\t\tconst params: ParamDoc[] = [];\n\t\t\tif (methodFromDevDoc?.params) {\n\t\t\t\tfor (const paramName of paramNames || Object.keys(methodFromDevDoc.params)) {\n\t\t\t\t\tparams.push({name: paramName, description: methodFromDevDoc.params[paramName]});\n\t\t\t\t}\n\t\t\t}\n\t\t\tconst returns: ReturnDoc[] = [];\n\t\t\tif (methodFromDevDoc?.returns) {\n\t\t\t\tfor (const returnName of returnNames || Object.keys(methodFromDevDoc.returns)) {\n\t\t\t\t\treturns.push({name: returnName, description: methodFromDevDoc.returns[returnName]});\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tif (methodName === 'constructor') {\n\t\t\t\tmethods.push({\n\t\t\t\t\ttype: 'constructor',\n\t\t\t\t\tname: 'constructor',\n\t\t\t\t\tabi: abi as AbiConstructor,\n\t\t\t\t\tsignature: methodSignature,\n\t\t\t\t\tfullFormat,\n\t\t\t\t\tnotice: methodFromUserDoc.notice,\n\t\t\t\t\tparams,\n\t\t\t\t\treturns,\n\t\t\t\t});\n\t\t\t} else {\n\t\t\t\tconst selector = FunctionFragment.from(abi).selector as `0x${string}`;\n\t\t\t\tmethods.push({\n\t\t\t\t\ttype: 'function',\n\t\t\t\t\tname: methodName,\n\t\t\t\t\tabi: abi as AbiFunction,\n\t\t\t\t\tsignature: methodSignature,\n\t\t\t\t\tfullFormat,\n\t\t\t\t\tbytes4: selector,\n\t\t\t\t\tnotice: methodFromUserDoc.notice,\n\t\t\t\t\tparams,\n\t\t\t\t\treturns,\n\t\t\t\t});\n\t\t\t}\n\t\t}\n\t}\n\n\tconst data: DocumentationData = {\n\t\tname,\n\t\taddress: deploymentOrArfifact.address,\n\t\tabi,\n\t\tauthor: deploymentOrArfifact.devdoc?.author,\n\t\ttitle: deploymentOrArfifact.devdoc?.title,\n\t\tnotice: deploymentOrArfifact.userdoc?.notice,\n\t\terrors,\n\t\tevents,\n\t\tmethods,\n\t};\n\treturn data;\n}\n"],"names":["__dirname","dirname","fileURLToPath","loadDeployments","Fragment","FunctionFragment"],"mappings":";;;;;;;;;;AASA,MAAMA,WAAS,GAAGC,YAAO,CAACC,iBAAa,CAAC,8LAAe,CAAC,CAAC,CAAC;AAC1D,SAAS,MAAM,CAAC,OAAO,EAAE,IAAI,EAAE;AAC/B,EAAE,IAAI,OAAO,CAAC,YAAY,EAAE;AAC5B,IAAI,KAAK,MAAM,MAAM,IAAI,OAAO,CAAC,YAAY,EAAE;AAC/C,MAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;AACjC,QAAQ,OAAO,KAAK,CAAC;AACrB,OAAO;AACP,KAAK;AACL,GAAG;AACH,EAAE,OAAO,IAAI,CAAC;AACd,CAAC;AACM,eAAe,GAAG,CAAC,MAAM,EAAE,OAAO,EAAE;AAC3C,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,GAAGC,uBAAe,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AAC5F,EAAE,IAAI,CAAC,OAAO,EAAE;AAChB,IAAI,MAAM,IAAI,KAAK,CAAC,CAAC,qBAAqB,EAAE,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AACnE,GAAG;AACH,EAAE,QAAQ,CAAC,EAAE,WAAW,EAAE,EAAE,OAAO,CAAC,CAAC;AACrC,CAAC;AACM,eAAe,QAAQ,CAAC,EAAE,WAAW,EAAE,EAAE,OAAO,EAAE;AACzD,EAAE,IAAI,CAAC,WAAW,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;AAC7D,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC,wBAAwB,CAAC,CAAC,CAAC;AAC5C,IAAI,OAAO;AACX,GAAG;AACH,EAAE,MAAM,UAAU,GAAG,EAAE,CAAC;AACxB,EAAE,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE;AAC/C,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE;AAChC,MAAM,SAAS;AACf,KAAK;AACL,IAAI,MAAM,UAAU,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;AACzC,IAAI,UAAU,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC;AAClC,GAAG;AACH,EAAE,OAAO,uBAAuB,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;AACtD,CAAC;AACM,eAAe,aAAa,CAAC,MAAM,EAAE,OAAO,EAAE;AACrD,EAAE,MAAM,KAAK,GAAG,EAAE,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;AACvC,EAAE,MAAM,WAAW,GAAG,EAAE,CAAC;AACzB,EAAE,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;AAC5B,IAAI,IAAI,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;AAChC,MAAM,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;AAChD,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE;AAClC,QAAQ,SAAS;AACjB,OAAO;AACP,MAAM,MAAM,gBAAgB,GAAG,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC;AACjF,MAAM,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;AACtD,MAAM,WAAW,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC;AACrC,KAAK;AACL,GAAG;AACH,EAAE,OAAO,uBAAuB,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;AACvD,CAAC;AACM,eAAe,uBAAuB,CAAC,WAAW,EAAE,OAAO,EAAE;AACpE,EAAE,MAAM,YAAY,GAAG,OAAO,CAAC,MAAM,IAAI,MAAM,CAAC;AAChD,EAAE,MAAM,gBAAgB,GAAG,OAAO,CAAC,QAAQ,IAAI,IAAI,CAAC,IAAI,CAACH,WAAS,EAAE,+CAA+C,CAAC,CAAC;AACrH,EAAE,MAAM,YAAY,GAAG,IAAI,CAAC,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC,CAAC;AAC/D,EAAE,MAAM,eAAe,GAAG,EAAE,CAAC,YAAY,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;AACrE,EAAE,MAAM,QAAQ,GAAG,UAAU,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;AACvD,EAAE,MAAM,eAAe,GAAG,EAAE,CAAC;AAC7B,EAAE,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE;AAC/C,IAAI,MAAM,UAAU,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;AACzC,IAAI,MAAM,IAAI,GAAG,yBAAyB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;AAC7D,IAAI,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC/B,GAAG;AACH,EAAE,EAAE,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;AAChC,EAAE,IAAI,YAAY,KAAK,eAAe,EAAE;AACxC,IAAI,KAAK,MAAM,UAAU,IAAI,eAAe,EAAE;AAC9C,MAAM,MAAM,SAAS,GAAG,QAAQ,CAAC,UAAU,CAAC,CAAC;AAC7C,MAAM,IAAI,SAAS,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;AACnC,QAAQ,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,UAAU,CAAC,IAAI,GAAG,KAAK,CAAC,EAAE,SAAS,CAAC,CAAC;AACtF,OAAO;AACP,KAAK;AACL,GAAG,MAAM;AACT,IAAI,MAAM,SAAS,GAAG,QAAQ,CAAC,EAAE,SAAS,EAAE,eAAe,EAAE,CAAC,CAAC;AAC/D,IAAI,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,YAAY,GAAG,KAAK,CAAC,EAAE,SAAS,CAAC,CAAC;AAC/E,GAAG;AACH,CAAC;AACM,SAAS,yBAAyB,CAAC,IAAI,EAAE,oBAAoB,EAAE;AACtE,EAAE,MAAM,GAAG,GAAG,oBAAoB,CAAC,GAAG,CAAC;AACvC,EAAE,MAAM,MAAM,mBAAmB,IAAI,GAAG,EAAE,CAAC;AAC3C,EAAE,KAAK,MAAM,UAAU,IAAI,GAAG,EAAE;AAChC,IAAI,QAAQ,UAAU,CAAC,IAAI;AAC3B,MAAM,KAAK,aAAa;AACxB,QAAQ,MAAM,CAAC,GAAG,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC;AAC9C,QAAQ,MAAM;AACd,MAAM,KAAK,OAAO;AAClB,QAAQ,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;AAChD,QAAQ,MAAM;AACd,MAAM,KAAK,OAAO;AAClB,QAAQ,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;AAChD,QAAQ,MAAM;AACd,MAAM,KAAK,UAAU;AACrB,QAAQ,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;AAChD,QAAQ,MAAM;AACd,KAAK;AACL,GAAG;AACH,EAAE,MAAM,MAAM,GAAG,EAAE,CAAC;AACpB,EAAE,MAAM,MAAM,GAAG,EAAE,CAAC;AACpB,EAAE,MAAM,OAAO,GAAG,EAAE,CAAC;AACrB,EAAE,IAAI,oBAAoB,CAAC,OAAO,EAAE,MAAM,EAAE;AAC5C,IAAI,KAAK,MAAM,cAAc,IAAI,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;AACnF,MAAM,MAAM,SAAS,GAAG,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,cAAc,CAAC,KAAK,CAAC,CAAC,EAAE,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,cAAc,CAAC;AAChI,MAAM,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;AACzC,MAAM,IAAI,CAAC,IAAI,EAAE;AACjB,QAAQ,SAAS;AACjB,OAAO;AACP,MAAM,MAAM,UAAU,GAAGI,eAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;AAC5D,MAAM,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,KAAK,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;AAC9E,MAAM,MAAM,gBAAgB,GAAG,oBAAoB,CAAC,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;AACnF,MAAM,MAAM,eAAe,GAAG,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,cAAc,CAAC,CAAC;AACpF,MAAM,MAAM,MAAM,GAAG,EAAE,CAAC;AACxB,MAAM,IAAI,eAAe,EAAE;AAC3B,QAAQ,KAAK,MAAM,GAAG,IAAI,eAAe,EAAE;AAC3C,UAAU,IAAI,GAAG,CAAC,MAAM,EAAE;AAC1B,YAAY,KAAK,MAAM,SAAS,IAAI,UAAU,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;AAC3E,cAAc,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,WAAW,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;AACnF,aAAa;AACb,WAAW;AACX,SAAS;AACT,OAAO;AACP,MAAM,MAAM,MAAM,GAAG,EAAE,CAAC;AACxB,MAAM,IAAI,gBAAgB,EAAE;AAC5B,QAAQ,KAAK,MAAM,GAAG,IAAI,gBAAgB,EAAE;AAC5C,UAAU,IAAI,GAAG,CAAC,MAAM,EAAE;AAC1B,YAAY,MAAM,KAAK,GAAG,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;AACjD,YAAY,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;AACtC,cAAc,IAAI,IAAI,IAAI,EAAE,EAAE;AAC9B,gBAAgB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAClC,eAAe;AACf,aAAa;AACb,WAAW;AACX,SAAS;AACT,OAAO;AACP,MAAM,MAAM,CAAC,IAAI,CAAC;AAClB,QAAQ,IAAI,EAAE,SAAS;AACvB,QAAQ,SAAS,EAAE,cAAc;AACjC,QAAQ,GAAG,EAAE,IAAI;AACjB,QAAQ,UAAU;AAClB,QAAQ,MAAM;AACd,QAAQ,MAAM;AACd,OAAO,CAAC,CAAC;AACT,KAAK;AACL,GAAG;AACH,EAAE,IAAI,oBAAoB,CAAC,OAAO,EAAE,MAAM,EAAE;AAC5C,IAAI,KAAK,MAAM,cAAc,IAAI,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;AACnF,MAAM,MAAM,SAAS,GAAG,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,cAAc,CAAC,KAAK,CAAC,CAAC,EAAE,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,cAAc,CAAC;AAChI,MAAM,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;AACzC,MAAM,IAAI,CAAC,IAAI,EAAE;AACjB,QAAQ,SAAS;AACjB,OAAO;AACP,MAAM,MAAM,UAAU,GAAGA,eAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;AAC5D,MAAM,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,KAAK,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;AAC9E,MAAM,MAAM,gBAAgB,GAAG,oBAAoB,CAAC,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;AACnF,MAAM,MAAM,eAAe,GAAG,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,cAAc,CAAC,CAAC;AACpF,MAAM,MAAM,MAAM,GAAG,EAAE,CAAC;AACxB,MAAM,IAAI,eAAe,EAAE,MAAM,EAAE;AACnC,QAAQ,KAAK,MAAM,SAAS,IAAI,UAAU,IAAI,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,EAAE;AACnF,UAAU,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,WAAW,EAAE,eAAe,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;AAC3F,SAAS;AACT,OAAO;AACP,MAAM,MAAM,CAAC,IAAI,CAAC;AAClB,QAAQ,IAAI,EAAE,SAAS;AACvB,QAAQ,SAAS,EAAE,cAAc;AACjC,QAAQ,GAAG,EAAE,IAAI;AACjB,QAAQ,UAAU;AAClB,QAAQ,MAAM,EAAE,gBAAgB,CAAC,MAAM;AACvC,QAAQ,MAAM;AACd,OAAO,CAAC,CAAC;AACT,KAAK;AACL,GAAG;AACH,EAAE,IAAI,oBAAoB,CAAC,OAAO,EAAE,OAAO,EAAE;AAC7C,IAAI,KAAK,MAAM,eAAe,IAAI,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;AACrF,MAAM,MAAM,UAAU,GAAG,eAAe,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC,EAAE,eAAe,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,eAAe,CAAC;AACrI,MAAM,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;AAC1C,MAAM,IAAI,CAAC,IAAI,EAAE;AACjB,QAAQ,SAAS;AACjB,OAAO;AACP,MAAM,MAAM,UAAU,GAAGA,eAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;AAC5D,MAAM,MAAM,UAAU,GAAG,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,KAAK,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC;AAC9F,MAAM,MAAM,WAAW,GAAG,IAAI,IAAI,SAAS,IAAI,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,KAAK,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC;AACrH,MAAM,MAAM,iBAAiB,GAAG,oBAAoB,CAAC,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;AACtF,MAAM,MAAM,gBAAgB,GAAG,oBAAoB,CAAC,MAAM,EAAE,OAAO,GAAG,eAAe,CAAC,CAAC;AACvF,MAAM,MAAM,MAAM,GAAG,EAAE,CAAC;AACxB,MAAM,IAAI,gBAAgB,EAAE,MAAM,EAAE;AACpC,QAAQ,KAAK,MAAM,SAAS,IAAI,UAAU,IAAI,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,EAAE;AACpF,UAAU,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,WAAW,EAAE,gBAAgB,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;AAC5F,SAAS;AACT,OAAO;AACP,MAAM,MAAM,OAAO,GAAG,EAAE,CAAC;AACzB,MAAM,IAAI,gBAAgB,EAAE,OAAO,EAAE;AACrC,QAAQ,KAAK,MAAM,UAAU,IAAI,WAAW,IAAI,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,EAAE;AACvF,UAAU,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,WAAW,EAAE,gBAAgB,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;AAChG,SAAS;AACT,OAAO;AACP,MAAM,IAAI,UAAU,KAAK,aAAa,EAAE;AACxC,QAAQ,OAAO,CAAC,IAAI,CAAC;AACrB,UAAU,IAAI,EAAE,aAAa;AAC7B,UAAU,IAAI,EAAE,aAAa;AAC7B,UAAU,GAAG,EAAE,IAAI;AACnB,UAAU,SAAS,EAAE,eAAe;AACpC,UAAU,UAAU;AACpB,UAAU,MAAM,EAAE,iBAAiB,CAAC,MAAM;AAC1C,UAAU,MAAM;AAChB,UAAU,OAAO;AACjB,SAAS,CAAC,CAAC;AACX,OAAO,MAAM;AACb,QAAQ,MAAM,QAAQ,GAAGC,uBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC;AAC9D,QAAQ,OAAO,CAAC,IAAI,CAAC;AACrB,UAAU,IAAI,EAAE,UAAU;AAC1B,UAAU,IAAI,EAAE,UAAU;AAC1B,UAAU,GAAG,EAAE,IAAI;AACnB,UAAU,SAAS,EAAE,eAAe;AACpC,UAAU,UAAU;AACpB,UAAU,MAAM,EAAE,QAAQ;AAC1B,UAAU,MAAM,EAAE,iBAAiB,CAAC,MAAM;AAC1C,UAAU,MAAM;AAChB,UAAU,OAAO;AACjB,SAAS,CAAC,CAAC;AACX,OAAO;AACP,KAAK;AACL,GAAG;AACH,EAAE,MAAM,IAAI,GAAG;AACf,IAAI,IAAI;AACR,IAAI,OAAO,EAAE,oBAAoB,CAAC,OAAO;AACzC,IAAI,GAAG;AACP,IAAI,MAAM,EAAE,oBAAoB,CAAC,MAAM,EAAE,MAAM;AAC/C,IAAI,KAAK,EAAE,oBAAoB,CAAC,MAAM,EAAE,KAAK;AAC7C,IAAI,MAAM,EAAE,oBAAoB,CAAC,OAAO,EAAE,MAAM;AAChD,IAAI,MAAM;AACV,IAAI,MAAM;AACV,IAAI,OAAO;AACX,GAAG,CAAC;AACJ,EAAE,OAAO,IAAI,CAAC;AACd;;;;;;;;"}
package/dist/index.mjs DELETED
@@ -1,241 +0,0 @@
1
- import fs from 'fs-extra';
2
- import { loadDeployments } from 'rocketh';
3
- import Handlebars from 'handlebars';
4
- import path, { dirname } from 'path';
5
- import { Fragment, FunctionFragment } from 'ethers';
6
- import { fileURLToPath } from 'url';
7
-
8
- const __dirname = dirname(fileURLToPath(import.meta.url));
9
- function filter(options, name) {
10
- if (options.exceptSuffix) {
11
- for (const suffix of options.exceptSuffix) {
12
- if (name.endsWith(suffix)) {
13
- return false;
14
- }
15
- }
16
- }
17
- return true;
18
- }
19
- async function run(config, options) {
20
- const { deployments, chainId } = loadDeployments(config.deployments, config.network.name);
21
- if (!chainId) {
22
- throw new Error(`no chainId found for ${config.network.name}`);
23
- }
24
- generate({ deployments }, options);
25
- }
26
- async function generate({ deployments }, options) {
27
- if (!deployments || Object.keys(deployments).length === 0) {
28
- console.log(`no deployments to export`);
29
- return;
30
- }
31
- const toDocument = {};
32
- for (const name of Object.keys(deployments)) {
33
- if (!filter(options, name)) {
34
- continue;
35
- }
36
- const deployment = deployments[name];
37
- toDocument[name] = deployment;
38
- }
39
- return generateFromDeployments(toDocument, options);
40
- }
41
- async function runFromFolder(folder, options) {
42
- const files = fs.readdirSync(folder);
43
- const deployments = {};
44
- for (const file of files) {
45
- if (file.endsWith(".json")) {
46
- const name = path.basename(file, ".json");
47
- if (!filter(options, name)) {
48
- continue;
49
- }
50
- const deploymentString = fs.readFileSync(path.join(folder, file), "utf-8");
51
- const deployment = JSON.parse(deploymentString);
52
- deployments[name] = deployment;
53
- }
54
- }
55
- return generateFromDeployments(deployments, options);
56
- }
57
- async function generateFromDeployments(deployments, options) {
58
- const outputFolder = options.output || "docs";
59
- const templateFilepath = options.template || path.join(__dirname, "../public/default_templates/{{contracts}}.hbs");
60
- const templateName = path.basename(templateFilepath, ".hbs");
61
- const templateContent = fs.readFileSync(templateFilepath, "utf-8");
62
- const template = Handlebars.compile(templateContent);
63
- const deploymentsList = [];
64
- for (const name of Object.keys(deployments)) {
65
- const deployment = deployments[name];
66
- const data = generateDocumentationData(name, deployment);
67
- deploymentsList.push(data);
68
- }
69
- fs.emptyDirSync(outputFolder);
70
- if (templateName === "{{contracts}}") {
71
- for (const deployment of deploymentsList) {
72
- const generated = template(deployment);
73
- if (generated.trim() !== "") {
74
- fs.writeFileSync(path.join(outputFolder, deployment.name + ".md"), generated);
75
- }
76
- }
77
- } else {
78
- const generated = template({ contracts: deploymentsList });
79
- fs.writeFileSync(path.join(outputFolder, templateName + ".md"), generated);
80
- }
81
- }
82
- function generateDocumentationData(name, deploymentOrArfifact) {
83
- const abi = deploymentOrArfifact.abi;
84
- const abiMap = /* @__PURE__ */ new Map();
85
- for (const abiElement of abi) {
86
- switch (abiElement.type) {
87
- case "constructor":
88
- abiMap.set("constructor", abiElement);
89
- break;
90
- case "error":
91
- abiMap.set(abiElement.name, abiElement);
92
- break;
93
- case "event":
94
- abiMap.set(abiElement.name, abiElement);
95
- break;
96
- case "function":
97
- abiMap.set(abiElement.name, abiElement);
98
- break;
99
- }
100
- }
101
- const errors = [];
102
- const events = [];
103
- const methods = [];
104
- if (deploymentOrArfifact.userdoc?.errors) {
105
- for (const errorSignature of Object.keys(deploymentOrArfifact.userdoc.errors)) {
106
- const errorName = errorSignature.indexOf("(") > 0 ? errorSignature.slice(0, errorSignature.indexOf("(")) : errorSignature;
107
- const abi2 = abiMap.get(errorName);
108
- if (!abi2) {
109
- continue;
110
- }
111
- const fullFormat = Fragment.from(abi2).format("full");
112
- const paramNames = abi2.inputs.map((v, index) => v.name || `_${index}`);
113
- const errorFromUserDoc = deploymentOrArfifact.userdoc.errors[errorSignature];
114
- const errorFromDevDoc = deploymentOrArfifact.devdoc?.errors?.[errorSignature];
115
- const params = [];
116
- if (errorFromDevDoc) {
117
- for (const doc of errorFromDevDoc) {
118
- if (doc.params) {
119
- for (const paramName of paramNames || Object.keys(doc.params)) {
120
- params.push({ name: paramName, description: doc.params[paramName] });
121
- }
122
- }
123
- }
124
- }
125
- const notice = [];
126
- if (errorFromUserDoc) {
127
- for (const doc of errorFromUserDoc) {
128
- if (doc.notice) {
129
- const notes = doc.notice.split("\\");
130
- for (const note of notes) {
131
- if (note != "") {
132
- notice.push(note);
133
- }
134
- }
135
- }
136
- }
137
- }
138
- errors.push({
139
- name: errorName,
140
- signature: errorSignature,
141
- abi: abi2,
142
- fullFormat,
143
- notice,
144
- params
145
- });
146
- }
147
- }
148
- if (deploymentOrArfifact.userdoc?.events) {
149
- for (const eventSignature of Object.keys(deploymentOrArfifact.userdoc.events)) {
150
- const eventName = eventSignature.indexOf("(") > 0 ? eventSignature.slice(0, eventSignature.indexOf("(")) : eventSignature;
151
- const abi2 = abiMap.get(eventName);
152
- if (!abi2) {
153
- continue;
154
- }
155
- const fullFormat = Fragment.from(abi2).format("full");
156
- const paramNames = abi2.inputs.map((v, index) => v.name || `_${index}`);
157
- const eventFromUserDoc = deploymentOrArfifact.userdoc.events[eventSignature];
158
- const eventFromDevDoc = deploymentOrArfifact.devdoc?.events?.[eventSignature];
159
- const params = [];
160
- if (eventFromDevDoc?.params) {
161
- for (const paramName of paramNames || Object.keys(eventFromDevDoc.params)) {
162
- params.push({ name: paramName, description: eventFromDevDoc.params[paramName] });
163
- }
164
- }
165
- events.push({
166
- name: eventName,
167
- signature: eventSignature,
168
- abi: abi2,
169
- fullFormat,
170
- notice: eventFromUserDoc.notice,
171
- params
172
- });
173
- }
174
- }
175
- if (deploymentOrArfifact.userdoc?.methods) {
176
- for (const methodSignature of Object.keys(deploymentOrArfifact.userdoc.methods)) {
177
- const methodName = methodSignature.indexOf("(") > 0 ? methodSignature.slice(0, methodSignature.indexOf("(")) : methodSignature;
178
- const abi2 = abiMap.get(methodName);
179
- if (!abi2) {
180
- continue;
181
- }
182
- const fullFormat = Fragment.from(abi2).format("full");
183
- const paramNames = abi2 ? abi2.inputs.map((v, index) => v.name || `_${index}`) : void 0;
184
- const returnNames = abi2 && "outputs" in abi2 ? abi2.outputs.map((v, index) => v.name || `_${index}`) : void 0;
185
- const methodFromUserDoc = deploymentOrArfifact.userdoc.methods[methodSignature];
186
- const methodFromDevDoc = deploymentOrArfifact.devdoc?.methods?.[methodSignature];
187
- const params = [];
188
- if (methodFromDevDoc?.params) {
189
- for (const paramName of paramNames || Object.keys(methodFromDevDoc.params)) {
190
- params.push({ name: paramName, description: methodFromDevDoc.params[paramName] });
191
- }
192
- }
193
- const returns = [];
194
- if (methodFromDevDoc?.returns) {
195
- for (const returnName of returnNames || Object.keys(methodFromDevDoc.returns)) {
196
- returns.push({ name: returnName, description: methodFromDevDoc.returns[returnName] });
197
- }
198
- }
199
- if (methodName === "constructor") {
200
- methods.push({
201
- type: "constructor",
202
- name: "constructor",
203
- abi: abi2,
204
- signature: methodSignature,
205
- fullFormat,
206
- notice: methodFromUserDoc.notice,
207
- params,
208
- returns
209
- });
210
- } else {
211
- const selector = FunctionFragment.from(abi2).selector;
212
- methods.push({
213
- type: "function",
214
- name: methodName,
215
- abi: abi2,
216
- signature: methodSignature,
217
- fullFormat,
218
- bytes4: selector,
219
- notice: methodFromUserDoc.notice,
220
- params,
221
- returns
222
- });
223
- }
224
- }
225
- }
226
- const data = {
227
- name,
228
- address: deploymentOrArfifact.address,
229
- abi,
230
- author: deploymentOrArfifact.devdoc?.author,
231
- title: deploymentOrArfifact.devdoc?.title,
232
- notice: deploymentOrArfifact.userdoc?.notice,
233
- errors,
234
- events,
235
- methods
236
- };
237
- return data;
238
- }
239
-
240
- export { generate, generateDocumentationData, generateFromDeployments, run, runFromFolder };
241
- //# sourceMappingURL=index.mjs.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.mjs","sources":["../src/index.ts"],"sourcesContent":["import fs from 'fs-extra';\nimport type {\n\tDeployment,\n\tResolvedConfig,\n\tNoticeUserDoc,\n\tArtifact,\n\tAbi,\n\tUnknownDeployments,\n\tAbiConstructor,\n\tAbiFunction,\n\tAbiError,\n\tAbiEvent,\n} from 'rocketh';\nimport {loadDeployments} from 'rocketh';\nimport Handlebars from 'handlebars';\nimport path from 'path';\nimport {Fragment, FunctionFragment} from 'ethers';\nimport {dirname} from 'path';\nimport {fileURLToPath} from 'url';\n\nimport {DocumentationData, ErrorDoc, EventDoc, MethodDoc, ParamDoc, ReturnDoc} from './types';\n\nexport * from './types';\n\nconst __dirname = dirname(fileURLToPath(import.meta.url));\n\nexport type RunOptions = {template?: string; output?: string; exceptSuffix?: string[]};\n\nfunction filter(options: RunOptions, name: string): boolean {\n\tif (options.exceptSuffix) {\n\t\tfor (const suffix of options.exceptSuffix) {\n\t\t\tif (name.endsWith(suffix)) {\n\t\t\t\treturn false;\n\t\t\t}\n\t\t}\n\t}\n\treturn true;\n}\n\nexport async function run(config: ResolvedConfig, options: RunOptions) {\n\tconst {deployments, chainId} = loadDeployments(config.deployments, config.network.name);\n\tif (!chainId) {\n\t\tthrow new Error(`no chainId found for ${config.network.name}`);\n\t}\n\tgenerate({deployments}, options);\n}\n\nexport async function generate(\n\t{deployments}: {deployments: UnknownDeployments; chainId?: string},\n\toptions: RunOptions\n) {\n\tif (!deployments || Object.keys(deployments).length === 0) {\n\t\tconsole.log(`no deployments to export`);\n\t\treturn;\n\t}\n\n\tconst toDocument: UnknownDeployments = {};\n\tfor (const name of Object.keys(deployments)) {\n\t\tif (!filter(options, name)) {\n\t\t\tcontinue;\n\t\t}\n\t\tconst deployment = deployments[name];\n\t\ttoDocument[name] = deployment;\n\t}\n\n\treturn generateFromDeployments(toDocument, options);\n}\n\nexport async function runFromFolder(folder: string, options: RunOptions) {\n\tconst files = fs.readdirSync(folder);\n\tconst deployments: UnknownDeployments = {};\n\tfor (const file of files) {\n\t\tif (file.endsWith('.json')) {\n\t\t\tconst name = path.basename(file, '.json');\n\t\t\tif (!filter(options, name)) {\n\t\t\t\tcontinue;\n\t\t\t}\n\n\t\t\tconst deploymentString = fs.readFileSync(path.join(folder, file), 'utf-8');\n\t\t\tconst deployment = JSON.parse(deploymentString);\n\t\t\tdeployments[name] = deployment;\n\t\t}\n\t}\n\n\treturn generateFromDeployments(deployments, options);\n}\n\n// export async function runFromArtifacts(folder: string, options: {template?: string; outputFolder?: string}) {\n// \tconst files = fs.readdirSync(folder);\n// \tconst deployments: UnknownDeployments = {};\n// \tfor (const file of files) {\n// \t\tif (file.endsWith('.json')) {\n// \t\t\tconst deploymentString = fs.readFileSync(path.join(folder, file), 'utf-8');\n// \t\t\tconst deployment = JSON.parse(deploymentString);\n// \t\t\tdeployments[path.basename(file, '.json')] = deployment;\n// \t\t}\n// \t}\n\n// \treturn generateFromDeployments(deployments, options);\n// }\n\nexport async function generateFromDeployments(deployments: UnknownDeployments, options: RunOptions) {\n\tconst outputFolder = options.output || 'docs';\n\tconst templateFilepath = options.template || path.join(__dirname, '../public/default_templates/{{contracts}}.hbs');\n\tconst templateName = path.basename(templateFilepath, '.hbs');\n\tconst templateContent = fs.readFileSync(templateFilepath, 'utf-8');\n\tconst template = Handlebars.compile(templateContent);\n\n\tconst deploymentsList: DocumentationData[] = [];\n\tfor (const name of Object.keys(deployments)) {\n\t\tconst deployment = deployments[name];\n\t\tconst data = generateDocumentationData(name, deployment);\n\t\tdeploymentsList.push(data);\n\t}\n\n\tfs.emptyDirSync(outputFolder);\n\tif (templateName === '{{contracts}}') {\n\t\tfor (const deployment of deploymentsList) {\n\t\t\tconst generated = template(deployment);\n\t\t\tif (generated.trim() !== '') {\n\t\t\t\tfs.writeFileSync(path.join(outputFolder, deployment.name + '.md'), generated);\n\t\t\t}\n\t\t}\n\t} else {\n\t\tconst generated = template({contracts: deploymentsList});\n\t\tfs.writeFileSync(path.join(outputFolder, templateName + '.md'), generated);\n\t}\n}\n\nexport function generateDocumentationData(\n\tname: string,\n\tdeploymentOrArfifact: Partial<Deployment<Abi>> & Artifact<Abi>\n): DocumentationData {\n\tconst abi = deploymentOrArfifact.abi;\n\tconst abiMap = new Map<string, AbiConstructor | AbiError | AbiEvent | AbiFunction>();\n\tfor (const abiElement of abi) {\n\t\tswitch (abiElement.type) {\n\t\t\tcase 'constructor':\n\t\t\t\tabiMap.set('constructor', abiElement);\n\t\t\t\tbreak;\n\t\t\tcase 'error':\n\t\t\t\tabiMap.set(abiElement.name, abiElement);\n\t\t\t\tbreak;\n\t\t\tcase 'event':\n\t\t\t\tabiMap.set(abiElement.name, abiElement);\n\t\t\t\tbreak;\n\t\t\tcase 'function':\n\t\t\t\tabiMap.set(abiElement.name, abiElement);\n\t\t\t\tbreak;\n\t\t}\n\t}\n\n\tconst errors: ErrorDoc[] = [];\n\tconst events: EventDoc[] = [];\n\tconst methods: MethodDoc[] = [];\n\n\tif (deploymentOrArfifact.userdoc?.errors) {\n\t\t// we loop only through userdoc\n\t\tfor (const errorSignature of Object.keys(deploymentOrArfifact.userdoc.errors)) {\n\t\t\tconst errorName =\n\t\t\t\terrorSignature.indexOf('(') > 0 ? errorSignature.slice(0, errorSignature.indexOf('(')) : errorSignature;\n\n\t\t\tconst abi = abiMap.get(errorName) as AbiError;\n\t\t\tif (!abi) {\n\t\t\t\tcontinue;\n\t\t\t}\n\t\t\tconst fullFormat = Fragment.from(abi).format('full');\n\t\t\tconst paramNames = abi.inputs.map((v, index) => v.name || `_${index}`);\n\n\t\t\tconst errorFromUserDoc = deploymentOrArfifact.userdoc.errors[errorSignature];\n\t\t\tconst errorFromDevDoc = deploymentOrArfifact.devdoc?.errors?.[errorSignature];\n\t\t\tconst params: ParamDoc[] = [];\n\t\t\tif (errorFromDevDoc) {\n\t\t\t\tfor (const doc of errorFromDevDoc) {\n\t\t\t\t\tif (doc.params) {\n\t\t\t\t\t\tfor (const paramName of paramNames || Object.keys(doc.params)) {\n\t\t\t\t\t\t\tparams.push({name: paramName, description: doc.params[paramName]});\n\t\t\t\t\t\t}\n\t\t\t\t\t\t// TODO what if same name\n\t\t\t\t\t\t// TODO what is the array for ? (look at solidity doc)\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t\tconst notice: string[] = [];\n\t\t\tif (errorFromUserDoc) {\n\t\t\t\tfor (const doc of errorFromUserDoc) {\n\t\t\t\t\tif (doc.notice) {\n\t\t\t\t\t\tconst notes = doc.notice.split('\\\\');\n\t\t\t\t\t\tfor (const note of notes) {\n\t\t\t\t\t\t\tif (note != '') {\n\t\t\t\t\t\t\t\tnotice.push(note);\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\n\t\t\terrors.push({\n\t\t\t\tname: errorName,\n\t\t\t\tsignature: errorSignature,\n\t\t\t\tabi: abi,\n\t\t\t\tfullFormat,\n\t\t\t\tnotice,\n\t\t\t\tparams,\n\t\t\t});\n\t\t}\n\t}\n\n\tif (deploymentOrArfifact.userdoc?.events) {\n\t\t// we loop only through userdoc\n\t\tfor (const eventSignature of Object.keys(deploymentOrArfifact.userdoc.events)) {\n\t\t\tconst eventName =\n\t\t\t\teventSignature.indexOf('(') > 0 ? eventSignature.slice(0, eventSignature.indexOf('(')) : eventSignature;\n\n\t\t\tconst abi = abiMap.get(eventName) as AbiEvent;\n\t\t\tif (!abi) {\n\t\t\t\tcontinue;\n\t\t\t}\n\t\t\tconst fullFormat = Fragment.from(abi).format('full');\n\t\t\tconst paramNames = abi.inputs.map((v, index) => v.name || `_${index}`);\n\n\t\t\tconst eventFromUserDoc = deploymentOrArfifact.userdoc.events[eventSignature];\n\t\t\tconst eventFromDevDoc = deploymentOrArfifact.devdoc?.events?.[eventSignature];\n\t\t\tconst params: ParamDoc[] = [];\n\t\t\tif (eventFromDevDoc?.params) {\n\t\t\t\tfor (const paramName of paramNames || Object.keys(eventFromDevDoc.params)) {\n\t\t\t\t\tparams.push({name: paramName, description: eventFromDevDoc.params[paramName]});\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tevents.push({\n\t\t\t\tname: eventName,\n\t\t\t\tsignature: eventSignature,\n\t\t\t\tabi: abi as AbiEvent,\n\t\t\t\tfullFormat,\n\t\t\t\tnotice: eventFromUserDoc.notice,\n\t\t\t\tparams,\n\t\t\t});\n\t\t}\n\t}\n\n\tif (deploymentOrArfifact.userdoc?.methods) {\n\t\t// we loop only through userdoc\n\t\tfor (const methodSignature of Object.keys(deploymentOrArfifact.userdoc.methods)) {\n\t\t\tconst methodName =\n\t\t\t\tmethodSignature.indexOf('(') > 0 ? methodSignature.slice(0, methodSignature.indexOf('(')) : methodSignature;\n\n\t\t\tconst abi = abiMap.get(methodName) as AbiFunction | AbiConstructor;\n\t\t\tif (!abi) {\n\t\t\t\tcontinue;\n\t\t\t}\n\t\t\tconst fullFormat = Fragment.from(abi).format('full');\n\t\t\tconst paramNames = abi ? abi.inputs.map((v, index) => v.name || `_${index}`) : undefined;\n\t\t\tconst returnNames = abi && 'outputs' in abi ? abi.outputs.map((v, index) => v.name || `_${index}`) : undefined;\n\n\t\t\tconst methodFromUserDoc = deploymentOrArfifact.userdoc.methods[methodSignature];\n\t\t\tconst methodFromDevDoc = deploymentOrArfifact.devdoc?.methods?.[methodSignature];\n\t\t\tconst params: ParamDoc[] = [];\n\t\t\tif (methodFromDevDoc?.params) {\n\t\t\t\tfor (const paramName of paramNames || Object.keys(methodFromDevDoc.params)) {\n\t\t\t\t\tparams.push({name: paramName, description: methodFromDevDoc.params[paramName]});\n\t\t\t\t}\n\t\t\t}\n\t\t\tconst returns: ReturnDoc[] = [];\n\t\t\tif (methodFromDevDoc?.returns) {\n\t\t\t\tfor (const returnName of returnNames || Object.keys(methodFromDevDoc.returns)) {\n\t\t\t\t\treturns.push({name: returnName, description: methodFromDevDoc.returns[returnName]});\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tif (methodName === 'constructor') {\n\t\t\t\tmethods.push({\n\t\t\t\t\ttype: 'constructor',\n\t\t\t\t\tname: 'constructor',\n\t\t\t\t\tabi: abi as AbiConstructor,\n\t\t\t\t\tsignature: methodSignature,\n\t\t\t\t\tfullFormat,\n\t\t\t\t\tnotice: methodFromUserDoc.notice,\n\t\t\t\t\tparams,\n\t\t\t\t\treturns,\n\t\t\t\t});\n\t\t\t} else {\n\t\t\t\tconst selector = FunctionFragment.from(abi).selector as `0x${string}`;\n\t\t\t\tmethods.push({\n\t\t\t\t\ttype: 'function',\n\t\t\t\t\tname: methodName,\n\t\t\t\t\tabi: abi as AbiFunction,\n\t\t\t\t\tsignature: methodSignature,\n\t\t\t\t\tfullFormat,\n\t\t\t\t\tbytes4: selector,\n\t\t\t\t\tnotice: methodFromUserDoc.notice,\n\t\t\t\t\tparams,\n\t\t\t\t\treturns,\n\t\t\t\t});\n\t\t\t}\n\t\t}\n\t}\n\n\tconst data: DocumentationData = {\n\t\tname,\n\t\taddress: deploymentOrArfifact.address,\n\t\tabi,\n\t\tauthor: deploymentOrArfifact.devdoc?.author,\n\t\ttitle: deploymentOrArfifact.devdoc?.title,\n\t\tnotice: deploymentOrArfifact.userdoc?.notice,\n\t\terrors,\n\t\tevents,\n\t\tmethods,\n\t};\n\treturn data;\n}\n"],"names":[],"mappings":";;;;;;;AASA,MAAM,SAAS,GAAG,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AAC1D,SAAS,MAAM,CAAC,OAAO,EAAE,IAAI,EAAE;AAC/B,EAAE,IAAI,OAAO,CAAC,YAAY,EAAE;AAC5B,IAAI,KAAK,MAAM,MAAM,IAAI,OAAO,CAAC,YAAY,EAAE;AAC/C,MAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;AACjC,QAAQ,OAAO,KAAK,CAAC;AACrB,OAAO;AACP,KAAK;AACL,GAAG;AACH,EAAE,OAAO,IAAI,CAAC;AACd,CAAC;AACM,eAAe,GAAG,CAAC,MAAM,EAAE,OAAO,EAAE;AAC3C,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,eAAe,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AAC5F,EAAE,IAAI,CAAC,OAAO,EAAE;AAChB,IAAI,MAAM,IAAI,KAAK,CAAC,CAAC,qBAAqB,EAAE,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AACnE,GAAG;AACH,EAAE,QAAQ,CAAC,EAAE,WAAW,EAAE,EAAE,OAAO,CAAC,CAAC;AACrC,CAAC;AACM,eAAe,QAAQ,CAAC,EAAE,WAAW,EAAE,EAAE,OAAO,EAAE;AACzD,EAAE,IAAI,CAAC,WAAW,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;AAC7D,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC,wBAAwB,CAAC,CAAC,CAAC;AAC5C,IAAI,OAAO;AACX,GAAG;AACH,EAAE,MAAM,UAAU,GAAG,EAAE,CAAC;AACxB,EAAE,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE;AAC/C,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE;AAChC,MAAM,SAAS;AACf,KAAK;AACL,IAAI,MAAM,UAAU,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;AACzC,IAAI,UAAU,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC;AAClC,GAAG;AACH,EAAE,OAAO,uBAAuB,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;AACtD,CAAC;AACM,eAAe,aAAa,CAAC,MAAM,EAAE,OAAO,EAAE;AACrD,EAAE,MAAM,KAAK,GAAG,EAAE,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;AACvC,EAAE,MAAM,WAAW,GAAG,EAAE,CAAC;AACzB,EAAE,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;AAC5B,IAAI,IAAI,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;AAChC,MAAM,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;AAChD,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE;AAClC,QAAQ,SAAS;AACjB,OAAO;AACP,MAAM,MAAM,gBAAgB,GAAG,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC;AACjF,MAAM,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;AACtD,MAAM,WAAW,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC;AACrC,KAAK;AACL,GAAG;AACH,EAAE,OAAO,uBAAuB,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;AACvD,CAAC;AACM,eAAe,uBAAuB,CAAC,WAAW,EAAE,OAAO,EAAE;AACpE,EAAE,MAAM,YAAY,GAAG,OAAO,CAAC,MAAM,IAAI,MAAM,CAAC;AAChD,EAAE,MAAM,gBAAgB,GAAG,OAAO,CAAC,QAAQ,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,+CAA+C,CAAC,CAAC;AACrH,EAAE,MAAM,YAAY,GAAG,IAAI,CAAC,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC,CAAC;AAC/D,EAAE,MAAM,eAAe,GAAG,EAAE,CAAC,YAAY,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;AACrE,EAAE,MAAM,QAAQ,GAAG,UAAU,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;AACvD,EAAE,MAAM,eAAe,GAAG,EAAE,CAAC;AAC7B,EAAE,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE;AAC/C,IAAI,MAAM,UAAU,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;AACzC,IAAI,MAAM,IAAI,GAAG,yBAAyB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;AAC7D,IAAI,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC/B,GAAG;AACH,EAAE,EAAE,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;AAChC,EAAE,IAAI,YAAY,KAAK,eAAe,EAAE;AACxC,IAAI,KAAK,MAAM,UAAU,IAAI,eAAe,EAAE;AAC9C,MAAM,MAAM,SAAS,GAAG,QAAQ,CAAC,UAAU,CAAC,CAAC;AAC7C,MAAM,IAAI,SAAS,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;AACnC,QAAQ,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,UAAU,CAAC,IAAI,GAAG,KAAK,CAAC,EAAE,SAAS,CAAC,CAAC;AACtF,OAAO;AACP,KAAK;AACL,GAAG,MAAM;AACT,IAAI,MAAM,SAAS,GAAG,QAAQ,CAAC,EAAE,SAAS,EAAE,eAAe,EAAE,CAAC,CAAC;AAC/D,IAAI,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,YAAY,GAAG,KAAK,CAAC,EAAE,SAAS,CAAC,CAAC;AAC/E,GAAG;AACH,CAAC;AACM,SAAS,yBAAyB,CAAC,IAAI,EAAE,oBAAoB,EAAE;AACtE,EAAE,MAAM,GAAG,GAAG,oBAAoB,CAAC,GAAG,CAAC;AACvC,EAAE,MAAM,MAAM,mBAAmB,IAAI,GAAG,EAAE,CAAC;AAC3C,EAAE,KAAK,MAAM,UAAU,IAAI,GAAG,EAAE;AAChC,IAAI,QAAQ,UAAU,CAAC,IAAI;AAC3B,MAAM,KAAK,aAAa;AACxB,QAAQ,MAAM,CAAC,GAAG,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC;AAC9C,QAAQ,MAAM;AACd,MAAM,KAAK,OAAO;AAClB,QAAQ,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;AAChD,QAAQ,MAAM;AACd,MAAM,KAAK,OAAO;AAClB,QAAQ,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;AAChD,QAAQ,MAAM;AACd,MAAM,KAAK,UAAU;AACrB,QAAQ,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;AAChD,QAAQ,MAAM;AACd,KAAK;AACL,GAAG;AACH,EAAE,MAAM,MAAM,GAAG,EAAE,CAAC;AACpB,EAAE,MAAM,MAAM,GAAG,EAAE,CAAC;AACpB,EAAE,MAAM,OAAO,GAAG,EAAE,CAAC;AACrB,EAAE,IAAI,oBAAoB,CAAC,OAAO,EAAE,MAAM,EAAE;AAC5C,IAAI,KAAK,MAAM,cAAc,IAAI,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;AACnF,MAAM,MAAM,SAAS,GAAG,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,cAAc,CAAC,KAAK,CAAC,CAAC,EAAE,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,cAAc,CAAC;AAChI,MAAM,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;AACzC,MAAM,IAAI,CAAC,IAAI,EAAE;AACjB,QAAQ,SAAS;AACjB,OAAO;AACP,MAAM,MAAM,UAAU,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;AAC5D,MAAM,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,KAAK,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;AAC9E,MAAM,MAAM,gBAAgB,GAAG,oBAAoB,CAAC,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;AACnF,MAAM,MAAM,eAAe,GAAG,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,cAAc,CAAC,CAAC;AACpF,MAAM,MAAM,MAAM,GAAG,EAAE,CAAC;AACxB,MAAM,IAAI,eAAe,EAAE;AAC3B,QAAQ,KAAK,MAAM,GAAG,IAAI,eAAe,EAAE;AAC3C,UAAU,IAAI,GAAG,CAAC,MAAM,EAAE;AAC1B,YAAY,KAAK,MAAM,SAAS,IAAI,UAAU,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;AAC3E,cAAc,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,WAAW,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;AACnF,aAAa;AACb,WAAW;AACX,SAAS;AACT,OAAO;AACP,MAAM,MAAM,MAAM,GAAG,EAAE,CAAC;AACxB,MAAM,IAAI,gBAAgB,EAAE;AAC5B,QAAQ,KAAK,MAAM,GAAG,IAAI,gBAAgB,EAAE;AAC5C,UAAU,IAAI,GAAG,CAAC,MAAM,EAAE;AAC1B,YAAY,MAAM,KAAK,GAAG,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;AACjD,YAAY,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;AACtC,cAAc,IAAI,IAAI,IAAI,EAAE,EAAE;AAC9B,gBAAgB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAClC,eAAe;AACf,aAAa;AACb,WAAW;AACX,SAAS;AACT,OAAO;AACP,MAAM,MAAM,CAAC,IAAI,CAAC;AAClB,QAAQ,IAAI,EAAE,SAAS;AACvB,QAAQ,SAAS,EAAE,cAAc;AACjC,QAAQ,GAAG,EAAE,IAAI;AACjB,QAAQ,UAAU;AAClB,QAAQ,MAAM;AACd,QAAQ,MAAM;AACd,OAAO,CAAC,CAAC;AACT,KAAK;AACL,GAAG;AACH,EAAE,IAAI,oBAAoB,CAAC,OAAO,EAAE,MAAM,EAAE;AAC5C,IAAI,KAAK,MAAM,cAAc,IAAI,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;AACnF,MAAM,MAAM,SAAS,GAAG,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,cAAc,CAAC,KAAK,CAAC,CAAC,EAAE,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,cAAc,CAAC;AAChI,MAAM,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;AACzC,MAAM,IAAI,CAAC,IAAI,EAAE;AACjB,QAAQ,SAAS;AACjB,OAAO;AACP,MAAM,MAAM,UAAU,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;AAC5D,MAAM,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,KAAK,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;AAC9E,MAAM,MAAM,gBAAgB,GAAG,oBAAoB,CAAC,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;AACnF,MAAM,MAAM,eAAe,GAAG,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,cAAc,CAAC,CAAC;AACpF,MAAM,MAAM,MAAM,GAAG,EAAE,CAAC;AACxB,MAAM,IAAI,eAAe,EAAE,MAAM,EAAE;AACnC,QAAQ,KAAK,MAAM,SAAS,IAAI,UAAU,IAAI,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,EAAE;AACnF,UAAU,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,WAAW,EAAE,eAAe,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;AAC3F,SAAS;AACT,OAAO;AACP,MAAM,MAAM,CAAC,IAAI,CAAC;AAClB,QAAQ,IAAI,EAAE,SAAS;AACvB,QAAQ,SAAS,EAAE,cAAc;AACjC,QAAQ,GAAG,EAAE,IAAI;AACjB,QAAQ,UAAU;AAClB,QAAQ,MAAM,EAAE,gBAAgB,CAAC,MAAM;AACvC,QAAQ,MAAM;AACd,OAAO,CAAC,CAAC;AACT,KAAK;AACL,GAAG;AACH,EAAE,IAAI,oBAAoB,CAAC,OAAO,EAAE,OAAO,EAAE;AAC7C,IAAI,KAAK,MAAM,eAAe,IAAI,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;AACrF,MAAM,MAAM,UAAU,GAAG,eAAe,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC,EAAE,eAAe,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,eAAe,CAAC;AACrI,MAAM,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;AAC1C,MAAM,IAAI,CAAC,IAAI,EAAE;AACjB,QAAQ,SAAS;AACjB,OAAO;AACP,MAAM,MAAM,UAAU,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;AAC5D,MAAM,MAAM,UAAU,GAAG,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,KAAK,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC;AAC9F,MAAM,MAAM,WAAW,GAAG,IAAI,IAAI,SAAS,IAAI,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,KAAK,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC;AACrH,MAAM,MAAM,iBAAiB,GAAG,oBAAoB,CAAC,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;AACtF,MAAM,MAAM,gBAAgB,GAAG,oBAAoB,CAAC,MAAM,EAAE,OAAO,GAAG,eAAe,CAAC,CAAC;AACvF,MAAM,MAAM,MAAM,GAAG,EAAE,CAAC;AACxB,MAAM,IAAI,gBAAgB,EAAE,MAAM,EAAE;AACpC,QAAQ,KAAK,MAAM,SAAS,IAAI,UAAU,IAAI,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,EAAE;AACpF,UAAU,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,WAAW,EAAE,gBAAgB,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;AAC5F,SAAS;AACT,OAAO;AACP,MAAM,MAAM,OAAO,GAAG,EAAE,CAAC;AACzB,MAAM,IAAI,gBAAgB,EAAE,OAAO,EAAE;AACrC,QAAQ,KAAK,MAAM,UAAU,IAAI,WAAW,IAAI,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,EAAE;AACvF,UAAU,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,WAAW,EAAE,gBAAgB,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;AAChG,SAAS;AACT,OAAO;AACP,MAAM,IAAI,UAAU,KAAK,aAAa,EAAE;AACxC,QAAQ,OAAO,CAAC,IAAI,CAAC;AACrB,UAAU,IAAI,EAAE,aAAa;AAC7B,UAAU,IAAI,EAAE,aAAa;AAC7B,UAAU,GAAG,EAAE,IAAI;AACnB,UAAU,SAAS,EAAE,eAAe;AACpC,UAAU,UAAU;AACpB,UAAU,MAAM,EAAE,iBAAiB,CAAC,MAAM;AAC1C,UAAU,MAAM;AAChB,UAAU,OAAO;AACjB,SAAS,CAAC,CAAC;AACX,OAAO,MAAM;AACb,QAAQ,MAAM,QAAQ,GAAG,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC;AAC9D,QAAQ,OAAO,CAAC,IAAI,CAAC;AACrB,UAAU,IAAI,EAAE,UAAU;AAC1B,UAAU,IAAI,EAAE,UAAU;AAC1B,UAAU,GAAG,EAAE,IAAI;AACnB,UAAU,SAAS,EAAE,eAAe;AACpC,UAAU,UAAU;AACpB,UAAU,MAAM,EAAE,QAAQ;AAC1B,UAAU,MAAM,EAAE,iBAAiB,CAAC,MAAM;AAC1C,UAAU,MAAM;AAChB,UAAU,OAAO;AACjB,SAAS,CAAC,CAAC;AACX,OAAO;AACP,KAAK;AACL,GAAG;AACH,EAAE,MAAM,IAAI,GAAG;AACf,IAAI,IAAI;AACR,IAAI,OAAO,EAAE,oBAAoB,CAAC,OAAO;AACzC,IAAI,GAAG;AACP,IAAI,MAAM,EAAE,oBAAoB,CAAC,MAAM,EAAE,MAAM;AAC/C,IAAI,KAAK,EAAE,oBAAoB,CAAC,MAAM,EAAE,KAAK;AAC7C,IAAI,MAAM,EAAE,oBAAoB,CAAC,OAAO,EAAE,MAAM;AAChD,IAAI,MAAM;AACV,IAAI,MAAM;AACV,IAAI,OAAO;AACX,GAAG,CAAC;AACJ,EAAE,OAAO,IAAI,CAAC;AACd;;;;"}
File without changes
File without changes
File without changes
File without changes
File without changes