@aptos-labs/ts-sdk 1.36.0 → 1.37.0

package/src/internal/move/jwks/build/jwk/sources/dependencies/AptosFramework/block.move

@@ -0,0 +1,394 @@
+/// This module defines a struct storing the metadata of the block and new block events.
+module aptos_framework::block {
+    use std::error;
+    use std::features;
+    use std::vector;
+    use std::option;
+    use aptos_std::table_with_length::{Self, TableWithLength};
+    use std::option::Option;
+    use aptos_framework::randomness;
+
+    use aptos_framework::account;
+    use aptos_framework::event::{Self, EventHandle};
+    use aptos_framework::reconfiguration;
+    use aptos_framework::reconfiguration_with_dkg;
+    use aptos_framework::stake;
+    use aptos_framework::state_storage;
+    use aptos_framework::system_addresses;
+    use aptos_framework::timestamp;
+    use aptos_framework::transaction_fee;
+
+    friend aptos_framework::genesis;
+
+    const MAX_U64: u64 = 18446744073709551615;
+
+    /// Should be in-sync with BlockResource rust struct in new_block.rs
+    struct BlockResource has key {
+        /// Height of the current block
+        height: u64,
+        /// Time period between epochs.
+        epoch_interval: u64,
+        /// Handle where events with the time of new blocks are emitted
+        new_block_events: EventHandle<NewBlockEvent>,
+        update_epoch_interval_events: EventHandle<UpdateEpochIntervalEvent>,
+    }
+
+    /// Store new block events as a move resource, internally using a circular buffer.
+    struct CommitHistory has key {
+        max_capacity: u32,
+        next_idx: u32,
+        table: TableWithLength<u32, NewBlockEvent>,
+    }
+
+    /// Should be in-sync with NewBlockEvent rust struct in new_block.rs
+    struct NewBlockEvent has copy, drop, store {
+        hash: address,
+        epoch: u64,
+        round: u64,
+        height: u64,
+        previous_block_votes_bitvec: vector<u8>,
+        proposer: address,
+        failed_proposer_indices: vector<u64>,
+        /// On-chain time during the block at the given height
+        time_microseconds: u64,
+    }
+
+    /// Event emitted when a proposal is created.
+    struct UpdateEpochIntervalEvent has drop, store {
+        old_epoch_interval: u64,
+        new_epoch_interval: u64,
+    }
+
+    #[event]
+    /// Should be in-sync with NewBlockEvent rust struct in new_block.rs
+    struct NewBlock has drop, store {
+        hash: address,
+        epoch: u64,
+        round: u64,
+        height: u64,
+        previous_block_votes_bitvec: vector<u8>,
+        proposer: address,
+        failed_proposer_indices: vector<u64>,
+        /// On-chain time during the block at the given height
+        time_microseconds: u64,
+    }
+
+    #[event]
+    /// Event emitted when a proposal is created.
+    struct UpdateEpochInterval has drop, store {
+        old_epoch_interval: u64,
+        new_epoch_interval: u64,
+    }
+
+    /// The number of new block events does not equal the current block height.
+    const ENUM_NEW_BLOCK_EVENTS_DOES_NOT_MATCH_BLOCK_HEIGHT: u64 = 1;
+    /// An invalid proposer was provided. Expected the proposer to be the VM or an active validator.
+    const EINVALID_PROPOSER: u64 = 2;
+    /// Epoch interval cannot be 0.
+    const EZERO_EPOCH_INTERVAL: u64 = 3;
+    /// The maximum capacity of the commit history cannot be 0.
+    const EZERO_MAX_CAPACITY: u64 = 3;
+
+    /// This can only be called during Genesis.
+    public(friend) fun initialize(aptos_framework: &signer, epoch_interval_microsecs: u64) {
+        system_addresses::assert_aptos_framework(aptos_framework);
+        assert!(epoch_interval_microsecs > 0, error::invalid_argument(EZERO_EPOCH_INTERVAL));
+
+        move_to<CommitHistory>(aptos_framework, CommitHistory {
+            max_capacity: 2000,
+            next_idx: 0,
+            table: table_with_length::new(),
+        });
+
+        move_to<BlockResource>(
+            aptos_framework,
+            BlockResource {
+                height: 0,
+                epoch_interval: epoch_interval_microsecs,
+                new_block_events: account::new_event_handle<NewBlockEvent>(aptos_framework),
+                update_epoch_interval_events: account::new_event_handle<UpdateEpochIntervalEvent>(aptos_framework),
+            }
+        );
+    }
+
+    /// Initialize the commit history resource if it's not in genesis.
+    public fun initialize_commit_history(fx: &signer, max_capacity: u32) {
+        assert!(max_capacity > 0, error::invalid_argument(EZERO_MAX_CAPACITY));
+        move_to<CommitHistory>(fx, CommitHistory {
+            max_capacity,
+            next_idx: 0,
+            table: table_with_length::new(),
+        });
+    }
+
+    /// Update the epoch interval.
+    /// Can only be called as part of the Aptos governance proposal process established by the AptosGovernance module.
+    public fun update_epoch_interval_microsecs(
+        aptos_framework: &signer,
+        new_epoch_interval: u64,
+    ) acquires BlockResource {
+        system_addresses::assert_aptos_framework(aptos_framework);
+        assert!(new_epoch_interval > 0, error::invalid_argument(EZERO_EPOCH_INTERVAL));
+
+        let block_resource = borrow_global_mut<BlockResource>(@aptos_framework);
+        let old_epoch_interval = block_resource.epoch_interval;
+        block_resource.epoch_interval = new_epoch_interval;
+
+        if (std::features::module_event_migration_enabled()) {
+            event::emit(
+                UpdateEpochInterval { old_epoch_interval, new_epoch_interval },
+            );
+        };
+        event::emit_event<UpdateEpochIntervalEvent>(
+            &mut block_resource.update_epoch_interval_events,
+            UpdateEpochIntervalEvent { old_epoch_interval, new_epoch_interval },
+        );
+    }
+
+    #[view]
+    /// Return epoch interval in seconds.
+    public fun get_epoch_interval_secs(): u64 acquires BlockResource {
+        borrow_global<BlockResource>(@aptos_framework).epoch_interval / 1000000
+    }
+
+
+    fun block_prologue_common(
+        vm: &signer,
+        hash: address,
+        epoch: u64,
+        round: u64,
+        proposer: address,
+        failed_proposer_indices: vector<u64>,
+        previous_block_votes_bitvec: vector<u8>,
+        timestamp: u64
+    ): u64 acquires BlockResource, CommitHistory {
+        // Operational constraint: can only be invoked by the VM.
+        system_addresses::assert_vm(vm);
+
+        // Blocks can only be produced by a valid proposer or by the VM itself for Nil blocks (no user txs).
+        assert!(
+            proposer == @vm_reserved || stake::is_current_epoch_validator(proposer),
+            error::permission_denied(EINVALID_PROPOSER),
+        );
+
+        let proposer_index = option::none();
+        if (proposer != @vm_reserved) {
+            proposer_index = option::some(stake::get_validator_index(proposer));
+        };
+
+        let block_metadata_ref = borrow_global_mut<BlockResource>(@aptos_framework);
+        block_metadata_ref.height = event::counter(&block_metadata_ref.new_block_events);
+
+        // Emit both event v1 and v2 for compatibility. Eventually only module events will be kept.
+        let new_block_event = NewBlockEvent {
+            hash,
+            epoch,
+            round,
+            height: block_metadata_ref.height,
+            previous_block_votes_bitvec,
+            proposer,
+            failed_proposer_indices,
+            time_microseconds: timestamp,
+        };
+        let new_block_event_v2 = NewBlock {
+            hash,
+            epoch,
+            round,
+            height: block_metadata_ref.height,
+            previous_block_votes_bitvec,
+            proposer,
+            failed_proposer_indices,
+            time_microseconds: timestamp,
+        };
+        emit_new_block_event(vm, &mut block_metadata_ref.new_block_events, new_block_event, new_block_event_v2);
+
+        if (features::collect_and_distribute_gas_fees()) {
+            // Assign the fees collected from the previous block to the previous block proposer.
+            // If for any reason the fees cannot be assigned, this function burns the collected coins.
+            transaction_fee::process_collected_fees();
+            // Set the proposer of this block as the receiver of the fees, so that the fees for this
+            // block are assigned to the right account.
+            transaction_fee::register_proposer_for_fee_collection(proposer);
+        };
+
+        // Performance scores have to be updated before the epoch transition as the transaction that triggers the
+        // transition is the last block in the previous epoch.
+        stake::update_performance_statistics(proposer_index, failed_proposer_indices);
+        state_storage::on_new_block(reconfiguration::current_epoch());
+
+        block_metadata_ref.epoch_interval
+    }
+
+    /// Set the metadata for the current block.
+    /// The runtime always runs this before executing the transactions in a block.
+    fun block_prologue(
+        vm: signer,
+        hash: address,
+        epoch: u64,
+        round: u64,
+        proposer: address,
+        failed_proposer_indices: vector<u64>,
+        previous_block_votes_bitvec: vector<u8>,
+        timestamp: u64
+    ) acquires BlockResource, CommitHistory {
+        let epoch_interval = block_prologue_common(&vm, hash, epoch, round, proposer, failed_proposer_indices, previous_block_votes_bitvec, timestamp);
+        randomness::on_new_block(&vm, epoch, round, option::none());
+        if (timestamp - reconfiguration::last_reconfiguration_time() >= epoch_interval) {
+            reconfiguration::reconfigure();
+        };
+    }
+
+    /// `block_prologue()` but trigger reconfiguration with DKG after epoch timed out.
+    fun block_prologue_ext(
+        vm: signer,
+        hash: address,
+        epoch: u64,
+        round: u64,
+        proposer: address,
+        failed_proposer_indices: vector<u64>,
+        previous_block_votes_bitvec: vector<u8>,
+        timestamp: u64,
+        randomness_seed: Option<vector<u8>>,
+    ) acquires BlockResource, CommitHistory {
+        let epoch_interval = block_prologue_common(
+            &vm,
+            hash,
+            epoch,
+            round,
+            proposer,
+            failed_proposer_indices,
+            previous_block_votes_bitvec,
+            timestamp
+        );
+        randomness::on_new_block(&vm, epoch, round, randomness_seed);
+
+        if (timestamp - reconfiguration::last_reconfiguration_time() >= epoch_interval) {
+            reconfiguration_with_dkg::try_start();
+        };
+    }
+
+    #[view]
+    /// Get the current block height
+    public fun get_current_block_height(): u64 acquires BlockResource {
+        borrow_global<BlockResource>(@aptos_framework).height
+    }
+
+    /// Emit the event and update height and global timestamp
+    fun emit_new_block_event(
+        vm: &signer,
+        event_handle: &mut EventHandle<NewBlockEvent>,
+        new_block_event: NewBlockEvent,
+        new_block_event_v2: NewBlock
+    ) acquires CommitHistory {
+        if (exists<CommitHistory>(@aptos_framework)) {
+            let commit_history_ref = borrow_global_mut<CommitHistory>(@aptos_framework);
+            let idx = commit_history_ref.next_idx;
+            if (table_with_length::contains(&commit_history_ref.table, idx)) {
+                table_with_length::remove(&mut commit_history_ref.table, idx);
+            };
+            table_with_length::add(&mut commit_history_ref.table, idx, copy new_block_event);
+            spec {
+                assume idx + 1 <= MAX_U32;
+            };
+            commit_history_ref.next_idx = (idx + 1) % commit_history_ref.max_capacity;
+        };
+        timestamp::update_global_time(vm, new_block_event.proposer, new_block_event.time_microseconds);
+        assert!(
+            event::counter(event_handle) == new_block_event.height,
+            error::invalid_argument(ENUM_NEW_BLOCK_EVENTS_DOES_NOT_MATCH_BLOCK_HEIGHT),
+        );
+        if (std::features::module_event_migration_enabled()) {
+            event::emit(new_block_event_v2);
+        };
+        event::emit_event<NewBlockEvent>(event_handle, new_block_event);
+    }
+
+    /// Emit a `NewBlockEvent` event. This function will be invoked by genesis directly to generate the very first
+    /// reconfiguration event.
+    fun emit_genesis_block_event(vm: signer) acquires BlockResource, CommitHistory {
+        let block_metadata_ref = borrow_global_mut<BlockResource>(@aptos_framework);
+        let genesis_id = @0x0;
+        emit_new_block_event(
+            &vm,
+            &mut block_metadata_ref.new_block_events,
+            NewBlockEvent {
+                hash: genesis_id,
+                epoch: 0,
+                round: 0,
+                height: 0,
+                previous_block_votes_bitvec: vector::empty(),
+                proposer: @vm_reserved,
+                failed_proposer_indices: vector::empty(),
+                time_microseconds: 0,
+            },
+            NewBlock {
+                hash: genesis_id,
+                epoch: 0,
+                round: 0,
+                height: 0,
+                previous_block_votes_bitvec: vector::empty(),
+                proposer: @vm_reserved,
+                failed_proposer_indices: vector::empty(),
+                time_microseconds: 0,
+            }
+        );
+    }
+
+    ///  Emit a `NewBlockEvent` event. This function will be invoked by write set script directly to generate the
+    ///  new block event for WriteSetPayload.
+    public fun emit_writeset_block_event(vm_signer: &signer, fake_block_hash: address) acquires BlockResource, CommitHistory {
+        system_addresses::assert_vm(vm_signer);
+        let block_metadata_ref = borrow_global_mut<BlockResource>(@aptos_framework);
+        block_metadata_ref.height = event::counter(&block_metadata_ref.new_block_events);
+
+        emit_new_block_event(
+            vm_signer,
+            &mut block_metadata_ref.new_block_events,
+            NewBlockEvent {
+                hash: fake_block_hash,
+                epoch: reconfiguration::current_epoch(),
+                round: MAX_U64,
+                height: block_metadata_ref.height,
+                previous_block_votes_bitvec: vector::empty(),
+                proposer: @vm_reserved,
+                failed_proposer_indices: vector::empty(),
+                time_microseconds: timestamp::now_microseconds(),
+            },
+            NewBlock {
+                hash: fake_block_hash,
+                epoch: reconfiguration::current_epoch(),
+                round: MAX_U64,
+                height: block_metadata_ref.height,
+                previous_block_votes_bitvec: vector::empty(),
+                proposer: @vm_reserved,
+                failed_proposer_indices: vector::empty(),
+                time_microseconds: timestamp::now_microseconds(),
+            }
+        );
+    }
+
+    #[test_only]
+    public fun initialize_for_test(account: &signer, epoch_interval_microsecs: u64) {
+        initialize(account, epoch_interval_microsecs);
+    }
+
+    #[test(aptos_framework = @aptos_framework)]
+    public entry fun test_update_epoch_interval(aptos_framework: signer) acquires BlockResource {
+        account::create_account_for_test(@aptos_framework);
+        initialize(&aptos_framework, 1);
+        assert!(borrow_global<BlockResource>(@aptos_framework).epoch_interval == 1, 0);
+        update_epoch_interval_microsecs(&aptos_framework, 2);
+        assert!(borrow_global<BlockResource>(@aptos_framework).epoch_interval == 2, 1);
+    }
+
+    #[test(aptos_framework = @aptos_framework, account = @0x123)]
+    #[expected_failure(abort_code = 0x50003, location = aptos_framework::system_addresses)]
+    public entry fun test_update_epoch_interval_unauthorized_should_fail(
+        aptos_framework: signer,
+        account: signer,
+    ) acquires BlockResource {
+        account::create_account_for_test(@aptos_framework);
+        initialize(&aptos_framework, 1);
+        update_epoch_interval_microsecs(&account, 2);
+    }
+}

package/src/internal/move/jwks/build/jwk/sources/dependencies/AptosFramework/chain_id.move

@@ -0,0 +1,41 @@
+/// The chain id distinguishes between different chains (e.g., testnet and the main network).
+/// One important role is to prevent transactions intended for one chain from being executed on another.
+/// This code provides a container for storing a chain id and functions to initialize and get it.
+module aptos_framework::chain_id {
+    use aptos_framework::system_addresses;
+
+    friend aptos_framework::genesis;
+
+    struct ChainId has key {
+        id: u8
+    }
+
+    /// Only called during genesis.
+    /// Publish the chain ID `id` of this instance under the SystemAddresses address
+    public(friend) fun initialize(aptos_framework: &signer, id: u8) {
+        system_addresses::assert_aptos_framework(aptos_framework);
+        move_to(aptos_framework, ChainId { id })
+    }
+
+    #[view]
+    /// Return the chain ID of this instance.
+    public fun get(): u8 acquires ChainId {
+        borrow_global<ChainId>(@aptos_framework).id
+    }
+
+    #[test_only]
+    use std::signer;
+
+    #[test_only]
+    public fun initialize_for_test(aptos_framework: &signer, id: u8) {
+        if (!exists<ChainId>(signer::address_of(aptos_framework))) {
+            initialize(aptos_framework, id);
+        }
+    }
+
+    #[test(aptos_framework = @0x1)]
+    fun test_get(aptos_framework: &signer) acquires ChainId {
+        initialize_for_test(aptos_framework, 1u8);
+        assert!(get() == 1u8, 1);
+    }
+}

package/src/internal/move/jwks/build/jwk/sources/dependencies/AptosFramework/chain_status.move

@@ -0,0 +1,48 @@
+/// This module code to assert that it is running in genesis (`Self::assert_genesis`) or after
+/// genesis (`Self::assert_operating`). These are essentially distinct states of the system. Specifically,
+/// if `Self::assert_operating` succeeds, assumptions about invariants over the global state can be made
+/// which reflect that the system has been successfully initialized.
+module aptos_framework::chain_status {
+    use aptos_framework::system_addresses;
+    use std::error;
+
+    friend aptos_framework::genesis;
+
+    /// Marker to publish at the end of genesis.
+    struct GenesisEndMarker has key {}
+
+    /// The blockchain is not in the operating status.
+    const ENOT_OPERATING: u64 = 1;
+    /// The blockchain is not in the genesis status.
+    const ENOT_GENESIS: u64 = 2;
+
+    /// Marks that genesis has finished.
+    public(friend) fun set_genesis_end(aptos_framework: &signer) {
+        system_addresses::assert_aptos_framework(aptos_framework);
+        move_to(aptos_framework, GenesisEndMarker {});
+    }
+
+    #[view]
+    /// Helper function to determine if Aptos is in genesis state.
+    public fun is_genesis(): bool {
+        !exists<GenesisEndMarker>(@aptos_framework)
+    }
+
+    #[view]
+    /// Helper function to determine if Aptos is operating. This is
+    /// the same as `!is_genesis()` and is provided for convenience.
+    /// Testing `is_operating()` is more frequent than `is_genesis()`.
+    public fun is_operating(): bool {
+        exists<GenesisEndMarker>(@aptos_framework)
+    }
+
+    /// Helper function to assert operating (not genesis) state.
+    public fun assert_operating() {
+        assert!(is_operating(), error::invalid_state(ENOT_OPERATING));
+    }
+
+    /// Helper function to assert genesis state.
+    public fun assert_genesis() {
+        assert!(is_genesis(), error::invalid_state(ENOT_OPERATING));
+    }
+}