docs: doc events and upgrade

Author: noa-starkware

packages/token_migration/src/events.cairo

@@ -1,6 +1,7 @@
 pub mod TokenMigrationEvents {
     use starknet::{ContractAddress, EthAddress};
 
+    /// Emitted when a token swap sucessfully executed.
     #[derive(Drop, starknet::Event, Debug, PartialEq)]
     pub struct TokenMigrated {
         #[key]
@@ -12,28 +13,34 @@ pub mod TokenMigrationEvents {
         pub amount: u256,
     }
 
+    /// Emitted upon handling l1-l2 msg verifying L1 recipient address.
     #[derive(Drop, starknet::Event, Debug, PartialEq)]
     pub struct L1RecipientVerified {
         pub l1_recipient: EthAddress,
     }
 
+    /// Emitted on a change in the token supplier address.
     #[derive(Drop, starknet::Event, Debug, PartialEq)]
     pub struct TokenSupplierSet {
         pub token_supplier: ContractAddress,
     }
 
+    /// Emitted on a change in the legacy token buffer level.
     #[derive(Drop, starknet::Event, Debug, PartialEq)]
     pub struct LegacyBufferSet {
         pub old_buffer: u256,
         pub new_buffer: u256,
     }
 
+    /// Emitted on a change in the fixed-size used for legacy token withdrawals to L1.
     #[derive(Drop, starknet::Event, Debug, PartialEq)]
     pub struct BatchSizeSet {
         pub old_batch_size: u256,
         pub new_batch_size: u256,
     }
 
+    /// Emitted when failed to send legacy tokens to L1.
+    /// The failure is caught and handled without failing the user action.
     #[derive(Drop, starknet::Event, Debug, PartialEq)]
     pub struct SendToL1Failed {
         pub error: felt252,

packages/token_migration/src/token_migration.cairo

@@ -113,6 +113,8 @@ pub mod TokenMigration {
 
     #[abi(embed_v0)]
     impl UpgradeableImpl of IUpgradeable<ContractState> {
+        /// Upgrades the contract to a new class hash.
+        /// Caller must be the owner.
         fn upgrade(ref self: ContractState, new_class_hash: ClassHash) {
             self.ownable.assert_only_owner();
             self.upgradeable.upgrade(:new_class_hash);