|
| 1 | +// ============================================================================== |
| 2 | +// METAGAME CALLBACK COMPONENT |
| 3 | +// ============================================================================== |
| 4 | +// A reusable component for receiving callbacks from token contracts when game |
| 5 | +// state changes (score updates, game over, objectives completed). |
| 6 | +// |
| 7 | +// Uses the hooks pattern: the component provides infrastructure and SRC5 |
| 8 | +// registration, while implementations define actual callback behavior via traits. |
| 9 | + |
| 10 | +#[starknet::component] |
| 11 | +pub mod MetagameCallbackComponent { |
| 12 | + use openzeppelin_introspection::src5::SRC5Component; |
| 13 | + use openzeppelin_introspection::src5::SRC5Component::InternalTrait as SRC5InternalTrait; |
| 14 | + use crate::extensions::callback::interface::{IMETAGAME_CALLBACK_ID, IMetagameCallback}; |
| 15 | + |
| 16 | + // ========================================================================== |
| 17 | + // STORAGE |
| 18 | + // ========================================================================== |
| 19 | + |
| 20 | + #[storage] |
| 21 | + pub struct Storage {} |
| 22 | + |
| 23 | + // ========================================================================== |
| 24 | + // HOOKS TRAIT |
| 25 | + // ========================================================================== |
| 26 | + // Allows the embedding contract to define custom callback behavior. |
| 27 | + // Implementers can aggregate scores, emit events, update leaderboards, etc. |
| 28 | + |
| 29 | + pub trait MetagameCallbackHooksTrait<TContractState> { |
| 30 | + /// Called when a token's score is updated. |
| 31 | + /// @param token_id The token ID (packed u256) |
| 32 | + /// @param score The new score value |
| 33 | + fn on_score_update(ref self: TContractState, token_id: u256, score: u32); |
| 34 | + |
| 35 | + /// Called when a game ends (game_over transitions to true). |
| 36 | + /// @param token_id The token ID (packed u256) |
| 37 | + /// @param final_score The final score when game ended |
| 38 | + fn on_game_over(ref self: TContractState, token_id: u256, final_score: u32); |
| 39 | + |
| 40 | + /// Called when all objectives are completed. |
| 41 | + /// @param token_id The token ID (packed u256) |
| 42 | + fn on_objective_complete(ref self: TContractState, token_id: u256); |
| 43 | + } |
| 44 | + |
| 45 | + // ========================================================================== |
| 46 | + // EMBEDDABLE IMPLEMENTATION |
| 47 | + // ========================================================================== |
| 48 | + // Implements IMetagameCallback by delegating to hooks. |
| 49 | + // Contracts must provide a MetagameCallbackHooksTrait implementation. |
| 50 | + |
| 51 | + #[embeddable_as(MetagameCallbackImpl)] |
| 52 | + impl MetagameCallback< |
| 53 | + TContractState, |
| 54 | + +HasComponent<TContractState>, |
| 55 | + +Drop<TContractState>, |
| 56 | + +MetagameCallbackHooksTrait<TContractState>, |
| 57 | + > of IMetagameCallback<ComponentState<TContractState>> { |
| 58 | + fn on_score_update(ref self: ComponentState<TContractState>, token_id: u256, score: u32) { |
| 59 | + let mut contract = self.get_contract_mut(); |
| 60 | + MetagameCallbackHooksTrait::on_score_update(ref contract, token_id, score); |
| 61 | + } |
| 62 | + |
| 63 | + fn on_game_over( |
| 64 | + ref self: ComponentState<TContractState>, token_id: u256, final_score: u32, |
| 65 | + ) { |
| 66 | + let mut contract = self.get_contract_mut(); |
| 67 | + MetagameCallbackHooksTrait::on_game_over(ref contract, token_id, final_score); |
| 68 | + } |
| 69 | + |
| 70 | + fn on_objective_complete(ref self: ComponentState<TContractState>, token_id: u256) { |
| 71 | + let mut contract = self.get_contract_mut(); |
| 72 | + MetagameCallbackHooksTrait::on_objective_complete(ref contract, token_id); |
| 73 | + } |
| 74 | + } |
| 75 | + |
| 76 | + // ========================================================================== |
| 77 | + // INTERNAL IMPLEMENTATION |
| 78 | + // ========================================================================== |
| 79 | + |
| 80 | + #[generate_trait] |
| 81 | + pub impl InternalImpl< |
| 82 | + TContractState, |
| 83 | + +HasComponent<TContractState>, |
| 84 | + impl SRC5: SRC5Component::HasComponent<TContractState>, |
| 85 | + +Drop<TContractState>, |
| 86 | + > of InternalTrait<TContractState> { |
| 87 | + /// Initializes the component by registering the SRC5 interface. |
| 88 | + /// Should be called in the contract's constructor. |
| 89 | + fn initializer(ref self: ComponentState<TContractState>) { |
| 90 | + let mut src5_component = get_dep_component_mut!(ref self, SRC5); |
| 91 | + src5_component.register_interface(IMETAGAME_CALLBACK_ID); |
| 92 | + } |
| 93 | + } |
| 94 | +} |
| 95 | + |
| 96 | +// ============================================================================== |
| 97 | +// EMPTY HOOKS IMPLEMENTATION |
| 98 | +// ============================================================================== |
| 99 | +// Provides a no-op implementation for contracts that don't need custom behavior. |
| 100 | +// Use this when you want to receive callbacks but don't need to process them. |
| 101 | + |
| 102 | +pub impl MetagameCallbackHooksEmptyImpl< |
| 103 | + TContractState, |
| 104 | +> of MetagameCallbackComponent::MetagameCallbackHooksTrait<TContractState> { |
| 105 | + fn on_score_update( |
| 106 | + ref self: TContractState, token_id: u256, score: u32, |
| 107 | + ) { // No-op: contracts can override for custom score handling |
| 108 | + } |
| 109 | + |
| 110 | + fn on_game_over( |
| 111 | + ref self: TContractState, token_id: u256, final_score: u32, |
| 112 | + ) { // No-op: contracts can override for custom game over handling |
| 113 | + } |
| 114 | + |
| 115 | + fn on_objective_complete( |
| 116 | + ref self: TContractState, token_id: u256, |
| 117 | + ) { // No-op: contracts can override for custom objectives handling |
| 118 | + } |
| 119 | +} |
0 commit comments