@openzeppelin/wizard-stellar 0.2.3 → 0.3.0

package/dist/set-access-control.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.DEFAULT_ACCESS_CONTROL = exports.accessOptions = void 0;
 exports.setAccessControl = setAccessControl;
 exports.requireAccessControl = requireAccessControl;
-exports.accessOptions = [false, 'ownable'];
+exports.accessOptions = [false, 'ownable', 'roles'];
 exports.DEFAULT_ACCESS_CONTROL = 'ownable';
 /**
  * Sets access control for the contract via constructor args.
@@ -15,14 +15,36 @@ function setAccessControl(c, access) {
         case 'ownable': {
             if (!c.ownable) {
                 c.ownable = true;
-                c.addUseClause('soroban_sdk', 'symbol_short');
-                c.addUseClause('soroban_sdk', 'Symbol');
-                c.addVariable({ name: 'OWNER', type: 'Symbol', value: `symbol_short!("OWNER")` });
+                c.addUseClause('soroban_sdk', 'Address');
+                c.addUseClause('stellar_ownable', 'self', { alias: 'ownable' });
+                c.addUseClause('stellar_ownable', 'Ownable');
+                const ownableTrait = {
+                    traitName: 'Ownable',
+                    structName: c.name,
+                    tags: ['default_impl', 'contractimpl'],
+                    section: 'Utils',
+                };
+                c.addTraitImplBlock(ownableTrait);
                 c.addConstructorArgument({ name: 'owner', type: 'Address' });
-                c.addConstructorCode('e.storage().instance().set(&OWNER, &owner);');
+                c.addConstructorCode('ownable::set_owner(e, &owner);');
             }
             break;
         }
+        case 'roles': {
+            c.addUseClause('soroban_sdk', 'Address');
+            c.addUseClause('stellar_access_control', 'self', { alias: 'access_control' });
+            c.addUseClause('stellar_access_control', 'AccessControl');
+            const accessControltrait = {
+                traitName: 'AccessControl',
+                structName: c.name,
+                tags: ['default_impl', 'contractimpl'],
+                section: 'Utils',
+            };
+            c.addTraitImplBlock(accessControltrait);
+            c.addConstructorArgument({ name: 'admin', type: 'Address' });
+            c.addConstructorCode('access_control::set_admin(e, &admin);');
+            break;
+        }
         default: {
             const _ = access;
             throw new Error('Unknown value for `access`');
@@ -31,25 +53,45 @@ function setAccessControl(c, access) {
 }
 /**
  * Enables access control for the contract and restricts the given function with access control.
- *
- * If `caller` is provided, requires that the caller is the owner. Otherwise, requires that the owner is authorized.
  */
-function requireAccessControl(c, trait, fn, access, caller) {
+function requireAccessControl(c, trait, fn, access, accessProps = { useMacro: true }) {
     if (access === false) {
         access = exports.DEFAULT_ACCESS_CONTROL;
     }
     setAccessControl(c, access);
     switch (access) {
         case 'ownable': {
-            c.addUseClause('soroban_sdk', 'Address');
-            const getOwner = 'let owner: Address = e.storage().instance().get(&OWNER).expect("owner should be set");';
-            if (caller) {
-                c.addUseClause('soroban_sdk', 'panic_with_error');
-                c.addError('Unauthorized', 1); // TODO: Ensure there are no conflicts in error codes
-                c.addFunctionCodeBefore(fn, [getOwner, `if owner != ${caller} {`, `    panic_with_error!(e, ${c.name}Error::Unauthorized)`, '}'], trait);
+            c.addUseClause('stellar_ownable_macro', 'only_owner');
+            if (accessProps.useMacro) {
+                c.addFunctionTag(fn, 'only_owner', trait);
+            }
+            else {
+                c.addFunctionCodeBefore(fn, [`ownable::enforce_owner_auth(e);`], trait);
+            }
+            break;
+        }
+        case 'roles': {
+            const { useMacro, caller, role } = accessProps;
+            if (caller && role) {
+                c.addUseClause('soroban_sdk', 'Symbol');
+                c.addConstructorArgument({ name: role, type: 'Address' });
+                c.addConstructorCode(`access_control::grant_role_no_auth(e, &admin, &${role}, &Symbol::new(e, "${role}"));`);
+                if (useMacro) {
+                    c.addUseClause('stellar_access_control_macros', 'only_role');
+                    c.addFunctionTag(fn, `only_role(${caller}, "${role}")`, trait);
+                }
+                else {
+                    c.addFunctionCodeBefore(fn, [`access_control::ensure_role(e, ${caller}, &Symbol::new(e, "${role}"));`], trait);
+                }
             }
             else {
-                c.addFunctionCodeBefore(fn, [getOwner, 'owner.require_auth();'], trait);
+                if (useMacro) {
+                    c.addUseClause('stellar_access_control_macros', 'only_admin');
+                    c.addFunctionTag(fn, 'only_admin', trait);
+                }
+                else {
+                    c.addFunctionCodeBefore(fn, ['access_control::enforce_admin_auth(e);'], trait);
+                }
             }
             break;
         }

package/dist/set-access-control.js.map

@@ -1 +1 @@
-{"version":3,"file":"set-access-control.js","sourceRoot":"","sources":["../src/set-access-control.ts"],"names":[],"mappings":";;;AAUA,4CAoBC;AAOD,oDAkCC;AArEY,QAAA,aAAa,GAAG,CAAC,KAAK,EAAE,SAAS,CAAU,CAAC;AAC5C,QAAA,sBAAsB,GAAG,SAAS,CAAC;AAIhD;;GAEG;AACH,SAAgB,gBAAgB,CAAC,CAAkB,EAAE,MAAc;IACjE,QAAQ,MAAM,EAAE,CAAC;QACf,KAAK,KAAK;YACR,MAAM;QACR,KAAK,SAAS,CAAC,CAAC,CAAC;YACf,IAAI,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;gBACf,CAAC,CAAC,OAAO,GAAG,IAAI,CAAC;gBACjB,CAAC,CAAC,YAAY,CAAC,aAAa,EAAE,cAAc,CAAC,CAAC;gBAC9C,CAAC,CAAC,YAAY,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;gBACxC,CAAC,CAAC,WAAW,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,wBAAwB,EAAE,CAAC,CAAC;gBAClF,CAAC,CAAC,sBAAsB,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC;gBAC7D,CAAC,CAAC,kBAAkB,CAAC,6CAA6C,CAAC,CAAC;YACtE,CAAC;YACD,MAAM;QACR,CAAC;QACD,OAAO,CAAC,CAAC,CAAC;YACR,MAAM,CAAC,GAAU,MAAM,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;QAChD,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,SAAgB,oBAAoB,CAClC,CAAkB,EAClB,KAAqC,EACrC,EAAgB,EAChB,MAAc,EACd,MAAe;IAEf,IAAI,MAAM,KAAK,KAAK,EAAE,CAAC;QACrB,MAAM,GAAG,8BAAsB,CAAC;IAClC,CAAC;IACD,gBAAgB,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;IAE5B,QAAQ,MAAM,EAAE,CAAC;QACf,KAAK,SAAS,CAAC,CAAC,CAAC;YACf,CAAC,CAAC,YAAY,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;YACzC,MAAM,QAAQ,GAAG,wFAAwF,CAAC;YAC1G,IAAI,MAAM,EAAE,CAAC;gBACX,CAAC,CAAC,YAAY,CAAC,aAAa,EAAE,kBAAkB,CAAC,CAAC;gBAClD,CAAC,CAAC,QAAQ,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,CAAC,qDAAqD;gBACpF,CAAC,CAAC,qBAAqB,CACrB,EAAE,EACF,CAAC,QAAQ,EAAE,eAAe,MAAM,IAAI,EAAE,4BAA4B,CAAC,CAAC,IAAI,sBAAsB,EAAE,GAAG,CAAC,EACpG,KAAK,CACN,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,CAAC,CAAC,qBAAqB,CAAC,EAAE,EAAE,CAAC,QAAQ,EAAE,uBAAuB,CAAC,EAAE,KAAK,CAAC,CAAC;YAC1E,CAAC;YACD,MAAM;QACR,CAAC;QACD,OAAO,CAAC,CAAC,CAAC;YACR,MAAM,CAAC,GAAU,MAAM,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;QAChD,CAAC;IACH,CAAC;AACH,CAAC"}
+{"version":3,"file":"set-access-control.js","sourceRoot":"","sources":["../src/set-access-control.ts"],"names":[],"mappings":";;;AAeA,4CA8CC;AAKD,oDA0DC;AA1HY,QAAA,aAAa,GAAG,CAAC,KAAK,EAAE,SAAS,EAAE,OAAO,CAAU,CAAC;AACrD,QAAA,sBAAsB,GAAG,SAAS,CAAC;AAShD;;GAEG;AACH,SAAgB,gBAAgB,CAAC,CAAkB,EAAE,MAAc;IACjE,QAAQ,MAAM,EAAE,CAAC;QACf,KAAK,KAAK;YACR,MAAM;QACR,KAAK,SAAS,CAAC,CAAC,CAAC;YACf,IAAI,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;gBACf,CAAC,CAAC,OAAO,GAAG,IAAI,CAAC;gBACjB,CAAC,CAAC,YAAY,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;gBACzC,CAAC,CAAC,YAAY,CAAC,iBAAiB,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;gBAChE,CAAC,CAAC,YAAY,CAAC,iBAAiB,EAAE,SAAS,CAAC,CAAC;gBAE7C,MAAM,YAAY,GAAG;oBACnB,SAAS,EAAE,SAAS;oBACpB,UAAU,EAAE,CAAC,CAAC,IAAI;oBAClB,IAAI,EAAE,CAAC,cAAc,EAAE,cAAc,CAAC;oBACtC,OAAO,EAAE,OAAO;iBACjB,CAAC;gBACF,CAAC,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC;gBAElC,CAAC,CAAC,sBAAsB,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC;gBAC7D,CAAC,CAAC,kBAAkB,CAAC,gCAAgC,CAAC,CAAC;YACzD,CAAC;YACD,MAAM;QACR,CAAC;QACD,KAAK,OAAO,CAAC,CAAC,CAAC;YACb,CAAC,CAAC,YAAY,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;YACzC,CAAC,CAAC,YAAY,CAAC,wBAAwB,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,gBAAgB,EAAE,CAAC,CAAC;YAC9E,CAAC,CAAC,YAAY,CAAC,wBAAwB,EAAE,eAAe,CAAC,CAAC;YAE1D,MAAM,kBAAkB,GAAG;gBACzB,SAAS,EAAE,eAAe;gBAC1B,UAAU,EAAE,CAAC,CAAC,IAAI;gBAClB,IAAI,EAAE,CAAC,cAAc,EAAE,cAAc,CAAC;gBACtC,OAAO,EAAE,OAAO;aACjB,CAAC;YACF,CAAC,CAAC,iBAAiB,CAAC,kBAAkB,CAAC,CAAC;YAExC,CAAC,CAAC,sBAAsB,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC;YAC7D,CAAC,CAAC,kBAAkB,CAAC,uCAAuC,CAAC,CAAC;YAC9D,MAAM;QACR,CAAC;QACD,OAAO,CAAC,CAAC,CAAC;YACR,MAAM,CAAC,GAAU,MAAM,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;QAChD,CAAC;IACH,CAAC;AACH,CAAC;AAED;;GAEG;AACH,SAAgB,oBAAoB,CAClC,CAAkB,EAClB,KAAqC,EACrC,EAAgB,EAChB,MAAc,EACd,cAA2B,EAAE,QAAQ,EAAE,IAAI,EAAE;IAE7C,IAAI,MAAM,KAAK,KAAK,EAAE,CAAC;QACrB,MAAM,GAAG,8BAAsB,CAAC;IAClC,CAAC;IACD,gBAAgB,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;IAE5B,QAAQ,MAAM,EAAE,CAAC;QACf,KAAK,SAAS,CAAC,CAAC,CAAC;YACf,CAAC,CAAC,YAAY,CAAC,uBAAuB,EAAE,YAAY,CAAC,CAAC;YAEtD,IAAI,WAAW,CAAC,QAAQ,EAAE,CAAC;gBACzB,CAAC,CAAC,cAAc,CAAC,EAAE,EAAE,YAAY,EAAE,KAAK,CAAC,CAAC;YAC5C,CAAC;iBAAM,CAAC;gBACN,CAAC,CAAC,qBAAqB,CAAC,EAAE,EAAE,CAAC,iCAAiC,CAAC,EAAE,KAAK,CAAC,CAAC;YAC1E,CAAC;YAED,MAAM;QACR,CAAC;QACD,KAAK,OAAO,CAAC,CAAC,CAAC;YACb,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,WAAW,CAAC;YAE/C,IAAI,MAAM,IAAI,IAAI,EAAE,CAAC;gBACnB,CAAC,CAAC,YAAY,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;gBACxC,CAAC,CAAC,sBAAsB,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC;gBAC1D,CAAC,CAAC,kBAAkB,CAAC,kDAAkD,IAAI,sBAAsB,IAAI,MAAM,CAAC,CAAC;gBAE7G,IAAI,QAAQ,EAAE,CAAC;oBACb,CAAC,CAAC,YAAY,CAAC,+BAA+B,EAAE,WAAW,CAAC,CAAC;oBAC7D,CAAC,CAAC,cAAc,CAAC,EAAE,EAAE,aAAa,MAAM,MAAM,IAAI,IAAI,EAAE,KAAK,CAAC,CAAC;gBACjE,CAAC;qBAAM,CAAC;oBACN,CAAC,CAAC,qBAAqB,CACrB,EAAE,EACF,CAAC,kCAAkC,MAAM,sBAAsB,IAAI,MAAM,CAAC,EAC1E,KAAK,CACN,CAAC;gBACJ,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,IAAI,QAAQ,EAAE,CAAC;oBACb,CAAC,CAAC,YAAY,CAAC,+BAA+B,EAAE,YAAY,CAAC,CAAC;oBAC9D,CAAC,CAAC,cAAc,CAAC,EAAE,EAAE,YAAY,EAAE,KAAK,CAAC,CAAC;gBAC5C,CAAC;qBAAM,CAAC;oBACN,CAAC,CAAC,qBAAqB,CAAC,EAAE,EAAE,CAAC,wCAAwC,CAAC,EAAE,KAAK,CAAC,CAAC;gBACjF,CAAC;YACH,CAAC;YAED,MAAM;QACR,CAAC;QACD,OAAO,CAAC,CAAC,CAAC;YACR,MAAM,CAAC,GAAU,MAAM,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;QAChD,CAAC;IACH,CAAC;AACH,CAAC"}

package/dist/stablecoin.d.ts

@@ -0,0 +1,11 @@
+import type { Contract } from './contract';
+import type { FungibleOptions } from './fungible';
+export declare const defaults: Required<StablecoinOptions>;
+export declare const limitationsOptions: readonly [false, "allowlist", "blocklist"];
+export declare function printStablecoin(opts?: StablecoinOptions): string;
+export interface StablecoinOptions extends FungibleOptions {
+    limitations?: false | 'allowlist' | 'blocklist';
+}
+export declare function isAccessControlRequired(opts: Partial<StablecoinOptions>): boolean;
+export declare function buildStablecoin(opts: StablecoinOptions): Contract;
+//# sourceMappingURL=stablecoin.d.ts.map

package/dist/stablecoin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stablecoin.d.ts","sourceRoot":"","sources":["../src/stablecoin.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAmB,MAAM,YAAY,CAAC;AAI5D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAUlD,eAAO,MAAM,QAAQ,EAAE,QAAQ,CAAC,iBAAiB,CAKvC,CAAC;AAEX,eAAO,MAAM,kBAAkB,4CAA6C,CAAC;AAE7E,wBAAgB,eAAe,CAAC,IAAI,GAAE,iBAA4B,GAAG,MAAM,CAE1E;AAED,MAAM,WAAW,iBAAkB,SAAQ,eAAe;IACxD,WAAW,CAAC,EAAE,KAAK,GAAG,WAAW,GAAG,WAAW,CAAC;CACjD;AAWD,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,OAAO,CAAC,iBAAiB,CAAC,GAAG,OAAO,CAEjF;AAED,wBAAgB,eAAe,CAAC,IAAI,EAAE,iBAAiB,GAAG,QAAQ,CAUjE"}

package/dist/stablecoin.js

@@ -0,0 +1,103 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.limitationsOptions = exports.defaults = void 0;
+exports.printStablecoin = printStablecoin;
+exports.isAccessControlRequired = isAccessControlRequired;
+exports.buildStablecoin = buildStablecoin;
+const define_functions_1 = require("./utils/define-functions");
+const common_options_1 = require("./common-options");
+const print_1 = require("./print");
+const fungible_1 = require("./fungible");
+const set_access_control_1 = require("./set-access-control");
+exports.defaults = {
+    ...fungible_1.defaults,
+    name: 'MyStablecoin',
+    symbol: 'MST',
+    limitations: false,
+};
+exports.limitationsOptions = [false, 'allowlist', 'blocklist'];
+function printStablecoin(opts = exports.defaults) {
+    return (0, print_1.printContract)(buildStablecoin(opts));
+}
+function withDefaults(opts) {
+    var _a, _b, _c;
+    return {
+        ...(0, fungible_1.withDefaults)(opts),
+        name: (_a = opts.name) !== null && _a !== void 0 ? _a : exports.defaults.name,
+        symbol: (_b = opts.symbol) !== null && _b !== void 0 ? _b : exports.defaults.symbol,
+        limitations: (_c = opts.limitations) !== null && _c !== void 0 ? _c : exports.defaults.limitations,
+    };
+}
+function isAccessControlRequired(opts) {
+    return (0, fungible_1.isAccessControlRequired)(opts) || opts.limitations !== false;
+}
+function buildStablecoin(opts) {
+    const allOpts = withDefaults(opts);
+    const c = (0, fungible_1.buildFungible)(allOpts);
+    if (allOpts.limitations) {
+        addLimitations(c, allOpts.access, allOpts.limitations);
+    }
+    return c;
+}
+function addLimitations(c, access, mode) {
+    const type = mode === 'allowlist';
+    const limitationsTrait = {
+        traitName: type ? 'FungibleAllowList' : 'FungibleBlockList',
+        structName: c.name,
+        tags: ['contractimpl'],
+        section: 'Extensions',
+    };
+    if (type) {
+        c.addUseClause('stellar_fungible', 'allowlist::{AllowList, FungibleAllowList}');
+        c.overrideAssocType('FungibleToken', 'type ContractType = AllowList;');
+    }
+    else {
+        c.addUseClause('stellar_fungible', 'blocklist::{BlockList, FungibleBlockList}');
+        c.overrideAssocType('FungibleToken', 'type ContractType = BlockList;');
+    }
+    const [getterFn, addFn, removeFn] = type
+        ? [functions.allowed, functions.allow_user, functions.disallow_user]
+        : [functions.blocked, functions.block_user, functions.unblock_user];
+    c.addTraitFunction(limitationsTrait, getterFn);
+    const accessProps = {
+        useMacro: true,
+        role: 'manager',
+        caller: 'operator',
+    };
+    c.addTraitFunction(limitationsTrait, addFn);
+    (0, set_access_control_1.requireAccessControl)(c, limitationsTrait, addFn, access, accessProps);
+    c.addTraitFunction(limitationsTrait, removeFn);
+    (0, set_access_control_1.requireAccessControl)(c, limitationsTrait, removeFn, access, accessProps);
+}
+const functions = {
+    ...fungible_1.functions,
+    ...(0, define_functions_1.defineFunctions)({
+        allowed: {
+            args: [(0, common_options_1.getSelfArg)(), { name: 'account', type: 'Address' }],
+            returns: 'bool',
+            code: ['AllowList::allowed(e, &account)'],
+        },
+        allow_user: {
+            args: [(0, common_options_1.getSelfArg)(), { name: 'user', type: 'Address' }, { name: 'operator', type: 'Address' }],
+            code: ['AllowList::allow_user(e, &user)'],
+        },
+        disallow_user: {
+            args: [(0, common_options_1.getSelfArg)(), { name: 'user', type: 'Address' }, { name: 'operator', type: 'Address' }],
+            code: ['AllowList::disallow_user(e, &user)'],
+        },
+        blocked: {
+            args: [(0, common_options_1.getSelfArg)(), { name: 'account', type: 'Address' }],
+            returns: 'bool',
+            code: ['BlockList::blocked(e, &account)'],
+        },
+        block_user: {
+            args: [(0, common_options_1.getSelfArg)(), { name: 'user', type: 'Address' }, { name: 'operator', type: 'Address' }],
+            code: ['BlockList::block_user(e, &user)'],
+        },
+        unblock_user: {
+            args: [(0, common_options_1.getSelfArg)(), { name: 'user', type: 'Address' }, { name: 'operator', type: 'Address' }],
+            code: ['BlockList::unblock_user(e, &user)'],
+        },
+    }),
+};
+//# sourceMappingURL=stablecoin.js.map

package/dist/stablecoin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stablecoin.js","sourceRoot":"","sources":["../src/stablecoin.ts"],"names":[],"mappings":";;;AAuBA,0CAEC;AAeD,0DAEC;AAED,0CAUC;AArDD,+DAA2D;AAC3D,qDAA8C;AAC9C,mCAAwC;AAExC,yCAMoB;AACpB,6DAAyE;AAE5D,QAAA,QAAQ,GAAgC;IACnD,GAAG,mBAAgB;IACnB,IAAI,EAAE,cAAc;IACpB,MAAM,EAAE,KAAK;IACb,WAAW,EAAE,KAAK;CACV,CAAC;AAEE,QAAA,kBAAkB,GAAG,CAAC,KAAK,EAAE,WAAW,EAAE,WAAW,CAAU,CAAC;AAE7E,SAAgB,eAAe,CAAC,OAA0B,gBAAQ;IAChE,OAAO,IAAA,qBAAa,EAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC;AAC9C,CAAC;AAMD,SAAS,YAAY,CAAC,IAAuB;;IAC3C,OAAO;QACL,GAAG,IAAA,uBAAoB,EAAC,IAAI,CAAC;QAC7B,IAAI,EAAE,MAAA,IAAI,CAAC,IAAI,mCAAI,gBAAQ,CAAC,IAAI;QAChC,MAAM,EAAE,MAAA,IAAI,CAAC,MAAM,mCAAI,gBAAQ,CAAC,MAAM;QACtC,WAAW,EAAE,MAAA,IAAI,CAAC,WAAW,mCAAI,gBAAQ,CAAC,WAAW;KACtD,CAAC;AACJ,CAAC;AAED,SAAgB,uBAAuB,CAAC,IAAgC;IACtE,OAAO,IAAA,kCAA+B,EAAC,IAAI,CAAC,IAAI,IAAI,CAAC,WAAW,KAAK,KAAK,CAAC;AAC7E,CAAC;AAED,SAAgB,eAAe,CAAC,IAAuB;IACrD,MAAM,OAAO,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;IAEnC,MAAM,CAAC,GAAG,IAAA,wBAAa,EAAC,OAAO,CAAC,CAAC;IAEjC,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;QACxB,cAAc,CAAC,CAAC,EAAE,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;IACzD,CAAC;IAED,OAAO,CAAC,CAAC;AACX,CAAC;AAED,SAAS,cAAc,CAAC,CAAkB,EAAE,MAAc,EAAE,IAA+B;IACzF,MAAM,IAAI,GAAG,IAAI,KAAK,WAAW,CAAC;IAElC,MAAM,gBAAgB,GAAG;QACvB,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,mBAAmB;QAC3D,UAAU,EAAE,CAAC,CAAC,IAAI;QAClB,IAAI,EAAE,CAAC,cAAc,CAAC;QACtB,OAAO,EAAE,YAAY;KACtB,CAAC;IAEF,IAAI,IAAI,EAAE,CAAC;QACT,CAAC,CAAC,YAAY,CAAC,kBAAkB,EAAE,2CAA2C,CAAC,CAAC;QAChF,CAAC,CAAC,iBAAiB,CAAC,eAAe,EAAE,gCAAgC,CAAC,CAAC;IACzE,CAAC;SAAM,CAAC;QACN,CAAC,CAAC,YAAY,CAAC,kBAAkB,EAAE,2CAA2C,CAAC,CAAC;QAChF,CAAC,CAAC,iBAAiB,CAAC,eAAe,EAAE,gCAAgC,CAAC,CAAC;IACzE,CAAC;IAED,MAAM,CAAC,QAAQ,EAAE,KAAK,EAAE,QAAQ,CAAC,GAAG,IAAI;QACtC,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,EAAE,SAAS,CAAC,UAAU,EAAE,SAAS,CAAC,aAAa,CAAC;QACpE,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,EAAE,SAAS,CAAC,UAAU,EAAE,SAAS,CAAC,YAAY,CAAC,CAAC;IAEtE,CAAC,CAAC,gBAAgB,CAAC,gBAAgB,EAAE,QAAQ,CAAC,CAAC;IAE/C,MAAM,WAAW,GAAG;QAClB,QAAQ,EAAE,IAAI;QACd,IAAI,EAAE,SAAS;QACf,MAAM,EAAE,UAAU;KACnB,CAAC;IAEF,CAAC,CAAC,gBAAgB,CAAC,gBAAgB,EAAE,KAAK,CAAC,CAAC;IAC5C,IAAA,yCAAoB,EAAC,CAAC,EAAE,gBAAgB,EAAE,KAAK,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IAEtE,CAAC,CAAC,gBAAgB,CAAC,gBAAgB,EAAE,QAAQ,CAAC,CAAC;IAC/C,IAAA,yCAAoB,EAAC,CAAC,EAAE,gBAAgB,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;AAC3E,CAAC;AAED,MAAM,SAAS,GAAG;IAChB,GAAG,oBAAiB;IACpB,GAAG,IAAA,kCAAe,EAAC;QACjB,OAAO,EAAE;YACP,IAAI,EAAE,CAAC,IAAA,2BAAU,GAAE,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;YAC1D,OAAO,EAAE,MAAM;YACf,IAAI,EAAE,CAAC,iCAAiC,CAAC;SAC1C;QACD,UAAU,EAAE;YACV,IAAI,EAAE,CAAC,IAAA,2BAAU,GAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;YAC9F,IAAI,EAAE,CAAC,iCAAiC,CAAC;SAC1C;QACD,aAAa,EAAE;YACb,IAAI,EAAE,CAAC,IAAA,2BAAU,GAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;YAC9F,IAAI,EAAE,CAAC,oCAAoC,CAAC;SAC7C;QACD,OAAO,EAAE;YACP,IAAI,EAAE,CAAC,IAAA,2BAAU,GAAE,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;YAC1D,OAAO,EAAE,MAAM;YACf,IAAI,EAAE,CAAC,iCAAiC,CAAC;SAC1C;QACD,UAAU,EAAE;YACV,IAAI,EAAE,CAAC,IAAA,2BAAU,GAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;YAC9F,IAAI,EAAE,CAAC,iCAAiC,CAAC;SAC1C;QACD,YAAY,EAAE;YACZ,IAAI,EAAE,CAAC,IAAA,2BAAU,GAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;YAC9F,IAAI,EAAE,CAAC,mCAAmC,CAAC;SAC5C;KACF,CAAC;CACH,CAAC"}

package/dist/utils/define-functions.d.ts

@@ -1,5 +1,7 @@
 import type { BaseFunction } from '../contract';
-type ImplicitNameFunction = Omit<BaseFunction, 'name'>;
-export declare function defineFunctions<F extends string>(fns: Record<F, ImplicitNameFunction>): Record<F, BaseFunction>;
+type OverridableImplicitNameFunction = Omit<BaseFunction, 'name'> & {
+    name?: string;
+};
+export declare function defineFunctions<F extends string>(fns: Record<F, OverridableImplicitNameFunction>): Record<F, BaseFunction>;
 export {};
 //# sourceMappingURL=define-functions.d.ts.map

package/dist/utils/define-functions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"define-functions.d.ts","sourceRoot":"","sources":["../../src/utils/define-functions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAEhD,KAAK,oBAAoB,GAAG,IAAI,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;AAEvD,wBAAgB,eAAe,CAAC,CAAC,SAAS,MAAM,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC,EAAE,oBAAoB,CAAC,GAAG,MAAM,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC"}
+{"version":3,"file":"define-functions.d.ts","sourceRoot":"","sources":["../../src/utils/define-functions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAEhD,KAAK,+BAA+B,GAAG,IAAI,CAAC,YAAY,EAAE,MAAM,CAAC,GAAG;IAAE,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAEtF,wBAAgB,eAAe,CAAC,CAAC,SAAS,MAAM,EAC9C,GAAG,EAAE,MAAM,CAAC,CAAC,EAAE,+BAA+B,CAAC,GAC9C,MAAM,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC"}

package/dist/utils/define-functions.js

@@ -2,6 +2,12 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.defineFunctions = defineFunctions;
 function defineFunctions(fns) {
-    return Object.fromEntries(Object.entries(fns).map(([name, fn]) => [name, Object.assign({ name }, fn)]));
+    return Object.fromEntries(Object.entries(fns).map(([implicitName, fn]) => {
+        var _a;
+        return [
+            implicitName,
+            Object.assign({ name: (_a = fn.name) !== null && _a !== void 0 ? _a : implicitName }, fn),
+        ];
+    }));
 }
 //# sourceMappingURL=define-functions.js.map

package/dist/utils/define-functions.js.map

@@ -1 +1 @@
-{"version":3,"file":"define-functions.js","sourceRoot":"","sources":["../../src/utils/define-functions.ts"],"names":[],"mappings":";;AAMA,0CAEC;AAFD,SAAgB,eAAe,CAAC,GAAyC;IACvE,OAAO,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;AAC1G,CAAC"}
+{"version":3,"file":"define-functions.js","sourceRoot":"","sources":["../../src/utils/define-functions.ts"],"names":[],"mappings":";;AAQA,0CAOC;AAPD,SAAgB,eAAe,CAAC,GAAoD;IAClF,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,EAAE,EAAE;;QAAC,OAAA;YAC9C,YAAY;YACZ,MAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,MAAA,EAAE,CAAC,IAAI,mCAAI,YAAY,EAAE,EAAE,EAAE,CAAC;SACrD,CAAA;KAAA,CAAC,CACH,CAAC;AACJ,CAAC"}

package/dist/utils/version.d.ts

@@ -1,12 +1,12 @@
 /**
  * The actual latest version to use in links.
  */
-export declare const contractsVersion = "0.2.0";
-export declare const contractsVersionTag = "v0.2.0";
+export declare const contractsVersion = "0.3.0";
+export declare const contractsVersionTag = "v0.3.0";
 /**
  * Semantic version string representing of the minimum compatible version of Contracts to display in output.
  */
-export declare const compatibleContractsSemver = "^0.2.0";
+export declare const compatibleContractsSemver = "^0.3.0";
 /**
  * The Soroban version for which compilation and testing have passing tests
  */

package/dist/utils/version.js

@@ -4,12 +4,12 @@ exports.compatibleSorobanVersion = exports.compatibleContractsSemver = exports.c
 /**
  * The actual latest version to use in links.
  */
-exports.contractsVersion = '0.2.0';
+exports.contractsVersion = '0.3.0';
 exports.contractsVersionTag = `v${exports.contractsVersion}`;
 /**
  * Semantic version string representing of the minimum compatible version of Contracts to display in output.
  */
-exports.compatibleContractsSemver = '^0.2.0';
+exports.compatibleContractsSemver = '^0.3.0';
 /**
  * The Soroban version for which compilation and testing have passing tests
  */

package/dist/zip-shared.d.ts

@@ -10,7 +10,7 @@ export declare const stellarDependencies: {
     readonly pausable: readonly ["stellar-pausable", "stellar-pausable-macros"];
     readonly upgradable: readonly ["stellar-upgradeable", "stellar-upgradeable-macros"];
 };
-export declare const allStellarDependencies: ("pausable" | "fungible" | "base" | "nonFungible" | "upgradable")[];
+export declare const allStellarDependencies: ("pausable" | "base" | "fungible" | "nonFungible" | "upgradable")[];
 export declare const allDependencies: {
     readonly soroban: readonly ["soroban-sdk"];
     readonly base: readonly ["stellar-default-impl-macro"];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openzeppelin/wizard-stellar",
-  "version": "0.2.3",
+  "version": "0.3.0",
   "description": "A boilerplate generator to get started with OpenZeppelin Stellar Soroban Contracts",
   "license": "AGPL-3.0-only",
   "repository": "https://github.com/OpenZeppelin/contracts-wizard",

package/src/add-pausable.ts

@@ -7,6 +7,7 @@ import { defineFunctions } from './utils/define-functions';
 export function addPausable(c: ContractBuilder, access: Access) {
   c.addUseClause('stellar_pausable', 'self', { alias: 'pausable' });
   c.addUseClause('stellar_pausable', 'Pausable');
+  c.addUseClause('stellar_default_impl_macro', 'default_impl');
 
   const pausableTrait = {
     traitName: 'Pausable',
@@ -19,8 +20,12 @@ export function addPausable(c: ContractBuilder, access: Access) {
   c.addTraitFunction(pausableTrait, functions.pause);
   c.addTraitFunction(pausableTrait, functions.unpause);
 
-  requireAccessControl(c, pausableTrait, functions.pause, access, 'caller');
-  requireAccessControl(c, pausableTrait, functions.unpause, access, 'caller');
+  requireAccessControl(c, pausableTrait, functions.pause, access, { useMacro: true, role: 'pauser', caller: 'caller' });
+  requireAccessControl(c, pausableTrait, functions.unpause, access, {
+    useMacro: true,
+    role: 'pauser',
+    caller: 'caller',
+  });
 }
 
 const functions = defineFunctions({
@@ -31,10 +36,10 @@ const functions = defineFunctions({
   },
   pause: {
     args: [getSelfArg(), { name: 'caller', type: 'Address' }],
-    code: ['pausable::pause(e, &caller)'],
+    code: ['pausable::pause(e)'],
   },
   unpause: {
     args: [getSelfArg(), { name: 'caller', type: 'Address' }],
-    code: ['pausable::unpause(e, &caller)'],
+    code: ['pausable::unpause(e)'],
   },
 });

package/src/add-upgradeable.ts

@@ -8,7 +8,7 @@ export function addUpgradeable(c: ContractBuilder, access: Access) {
   const functions = defineFunctions({
     _require_auth: {
       args: [getSelfArg(), { name: 'operator', type: '&Address' }],
-      code: ['operator.require_auth();'],
+      code: [],
     },
   });
 
@@ -26,5 +26,9 @@ export function addUpgradeable(c: ContractBuilder, access: Access) {
 
   c.addTraitFunction(upgradeableTrait, functions._require_auth);
 
-  requireAccessControl(c, upgradeableTrait, functions._require_auth, access, '*operator');
+  requireAccessControl(c, upgradeableTrait, functions._require_auth, access, {
+    useMacro: false,
+    role: 'upgrader',
+    caller: 'operator',
+  });
 }

package/src/api.ts

@@ -1,8 +1,22 @@
 import type { CommonContractOptions } from './common-options';
 import type { FungibleOptions } from './fungible';
 import type { NonFungibleOptions } from './non-fungible';
-import { printFungible, defaults as fungibledefaults } from './fungible';
-import { printNonFungible, defaults as nonFungibledefaults } from './non-fungible';
+import type { StablecoinOptions } from './stablecoin';
+import {
+  printStablecoin,
+  defaults as stablecoinDefaults,
+  isAccessControlRequired as stablecoinIsAccessControlRequired,
+} from './stablecoin';
+import {
+  printFungible,
+  defaults as fungibledefaults,
+  isAccessControlRequired as fungibleIsAccessControlRequired,
+} from './fungible';
+import {
+  printNonFungible,
+  defaults as nonFungibledefaults,
+  isAccessControlRequired as nonFungibleIsAccessControlRequired,
+} from './non-fungible';
 
 export interface WizardContractAPI<Options extends CommonContractOptions> {
   /**
@@ -24,15 +38,24 @@ export interface AccessControlAPI<Options extends CommonContractOptions> {
   isAccessControlRequired: (opts: Partial<Options>) => boolean;
 }
 
-export type Fungible = WizardContractAPI<FungibleOptions>; // TODO add AccessControlAPI<FungibleOptions> when access control is implemented, if useful
-export type NonFungible = WizardContractAPI<NonFungibleOptions>;
+export type Fungible = WizardContractAPI<FungibleOptions> & AccessControlAPI<FungibleOptions>;
+export type NonFungible = WizardContractAPI<NonFungibleOptions> & AccessControlAPI<NonFungibleOptions>;
+export type Stablecoin = WizardContractAPI<StablecoinOptions> & AccessControlAPI<StablecoinOptions>;
 
 export const fungible: Fungible = {
   print: printFungible,
   defaults: fungibledefaults,
+  isAccessControlRequired: fungibleIsAccessControlRequired,
 };
 
 export const nonFungible: NonFungible = {
   print: printNonFungible,
   defaults: nonFungibledefaults,
+  isAccessControlRequired: nonFungibleIsAccessControlRequired,
+};
+
+export const stablecoin: Stablecoin = {
+  print: printStablecoin,
+  defaults: stablecoinDefaults,
+  isAccessControlRequired: stablecoinIsAccessControlRequired,
 };

package/src/build-generic.ts

@@ -2,10 +2,13 @@ import type { FungibleOptions } from './fungible';
 import { buildFungible } from './fungible';
 import type { NonFungibleOptions } from './non-fungible';
 import { buildNonFungible } from './non-fungible';
+import type { StablecoinOptions } from './stablecoin';
+import { buildStablecoin } from './stablecoin';
 
 export interface KindedOptions {
   Fungible: { kind: 'Fungible' } & FungibleOptions;
   NonFungible: { kind: 'NonFungible' } & NonFungibleOptions;
+  Stablecoin: { kind: 'Stablecoin' } & StablecoinOptions;
 }
 
 export type GenericOptions = KindedOptions[keyof KindedOptions];
@@ -18,6 +21,9 @@ export function buildGeneric(opts: GenericOptions) {
     case 'NonFungible':
       return buildNonFungible(opts);
 
+    case 'Stablecoin':
+      return buildStablecoin(opts);
+
     default: {
       const _: never = opts;
       throw new Error('Unknown kind');

package/src/contract.ts

@@ -56,8 +56,8 @@ export interface BaseFunction {
 }
 
 export interface ContractFunction extends BaseFunction {
+  tags: string[];
   codeBefore?: string[];
-  tag?: string;
 }
 
 export interface Variable {
@@ -177,6 +177,7 @@ export class ContractBuilder implements Contract {
       const contractFn: ContractFunction = {
         ...fn,
         pub: true,
+        tags: [],
         codeBefore: [],
       };
       this.freeFunctionsMap.set(signature, contractFn);
@@ -201,6 +202,7 @@ export class ContractBuilder implements Contract {
     // Otherwise, add the function
     const contractFn: ContractFunction = {
       ...fn,
+      tags: [],
       codeBefore: [],
     };
     t.functions.push(contractFn);
@@ -236,7 +238,7 @@ export class ContractBuilder implements Contract {
 
   addFunctionTag(fn: BaseFunction, tag: string, baseTrait?: BaseTraitImplBlock): void {
     const existingFn = this.getOrCreateFunction(fn, baseTrait);
-    existingFn.tag = tag;
+    existingFn.tags = [...(existingFn.tags ?? []), tag];
   }
 
   addConstructorArgument(arg: Argument): void {
@@ -249,6 +251,11 @@ export class ContractBuilder implements Contract {
   }
 
   addConstructorCode(code: string): void {
+    for (const existingCode of this.constructorCode) {
+      if (existingCode === code) {
+        return;
+      }
+    }
     this.constructorCode.push(code);
   }