Merge pull request #296 from Emeka000/good

entrypoints

Author: jhayniffy

EVENT_DICTIONARY.md

@@ -221,3 +221,32 @@ Emitted when voting reaches majority **or** the vote window expires.
 - Claim description text.
 - Voter lists (derive from `vote_cast` stream).
 - PII of any kind.
+
+---
+
+## Read-only entrypoints
+
+These entrypoints are callable via Soroban simulation without authentication.
+They perform **no storage reads or writes** and are safe to call repeatedly.
+
+### `version` — deployed contract semver
+
+Returns the semver string stamped at build time from `Cargo.toml` (e.g. `"0.1.0"`).
+No events emitted; no state mutation; no auth required.
+
+| Property | Value |
+|----------|-------|
+| Auth required | None |
+| State mutation | None |
+| Return type | `String` — pure semver (`MAJOR.MINOR.PATCH`), no network or environment prefix |
+| Callable via simulation | Yes |
+
+**Backend usage:** the deployment registry calls `version()` via simulation immediately
+after each deploy and records the result. If the returned value does not match the
+expected `CARGO_PKG_VERSION` baked into the release artifact, the registry logs an error
+and the deploy pipeline should halt and alert.
+
+```
+GET /chain/contract-version?source_account=G…
+→ { "version": "0.1.0", "minResourceFee": "…" }
+```

contracts/niffyinsure/src/lib.rs

@@ -92,6 +92,12 @@ impl NiffyInsure {
         storage::get_admin(&env)
     }
 
+    /// Returns the semver version string stamped at build time from `Cargo.toml`.
+    /// Read-only: no storage access, no auth required. Safe to call via simulation.
+    pub fn version(env: Env) -> soroban_sdk::String {
+        soroban_sdk::String::from_str(&env, env!("CARGO_PKG_VERSION"))
+    }
+
     /// Read-only: balance of the default payout token held by this contract (payout reserve).
     /// Matches funds available for `process_claim` for the configured default asset.
     pub fn get_treasury_balance(env: Env) -> i128 {

contracts/niffyinsure/tests/version.rs

@@ -0,0 +1,44 @@
+#![cfg(test)]
+
+use niffyinsure::NiffyInsureClient;
+use soroban_sdk::{testutils::Address as _, Address, Env};
+
+#[test]
+fn version_returns_nonempty_semver_string() {
+    let env = Env::default();
+    let contract_id = env.register(niffyinsure::NiffyInsure, ());
+    let client = NiffyInsureClient::new(&env, &contract_id);
+
+    let v = client.version();
+    let v_str = v.to_string();
+    assert!(!v_str.is_empty(), "version() must not be empty");
+    assert_eq!(
+        v_str,
+        env!("CARGO_PKG_VERSION"),
+        "version() must match Cargo.toml"
+    );
+}
+
+#[test]
+fn version_requires_no_auth_and_no_init() {
+    // Contract is not initialised — version() must succeed regardless.
+    let env = Env::default();
+    let contract_id = env.register(niffyinsure::NiffyInsure, ());
+    let client = NiffyInsureClient::new(&env, &contract_id);
+    let _ = client.version(); // must not panic
+}
+
+#[test]
+fn version_is_idempotent() {
+    let env = Env::default();
+    env.mock_all_auths();
+    let contract_id = env.register(niffyinsure::NiffyInsure, ());
+    let client = NiffyInsureClient::new(&env, &contract_id);
+    let admin = Address::generate(&env);
+    let token = Address::generate(&env);
+    client.initialize(&admin, &token);
+
+    let v1 = client.version();
+    let v2 = client.version();
+    assert_eq!(v1, v2);
+}

contracts/premium_calculator/src/lib.rs

@@ -56,6 +56,12 @@ impl PremiumCalculator {
         storage::get_table(&env).map(|t| t.version).unwrap_or(0)
     }
 
+    /// Returns the semver version string stamped at build time from `Cargo.toml`.
+    /// Read-only: no storage access, no auth required. Safe to call via simulation.
+    pub fn version(env: Env) -> soroban_sdk::String {
+        soroban_sdk::String::from_str(&env, env!("CARGO_PKG_VERSION"))
+    }
+
     /// Admin: replace the multiplier table. Version must be strictly greater.
     pub fn update_table(env: Env, new_table: MultiplierTable) -> Result<(), CalcError> {
         let admin = storage::get_admin(&env).ok_or(CalcError::NotInitialized)?;
@@ -164,3 +170,50 @@ fn mul_ratio(amount: i128, num: i128, den: i128) -> Result<i128, CalcError> {
 fn checked_sub(a: i128, b: i128) -> Result<i128, CalcError> {
     a.checked_sub(b).ok_or(CalcError::Overflow)
 }
+
+// ── Tests ──────────────────────────────────────────────────────────────────────
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use soroban_sdk::{testutils::Address as _, Address, Env};
+
+    #[test]
+    fn version_returns_nonempty_semver_string() {
+        let env = Env::default();
+        let contract_id = env.register(PremiumCalculator, ());
+        let client = PremiumCalculatorClient::new(&env, &contract_id);
+
+        let v = client.version();
+        let v_str = v.to_string();
+        assert!(!v_str.is_empty(), "version() must not be empty");
+        assert_eq!(
+            v_str,
+            env!("CARGO_PKG_VERSION"),
+            "version() must match Cargo.toml"
+        );
+    }
+
+    #[test]
+    fn version_requires_no_auth_and_no_init() {
+        // Contract is not initialised — version() must succeed regardless.
+        let env = Env::default();
+        let contract_id = env.register(PremiumCalculator, ());
+        let client = PremiumCalculatorClient::new(&env, &contract_id);
+        let _ = client.version(); // must not panic
+    }
+
+    #[test]
+    fn version_is_idempotent() {
+        let env = Env::default();
+        env.mock_all_auths();
+        let contract_id = env.register(PremiumCalculator, ());
+        let client = PremiumCalculatorClient::new(&env, &contract_id);
+        let admin = Address::generate(&env);
+        client.initialize(&admin);
+
+        let v1 = client.version();
+        let v2 = client.version();
+        assert_eq!(v1, v2);
+    }
+}