Stellar: Stablecoin (#575)

Co-authored-by: Eric Lau <[email protected]>

Author: brozorec

.changeset/ninety-readers-kneel.md

@@ -0,0 +1,7 @@
+---
+'@openzeppelin/wizard-stellar': minor
+---
+
+Add Stablecoin with Limitations and Access Control (ownable and roles).
+- **Breaking changes**:
+  - Use OpenZeppelin Stellar Soroban Contracts v0.3.0

.changeset/proud-brooms-happen.md

@@ -0,0 +1,7 @@
+---
+'@openzeppelin/wizard-mcp': patch
+---
+
+Stellar: Add Stablecoin with Limitations and Access Control (ownable and roles).
+- **Potentially breaking changes**:
+  - Use OpenZeppelin Stellar Soroban Contracts v0.3.0

.changeset/soft-points-obey.md

@@ -0,0 +1,5 @@
+---
+'@openzeppelin/wizard-common': patch
+---
+
+Stellar: Add Stablecoin with Limitations and Access Control (ownable and roles).

packages/common/src/ai/descriptions/stellar.ts

@@ -5,10 +5,13 @@ export const stellarPrompts = {
   Fungible: 'Make a fungible token per the Fungible Token Standard, compatible with SEP-41, similar to ERC-20.',
   NonFungible:
     'Make a non-fungible token per the Non-Fungible Token Standard, compatible with SEP-50, similar to ERC-721.',
+  Stablecoin: 'Make a stablecoin that uses Fungible Token Standard, compatible with SEP-41.',
 };
 
 export const stellarCommonDescriptions = {
   upgradeable: 'Whether the contract can be upgraded.',
+  access:
+    'The type of access control to provision. Ownable is a simple mechanism with a single account authorized for all privileged actions. Roles is a flexible mechanism with a separate role for each privileged action. A role can have many authorized accounts.',
 };
 
 export const stellarFungibleDescriptions = {
@@ -20,3 +23,8 @@ export const stellarNonFungibleDescriptions = {
   consecutive: 'To batch mint NFTs instead of minting them individually (sequential minting is mandatory).',
   sequential: 'Whether the IDs of the minted NFTs will be sequential.',
 };
+
+export const stellarStablecoinDescriptions = {
+  limitations: 'Whether to restrict certain users from transferring tokens, either via allowing or blocking them.',
+  premint: 'The number of tokens to premint for the deployer.',
+};

packages/core/stellar/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)'],
   },
 });

packages/core/stellar/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',
+  });
 }

packages/core/stellar/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,
 };

packages/core/stellar/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');

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

@@ -9,7 +9,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Stellar Soroban Contracts ^0.2.0␊
+    // Compatible with OpenZeppelin Stellar Soroban Contracts ^0.3.0␊
     #![no_std]␊
     ␊
     #[contract]␊
@@ -21,7 +21,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Stellar Soroban Contracts ^0.2.0␊
+    // Compatible with OpenZeppelin Stellar Soroban Contracts ^0.3.0␊
     #![no_std]␊
     ␊
     #[contract]␊
@@ -40,7 +40,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Stellar Soroban Contracts ^0.2.0␊
+    // Compatible with OpenZeppelin Stellar Soroban Contracts ^0.3.0␊
     #![no_std]␊
     ␊
     #[contract]␊
@@ -59,7 +59,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Stellar Soroban Contracts ^0.2.0␊
+    // Compatible with OpenZeppelin Stellar Soroban Contracts ^0.3.0␊
     #![no_std]␊
     ␊
     #[contract]␊
@@ -81,7 +81,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Stellar Soroban Contracts ^0.2.0␊
+    // Compatible with OpenZeppelin Stellar Soroban Contracts ^0.3.0␊
     #![no_std]␊
     ␊
     #[contract]␊
@@ -103,7 +103,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Stellar Soroban Contracts ^0.2.0␊
+    // Compatible with OpenZeppelin Stellar Soroban Contracts ^0.3.0␊
     #![no_std]␊
     ␊
     use some::library::SomeLibrary;␊
@@ -117,7 +117,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Stellar Soroban Contracts ^0.2.0␊
+    // Compatible with OpenZeppelin Stellar Soroban Contracts ^0.3.0␊
     #![no_std]␊
     ␊
     use some::library::{Misc, SomeLibrary};␊
@@ -131,7 +131,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Stellar Soroban Contracts ^0.2.0␊
+    // Compatible with OpenZeppelin Stellar Soroban Contracts ^0.3.0␊
     #![no_std]␊
     ␊
     use another::library::{self as custom1, self as custom2, AnotherLibrary};␊
@@ -146,7 +146,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Stellar Soroban Contracts ^0.2.0␊
+    // Compatible with OpenZeppelin Stellar Soroban Contracts ^0.3.0␊
     ␊
     //! Some documentation␊
     #![no_std]␊
@@ -160,7 +160,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Stellar Soroban Contracts ^0.2.0␊
+    // Compatible with OpenZeppelin Stellar Soroban Contracts ^0.3.0␊
     ␊
     //! # Security␊
     //!␊
@@ -176,7 +176,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Stellar Soroban Contracts ^0.2.0␊
+    // Compatible with OpenZeppelin Stellar Soroban Contracts ^0.3.0␊
     ␊
     //! Some documentation␊
     ␊