smart-contracts

Files (28)

• SKILL.md
• Cargo.lock · examples/hello-world/
• Cargo.toml · examples/hello-world/
• lib.rs · examples/hello-world/src/
• test.rs · examples/hello-world/src/
• test_events_emitted.1.json · examples/hello-world/test_snapshots/test/
• test_increment.1.json · examples/hello-world/test_snapshots/test/
• test_increment_auth_required.1.json · examples/hello-world/test_snapshots/test/
• test_increment_multiple.1.json · examples/hello-world/test_snapshots/test/
• test_initial_state.1.json · examples/hello-world/test_snapshots/test/
• test_storage_ttl_extended_on_write.1.json · examples/hello-world/test_snapshots/test/
• Cargo.lock · examples/token/
• Cargo.toml · examples/token/
• lib.rs · examples/token/src/
• test.rs · examples/token/src/
• test_approve.1.json · examples/token/test_snapshots/test/
• test_balance_defaults_to_zero.1.json · examples/token/test_snapshots/test/
• test_burn.1.json · examples/token/test_snapshots/test/
• test_burn_insufficient_balance.1.json · examples/token/test_snapshots/test/
• test_metadata.1.json · examples/token/test_snapshots/test/
• test_mint.1.json · examples/token/test_snapshots/test/
• test_mint_auth_required.1.json · examples/token/test_snapshots/test/
• test_mint_invalid_amount_rejected.1.json · examples/token/test_snapshots/test/
• test_mint_multiple_recipients.1.json · examples/token/test_snapshots/test/
• test_total_supply_initial.1.json · examples/token/test_snapshots/test/
• test_transfer.1.json · examples/token/test_snapshots/test/
• test_transfer_from.1.json · examples/token/test_snapshots/test/
• test_transfer_insufficient_balance.1.json · examples/token/test_snapshots/test/

SKILL.md (first lines)

# Smart Contracts (Soroban)

## Source Files

| File | Contents |
|------|----------|
| `contracts/hello-world/src/lib.rs` | Minimal contract scaffold |
| `contracts/hello-world/src/test.rs` | Unit + auth + event tests |
| `contracts/token/src/lib.rs` | Full SEP-41 token |
| `contracts/token/src/test.rs` | Token unit + integration tests |

---

## Testing Guide

### Setup

```rust
#![cfg(test)]
extern crate std;
use soroban_sdk::{
    testutils::{Address as _, Events},
    Address, Env, String, Symbol,
};
```

### Pattern 1: Unit Test with Setup Helper

Extract shared setup into a helper function:

```rust
fn setup() -> (Env, Address, Address, MyContractClient<'static>) {
    let env = Env::default();
    env.mock_all_auths();
    let admin = Address::generate(&env);
    let user = Address::generate(&env);
    let contract_id = env.register(MyContract, (&admin, 1000u32));
    let client = MyContractClient::new(&env, &contract_id);
    (env, admin, user, client)
}

#[test]
fn test_initial_state() {
    let (_, _, _, client) = setup();
    assert_eq!(client.get_count(), 0);
}
```

### Pattern 2: Auth Testing (without mock_all_auths)

Test that only authorized callers can invoke privileged functions:

```rust
#[test]
fn test_auth_required() {
    let env = Env::default();
    // Do NOT call mock_all_auths() — test auth failures
    let admin = Address::generate(&env);
    let attacker = Address::generate(&env);
    let contract_id = env.register(MyContract, (&admin,));
    let client = MyContractClient::new(&env, &contract_id);

    let result = std::panic::catch_unwind(std::panic::AssertUnwindSafe(|| {
        client.admin_only(&attacker); // attacker has no auth
    }));
    assert!(result.is_err());
}

#[test]
fn test_auth_passes() {
    let env = Env::default();
    env.mock_all_auths();
    let admin = Address::generate(&env);
    let contract_id = env.register(MyContract, (&admin,));
    let client = MyContractClient::new(&env, &contract_id);

    client.admin_only(&admin); // should not panic
}
```

### Pattern 3: Event Assertions

```rust
#[test]
fn test_events_emitted() {
    let env = Env::default();
    env.mock_all_auths();
    let admin = Address::generate(&env);
    let contract_id = env.register(MyContract, (&admin,));
    let client = MyContractClient::new(&env, &contract_id);

    client.do_thing();

    let events = env.events().all();
    assert!(!events.is_empty());

    let (event_contract, topics, data) = &events[0];
    assert_eq!(*event_contract, contract_id);
    // topics[0] is the event type symbol
    assert_eq!(topics.get(0).unwrap(), Symbol::new(&env, "DONE"));
}
```

### Pattern 4: Error / Panic Testing

```rust
#[test]
#[should_panic(expected = "HostError")]
fn test_rejects_invalid_input() {
    let env = Env::default();
    env.mock_all_auths();
    let (_, _, client) = setup();

    client.try_v1(); // intentionally bad input
}
```

### Pattern 5: Contract Storage / TTL Testing

From rylsherdamz-rgb/stellar-forge, MIT.

More from rylsherdamz-rgb/stellar-forge