@openzeppelin/wizard 0.1.0

package/README.md

@@ -0,0 +1,82 @@
+# OpenZeppelin Contracts Wizard for Solidity
+
+Interactively build a contract out of components from OpenZeppelin Contracts. Provide parameters and desired features for the kind of contract that you want, and the Wizard will generate all of the code necessary. The resulting code is ready to be compiled and deployed, or it can serve as a starting point and customized further with application specific logic.
+
+This package provides a programmatic API. For a web interface, see https://wizard.openzeppelin.com
+
+### Installation
+
+`npm install @openzeppelin/wizard`
+
+### Contract types
+
+The following contract types are supported:
+- `erc20`
+- `erc721`
+- `erc1155`
+- `governor`
+
+Each contract type has a `print` function and a `defaults` constant as defined below.
+
+### Functions
+
+#### `print`
+```js
+function print(opts?: ERC20Options): string
+```
+```js
+function print(opts?: ERC721Options): string
+```
+```js
+function print(opts?: ERC1155Options): string
+```
+```js
+function print(opts?: GovernorOptions): string
+```
+Returns a string representation of a contract generated using the provided options. If `opts` is not provided, uses [`defaults`](#defaults).
+
+#### `defaults`
+```js
+const defaults: Required<ERC20Options>
+```
+```js
+const defaults: Required<ERC721Options>
+```
+```js
+const defaults: Required<ERC1155Options>
+```
+```js
+const defaults: Required<GovernorOptions>
+```
+The default options that are used for [`print`](#print).
+
+### Examples
+
+Import the contract type(s) that you want to use from the `@openzeppelin/wizard` package:
+
+```js
+import { erc20 } from '@openzeppelin/wizard';
+```
+
+To generate the source code for an ERC20 contract with all of the default settings:
+```js
+const contract = erc20.print();
+```
+
+To generate the source code for an ERC20 contract with a custom name and symbol, along with some custom settings:
+```js
+const contract = erc20.print({
+  name: 'ExampleToken',
+  symbol: 'ETK',
+  burnable: true,
+  premint: '1000000',
+});
+```
+
+To generate the source code for an ERC20 contract with all of the defaults but is upgradeable using the UUPS proxy pattern:
+```js
+const contract = erc20.print({
+  ...erc20.defaults,
+  upgradeable: 'uups',
+});
+```

package/dist/add-pausable.d.ts

@@ -0,0 +1,4 @@
+import type { ContractBuilder, BaseFunction } from './contract';
+import { Access } from './set-access-control';
+export declare function addPausable(c: ContractBuilder, access: Access, pausableFns: BaseFunction[]): void;
+//# sourceMappingURL=add-pausable.d.ts.map

package/dist/add-pausable.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"add-pausable.d.ts","sourceRoot":"","sources":["../src/add-pausable.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAChE,OAAO,EAAE,MAAM,EAAoB,MAAM,sBAAsB,CAAC;AAGhE,wBAAgB,WAAW,CAAC,CAAC,EAAE,eAAe,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,YAAY,EAAE,QAe1F"}

package/dist/add-pausable.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addPausable = void 0;
+const set_access_control_1 = require("./set-access-control");
+const define_functions_1 = require("./utils/define-functions");
+function addPausable(c, access, pausableFns) {
+    c.addParent({
+        name: 'Pausable',
+        path: '@openzeppelin/contracts/security/Pausable.sol',
+    });
+    for (const fn of pausableFns) {
+        c.addModifier('whenNotPaused', fn);
+    }
+    (0, set_access_control_1.setAccessControl)(c, functions.pause, access, 'PAUSER');
+    c.addFunctionCode('_pause();', functions.pause);
+    (0, set_access_control_1.setAccessControl)(c, functions.unpause, access, 'PAUSER');
+    c.addFunctionCode('_unpause();', functions.unpause);
+}
+exports.addPausable = addPausable;
+const functions = (0, define_functions_1.defineFunctions)({
+    pause: {
+        kind: 'public',
+        args: [],
+    },
+    unpause: {
+        kind: 'public',
+        args: [],
+    },
+});
+//# sourceMappingURL=add-pausable.js.map

package/dist/add-pausable.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"add-pausable.js","sourceRoot":"","sources":["../src/add-pausable.ts"],"names":[],"mappings":";;;AACA,6DAAgE;AAChE,+DAA2D;AAE3D,SAAgB,WAAW,CAAC,CAAkB,EAAE,MAAc,EAAE,WAA2B;IACzF,CAAC,CAAC,SAAS,CAAC;QACV,IAAI,EAAE,UAAU;QAChB,IAAI,EAAE,+CAA+C;KACtD,CAAC,CAAC;IAEH,KAAK,MAAM,EAAE,IAAI,WAAW,EAAE;QAC5B,CAAC,CAAC,WAAW,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC;KACpC;IAED,IAAA,qCAAgB,EAAC,CAAC,EAAE,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IACvD,CAAC,CAAC,eAAe,CAAC,WAAW,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC;IAEhD,IAAA,qCAAgB,EAAC,CAAC,EAAE,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IACzD,CAAC,CAAC,eAAe,CAAC,aAAa,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;AACtD,CAAC;AAfD,kCAeC;AAED,MAAM,SAAS,GAAG,IAAA,kCAAe,EAAC;IAChC,KAAK,EAAE;QACL,IAAI,EAAE,QAAiB;QACvB,IAAI,EAAE,EAAE;KACT;IAED,OAAO,EAAE;QACP,IAAI,EAAE,QAAiB;QACvB,IAAI,EAAE,EAAE;KACT;CACF,CAAC,CAAC"}

package/dist/api.d.ts

@@ -0,0 +1,24 @@
+import type { CommonOptions } from './common-options';
+import { ERC20Options } from './erc20';
+import { ERC721Options } from './erc721';
+import { ERC1155Options } from './erc1155';
+import { GovernorOptions } from './governor';
+export interface WizardContractAPI<Options extends CommonOptions> {
+    /**
+     * Returns a string representation of a contract generated using the provided options. If opts is not provided, uses `defaults`.
+     */
+    print: (opts?: Options) => string;
+    /**
+     * The default options that are used for `print`.
+     */
+    defaults: Required<Options>;
+}
+export declare type ERC20 = WizardContractAPI<ERC20Options>;
+export declare type ERC721 = WizardContractAPI<ERC721Options>;
+export declare type ERC1155 = WizardContractAPI<ERC1155Options>;
+export declare type Governor = WizardContractAPI<GovernorOptions>;
+export declare const erc20: ERC20;
+export declare const erc721: ERC721;
+export declare const erc1155: ERC1155;
+export declare const governor: Governor;
+//# sourceMappingURL=api.d.ts.map

package/dist/api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACtD,OAAO,EAAyC,YAAY,EAAE,MAAM,SAAS,CAAC;AAC9E,OAAO,EAA2C,aAAa,EAAE,MAAM,UAAU,CAAC;AAClF,OAAO,EAA6C,cAAc,EAAE,MAAM,WAAW,CAAC;AACtF,OAAO,EAA+C,eAAe,EAAE,MAAM,YAAY,CAAC;AAE1F,MAAM,WAAW,iBAAiB,CAAC,OAAO,SAAS,aAAa;IAC9D;;OAEG;IACH,KAAK,EAAE,CAAC,IAAI,CAAC,EAAE,OAAO,KAAK,MAAM,CAAC;IAElC;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;CAC7B;AAED,oBAAY,KAAK,GAAG,iBAAiB,CAAC,YAAY,CAAC,CAAC;AACpD,oBAAY,MAAM,GAAG,iBAAiB,CAAC,aAAa,CAAC,CAAC;AACtD,oBAAY,OAAO,GAAG,iBAAiB,CAAC,cAAc,CAAC,CAAC;AACxD,oBAAY,QAAQ,GAAG,iBAAiB,CAAC,eAAe,CAAC,CAAC;AAE1D,eAAO,MAAM,KAAK,EAAE,KAGnB,CAAA;AACD,eAAO,MAAM,MAAM,EAAE,MAGpB,CAAA;AACD,eAAO,MAAM,OAAO,EAAE,OAGrB,CAAA;AACD,eAAO,MAAM,QAAQ,EAAE,QAGtB,CAAA"}

package/dist/api.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.governor = exports.erc1155 = exports.erc721 = exports.erc20 = void 0;
+const erc20_1 = require("./erc20");
+const erc721_1 = require("./erc721");
+const erc1155_1 = require("./erc1155");
+const governor_1 = require("./governor");
+exports.erc20 = {
+    print: erc20_1.printERC20,
+    defaults: erc20_1.defaults
+};
+exports.erc721 = {
+    print: erc721_1.printERC721,
+    defaults: erc721_1.defaults
+};
+exports.erc1155 = {
+    print: erc1155_1.printERC1155,
+    defaults: erc1155_1.defaults
+};
+exports.governor = {
+    print: governor_1.printGovernor,
+    defaults: governor_1.defaults
+};
+//# sourceMappingURL=api.js.map

package/dist/api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.js","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":";;;AACA,mCAA8E;AAC9E,qCAAkF;AAClF,uCAAsF;AACtF,yCAA0F;AAmB7E,QAAA,KAAK,GAAU;IAC1B,KAAK,EAAE,kBAAU;IACjB,QAAQ,EAAE,gBAAa;CACxB,CAAA;AACY,QAAA,MAAM,GAAW;IAC5B,KAAK,EAAE,oBAAW;IAClB,QAAQ,EAAE,iBAAc;CACzB,CAAA;AACY,QAAA,OAAO,GAAY;IAC9B,KAAK,EAAE,sBAAY;IACnB,QAAQ,EAAE,kBAAe;CAC1B,CAAA;AACY,QAAA,QAAQ,GAAa;IAChC,KAAK,EAAE,wBAAa;IACpB,QAAQ,EAAE,mBAAgB;CAC3B,CAAA"}

package/dist/build-generic.d.ts

@@ -0,0 +1,21 @@
+import { ERC20Options } from './erc20';
+import { ERC721Options } from './erc721';
+import { ERC1155Options } from './erc1155';
+import { GovernorOptions } from './governor';
+export interface KindedOptions {
+    ERC20: {
+        kind: 'ERC20';
+    } & ERC20Options;
+    ERC721: {
+        kind: 'ERC721';
+    } & ERC721Options;
+    ERC1155: {
+        kind: 'ERC1155';
+    } & ERC1155Options;
+    Governor: {
+        kind: 'Governor';
+    } & GovernorOptions;
+}
+export declare type GenericOptions = KindedOptions[keyof KindedOptions];
+export declare function buildGeneric(opts: GenericOptions): import("./contract").Contract;
+//# sourceMappingURL=build-generic.d.ts.map

package/dist/build-generic.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"build-generic.d.ts","sourceRoot":"","sources":["../src/build-generic.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAc,MAAM,SAAS,CAAC;AACnD,OAAO,EAAE,aAAa,EAAe,MAAM,UAAU,CAAC;AACtD,OAAO,EAAE,cAAc,EAAgB,MAAM,WAAW,CAAC;AACzD,OAAO,EAAE,eAAe,EAAiB,MAAM,YAAY,CAAC;AAE5D,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAK;QAAE,IAAI,EAAE,OAAO,CAAA;KAAE,GAAM,YAAY,CAAC;IAC9C,MAAM,EAAI;QAAE,IAAI,EAAE,QAAQ,CAAA;KAAE,GAAK,aAAa,CAAC;IAC/C,OAAO,EAAG;QAAE,IAAI,EAAE,SAAS,CAAA;KAAE,GAAI,cAAc,CAAC;IAChD,QAAQ,EAAE;QAAE,IAAI,EAAE,UAAU,CAAA;KAAE,GAAG,eAAe,CAAC;CAClD;AAED,oBAAY,cAAc,GAAG,aAAa,CAAC,MAAM,aAAa,CAAC,CAAC;AAEhE,wBAAgB,YAAY,CAAC,IAAI,EAAE,cAAc,iCAkBhD"}

package/dist/build-generic.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildGeneric = void 0;
+const erc20_1 = require("./erc20");
+const erc721_1 = require("./erc721");
+const erc1155_1 = require("./erc1155");
+const governor_1 = require("./governor");
+function buildGeneric(opts) {
+    switch (opts.kind) {
+        case 'ERC20':
+            return (0, erc20_1.buildERC20)(opts);
+        case 'ERC721':
+            return (0, erc721_1.buildERC721)(opts);
+        case 'ERC1155':
+            return (0, erc1155_1.buildERC1155)(opts);
+        case 'Governor':
+            return (0, governor_1.buildGovernor)(opts);
+        default:
+            const _ = opts;
+            throw new Error('Unknown ERC');
+    }
+}
+exports.buildGeneric = buildGeneric;
+//# sourceMappingURL=build-generic.js.map

package/dist/build-generic.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"build-generic.js","sourceRoot":"","sources":["../src/build-generic.ts"],"names":[],"mappings":";;;AAAA,mCAAmD;AACnD,qCAAsD;AACtD,uCAAyD;AACzD,yCAA4D;AAW5D,SAAgB,YAAY,CAAC,IAAoB;IAC/C,QAAQ,IAAI,CAAC,IAAI,EAAE;QACjB,KAAK,OAAO;YACV,OAAO,IAAA,kBAAU,EAAC,IAAI,CAAC,CAAC;QAE1B,KAAK,QAAQ;YACX,OAAO,IAAA,oBAAW,EAAC,IAAI,CAAC,CAAC;QAE3B,KAAK,SAAS;YACZ,OAAO,IAAA,sBAAY,EAAC,IAAI,CAAC,CAAC;QAE5B,KAAK,UAAU;YACb,OAAO,IAAA,wBAAa,EAAC,IAAI,CAAC,CAAC;QAE7B;YACE,MAAM,CAAC,GAAU,IAAI,CAAC;YACtB,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,CAAC;KAClC;AACH,CAAC;AAlBD,oCAkBC"}

package/dist/common-functions.d.ts

@@ -0,0 +1,3 @@
+import type { BaseFunction } from './contract';
+export declare const supportsInterface: BaseFunction;
+//# sourceMappingURL=common-functions.d.ts.map

package/dist/common-functions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"common-functions.d.ts","sourceRoot":"","sources":["../src/common-functions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE/C,eAAO,MAAM,iBAAiB,EAAE,YAQ/B,CAAC"}

package/dist/common-functions.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.supportsInterface = void 0;
+exports.supportsInterface = {
+    name: 'supportsInterface',
+    kind: 'public',
+    args: [
+        { name: 'interfaceId', type: 'bytes4' },
+    ],
+    returns: ['bool'],
+    mutability: 'view',
+};
+//# sourceMappingURL=common-functions.js.map

package/dist/common-functions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"common-functions.js","sourceRoot":"","sources":["../src/common-functions.ts"],"names":[],"mappings":";;;AAEa,QAAA,iBAAiB,GAAiB;IAC7C,IAAI,EAAE,mBAAmB;IACzB,IAAI,EAAE,QAAQ;IACd,IAAI,EAAE;QACJ,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,QAAQ,EAAE;KACxC;IACD,OAAO,EAAE,CAAC,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM;CACnB,CAAC"}

package/dist/common-options.d.ts

@@ -0,0 +1,11 @@
+import type { Access } from "./set-access-control";
+import type { Info } from "./set-info";
+import type { Upgradeable } from "./set-upgradeable";
+export declare const defaults: Required<CommonOptions>;
+export interface CommonOptions {
+    access?: Access;
+    upgradeable?: Upgradeable;
+    info?: Info;
+}
+export declare function withCommonDefaults(opts: CommonOptions): Required<CommonOptions>;
+//# sourceMappingURL=common-options.d.ts.map

package/dist/common-options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"common-options.d.ts","sourceRoot":"","sources":["../src/common-options.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAEvC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAErD,eAAO,MAAM,QAAQ,EAAE,QAAQ,CAAC,aAAa,CAInC,CAAC;AAEX,MAAM,WAAW,aAAa;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,IAAI,CAAC,EAAE,IAAI,CAAC;CACb;AAED,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,aAAa,GAAG,QAAQ,CAAC,aAAa,CAAC,CAM/E"}

package/dist/common-options.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.withCommonDefaults = exports.defaults = void 0;
+const set_info_1 = require("./set-info");
+exports.defaults = {
+    access: 'ownable',
+    upgradeable: false,
+    info: set_info_1.defaults,
+};
+function withCommonDefaults(opts) {
+    var _a, _b, _c;
+    return {
+        access: (_a = opts.access) !== null && _a !== void 0 ? _a : 'ownable',
+        upgradeable: (_b = opts.upgradeable) !== null && _b !== void 0 ? _b : false,
+        info: (_c = opts.info) !== null && _c !== void 0 ? _c : {},
+    };
+}
+exports.withCommonDefaults = withCommonDefaults;
+//# sourceMappingURL=common-options.js.map

package/dist/common-options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"common-options.js","sourceRoot":"","sources":["../src/common-options.ts"],"names":[],"mappings":";;;AAEA,yCAAsD;AAGzC,QAAA,QAAQ,GAA4B;IAC/C,MAAM,EAAE,SAAS;IACjB,WAAW,EAAE,KAAK;IAClB,IAAI,EAAE,mBAAY;CACV,CAAC;AAQX,SAAgB,kBAAkB,CAAC,IAAmB;;IACpD,OAAO;QACL,MAAM,EAAE,MAAA,IAAI,CAAC,MAAM,mCAAI,SAAS;QAChC,WAAW,EAAE,MAAA,IAAI,CAAC,WAAW,mCAAI,KAAK;QACtC,IAAI,EAAE,MAAA,IAAI,CAAC,IAAI,mCAAI,EAAE;KACtB,CAAC;AACJ,CAAC;AAND,gDAMC"}

package/dist/contract.d.ts

@@ -0,0 +1,86 @@
+export interface Contract {
+    name: string;
+    license: string;
+    parents: Parent[];
+    using: Using[];
+    natspecTags: NatspecTag[];
+    imports: string[];
+    functions: ContractFunction[];
+    constructorCode: string[];
+    constructorArgs: FunctionArgument[];
+    variables: string[];
+    upgradeable: boolean;
+}
+export declare type Value = string | number | {
+    lit: string;
+} | {
+    note: string;
+    value: Value;
+};
+export interface Parent {
+    contract: ParentContract;
+    params: Value[];
+}
+export interface ParentContract {
+    name: string;
+    path: string;
+}
+export interface Using {
+    library: ParentContract;
+    usingFor: string;
+}
+export interface BaseFunction {
+    name: string;
+    args: FunctionArgument[];
+    returns?: string[];
+    kind: FunctionKind;
+    mutability?: FunctionMutability;
+}
+export interface ContractFunction extends BaseFunction {
+    override: Set<string>;
+    modifiers: string[];
+    code: string[];
+    mutability: FunctionMutability;
+    final: boolean;
+}
+export declare type FunctionKind = 'internal' | 'public';
+export declare type FunctionMutability = typeof mutabilityRank[number];
+declare const mutabilityRank: readonly ["pure", "view", "nonpayable", "payable"];
+export interface FunctionArgument {
+    type: string;
+    name: string;
+}
+export interface NatspecTag {
+    key: string;
+    value: string;
+}
+export declare class ContractBuilder implements Contract {
+    readonly name: string;
+    license: string;
+    upgradeable: boolean;
+    readonly using: Using[];
+    readonly natspecTags: NatspecTag[];
+    readonly constructorArgs: FunctionArgument[];
+    readonly constructorCode: string[];
+    readonly variableSet: Set<string>;
+    private parentMap;
+    private functionMap;
+    constructor(name: string);
+    get parents(): Parent[];
+    get imports(): string[];
+    get functions(): ContractFunction[];
+    get variables(): string[];
+    addParent(contract: ParentContract, params?: Value[]): boolean;
+    addUsing(library: ParentContract, usingFor: string): void;
+    addOverride(parent: string, baseFn: BaseFunction, mutability?: FunctionMutability): void;
+    addModifier(modifier: string, baseFn: BaseFunction): void;
+    addNatspecTag(key: string, value: string): void;
+    private addFunction;
+    addConstructorArgument(arg: FunctionArgument): void;
+    addConstructorCode(code: string): void;
+    addFunctionCode(code: string, baseFn: BaseFunction, mutability?: FunctionMutability): void;
+    setFunctionBody(code: string[], baseFn: BaseFunction, mutability?: FunctionMutability): void;
+    addVariable(code: string): boolean;
+}
+export {};
+//# sourceMappingURL=contract.d.ts.map

package/dist/contract.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"contract.d.ts","sourceRoot":"","sources":["../src/contract.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,KAAK,EAAE,KAAK,EAAE,CAAC;IACf,WAAW,EAAE,UAAU,EAAE,CAAC;IAC1B,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,SAAS,EAAE,gBAAgB,EAAE,CAAC;IAC9B,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,eAAe,EAAE,gBAAgB,EAAE,CAAC;IACpC,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,WAAW,EAAE,OAAO,CAAC;CACtB;AAED,oBAAY,KAAK,GAAG,MAAM,GAAG,MAAM,GAAG;IAAE,GAAG,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,KAAK,CAAA;CAAE,CAAC;AAEvF,MAAM,WAAW,MAAM;IACrB,QAAQ,EAAE,cAAc,CAAC;IACzB,MAAM,EAAE,KAAK,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,KAAK;IACpB,OAAO,EAAE,cAAc,CAAC;IACxB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,gBAAgB,EAAE,CAAC;IACzB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,IAAI,EAAE,YAAY,CAAC;IACnB,UAAU,CAAC,EAAE,kBAAkB,CAAC;CACjC;AAED,MAAM,WAAW,gBAAiB,SAAQ,YAAY;IACpD,QAAQ,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IACtB,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,UAAU,EAAE,kBAAkB,CAAC;IAC/B,KAAK,EAAE,OAAO,CAAC;CAChB;AAED,oBAAY,YAAY,GAAG,UAAU,GAAG,QAAQ,CAAC;AACjD,oBAAY,kBAAkB,GAAG,OAAO,cAAc,CAAC,MAAM,CAAC,CAAC;AAG/D,QAAA,MAAM,cAAc,oDAAqD,CAAC;AAQ1E,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,UAAU;IACzB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;CACf;AAED,qBAAa,eAAgB,YAAW,QAAQ;IAC9C,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,OAAO,EAAE,MAAM,CAAS;IACxB,WAAW,UAAS;IAEpB,QAAQ,CAAC,KAAK,EAAE,KAAK,EAAE,CAAM;IAC7B,QAAQ,CAAC,WAAW,EAAE,UAAU,EAAE,CAAM;IAExC,QAAQ,CAAC,eAAe,EAAE,gBAAgB,EAAE,CAAM;IAClD,QAAQ,CAAC,eAAe,EAAE,MAAM,EAAE,CAAM;IACxC,QAAQ,CAAC,WAAW,EAAE,GAAG,CAAC,MAAM,CAAC,CAAa;IAE9C,OAAO,CAAC,SAAS,CAAkD;IACnE,OAAO,CAAC,WAAW,CAA4C;gBAEnD,IAAI,EAAE,MAAM;IAIxB,IAAI,OAAO,IAAI,MAAM,EAAE,CAUtB;IAED,IAAI,OAAO,IAAI,MAAM,EAAE,CAKtB;IAED,IAAI,SAAS,IAAI,gBAAgB,EAAE,CAElC;IAED,IAAI,SAAS,IAAI,MAAM,EAAE,CAExB;IAED,SAAS,CAAC,QAAQ,EAAE,cAAc,EAAE,MAAM,GAAE,KAAK,EAAO,GAAG,OAAO;IAMlE,QAAQ,CAAC,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM;IAIlD,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,UAAU,CAAC,EAAE,kBAAkB;IAQjF,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY;IAKlD,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;IAKxC,OAAO,CAAC,WAAW;IAmBnB,sBAAsB,CAAC,GAAG,EAAE,gBAAgB;IAI5C,kBAAkB,CAAC,IAAI,EAAE,MAAM;IAI/B,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,UAAU,CAAC,EAAE,kBAAkB;IAWnF,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,YAAY,EAAE,UAAU,CAAC,EAAE,kBAAkB;IAYrF,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;CAKnC"}

package/dist/contract.js

@@ -0,0 +1,125 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContractBuilder = void 0;
+const to_identifier_1 = require("./utils/to-identifier");
+// Order is important
+const mutabilityRank = ['pure', 'view', 'nonpayable', 'payable'];
+function maxMutability(a, b) {
+    return mutabilityRank[Math.max(mutabilityRank.indexOf(a), mutabilityRank.indexOf(b))];
+}
+class ContractBuilder {
+    constructor(name) {
+        this.license = 'MIT';
+        this.upgradeable = false;
+        this.using = [];
+        this.natspecTags = [];
+        this.constructorArgs = [];
+        this.constructorCode = [];
+        this.variableSet = new Set();
+        this.parentMap = new Map();
+        this.functionMap = new Map();
+        this.name = (0, to_identifier_1.toIdentifier)(name, true);
+    }
+    get parents() {
+        return [...this.parentMap.values()].sort((a, b) => {
+            if (a.contract.name === 'Initializable') {
+                return -1;
+            }
+            else if (b.contract.name === 'Initializable') {
+                return 1;
+            }
+            else {
+                return 0;
+            }
+        });
+    }
+    get imports() {
+        return [
+            ...[...this.parentMap.values()].map(p => p.contract.path),
+            ...this.using.map(u => u.library.path),
+        ];
+    }
+    get functions() {
+        return [...this.functionMap.values()];
+    }
+    get variables() {
+        return [...this.variableSet];
+    }
+    addParent(contract, params = []) {
+        const present = this.parentMap.has(contract.name);
+        this.parentMap.set(contract.name, { contract, params });
+        return !present;
+    }
+    addUsing(library, usingFor) {
+        this.using.push({ library, usingFor });
+    }
+    addOverride(parent, baseFn, mutability) {
+        const fn = this.addFunction(baseFn);
+        fn.override.add(parent);
+        if (mutability) {
+            fn.mutability = maxMutability(fn.mutability, mutability);
+        }
+    }
+    addModifier(modifier, baseFn) {
+        const fn = this.addFunction(baseFn);
+        fn.modifiers.push(modifier);
+    }
+    addNatspecTag(key, value) {
+        if (!/^(@custom:)?[a-z][a-z\-]*$/.exec(key))
+            throw new Error(`Invalid natspec key: ${key}`);
+        this.natspecTags.push({ key, value });
+    }
+    addFunction(baseFn) {
+        const signature = [baseFn.name, '(', ...baseFn.args.map(a => a.name), ')'].join('');
+        const got = this.functionMap.get(signature);
+        if (got !== undefined) {
+            return got;
+        }
+        else {
+            const fn = {
+                override: new Set(),
+                modifiers: [],
+                code: [],
+                mutability: 'nonpayable',
+                final: false,
+                ...baseFn,
+            };
+            this.functionMap.set(signature, fn);
+            return fn;
+        }
+    }
+    addConstructorArgument(arg) {
+        this.constructorArgs.push(arg);
+    }
+    addConstructorCode(code) {
+        this.constructorCode.push(code);
+    }
+    addFunctionCode(code, baseFn, mutability) {
+        const fn = this.addFunction(baseFn);
+        if (fn.final) {
+            throw new Error(`Function ${baseFn.name} is already finalized`);
+        }
+        fn.code.push(code);
+        if (mutability) {
+            fn.mutability = maxMutability(fn.mutability, mutability);
+        }
+    }
+    setFunctionBody(code, baseFn, mutability) {
+        const fn = this.addFunction(baseFn);
+        if (fn.code.length > 0) {
+            throw new Error(`Function ${baseFn.name} has additional code`);
+        }
+        fn.code.push(...code);
+        fn.final = true;
+        if (mutability) {
+            fn.mutability = mutability;
+        }
+    }
+    addVariable(code) {
+        const present = this.variableSet.has(code);
+        this.variableSet.add(code);
+        return !present;
+    }
+}
+exports.ContractBuilder = ContractBuilder;
+//# sourceMappingURL=contract.js.map

package/dist/contract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contract.js","sourceRoot":"","sources":["../src/contract.ts"],"names":[],"mappings":";;;AAAA,yDAAqD;AAoDrD,qBAAqB;AACrB,MAAM,cAAc,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,SAAS,CAAU,CAAC;AAE1E,SAAS,aAAa,CAAC,CAAqB,EAAE,CAAqB;IACjE,OAAO,cAAc,CACnB,IAAI,CAAC,GAAG,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAC9D,CAAC;AACL,CAAC;AAYD,MAAa,eAAe;IAe1B,YAAY,IAAY;QAbxB,YAAO,GAAW,KAAK,CAAC;QACxB,gBAAW,GAAG,KAAK,CAAC;QAEX,UAAK,GAAY,EAAE,CAAC;QACpB,gBAAW,GAAiB,EAAE,CAAC;QAE/B,oBAAe,GAAuB,EAAE,CAAC;QACzC,oBAAe,GAAa,EAAE,CAAC;QAC/B,gBAAW,GAAgB,IAAI,GAAG,EAAE,CAAC;QAEtC,cAAS,GAAwB,IAAI,GAAG,EAAkB,CAAC;QAC3D,gBAAW,GAAkC,IAAI,GAAG,EAAE,CAAC;QAG7D,IAAI,CAAC,IAAI,GAAG,IAAA,4BAAY,EAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACvC,CAAC;IAED,IAAI,OAAO;QACT,OAAO,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;YAChD,IAAI,CAAC,CAAC,QAAQ,CAAC,IAAI,KAAK,eAAe,EAAE;gBACvC,OAAO,CAAC,CAAC,CAAC;aACX;iBAAM,IAAI,CAAC,CAAC,QAAQ,CAAC,IAAI,KAAK,eAAe,EAAE;gBAC9C,OAAO,CAAC,CAAC;aACV;iBAAM;gBACL,OAAO,CAAC,CAAC;aACV;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,IAAI,OAAO;QACT,OAAO;YACL,GAAG,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC;YACzD,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;SACvC,CAAC;IACJ,CAAC;IAED,IAAI,SAAS;QACX,OAAO,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC;IACxC,CAAC;IAED,IAAI,SAAS;QACX,OAAO,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC;IAC/B,CAAC;IAED,SAAS,CAAC,QAAwB,EAAE,SAAkB,EAAE;QACtD,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAClD,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC;QACxD,OAAO,CAAC,OAAO,CAAC;IAClB,CAAC;IAED,QAAQ,CAAC,OAAuB,EAAE,QAAgB;QAChD,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,CAAC;IACzC,CAAC;IAED,WAAW,CAAC,MAAc,EAAE,MAAoB,EAAE,UAA+B;QAC/E,MAAM,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QACpC,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACxB,IAAI,UAAU,EAAE;YACd,EAAE,CAAC,UAAU,GAAG,aAAa,CAAC,EAAE,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;SAC1D;IACH,CAAC;IAED,WAAW,CAAC,QAAgB,EAAE,MAAoB;QAChD,MAAM,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QACpC,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC9B,CAAC;IAED,aAAa,CAAC,GAAW,EAAE,KAAa;QACtC,IAAI,CAAC,4BAA4B,CAAC,IAAI,CAAC,GAAG,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,wBAAwB,GAAG,EAAE,CAAC,CAAC;QAC5F,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC;IACxC,CAAC;IAEO,WAAW,CAAC,MAAoB;QACtC,MAAM,SAAS,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACpF,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAC5C,IAAI,GAAG,KAAK,SAAS,EAAE;YACrB,OAAO,GAAG,CAAC;SACZ;aAAM;YACL,MAAM,EAAE,GAAqB;gBAC3B,QAAQ,EAAE,IAAI,GAAG,EAAU;gBAC3B,SAAS,EAAE,EAAE;gBACb,IAAI,EAAE,EAAE;gBACR,UAAU,EAAE,YAAY;gBACxB,KAAK,EAAE,KAAK;gBACZ,GAAG,MAAM;aACV,CAAC;YACF,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;YACpC,OAAO,EAAE,CAAC;SACX;IACH,CAAC;IAED,sBAAsB,CAAC,GAAqB;QAC1C,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACjC,CAAC;IAED,kBAAkB,CAAC,IAAY;QAC7B,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC;IAED,eAAe,CAAC,IAAY,EAAE,MAAoB,EAAE,UAA+B;QACjF,MAAM,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QACpC,IAAI,EAAE,CAAC,KAAK,EAAE;YACZ,MAAM,IAAI,KAAK,CAAC,YAAY,MAAM,CAAC,IAAI,uBAAuB,CAAC,CAAC;SACjE;QACD,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnB,IAAI,UAAU,EAAE;YACd,EAAE,CAAC,UAAU,GAAG,aAAa,CAAC,EAAE,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;SAC1D;IACH,CAAC;IAED,eAAe,CAAC,IAAc,EAAE,MAAoB,EAAE,UAA+B;QACnF,MAAM,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QACpC,IAAI,EAAE,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;YACtB,MAAM,IAAI,KAAK,CAAC,YAAY,MAAM,CAAC,IAAI,sBAAsB,CAAC,CAAC;SAChE;QACD,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;QACtB,EAAE,CAAC,KAAK,GAAG,IAAI,CAAC;QAChB,IAAI,UAAU,EAAE;YACd,EAAE,CAAC,UAAU,GAAG,UAAU,CAAC;SAC5B;IACH,CAAC;IAED,WAAW,CAAC,IAAY;QACtB,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC3C,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC3B,OAAO,CAAC,OAAO,CAAC;IAClB,CAAC;CACF;AAjID,0CAiIC"}

package/dist/contract.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=contract.test.d.ts.map

package/dist/contract.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"contract.test.d.ts","sourceRoot":"","sources":["../src/contract.test.ts"],"names":[],"mappings":""}