Skip to content

feat: add metadata field and accessor to commitment #540

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
1nonlypiece merged 3 commits into from
May 28, 2026
Merged

feat: add metadata field and accessor to commitment #540

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3e25275
feat: add metadata field and accessor to commitment
DeePrincipal-dev-lang May 28, 2026
d5e0bb5
Merge branch 'master' into feature/commitment-metadata-field
DeePrincipal-dev-lang May 28, 2026
5ff31cb
chore: merge master and resolve conflicts (auto: favor PR)
1nonlypiece May 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions contracts/escrow/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,9 @@ pub struct Commitment {
/// Compliance score 0..=100 recorded by the attestation engine.
pub compliance_score: u32,
pub created_at: u64,
/// Arbitrary key-value metadata supplied at creation time (e.g. risk notes,
/// off-chain context). Keys and values are both `String`. Empty by default.
pub metadata: Map<String, String>,
}

/// Errors returned to the caller. Numeric codes are stable and surfaced by the
Expand Down Expand Up @@ -305,6 +308,7 @@ impl EscrowContract {
risk: RiskProfile,
duration_days: u32,
penalty_bps: u32,
metadata: Map<String, String>,
) -> Result<u64, Error> {
Self::require_init(&env)?;
Self::require_not_paused(&env)?;
Expand Down Expand Up @@ -414,6 +418,7 @@ impl EscrowContract {
penalty_bps,
compliance_score: 100,
created_at: now,
metadata,
};

env.storage()
Expand Down
22 changes: 12 additions & 10 deletions contracts/escrow/src/test.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,8 @@ fn unauthorized_cannot_rotate_admin_or_fee_recipient() {

use super::*;
use soroban_sdk::{
testutils::{Address as _, Events, Ledger as _},
map,
testutils::{Address as _, Ledger as _},
token::{StellarAssetClient, TokenClient},
Address, Bytes, BytesN, Env, String,
};
Expand Down Expand Up @@ -227,7 +228,7 @@ fn create_and_fund_locks_funds() {

let id = f
.client
.create_commitment(&owner, &f.asset, &1_000, &RiskProfile::Balanced, &30, &300);
.create_commitment(&owner, &f.asset, &1_000, &RiskProfile::Balanced, &30, &300, &Map::new(&f.env));
let c = f.client.get_commitment(&id);
assert_eq!(c.status, EscrowStatus::Created);
assert_eq!(c.amount, 1_000);
Expand All @@ -244,7 +245,7 @@ fn release_after_maturity_pays_principal_plus_yield() {
fund_owner(&f, &owner, 1_000);
let id = f
.client
.create_commitment(&owner, &f.asset, &1_000, &RiskProfile::Safe, &10, &200);
.create_commitment(&owner, &f.asset, &1_000, &RiskProfile::Safe, &10, &200, &Map::new(&f.env));
f.client.fund_escrow(&id);

let admin_deposit = 10;
Expand Down Expand Up @@ -310,7 +311,7 @@ fn release_before_maturity_fails() {
fund_owner(&f, &owner, 1_000);
let id = f
.client
.create_commitment(&owner, &f.asset, &1_000, &RiskProfile::Safe, &10, &200);
.create_commitment(&owner, &f.asset, &1_000, &RiskProfile::Safe, &10, &200, &Map::new(&f.env));
f.client.fund_escrow(&id);

let res = f.client.try_release(&id);
Expand Down Expand Up @@ -372,7 +373,7 @@ fn refund_applies_penalty_to_fee_recipient() {
// 5% penalty.
let id = f
.client
.create_commitment(&owner, &f.asset, &1_000, &RiskProfile::Aggressive, &30, &500);
.create_commitment(&owner, &f.asset, &1_000, &RiskProfile::Aggressive, &30, &500, &Map::new(&f.env));
f.client.fund_escrow(&id);

let refunded = f.client.refund(&id);
Expand All @@ -389,7 +390,7 @@ fn dispute_freezes_then_admin_resolves() {
fund_owner(&f, &owner, 1_000);
let id = f
.client
.create_commitment(&owner, &f.asset, &1_000, &RiskProfile::Balanced, &30, &300);
.create_commitment(&owner, &f.asset, &1_000, &RiskProfile::Balanced, &30, &300, &Map::new(&f.env));
f.client.fund_escrow(&id);

f.client
Expand All @@ -413,7 +414,7 @@ fn create_rejects_invalid_amount() {
let owner = Address::generate(&f.env);
let res =
f.client
.try_create_commitment(&owner, &f.asset, &0, &RiskProfile::Safe, &30, &200);
.try_create_commitment(&owner, &f.asset, &0, &RiskProfile::Safe, &30, &200, &Map::new(&f.env));
assert_eq!(res, Err(Ok(Error::InvalidAmount)));
}

Expand All @@ -428,6 +429,7 @@ fn create_rejects_excessive_penalty() {
&RiskProfile::Safe,
&30,
&20_000,
&Map::new(&f.env),
);
assert_eq!(res, Err(Ok(Error::PenaltyTooHigh)));
}
Expand All @@ -439,7 +441,7 @@ fn record_attestation_clamps_score() {
let attestor = Address::generate(&f.env);
let id = f
.client
.create_commitment(&owner, &f.asset, &1_000, &RiskProfile::Balanced, &30, &300);
.create_commitment(&owner, &f.asset, &1_000, &RiskProfile::Balanced, &30, &300, &Map::new(&f.env));
f.client.record_attestation(&id, &attestor, &250);
assert_eq!(f.client.get_commitment(&id).compliance_score, 100);
}
Expand All @@ -450,10 +452,10 @@ fn owner_index_tracks_commitments() {
let owner = Address::generate(&f.env);
let a = f
.client
.create_commitment(&owner, &f.asset, &100, &RiskProfile::Safe, &30, &200);
.create_commitment(&owner, &f.asset, &100, &RiskProfile::Safe, &30, &200, &Map::new(&f.env));
let b = f
.client
.create_commitment(&owner, &f.asset, &200, &RiskProfile::Balanced, &30, &300);
.create_commitment(&owner, &f.asset, &200, &RiskProfile::Balanced, &30, &300, &Map::new(&f.env));
let ids = f.client.get_owner_commitments(&owner);
assert_eq!(ids.len(), 2);
assert_eq!(ids.get(0).unwrap(), a);
Expand Down
Loading