Skip to content

Needed changes to use the latest record_tags.move version #228

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
itsyaasir merged 4 commits into from
Mar 24, 2026
Merged

Needed changes to use the latest record_tags.move version #228

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0437f1a
First part of needed changes to use the latest record_tags.move version
chrisgitiota Mar 19, 2026
7e9f4bf
Move sources are compilable now - some of the tests are failing though
chrisgitiota Mar 20, 2026
8b8db89
Fixed issue "is_in_use() is inverted" and removed several warnings
chrisgitiota Mar 23, 2026
49817ae
Renamed fun args `record_tags` to `role_tags` for `create_role` and `…
chrisgitiota Mar 23, 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
75 changes: 36 additions & 39 deletions audit-trail-move/sources/audit_trail.move
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,12 @@ use audit_trail::{
},
permission::{Self, Permission},
record::{Self, Record},
record_tags::{Self, RecordTags}
record_tags::{Self, RoleTags, TagRegistry}
};
use iota::{
clock::{Self, Clock},
event,
linked_table::{Self, LinkedTable},
vec_map::{Self, VecMap},
vec_set::VecSet
};
use std::string::String;
Expand Down Expand Up @@ -87,11 +86,11 @@ public struct AuditTrail<D: store + copy> has key, store {
/// LinkedTable mapping sequence numbers to records
records: LinkedTable<u64, Record<D>>,
/// Canonical list of tags that may be attached to records in this trail with their combined usage counts
tags: VecMap<String, u64>,
tags: record_tags::TagRegistry,
/// Deletion locking rules
locking_config: LockingConfig,
/// A list of role definitions consisting of a unique role specifier and a list of associated permissions
roles: RoleMap<Permission, RecordTags>,
roles: RoleMap<Permission, RoleTags>,
/// Set at creation, cannot be changed
immutable_metadata: Option<ImmutableMetadata>,
/// Can be updated by holders of MetadataUpdate permission
Expand Down Expand Up @@ -216,7 +215,7 @@ public fun create<D: store + copy>(
ctx,
);

let tags = record_tags::new_usage(tags);
let tags = record_tags::new_tag_registry(tags);

let trail = AuditTrail {
id: trail_uid,
Expand Down Expand Up @@ -276,7 +275,7 @@ fun assert_record_tag_allowed<D: store + copy>(
};

let requested_tag = option::borrow(tag);
assert!(record_tags::is_defined(&self.tags, requested_tag), ERecordTagNotDefined);
assert!(record_tags::contains(&self.tags, requested_tag), ERecordTagNotDefined);
assert!(record_tags::role_allows(&self.roles, cap, requested_tag), ERecordTagNotAllowed);
}

Expand Down Expand Up @@ -312,7 +311,7 @@ public fun add_record<D: store + copy>(
let seq = self.sequence_number;

if (record_tag.is_some()) {
record_tags::increment_tag_usage(&mut self.tags, option::borrow(&record_tag));
record_tags::increment_usage_count(&mut self.tags, option::borrow(&record_tag));
};

let record = record::new(
Expand Down Expand Up @@ -365,7 +364,7 @@ public fun delete_record<D: store + copy + drop>(

let record = linked_table::remove(&mut self.records, sequence_number);
if (record::tag(&record).is_some()) {
record_tags::decrement_tag_usage(&mut self.tags, option::borrow(record::tag(&record)));
record_tags::decrement_usage_count(&mut self.tags, option::borrow(record::tag(&record)));
};
record::destroy(record);

Expand Down Expand Up @@ -407,7 +406,7 @@ public fun delete_records_batch<D: store + copy + drop>(
let (sequence_number, record) = self.records.pop_front();

if (record::tag(&record).is_some()) {
record_tags::decrement_tag_usage(&mut self.tags, option::borrow(record::tag(&record)));
record_tags::decrement_usage_count(&mut self.tags, option::borrow(record::tag(&record)));
};

record.destroy();
Expand Down Expand Up @@ -455,7 +454,7 @@ public fun delete_audit_trail<D: store + copy>(
created_at: _,
sequence_number: _,
records,
mut tags,
tags,
locking_config: _,
roles,
immutable_metadata: _,
Expand All @@ -464,12 +463,9 @@ public fun delete_audit_trail<D: store + copy>(
} = self;

roles.destroy();

linked_table::destroy_empty(records);
while (!vec_map::is_empty(&tags)) {
let (_, _) = vec_map::pop(&mut tags);
};
vec_map::destroy_empty(tags);
tags.destroy();

object::delete(id);

event::emit(AuditTrailDeleted { trail_id, timestamp });
Expand Down Expand Up @@ -610,8 +606,8 @@ public fun add_record_tag<D: store + copy>(

self.roles.assert_capability_valid(cap, &permission::add_record_tags(), clock, ctx);

assert!(!iota::vec_map::contains(&self.tags, &tag), ERecordTagAlreadyDefined);
vec_map::insert(&mut self.tags, tag, 0);
assert!(!self.tags.contains(&tag), ERecordTagAlreadyDefined);
self.tags.insert_tag(tag, 0);
}

/// Removes a record tag from the trail registry if it is not used by any record.
Expand All @@ -626,9 +622,10 @@ public fun remove_record_tag<D: store + copy>(

self.roles.assert_capability_valid(cap, &permission::delete_record_tags(), clock, ctx);

assert!(iota::vec_map::contains(&self.tags, &tag), ERecordTagNotDefined);
assert!(record_tags::usage_count(&self.tags, &tag) == 0, ERecordTagInUse);
vec_map::remove(&mut self.tags, &tag);
assert!(self.tags.contains(&tag), ERecordTagNotDefined);
assert!(!self.tags.is_in_use(&tag), ERecordTagInUse);

self.tags.remove_tag(&tag);
}

// ===== Role and Capability Administration =====
Expand All @@ -639,31 +636,31 @@ public fun create_role<D: store + copy>(
cap: &Capability,
role: String,
permissions: VecSet<Permission>,
record_tags: Option<RecordTags>,
role_tags: Option<RoleTags>,
clock: &Clock,
ctx: &mut TxContext,
) {
assert!(self.version == PACKAGE_VERSION, EPackageVersionMismatch);

assert!(record_tags::defined_for_trail(&self.tags, &record_tags), ERecordTagNotDefined);
assert!(self.tags.contains_all_role_tags(&role_tags), ERecordTagNotDefined);

role_map::create_role(
self.access_mut(),
cap,
role,
permissions,
copy record_tags,
copy role_tags,
clock,
ctx,
);

if (record_tags.is_some()) {
let tags = iota::vec_set::keys(record_tags::allowed_record_tags(option::borrow(&record_tags)));
if (role_tags.is_some()) {
let tags = role_tags.borrow().tags().keys();
let mut i = 0;
let tag_count = tags.length();

while (i < tag_count) {
record_tags::increment_tag_usage(&mut self.tags, &tags[i]);
self.tags.increment_usage_count(&tags[i]);
i = i + 1;
};
};
Expand All @@ -675,42 +672,42 @@ public fun update_role_permissions<D: store + copy>(
cap: &Capability,
role: String,
new_permissions: VecSet<Permission>,
record_tags: Option<RecordTags>,
role_tags: Option<RoleTags>,
clock: &Clock,
ctx: &mut TxContext,
) {
assert!(self.version == PACKAGE_VERSION, EPackageVersionMismatch);

assert!(record_tags::defined_for_trail(&self.tags, &record_tags), ERecordTagNotDefined);
assert!(self.tags.contains_all_role_tags(&role_tags), ERecordTagNotDefined);
let old_record_tags = *role_map::get_role_data(self.access(), &role);
role_map::update_role(
self.access_mut(),
cap,
&role,
new_permissions,
copy record_tags,
copy role_tags,
clock,
ctx,
);

if (old_record_tags.is_some()) {
let tags = iota::vec_set::keys(record_tags::allowed_record_tags(option::borrow(&old_record_tags)));
let tags = old_record_tags.borrow().tags().keys();
let mut i = 0;
let tag_count = tags.length();

while (i < tag_count) {
record_tags::decrement_tag_usage(&mut self.tags, &tags[i]);
self.tags.decrement_usage_count(&tags[i]);
i = i + 1;
};
};

if (record_tags.is_some()) {
let tags = iota::vec_set::keys(record_tags::allowed_record_tags(option::borrow(&record_tags)));
if (role_tags.is_some()) {
let tags = role_tags.borrow().tags().keys();
let mut i = 0;
let tag_count = tags.length();

while (i < tag_count) {
record_tags::increment_tag_usage(&mut self.tags, &tags[i]);
self.tags.increment_usage_count(&tags[i]);
i = i + 1;
};
};
Expand All @@ -729,12 +726,12 @@ public fun delete_role<D: store + copy>(
role_map::delete_role(self.access_mut(), cap, &role, clock, ctx);

if (old_record_tags.is_some()) {
let tags = iota::vec_set::keys(record_tags::allowed_record_tags(option::borrow(&old_record_tags)));
let tags = old_record_tags.borrow().tags().keys();
let mut i = 0;
let tag_count = tags.length();

while (i < tag_count) {
record_tags::decrement_tag_usage(&mut self.tags, &tags[i]);
self.tags.decrement_usage_count(&tags[i]);
i = i + 1;
};
};
Expand Down Expand Up @@ -941,7 +938,7 @@ public fun locking_config<D: store + copy>(self: &AuditTrail<D>): &LockingConfig
}

/// Get the trail-defined record tags and their combined usage counts.
public fun tags<D: store + copy>(self: &AuditTrail<D>): &VecMap<String, u64> {
public fun tags<D: store + copy>(self: &AuditTrail<D>): &TagRegistry {
&self.tags
}

Expand Down Expand Up @@ -983,15 +980,15 @@ public fun records<D: store + copy>(self: &AuditTrail<D>): &LinkedTable<u64, Rec
// ===== Access Control Functions =====

/// Returns a reference to the RoleMap managing access (roles and capabilities) for the audit trail.
public fun access<D: store + copy>(self: &AuditTrail<D>): &RoleMap<Permission, RecordTags> {
public fun access<D: store + copy>(self: &AuditTrail<D>): &RoleMap<Permission, RoleTags> {
assert!(self.version == PACKAGE_VERSION, EPackageVersionMismatch);
&self.roles
}

/// Returns a mutable reference to the RoleMap managing access (roles and capabilities) for the audit trail.
public(package) fun access_mut<D: store + copy>(
self: &mut AuditTrail<D>,
): &mut RoleMap<Permission, RecordTags> {
): &mut RoleMap<Permission, RoleTags> {
assert!(self.version == PACKAGE_VERSION, EPackageVersionMismatch);
&mut self.roles
}
44 changes: 39 additions & 5 deletions audit-trail-move/sources/record_tags.move
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ public struct RoleTags has copy, drop, store {
}

/// Create a new `RoleTags`.
public fun new_role_tag_list(tags: vector<String>): RoleTags {
public fun new_role_tags(tags: vector<String>): RoleTags {
RoleTags {
tags: vec_set::from_keys(tags),
}
Expand Down Expand Up @@ -56,6 +56,26 @@ public(package) fun new_tag_registry(mut tags: vector<String>): TagRegistry {
TagRegistry { tag_map: usage }
}

/// Destroys the `TagRegistry` by emptying the internal tag map and then destroying it.
public(package) fun destroy(mut self: TagRegistry) {
while (!self.tag_map.is_empty()) {
let (_, _) = self.tag_map.pop();
};
self.tag_map.destroy_empty();
}

public(package) fun insert_tag(self: &mut TagRegistry, tag: String, usage_count: u64) {
self.tag_map.insert(tag, usage_count);
}

public(package) fun remove_tag(self: &mut TagRegistry, tag: &String) {
self.tag_map.remove(tag);
}

public(package) fun tag_keys(self: &TagRegistry): vector<String> {
iota::vec_map::keys(&self.tag_map)
}

/// Returns true when all provided `role_tags` (tags associated with a role) are contained in the `TagRegistry`.
public(package) fun contains_all_role_tags(
self: &TagRegistry,
Expand Down Expand Up @@ -95,14 +115,28 @@ public(package) fun usage_count(self: &TagRegistry, tag: &String): Option<u64> {
}
}

/// Increments the usage count for a tag by 1.
/// Will be without effect if the tag is not contained in the registry.
public(package) fun increment_usage_count(self: &mut TagRegistry, tag: &String) {
let counters = vec_map::get_mut(&mut self.tag_map, tag);
*counters = *counters + 1;
if (self.tag_map.contains(tag)) {
let counters = vec_map::get_mut(&mut self.tag_map, tag);
*counters = *counters + 1;
};
}

/// Decrements the usage count for a tag by 1.
/// Will be without effect if the tag is not contained in the registry.
public(package) fun decrement_usage_count(self: &mut TagRegistry, tag: &String) {
let counters = vec_map::get_mut(&mut self.tag_map, tag);
*counters = *counters - 1;
if (self.tag_map.contains(tag)) {
let counters = vec_map::get_mut(&mut self.tag_map, tag);
*counters = *counters - 1;
};
}

/// Returns if the specified is in use.
/// Returns false if the tag is not contained in the registry.
public(package) fun is_in_use(self: &TagRegistry, tag: &String): bool {
Comment thread
chrisgitiota marked this conversation as resolved.
(*self.usage_count(tag).borrow_with_default(&0)) > 0
}


Expand Down
12 changes: 6 additions & 6 deletions audit-trail-move/tests/create_audit_trail_tests.move
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ use audit_trail::{
new_capability_for_address
}
};
use iota::{clock, test_scenario as ts, vec_map};
use iota::{clock, test_scenario as ts};
use std::string;
use tf_components::timelock;

Expand Down Expand Up @@ -121,9 +121,9 @@ fun test_tag_admin_role_can_manage_available_record_tags() {
ts::ctx(&mut scenario),
);

let available_tags = trail.tags();
assert!(vec_map::size(available_tags) == 1, 0);
assert!(vec_map::contains(available_tags, &string::utf8(b"finance")), 1);
let available_tags = trail.tags().tag_keys();
assert!(available_tags.length() == 1, 0);
assert!(available_tags.contains(&string::utf8(b"finance")), 1);

trail.remove_record_tag(
&tag_admin_cap,
Expand All @@ -132,8 +132,8 @@ fun test_tag_admin_role_can_manage_available_record_tags() {
ts::ctx(&mut scenario),
);

let available_tags = trail.tags();
assert!(vec_map::size(available_tags) == 0, 0);
let available_tags = trail.tags().tag_keys();
assert!(available_tags.length() == 0, 2);

cleanup_capability_trail_and_clock(&scenario, tag_admin_cap, trail, clock);
};
Expand Down
6 changes: 3 additions & 3 deletions audit-trail-move/tests/record_tests.move
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ fun test_add_tagged_record_with_matching_role_tags() {
&admin_cap,
string::utf8(b"TaggedWriter"),
permission::record_admin_permissions(),
std::option::some(record_tags::new_record_tags(vector[string::utf8(b"finance")])),
std::option::some(record_tags::new_role_tags(vector[string::utf8(b"finance")])),
&clock,
ts::ctx(&mut scenario),
);
Expand Down Expand Up @@ -275,7 +275,7 @@ fun test_add_tagged_record_requires_trail_defined_tag() {
&admin_cap,
string::utf8(b"TaggedWriter"),
permission::record_admin_permissions(),
std::option::some(record_tags::new_record_tags(vector[string::utf8(b"finance")])),
std::option::some(record_tags::new_role_tags(vector[string::utf8(b"finance")])),
&clock,
ts::ctx(&mut scenario),
);
Expand Down Expand Up @@ -343,7 +343,7 @@ fun test_remove_record_tag_rejects_in_use_tag() {
&admin_cap,
string::utf8(b"TaggedWriter"),
permission::record_admin_permissions(),
std::option::some(record_tags::new_record_tags(vector[string::utf8(b"finance")])),
std::option::some(record_tags::new_role_tags(vector[string::utf8(b"finance")])),
&clock,
ts::ctx(&mut scenario),
);
Expand Down
Loading