@openzeppelin/wizard 0.1.0

package/dist/governor.js

@@ -0,0 +1,386 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.numberPattern = exports.buildGovernor = exports.printGovernor = exports.timelockOptions = exports.votesOptions = exports.defaults = void 0;
+const common_functions_1 = require("./common-functions");
+const common_options_1 = require("./common-options");
+const contract_1 = require("./contract");
+const error_1 = require("./error");
+const print_1 = require("./print");
+const set_info_1 = require("./set-info");
+const set_upgradeable_1 = require("./set-upgradeable");
+const define_functions_1 = require("./utils/define-functions");
+const duration_1 = require("./utils/duration");
+exports.defaults = {
+    name: 'MyGovernor',
+    delay: '1 block',
+    period: '1 week',
+    votes: 'erc20votes',
+    timelock: 'openzeppelin',
+    blockTime: 13.2,
+    decimals: 18,
+    proposalThreshold: '0',
+    quorumMode: 'percent',
+    quorumPercent: 4,
+    quorumAbsolute: '',
+    bravo: false,
+    settings: true,
+    access: common_options_1.defaults.access,
+    upgradeable: common_options_1.defaults.upgradeable,
+    info: common_options_1.defaults.info
+};
+exports.votesOptions = ['erc20votes', 'erc721votes', 'comp'];
+exports.timelockOptions = [false, 'openzeppelin', 'compound'];
+function printGovernor(opts = exports.defaults) {
+    return (0, print_1.printContract)(buildGovernor(opts));
+}
+exports.printGovernor = printGovernor;
+function withDefaults(opts) {
+    var _a, _b, _c, _d, _e, _f, _g, _h;
+    return {
+        ...opts,
+        ...(0, common_options_1.withCommonDefaults)(opts),
+        decimals: (_a = opts.decimals) !== null && _a !== void 0 ? _a : exports.defaults.decimals,
+        blockTime: opts.blockTime || exports.defaults.blockTime,
+        quorumPercent: (_b = opts.quorumPercent) !== null && _b !== void 0 ? _b : exports.defaults.quorumPercent,
+        quorumAbsolute: (_c = opts.quorumAbsolute) !== null && _c !== void 0 ? _c : exports.defaults.quorumAbsolute,
+        proposalThreshold: opts.proposalThreshold || exports.defaults.proposalThreshold,
+        settings: (_d = opts.settings) !== null && _d !== void 0 ? _d : exports.defaults.settings,
+        bravo: (_e = opts.bravo) !== null && _e !== void 0 ? _e : exports.defaults.bravo,
+        quorumMode: (_f = opts.quorumMode) !== null && _f !== void 0 ? _f : exports.defaults.quorumMode,
+        votes: (_g = opts.votes) !== null && _g !== void 0 ? _g : exports.defaults.votes,
+        timelock: (_h = opts.timelock) !== null && _h !== void 0 ? _h : exports.defaults.timelock
+    };
+}
+function buildGovernor(opts) {
+    const allOpts = withDefaults(opts);
+    const c = new contract_1.ContractBuilder(allOpts.name);
+    validateDecimals(allOpts.decimals);
+    addBase(c, allOpts);
+    addSettings(c, allOpts);
+    addCounting(c, allOpts);
+    addBravo(c, allOpts);
+    addVotes(c, allOpts);
+    addQuorum(c, allOpts);
+    addTimelock(c, allOpts);
+    (0, set_upgradeable_1.setUpgradeable)(c, allOpts.upgradeable, allOpts.access);
+    (0, set_info_1.setInfo)(c, allOpts.info);
+    return c;
+}
+exports.buildGovernor = buildGovernor;
+function addBase(c, { name }) {
+    c.addParent({
+        name: 'Governor',
+        path: '@openzeppelin/contracts/governance/Governor.sol',
+    }, [name]);
+    c.addOverride('IGovernor', functions.votingDelay);
+    c.addOverride('IGovernor', functions.votingPeriod);
+    c.addOverride('IGovernor', functions.quorum);
+    c.addOverride('Governor', functions.state);
+    c.addOverride('Governor', functions.propose);
+    c.addOverride('Governor', functions.proposalThreshold);
+    c.addOverride('Governor', functions._execute);
+    c.addOverride('Governor', functions._cancel);
+    c.addOverride('Governor', functions._executor);
+    c.addOverride('Governor', common_functions_1.supportsInterface);
+}
+function addSettings(c, allOpts) {
+    if (allOpts.settings) {
+        c.addParent({
+            name: 'GovernorSettings',
+            path: '@openzeppelin/contracts/governance/extensions/GovernorSettings.sol',
+        }, [
+            { value: getVotingDelay(allOpts), note: allOpts.delay },
+            { value: getVotingPeriod(allOpts), note: allOpts.period },
+            { lit: getProposalThreshold(allOpts) },
+        ]);
+        c.addOverride('GovernorSettings', functions.votingDelay, 'view');
+        c.addOverride('GovernorSettings', functions.votingPeriod, 'view');
+        c.addOverride('GovernorSettings', functions.proposalThreshold, 'view');
+    }
+    else {
+        setVotingParameters(c, allOpts);
+        setProposalThreshold(c, allOpts);
+    }
+}
+function getVotingDelay(opts) {
+    try {
+        return (0, duration_1.durationToBlocks)(opts.delay, opts.blockTime);
+    }
+    catch (e) {
+        if (e instanceof Error) {
+            throw new error_1.OptionsError({
+                delay: e.message,
+            });
+        }
+        else {
+            throw e;
+        }
+    }
+}
+function getVotingPeriod(opts) {
+    try {
+        return (0, duration_1.durationToBlocks)(opts.period, opts.blockTime);
+    }
+    catch (e) {
+        if (e instanceof Error) {
+            throw new error_1.OptionsError({
+                period: e.message,
+            });
+        }
+        else {
+            throw e;
+        }
+    }
+}
+function validateDecimals(decimals) {
+    if (!/^\d+$/.test(decimals.toString())) {
+        throw new error_1.OptionsError({
+            decimals: 'Not a valid number',
+        });
+    }
+}
+function getProposalThreshold({ proposalThreshold, decimals, votes }) {
+    if (!/^\d+$/.test(proposalThreshold)) {
+        throw new error_1.OptionsError({
+            proposalThreshold: 'Not a valid number',
+        });
+    }
+    if (/^0+$/.test(proposalThreshold) || decimals === 0 || votes === 'erc721votes') {
+        return proposalThreshold;
+    }
+    else {
+        return `${proposalThreshold}e${decimals}`;
+    }
+}
+function setVotingParameters(c, opts) {
+    const delayBlocks = getVotingDelay(opts);
+    c.setFunctionBody([`return ${delayBlocks}; // ${opts.delay}`], functions.votingDelay);
+    const periodBlocks = getVotingPeriod(opts);
+    c.setFunctionBody([`return ${periodBlocks}; // ${opts.period}`], functions.votingPeriod);
+}
+function setProposalThreshold(c, opts) {
+    const threshold = getProposalThreshold(opts);
+    const nonZeroThreshold = parseInt(threshold) !== 0;
+    if (nonZeroThreshold) {
+        c.setFunctionBody([`return ${threshold};`], functions.proposalThreshold);
+    }
+}
+function addCounting(c, { bravo }) {
+    if (!bravo) {
+        c.addParent({
+            name: 'GovernorCountingSimple',
+            path: '@openzeppelin/contracts/governance/extensions/GovernorCountingSimple.sol',
+        });
+    }
+}
+const votesModules = {
+    erc20votes: {
+        tokenType: 'IVotes',
+        parentName: 'GovernorVotes',
+    },
+    erc721votes: {
+        tokenType: 'IVotes',
+        parentName: 'GovernorVotes',
+    },
+    comp: {
+        tokenType: 'ERC20VotesComp',
+        parentName: 'GovernorVotesComp',
+    },
+};
+function addVotes(c, { votes }) {
+    const tokenArg = '_token';
+    const { tokenType, parentName } = votesModules[votes];
+    c.addConstructorArgument({
+        type: tokenType,
+        name: tokenArg,
+    });
+    c.addParent({
+        name: parentName,
+        path: `@openzeppelin/contracts/governance/extensions/${parentName}.sol`,
+    }, [{ lit: tokenArg }]);
+}
+exports.numberPattern = /^(?!$)(\d*)(?:\.(\d+))?(?:e(\d+))?$/;
+function addQuorum(c, opts) {
+    if (opts.quorumMode === 'percent') {
+        if (opts.votes !== 'erc20votes' && opts.votes !== 'erc721votes') {
+            throw new error_1.OptionsError({
+                quorumPercent: 'Percent-based quorum is only available for ERC20Votes or ERC721Votes',
+            });
+        }
+        if (opts.quorumPercent > 100) {
+            throw new error_1.OptionsError({
+                quorumPercent: 'Invalid percentage',
+            });
+        }
+        let { quorumFractionNumerator, quorumFractionDenominator } = getQuorumFractionComponents(opts.quorumPercent);
+        if (quorumFractionDenominator !== undefined) {
+            c.addOverride('GovernorVotesQuorumFraction', functions.quorumDenominator);
+            c.setFunctionBody([
+                `return ${quorumFractionDenominator};`
+            ], functions.quorumDenominator, 'pure');
+        }
+        c.addParent({
+            name: 'GovernorVotesQuorumFraction',
+            path: '@openzeppelin/contracts/governance/extensions/GovernorVotesQuorumFraction.sol',
+        }, [quorumFractionNumerator]);
+        c.addOverride('GovernorVotesQuorumFraction', functions.quorum);
+    }
+    else if (opts.quorumMode === 'absolute') {
+        if (!exports.numberPattern.test(opts.quorumAbsolute)) {
+            throw new error_1.OptionsError({
+                quorumAbsolute: 'Not a valid number',
+            });
+        }
+        let returnStatement = (opts.decimals === 0 || opts.votes === 'erc721votes') ?
+            `return ${opts.quorumAbsolute};` :
+            `return ${opts.quorumAbsolute}e${opts.decimals};`;
+        c.setFunctionBody([
+            returnStatement,
+        ], functions.quorum, 'pure');
+    }
+}
+const timelockModules = {
+    openzeppelin: {
+        timelockType: 'TimelockController',
+        parentName: 'GovernorTimelockControl',
+    },
+    compound: {
+        timelockType: 'ICompoundTimelock',
+        parentName: 'GovernorTimelockCompound',
+    },
+};
+function getQuorumFractionComponents(quorumPercent) {
+    let quorumFractionNumerator = quorumPercent;
+    let quorumFractionDenominator = undefined;
+    const quorumPercentSegments = quorumPercent.toString().split(".");
+    if (quorumPercentSegments.length > 2) {
+        throw new error_1.OptionsError({
+            quorumPercent: 'Invalid percentage',
+        });
+    }
+    else if (quorumPercentSegments.length == 2 && quorumPercentSegments[0] !== undefined && quorumPercentSegments[1] !== undefined) {
+        quorumFractionNumerator = parseInt(quorumPercentSegments[0].concat(quorumPercentSegments[1]));
+        const decimals = quorumPercentSegments[1].length;
+        quorumFractionDenominator = '100';
+        while (quorumFractionDenominator.length < decimals + 3) {
+            quorumFractionDenominator += '0';
+        }
+    }
+    return { quorumFractionNumerator, quorumFractionDenominator };
+}
+function addTimelock(c, { timelock }) {
+    if (timelock === false) {
+        return;
+    }
+    const timelockArg = '_timelock';
+    const { timelockType, parentName } = timelockModules[timelock];
+    c.addConstructorArgument({
+        type: timelockType,
+        name: timelockArg,
+    });
+    c.addParent({
+        name: parentName,
+        path: `@openzeppelin/contracts/governance/extensions/${parentName}.sol`,
+    }, [{ lit: timelockArg }]);
+    c.addOverride('IGovernor', functions.propose);
+    c.addOverride(parentName, functions._execute);
+    c.addOverride(parentName, functions._cancel);
+    c.addOverride(parentName, functions._executor);
+    c.addOverride(parentName, functions.state);
+    c.addOverride(parentName, common_functions_1.supportsInterface);
+}
+function addBravo(c, { bravo, timelock }) {
+    if (bravo) {
+        if (timelock === false) {
+            throw new error_1.OptionsError({
+                timelock: 'GovernorBravo compatibility requires a timelock',
+            });
+        }
+        c.addParent({
+            name: 'GovernorCompatibilityBravo',
+            path: '@openzeppelin/contracts/governance/compatibility/GovernorCompatibilityBravo.sol',
+        });
+        c.addOverride('IGovernor', functions.state);
+        c.addOverride('GovernorCompatibilityBravo', functions.propose);
+        c.addOverride('IERC165', common_functions_1.supportsInterface);
+    }
+}
+const functions = (0, define_functions_1.defineFunctions)({
+    votingDelay: {
+        args: [],
+        returns: ['uint256'],
+        kind: 'public',
+        mutability: 'pure',
+    },
+    votingPeriod: {
+        args: [],
+        returns: ['uint256'],
+        kind: 'public',
+        mutability: 'pure',
+    },
+    proposalThreshold: {
+        args: [],
+        returns: ['uint256'],
+        kind: 'public',
+        mutability: 'pure',
+    },
+    quorum: {
+        args: [
+            { name: 'blockNumber', type: 'uint256' },
+        ],
+        returns: ['uint256'],
+        kind: 'public',
+        mutability: 'view',
+    },
+    quorumDenominator: {
+        args: [],
+        returns: ['uint256'],
+        kind: 'public',
+        mutability: 'view',
+    },
+    propose: {
+        args: [
+            { name: 'targets', type: 'address[] memory' },
+            { name: 'values', type: 'uint256[] memory' },
+            { name: 'calldatas', type: 'bytes[] memory' },
+            { name: 'description', type: 'string memory' },
+        ],
+        returns: ['uint256'],
+        kind: 'public',
+    },
+    _execute: {
+        args: [
+            { name: 'proposalId', type: 'uint256' },
+            { name: 'targets', type: 'address[] memory' },
+            { name: 'values', type: 'uint256[] memory' },
+            { name: 'calldatas', type: 'bytes[] memory' },
+            { name: 'descriptionHash', type: 'bytes32' },
+        ],
+        kind: 'internal',
+    },
+    _cancel: {
+        args: [
+            { name: 'targets', type: 'address[] memory' },
+            { name: 'values', type: 'uint256[] memory' },
+            { name: 'calldatas', type: 'bytes[] memory' },
+            { name: 'descriptionHash', type: 'bytes32' },
+        ],
+        returns: ['uint256'],
+        kind: 'internal',
+    },
+    state: {
+        args: [
+            { name: 'proposalId', type: 'uint256' },
+        ],
+        returns: ['ProposalState'],
+        kind: 'public',
+        mutability: 'view',
+    },
+    _executor: {
+        args: [],
+        returns: ['address'],
+        kind: 'internal',
+        mutability: 'view',
+    },
+});
+//# sourceMappingURL=governor.js.map

package/dist/governor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"governor.js","sourceRoot":"","sources":["../src/governor.ts"],"names":[],"mappings":";;;AAAA,yDAAuD;AACvD,qDAAiG;AACjG,yCAAuD;AACvD,mCAAuC;AACvC,mCAAwC;AACxC,yCAAqC;AACrC,uDAAmD;AACnD,+DAA2D;AAC3D,+CAAoD;AAEvC,QAAA,QAAQ,GAA8B;IACjD,IAAI,EAAE,YAAY;IAClB,KAAK,EAAE,SAAS;IAChB,MAAM,EAAE,QAAQ;IAEhB,KAAK,EAAE,YAAY;IACnB,QAAQ,EAAE,cAAc;IACxB,SAAS,EAAE,IAAI;IACf,QAAQ,EAAE,EAAE;IACZ,iBAAiB,EAAE,GAAG;IACtB,UAAU,EAAE,SAAS;IACrB,aAAa,EAAE,CAAC;IAChB,cAAc,EAAE,EAAE;IAClB,KAAK,EAAE,KAAK;IACZ,QAAQ,EAAE,IAAI;IAEd,MAAM,EAAE,yBAAc,CAAC,MAAM;IAC7B,WAAW,EAAE,yBAAc,CAAC,WAAW;IACvC,IAAI,EAAE,yBAAc,CAAC,IAAI;CACjB,CAAC;AAEE,QAAA,YAAY,GAAG,CAAC,YAAY,EAAE,aAAa,EAAE,MAAM,CAAU,CAAC;AAG9D,QAAA,eAAe,GAAG,CAAC,KAAK,EAAE,cAAc,EAAE,UAAU,CAAU,CAAC;AAG5E,SAAgB,aAAa,CAAC,OAAwB,gBAAQ;IAC5D,OAAO,IAAA,qBAAa,EAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC;AAC5C,CAAC;AAFD,sCAEC;AAkBD,SAAS,YAAY,CAAC,IAAqB;;IACzC,OAAO;QACL,GAAG,IAAI;QACP,GAAG,IAAA,mCAAkB,EAAC,IAAI,CAAC;QAC3B,QAAQ,EAAE,MAAA,IAAI,CAAC,QAAQ,mCAAI,gBAAQ,CAAC,QAAQ;QAC5C,SAAS,EAAE,IAAI,CAAC,SAAS,IAAI,gBAAQ,CAAC,SAAS;QAC/C,aAAa,EAAE,MAAA,IAAI,CAAC,aAAa,mCAAI,gBAAQ,CAAC,aAAa;QAC3D,cAAc,EAAE,MAAA,IAAI,CAAC,cAAc,mCAAI,gBAAQ,CAAC,cAAc;QAC9D,iBAAiB,EAAE,IAAI,CAAC,iBAAiB,IAAI,gBAAQ,CAAC,iBAAiB;QACvE,QAAQ,EAAE,MAAA,IAAI,CAAC,QAAQ,mCAAI,gBAAQ,CAAC,QAAQ;QAC5C,KAAK,EAAE,MAAA,IAAI,CAAC,KAAK,mCAAI,gBAAQ,CAAC,KAAK;QACnC,UAAU,EAAE,MAAA,IAAI,CAAC,UAAU,mCAAI,gBAAQ,CAAC,UAAU;QAClD,KAAK,EAAE,MAAA,IAAI,CAAC,KAAK,mCAAI,gBAAQ,CAAC,KAAK;QACnC,QAAQ,EAAE,MAAA,IAAI,CAAC,QAAQ,mCAAI,gBAAQ,CAAC,QAAQ;KAC7C,CAAC;AACJ,CAAC;AAED,SAAgB,aAAa,CAAC,IAAqB;IACjD,MAAM,OAAO,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;IAEnC,MAAM,CAAC,GAAG,IAAI,0BAAe,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5C,gBAAgB,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAEnC,OAAO,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IACpB,WAAW,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IACxB,WAAW,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IACxB,QAAQ,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IACrB,QAAQ,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IACrB,SAAS,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IACtB,WAAW,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IAExB,IAAA,gCAAc,EAAC,CAAC,EAAE,OAAO,CAAC,WAAW,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;IAEvD,IAAA,kBAAO,EAAC,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzB,OAAO,CAAC,CAAC;AACX,CAAC;AApBD,sCAoBC;AAED,SAAS,OAAO,CAAC,CAAkB,EAAE,EAAE,IAAI,EAAmB;IAC5D,CAAC,CAAC,SAAS,CACT;QACE,IAAI,EAAE,UAAU;QAChB,IAAI,EAAE,iDAAiD;KACxD,EACD,CAAC,IAAI,CAAC,CACP,CAAC;IACF,CAAC,CAAC,WAAW,CAAC,WAAW,EAAE,SAAS,CAAC,WAAW,CAAC,CAAC;IAClD,CAAC,CAAC,WAAW,CAAC,WAAW,EAAE,SAAS,CAAC,YAAY,CAAC,CAAC;IACnD,CAAC,CAAC,WAAW,CAAC,WAAW,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC;IAC7C,CAAC,CAAC,WAAW,CAAC,UAAU,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC;IAC3C,CAAC,CAAC,WAAW,CAAC,UAAU,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;IAC7C,CAAC,CAAC,WAAW,CAAC,UAAU,EAAE,SAAS,CAAC,iBAAiB,CAAC,CAAC;IACvD,CAAC,CAAC,WAAW,CAAC,UAAU,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC;IAC9C,CAAC,CAAC,WAAW,CAAC,UAAU,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;IAC7C,CAAC,CAAC,WAAW,CAAC,UAAU,EAAE,SAAS,CAAC,SAAS,CAAC,CAAC;IAC/C,CAAC,CAAC,WAAW,CAAC,UAAU,EAAE,oCAAiB,CAAC,CAAC;AAC/C,CAAC;AAED,SAAS,WAAW,CAAC,CAAkB,EAAE,OAAkC;IACzE,IAAI,OAAO,CAAC,QAAQ,EAAE;QACpB,CAAC,CAAC,SAAS,CACT;YACE,IAAI,EAAE,kBAAkB;YACxB,IAAI,EAAE,oEAAoE;SAC3E,EACD;YACE,EAAE,KAAK,EAAE,cAAc,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,KAAK,EAAE;YACvD,EAAE,KAAK,EAAE,eAAe,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,MAAM,EAAE;YACzD,EAAE,GAAG,EAAE,oBAAoB,CAAC,OAAO,CAAC,EAAE;SACvC,CACF,CAAC;QACF,CAAC,CAAC,WAAW,CAAC,kBAAkB,EAAE,SAAS,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;QACjE,CAAC,CAAC,WAAW,CAAC,kBAAkB,EAAE,SAAS,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;QAClE,CAAC,CAAC,WAAW,CAAC,kBAAkB,EAAE,SAAS,CAAC,iBAAiB,EAAE,MAAM,CAAC,CAAC;KACxE;SAAM;QACL,mBAAmB,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;QAChC,oBAAoB,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;KAClC;AACH,CAAC;AAED,SAAS,cAAc,CAAC,IAA+B;IACrD,IAAI;QACF,OAAO,IAAA,2BAAgB,EAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;KACrD;IAAC,OAAO,CAAC,EAAE;QACV,IAAI,CAAC,YAAY,KAAK,EAAE;YACtB,MAAM,IAAI,oBAAY,CAAC;gBACrB,KAAK,EAAE,CAAC,CAAC,OAAO;aACjB,CAAC,CAAC;SACJ;aAAM;YACL,MAAM,CAAC,CAAC;SACT;KACF;AACH,CAAC;AAED,SAAS,eAAe,CAAC,IAA+B;IACtD,IAAI;QACF,OAAO,IAAA,2BAAgB,EAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;KACtD;IAAC,OAAO,CAAC,EAAE;QACV,IAAI,CAAC,YAAY,KAAK,EAAE;YACtB,MAAM,IAAI,oBAAY,CAAC;gBACrB,MAAM,EAAE,CAAC,CAAC,OAAO;aAClB,CAAC,CAAC;SACJ;aAAM;YACL,MAAM,CAAC,CAAC;SACT;KACF;AACH,CAAC;AAED,SAAS,gBAAgB,CAAC,QAAgB;IACxC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,EAAE;QACtC,MAAM,IAAI,oBAAY,CAAC;YACrB,QAAQ,EAAE,oBAAoB;SAC/B,CAAC,CAAC;KACJ;AACH,CAAC;AAED,SAAS,oBAAoB,CAAC,EAAE,iBAAiB,EAAE,QAAQ,EAAE,KAAK,EAA6B;IAC7F,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,CAAC,EAAE;QACpC,MAAM,IAAI,oBAAY,CAAC;YACrB,iBAAiB,EAAE,oBAAoB;SACxC,CAAC,CAAC;KACJ;IAED,IAAI,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,IAAI,QAAQ,KAAK,CAAC,IAAI,KAAK,KAAK,aAAa,EAAE;QAC/E,OAAO,iBAAiB,CAAC;KAC1B;SAAM;QACL,OAAO,GAAG,iBAAiB,IAAI,QAAQ,EAAE,CAAC;KAC3C;AACH,CAAC;AAED,SAAS,mBAAmB,CAAC,CAAkB,EAAE,IAA+B;IAC9E,MAAM,WAAW,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC;IACzC,CAAC,CAAC,eAAe,CAAC,CAAC,UAAU,WAAW,QAAQ,IAAI,CAAC,KAAK,EAAE,CAAC,EAAE,SAAS,CAAC,WAAW,CAAC,CAAC;IAEtF,MAAM,YAAY,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;IAC3C,CAAC,CAAC,eAAe,CAAC,CAAC,UAAU,YAAY,QAAQ,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,SAAS,CAAC,YAAY,CAAC,CAAC;AAC3F,CAAC;AAED,SAAS,oBAAoB,CAAC,CAAkB,EAAE,IAA+B;IAC/E,MAAM,SAAS,GAAG,oBAAoB,CAAC,IAAI,CAAC,CAAC;IAC7C,MAAM,gBAAgB,GAAG,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAEnD,IAAI,gBAAgB,EAAE;QACpB,CAAC,CAAC,eAAe,CAAC,CAAC,UAAU,SAAS,GAAG,CAAC,EAAE,SAAS,CAAC,iBAAiB,CAAC,CAAC;KAC1E;AACH,CAAC;AAED,SAAS,WAAW,CAAC,CAAkB,EAAE,EAAE,KAAK,EAAmB;IACjE,IAAI,CAAC,KAAK,EAAE;QACV,CAAC,CAAC,SAAS,CAAC;YACV,IAAI,EAAE,wBAAwB;YAC9B,IAAI,EAAE,0EAA0E;SACjF,CAAC,CAAC;KACJ;AACH,CAAC;AAED,MAAM,YAAY,GAAG;IACnB,UAAU,EAAE;QACV,SAAS,EAAE,QAAQ;QACnB,UAAU,EAAE,eAAe;KAC5B;IACD,WAAW,EAAE;QACX,SAAS,EAAE,QAAQ;QACnB,UAAU,EAAE,eAAe;KAC5B;IACD,IAAI,EAAE;QACJ,SAAS,EAAE,gBAAgB;QAC3B,UAAU,EAAE,mBAAmB;KAChC;CACO,CAAC;AAEX,SAAS,QAAQ,CAAC,CAAkB,EAAE,EAAE,KAAK,EAA6B;IACxE,MAAM,QAAQ,GAAG,QAAQ,CAAC;IAC1B,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;IAEtD,CAAC,CAAC,sBAAsB,CAAC;QACvB,IAAI,EAAE,SAAS;QACf,IAAI,EAAE,QAAQ;KACf,CAAC,CAAC;IAEH,CAAC,CAAC,SAAS,CAAC;QACV,IAAI,EAAE,UAAU;QAChB,IAAI,EAAE,iDAAiD,UAAU,MAAM;KACxE,EAAE,CAAC,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC;AAC1B,CAAC;AAEY,QAAA,aAAa,GAAG,qCAAqC,CAAC;AAEnE,SAAS,SAAS,CAAC,CAAkB,EAAE,IAA+B;IACpE,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,EAAE;QACjC,IAAI,IAAI,CAAC,KAAK,KAAK,YAAY,IAAI,IAAI,CAAC,KAAK,KAAK,aAAa,EAAE;YAC/D,MAAM,IAAI,oBAAY,CAAC;gBACrB,aAAa,EAAE,sEAAsE;aACtF,CAAC,CAAC;SACJ;QAED,IAAI,IAAI,CAAC,aAAa,GAAG,GAAG,EAAE;YAC5B,MAAM,IAAI,oBAAY,CAAC;gBACrB,aAAa,EAAE,oBAAoB;aACpC,CAAC,CAAC;SACJ;QAED,IAAI,EAAE,uBAAuB,EAAE,yBAAyB,EAAE,GAAG,2BAA2B,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAE7G,IAAI,yBAAyB,KAAK,SAAS,EAAE;YAC3C,CAAC,CAAC,WAAW,CAAC,6BAA6B,EAAE,SAAS,CAAC,iBAAiB,CAAC,CAAC;YAC1E,CAAC,CAAC,eAAe,CAAC;gBAChB,UAAU,yBAAyB,GAAG;aACvC,EAAE,SAAS,CAAC,iBAAiB,EAAE,MAAM,CAAC,CAAC;SACzC;QAED,CAAC,CAAC,SAAS,CAAC;YACV,IAAI,EAAE,6BAA6B;YACnC,IAAI,EAAE,+EAA+E;SACtF,EAAE,CAAC,uBAAuB,CAAC,CAAC,CAAC;QAC9B,CAAC,CAAC,WAAW,CAAC,6BAA6B,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC;KAChE;SAEI,IAAI,IAAI,CAAC,UAAU,KAAK,UAAU,EAAE;QACvC,IAAI,CAAC,qBAAa,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE;YAC5C,MAAM,IAAI,oBAAY,CAAC;gBACrB,cAAc,EAAE,oBAAoB;aACrC,CAAC,CAAC;SACJ;QAED,IAAI,eAAe,GAAG,CAAC,IAAI,CAAC,QAAQ,KAAK,CAAC,IAAI,IAAI,CAAC,KAAK,KAAK,aAAa,CAAC,CAAC,CAAC;YAC3E,UAAU,IAAI,CAAC,cAAc,GAAG,CAAC,CAAC;YAClC,UAAU,IAAI,CAAC,cAAc,IAAI,IAAI,CAAC,QAAQ,GAAG,CAAC;QAEpD,CAAC,CAAC,eAAe,CAAC;YAChB,eAAe;SAChB,EAAE,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KAC9B;AACH,CAAC;AAED,MAAM,eAAe,GAAG;IACtB,YAAY,EAAE;QACZ,YAAY,EAAE,oBAAoB;QAClC,UAAU,EAAE,yBAAyB;KACtC;IACD,QAAQ,EAAE;QACR,YAAY,EAAE,mBAAmB;QACjC,UAAU,EAAE,0BAA0B;KACvC;CACO,CAAC;AAEX,SAAS,2BAA2B,CAAC,aAAqB;IACxD,IAAI,uBAAuB,GAAG,aAAa,CAAC;IAC5C,IAAI,yBAAyB,GAAG,SAAS,CAAC;IAE1C,MAAM,qBAAqB,GAAG,aAAa,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAClE,IAAI,qBAAqB,CAAC,MAAM,GAAG,CAAC,EAAE;QACpC,MAAM,IAAI,oBAAY,CAAC;YACrB,aAAa,EAAE,oBAAoB;SACpC,CAAC,CAAC;KACJ;SAAM,IAAI,qBAAqB,CAAC,MAAM,IAAI,CAAC,IAAI,qBAAqB,CAAC,CAAC,CAAC,KAAK,SAAS,IAAI,qBAAqB,CAAC,CAAC,CAAC,KAAK,SAAS,EAAE;QAChI,uBAAuB,GAAG,QAAQ,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC9F,MAAM,QAAQ,GAAG,qBAAqB,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;QACjD,yBAAyB,GAAG,KAAK,CAAC;QAClC,OAAO,yBAAyB,CAAC,MAAM,GAAG,QAAQ,GAAG,CAAC,EAAE;YACtD,yBAAyB,IAAI,GAAG,CAAC;SAClC;KACF;IACD,OAAO,EAAE,uBAAuB,EAAE,yBAAyB,EAAE,CAAC;AAChE,CAAC;AAED,SAAS,WAAW,CAAC,CAAkB,EAAE,EAAE,QAAQ,EAA6B;IAC9E,IAAI,QAAQ,KAAK,KAAK,EAAE;QACtB,OAAO;KACR;IAED,MAAM,WAAW,GAAG,WAAW,CAAC;IAChC,MAAM,EAAE,YAAY,EAAE,UAAU,EAAE,GAAG,eAAe,CAAC,QAAQ,CAAC,CAAC;IAE/D,CAAC,CAAC,sBAAsB,CAAC;QACvB,IAAI,EAAE,YAAY;QAClB,IAAI,EAAE,WAAW;KAClB,CAAC,CAAC;IAEH,CAAC,CAAC,SAAS,CAAC;QACV,IAAI,EAAE,UAAU;QAChB,IAAI,EAAE,iDAAiD,UAAU,MAAM;KACxE,EAAE,CAAC,EAAE,GAAG,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC;IAC3B,CAAC,CAAC,WAAW,CAAC,WAAW,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;IAC9C,CAAC,CAAC,WAAW,CAAC,UAAU,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC;IAC9C,CAAC,CAAC,WAAW,CAAC,UAAU,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;IAC7C,CAAC,CAAC,WAAW,CAAC,UAAU,EAAE,SAAS,CAAC,SAAS,CAAC,CAAC;IAC/C,CAAC,CAAC,WAAW,CAAC,UAAU,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC;IAC3C,CAAC,CAAC,WAAW,CAAC,UAAU,EAAE,oCAAiB,CAAC,CAAC;AAC/C,CAAC;AAED,SAAS,QAAQ,CAAC,CAAkB,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAmB;IACxE,IAAI,KAAK,EAAE;QACT,IAAI,QAAQ,KAAK,KAAK,EAAE;YACtB,MAAM,IAAI,oBAAY,CAAC;gBACrB,QAAQ,EAAE,iDAAiD;aAC5D,CAAC,CAAC;SACJ;QAED,CAAC,CAAC,SAAS,CAAC;YACV,IAAI,EAAE,4BAA4B;YAClC,IAAI,EAAE,iFAAiF;SACxF,CAAC,CAAC;QACH,CAAC,CAAC,WAAW,CAAC,WAAW,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC;QAC5C,CAAC,CAAC,WAAW,CAAC,4BAA4B,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;QAC/D,CAAC,CAAC,WAAW,CAAC,SAAS,EAAE,oCAAiB,CAAC,CAAC;KAC7C;AACH,CAAC;AAED,MAAM,SAAS,GAAG,IAAA,kCAAe,EAAC;IAChC,WAAW,EAAE;QACX,IAAI,EAAE,EAAE;QACR,OAAO,EAAE,CAAC,SAAS,CAAC;QACpB,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE,MAAM;KACnB;IACD,YAAY,EAAE;QACZ,IAAI,EAAE,EAAE;QACR,OAAO,EAAE,CAAC,SAAS,CAAC;QACpB,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE,MAAM;KACnB;IACD,iBAAiB,EAAE;QACjB,IAAI,EAAE,EAAE;QACR,OAAO,EAAE,CAAC,SAAS,CAAC;QACpB,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE,MAAM;KACnB;IACD,MAAM,EAAE;QACN,IAAI,EAAE;YACJ,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,SAAS,EAAE;SACzC;QACD,OAAO,EAAE,CAAC,SAAS,CAAC;QACpB,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE,MAAM;KACnB;IACD,iBAAiB,EAAE;QACjB,IAAI,EAAE,EAAE;QACR,OAAO,EAAE,CAAC,SAAS,CAAC;QACpB,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE,MAAM;KACnB;IACD,OAAO,EAAE;QACP,IAAI,EAAE;YACJ,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,kBAAkB,EAAE;YAC7C,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,kBAAkB,EAAE;YAC5C,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,gBAAgB,EAAE;YAC7C,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,eAAe,EAAE;SAC/C;QACD,OAAO,EAAE,CAAC,SAAS,CAAC;QACpB,IAAI,EAAE,QAAQ;KACf;IACD,QAAQ,EAAE;QACR,IAAI,EAAE;YACJ,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,SAAS,EAAE;YACvC,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,kBAAkB,EAAE;YAC7C,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,kBAAkB,EAAE;YAC5C,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,gBAAgB,EAAE;YAC7C,EAAE,IAAI,EAAE,iBAAiB,EAAE,IAAI,EAAE,SAAS,EAAE;SAC7C;QACD,IAAI,EAAE,UAAU;KACjB;IACD,OAAO,EAAE;QACP,IAAI,EAAE;YACJ,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,kBAAkB,EAAE;YAC7C,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,kBAAkB,EAAE;YAC5C,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,gBAAgB,EAAE;YAC7C,EAAE,IAAI,EAAE,iBAAiB,EAAE,IAAI,EAAE,SAAS,EAAE;SAC7C;QACD,OAAO,EAAE,CAAC,SAAS,CAAC;QACpB,IAAI,EAAE,UAAU;KACjB;IACD,KAAK,EAAE;QACL,IAAI,EAAE;YACJ,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,SAAS,EAAE;SACxC;QACD,OAAO,EAAE,CAAC,eAAe,CAAC;QAC1B,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE,MAAM;KACnB;IACD,SAAS,EAAE;QACT,IAAI,EAAE,EAAE;QACR,OAAO,EAAE,CAAC,SAAS,CAAC;QACpB,IAAI,EAAE,UAAU;QAChB,UAAU,EAAE,MAAM;KACnB;CACF,CAAC,CAAC"}

package/dist/governor.test.d.ts

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

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

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

package/dist/governor.test.js

@@ -0,0 +1,104 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const ava_1 = __importDefault(require("ava"));
+const _1 = require(".");
+const governor_1 = require("./governor");
+const print_1 = require("./print");
+function testGovernor(title, opts) {
+    (0, ava_1.default)(title, t => {
+        const c = (0, governor_1.buildGovernor)({
+            name: 'MyGovernor',
+            delay: '1 week',
+            period: '1 week',
+            settings: false,
+            ...opts,
+        });
+        t.snapshot((0, print_1.printContract)(c));
+    });
+}
+/**
+ * Tests external API for equivalence with internal API
+ */
+function testAPIEquivalence(title, opts) {
+    (0, ava_1.default)(title, t => {
+        t.is(_1.governor.print(opts), (0, print_1.printContract)((0, governor_1.buildGovernor)({
+            name: 'MyGovernor',
+            delay: '1 block',
+            period: '1 week',
+            ...opts,
+        })));
+    });
+}
+testGovernor('governor with proposal threshold', {
+    proposalThreshold: '1',
+});
+testGovernor('governor with custom block time', {
+    blockTime: 6,
+});
+testGovernor('governor with custom decimals', {
+    decimals: 6,
+    proposalThreshold: '1',
+    quorumMode: 'absolute',
+    quorumAbsolute: '1',
+});
+testGovernor('governor with 0 decimals', {
+    decimals: 0,
+    proposalThreshold: '1',
+    quorumMode: 'absolute',
+    quorumAbsolute: '1',
+});
+testGovernor('governor with settings', {
+    settings: true,
+    proposalThreshold: '1',
+});
+testGovernor('governor with bravo', {
+    bravo: true,
+});
+testGovernor('governor with erc20votes', {
+    votes: 'erc20votes',
+});
+testGovernor('governor with erc721votes', {
+    votes: 'erc721votes',
+});
+testGovernor('governor with erc721votes omit decimals', {
+    votes: 'erc721votes',
+    decimals: 6,
+    proposalThreshold: '1',
+    quorumMode: 'absolute',
+    quorumAbsolute: '5',
+});
+testGovernor('governor with erc721votes settings omit decimals', {
+    votes: 'erc721votes',
+    decimals: 6,
+    proposalThreshold: '10',
+    settings: true,
+});
+testGovernor('governor with comp', {
+    votes: 'comp',
+    quorumMode: 'absolute',
+    quorumAbsolute: '1',
+});
+testGovernor('governor with percent quorum', {
+    quorumMode: 'percent',
+    quorumPercent: 6,
+});
+testGovernor('governor with fractional percent quorum', {
+    quorumMode: 'percent',
+    quorumPercent: 0.5,
+});
+testGovernor('governor with openzeppelin timelock', {
+    timelock: 'openzeppelin',
+});
+testGovernor('governor with compound timelock', {
+    timelock: 'compound',
+});
+testAPIEquivalence('API default');
+testAPIEquivalence('API basic', { name: 'CustomGovernor', delay: '2 weeks', period: '2 week' });
+testAPIEquivalence('API basic upgradeable', { name: 'CustomGovernor', delay: '2 weeks', period: '2 week', upgradeable: 'uups' });
+(0, ava_1.default)('API assert defaults', async (t) => {
+    t.is(_1.governor.print(_1.governor.defaults), _1.governor.print());
+});
+//# sourceMappingURL=governor.test.js.map

package/dist/governor.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"governor.test.js","sourceRoot":"","sources":["../src/governor.test.ts"],"names":[],"mappings":";;;;;AAAA,8CAAuB;AACvB,wBAA6B;AAE7B,yCAA4D;AAC5D,mCAAwC;AAExC,SAAS,YAAY,CAAC,KAAa,EAAE,IAA8B;IACjE,IAAA,aAAI,EAAC,KAAK,EAAE,CAAC,CAAC,EAAE;QACd,MAAM,CAAC,GAAG,IAAA,wBAAa,EAAC;YACtB,IAAI,EAAE,YAAY;YAClB,KAAK,EAAE,QAAQ;YACf,MAAM,EAAE,QAAQ;YAChB,QAAQ,EAAE,KAAK;YACf,GAAG,IAAI;SACR,CAAC,CAAC;QACH,CAAC,CAAC,QAAQ,CAAC,IAAA,qBAAa,EAAC,CAAC,CAAC,CAAC,CAAC;IAC/B,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;GAEG;AACF,SAAS,kBAAkB,CAAC,KAAa,EAAE,IAAsB;IAChE,IAAA,aAAI,EAAC,KAAK,EAAE,CAAC,CAAC,EAAE;QACd,CAAC,CAAC,EAAE,CAAC,WAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,IAAA,qBAAa,EAAC,IAAA,wBAAa,EAAC;YACrD,IAAI,EAAE,YAAY;YAClB,KAAK,EAAE,SAAS;YAChB,MAAM,EAAE,QAAQ;YAChB,GAAG,IAAI;SACR,CAAC,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC;AAED,YAAY,CAAC,kCAAkC,EAAE;IAC/C,iBAAiB,EAAE,GAAG;CACvB,CAAC,CAAC;AAEH,YAAY,CAAC,iCAAiC,EAAE;IAC9C,SAAS,EAAE,CAAC;CACb,CAAC,CAAC;AAEH,YAAY,CAAC,+BAA+B,EAAE;IAC5C,QAAQ,EAAE,CAAC;IACX,iBAAiB,EAAE,GAAG;IACtB,UAAU,EAAE,UAAU;IACtB,cAAc,EAAE,GAAG;CACpB,CAAC,CAAC;AAEH,YAAY,CAAC,0BAA0B,EAAE;IACvC,QAAQ,EAAE,CAAC;IACX,iBAAiB,EAAE,GAAG;IACtB,UAAU,EAAE,UAAU;IACtB,cAAc,EAAE,GAAG;CACpB,CAAC,CAAC;AAEH,YAAY,CAAC,wBAAwB,EAAE;IACrC,QAAQ,EAAE,IAAI;IACd,iBAAiB,EAAE,GAAG;CACvB,CAAC,CAAC;AAEH,YAAY,CAAC,qBAAqB,EAAE;IAClC,KAAK,EAAE,IAAI;CACZ,CAAC,CAAC;AAEH,YAAY,CAAC,0BAA0B,EAAE;IACvC,KAAK,EAAE,YAAY;CACpB,CAAC,CAAC;AAEH,YAAY,CAAC,2BAA2B,EAAE;IACxC,KAAK,EAAE,aAAa;CACrB,CAAC,CAAC;AAEH,YAAY,CAAC,yCAAyC,EAAE;IACtD,KAAK,EAAE,aAAa;IACpB,QAAQ,EAAE,CAAC;IACX,iBAAiB,EAAE,GAAG;IACtB,UAAU,EAAE,UAAU;IACtB,cAAc,EAAE,GAAG;CACpB,CAAC,CAAC;AAEH,YAAY,CAAC,kDAAkD,EAAE;IAC/D,KAAK,EAAE,aAAa;IACpB,QAAQ,EAAE,CAAC;IACX,iBAAiB,EAAE,IAAI;IACvB,QAAQ,EAAE,IAAI;CACf,CAAC,CAAC;AAEH,YAAY,CAAC,oBAAoB,EAAE;IACjC,KAAK,EAAE,MAAM;IACb,UAAU,EAAE,UAAU;IACtB,cAAc,EAAE,GAAG;CACpB,CAAC,CAAC;AAEH,YAAY,CAAC,8BAA8B,EAAE;IAC3C,UAAU,EAAE,SAAS;IACrB,aAAa,EAAE,CAAC;CACjB,CAAC,CAAC;AAEH,YAAY,CAAC,yCAAyC,EAAE;IACtD,UAAU,EAAE,SAAS;IACrB,aAAa,EAAE,GAAG;CACnB,CAAC,CAAC;AAEH,YAAY,CAAC,qCAAqC,EAAE;IAClD,QAAQ,EAAE,cAAc;CACzB,CAAC,CAAC;AAEH,YAAY,CAAC,iCAAiC,EAAE;IAC9C,QAAQ,EAAE,UAAU;CACrB,CAAC,CAAC;AAEH,kBAAkB,CAAC,aAAa,CAAC,CAAC;AAElC,kBAAkB,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,gBAAgB,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC;AAEhG,kBAAkB,CAAC,uBAAuB,EAAE,EAAE,IAAI,EAAE,gBAAgB,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC,CAAC;AAEjI,IAAA,aAAI,EAAC,qBAAqB,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IACpC,CAAC,CAAC,EAAE,CAAC,WAAQ,CAAC,KAAK,CAAC,WAAQ,CAAC,QAAQ,CAAC,EAAE,WAAQ,CAAC,KAAK,EAAE,CAAC,CAAC;AAC5D,CAAC,CAAC,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,17 @@
+export type { GenericOptions, KindedOptions } from './build-generic';
+export { buildGeneric } from './build-generic';
+export type { Contract } from './contract';
+export { ContractBuilder } from './contract';
+export { printContract } from './print';
+export { printContractVersioned } from './print-versioned';
+export type { Access } from './set-access-control';
+export type { Upgradeable } from './set-upgradeable';
+export type { Info } from './set-info';
+export { premintPattern } from './erc20';
+export { defaults as infoDefaults } from './set-info';
+export type { OptionsErrorMessages } from './error';
+export { OptionsError } from './error';
+export type { Kind } from './kind';
+export { sanitizeKind } from './kind';
+export { erc20, erc721, erc1155, governor } from './api';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACrE,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAE/C,YAAY,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAE7C,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AACxC,OAAO,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAC;AAE3D,YAAY,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AACnD,YAAY,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AACrD,YAAY,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAEvC,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AACzC,OAAO,EAAE,QAAQ,IAAI,YAAY,EAAE,MAAM,YAAY,CAAC;AAEtD,YAAY,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAEvC,YAAY,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AACnC,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAEtC,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC"}

package/dist/index.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.governor = exports.erc1155 = exports.erc721 = exports.erc20 = exports.sanitizeKind = exports.OptionsError = exports.infoDefaults = exports.premintPattern = exports.printContractVersioned = exports.printContract = exports.ContractBuilder = exports.buildGeneric = void 0;
+var build_generic_1 = require("./build-generic");
+Object.defineProperty(exports, "buildGeneric", { enumerable: true, get: function () { return build_generic_1.buildGeneric; } });
+var contract_1 = require("./contract");
+Object.defineProperty(exports, "ContractBuilder", { enumerable: true, get: function () { return contract_1.ContractBuilder; } });
+var print_1 = require("./print");
+Object.defineProperty(exports, "printContract", { enumerable: true, get: function () { return print_1.printContract; } });
+var print_versioned_1 = require("./print-versioned");
+Object.defineProperty(exports, "printContractVersioned", { enumerable: true, get: function () { return print_versioned_1.printContractVersioned; } });
+var erc20_1 = require("./erc20");
+Object.defineProperty(exports, "premintPattern", { enumerable: true, get: function () { return erc20_1.premintPattern; } });
+var set_info_1 = require("./set-info");
+Object.defineProperty(exports, "infoDefaults", { enumerable: true, get: function () { return set_info_1.defaults; } });
+var error_1 = require("./error");
+Object.defineProperty(exports, "OptionsError", { enumerable: true, get: function () { return error_1.OptionsError; } });
+var kind_1 = require("./kind");
+Object.defineProperty(exports, "sanitizeKind", { enumerable: true, get: function () { return kind_1.sanitizeKind; } });
+var api_1 = require("./api");
+Object.defineProperty(exports, "erc20", { enumerable: true, get: function () { return api_1.erc20; } });
+Object.defineProperty(exports, "erc721", { enumerable: true, get: function () { return api_1.erc721; } });
+Object.defineProperty(exports, "erc1155", { enumerable: true, get: function () { return api_1.erc1155; } });
+Object.defineProperty(exports, "governor", { enumerable: true, get: function () { return api_1.governor; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AACA,iDAA+C;AAAtC,6GAAA,YAAY,OAAA;AAGrB,uCAA6C;AAApC,2GAAA,eAAe,OAAA;AAExB,iCAAwC;AAA/B,sGAAA,aAAa,OAAA;AACtB,qDAA2D;AAAlD,yHAAA,sBAAsB,OAAA;AAM/B,iCAAyC;AAAhC,uGAAA,cAAc,OAAA;AACvB,uCAAsD;AAA7C,wGAAA,QAAQ,OAAgB;AAGjC,iCAAuC;AAA9B,qGAAA,YAAY,OAAA;AAGrB,+BAAsC;AAA7B,oGAAA,YAAY,OAAA;AAErB,6BAAyD;AAAhD,4FAAA,KAAK,OAAA;AAAE,6FAAA,MAAM,OAAA;AAAE,8FAAA,OAAO,OAAA;AAAE,+FAAA,QAAQ,OAAA"}

package/dist/kind.d.ts

@@ -0,0 +1,4 @@
+import type { GenericOptions } from './build-generic';
+export declare type Kind = GenericOptions['kind'];
+export declare function sanitizeKind(kind: unknown): Kind;
+//# sourceMappingURL=kind.d.ts.map

package/dist/kind.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"kind.d.ts","sourceRoot":"","sources":["../src/kind.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAEtD,oBAAY,IAAI,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;AAE1C,wBAAgB,YAAY,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI,CAQhD"}

package/dist/kind.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sanitizeKind = void 0;
+function sanitizeKind(kind) {
+    if (typeof kind === 'string') {
+        const sanitized = kind.replace(/^(ERC|.)/i, c => c.toUpperCase());
+        if (isKind(sanitized)) {
+            return sanitized;
+        }
+    }
+    return 'ERC20';
+}
+exports.sanitizeKind = sanitizeKind;
+function isKind(value) {
+    switch (value) {
+        case 'ERC20':
+        case 'ERC1155':
+        case 'ERC721':
+        case 'Governor':
+            return true;
+        default: {
+            // Static assert that we've checked all kinds.
+            const _ = value;
+            return false;
+        }
+    }
+}
+//# sourceMappingURL=kind.js.map

package/dist/kind.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"kind.js","sourceRoot":"","sources":["../src/kind.ts"],"names":[],"mappings":";;;AAIA,SAAgB,YAAY,CAAC,IAAa;IACxC,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;QAC5B,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;QAClE,IAAI,MAAM,CAAC,SAAS,CAAC,EAAE;YACrB,OAAO,SAAS,CAAC;SAClB;KACF;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AARD,oCAQC;AAED,SAAS,MAAM,CAAI,KAAe;IAChC,QAAQ,KAAK,EAAE;QACb,KAAK,OAAO,CAAC;QACb,KAAK,SAAS,CAAC;QACf,KAAK,QAAQ,CAAC;QACd,KAAK,UAAU;YACb,OAAO,IAAI,CAAC;QAEd,OAAO,CAAC,CAAC;YACP,8CAA8C;YAC9C,MAAM,CAAC,GAAM,KAAK,CAAC;YACnB,OAAO,KAAK,CAAC;SACd;KACF;AACH,CAAC"}

package/dist/options.d.ts

@@ -0,0 +1,11 @@
+import type { Contract } from './contract';
+export interface Options {
+    transformImport?: (path: string) => string;
+}
+export interface Helpers extends Required<Options> {
+    upgradeable: boolean;
+    transformName: (name: string) => string;
+    transformVariable: (code: string) => string;
+}
+export declare function withHelpers(contract: Contract, opts?: Options): Helpers;
+//# sourceMappingURL=options.d.ts.map

package/dist/options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../src/options.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAoB3C,MAAM,WAAW,OAAO;IACtB,eAAe,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;CAC5C;AAED,MAAM,WAAW,OAAQ,SAAQ,QAAQ,CAAC,OAAO,CAAC;IAChD,WAAW,EAAE,OAAO,CAAC;IACrB,aAAa,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;IACxC,iBAAiB,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;CAC7C;AAED,wBAAgB,WAAW,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,GAAE,OAAY,GAAG,OAAO,CAY3E"}