@openzeppelin/wizard-stellar 0.2.2 → 0.3.0

package/dist/zip-scaffold.js

@@ -3,81 +3,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.contractOptionsToScaffoldContractName = void 0;
 exports.zipScaffold = zipScaffold;
 const jszip_1 = __importDefault(require("jszip"));
 const print_1 = require("./print");
 const version_1 = require("./utils/version");
-const dependencies = {
-    base: ['stellar-default-impl-macro'],
-    fungible: ['stellar-fungible'],
-    nonFungible: ['stellar-non-fungible'],
-    pausable: ['stellar-pausable', 'stellar-pausable-macros'],
-    upgradable: ['stellar-upgradeable', 'stellar-upgradeable-macros'],
-    soroban: ['soroban-sdk'],
-};
-const addDependenciesWith = (dependencyValue, dependenciesToAdd) => dependenciesToAdd.reduce((addedDependency, dependencyName) => {
-    return `${addedDependency}${dependencies[dependencyName].map(cargoDependencies => `${cargoDependencies} = ${dependencyValue}\n`).join('')}`;
-}, '');
-const getDependenciesToAdd = (opts) => {
-    const dependenciesToAdd = ['base'];
-    if (opts.kind === 'Fungible')
-        dependenciesToAdd.push('fungible');
-    if (opts.kind === 'NonFungible')
-        dependenciesToAdd.push('nonFungible');
-    if (opts.pausable)
-        dependenciesToAdd.push('pausable');
-    if (opts.upgradeable)
-        dependenciesToAdd.push('upgradable');
-    return dependenciesToAdd;
-};
-const test = (c) => `#![cfg(test)]
-
-extern crate std;
-
-use soroban_sdk::{ ${getAddressArgs(c).length ? 'testutils::Address as _, Address, ' : ''}Env, String };
-
-use crate::contract::{ ${c.name}, ${c.name}Client };
-
-#[test]
-fn initial_state() {
-    let env = Env::default();
-
-    let contract_addr = env.register(${c.name}, (${getAddressArgs(c)
-    .map(() => 'Address::generate(&env)')
-    .join(',')}${getAddressArgs(c).length === 1 ? ',' : ''}));
-    let client = ${c.name}Client::new(&env, &contract_addr);
-
-    assert_eq!(client.name(), String::from_str(&env, "${c.name}"));
-}
-
-// Add more tests bellow
-`;
-function contractCargo(opts, scaffoldContractName) {
-    return `[package]
-name = "${scaffoldContractName.replace(/_/, '-')}-contract"
-edition.workspace = true
-license.workspace = true
-publish = false
-version.workspace = true
-
-[lib]
-crate-type = ["cdylib"]
-doctest = false
-
-[dependencies]
-${addDependenciesWith('{ workspace = true }', [...getDependenciesToAdd(opts), 'soroban'])}
-[dev-dependencies]
-${addDependenciesWith('{ workspace = true, features = ["testutils"] }', ['soroban'])}
-`;
-}
-function pascalToSnakeCase(string) {
-    return string
-        .replace(/([A-Z])/g, '_$1')
-        .replace(/^_/, '')
-        .toLowerCase();
-}
-exports.contractOptionsToScaffoldContractName = pascalToSnakeCase;
+const zip_shared_1 = require("./zip-shared");
 function getAddressArgs(c) {
     return c.constructorArgs
         .filter(constructorArg => { var _a; return ((_a = constructorArg.type) === null || _a === void 0 ? void 0 : _a.toLowerCase()) === 'address'; })
@@ -155,11 +85,11 @@ setup_environment() {
   mv "$temp" "$file"
 }
 `;
-    const updateWorkspaceCargo = (opts) => `update_cargo() {
+    const updateWorkspaceCargo = `update_cargo() {
   cp Cargo.toml Cargo.toml.bak
 
   cat <<EOF > deps.tmp
-${addDependenciesWith(`{ git = "https://github.com/OpenZeppelin/stellar-contracts", tag = "${version_1.contractsVersionTag}" }`, getDependenciesToAdd(opts))}${addDependenciesWith(`{ version = "${version_1.compatibleSorobanVersion}" }`, ['soroban'])}
+${(0, zip_shared_1.addDependenciesWith)(`{ git = "https://github.com/OpenZeppelin/stellar-contracts", tag = "${version_1.contractsVersionTag}" }`, zip_shared_1.allStellarDependencies)}${(0, zip_shared_1.addDependenciesWith)(`{ version = "${version_1.compatibleSorobanVersion}" }`, ['soroban'])}
 EOF
 
   awk '
@@ -226,7 +156,7 @@ init_git(){
 
 ${environmentsFileUpdate(c, scaffoldContractName)}
 
-${updateWorkspaceCargo(opts)}
+${updateWorkspaceCargo}
 
 build_contracts() {
   cargo build
@@ -284,7 +214,7 @@ This project demonstrates a basic Scaffold use case. It comes with a contract ge
 ## Installing dependencies
 
 - See [Git installation guide](https://github.com/git-guides/install-git).
-- See [Rust installation guide](https://www.rust-lang.org/tools/install).
+- See [Rust and Stellar installation guide](https://developers.stellar.org/docs/build/smart-contracts/getting-started/setup).
 - See [Scaffold CLI installation guide](https://github.com/AhaLabs/scaffold-stellar?tab=readme-ov-file#quick-start).
 - See [Docker installation guide](https://docs.docker.com/engine/install/).
 - See [Node installation guide](https://nodejs.org/en/download).
@@ -315,19 +245,13 @@ npm run dev
 \`\`\`
 `;
 };
-const createLib = `#![no_std]
-#![allow(dead_code)]
-
-mod contract;
-mod test;
-`;
 async function zipScaffold(c, opts) {
     const zip = new jszip_1.default();
-    const scaffoldContractName = (0, exports.contractOptionsToScaffoldContractName)((opts === null || opts === void 0 ? void 0 : opts.kind) || 'contract');
+    const scaffoldContractName = (0, zip_shared_1.contractOptionsToContractName)((opts === null || opts === void 0 ? void 0 : opts.kind) || 'contract');
     zip.file(`contracts/${scaffoldContractName}/src/contract.rs`, (0, print_1.removeCreateLevelAttributes)((0, print_1.printContract)(c)));
-    zip.file(`contracts/${scaffoldContractName}/src/test.rs`, test(c));
-    zip.file(`contracts/${scaffoldContractName}/src/lib.rs`, createLib);
-    zip.file(`contracts/${scaffoldContractName}/Cargo.toml`, contractCargo(opts, scaffoldContractName));
+    zip.file(`contracts/${scaffoldContractName}/src/test.rs`, (0, zip_shared_1.printRustNameTest)(c));
+    zip.file(`contracts/${scaffoldContractName}/src/lib.rs`, zip_shared_1.createRustLibFile);
+    zip.file(`contracts/${scaffoldContractName}/Cargo.toml`, (0, zip_shared_1.printContractCargo)(scaffoldContractName));
     zip.file('setup.sh', setupSh(c, opts, scaffoldContractName));
     zip.file('README-WIZARD.md', readme(c));
     return zip;

package/dist/zip-scaffold.js.map

@@ -1 +1 @@
-{"version":3,"file":"zip-scaffold.js","sourceRoot":"","sources":["../src/zip-scaffold.ts"],"names":[],"mappings":";;;;;;AA8UA,kCAaC;AA3VD,kDAA0B;AAG1B,mCAAqE;AACrE,6CAAgF;AAEhF,MAAM,YAAY,GAAG;IACnB,IAAI,EAAE,CAAC,4BAA4B,CAAC;IACpC,QAAQ,EAAE,CAAC,kBAAkB,CAAC;IAC9B,WAAW,EAAE,CAAC,sBAAsB,CAAC;IACrC,QAAQ,EAAE,CAAC,kBAAkB,EAAE,yBAAyB,CAAC;IACzD,UAAU,EAAE,CAAC,qBAAqB,EAAE,4BAA4B,CAAC;IACjE,OAAO,EAAE,CAAC,aAAa,CAAC;CAChB,CAAC;AAEX,MAAM,mBAAmB,GAAG,CAAC,eAAuB,EAAE,iBAAgD,EAAE,EAAE,CACxG,iBAAiB,CAAC,MAAM,CAAC,CAAC,eAAe,EAAE,cAAc,EAAE,EAAE;IAC3D,OAAO,GAAG,eAAe,GAAG,YAAY,CAAC,cAAc,CAAC,CAAC,GAAG,CAAC,iBAAiB,CAAC,EAAE,CAAC,GAAG,iBAAiB,MAAM,eAAe,IAAI,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC;AAC9I,CAAC,EAAE,EAAE,CAAC,CAAC;AAET,MAAM,oBAAoB,GAAG,CAAC,IAAoB,EAAiC,EAAE;IACnF,MAAM,iBAAiB,GAAkC,CAAC,MAAM,CAAC,CAAC;IAElE,IAAI,IAAI,CAAC,IAAI,KAAK,UAAU;QAAE,iBAAiB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACjE,IAAI,IAAI,CAAC,IAAI,KAAK,aAAa;QAAE,iBAAiB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IACvE,IAAI,IAAI,CAAC,QAAQ;QAAE,iBAAiB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACtD,IAAI,IAAI,CAAC,WAAW;QAAE,iBAAiB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAE3D,OAAO,iBAAiB,CAAC;AAC3B,CAAC,CAAC;AAEF,MAAM,IAAI,GAAG,CAAC,CAAW,EAAE,EAAE,CAAC;;;;qBAIT,cAAc,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,oCAAoC,CAAC,CAAC,CAAC,EAAE;;yBAEhE,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,IAAI;;;;;;uCAMH,CAAC,CAAC,IAAI,MAAM,cAAc,CAAC,CAAC,CAAC;KAC7D,GAAG,CAAC,GAAG,EAAE,CAAC,yBAAyB,CAAC;KACpC,IAAI,CAAC,GAAG,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE;mBACzC,CAAC,CAAC,IAAI;;wDAE+B,CAAC,CAAC,IAAI;;;;CAI7D,CAAC;AAEF,SAAS,aAAa,CAAC,IAAoB,EAAE,oBAA4B;IACvE,OAAO;UACC,oBAAoB,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC;;;;;;;;;;;EAW9C,mBAAmB,CAAC,sBAAsB,EAAE,CAAC,GAAG,oBAAoB,CAAC,IAAI,CAAC,EAAE,SAAS,CAAC,CAAC;;EAEvF,mBAAmB,CAAC,gDAAgD,EAAE,CAAC,SAAS,CAAC,CAAC;CACnF,CAAC;AACF,CAAC;AAED,SAAS,iBAAiB,CAAC,MAAc;IACvC,OAAO,MAAM;SACV,OAAO,CAAC,UAAU,EAAE,KAAK,CAAC;SAC1B,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC;SACjB,WAAW,EAAE,CAAC;AACnB,CAAC;AAEY,QAAA,qCAAqC,GAAG,iBAAiB,CAAC;AAEvE,SAAS,cAAc,CAAC,CAAW;IACjC,OAAO,CAAC,CAAC,eAAe;SACrB,MAAM,CAAC,cAAc,CAAC,EAAE,WAAC,OAAA,CAAA,MAAA,cAAc,CAAC,IAAI,0CAAE,WAAW,EAAE,MAAK,SAAS,CAAA,EAAA,CAAC;SAC1E,GAAG,CAAC,cAAc,CAAC,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;AAChD,CAAC;AAED,MAAM,OAAO,GAAG,CAAC,CAAW,EAAE,IAAoB,EAAE,oBAA4B,EAAE,EAAE;IAClF,MAAM,sBAAsB,GAAG,CAAC,aAAuB,EAAE,yBAAiC,EAAE,EAAE,CAAC;;;;;;;;;;;;+CAYlD,yBAAyB;;;;;;UAO9D,aAAa,CAAC,eAAe,CAAC,MAAM;QAClC,CAAC,CAAC,mBAAmB;YACnB;;WAEH,aAAa,CAAC,eAAe,CAAC,GAAG,CAAC,cAAc,CAAC,EAAE,WAAC,OAAA,KAAK,cAAc,CAAC,IAAI,WAAW,cAAc,CAAC,IAAI,CAAC,iBAAiB,EAAE,IAAI,CAAA,MAAA,cAAc,CAAC,IAAI,0CAAE,iBAAiB,EAAE,KAAI,UAAU,UAAU,CAAA,EAAA,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;;WAE7M;QACC,CAAC,CAAC,IACN;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA6CP,CAAC;IAEA,MAAM,oBAAoB,GAAG,CAAC,IAAoB,EAAE,EAAE,CAAC;;;;EAIvD,mBAAmB,CAAC,uEAAuE,6BAAmB,KAAK,EAAE,oBAAoB,CAAC,IAAI,CAAC,CAAC,GAAG,mBAAmB,CAAC,gBAAgB,kCAAwB,KAAK,EAAE,CAAC,SAAS,CAAC,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA4BlO,CAAC;IAED,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAoCP,sBAAsB,CAAC,CAAC,EAAE,oBAAoB,CAAC;;EAE/C,oBAAoB,CAAC,IAAI,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA8C3B,CAAC;AACF,CAAC,CAAC;AAEF,MAAM,MAAM,GAAG,CAAC,CAAW,EAAE,EAAE;IAC7B,MAAM,iBAAiB,GAAG,CAAC,CAAW,EAAE,EAAE,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;IAExE,OAAO;;;;;;;;;;;;;;;;;;EAkBP,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,oIAAoI,CAAC,CAAC,CAAC,EAAE;;;;;;;;;;;;;;;;;;;CAmBjK,CAAC;AACF,CAAC,CAAC;AAEF,MAAM,SAAS,GAAG;;;;;CAKjB,CAAC;AAEK,KAAK,UAAU,WAAW,CAAC,CAAW,EAAE,IAAoB;IACjE,MAAM,GAAG,GAAG,IAAI,eAAK,EAAE,CAAC;IAExB,MAAM,oBAAoB,GAAG,IAAA,6CAAqC,EAAC,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,IAAI,KAAI,UAAU,CAAC,CAAC;IAE7F,GAAG,CAAC,IAAI,CAAC,aAAa,oBAAoB,kBAAkB,EAAE,IAAA,mCAA2B,EAAC,IAAA,qBAAa,EAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC7G,GAAG,CAAC,IAAI,CAAC,aAAa,oBAAoB,cAAc,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IACnE,GAAG,CAAC,IAAI,CAAC,aAAa,oBAAoB,aAAa,EAAE,SAAS,CAAC,CAAC;IACpE,GAAG,CAAC,IAAI,CAAC,aAAa,oBAAoB,aAAa,EAAE,aAAa,CAAC,IAAI,EAAE,oBAAoB,CAAC,CAAC,CAAC;IACpG,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,oBAAoB,CAAC,CAAC,CAAC;IAC7D,GAAG,CAAC,IAAI,CAAC,kBAAkB,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IAExC,OAAO,GAAG,CAAC;AACb,CAAC"}
+{"version":3,"file":"zip-scaffold.js","sourceRoot":"","sources":["../src/zip-scaffold.ts"],"names":[],"mappings":";;;;;AAmQA,kCAaC;AAhRD,kDAA0B;AAG1B,mCAAqE;AACrE,6CAAgF;AAChF,6CAOsB;AAEtB,SAAS,cAAc,CAAC,CAAW;IACjC,OAAO,CAAC,CAAC,eAAe;SACrB,MAAM,CAAC,cAAc,CAAC,EAAE,WAAC,OAAA,CAAA,MAAA,cAAc,CAAC,IAAI,0CAAE,WAAW,EAAE,MAAK,SAAS,CAAA,EAAA,CAAC;SAC1E,GAAG,CAAC,cAAc,CAAC,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;AAChD,CAAC;AAED,MAAM,OAAO,GAAG,CAAC,CAAW,EAAE,IAAoB,EAAE,oBAA4B,EAAE,EAAE;IAClF,MAAM,sBAAsB,GAAG,CAAC,aAAuB,EAAE,yBAAiC,EAAE,EAAE,CAAC;;;;;;;;;;;;+CAYlD,yBAAyB;;;;;;UAO9D,aAAa,CAAC,eAAe,CAAC,MAAM;QAClC,CAAC,CAAC,mBAAmB;YACnB;;WAEH,aAAa,CAAC,eAAe,CAAC,GAAG,CAAC,cAAc,CAAC,EAAE,WAAC,OAAA,KAAK,cAAc,CAAC,IAAI,WAAW,cAAc,CAAC,IAAI,CAAC,iBAAiB,EAAE,IAAI,CAAA,MAAA,cAAc,CAAC,IAAI,0CAAE,iBAAiB,EAAE,KAAI,UAAU,UAAU,CAAA,EAAA,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;;WAE7M;QACC,CAAC,CAAC,IACN;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA6CP,CAAC;IAEA,MAAM,oBAAoB,GAAG;;;;EAI7B,IAAA,gCAAmB,EAAC,uEAAuE,6BAAmB,KAAK,EAAE,mCAAsB,CAAC,GAAG,IAAA,gCAAmB,EAAC,gBAAgB,kCAAwB,KAAK,EAAE,CAAC,SAAS,CAAC,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA4B9N,CAAC;IAED,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAoCP,sBAAsB,CAAC,CAAC,EAAE,oBAAoB,CAAC;;EAE/C,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA8CrB,CAAC;AACF,CAAC,CAAC;AAEF,MAAM,MAAM,GAAG,CAAC,CAAW,EAAE,EAAE;IAC7B,MAAM,iBAAiB,GAAG,CAAC,CAAW,EAAE,EAAE,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;IAExE,OAAO;;;;;;;;;;;;;;;;;;EAkBP,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,oIAAoI,CAAC,CAAC,CAAC,EAAE;;;;;;;;;;;;;;;;;;;CAmBjK,CAAC;AACF,CAAC,CAAC;AAEK,KAAK,UAAU,WAAW,CAAC,CAAW,EAAE,IAAoB;IACjE,MAAM,GAAG,GAAG,IAAI,eAAK,EAAE,CAAC;IAExB,MAAM,oBAAoB,GAAG,IAAA,0CAA6B,EAAC,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,IAAI,KAAI,UAAU,CAAC,CAAC;IAErF,GAAG,CAAC,IAAI,CAAC,aAAa,oBAAoB,kBAAkB,EAAE,IAAA,mCAA2B,EAAC,IAAA,qBAAa,EAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC7G,GAAG,CAAC,IAAI,CAAC,aAAa,oBAAoB,cAAc,EAAE,IAAA,8BAAiB,EAAC,CAAC,CAAC,CAAC,CAAC;IAChF,GAAG,CAAC,IAAI,CAAC,aAAa,oBAAoB,aAAa,EAAE,8BAAiB,CAAC,CAAC;IAC5E,GAAG,CAAC,IAAI,CAAC,aAAa,oBAAoB,aAAa,EAAE,IAAA,+BAAkB,EAAC,oBAAoB,CAAC,CAAC,CAAC;IACnG,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,oBAAoB,CAAC,CAAC,CAAC;IAC7D,GAAG,CAAC,IAAI,CAAC,kBAAkB,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IAExC,OAAO,GAAG,CAAC;AACb,CAAC"}

package/dist/zip-shared.d.ts

@@ -0,0 +1,26 @@
+import type { Contract } from './contract';
+declare function pascalToSnakeCase(string: string): string;
+export declare const contractOptionsToContractName: typeof pascalToSnakeCase;
+export declare function getAddressArgs(c: Pick<Contract, 'constructorArgs'>): string[];
+export declare const printRustNameTest: (c: Pick<Contract, "constructorArgs" | "name">) => string;
+export declare const stellarDependencies: {
+    readonly base: readonly ["stellar-default-impl-macro"];
+    readonly fungible: readonly ["stellar-fungible"];
+    readonly nonFungible: readonly ["stellar-non-fungible"];
+    readonly pausable: readonly ["stellar-pausable", "stellar-pausable-macros"];
+    readonly upgradable: readonly ["stellar-upgradeable", "stellar-upgradeable-macros"];
+};
+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"];
+    readonly fungible: readonly ["stellar-fungible"];
+    readonly nonFungible: readonly ["stellar-non-fungible"];
+    readonly pausable: readonly ["stellar-pausable", "stellar-pausable-macros"];
+    readonly upgradable: readonly ["stellar-upgradeable", "stellar-upgradeable-macros"];
+};
+export declare const addDependenciesWith: (dependencyValue: string, dependenciesToAdd: (keyof typeof allDependencies)[]) => string;
+export declare const printContractCargo: (scaffoldContractName: string) => string;
+export declare const createRustLibFile = "#![no_std]\n#![allow(dead_code)]\n\nmod contract;\nmod test;\n";
+export {};
+//# sourceMappingURL=zip-shared.d.ts.map

package/dist/zip-shared.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"zip-shared.d.ts","sourceRoot":"","sources":["../src/zip-shared.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE3C,iBAAS,iBAAiB,CAAC,MAAM,EAAE,MAAM,UAKxC;AAED,eAAO,MAAM,6BAA6B,0BAAoB,CAAC;AAE/D,wBAAgB,cAAc,CAAC,CAAC,EAAE,IAAI,CAAC,QAAQ,EAAE,iBAAiB,CAAC,GAAG,MAAM,EAAE,CAI7E;AAED,eAAO,MAAM,iBAAiB,MAAO,IAAI,CAAC,QAAQ,EAAE,iBAAiB,GAAG,MAAM,CAAC,WAqB9E,CAAC;AAKF,eAAO,MAAM,mBAAmB;;;;;;CAMtB,CAAC;AAEX,eAAO,MAAM,sBAAsB,qEAAiC,CAAC;AAErE,eAAO,MAAM,eAAe;;;;;;;CAGlB,CAAC;AAEX,eAAO,MAAM,mBAAmB,oBAAqB,MAAM,qBAAqB,CAAC,MAAM,OAAO,eAAe,CAAC,EAAE,WAGxG,CAAC;AAET,eAAO,MAAM,kBAAkB,yBAA0B,MAAM,WAcuB,CAAC;AAEvF,eAAO,MAAM,iBAAiB,mEAK7B,CAAC"}

package/dist/zip-shared.js

@@ -0,0 +1,79 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createRustLibFile = exports.printContractCargo = exports.addDependenciesWith = exports.allDependencies = exports.allStellarDependencies = exports.stellarDependencies = exports.printRustNameTest = exports.contractOptionsToContractName = void 0;
+exports.getAddressArgs = getAddressArgs;
+function pascalToSnakeCase(string) {
+    return string
+        .replace(/([A-Z])/g, '_$1')
+        .replace(/^_/, '')
+        .toLowerCase();
+}
+exports.contractOptionsToContractName = pascalToSnakeCase;
+function getAddressArgs(c) {
+    return (c.constructorArgs || [])
+        .filter(constructorArg => { var _a; return ((_a = constructorArg.type) === null || _a === void 0 ? void 0 : _a.trim()) === 'Address'; })
+        .map(constructorArg => constructorArg.name);
+}
+const printRustNameTest = (c) => `#![cfg(test)]
+
+extern crate std;
+
+use soroban_sdk::{ ${getAddressArgs(c).length ? 'testutils::Address as _, Address, ' : ''}Env, String };
+
+use crate::contract::{ ${c.name}, ${c.name}Client };
+
+#[test]
+fn initial_state() {
+    let env = Env::default();
+
+    let contract_addr = env.register(${c.name}, (${getAddressArgs(c)
+    .map(() => 'Address::generate(&env)')
+    .join(',')}${getAddressArgs(c).length === 1 ? ',' : ''}));
+    let client = ${c.name}Client::new(&env, &contract_addr);
+
+    assert_eq!(client.name(), String::from_str(&env, "${c.name}"));
+}
+
+// Add more tests bellow
+`;
+exports.printRustNameTest = printRustNameTest;
+const getKeysOf = (objectToGetKeysOf) => Object.keys(objectToGetKeysOf);
+exports.stellarDependencies = {
+    base: ['stellar-default-impl-macro'],
+    fungible: ['stellar-fungible'],
+    nonFungible: ['stellar-non-fungible'],
+    pausable: ['stellar-pausable', 'stellar-pausable-macros'],
+    upgradable: ['stellar-upgradeable', 'stellar-upgradeable-macros'],
+};
+exports.allStellarDependencies = getKeysOf(exports.stellarDependencies);
+exports.allDependencies = {
+    ...exports.stellarDependencies,
+    soroban: ['soroban-sdk'],
+};
+const addDependenciesWith = (dependencyValue, dependenciesToAdd) => dependenciesToAdd.reduce((addedDependency, dependencyName) => {
+    return `${addedDependency}${exports.allDependencies[dependencyName].map(cargoDependencies => `${cargoDependencies} = ${dependencyValue}\n`).join('')}`;
+}, '');
+exports.addDependenciesWith = addDependenciesWith;
+const printContractCargo = (scaffoldContractName) => `[package]
+name = "${scaffoldContractName.replace(/_/, '-')}-contract"
+edition.workspace = true
+license.workspace = true
+publish = false
+version.workspace = true
+
+[lib]
+crate-type = ["cdylib"]
+doctest = false
+
+[dependencies]
+${(0, exports.addDependenciesWith)('{ workspace = true }', [...exports.allStellarDependencies, 'soroban'])}
+[dev-dependencies]
+${(0, exports.addDependenciesWith)('{ workspace = true, features = ["testutils"] }', ['soroban'])}`;
+exports.printContractCargo = printContractCargo;
+exports.createRustLibFile = `#![no_std]
+#![allow(dead_code)]
+
+mod contract;
+mod test;
+`;
+//# sourceMappingURL=zip-shared.js.map

package/dist/zip-shared.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"zip-shared.js","sourceRoot":"","sources":["../src/zip-shared.ts"],"names":[],"mappings":";;;AAWA,wCAIC;AAbD,SAAS,iBAAiB,CAAC,MAAc;IACvC,OAAO,MAAM;SACV,OAAO,CAAC,UAAU,EAAE,KAAK,CAAC;SAC1B,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC;SACjB,WAAW,EAAE,CAAC;AACnB,CAAC;AAEY,QAAA,6BAA6B,GAAG,iBAAiB,CAAC;AAE/D,SAAgB,cAAc,CAAC,CAAoC;IACjE,OAAO,CAAC,CAAC,CAAC,eAAe,IAAI,EAAE,CAAC;SAC7B,MAAM,CAAC,cAAc,CAAC,EAAE,WAAC,OAAA,CAAA,MAAA,cAAc,CAAC,IAAI,0CAAE,IAAI,EAAE,MAAK,SAAS,CAAA,EAAA,CAAC;SACnE,GAAG,CAAC,cAAc,CAAC,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;AAChD,CAAC;AAEM,MAAM,iBAAiB,GAAG,CAAC,CAA6C,EAAE,EAAE,CAAC;;;;qBAI/D,cAAc,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,oCAAoC,CAAC,CAAC,CAAC,EAAE;;yBAEhE,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,IAAI;;;;;;uCAMH,CAAC,CAAC,IAAI,MAAM,cAAc,CAAC,CAAC,CAAC;KAC7D,GAAG,CAAC,GAAG,EAAE,CAAC,yBAAyB,CAAC;KACpC,IAAI,CAAC,GAAG,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE;mBACzC,CAAC,CAAC,IAAI;;wDAE+B,CAAC,CAAC,IAAI;;;;CAI7D,CAAC;AArBW,QAAA,iBAAiB,qBAqB5B;AAEF,MAAM,SAAS,GAAG,CAA0C,iBAA0B,EAAE,EAAE,CACxF,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAsB,CAAC;AAEzC,QAAA,mBAAmB,GAAG;IACjC,IAAI,EAAE,CAAC,4BAA4B,CAAC;IACpC,QAAQ,EAAE,CAAC,kBAAkB,CAAC;IAC9B,WAAW,EAAE,CAAC,sBAAsB,CAAC;IACrC,QAAQ,EAAE,CAAC,kBAAkB,EAAE,yBAAyB,CAAC;IACzD,UAAU,EAAE,CAAC,qBAAqB,EAAE,4BAA4B,CAAC;CACzD,CAAC;AAEE,QAAA,sBAAsB,GAAG,SAAS,CAAC,2BAAmB,CAAC,CAAC;AAExD,QAAA,eAAe,GAAG;IAC7B,GAAG,2BAAmB;IACtB,OAAO,EAAE,CAAC,aAAa,CAAC;CAChB,CAAC;AAEJ,MAAM,mBAAmB,GAAG,CAAC,eAAuB,EAAE,iBAAmD,EAAE,EAAE,CAClH,iBAAiB,CAAC,MAAM,CAAC,CAAC,eAAe,EAAE,cAAc,EAAE,EAAE;IAC3D,OAAO,GAAG,eAAe,GAAG,uBAAe,CAAC,cAAc,CAAC,CAAC,GAAG,CAAC,iBAAiB,CAAC,EAAE,CAAC,GAAG,iBAAiB,MAAM,eAAe,IAAI,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC;AACjJ,CAAC,EAAE,EAAE,CAAC,CAAC;AAHI,QAAA,mBAAmB,uBAGvB;AAEF,MAAM,kBAAkB,GAAG,CAAC,oBAA4B,EAAE,EAAE,CAAC;UAC1D,oBAAoB,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC;;;;;;;;;;;EAW9C,IAAA,2BAAmB,EAAC,sBAAsB,EAAE,CAAC,GAAG,8BAAsB,EAAE,SAAS,CAAC,CAAC;;EAEnF,IAAA,2BAAmB,EAAC,gDAAgD,EAAE,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC;AAd1E,QAAA,kBAAkB,sBAcwD;AAE1E,QAAA,iBAAiB,GAAG;;;;;CAKhC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openzeppelin/wizard-stellar",
-  "version": "0.2.2",
+  "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

@@ -2,6 +2,8 @@ import { toIdentifier } from './utils/convert-strings';
 
 export interface Contract {
   license: string;
+  securityContact: string;
+  documentations: string[];
   name: string;
   useClauses: UseClause[];
   constructorCode: string[];
@@ -54,8 +56,8 @@ export interface BaseFunction {
 }
 
 export interface ContractFunction extends BaseFunction {
+  tags: string[];
   codeBefore?: string[];
-  tag?: string;
 }
 
 export interface Variable {
@@ -72,8 +74,11 @@ export interface Argument {
 export class ContractBuilder implements Contract {
   readonly name: string;
   license = 'MIT';
+  securityContact = '';
   ownable = false;
 
+  readonly documentations: string[] = [];
+
   readonly constructorArgs: Argument[] = [];
   readonly constructorCode: string[] = [];
 
@@ -172,6 +177,7 @@ export class ContractBuilder implements Contract {
       const contractFn: ContractFunction = {
         ...fn,
         pub: true,
+        tags: [],
         codeBefore: [],
       };
       this.freeFunctionsMap.set(signature, contractFn);
@@ -196,6 +202,7 @@ export class ContractBuilder implements Contract {
     // Otherwise, add the function
     const contractFn: ContractFunction = {
       ...fn,
+      tags: [],
       codeBefore: [],
     };
     t.functions.push(contractFn);
@@ -231,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 {
@@ -244,10 +251,23 @@ export class ContractBuilder implements Contract {
   }
 
   addConstructorCode(code: string): void {
+    for (const existingCode of this.constructorCode) {
+      if (existingCode === code) {
+        return;
+      }
+    }
     this.constructorCode.push(code);
   }
 
   addDerives(derive: string): void {
     this.derivesSet.add(derive);
   }
+
+  addDocumentation(description: string) {
+    this.documentations.push(description);
+  }
+
+  addSecurityTag(securityContact: string) {
+    this.securityContact = securityContact;
+  }
 }