Skip to content

Add contract events for TTL extension and protocol fee recipient updates #642

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

Open
JamesVictor-O wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add contract events for TTL extension and protocol fee recipient updates #642

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 22 additions & 0 deletions creator-keys/src/events.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -258,11 +258,16 @@ pub struct AllocationClaimedEvent {
pub ledger: u32,
}

/// Stable field order for protocol fee recipient updated event payloads.
pub const PROTOCOL_FEE_RECIPIENT_UPDATED_DATA_FIELDS: [&str; 3] =
["old_recipient", "new_recipient", "updated_at_ledger"];

#[derive(Clone, Debug, Eq, PartialEq)]
#[contracttype]
pub struct ProtocolFeeRecipientUpdatedEvent {
pub old_recipient: Address,
pub new_recipient: Address,
pub updated_at_ledger: u32,
}

#[derive(Clone, Debug, Eq, PartialEq)]
Expand Down Expand Up @@ -431,6 +436,23 @@ pub fn ttl_extended_topics(creator: &Address) -> (Symbol, Address) {
(TTL_EXTENDED_EVENT_NAME, creator.clone())
}

/// Stable field order for TTL extension event payloads.
pub const TTL_EXTENDED_DATA_FIELDS: [&str; 3] =
["creator_id", "extended_at_ledger", "new_expiry_ledger"];

/// Stable TTL extension event payload for downstream indexers.
///
/// Event shape:
/// - topics: `(TTL_EXTENDED_EVENT_NAME, creator_id)`
/// - data: `TtlExtendedEvent`
#[derive(Clone, Debug, Eq, PartialEq)]
#[contracttype]
pub struct TtlExtendedEvent {
pub creator_id: Address,
pub extended_at_ledger: u32,
pub new_expiry_ledger: u32,
}

#[contracterror]
#[derive(Copy, Clone, Debug, Eq, PartialEq, PartialOrd, Ord)]
#[repr(u32)]
Expand Down
12 changes: 10 additions & 2 deletions creator-keys/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1392,8 +1392,14 @@ fn extend_creator_ttl(env: &Env, creator: &Address) {
}
}

env.events()
.publish(events::ttl_extended_topics(creator), extend_to);
env.events().publish(
events::ttl_extended_topics(creator),
events::TtlExtendedEvent {
creator_id: creator.clone(),
extended_at_ledger: current_ledger,
new_expiry_ledger: extend_to,
},
);
}

#[contract]
Expand Down Expand Up @@ -2618,6 +2624,7 @@ impl CreatorKeysContract {
events::ProtocolFeeRecipientUpdatedEvent {
old_recipient: old,
new_recipient: recipient,
updated_at_ledger: env.ledger().sequence(),
},
);
}
Expand Down Expand Up @@ -3019,6 +3026,7 @@ impl CreatorKeysContract {
events::ProtocolFeeRecipientUpdatedEvent {
old_recipient,
new_recipient,
updated_at_ledger: env.ledger().sequence(),
},
);

Expand Down
27 changes: 26 additions & 1 deletion creator-keys/test_snapshots/test_buy_event_buyer_address_field_is_non_zero.1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -693,7 +693,32 @@
}
],
"data": {
"u32": 6311520
"map": [
{
"key": {
"symbol": "creator_id"
},
"val": {
"address": "CAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAHK3M"
}
},
{
"key": {
"symbol": "extended_at_ledger"
},
"val": {
"u32": 0
}
},
{
"key": {
"symbol": "new_expiry_ledger"
},
"val": {
"u32": 6311520
}
}
]
}
}
}
Expand Down
27 changes: 26 additions & 1 deletion creator-keys/test_snapshots/test_buy_event_buyer_address_matches_caller.1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -693,7 +693,32 @@
}
],
"data": {
"u32": 6311520
"map": [
{
"key": {
"symbol": "creator_id"
},
"val": {
"address": "CAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAHK3M"
}
},
{
"key": {
"symbol": "extended_at_ledger"
},
"val": {
"u32": 0
}
},
{
"key": {
"symbol": "new_expiry_ledger"
},
"val": {
"u32": 6311520
}
}
]
}
}
}
Expand Down
27 changes: 26 additions & 1 deletion creator-keys/test_snapshots/test_buy_key_event_includes_payment_amount.1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -693,7 +693,32 @@
}
],
"data": {
"u32": 6311520
"map": [
{
"key": {
"symbol": "creator_id"
},
"val": {
"address": "CAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAHK3M"
}
},
{
"key": {
"symbol": "extended_at_ledger"
},
"val": {
"u32": 0
}
},
{
"key": {
"symbol": "new_expiry_ledger"
},
"val": {
"u32": 6311520
}
}
]
}
}
}
Expand Down
27 changes: 26 additions & 1 deletion ...r-keys/test_snapshots/test_buy_key_event_payload_fields_are_validated_from_fixture.1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -693,7 +693,32 @@
}
],
"data": {
"u32": 6311520
"map": [
{
"key": {
"symbol": "creator_id"
},
"val": {
"address": "CAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAHK3M"
}
},
{
"key": {
"symbol": "extended_at_ledger"
},
"val": {
"u32": 0
}
},
{
"key": {
"symbol": "new_expiry_ledger"
},
"val": {
"u32": 6311520
}
}
]
}
}
}
Expand Down
27 changes: 26 additions & 1 deletion ...-keys/test_snapshots/test_buy_key_event_payload_tracks_new_supply_across_purchases.1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -914,7 +914,32 @@
}
],
"data": {
"u32": 6311520
"map": [
{
"key": {
"symbol": "creator_id"
},
"val": {
"address": "CAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAHK3M"
}
},
{
"key": {
"symbol": "extended_at_ledger"
},
"val": {
"u32": 0
}
},
{
"key": {
"symbol": "new_expiry_ledger"
},
"val": {
"u32": 6311520
}
}
]
}
}
}
Expand Down
27 changes: 26 additions & 1 deletion creator-keys/test_snapshots/test_buy_key_event_present_after_purchase.1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -693,7 +693,32 @@
}
],
"data": {
"u32": 6311520
"map": [
{
"key": {
"symbol": "creator_id"
},
"val": {
"address": "CAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAHK3M"
}
},
{
"key": {
"symbol": "extended_at_ledger"
},
"val": {
"u32": 0
}
},
{
"key": {
"symbol": "new_expiry_ledger"
},
"val": {
"u32": 6311520
}
}
]
}
}
}
Expand Down
27 changes: 26 additions & 1 deletion creator-keys/test_snapshots/test_buy_key_event_topics_include_creator_and_buyer.1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -693,7 +693,32 @@
}
],
"data": {
"u32": 6311520
"map": [
{
"key": {
"symbol": "creator_id"
},
"val": {
"address": "CAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAHK3M"
}
},
{
"key": {
"symbol": "extended_at_ledger"
},
"val": {
"u32": 0
}
},
{
"key": {
"symbol": "new_expiry_ledger"
},
"val": {
"u32": 6311520
}
}
]
}
}
}
Expand Down
27 changes: 26 additions & 1 deletion creator-keys/test_snapshots/test_buy_key_positive_payment_succeeds.1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -693,7 +693,32 @@
}
],
"data": {
"u32": 6311520
"map": [
{
"key": {
"symbol": "creator_id"
},
"val": {
"address": "CAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAHK3M"
}
},
{
"key": {
"symbol": "extended_at_ledger"
},
"val": {
"u32": 0
}
},
{
"key": {
"symbol": "new_expiry_ledger"
},
"val": {
"u32": 6311520
}
}
]
}
}
}
Expand Down
27 changes: 26 additions & 1 deletion creator-keys/test_snapshots/test_buy_key_succeeds_after_unpause.1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -930,7 +930,32 @@
}
],
"data": {
"u32": 6311520
"map": [
{
"key": {
"symbol": "creator_id"
},
"val": {
"address": "CAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAITA4"
}
},
{
"key": {
"symbol": "extended_at_ledger"
},
"val": {
"u32": 0
}
},
{
"key": {
"symbol": "new_expiry_ledger"
},
"val": {
"u32": 6311520
}
}
]
}
}
}
Expand Down
Loading
Loading