@openzeppelin/wizard-stellar 0.1.0

package/README.md

@@ -0,0 +1,57 @@
+# OpenZeppelin Contracts Wizard for Stellar
+
+Interactively build a contract out of components from OpenZeppelin Stellar Soroban 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/stellar
+
+### Installation
+
+`npm install @openzeppelin/wizard-stellar`
+
+### Contract types
+
+The following contract types are supported:
+- `fungible`
+
+Each contract type has functions/constants as defined below.
+
+### Functions
+
+#### `print`
+```js
+function print(opts?: FungibleOptions): 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<FungibleOptions>
+```
+The default options that are used for [`print`](#print).
+
+### Examples
+
+Import the contract type(s) (for example, `fungible`) that you want to use from the `@openzeppelin/wizard-stellar` package:
+
+```js
+import { fungible } from '@openzeppelin/wizard-stellar';
+```
+
+To generate the source code for an Fungible contract with all of the default settings:
+```js
+const contract = fungible.print();
+```
+
+To generate the source code for an Fungible contract with some custom settings:
+```js
+const contract = fungible.print({
+  pausable: true,
+});
+```
+or
+```js
+const contract = fungible.print({
+  ...fungible.defaults,
+  pausable: true,
+});
+```

package/dist/add-pausable.d.ts

@@ -0,0 +1,4 @@
+import type { ContractBuilder } from './contract';
+import type { Access } from './set-access-control';
+export declare function addPausable(c: ContractBuilder, access: Access): 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":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAClD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAInD,wBAAgB,WAAW,CAAC,CAAC,EAAE,eAAe,EAAE,MAAM,EAAE,MAAM,QAiB7D"}

package/dist/add-pausable.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addPausable = addPausable;
+const common_options_1 = require("./common-options");
+const set_access_control_1 = require("./set-access-control");
+const define_functions_1 = require("./utils/define-functions");
+function addPausable(c, access) {
+    c.addUseClause('openzeppelin_pausable', 'self', { alias: 'pausable' });
+    c.addUseClause('openzeppelin_pausable', 'Pausable');
+    const pausableTrait = {
+        name: 'Pausable',
+        for: c.name,
+        tags: ['contractimpl'],
+        section: 'Utils',
+    };
+    c.addFunction(pausableTrait, functions.paused);
+    c.addFunction(pausableTrait, functions.pause);
+    c.addFunction(pausableTrait, functions.unpause);
+    (0, set_access_control_1.requireAccessControl)(c, pausableTrait, functions.pause, access, 'caller');
+    (0, set_access_control_1.requireAccessControl)(c, pausableTrait, functions.unpause, access, 'caller');
+}
+const functions = (0, define_functions_1.defineFunctions)({
+    paused: {
+        args: [(0, common_options_1.getSelfArg)()],
+        returns: 'bool',
+        code: ['pausable::paused(e)'],
+    },
+    pause: {
+        args: [(0, common_options_1.getSelfArg)(), { name: 'caller', type: 'Address' }],
+        code: ['pausable::pause(e, &caller)'],
+    },
+    unpause: {
+        args: [(0, common_options_1.getSelfArg)(), { name: 'caller', type: 'Address' }],
+        code: ['pausable::unpause(e, &caller)'],
+    },
+});
+//# 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":";;AAMA,kCAiBC;AAvBD,qDAA8C;AAG9C,6DAA4D;AAC5D,+DAA2D;AAE3D,SAAgB,WAAW,CAAC,CAAkB,EAAE,MAAc;IAC5D,CAAC,CAAC,YAAY,CAAC,uBAAuB,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,CAAC;IACvE,CAAC,CAAC,YAAY,CAAC,uBAAuB,EAAE,UAAU,CAAC,CAAC;IAEpD,MAAM,aAAa,GAAG;QACpB,IAAI,EAAE,UAAU;QAChB,GAAG,EAAE,CAAC,CAAC,IAAI;QACX,IAAI,EAAE,CAAC,cAAc,CAAC;QACtB,OAAO,EAAE,OAAO;KACjB,CAAC;IAEF,CAAC,CAAC,WAAW,CAAC,aAAa,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC;IAC/C,CAAC,CAAC,WAAW,CAAC,aAAa,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC;IAC9C,CAAC,CAAC,WAAW,CAAC,aAAa,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;IAEhD,IAAA,yCAAoB,EAAC,CAAC,EAAE,aAAa,EAAE,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IAC1E,IAAA,yCAAoB,EAAC,CAAC,EAAE,aAAa,EAAE,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;AAC9E,CAAC;AAED,MAAM,SAAS,GAAG,IAAA,kCAAe,EAAC;IAChC,MAAM,EAAE;QACN,IAAI,EAAE,CAAC,IAAA,2BAAU,GAAE,CAAC;QACpB,OAAO,EAAE,MAAM;QACf,IAAI,EAAE,CAAC,qBAAqB,CAAC;KAC9B;IACD,KAAK,EAAE;QACL,IAAI,EAAE,CAAC,IAAA,2BAAU,GAAE,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;QACzD,IAAI,EAAE,CAAC,6BAA6B,CAAC;KACtC;IACD,OAAO,EAAE;QACP,IAAI,EAAE,CAAC,IAAA,2BAAU,GAAE,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;QACzD,IAAI,EAAE,CAAC,+BAA+B,CAAC;KACxC;CACF,CAAC,CAAC"}

package/dist/api.d.ts

@@ -0,0 +1,22 @@
+import type { CommonContractOptions } from './common-options';
+import type { FungibleOptions } from './fungible';
+export interface WizardContractAPI<Options extends CommonContractOptions> {
+    /**
+     * 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 interface AccessControlAPI<Options extends CommonContractOptions> {
+    /**
+     * Whether any of the provided options require access control to be enabled. If this returns `true`, then calling `print` with the
+     * same options would cause the `access` option to default to `'ownable'` if it was `undefined` or `false`.
+     */
+    isAccessControlRequired: (opts: Partial<Options>) => boolean;
+}
+export type Fungible = WizardContractAPI<FungibleOptions>;
+export declare const fungible: Fungible;
+//# 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,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AAC9D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAGlD,MAAM,WAAW,iBAAiB,CAAC,OAAO,SAAS,qBAAqB;IACtE;;OAEG;IACH,KAAK,EAAE,CAAC,IAAI,CAAC,EAAE,OAAO,KAAK,MAAM,CAAC;IAElC;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;CAC7B;AAED,MAAM,WAAW,gBAAgB,CAAC,OAAO,SAAS,qBAAqB;IACrE;;;OAGG;IACH,uBAAuB,EAAE,CAAC,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK,OAAO,CAAC;CAC9D;AAED,MAAM,MAAM,QAAQ,GAAG,iBAAiB,CAAC,eAAe,CAAC,CAAC;AAE1D,eAAO,MAAM,QAAQ,EAAE,QAGtB,CAAC"}

package/dist/api.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fungible = void 0;
+const fungible_1 = require("./fungible");
+exports.fungible = {
+    print: fungible_1.printFungible,
+    defaults: fungible_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":";;;AAEA,yCAAyE;AAwB5D,QAAA,QAAQ,GAAa;IAChC,KAAK,EAAE,wBAAa;IACpB,QAAQ,EAAE,mBAAgB;CAC3B,CAAC"}

package/dist/build-generic.d.ts

@@ -0,0 +1,9 @@
+import type { FungibleOptions } from './fungible';
+export interface KindedOptions {
+    Fungible: {
+        kind: 'Fungible';
+    } & FungibleOptions;
+}
+export 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,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAGlD,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE;QAAE,IAAI,EAAE,UAAU,CAAA;KAAE,GAAG,eAAe,CAAC;CAClD;AAED,MAAM,MAAM,cAAc,GAAG,aAAa,CAAC,MAAM,aAAa,CAAC,CAAC;AAEhE,wBAAgB,YAAY,CAAC,IAAI,EAAE,cAAc,iCAShD"}

package/dist/build-generic.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildGeneric = buildGeneric;
+const fungible_1 = require("./fungible");
+function buildGeneric(opts) {
+    switch (opts.kind) {
+        case 'Fungible':
+            return (0, fungible_1.buildFungible)(opts);
+        default: {
+            const _ = opts.kind; // TODO: When there are additional kinds above, change this assignment to just `opts` instead of `opts.kind`
+            throw new Error('Unknown ERC');
+        }
+    }
+}
+//# 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":";;AASA,oCASC;AAjBD,yCAA2C;AAQ3C,SAAgB,YAAY,CAAC,IAAoB;IAC/C,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,KAAK,UAAU;YACb,OAAO,IAAA,wBAAa,EAAC,IAAI,CAAC,CAAC;QAC7B,OAAO,CAAC,CAAC,CAAC;YACR,MAAM,CAAC,GAAU,IAAI,CAAC,IAAI,CAAC,CAAC,4GAA4G;YACxI,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,CAAC;QACjC,CAAC;IACH,CAAC;AACH,CAAC"}

package/dist/common-options.d.ts

@@ -0,0 +1,15 @@
+import type { Argument } from './contract';
+import type { Access } from './set-access-control';
+import type { Info } from './set-info';
+export declare const defaults: Required<CommonOptions>;
+export declare const contractDefaults: Required<CommonContractOptions>;
+export interface CommonOptions {
+    info?: Info;
+}
+export interface CommonContractOptions extends CommonOptions {
+    access?: Access;
+}
+export declare function withCommonDefaults(opts: CommonOptions): Required<CommonOptions>;
+export declare function withCommonContractDefaults(opts: CommonContractOptions): Required<CommonContractOptions>;
+export declare function getSelfArg(): Argument;
+//# 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,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAGvC,eAAO,MAAM,QAAQ,EAAE,QAAQ,CAAC,aAAa,CAEnC,CAAC;AAEX,eAAO,MAAM,gBAAgB,EAAE,QAAQ,CAAC,qBAAqB,CAGnD,CAAC;AAEX,MAAM,WAAW,aAAa;IAC5B,IAAI,CAAC,EAAE,IAAI,CAAC;CACb;AAED,MAAM,WAAW,qBAAsB,SAAQ,aAAa;IAC1D,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,aAAa,GAAG,QAAQ,CAAC,aAAa,CAAC,CAI/E;AAED,wBAAgB,0BAA0B,CAAC,IAAI,EAAE,qBAAqB,GAAG,QAAQ,CAAC,qBAAqB,CAAC,CAKvG;AAED,wBAAgB,UAAU,IAAI,QAAQ,CAErC"}

package/dist/common-options.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.contractDefaults = exports.defaults = void 0;
+exports.withCommonDefaults = withCommonDefaults;
+exports.withCommonContractDefaults = withCommonContractDefaults;
+exports.getSelfArg = getSelfArg;
+const set_info_1 = require("./set-info");
+exports.defaults = {
+    info: set_info_1.defaults,
+};
+exports.contractDefaults = {
+    ...exports.defaults,
+    access: false,
+};
+function withCommonDefaults(opts) {
+    var _a;
+    return {
+        info: (_a = opts.info) !== null && _a !== void 0 ? _a : exports.defaults.info,
+    };
+}
+function withCommonContractDefaults(opts) {
+    var _a;
+    return {
+        ...withCommonDefaults(opts),
+        access: (_a = opts.access) !== null && _a !== void 0 ? _a : exports.contractDefaults.access,
+    };
+}
+function getSelfArg() {
+    return { name: 'e', type: '&Env' };
+}
+//# 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":";;;AAsBA,gDAIC;AAED,gEAKC;AAED,gCAEC;AAlCD,yCAAsD;AAEzC,QAAA,QAAQ,GAA4B;IAC/C,IAAI,EAAE,mBAAY;CACV,CAAC;AAEE,QAAA,gBAAgB,GAAoC;IAC/D,GAAG,gBAAQ;IACX,MAAM,EAAE,KAAK;CACL,CAAC;AAUX,SAAgB,kBAAkB,CAAC,IAAmB;;IACpD,OAAO;QACL,IAAI,EAAE,MAAA,IAAI,CAAC,IAAI,mCAAI,gBAAQ,CAAC,IAAI;KACjC,CAAC;AACJ,CAAC;AAED,SAAgB,0BAA0B,CAAC,IAA2B;;IACpE,OAAO;QACL,GAAG,kBAAkB,CAAC,IAAI,CAAC;QAC3B,MAAM,EAAE,MAAA,IAAI,CAAC,MAAM,mCAAI,wBAAgB,CAAC,MAAM;KAC/C,CAAC;AACJ,CAAC;AAED,SAAgB,UAAU;IACxB,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;AACrC,CAAC"}

package/dist/contract.d.ts

@@ -0,0 +1,91 @@
+export interface Contract {
+    license: string;
+    name: string;
+    useClauses: UseClause[];
+    constructorCode: string[];
+    constructorArgs: Argument[];
+    implementedTraits: ImplementedTrait[];
+    variables: Variable[];
+    errors: Error[];
+    ownable: boolean;
+}
+export interface Error {
+    name: string;
+    num: number;
+}
+export type Value = string | number | bigint | {
+    lit: string;
+} | {
+    note: string;
+    value: Value;
+};
+export interface UseClause {
+    containerPath: string;
+    name: string;
+    groupable?: boolean;
+    alias?: string;
+}
+export interface BaseImplementedTrait {
+    name: string;
+    for: string;
+    tags: string[];
+    section?: string;
+    /**
+     * Priority for which trait to print first.
+     * Lower numbers are higher priority, undefined is lowest priority.
+     */
+    priority?: number;
+}
+export interface ImplementedTrait extends BaseImplementedTrait {
+    functions: ContractFunction[];
+    section?: string;
+}
+export interface BaseFunction {
+    name: string;
+    args: Argument[];
+    code: string[];
+    returns?: string;
+}
+export interface ContractFunction extends BaseFunction {
+    codeBefore?: string[];
+    tag?: string;
+}
+export interface Variable {
+    name: string;
+    type: string;
+    value: string;
+}
+export interface Argument {
+    name: string;
+    type?: string;
+}
+export declare class ContractBuilder implements Contract {
+    readonly name: string;
+    license: string;
+    ownable: boolean;
+    readonly constructorArgs: Argument[];
+    readonly constructorCode: string[];
+    private implementedTraitsMap;
+    private variablesMap;
+    private useClausesMap;
+    private errorsMap;
+    constructor(name: string);
+    get implementedTraits(): ImplementedTrait[];
+    get variables(): Variable[];
+    get useClauses(): UseClause[];
+    get errors(): Error[];
+    addError(name: string, num: number): boolean;
+    addUseClause(containerPath: string, name: string, options?: {
+        groupable?: boolean;
+        alias?: string;
+    }): void;
+    addVariable(variable: Variable): boolean;
+    addImplementedTrait(baseTrait: BaseImplementedTrait): ImplementedTrait;
+    addFunction(baseTrait: BaseImplementedTrait, fn: BaseFunction): ContractFunction;
+    private getFunctionSignature;
+    addFunctionCodeBefore(baseTrait: BaseImplementedTrait, fn: BaseFunction, codeBefore: string[]): void;
+    addFunctionTag(baseTrait: BaseImplementedTrait, fn: BaseFunction, tag: string): void;
+    addConstructorArgument(arg: Argument): void;
+    addConstructorCode(code: string): void;
+}
+//# 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,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,SAAS,EAAE,CAAC;IACxB,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,eAAe,EAAE,QAAQ,EAAE,CAAC;IAC5B,iBAAiB,EAAE,gBAAgB,EAAE,CAAC;IACtC,SAAS,EAAE,QAAQ,EAAE,CAAC;IACtB,MAAM,EAAE,KAAK,EAAE,CAAC;IAChB,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,KAAK;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,MAAM,KAAK,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG;IAAE,GAAG,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,KAAK,CAAA;CAAE,CAAC;AAEhG,MAAM,WAAW,SAAS;IACxB,aAAa,EAAE,MAAM,CAAC;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,gBAAiB,SAAQ,oBAAoB;IAC5D,SAAS,EAAE,gBAAgB,EAAE,CAAC;IAC9B,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,QAAQ,EAAE,CAAC;IACjB,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,gBAAiB,SAAQ,YAAY;IACpD,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,qBAAa,eAAgB,YAAW,QAAQ;IAC9C,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,OAAO,SAAS;IAChB,OAAO,UAAS;IAEhB,QAAQ,CAAC,eAAe,EAAE,QAAQ,EAAE,CAAM;IAC1C,QAAQ,CAAC,eAAe,EAAE,MAAM,EAAE,CAAM;IAExC,OAAO,CAAC,oBAAoB,CAA4C;IACxE,OAAO,CAAC,YAAY,CAAoC;IACxD,OAAO,CAAC,aAAa,CAAqC;IAC1D,OAAO,CAAC,SAAS,CAAiC;gBAEtC,IAAI,EAAE,MAAM;IAIxB,IAAI,iBAAiB,IAAI,gBAAgB,EAAE,CAE1C;IAED,IAAI,SAAS,IAAI,QAAQ,EAAE,CAE1B;IAED,IAAI,UAAU,IAAI,SAAS,EAAE,CAE5B;IAED,IAAI,MAAM,IAAI,KAAK,EAAE,CAEpB;IAED,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO;IAU5C,YAAY,CAAC,aAAa,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI;IAW1G,WAAW,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO;IASxC,mBAAmB,CAAC,SAAS,EAAE,oBAAoB,GAAG,gBAAgB;IAmBtE,WAAW,CAAC,SAAS,EAAE,oBAAoB,EAAE,EAAE,EAAE,YAAY,GAAG,gBAAgB;IAsBhF,OAAO,CAAC,oBAAoB;IAI5B,qBAAqB,CAAC,SAAS,EAAE,oBAAoB,EAAE,EAAE,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,IAAI;IAMpG,cAAc,CAAC,SAAS,EAAE,oBAAoB,EAAE,EAAE,EAAE,YAAY,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI;IAMpF,sBAAsB,CAAC,GAAG,EAAE,QAAQ,GAAG,IAAI;IAS3C,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;CAGvC"}

package/dist/contract.js

@@ -0,0 +1,123 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContractBuilder = void 0;
+const convert_strings_1 = require("./utils/convert-strings");
+class ContractBuilder {
+    constructor(name) {
+        this.license = 'MIT';
+        this.ownable = false;
+        this.constructorArgs = [];
+        this.constructorCode = [];
+        this.implementedTraitsMap = new Map();
+        this.variablesMap = new Map();
+        this.useClausesMap = new Map();
+        this.errorsMap = new Map();
+        this.name = (0, convert_strings_1.toIdentifier)(name, true);
+    }
+    get implementedTraits() {
+        return [...this.implementedTraitsMap.values()];
+    }
+    get variables() {
+        return [...this.variablesMap.values()];
+    }
+    get useClauses() {
+        return [...this.useClausesMap.values()];
+    }
+    get errors() {
+        return [...this.errorsMap.values()];
+    }
+    addError(name, num) {
+        if (this.errorsMap.has(name)) {
+            return false;
+        }
+        else {
+            this.addUseClause('soroban_sdk', 'contracterror');
+            this.errorsMap.set(name, { name, num });
+            return true;
+        }
+    }
+    addUseClause(containerPath, name, options) {
+        var _a, _b;
+        // groupable defaults to true
+        const groupable = (_a = options === null || options === void 0 ? void 0 : options.groupable) !== null && _a !== void 0 ? _a : true;
+        const alias = (_b = options === null || options === void 0 ? void 0 : options.alias) !== null && _b !== void 0 ? _b : '';
+        const uniqueName = alias.length > 0 ? alias : name;
+        const present = this.useClausesMap.has(uniqueName);
+        if (!present) {
+            this.useClausesMap.set(uniqueName, { containerPath, name, groupable, alias });
+        }
+    }
+    addVariable(variable) {
+        if (this.variablesMap.has(variable.name)) {
+            return false;
+        }
+        else {
+            this.variablesMap.set(variable.name, variable);
+            return true;
+        }
+    }
+    addImplementedTrait(baseTrait) {
+        const key = baseTrait.name;
+        const existingTrait = this.implementedTraitsMap.get(key);
+        if (existingTrait !== undefined) {
+            return existingTrait;
+        }
+        else {
+            const t = {
+                name: baseTrait.name,
+                for: baseTrait.for,
+                tags: [...baseTrait.tags],
+                functions: [],
+                section: baseTrait.section,
+                priority: baseTrait.priority,
+            };
+            this.implementedTraitsMap.set(key, t);
+            return t;
+        }
+    }
+    addFunction(baseTrait, fn) {
+        const t = this.addImplementedTrait(baseTrait);
+        const signature = this.getFunctionSignature(fn);
+        // Look for the existing function with the same signature and return it if found
+        for (let i = 0; i < t.functions.length; i++) {
+            const existingFn = t.functions[i];
+            if (existingFn !== undefined && this.getFunctionSignature(existingFn) === signature) {
+                return existingFn;
+            }
+        }
+        // Otherwise, add the function
+        const contractFn = {
+            ...fn,
+            codeBefore: [],
+        };
+        t.functions.push(contractFn);
+        return contractFn;
+    }
+    getFunctionSignature(fn) {
+        return [fn.name, '(', ...fn.args.map(a => a.name), ')'].join('');
+    }
+    addFunctionCodeBefore(baseTrait, fn, codeBefore) {
+        var _a;
+        this.addImplementedTrait(baseTrait);
+        const existingFn = this.addFunction(baseTrait, fn);
+        existingFn.codeBefore = [...((_a = existingFn.codeBefore) !== null && _a !== void 0 ? _a : []), ...codeBefore];
+    }
+    addFunctionTag(baseTrait, fn, tag) {
+        this.addImplementedTrait(baseTrait);
+        const existingFn = this.addFunction(baseTrait, fn);
+        existingFn.tag = tag;
+    }
+    addConstructorArgument(arg) {
+        for (const existingArg of this.constructorArgs) {
+            if (existingArg.name == arg.name) {
+                return;
+            }
+        }
+        this.constructorArgs.push(arg);
+    }
+    addConstructorCode(code) {
+        this.constructorCode.push(code);
+    }
+}
+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,6DAAuD;AAoEvD,MAAa,eAAe;IAa1B,YAAY,IAAY;QAXxB,YAAO,GAAG,KAAK,CAAC;QAChB,YAAO,GAAG,KAAK,CAAC;QAEP,oBAAe,GAAe,EAAE,CAAC;QACjC,oBAAe,GAAa,EAAE,CAAC;QAEhC,yBAAoB,GAAkC,IAAI,GAAG,EAAE,CAAC;QAChE,iBAAY,GAA0B,IAAI,GAAG,EAAE,CAAC;QAChD,kBAAa,GAA2B,IAAI,GAAG,EAAE,CAAC;QAClD,cAAS,GAAuB,IAAI,GAAG,EAAE,CAAC;QAGhD,IAAI,CAAC,IAAI,GAAG,IAAA,8BAAY,EAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACvC,CAAC;IAED,IAAI,iBAAiB;QACnB,OAAO,CAAC,GAAG,IAAI,CAAC,oBAAoB,CAAC,MAAM,EAAE,CAAC,CAAC;IACjD,CAAC;IAED,IAAI,SAAS;QACX,OAAO,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC;IACzC,CAAC;IAED,IAAI,UAAU;QACZ,OAAO,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,CAAC,CAAC;IAC1C,CAAC;IAED,IAAI,MAAM;QACR,OAAO,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC;IACtC,CAAC;IAED,QAAQ,CAAC,IAAY,EAAE,GAAW;QAChC,IAAI,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YAC7B,OAAO,KAAK,CAAC;QACf,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,YAAY,CAAC,aAAa,EAAE,eAAe,CAAC,CAAC;YAClD,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC;YACxC,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAED,YAAY,CAAC,aAAqB,EAAE,IAAY,EAAE,OAAiD;;QACjG,6BAA6B;QAC7B,MAAM,SAAS,GAAG,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,SAAS,mCAAI,IAAI,CAAC;QAC7C,MAAM,KAAK,GAAG,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,mCAAI,EAAE,CAAC;QACnC,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;QACnD,MAAM,OAAO,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QACnD,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,UAAU,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC;QAChF,CAAC;IACH,CAAC;IAED,WAAW,CAAC,QAAkB;QAC5B,IAAI,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YACzC,OAAO,KAAK,CAAC;QACf,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;YAC/C,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAED,mBAAmB,CAAC,SAA+B;QACjD,MAAM,GAAG,GAAG,SAAS,CAAC,IAAI,CAAC;QAC3B,MAAM,aAAa,GAAG,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACzD,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;YAChC,OAAO,aAAa,CAAC;QACvB,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,GAAqB;gBAC1B,IAAI,EAAE,SAAS,CAAC,IAAI;gBACpB,GAAG,EAAE,SAAS,CAAC,GAAG;gBAClB,IAAI,EAAE,CAAC,GAAG,SAAS,CAAC,IAAI,CAAC;gBACzB,SAAS,EAAE,EAAE;gBACb,OAAO,EAAE,SAAS,CAAC,OAAO;gBAC1B,QAAQ,EAAE,SAAS,CAAC,QAAQ;aAC7B,CAAC;YACF,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;YACtC,OAAO,CAAC,CAAC;QACX,CAAC;IACH,CAAC;IAED,WAAW,CAAC,SAA+B,EAAE,EAAgB;QAC3D,MAAM,CAAC,GAAG,IAAI,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC;QAE9C,MAAM,SAAS,GAAG,IAAI,CAAC,oBAAoB,CAAC,EAAE,CAAC,CAAC;QAEhD,gFAAgF;QAChF,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAC5C,MAAM,UAAU,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YAClC,IAAI,UAAU,KAAK,SAAS,IAAI,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC,KAAK,SAAS,EAAE,CAAC;gBACpF,OAAO,UAAU,CAAC;YACpB,CAAC;QACH,CAAC;QAED,8BAA8B;QAC9B,MAAM,UAAU,GAAqB;YACnC,GAAG,EAAE;YACL,UAAU,EAAE,EAAE;SACf,CAAC;QACF,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC7B,OAAO,UAAU,CAAC;IACpB,CAAC;IAEO,oBAAoB,CAAC,EAAgB;QAC3C,OAAO,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACnE,CAAC;IAED,qBAAqB,CAAC,SAA+B,EAAE,EAAgB,EAAE,UAAoB;;QAC3F,IAAI,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC;QACpC,MAAM,UAAU,GAAG,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;QACnD,UAAU,CAAC,UAAU,GAAG,CAAC,GAAG,CAAC,MAAA,UAAU,CAAC,UAAU,mCAAI,EAAE,CAAC,EAAE,GAAG,UAAU,CAAC,CAAC;IAC5E,CAAC;IAED,cAAc,CAAC,SAA+B,EAAE,EAAgB,EAAE,GAAW;QAC3E,IAAI,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC;QACpC,MAAM,UAAU,GAAG,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;QACnD,UAAU,CAAC,GAAG,GAAG,GAAG,CAAC;IACvB,CAAC;IAED,sBAAsB,CAAC,GAAa;QAClC,KAAK,MAAM,WAAW,IAAI,IAAI,CAAC,eAAe,EAAE,CAAC;YAC/C,IAAI,WAAW,CAAC,IAAI,IAAI,GAAG,CAAC,IAAI,EAAE,CAAC;gBACjC,OAAO;YACT,CAAC;QACH,CAAC;QACD,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;CACF;AApID,0CAoIC"}

package/dist/error.d.ts

@@ -0,0 +1,8 @@
+export type OptionsErrorMessages = {
+    [prop in string]?: string;
+};
+export declare class OptionsError extends Error {
+    readonly messages: OptionsErrorMessages;
+    constructor(messages: OptionsErrorMessages);
+}
+//# sourceMappingURL=error.d.ts.map

package/dist/error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../src/error.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,oBAAoB,GAAG;KAAG,IAAI,IAAI,MAAM,CAAC,CAAC,EAAE,MAAM;CAAE,CAAC;AAEjE,qBAAa,YAAa,SAAQ,KAAK;IACzB,QAAQ,CAAC,QAAQ,EAAE,oBAAoB;gBAA9B,QAAQ,EAAE,oBAAoB;CAGpD"}

package/dist/error.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OptionsError = void 0;
+class OptionsError extends Error {
+    constructor(messages) {
+        super('Invalid options');
+        this.messages = messages;
+    }
+}
+exports.OptionsError = OptionsError;
+//# sourceMappingURL=error.js.map

package/dist/error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.js","sourceRoot":"","sources":["../src/error.ts"],"names":[],"mappings":";;;AAEA,MAAa,YAAa,SAAQ,KAAK;IACrC,YAAqB,QAA8B;QACjD,KAAK,CAAC,iBAAiB,CAAC,CAAC;QADN,aAAQ,GAAR,QAAQ,CAAsB;IAEnD,CAAC;CACF;AAJD,oCAIC"}

package/dist/fungible.d.ts

@@ -0,0 +1,24 @@
+import type { Contract } from './contract';
+import type { CommonContractOptions } from './common-options';
+export declare const defaults: Required<FungibleOptions>;
+export declare function printFungible(opts?: FungibleOptions): string;
+export interface FungibleOptions extends CommonContractOptions {
+    name: string;
+    symbol: string;
+    burnable?: boolean;
+    pausable?: boolean;
+    premint?: string;
+    mintable?: boolean;
+}
+export declare function buildFungible(opts: FungibleOptions): Contract;
+export declare const premintPattern: RegExp;
+/**
+ * Calculates the initial supply that would be used in an Fungible contract based on a given premint amount and number of decimals.
+ *
+ * @param premint Premint amount in token units, may be fractional
+ * @param decimals The number of decimals in the token
+ * @returns `premint` with zeros padded or removed based on `decimals`.
+ * @throws OptionsError if `premint` has more than one decimal character or is more precise than allowed by the `decimals` argument.
+ */
+export declare function getInitialSupply(premint: string, decimals: number): string;
+//# sourceMappingURL=fungible.d.ts.map

package/dist/fungible.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fungible.d.ts","sourceRoot":"","sources":["../src/fungible.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAM3C,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AAQ9D,eAAO,MAAM,QAAQ,EAAE,QAAQ,CAAC,eAAe,CASrC,CAAC;AAEX,wBAAgB,aAAa,CAAC,IAAI,GAAE,eAA0B,GAAG,MAAM,CAEtE;AAED,MAAM,WAAW,eAAgB,SAAQ,qBAAqB;IAC5D,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAaD,wBAAgB,aAAa,CAAC,IAAI,EAAE,eAAe,GAAG,QAAQ,CA2B7D;AA8DD,eAAO,MAAM,cAAc,QAAkB,CAAC;AAqB9C;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CA+B1E"}