Skip to content

README.md

Latest commit

 

History

History
79 lines (58 loc) · 2.66 KB

README.md

File metadata and controls

79 lines (58 loc) · 2.66 KB
Raw

niffyinsure — Soroban smart contract

Parametric insurance with DAO-governed claim resolution, compiled to WASM for Stellar Soroban.

Prerequisites

Tool Version
Rust (stable) ≥ 1.81 (MSRV)
wasm32 target rustup target add wasm32-unknown-unknown
Stellar CLI ≥ 21 (cargo install --locked stellar-cli)

Produced with rustc 1.94.0 (stable, 2026-03-02).

Build

# from repo root or contracts/niffyinsure/
cargo build --target wasm32-unknown-unknown --release

# artifact
target/wasm32-unknown-unknown/release/niffyinsure.wasm

Or via Makefile:

make build      # compile
make sha        # build + print SHA-256

Test

cargo test

Tests run on the native target using soroban-sdk's testutils feature.

Deploy

stellar contract deploy \
  --wasm target/wasm32-unknown-unknown/release/niffyinsure.wasm \
  --network testnet \
  --source <ACCOUNT_SECRET_KEY>

Record the contract ID and the SHA-256 from make sha in your release notes so deployed binaries are traceable.

Common failure modes

Symptom Cause Fix
error[E0463]: can't find crate for std Missing wasm32 target rustup target add wasm32-unknown-unknown
soroban_sdk version conflict Mismatched SDK pin Ensure Cargo.lock is committed and =23.5.3 is pinned
stellar contract deploy fails Wrong CLI version stellar --version must be ≥ 21
Tests fail with no_std errors Running cargo test --target wasm32 Tests run on native; omit --target flag

Quote behavior (generate_premium)

  • generate_premium is a quote-only entrypoint: it does not increment claim_id, mutate policy state, or transfer funds.
  • The response is a structured PremiumQuote with total_premium, optional line_items (for UX), and valid_until_ledger.
  • MVP does not emit quote events to reduce event spam, avoid accidental PII leakage, and stay within Soroban payload limits.
  • Validation failures return typed error codes; API layers can map these using quote_error_message(code) for support-friendly messages.
  • Off-chain quote caches must enforce valid_until_ledger: if admin-adjustable multipliers are introduced later, stale cached quotes must be discarded and re-simulated before bind.

Module map

src/
  lib.rs       # contract entry, initialize
  types.rs     # Policy, Claim, VoteOption, ClaimStatus
  storage.rs   # DataKey, typed read/write helpers
  premium.rs   # compute_premium (risk factors → stroops)
  policy.rs    # generate_premium, initiate, renew, terminate
  claim.rs     # file_claim, vote_on_claim
  token.rs     # token transfer wrapper