Add Stellar Contracts (#460)

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

Author: 3 people

.github/workflows/test.yml

@@ -25,6 +25,7 @@ jobs:
         package:
           - solidity
           - cairo
+          - stellar
 
     runs-on: ubuntu-latest
     steps:

packages/core/stellar/.gitignore

@@ -0,0 +1,4 @@
+/cache
+/artifacts
+/contracts/generated
+/openzeppelin-contracts.json

packages/core/stellar/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 0.1.0 (2025-02-25)
+
+- Initial version. ([#460](https://github.com/OpenZeppelin/contracts-wizard/pull/460))

packages/core/stellar/LICENSE

@@ -0,0 +1,8 @@
+OpenZeppelin Contracts Wizard
+Copyright (C) 2021-2025  Zeppelin Group Ltd
+
+This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, version 3.
+
+This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.

packages/core/stellar/NOTICE

@@ -0,0 +1,57 @@
+# OpenZeppelin Contracts Wizard for Stellar
+
+Interactively build a contract out of components from OpenZeppelin Stellar Soroban Contracts. Provide parameters and desired features for the kind of contract that you want, and the Wizard will generate all of the code necessary. The resulting code is ready to be compiled and deployed, or it can serve as a starting point and customized further with application specific logic.
+
+This package provides a programmatic API. For a web interface, see https://wizard.openzeppelin.com/stellar
+
+### Installation
+
+`npm install @openzeppelin/wizard-stellar`
+
+### Contract types
+
+The following contract types are supported:
+- `fungible`
+
+Each contract type has functions/constants as defined below.
+
+### Functions
+
+#### `print`
+```js
+function print(opts?: FungibleOptions): string
+```
+Returns a string representation of a contract generated using the provided options. If `opts` is not provided, uses [`defaults`](#defaults).
+
+#### `defaults`
+```js
+const defaults: Required<FungibleOptions>
+```
+The default options that are used for [`print`](#print).
+
+### Examples
+
+Import the contract type(s) (for example, `fungible`) that you want to use from the `@openzeppelin/wizard-stellar` package:
+
+```js
+import { fungible } from '@openzeppelin/wizard-stellar';
+```
+
+To generate the source code for an Fungible contract with all of the default settings:
+```js
+const contract = fungible.print();
+```
+
+To generate the source code for an Fungible contract with some custom settings:
+```js
+const contract = fungible.print({
+  pausable: true,
+});
+```
+or
+```js
+const contract = fungible.print({
+  ...fungible.defaults,
+  pausable: true,
+});
+```

packages/core/stellar/README.md

@@ -0,0 +1,9 @@
+module.exports = {
+  extensions: ['ts'],
+  require: ['ts-node/register'],
+  watchmode: {
+    ignoreChanges: ['contracts', 'artifacts', 'cache'],
+  },
+  timeout: '10m',
+  workerThreads: false,
+};

packages/core/stellar/ava.config.js

@@ -0,0 +1,33 @@
+{
+  "name": "@openzeppelin/wizard-stellar",
+  "version": "0.1.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",
+  "main": "dist/index.js",
+  "ts:main": "src/index.ts",
+  "files": [
+    "LICENSE",
+    "NOTICE",
+    "/dist",
+    "/src",
+    "!**/*.test.*"
+  ],
+  "scripts": {
+    "prepare": "tsc",
+    "prepublish": "rimraf dist *.tsbuildinfo",
+    "test": "ava",
+    "test:update-snapshots": "ava --update-snapshots",
+    "test:watch": "ava --watch",
+    "version": "node ../../../scripts/bump-changelog.js"
+  },
+  "devDependencies": {
+    "@types/node": "^18.0.0",
+    "@types/semver": "^7.5.7",
+    "ava": "^6.0.0",
+    "rimraf": "^5.0.0",
+    "ts-node": "^10.4.0",
+    "typescript": "^5.0.0",
+    "semver": "^7.6.0"
+  }
+}

packages/core/stellar/package.json

@@ -0,0 +1,40 @@
+import { getSelfArg } from './common-options';
+import type { ContractBuilder } from './contract';
+import type { Access } from './set-access-control';
+import { requireAccessControl } from './set-access-control';
+import { defineFunctions } from './utils/define-functions';
+
+export function addPausable(c: ContractBuilder, access: Access) {
+  c.addUseClause('openzeppelin_pausable', 'self', { alias: 'pausable' });
+  c.addUseClause('openzeppelin_pausable', 'Pausable');
+
+  const pausableTrait = {
+    name: 'Pausable',
+    for: c.name,
+    tags: ['contractimpl'],
+    section: 'Utils',
+  };
+
+  c.addFunction(pausableTrait, functions.paused);
+  c.addFunction(pausableTrait, functions.pause);
+  c.addFunction(pausableTrait, functions.unpause);
+
+  requireAccessControl(c, pausableTrait, functions.pause, access, 'caller');
+  requireAccessControl(c, pausableTrait, functions.unpause, access, 'caller');
+}
+
+const functions = defineFunctions({
+  paused: {
+    args: [getSelfArg()],
+    returns: 'bool',
+    code: ['pausable::paused(e)'],
+  },
+  pause: {
+    args: [getSelfArg(), { name: 'caller', type: 'Address' }],
+    code: ['pausable::pause(e, &caller)'],
+  },
+  unpause: {
+    args: [getSelfArg(), { name: 'caller', type: 'Address' }],
+    code: ['pausable::unpause(e, &caller)'],
+  },
+});

packages/core/stellar/src/add-pausable.ts

@@ -0,0 +1,30 @@
+import type { CommonContractOptions } from './common-options';
+import type { FungibleOptions } from './fungible';
+import { printFungible, defaults as fungibledefaults } from './fungible';
+
+export interface WizardContractAPI<Options extends CommonContractOptions> {
+  /**
+   * Returns a string representation of a contract generated using the provided options. If opts is not provided, uses `defaults`.
+   */
+  print: (opts?: Options) => string;
+
+  /**
+   * The default options that are used for `print`.
+   */
+  defaults: Required<Options>;
+}
+
+export interface AccessControlAPI<Options extends CommonContractOptions> {
+  /**
+   * Whether any of the provided options require access control to be enabled. If this returns `true`, then calling `print` with the
+   * same options would cause the `access` option to default to `'ownable'` if it was `undefined` or `false`.
+   */
+  isAccessControlRequired: (opts: Partial<Options>) => boolean;
+}
+
+export type Fungible = WizardContractAPI<FungibleOptions>; // TODO add AccessControlAPI<FungibleOptions> when access control is implemented, if useful
+
+export const fungible: Fungible = {
+  print: printFungible,
+  defaults: fungibledefaults,
+};