Soroban Test Helpers

A collection of utilities and macros to simplify testing Soroban smart contracts.

Features

This crate provides helper utilities for writing cleaner, more concise tests for Soroban smart contracts.

• #[test] attribute macro - Simplifies test setup by:
  • Automatically initializing the Soroban environment
  • Generating test addresses as needed
  • Reducing test boilerplate

Installation

Add this to your Cargo.toml:

[dependencies]
soroban-test-helpers = "0.2.4"

Usage Example

use soroban_sdk::{Address, Env};
use soroban_test_helpers::test;

// Original test setup
#[test]
fn original_test_approach() {
    let env = Env::default();
    let user = Address::generate(&env);
    let contract = Address::generate(&env);
    
    // Test logic...
}

// Simplified test using soroban-test-helpers
#[test]
fn simplified_test(env: Env, user: Address, contract: Address) {
    // Test logic...
    // Environment setup is handled automatically!
}

How It Works

The #[test] attribute macro transforms your test function by:

1. Creating an environment using Default::default() for the first parameter
2. Generating subsequent address parameters using Address::generate(&env)
3. Ensuring your test code runs with these automatically created values

This significantly reduces the amount of boilerplate code in your tests.

Contributing

We welcome contributions from the community! Here's how you can get involved:

1. Fork the repository
2. Create your feature branch
3. Commit your changes
4. Push to the branch
5. Create a Pull Request

If you are looking for a good place to start, find a good first issue here.

You can open an issue for a bug report, feature request, or documentation request.

You can find more details in our Contributing guide.

Please read our Code of Conduct and check the Security Policy for reporting vulnerabilities.

License

This project is licensed under the GNU Affero General Public License v3.0 - see the LICENSE file for details.

Security

If you discover a security vulnerability within this project, please see SECURITY.md for instructions on responsible disclosure.

Maintainers

See CODEOWNERS file for the list of project maintainers.