@openzeppelin/wizard-stellar 0.2.1 → 0.2.3

package/dist/zip-scaffold.js.map

@@ -0,0 +1 @@
+{"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" | "fungible" | "base" | "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.1",
+  "version": "0.2.3",
   "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/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[];
@@ -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[] = [];
 
@@ -250,4 +255,12 @@ export class ContractBuilder implements Contract {
   addDerives(derive: string): void {
     this.derivesSet.add(derive);
   }
+
+  addDocumentation(description: string) {
+    this.documentations.push(description);
+  }
+
+  addSecurityTag(securityContact: string) {
+    this.securityContact = securityContact;
+  }
 }

package/src/index.ts

@@ -23,3 +23,6 @@ export { contractsVersion, contractsVersionTag, compatibleContractsSemver } from
 
 export { fungible } from './api';
 export { nonFungible } from './api';
+
+export type { FungibleOptions } from './fungible';
+export type { NonFungibleOptions } from './non-fungible';

package/src/print.ts

@@ -9,6 +9,13 @@ const DEFAULT_SECTION = '1. with no section';
 const STANDALONE_IMPORTS_GROUP = 'Standalone Imports';
 const MAX_USE_CLAUSE_LINE_LENGTH = 90;
 const TAB = '    ';
+export const createLevelAttributes = [`#![no_std]`];
+
+export const removeCreateLevelAttributes = (printedContract: string) =>
+  createLevelAttributes.reduce(
+    (cleanedPrintedContract, createLevelAttribute) => cleanedPrintedContract.replace(createLevelAttribute, ''),
+    printedContract,
+  );
 
 export function printContract(contract: Contract): string {
   return formatLines(
@@ -16,7 +23,9 @@ export function printContract(contract: Contract): string {
       [
         `// SPDX-License-Identifier: ${contract.license}`,
         `// Compatible with OpenZeppelin Stellar Soroban Contracts ${compatibleContractsSemver}`,
-        `#![no_std]`,
+        ...(contract.documentations.length ? ['', ...printDocumentations(contract.documentations)] : []),
+        ...(contract.securityContact ? ['', ...printSecurityTag(contract.securityContact)] : []),
+        ...createLevelAttributes,
       ],
       spaceBetween(
         printUseClauses(contract),
@@ -353,3 +362,11 @@ function printArgument(arg: Argument): string {
     return `${arg.name}`;
   }
 }
+
+function printDocumentations(documentations: string[]): string[] {
+  return documentations.map(documentation => `//! ${documentation}`);
+}
+
+function printSecurityTag(securityContact: string) {
+  return ['//! # Security', '//!', `//! For security issues, please contact: ${securityContact}`];
+}

package/src/set-info.ts

@@ -1,15 +1,22 @@
 import type { ContractBuilder } from './contract';
 
+export const TAG_SECURITY_CONTACT = `@custom:security-contact`;
+
 export const infoOptions = [{}, { license: 'WTFPL' }] as const;
 
 export const defaults: Info = { license: 'MIT' };
 
 export type Info = {
   license?: string;
+  securityContact?: string;
 };
 
 export function setInfo(c: ContractBuilder, info: Info): void {
-  const { license } = info;
+  const { securityContact, license } = info;
+
+  if (securityContact) {
+    c.addSecurityTag(securityContact);
+  }
 
   if (license) {
     c.license = license;

package/src/utils/version.ts

@@ -8,3 +8,8 @@ export const contractsVersionTag = `v${contractsVersion}`;
  * Semantic version string representing of the minimum compatible version of Contracts to display in output.
  */
 export const compatibleContractsSemver = '^0.2.0';
+
+/**
+ * The Soroban version for which compilation and testing have passing tests
+ */
+export const compatibleSorobanVersion = '22.0.8';

package/src/zip-rust.ts

@@ -0,0 +1,57 @@
+import JSZip from 'jszip';
+import type { GenericOptions } from './build-generic';
+import type { Contract } from './contract';
+import { printContract, removeCreateLevelAttributes } from './print';
+import {
+  addDependenciesWith,
+  allStellarDependencies,
+  contractOptionsToContractName,
+  createRustLibFile,
+  printContractCargo,
+  printRustNameTest,
+} from './zip-shared';
+import { contractsVersionTag, compatibleSorobanVersion } from './utils/version';
+
+const workspaceCargo = `[workspace]
+resolver = "2"
+members = ["contracts/*"]
+
+[workspace.package]
+authors = []
+edition = "2021"
+license = "Apache-2.0"
+version = "0.0.1"
+
+[workspace.dependencies]
+${addDependenciesWith(`{ git = "https://github.com/OpenZeppelin/stellar-contracts", tag = "${contractsVersionTag}" }`, allStellarDependencies)}${addDependenciesWith(`{ version = "${compatibleSorobanVersion}" }`, ['soroban'])}
+`;
+
+const readme = `\
+# Sample Rust Contract Environment
+
+This project demonstrates a basic Rust contract environment use case. It comes with a contract generated by [OpenZeppelin Wizard](https://wizard.openzeppelin.com/) and a test for that contract. Make sure you have the required dependencies and keep building!
+
+## Go further
+
+Continue your development journey with [Stellar CLI](https://github.com/stellar/stellar-cli).
+
+## Installing dependencies
+
+- See [Rust and Stellar installation guide](https://developers.stellar.org/docs/build/smart-contracts/getting-started/setup).
+- See [Git installation guide](https://github.com/git-guides/install-git).
+`;
+
+export async function zipRust(c: Contract, opts: GenericOptions) {
+  const zip = new JSZip();
+
+  const contractName = contractOptionsToContractName(opts?.kind || 'contract');
+
+  zip.file(`contracts/${contractName}/src/contract.rs`, removeCreateLevelAttributes(printContract(c)));
+  zip.file(`contracts/${contractName}/src/test.rs`, printRustNameTest(c));
+  zip.file(`contracts/${contractName}/src/lib.rs`, createRustLibFile);
+  zip.file(`contracts/${contractName}/Cargo.toml`, printContractCargo(contractName));
+  zip.file('Cargo.toml', workspaceCargo);
+  zip.file('README.md', readme);
+
+  return zip;
+}

package/src/zip-scaffold.ts

@@ -0,0 +1,273 @@
+import JSZip from 'jszip';
+import type { GenericOptions } from './build-generic';
+import type { Contract } from './contract';
+import { printContract, removeCreateLevelAttributes } from './print';
+import { compatibleSorobanVersion, contractsVersionTag } from './utils/version';
+import {
+  addDependenciesWith,
+  allStellarDependencies,
+  contractOptionsToContractName,
+  createRustLibFile,
+  printContractCargo,
+  printRustNameTest,
+} from './zip-shared';
+
+function getAddressArgs(c: Contract): string[] {
+  return c.constructorArgs
+    .filter(constructorArg => constructorArg.type?.toLowerCase() === 'address')
+    .map(constructorArg => constructorArg.name);
+}
+
+const setupSh = (c: Contract, opts: GenericOptions, scaffoldContractName: string) => {
+  const environmentsFileUpdate = (setUpContract: Contract, setUpScaffoldContractName: string) => `
+# Update environments.toml: remove original contracts and insert wizard's contract
+setup_environment() {
+  local file="environments.toml"
+  local temp
+  temp="$(mktemp)"
+
+  local in_dev_contracts=0
+  local skip_entry=0
+  local contract_entry_inserted=0
+  insert_contract_entry() {
+    {
+      printf '%s\\n' "[development.contracts.${setUpScaffoldContractName}_contract]" \\
+        "client = true" "" \\
+        "# If your contract has a \\\`__constructor\\\`, specify your arguments to it here." \\
+        "# These are the same arguments you could pass after the \\\`--\\\` in a call to" \\
+        "# \\\`stellar contract deploy\\\`" \\
+        "# Only available in \\\`development\\\` and \\\`test\\\` environments" \\
+        ${
+          setUpContract.constructorArgs.length
+            ? // Mind the spacing
+              `"# TODO add appropriate values for for the constructors arguments" \\
+        "constructor_args = \\"\\"\\"" \\
+        "${setUpContract.constructorArgs.map(constructorArg => `--${constructorArg.name} \\"ADD_${constructorArg.name.toLocaleUpperCase()}_${constructorArg.type?.toLocaleUpperCase() || 'ARGUMENT'}_HERE\\"`).join(' ')}" \\
+        "\\"\\"\\"" \\
+        ""`
+            : '""'
+        }
+    } >> "$temp"
+  }
+
+  while IFS= read -r line; do
+    if [[ $contract_entry_inserted -eq 0 && $line == '[staging.network]' ]]; then
+      insert_contract_entry
+      contract_entry_inserted=1
+    fi
+
+    if [[ $line =~ ^\\[development\\.contracts\\]$ ]]; then
+      printf '%s\\n' "$line" >> "$temp"
+      in_dev_contracts=1
+      skip_entry=0
+      continue
+    fi
+
+    if [[ $line =~ ^\\[[^]]+\\]$ ]]; then
+      if (( in_dev_contracts )) && [[ $line =~ ^\\[development\\.contracts\\..+\\]$ ]]; then
+        skip_entry=1
+        in_dev_contracts=0
+        continue
+      fi
+      in_dev_contracts=0
+      skip_entry=0
+      printf '%s\\n' "$line" >> "$temp"
+      continue
+    fi
+
+    if (( skip_entry )); then
+      continue
+    fi
+
+    if (( in_dev_contracts )); then
+      if [[ $line =~ ^[[:space:]]*# ]]; then
+        printf '%s\\n' "$line" >> "$temp"
+      fi
+      continue
+    fi
+
+    printf '%s\\n' "$line" >> "$temp"
+  done < "$file"
+
+  mv "$temp" "$file"
+}
+`;
+
+  const updateWorkspaceCargo = `update_cargo() {
+  cp Cargo.toml Cargo.toml.bak
+
+  cat <<EOF > deps.tmp
+${addDependenciesWith(`{ git = "https://github.com/OpenZeppelin/stellar-contracts", tag = "${contractsVersionTag}" }`, allStellarDependencies)}${addDependenciesWith(`{ version = "${compatibleSorobanVersion}" }`, ['soroban'])}
+EOF
+
+  awk '
+    BEGIN {
+      inserted = 0
+      deps = ""
+      while ((getline line < "deps.tmp") > 0) {
+        deps = deps line "\\n"
+      }
+      close("deps.tmp")
+    }
+    /^\\[workspace.dependencies\\]/ {
+      in_deps = 1
+      print
+      if (!inserted) {
+        printf "%s", deps
+        inserted = 1
+      }
+      next
+    }
+    /^\\[/ { in_deps = 0 }
+    in_deps { next }
+    { print }
+  ' Cargo.toml.bak > Cargo.toml
+
+  rm deps.tmp
+  rm Cargo.toml.bak
+}`;
+
+  return `\
+#!/usr/bin/env bash
+#
+# setup.sh
+# 
+# This script is meant to set up a Scaffold project and insert the Wizard's contracts in the project
+
+check_is_installed() {
+  if ! which "$1" &> /dev/null; then
+    echo "❌ $1 command not found."
+    echo "Install $2 and try again, you can find installation guides in the README."
+    exit 1
+  fi
+}
+
+scaffold() {
+  tmp_folder="tmp"
+  stellar scaffold init "$tmp_folder"
+
+  rm -rf "$tmp_folder/contracts"
+
+  local current_directory
+  current_directory="$(cd "$(dirname "\${BASH_SOURCE[0]}")" && pwd)"
+
+  shopt -s dotglob
+
+  cp -a "$current_directory/$tmp_folder"/. "$current_directory"/
+  rm -rf "$current_directory/$tmp_folder"
+}
+
+init_git(){
+  git init
+  git add .
+  git commit -m "openzeppelin: add wizard output" --quiet
+}
+
+${environmentsFileUpdate(c, scaffoldContractName)}
+
+${updateWorkspaceCargo}
+
+build_contracts() {
+  cargo build
+}
+
+install_npm_dependencies() {
+  if ! npm install --silent; then
+    echo "❌ Failed to set up the project."
+    exit 1
+  fi
+}
+
+
+################
+##### Start ####
+################
+
+echo "⚙️ Checking dependencies requirement"
+check_is_installed git "Git"
+check_is_installed cargo "Rust"
+check_is_installed stellar "Scaffold"
+check_is_installed docker "Docker"
+check_is_installed node "Node"
+
+
+if ! [ -f "environments.toml" ]
+then
+  echo "🏗️ Building Scaffold project"
+
+  scaffold
+  
+  setup_environment
+
+  update_cargo
+
+  build_contracts
+
+  install_npm_dependencies
+
+  init_git
+
+  echo "✅ Installation complete" 
+else
+  echo "✅ Scaffold project already initialized."
+fi
+`;
+};
+
+const readme = (c: Contract) => {
+  const hasTodosToResolve = (c: Contract) => getAddressArgs(c).length > 0;
+
+  return `\
+# Sample Scaffold Project
+
+This project demonstrates a basic Scaffold use case. It comes with a contract generated by [OpenZeppelin Wizard](https://wizard.openzeppelin.com/), a test for that contract, and a script that initiate a Stellar Scaffold project with this contract. [Scaffold Stellar](https://github.com/AhaLabs/scaffold-stellar?tab=readme-ov-file#scaffold-stellar) is a convention-over-configuration toolkit for blockchain and distributed application development on the Stellar network. It provides a seamless development experience through CLI tools, smart contract management, and deployment utilities.
+
+## Installing dependencies
+
+- See [Git installation guide](https://github.com/git-guides/install-git).
+- 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).
+
+## Initializing the project
+
+\`\`\`
+bash setup.sh
+\`\`\`
+${hasTodosToResolve(c) ? '\n## Resolve any TODOs \n\nSearch for any TODO comments in the project and resolve them (search for TODO with your code editor).\n' : ''}
+
+## Testing the contract
+
+\`\`\`
+cargo test
+\`\`\`
+
+## Deploying the contract
+
+\`\`\`
+stellar scaffold watch --build-clients
+\`\`\`
+
+## Deploying the contract and run the Scaffold UI app
+
+\`\`\`
+npm run dev
+\`\`\`
+`;
+};
+
+export async function zipScaffold(c: Contract, opts: GenericOptions) {
+  const zip = new JSZip();
+
+  const scaffoldContractName = contractOptionsToContractName(opts?.kind || 'contract');
+
+  zip.file(`contracts/${scaffoldContractName}/src/contract.rs`, removeCreateLevelAttributes(printContract(c)));
+  zip.file(`contracts/${scaffoldContractName}/src/test.rs`, printRustNameTest(c));
+  zip.file(`contracts/${scaffoldContractName}/src/lib.rs`, createRustLibFile);
+  zip.file(`contracts/${scaffoldContractName}/Cargo.toml`, printContractCargo(scaffoldContractName));
+  zip.file('setup.sh', setupSh(c, opts, scaffoldContractName));
+  zip.file('README-WIZARD.md', readme(c));
+
+  return zip;
+}

package/src/zip-shared.ts

@@ -0,0 +1,85 @@
+import type { Contract } from './contract';
+
+function pascalToSnakeCase(string: string) {
+  return string
+    .replace(/([A-Z])/g, '_$1')
+    .replace(/^_/, '')
+    .toLowerCase();
+}
+
+export const contractOptionsToContractName = pascalToSnakeCase;
+
+export function getAddressArgs(c: Pick<Contract, 'constructorArgs'>): string[] {
+  return (c.constructorArgs || [])
+    .filter(constructorArg => constructorArg.type?.trim() === 'Address')
+    .map(constructorArg => constructorArg.name);
+}
+
+export const printRustNameTest = (c: Pick<Contract, 'constructorArgs' | 'name'>) => `#![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
+`;
+
+const getKeysOf = <TObject extends Record<string, unknown>>(objectToGetKeysOf: TObject) =>
+  Object.keys(objectToGetKeysOf) as (keyof TObject)[];
+
+export const 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'],
+} as const;
+
+export const allStellarDependencies = getKeysOf(stellarDependencies);
+
+export const allDependencies = {
+  ...stellarDependencies,
+  soroban: ['soroban-sdk'],
+} as const;
+
+export const addDependenciesWith = (dependencyValue: string, dependenciesToAdd: (keyof typeof allDependencies)[]) =>
+  dependenciesToAdd.reduce((addedDependency, dependencyName) => {
+    return `${addedDependency}${allDependencies[dependencyName].map(cargoDependencies => `${cargoDependencies} = ${dependencyValue}\n`).join('')}`;
+  }, '');
+
+export const printContractCargo = (scaffoldContractName: string) => `[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 }', [...allStellarDependencies, 'soroban'])}
+[dev-dependencies]
+${addDependenciesWith('{ workspace = true, features = ["testutils"] }', ['soroban'])}`;
+
+export const createRustLibFile = `#![no_std]
+#![allow(dead_code)]
+
+mod contract;
+mod test;
+`;