Merge branch 'main' into N-07-consistency

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+<defender-support@openzeppelin.com>.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+<https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+<https://www.contributor-covenant.org/faq>. Translations are available at
+<https://www.contributor-covenant.org/translations>.

CONTRIBUTING.md

@@ -6,14 +6,7 @@ For ANY of the items below, if they seem too complicated or hard, you can always
 
 ## Contribution guidelines
 
-Before starting development, please [create an issue](https://github.com/OpenZeppelin/soroban-contracts/issues/new/choose) to open the discussion, validate that the PR is wanted, and coordinate overall implementation details.
-
-### Coding style
-
-You can check out `[rustfmt.toml](https://github.com/OpenZeppelin/soroban-contracts/rustfmt.toml)`.
-
-Also, we suggest enabling `format-on-save` feature of your code editor.
-
+Before starting development, please [create an issue](https://github.com/OpenZeppelin/stellar-contracts/issues/new/choose) to open the discussion, validate that the PR is wanted, and coordinate overall implementation details.
 
 ## Creating Pull Requests (PRs)
 
@@ -24,13 +17,13 @@ As a contributor, you are expected to fork this repository, work on your own for
 1. Make sure your fork is up to date with the main repository:
 
     ```sh
-    cd soroban-contracts
-    git remote add upstream https://github.com/OpenZeppelin/soroban-contracts.git
+    cd stellar-contracts
+    git remote add upstream https://github.com/OpenZeppelin/stellar-contracts.git
     git fetch upstream
     git pull --rebase upstream main
     ```
 
-    > NOTE: The directory `soroban-contracts` represents your fork's local copy.
+    > NOTE: The directory `stellar-contracts` represents your fork's local copy.
 
 2. Branch out from `main` into `fix/some-bug-short-description-#123` (ex: `fix/typos-in-docs-#123`):
 
@@ -48,7 +41,7 @@ As a contributor, you are expected to fork this repository, work on your own for
     git push origin fix/some-bug-short-description-#123
     ```
 
-4. Run tests and linter. This can be done by running local continuous integration and make sure it passes.
+4. Run tests and linter. This can be done by running local continuous integration and make sure it passes (the tests on GitHub will be run once they are approved by us for the external PRs).
 
     ```bash
     # run tests
@@ -64,7 +57,7 @@ As a contributor, you are expected to fork this repository, work on your own for
     cargo doc --all --no-deps
     ```
 
-5. Go to [OpenZeppelin/soroban-contracts](https://github.com/OpenZeppelin/soroban-contracts) in your web browser and issue a new pull request.
+5. Go to [OpenZeppelin/stellar-contracts](https://github.com/OpenZeppelin/stellar-contracts) in your web browser and issue a new pull request.
     Begin the body of the PR with "Fixes #123" or "Resolves #123" to link the PR to the issue that it is resolving.
     *IMPORTANT* Read the PR template very carefully and make sure to follow all the instructions. These instructions
     refer to some very important conditions that your PR must meet in order to be accepted, such as making sure that all PR checks pass.
@@ -80,8 +73,8 @@ If you are introducing a new feature, please add a new test to ensure that it wo
 
 ## All set
 
-If you have any questions, feel free to post them as an [issue](https://github.com/OpenZeppelin/soroban-contracts/issues).
+If you have any questions, feel free to post them as an [issue](https://github.com/OpenZeppelin/stellar-contracts/issues).
 
-Finally, if you're looking to collaborate and want to find easy tasks to start, look at the issues we marked as ["Good first issue"](https://github.com/OpenZeppelin/soroban-contracts/labels/good%20first%20issue).
+Finally, if you're looking to collaborate and want to find easy tasks to start, look at the issues we marked as ["Good first issue"](https://github.com/OpenZeppelin/stellar-contracts/labels/good%20first%20issue).
 
 Thanks for your time and code!

README.md

@@ -1,12 +1,42 @@
 # OpenZeppelin Stellar Soroban Contracts
 
+> [!Warning]
+> This project is still in a very early and experimental phase. It has never been audited nor thoroughly reviewed for security vulnerabilities. Use in production environments at your own risk.
+
+
+OpenZeppelin Stellar Soroban Contracts is a collection of contracts for the Stellar network. Our goal is to bring Web3 standards under the OpenZeppelin quality by providing a set of high-quality, battle-tested contracts that can be used to build decentralized applications on the Stellar network.
+
+
+## Project Structure
+
+- `contracts/`: Source code
+  - `token/`: Various token types (fungible, non-fungible, etc.)
+  - `utils/`: Utilities for token types (pausable, etc.)
+- `examples/`: Example contracts
+- `docs/`: Documentation
 
 ## Security
 
-> [!Warning]
-> This project is still in a very early and experimental phase. It has never been audited nor thoroughly reviewed for security vulnerabilities. Do not use in production.
+For security concerns, please refer to our [Security Policy](SECURITY.md).
 
 
 ## License
 
 OpenZeppelin Stellar Soroban Contracts are released under the [MIT LICENSE](LICENSE).
+
+
+## Coding Standards
+
+We try to follow the idiomatic Rust style, and enforce `clippy` and `cargo fmt` checks in CI.
+The detailed rules are defined in the [.rustfmt.toml](./rustfmt.toml) and [.clippy.toml](./clippy.toml) files.
+
+
+## Contributing
+
+We welcome contributions from the community!
+
+If you are looking for a good place to start, find a good first issue [here](https://github.com/OpenZeppelin/stellar-contracts/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22good%20first%20issue%22).
+
+You can open an issue for a [bug report](https://github.com/OpenZeppelin/stellar-contracts/issues/new?template=bug_report.yml), [core implementation](https://github.com/OpenZeppelin/stellar-contracts/issues/new?template=core_implementation.yml), or [feature request](https://github.com/OpenZeppelin/stellar-contracts/issues/new?template=feature_request.ymll).
+
+You can find more details in our [Contributing](CONTRIBUTING.md) guide, and please read our [Code of Conduct](CODE_OF_CONDUCT.md).

SECURITY.md

@@ -1,3 +1,32 @@
-# Security
+# Security Policy
 
-Please report any security issues you find to security@openzeppelin.com.
+Security vulnerabilities should be [disclosed](#reporting-a-vulnerability) by email to security@openzeppelin.com.
+
+## Supported Versions
+
+The following versions are currently supported and receive security updates. Alpha, Beta and Release candidates will not receive security updates.
+
+Security patches will be released for the latest minor of a given major release. For example, if an issue is found in versions >=1.13.0 and the latest is 1.14.0, the patch will be released only in version 1.14.1.
+
+Only critical severity bug fixes will be backported to past major releases.
+
+| Version  | Supported          |
+| -------- | ------------------ |
+| >= 0.1.x | :white_check_mark: |
+| <= 0.0.9 | :x:                |
+
+## Reporting a Vulnerability
+
+We're extremely grateful for security researchers and users that report vulnerabilities to us.
+All reports are thoroughly investigated by the project's security team.
+
+Vulnerabilities are reported privately via GitHub's [Security Advisories](https://docs.github.com/en/code-security/security-advisories) feature.
+Please use the following link to submit your vulnerability: [Report a vulnerability](https://github.com/openzeppelin/openzeppelin-monitor/security/advisories/new)
+
+Please see
+[Privately reporting a security vulnerability](https://docs.github.com/en/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability#privately-reporting-a-security-vulnerability)
+for more information on how to submit a vulnerability using GitHub's interface.
+
+## Legal
+
+Smart contracts are a nascent technology and carry a high level of technical risk and uncertainty. OpenZeppelin Contracts is made available under the MIT License, which disclaims all warranties in relation to the project and which limits the liability of those that contribute and maintain the project, including OpenZeppelin. Your use of the project is also governed by the terms found at www.openzeppelin.com/tos (the "Terms"). As set out in the Terms, you are solely responsible for any use of OpenZeppelin Contracts and you assume all risks associated with any such use. This Security Policy in no way evidences or represents an ongoing duty by any contributor, including OpenZeppelin, to correct any flaws or alert you to all or any of the potential risks of utilizing the project.

contracts/token/fungible/src/extensions/burnable/mod.rs

@@ -58,7 +58,7 @@ pub trait FungibleBurnable {
     /// # Errors
     ///
     /// * [`crate::FungibleTokenError::InsufficientBalance`] - When attempting
-    ///   to burn more tokens than `from` current balance.A
+    ///   to burn more tokens than `from` current balance.
     /// * [`crate::FungibleTokenError::InsufficientAllowance`] - When attempting
     ///   to burn more tokens than `from` allowance.
     ///

contracts/token/fungible/src/extensions/burnable/storage.rs

@@ -5,7 +5,7 @@ use crate::{
     storage::{spend_allowance, update},
 };
 
-/// Destroys `amount` of tokens from `account`. Updates the total
+/// Destroys `amount` of tokens from `from`. Updates the total
 /// supply accordingly.
 ///
 /// # Arguments
@@ -18,6 +18,7 @@ use crate::{
 ///
 /// * [`crate::FungibleTokenError::InsufficientBalance`] - When attempting to
 ///   burn more tokens than `from` current balance.
+/// * [`crate::FungibleTokenError::LessThanZero`] - When `amount < 0`.
 ///
 /// # Events
 ///
@@ -33,8 +34,9 @@ pub fn burn(e: &Env, from: &Address, amount: i128) {
     emit_burn(e, from, amount);
 }
 
-/// Destroys `amount` of tokens from `account` using the allowance mechanism.
-/// `amount`is then deducted from `spender` allowance.
+
+/// Destroys `amount` of tokens from `from` using the allowance mechanism.
+/// `amount` is then deducted from `spender` allowance.
 /// Updates the total supply accordingly.
 ///
 /// # Arguments
@@ -51,6 +53,7 @@ pub fn burn(e: &Env, from: &Address, amount: i128) {
 ///   burn more tokens than `from` current balance.
 /// * [`crate::FungibleTokenError::InsufficientAllowance`] - When attempting to
 ///   burn more tokens than `spender`s current allowance.
+/// * [`crate::FungibleTokenError::LessThanZero`] - When `amount < 0`.
 ///
 /// # Events
 ///

contracts/token/fungible/src/extensions/metadata/storage.rs

@@ -1,6 +1,4 @@
-use soroban_sdk::{contracttype, symbol_short, unwrap::UnwrapOptimized, Env, String, Symbol};
-
-use crate::storage::{INSTANCE_EXTEND_AMOUNT, INSTANCE_TTL_THRESHOLD};
+use soroban_sdk::{contracttype, panic_with_error, symbol_short, Env, String, Symbol};
 
 /// Storage key that maps to [`Metadata`]
 pub const METADATA_KEY: Symbol = symbol_short!("METADATA");
@@ -18,15 +16,28 @@ pub struct Metadata {
 /// # Arguments
 ///
 /// * `e` - Access to the Soroban environment.
+///
+/// # Errors
+///
+/// * [`FungibleTokenError::UnsetMetadata`] - When trying to access
+///   uninitialized metadata.
 pub fn get_metadata(e: &Env) -> Metadata {
-    e.storage().instance().get(&METADATA_KEY).unwrap_optimized()
+    e.storage()
+        .instance()
+        .get(&METADATA_KEY)
+        .unwrap_or_else(|| panic_with_error!(e, FungibleTokenError::UnsetMetadata))
 }
 
 /// Returns the token decimals.
 ///
 /// # Arguments
 ///
 /// * `e` - Access to the Soroban environment.
+///
+/// # Errors
+///
+/// * [`FungibleTokenError::UnsetMetadata`] - When trying to access
+///   uninitialized metadata.
 pub fn decimals(e: &Env) -> u32 {
     get_metadata(e).decimals
 }
@@ -36,6 +47,11 @@ pub fn decimals(e: &Env) -> u32 {
 /// # Arguments
 ///
 /// * `e` - Access to the Soroban environment.
+///
+/// # Errors
+///
+/// * [`FungibleTokenError::UnsetMetadata`] - When trying to access
+///   uninitialized metadata.
 pub fn name(e: &Env) -> String {
     get_metadata(e).name
 }
@@ -45,6 +61,11 @@ pub fn name(e: &Env) -> String {
 /// # Arguments
 ///
 /// * `e` - Access to the Soroban environment.
+///
+/// # Errors
+///
+/// * [`FungibleTokenError::UnsetMetadata`] - When trying to access
+///   uninitialized metadata.
 pub fn symbol(e: &Env) -> String {
     get_metadata(e).symbol
 }
@@ -65,6 +86,5 @@ pub fn symbol(e: &Env) -> String {
 /// admin-only authorization.
 pub fn set_metadata(e: &Env, decimals: u32, name: String, symbol: String) {
     let metadata = Metadata { decimals, name, symbol };
-    e.storage().instance().extend_ttl(INSTANCE_TTL_THRESHOLD, INSTANCE_EXTEND_AMOUNT);
     e.storage().instance().set(&METADATA_KEY, &metadata);
 }

contracts/token/fungible/src/extensions/metadata/test.rs

@@ -26,7 +26,7 @@ fn set_and_get_metadata() {
 }
 
 #[test]
-#[should_panic]
+#[should_panic(expected = "Error(Contract, #205)")]
 fn get_unset_metadata() {
     let e = Env::default();
     let address = e.register(MockContract, ());