[Stellar] Use constructor arguments in Stellar contracts

.changeset/big-buttons-cover.md

@@ -0,0 +1,5 @@
+---
+'@openzeppelin/wizard-stellar': minor
+---
+
+Use constructor args for Sellar smart contracts

packages/core/stellar/README.md

@@ -13,6 +13,7 @@ This package provides a programmatic API. For a web interface, see https://wizar
 The following contract types are supported:
 - `fungible`
 - `nonFungible`
+- `stablecoin`
 
 Each contract type has functions/constants as defined below.
 

packages/core/stellar/src/contract.ts

@@ -7,7 +7,7 @@ export interface Contract {
   name: string;
   useClauses: UseClause[];
   constructorCode: string[];
-  constructorArgs: Argument[];
+  constructorArgs: ConstructorArgument[];
   implementedTraits: TraitImplBlock[];
   freeFunctions: ContractFunction[];
   variables: Variable[];
@@ -71,6 +71,10 @@ export interface Argument {
   type?: string;
 }
 
+export interface ConstructorArgument extends Argument {
+  value?: string;
+}
+
 export class ContractBuilder implements Contract {
   readonly name: string;
   license = 'MIT';
@@ -79,7 +83,7 @@ export class ContractBuilder implements Contract {
 
   readonly documentations: string[] = [];
 
-  readonly constructorArgs: Argument[] = [];
+  readonly constructorArgs: ConstructorArgument[] = [];
   readonly constructorCode: string[] = [];
 
   private implementedTraitsMap: Map<string, TraitImplBlock> = new Map();
@@ -241,7 +245,7 @@ export class ContractBuilder implements Contract {
     existingFn.tags = [...(existingFn.tags ?? []), tag];
   }
 
-  addConstructorArgument(arg: Argument): void {
+  addConstructorArgument(arg: ConstructorArgument): void {
     for (const existingArg of this.constructorArgs) {
       if (existingArg.name == arg.name) {
         return;

packages/core/stellar/src/fungible.test.ts.md

@@ -21,8 +21,15 @@ Generated by [AVA](https://avajs.dev).
     ␊
     #[contractimpl]␊
     impl MyToken {␊
-        pub fn __constructor(e: &Env) {␊
-            Base::set_metadata(e, 18, String::from_str(e, "MyToken"), String::from_str(e, "MTK"));␊
+        // deploy this smart contract with the Stellar CLI:␊
+        //␊
+        // stellar contract deploy \\␊
+        // --wasm path/to/file.wasm \\␊
+        // -- \\␊
+        // --name MyToken \\␊
+        // --symbol MTK␊
+        pub fn __constructor(e: &Env, name: String, symbol: String) {␊
+            Base::set_metadata(e, 18, name, symbol);␊
         }␊
     }␊
     ␊
@@ -51,8 +58,15 @@ Generated by [AVA](https://avajs.dev).
     ␊
     #[contractimpl]␊
     impl MyToken {␊
-        pub fn __constructor(e: &Env) {␊
-            Base::set_metadata(e, 18, String::from_str(e, "MyToken"), String::from_str(e, "MTK"));␊
+        // deploy this smart contract with the Stellar CLI:␊
+        //␊
+        // stellar contract deploy \\␊
+        // --wasm path/to/file.wasm \\␊
+        // -- \\␊
+        // --name MyToken \\␊
+        // --symbol MTK␊
+        pub fn __constructor(e: &Env, name: String, symbol: String) {␊
+            Base::set_metadata(e, 18, name, symbol);␊
         }␊
     }␊
     ␊
@@ -91,8 +105,16 @@ Generated by [AVA](https://avajs.dev).
     ␊
     #[contractimpl]␊
     impl MyToken {␊
-        pub fn __constructor(e: &Env, owner: Address) {␊
-            Base::set_metadata(e, 18, String::from_str(e, "MyToken"), String::from_str(e, "MTK"));␊
+        // deploy this smart contract with the Stellar CLI:␊
+        //␊
+        // stellar contract deploy \\␊
+        // --wasm path/to/file.wasm \\␊
+        // -- \\␊
+        // --name MyToken \\␊
+        // --symbol MTK \\␊
+        // --owner <owner_address>␊
+        pub fn __constructor(e: &Env, name: String, symbol: String, owner: Address) {␊
+            Base::set_metadata(e, 18, name, symbol);␊
             ownable::set_owner(e, &owner);␊
         }␊
     }␊
@@ -158,8 +180,16 @@ Generated by [AVA](https://avajs.dev).
     ␊
     #[contractimpl]␊
     impl MyToken {␊
-        pub fn __constructor(e: &Env, owner: Address) {␊
-            Base::set_metadata(e, 18, String::from_str(e, "MyToken"), String::from_str(e, "MTK"));␊
+        // deploy this smart contract with the Stellar CLI:␊
+        //␊
+        // stellar contract deploy \\␊
+        // --wasm path/to/file.wasm \\␊
+        // -- \\␊
+        // --name MyToken \\␊
+        // --symbol MTK \\␊
+        // --owner <owner_address>␊
+        pub fn __constructor(e: &Env, name: String, symbol: String, owner: Address) {␊
+            Base::set_metadata(e, 18, name, symbol);␊
             ownable::set_owner(e, &owner);␊
         }␊
     }␊
@@ -240,9 +270,18 @@ Generated by [AVA](https://avajs.dev).
     ␊
     #[contractimpl]␊
     impl MyToken {␊
-        pub fn __constructor(e: &Env, recipient: Address) {␊
-            Base::set_metadata(e, 18, String::from_str(e, "MyToken"), String::from_str(e, "MTK"));␊
-            Base::mint(e, &recipient, 1000000000000000000000);␊
+        // deploy this smart contract with the Stellar CLI:␊
+        //␊
+        // stellar contract deploy \\␊
+        // --wasm path/to/file.wasm \\␊
+        // -- \\␊
+        // --name MyToken \\␊
+        // --symbol MTK \\␊
+        // --recipient <recipient_address> \\␊
+        // --premint 1000000000000000000000␊
+        pub fn __constructor(e: &Env, name: String, symbol: String, recipient: Address, premint: i128) {␊
+            Base::set_metadata(e, 18, name, symbol);␊
+            Base::mint(e, &recipient, premint);␊
         }␊
     }␊
     ␊
@@ -271,8 +310,15 @@ Generated by [AVA](https://avajs.dev).
     ␊
     #[contractimpl]␊
     impl MyToken {␊
-        pub fn __constructor(e: &Env) {␊
-            Base::set_metadata(e, 18, String::from_str(e, "MyToken"), String::from_str(e, "MTK"));␊
+        // deploy this smart contract with the Stellar CLI:␊
+        //␊
+        // stellar contract deploy \\␊
+        // --wasm path/to/file.wasm \\␊
+        // -- \\␊
+        // --name MyToken \\␊
+        // --symbol MTK␊
+        pub fn __constructor(e: &Env, name: String, symbol: String) {␊
+            Base::set_metadata(e, 18, name, symbol);␊
         }␊
     }␊
     ␊
@@ -301,8 +347,15 @@ Generated by [AVA](https://avajs.dev).
     ␊
     #[contractimpl]␊
     impl MyToken {␊
-        pub fn __constructor(e: &Env) {␊
-            Base::set_metadata(e, 18, String::from_str(e, "MyToken"), String::from_str(e, "MTK"));␊
+        // deploy this smart contract with the Stellar CLI:␊
+        //␊
+        // stellar contract deploy \\␊
+        // --wasm path/to/file.wasm \\␊
+        // -- \\␊
+        // --name MyToken \\␊
+        // --symbol MTK␊
+        pub fn __constructor(e: &Env, name: String, symbol: String) {␊
+            Base::set_metadata(e, 18, name, symbol);␊
         }␊
     }␊
     ␊
@@ -332,8 +385,16 @@ Generated by [AVA](https://avajs.dev).
     ␊
     #[contractimpl]␊
     impl MyToken {␊
-        pub fn __constructor(e: &Env, owner: Address) {␊
-            Base::set_metadata(e, 18, String::from_str(e, "MyToken"), String::from_str(e, "MTK"));␊
+        // deploy this smart contract with the Stellar CLI:␊
+        //␊
+        // stellar contract deploy \\␊
+        // --wasm path/to/file.wasm \\␊
+        // -- \\␊
+        // --name MyToken \\␊
+        // --symbol MTK \\␊
+        // --owner <owner_address>␊
+        pub fn __constructor(e: &Env, name: String, symbol: String, owner: Address) {␊
+            Base::set_metadata(e, 18, name, symbol);␊
             ownable::set_owner(e, &owner);␊
         }␊
     }␊
@@ -372,8 +433,16 @@ Generated by [AVA](https://avajs.dev).
     ␊
     #[contractimpl]␊
     impl MyToken {␊
-        pub fn __constructor(e: &Env, admin: Address) {␊
-            Base::set_metadata(e, 18, String::from_str(e, "MyToken"), String::from_str(e, "MTK"));␊
+        // deploy this smart contract with the Stellar CLI:␊
+        //␊
+        // stellar contract deploy \\␊
+        // --wasm path/to/file.wasm \\␊
+        // -- \\␊
+        // --name MyToken \\␊
+        // --symbol MTK \\␊
+        // --admin <admin_address>␊
+        pub fn __constructor(e: &Env, name: String, symbol: String, admin: Address) {␊
+            Base::set_metadata(e, 18, name, symbol);␊
             access_control::set_admin(e, &admin);␊
         }␊
     }␊
@@ -413,9 +482,26 @@ Generated by [AVA](https://avajs.dev).
     ␊
     #[contractimpl]␊
     impl MyToken {␊
-        pub fn __constructor(e: &Env, recipient: Address, owner: Address) {␊
-            Base::set_metadata(e, 18, String::from_str(e, "MyToken"), String::from_str(e, "MTK"));␊
-            Base::mint(e, &recipient, 2000000000000000000000);␊
+        // deploy this smart contract with the Stellar CLI:␊
+        //␊
+        // stellar contract deploy \\␊
+        // --wasm path/to/file.wasm \\␊
+        // -- \\␊
+        // --name MyToken \\␊
+        // --symbol MTK \\␊
+        // --recipient <recipient_address> \\␊
+        // --premint 2000000000000000000000 \\␊
+        // --owner <owner_address>␊
+        pub fn __constructor(␊
+            e: &Env,␊
+            name: String,␊
+            symbol: String,␊
+            recipient: Address,␊
+            premint: i128,␊
+            owner: Address,␊
+        ) {␊
+            Base::set_metadata(e, 18, name, symbol);␊
+            Base::mint(e, &recipient, premint);␊
             ownable::set_owner(e, &owner);␊
         }␊
     ␊
@@ -506,16 +592,32 @@ Generated by [AVA](https://avajs.dev).
     ␊
     #[contractimpl]␊
     impl MyToken {␊
+        // deploy this smart contract with the Stellar CLI:␊
+        //␊
+        // stellar contract deploy \\␊
+        // --wasm path/to/file.wasm \\␊
+        // -- \\␊
+        // --name MyToken \\␊
+        // --symbol MTK \\␊
+        // --recipient <recipient_address> \\␊
+        // --premint 2000000000000000000000 \\␊
+        // --admin <admin_address> \\␊
+        // --pauser <pauser_address> \\␊
+        // --upgrader <upgrader_address> \\␊
+        // --minter <minter_address>␊
         pub fn __constructor(␊
             e: &Env,␊
+            name: String,␊
+            symbol: String,␊
             recipient: Address,␊
+            premint: i128,␊
             admin: Address,␊
             pauser: Address,␊
             upgrader: Address,␊
             minter: Address,␊
         ) {␊
-            Base::set_metadata(e, 18, String::from_str(e, "MyToken"), String::from_str(e, "MTK"));␊
-            Base::mint(e, &recipient, 2000000000000000000000);␊
+            Base::set_metadata(e, 18, name, symbol);␊
+            Base::mint(e, &recipient, premint);␊
             access_control::set_admin(e, &admin);␊
             access_control::grant_role_no_auth(e, &admin, &pauser, &Symbol::new(e, "pauser"));␊
             access_control::grant_role_no_auth(e, &admin, &upgrader, &Symbol::new(e, "upgrader"));␊
@@ -616,9 +718,26 @@ Generated by [AVA](https://avajs.dev).
     ␊
     #[contractimpl]␊
     impl CustomToken {␊
-        pub fn __constructor(e: &Env, recipient: Address, owner: Address) {␊
-            Base::set_metadata(e, 18, String::from_str(e, "Custom  $ Token"), String::from_str(e, "MTK"));␊
-            Base::mint(e, &recipient, 2000000000000000000000);␊
+        // deploy this smart contract with the Stellar CLI:␊
+        //␊
+        // stellar contract deploy \\␊
+        // --wasm path/to/file.wasm \\␊
+        // -- \\␊
+        // --name "Custom  $ Token" \\␊
+        // --symbol MTK \\␊
+        // --recipient <recipient_address> \\␊
+        // --premint 2000000000000000000000 \\␊
+        // --owner <owner_address>␊
+        pub fn __constructor(␊
+            e: &Env,␊
+            name: String,␊
+            symbol: String,␊
+            recipient: Address,␊
+            premint: i128,␊
+            owner: Address,␊
+        ) {␊
+            Base::set_metadata(e, 18, name, symbol);␊
+            Base::mint(e, &recipient, premint);␊
             ownable::set_owner(e, &owner);␊
         }␊
     ␊

packages/core/stellar/src/fungible.ts

@@ -89,7 +89,9 @@ export function buildFungible(opts: FungibleOptions): ContractBuilder {
 
 function addBase(c: ContractBuilder, name: string, symbol: string, pausable: boolean) {
   // Set metadata
-  c.addConstructorCode(`Base::set_metadata(e, 18, String::from_str(e, "${name}"), String::from_str(e, "${symbol}"));`);
+  c.addConstructorArgument({ name: 'name', type: 'String', value: name });
+  c.addConstructorArgument({ name: 'symbol', type: 'String', value: symbol });
+  c.addConstructorCode('Base::set_metadata(e, 18, name, symbol);');
 
   // Set token functions
   c.addUseClause('stellar_tokens::fungible', 'Base');
@@ -198,8 +200,9 @@ function addPremint(c: ContractBuilder, amount: string) {
 
     c.addUseClause('soroban_sdk', 'Address');
 
-    c.addConstructorArgument({ name: 'recipient', type: 'Address' });
-    c.addConstructorCode(`Base::mint(e, &recipient, ${premintAbsolute});`);
+    c.addConstructorArgument({ name: 'recipient', type: 'Address', value: '<recipient_address>' });
+    c.addConstructorArgument({ name: 'premint', type: 'i128', value: String(premintAbsolute) });
+    c.addConstructorCode(`Base::mint(e, &recipient, premint);`);
   }
 }
 

packages/core/stellar/src/generate/non-fungible.ts

@@ -8,7 +8,7 @@ const booleans = [true, false];
 const blueprint = {
   name: ['MyToken'],
   symbol: ['MTK'],
-  tokenUri: ['https://www.mytoken.com'],
+  tokenUri: ['https://example.com'],
   burnable: booleans,
   pausable: booleans,
   upgradeable: booleans,