@aptos-labs/ts-sdk 3.0.0 → 3.1.0

package/src/internal/move/jwks/build/jwk/sources/dependencies/AptosStdlib/smart_table.move

@@ -0,0 +1,769 @@
+/// A smart table implementation based on linear hashing. (https://en.wikipedia.org/wiki/Linear_hashing)
+/// Compare to Table, it uses less storage slots but has higher chance of collision, a trade-off between space and time.
+/// Compare to other dynamic hashing implementation, linear hashing splits one bucket a time instead of doubling buckets
+/// when expanding to avoid unexpected gas cost.
+/// SmartTable uses faster hash function SipHash instead of cryptographically secure hash functions like sha3-256 since
+/// it tolerates collisions.
+module aptos_std::smart_table {
+    use std::error;
+    use std::vector;
+    use aptos_std::aptos_hash::sip_hash_from_value;
+    use aptos_std::table_with_length::{Self, TableWithLength};
+    use aptos_std::type_info::size_of_val;
+    use aptos_std::math64::max;
+    use aptos_std::simple_map::SimpleMap;
+    use aptos_std::simple_map;
+    use std::option::{Self, Option};
+
+    /// Key not found in the smart table
+    const ENOT_FOUND: u64 = 1;
+    /// Smart table capacity must be larger than 0
+    const EZERO_CAPACITY: u64 = 2;
+    /// Cannot destroy non-empty hashmap
+    const ENOT_EMPTY: u64 = 3;
+    /// Key already exists
+    const EALREADY_EXIST: u64 = 4;
+    /// Invalid load threshold percent to trigger split.
+    const EINVALID_LOAD_THRESHOLD_PERCENT: u64 = 5;
+    /// Invalid target bucket size.
+    const EINVALID_TARGET_BUCKET_SIZE: u64 = 6;
+    /// Invalid target bucket size.
+    const EEXCEED_MAX_BUCKET_SIZE: u64 = 7;
+    /// Invalid bucket index.
+    const EINVALID_BUCKET_INDEX: u64 = 8;
+    /// Invalid vector index within a bucket.
+    const EINVALID_VECTOR_INDEX: u64 = 9;
+
+    /// SmartTable entry contains both the key and value.
+    struct Entry<K, V> has copy, drop, store {
+        hash: u64,
+        key: K,
+        value: V,
+    }
+
+    struct SmartTable<K, V> has store {
+        buckets: TableWithLength<u64, vector<Entry<K, V>>>,
+        num_buckets: u64,
+        // number of bits to represent num_buckets
+        level: u8,
+        // total number of items
+        size: u64,
+        // Split will be triggered when target load threshold in percentage is reached when adding a new entry.
+        split_load_threshold: u8,
+        // The target size of each bucket, which is NOT enforced so oversized buckets can exist.
+        target_bucket_size: u64,
+    }
+
+    /// Create an empty SmartTable with default configurations.
+    public fun new<K: copy + drop + store, V: store>(): SmartTable<K, V> {
+        new_with_config<K, V>(0, 0, 0)
+    }
+
+    /// Create an empty SmartTable with customized configurations.
+    /// `num_initial_buckets`: The number of buckets on initialization. 0 means using default value.
+    /// `split_load_threshold`: The percent number which once reached, split will be triggered. 0 means using default
+    /// value.
+    /// `target_bucket_size`: The target number of entries per bucket, though not guaranteed. 0 means not set and will
+    /// dynamically assgined by the contract code.
+    public fun new_with_config<K: copy + drop + store, V: store>(
+        num_initial_buckets: u64,
+        split_load_threshold: u8,
+        target_bucket_size: u64
+    ): SmartTable<K, V> {
+        assert!(split_load_threshold <= 100, error::invalid_argument(EINVALID_LOAD_THRESHOLD_PERCENT));
+        let buckets = table_with_length::new();
+        table_with_length::add(&mut buckets, 0, vector::empty());
+        let table = SmartTable {
+            buckets,
+            num_buckets: 1,
+            level: 0,
+            size: 0,
+            // The default split load threshold is 75%.
+            split_load_threshold: if (split_load_threshold == 0) { 75 } else { split_load_threshold },
+            target_bucket_size,
+        };
+        // The default number of initial buckets is 2.
+        if (num_initial_buckets == 0) {
+            num_initial_buckets = 2;
+        };
+        while (num_initial_buckets > 1) {
+            num_initial_buckets = num_initial_buckets - 1;
+            split_one_bucket(&mut table);
+        };
+        table
+    }
+
+    /// Destroy empty table.
+    /// Aborts if it's not empty.
+    public fun destroy_empty<K, V>(self: SmartTable<K, V>) {
+        assert!(self.size == 0, error::invalid_argument(ENOT_EMPTY));
+        let i = 0;
+        while (i < self.num_buckets) {
+            vector::destroy_empty(table_with_length::remove(&mut self.buckets, i));
+            i = i + 1;
+        };
+        let SmartTable { buckets, num_buckets: _, level: _, size: _, split_load_threshold: _, target_bucket_size: _ } = self;
+        table_with_length::destroy_empty(buckets);
+    }
+
+    /// Destroy a table completely when V has `drop`.
+    public fun destroy<K: drop, V: drop>(self: SmartTable<K, V>) {
+        clear(&mut self);
+        destroy_empty(self);
+    }
+
+    /// Clear a table completely when T has `drop`.
+    public fun clear<K: drop, V: drop>(self: &mut SmartTable<K, V>) {
+        *table_with_length::borrow_mut(&mut self.buckets, 0) = vector::empty();
+        let i = 1;
+        while (i < self.num_buckets) {
+            table_with_length::remove(&mut self.buckets, i);
+            i = i + 1;
+        };
+        self.num_buckets = 1;
+        self.level = 0;
+        self.size = 0;
+    }
+
+    /// Add (key, value) pair in the hash map, it may grow one bucket if current load factor exceeds the threshold.
+    /// Note it may not split the actual overflowed bucket. Instead, it was determined by `num_buckets` and `level`.
+    /// For standard linear hash algorithm, it is stored as a variable but `num_buckets` here could be leveraged.
+    /// Abort if `key` already exists.
+    /// Note: This method may occasionally cost much more gas when triggering bucket split.
+    public fun add<K, V>(self: &mut SmartTable<K, V>, key: K, value: V) {
+        let hash = sip_hash_from_value(&key);
+        let index = bucket_index(self.level, self.num_buckets, hash);
+        let bucket = table_with_length::borrow_mut(&mut self.buckets, index);
+        // We set a per-bucket limit here with a upper bound (10000) that nobody should normally reach.
+        assert!(vector::length(bucket) <= 10000, error::permission_denied(EEXCEED_MAX_BUCKET_SIZE));
+        assert!(vector::all(bucket, | entry | {
+            let e: &Entry<K, V> = entry;
+            &e.key != &key
+        }), error::invalid_argument(EALREADY_EXIST));
+        let e = Entry { hash, key, value };
+        if (self.target_bucket_size == 0) {
+            let estimated_entry_size = max(size_of_val(&e), 1);
+            self.target_bucket_size = max(1024 /* free_write_quota */ / estimated_entry_size, 1);
+        };
+        vector::push_back(bucket, e);
+        self.size = self.size + 1;
+
+        if (load_factor(self) >= (self.split_load_threshold as u64)) {
+            split_one_bucket(self);
+        }
+    }
+
+    /// Add multiple key/value pairs to the smart table. The keys must not already exist.
+    public fun add_all<K, V>(self: &mut SmartTable<K, V>, keys: vector<K>, values: vector<V>) {
+        vector::zip(keys, values, |key, value| { add(self, key, value); });
+    }
+
+    inline fun unzip_entries<K: copy, V: copy>(entries: &vector<Entry<K, V>>): (vector<K>, vector<V>) {
+        let keys = vector[];
+        let values = vector[];
+        vector::for_each_ref(entries, |e|{
+            let entry: &Entry<K, V> = e;
+            vector::push_back(&mut keys, entry.key);
+            vector::push_back(&mut values, entry.value);
+        });
+        (keys, values)
+    }
+
+    /// Convert a smart table to a simple_map, which is supposed to be called mostly by view functions to get an atomic
+    /// view of the whole table.
+    /// Disclaimer: This function may be costly as the smart table may be huge in size. Use it at your own discretion.
+    public fun to_simple_map<K: store + copy + drop, V: store + copy>(
+        self: &SmartTable<K, V>,
+    ): SimpleMap<K, V> {
+        let i = 0;
+        let res = simple_map::new<K, V>();
+        while (i < self.num_buckets) {
+            let (keys, values) = unzip_entries(table_with_length::borrow(&self.buckets, i));
+            simple_map::add_all(&mut res, keys, values);
+            i = i + 1;
+        };
+        res
+    }
+
+    /// Get all keys in a smart table.
+    ///
+    /// For a large enough smart table this function will fail due to execution gas limits, and
+    /// `keys_paginated` should be used instead.
+    public fun keys<K: store + copy + drop, V: store + copy>(
+        self: &SmartTable<K, V>
+    ): vector<K> {
+        let (keys, _, _) = keys_paginated(self, 0, 0, length(self));
+        keys
+    }
+
+    /// Get keys from a smart table, paginated.
+    ///
+    /// This function can be used to paginate all keys in a large smart table outside of runtime,
+    /// e.g. through chained view function calls. The maximum `num_keys_to_get` before hitting gas
+    /// limits depends on the data types in the smart table.
+    ///
+    /// When starting pagination, pass `starting_bucket_index` = `starting_vector_index` = 0.
+    ///
+    /// The function will then return a vector of keys, an optional bucket index, and an optional
+    /// vector index. The unpacked return indices can then be used as inputs to another pagination
+    /// call, which will return a vector of more keys. This process can be repeated until the
+    /// returned bucket index and vector index value options are both none, which means that
+    /// pagination is complete. For an example, see `test_keys()`.
+    public fun keys_paginated<K: store + copy + drop, V: store + copy>(
+        self: &SmartTable<K, V>,
+        starting_bucket_index: u64,
+        starting_vector_index: u64,
+        num_keys_to_get: u64,
+    ): (
+        vector<K>,
+        Option<u64>,
+        Option<u64>,
+    ) {
+        let num_buckets = self.num_buckets;
+        let buckets_ref = &self.buckets;
+        assert!(starting_bucket_index < num_buckets, EINVALID_BUCKET_INDEX);
+        let bucket_ref = table_with_length::borrow(buckets_ref, starting_bucket_index);
+        let bucket_length = vector::length(bucket_ref);
+        assert!(
+            // In the general case, starting vector index should never be equal to bucket length
+            // because then iteration will attempt to borrow a vector element that is out of bounds.
+            // However starting vector index can be equal to bucket length in the special case of
+            // starting iteration at the beginning of an empty bucket since buckets are never
+            // destroyed, only emptied.
+            starting_vector_index < bucket_length || starting_vector_index == 0,
+            EINVALID_VECTOR_INDEX
+        );
+        let keys = vector[];
+        if (num_keys_to_get == 0) return
+            (keys, option::some(starting_bucket_index), option::some(starting_vector_index));
+        for (bucket_index in starting_bucket_index..num_buckets) {
+            bucket_ref = table_with_length::borrow(buckets_ref, bucket_index);
+            bucket_length = vector::length(bucket_ref);
+            for (vector_index in starting_vector_index..bucket_length) {
+                vector::push_back(&mut keys, vector::borrow(bucket_ref, vector_index).key);
+                num_keys_to_get = num_keys_to_get - 1;
+                if (num_keys_to_get == 0) {
+                    vector_index = vector_index + 1;
+                    return if (vector_index == bucket_length) {
+                        bucket_index = bucket_index + 1;
+                        if (bucket_index < num_buckets) {
+                            (keys, option::some(bucket_index), option::some(0))
+                        } else {
+                            (keys, option::none(), option::none())
+                        }
+                    } else {
+                        (keys, option::some(bucket_index), option::some(vector_index))
+                    }
+                };
+            };
+            starting_vector_index = 0; // Start parsing the next bucket at vector index 0.
+        };
+        (keys, option::none(), option::none())
+    }
+
+    /// Decide which is the next bucket to split and split it into two with the elements inside the bucket.
+    fun split_one_bucket<K, V>(self: &mut SmartTable<K, V>) {
+        let new_bucket_index = self.num_buckets;
+        // the next bucket to split is num_bucket without the most significant bit.
+        let to_split = new_bucket_index ^ (1 << self.level);
+        self.num_buckets = new_bucket_index + 1;
+        // if the whole level is splitted once, bump the level.
+        if (to_split + 1 == 1 << self.level) {
+            self.level = self.level + 1;
+        };
+        let old_bucket = table_with_length::borrow_mut(&mut self.buckets, to_split);
+        // partition the bucket, [0..p) stays in old bucket, [p..len) goes to new bucket
+        let p = vector::partition(old_bucket, |e| {
+            let entry: &Entry<K, V> = e; // Explicit type to satisfy compiler
+            bucket_index(self.level, self.num_buckets, entry.hash) != new_bucket_index
+        });
+        let new_bucket = vector::trim_reverse(old_bucket, p);
+        table_with_length::add(&mut self.buckets, new_bucket_index, new_bucket);
+    }
+
+    /// Return the expected bucket index to find the hash.
+    /// Basically, it use different base `1 << level` vs `1 << (level + 1)` in modulo operation based on the target
+    /// bucket index compared to the index of the next bucket to split.
+    fun bucket_index(level: u8, num_buckets: u64, hash: u64): u64 {
+        let index = hash % (1 << (level + 1));
+        if (index < num_buckets) {
+            // in existing bucket
+            index
+        } else {
+            // in unsplitted bucket
+            index % (1 << level)
+        }
+    }
+
+    /// Acquire an immutable reference to the value which `key` maps to.
+    /// Aborts if there is no entry for `key`.
+    public fun borrow<K: drop, V>(self: &SmartTable<K, V>, key: K): &V {
+        let index = bucket_index(self.level, self.num_buckets, sip_hash_from_value(&key));
+        let bucket = table_with_length::borrow(&self.buckets, index);
+        let i = 0;
+        let len = vector::length(bucket);
+        while (i < len) {
+            let entry = vector::borrow(bucket, i);
+            if (&entry.key == &key) {
+                return &entry.value
+            };
+            i = i + 1;
+        };
+        abort error::invalid_argument(ENOT_FOUND)
+    }
+
+    /// Acquire an immutable reference to the value which `key` maps to.
+    /// Returns specified default value if there is no entry for `key`.
+    public fun borrow_with_default<K: copy + drop, V>(self: &SmartTable<K, V>, key: K, default: &V): &V {
+        if (!contains(self, copy key)) {
+            default
+        } else {
+            borrow(self, copy key)
+        }
+    }
+
+    /// Acquire a mutable reference to the value which `key` maps to.
+    /// Aborts if there is no entry for `key`.
+    public fun borrow_mut<K: drop, V>(self: &mut SmartTable<K, V>, key: K): &mut V {
+        let index = bucket_index(self.level, self.num_buckets, sip_hash_from_value(&key));
+        let bucket = table_with_length::borrow_mut(&mut self.buckets, index);
+        let i = 0;
+        let len = vector::length(bucket);
+        while (i < len) {
+            let entry = vector::borrow_mut(bucket, i);
+            if (&entry.key == &key) {
+                return &mut entry.value
+            };
+            i = i + 1;
+        };
+        abort error::invalid_argument(ENOT_FOUND)
+    }
+
+    /// Acquire a mutable reference to the value which `key` maps to.
+    /// Insert the pair (`key`, `default`) first if there is no entry for `key`.
+    public fun borrow_mut_with_default<K: copy + drop, V: drop>(
+        self: &mut SmartTable<K, V>,
+        key: K,
+        default: V
+    ): &mut V {
+        if (!contains(self, copy key)) {
+            add(self, copy key, default)
+        };
+        borrow_mut(self, key)
+    }
+
+    /// Returns true iff `table` contains an entry for `key`.
+    public fun contains<K: drop, V>(self: &SmartTable<K, V>, key: K): bool {
+        let hash = sip_hash_from_value(&key);
+        let index = bucket_index(self.level, self.num_buckets, hash);
+        let bucket = table_with_length::borrow(&self.buckets, index);
+        vector::any(bucket, | entry | {
+            let e: &Entry<K, V> = entry;
+            e.hash == hash && &e.key == &key
+        })
+    }
+
+    /// Remove from `table` and return the value which `key` maps to.
+    /// Aborts if there is no entry for `key`.
+    public fun remove<K: copy + drop, V>(self: &mut SmartTable<K, V>, key: K): V {
+        let index = bucket_index(self.level, self.num_buckets, sip_hash_from_value(&key));
+        let bucket = table_with_length::borrow_mut(&mut self.buckets, index);
+        let i = 0;
+        let len = vector::length(bucket);
+        while (i < len) {
+            let entry = vector::borrow(bucket, i);
+            if (&entry.key == &key) {
+                let Entry { hash: _, key: _, value } = vector::swap_remove(bucket, i);
+                self.size = self.size - 1;
+                return value
+            };
+            i = i + 1;
+        };
+        abort error::invalid_argument(ENOT_FOUND)
+    }
+
+    /// Insert the pair (`key`, `value`) if there is no entry for `key`.
+    /// update the value of the entry for `key` to `value` otherwise
+    public fun upsert<K: copy + drop, V: drop>(self: &mut SmartTable<K, V>, key: K, value: V) {
+        if (!contains(self, copy key)) {
+            add(self, copy key, value)
+        } else {
+            let ref = borrow_mut(self, key);
+            *ref = value;
+        };
+    }
+
+    /// Returns the length of the table, i.e. the number of entries.
+    public fun length<K, V>(self: &SmartTable<K, V>): u64 {
+        self.size
+    }
+
+    /// Return the load factor of the hashtable.
+    public fun load_factor<K, V>(self: &SmartTable<K, V>): u64 {
+        self.size * 100 / self.num_buckets / self.target_bucket_size
+    }
+
+    /// Update `split_load_threshold`.
+    public fun update_split_load_threshold<K, V>(self: &mut SmartTable<K, V>, split_load_threshold: u8) {
+        assert!(
+            split_load_threshold <= 100 && split_load_threshold > 0,
+            error::invalid_argument(EINVALID_LOAD_THRESHOLD_PERCENT)
+        );
+        self.split_load_threshold = split_load_threshold;
+    }
+
+    /// Update `target_bucket_size`.
+    public fun update_target_bucket_size<K, V>(self: &mut SmartTable<K, V>, target_bucket_size: u64) {
+        assert!(target_bucket_size > 0, error::invalid_argument(EINVALID_TARGET_BUCKET_SIZE));
+        self.target_bucket_size = target_bucket_size;
+    }
+
+    /// Apply the function to a reference of each key-value pair in the table.
+    public inline fun for_each_ref<K, V>(self: &SmartTable<K, V>, f: |&K, &V|) {
+        let i = 0;
+        while (i < aptos_std::smart_table::num_buckets(self)) {
+            vector::for_each_ref(
+                aptos_std::table_with_length::borrow(aptos_std::smart_table::borrow_buckets(self), i),
+                |elem| {
+                    let (key, value) = aptos_std::smart_table::borrow_kv(elem);
+                    f(key, value)
+                }
+            );
+            i = i + 1;
+        }
+    }
+
+    /// Apply the function to a mutable reference of each key-value pair in the table.
+    public inline fun for_each_mut<K, V>(self: &mut SmartTable<K, V>, f: |&K, &mut V|) {
+        let i = 0;
+        while (i < aptos_std::smart_table::num_buckets(self)) {
+            vector::for_each_mut(
+                table_with_length::borrow_mut(aptos_std::smart_table::borrow_buckets_mut(self), i),
+                |elem| {
+                    let (key, value) = aptos_std::smart_table::borrow_kv_mut(elem);
+                    f(key, value)
+                }
+            );
+            i = i + 1;
+        };
+    }
+
+    /// Map the function over the references of key-value pairs in the table without modifying it.
+    public inline fun map_ref<K: copy + drop + store, V1, V2: store>(
+        self: &SmartTable<K, V1>,
+        f: |&V1|V2
+    ): SmartTable<K, V2> {
+        let new_table = new<K, V2>();
+        for_each_ref(self, |key, value| add(&mut new_table, *key, f(value)));
+        new_table
+    }
+
+    /// Return true if any key-value pair in the table satisfies the predicate.
+    public inline fun any<K, V>(
+        self: &SmartTable<K, V>,
+        p: |&K, &V|bool
+    ): bool {
+        let found = false;
+        let i = 0;
+        while (i < aptos_std::smart_table::num_buckets(self)) {
+            found = vector::any(table_with_length::borrow(aptos_std::smart_table::borrow_buckets(self), i), |elem| {
+                let (key, value) = aptos_std::smart_table::borrow_kv(elem);
+                p(key, value)
+            });
+            if (found) break;
+            i = i + 1;
+        };
+        found
+    }
+
+    // Helper functions to circumvent the scope issue of inline functions.
+    public fun borrow_kv<K, V>(self: &Entry<K, V>): (&K, &V) {
+        (&self.key, &self.value)
+    }
+
+    public fun borrow_kv_mut<K, V>(self: &mut Entry<K, V>): (&mut K, &mut V) {
+        (&mut self.key, &mut self.value)
+    }
+
+    public fun num_buckets<K, V>(self: &SmartTable<K, V>): u64 {
+        self.num_buckets
+    }
+
+    public fun borrow_buckets<K, V>(self: &SmartTable<K, V>): &TableWithLength<u64, vector<Entry<K, V>>> {
+        &self.buckets
+    }
+
+    public fun borrow_buckets_mut<K, V>(self: &mut SmartTable<K, V>): &mut TableWithLength<u64, vector<Entry<K, V>>> {
+        &mut self.buckets
+    }
+
+
+    #[test]
+    fun smart_table_test() {
+        let table = new();
+        let i = 0;
+        while (i < 200) {
+            add(&mut table, i, i);
+            i = i + 1;
+        };
+        assert!(length(&table) == 200, 0);
+        i = 0;
+        while (i < 200) {
+            *borrow_mut(&mut table, i) = i * 2;
+            assert!(*borrow(&table, i) == i * 2, 0);
+            i = i + 1;
+        };
+        i = 0;
+        assert!(table.num_buckets > 5, table.num_buckets);
+        while (i < 200) {
+            assert!(contains(&table, i), 0);
+            assert!(remove(&mut table, i) == i * 2, 0);
+            i = i + 1;
+        };
+        destroy_empty(table);
+    }
+
+    #[test]
+    fun smart_table_split_test() {
+        let table: SmartTable<u64, u64> = new_with_config(1, 100, 1);
+        let i = 1;
+        let level = 0;
+        while (i <= 256) {
+            assert!(table.num_buckets == i, 0);
+            assert!(table.level == level, i);
+            add(&mut table, i, i);
+            i = i + 1;
+            if (i == 1 << (level + 1)) {
+                level = level + 1;
+            };
+        };
+        let i = 1;
+        while (i <= 256) {
+            assert!(*borrow(&table, i) == i, 0);
+            i = i + 1;
+        };
+        assert!(table.num_buckets == 257, table.num_buckets);
+        assert!(load_factor(&table) == 99, 0);
+        assert!(length(&table) == 256, 0);
+        destroy(table);
+    }
+
+    #[test]
+    fun smart_table_update_configs() {
+        let table = new();
+        let i = 0;
+        while (i < 200) {
+            add(&mut table, i, i);
+            i = i + 1;
+        };
+        assert!(length(&table) == 200, 0);
+        update_target_bucket_size(&mut table, 10);
+        update_split_load_threshold(&mut table, 50);
+        while (i < 400) {
+            add(&mut table, i, i);
+            i = i + 1;
+        };
+        assert!(length(&table) == 400, 0);
+        i = 0;
+        while (i < 400) {
+            assert!(contains(&table, i), 0);
+            assert!(remove(&mut table, i) == i, 0);
+            i = i + 1;
+        };
+        destroy_empty(table);
+    }
+
+    #[test]
+    public fun smart_table_add_all_test() {
+        let table: SmartTable<u64, u64> = new_with_config(1, 100, 2);
+        assert!(length(&table) == 0, 0);
+        add_all(&mut table, vector[1, 2, 3, 4, 5, 6, 7], vector[1, 2, 3, 4, 5, 6, 7]);
+        assert!(length(&table) == 7, 1);
+        let i = 1;
+        while (i < 8) {
+            assert!(*borrow(&table, i) == i, 0);
+            i = i + 1;
+        };
+        i = i - 1;
+        while (i > 0) {
+            remove(&mut table, i);
+            i = i - 1;
+        };
+        destroy_empty(table);
+    }
+
+    #[test]
+    public fun smart_table_to_simple_map_test() {
+        let table = new();
+        let i = 0;
+        while (i < 200) {
+            add(&mut table, i, i);
+            i = i + 1;
+        };
+        let map = to_simple_map(&table);
+        assert!(simple_map::length(&map) == 200, 0);
+        destroy(table);
+    }
+
+    #[test]
+    public fun smart_table_clear_test() {
+        let table = new();
+        let i = 0u64;
+        while (i < 200) {
+            add(&mut table, i, i);
+            i = i + 1;
+        };
+        clear(&mut table);
+        let i = 0;
+        while (i < 200) {
+            add(&mut table, i, i);
+            i = i + 1;
+        };
+        assert!(table.size == 200, 0);
+        destroy(table);
+    }
+
+    #[test]
+    fun test_keys() {
+        let i = 0;
+        let table = new();
+        let expected_keys = vector[];
+        let keys = keys(&table);
+        assert!(vector::is_empty(&keys), 0);
+        let starting_bucket_index = 0;
+        let starting_vector_index = 0;
+        let (keys, starting_bucket_index_r, starting_vector_index_r) = keys_paginated(
+            &table,
+            starting_bucket_index,
+            starting_vector_index,
+            0
+        );
+        assert!(starting_bucket_index_r == option::some(starting_bucket_index), 0);
+        assert!(starting_vector_index_r == option::some(starting_vector_index), 0);
+        assert!(vector::is_empty(&keys), 0);
+        while (i < 100) {
+            add(&mut table, i, 0);
+            vector::push_back(&mut expected_keys, i);
+            i = i + 1;
+        };
+        let keys = keys(&table);
+        assert!(vector::length(&keys) == vector::length(&expected_keys), 0);
+        vector::for_each_ref(&keys, |e_ref| {
+            assert!(vector::contains(&expected_keys, e_ref), 0);
+        });
+        let keys = vector[];
+        let starting_bucket_index = 0;
+        let starting_vector_index = 0;
+        let returned_keys = vector[];
+        vector::length(&returned_keys); // To eliminate erroneous compiler "unused" warning
+        loop {
+            (returned_keys, starting_bucket_index_r, starting_vector_index_r) = keys_paginated(
+                &table,
+                starting_bucket_index,
+                starting_vector_index,
+                15
+            );
+            vector::append(&mut keys, returned_keys);
+            if (
+                starting_bucket_index_r == option::none() ||
+                starting_vector_index_r == option::none()
+            ) break;
+            starting_bucket_index = option::destroy_some(starting_bucket_index_r);
+            starting_vector_index = option::destroy_some(starting_vector_index_r);
+        };
+        assert!(vector::length(&keys) == vector::length(&expected_keys), 0);
+        vector::for_each_ref(&keys, |e_ref| {
+            assert!(vector::contains(&expected_keys, e_ref), 0);
+        });
+        destroy(table);
+        table = new();
+        add(&mut table, 1, 0);
+        add(&mut table, 2, 0);
+        (keys, starting_bucket_index_r, starting_vector_index_r) = keys_paginated(&table, 0, 0, 1);
+        (returned_keys, starting_bucket_index_r, starting_vector_index_r) = keys_paginated(
+            &table,
+            option::destroy_some(starting_bucket_index_r),
+            option::destroy_some(starting_vector_index_r),
+            1,
+        );
+        vector::append(&mut keys, returned_keys);
+        assert!(keys == vector[1, 2] || keys == vector[2, 1], 0);
+        assert!(starting_bucket_index_r == option::none(), 0);
+        assert!(starting_vector_index_r == option::none(), 0);
+        (keys, starting_bucket_index_r, starting_vector_index_r) = keys_paginated(&table, 0, 0, 0);
+        assert!(keys == vector[], 0);
+        assert!(starting_bucket_index_r == option::some(0), 0);
+        assert!(starting_vector_index_r == option::some(0), 0);
+        destroy(table);
+    }
+
+    #[test]
+    fun test_keys_corner_cases() {
+        let table = new();
+        let expected_keys = vector[];
+        for (i in 0..100) {
+            add(&mut table, i, 0);
+            vector::push_back(&mut expected_keys, i);
+        };
+        let (keys, starting_bucket_index_r, starting_vector_index_r) =
+            keys_paginated(&table, 0, 0, 5); // Both indices 0.
+        assert!(vector::length(&keys) == 5, 0);
+        vector::for_each_ref(&keys, |e_ref| {
+            assert!(vector::contains(&expected_keys, e_ref), 0);
+        });
+        let starting_bucket_index = option::destroy_some(starting_bucket_index_r);
+        let starting_vector_index = option::destroy_some(starting_vector_index_r);
+        (keys, starting_bucket_index_r, starting_vector_index_r) = keys_paginated(
+            &table,
+            starting_bucket_index,
+            starting_vector_index,
+            0, // Number of keys 0.
+        );
+        assert!(keys == vector[], 0);
+        assert!(starting_bucket_index_r == option::some(starting_bucket_index), 0);
+        assert!(starting_vector_index_r == option::some(starting_vector_index), 0);
+        (keys, starting_bucket_index_r, starting_vector_index_r) = keys_paginated(
+            &table,
+            starting_bucket_index,
+            0, // Vector index 0.
+            50,
+        );
+        assert!(vector::length(&keys) == 50, 0);
+        vector::for_each_ref(&keys, |e_ref| {
+            assert!(vector::contains(&expected_keys, e_ref), 0);
+        });
+        let starting_bucket_index = option::destroy_some(starting_bucket_index_r);
+        assert!(starting_bucket_index > 0, 0);
+        assert!(option::is_some(&starting_vector_index_r), 0);
+        (keys, starting_bucket_index_r, starting_vector_index_r) = keys_paginated(
+            &table,
+            0, // Bucket index 0.
+            1,
+            50,
+        );
+        assert!(vector::length(&keys) == 50, 0);
+        vector::for_each_ref(&keys, |e_ref| {
+            assert!(vector::contains(&expected_keys, e_ref), 0);
+        });
+        assert!(option::is_some(&starting_bucket_index_r), 0);
+        assert!(option::is_some(&starting_vector_index_r), 0);
+        destroy(table);
+    }
+
+    #[test, expected_failure(abort_code = EINVALID_BUCKET_INDEX)]
+    fun test_keys_invalid_bucket_index() {
+        let table = new();
+        add(&mut table, 1, 0);
+        let num_buckets = table.num_buckets;
+        keys_paginated(&table, num_buckets + 1, 0, 1);
+        destroy(table);
+    }
+
+    #[test, expected_failure(abort_code = EINVALID_VECTOR_INDEX)]
+    fun test_keys_invalid_vector_index() {
+        let table = new();
+        add(&mut table, 1, 0);
+        keys_paginated(&table, 0, 1, 1);
+        destroy(table);
+    }
+}