Skip to content
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

Jump to bottom

refactor(move): 2024 syntax update #47

Merged
merged 3 commits into from
Jun 4, 2024
Merged

refactor(move): 2024 syntax update #47

merged 3 commits into from
Jun 4, 2024

Conversation

re1ro
Copy link
Contributor

@re1ro re1ro commented Jun 4, 2024 •
edited by jira bot
Loading

AXE-4126

  • Method syntax: sui::coin::withdraw(&mut c, 10) -> c.withdraw(10)
  • Index syntax: x.borrow(i) -> &x[i]

@re1ro re1ro self-assigned this Jun 4, 2024
@re1ro re1ro requested a review from a team as a code owner June 4, 2024 02:14
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jun 4, 2024 •
edited
Loading

Code Coverage Summary

Click to see the summary 
Coverage report for module ./move/abi/

+-------------------------+
| Move Coverage Summary   |
+-------------------------+
Module 0000000000000000000000000000000000000000000000000000000000000103::abi
>>> % Module coverage: 96.38
+-------------------------+
| % Move Coverage: 96.38  |
+-------------------------+

Coverage report for module ./move/axelar_gateway/

+-------------------------+
| Move Coverage Summary   |
+-------------------------+
Module 0000000000000000000000000000000000000000000000000000000000000100::weighted_signer
>>> % Module coverage: 10.64
Module 0000000000000000000000000000000000000000000000000000000000000100::bytes32
>>> % Module coverage: 33.33
Module 0000000000000000000000000000000000000000000000000000000000000100::weighted_signers
>>> % Module coverage: 0.00
Module 0000000000000000000000000000000000000000000000000000000000000100::proof
>>> % Module coverage: 0.00
Module 0000000000000000000000000000000000000000000000000000000000000100::auth
>>> % Module coverage: 0.00
Module 0000000000000000000000000000000000000000000000000000000000000100::channel
>>> % Module coverage: 100.00
Module 0000000000000000000000000000000000000000000000000000000000000100::discovery
>>> % Module coverage: 57.52
Module 0000000000000000000000000000000000000000000000000000000000000100::message
>>> % Module coverage: 0.00
Module 0000000000000000000000000000000000000000000000000000000000000100::gateway
>>> % Module coverage: 0.00
+-------------------------+
| % Move Coverage: 13.66  |
+-------------------------+

Coverage report for module ./move/gas_service/

+-------------------------+
| Move Coverage Summary   |
+-------------------------+
Module 0000000000000000000000000000000000000000000000000000000000000105::gas_service
>>> % Module coverage: 100.00
+-------------------------+
| % Move Coverage: 100.00  |
+-------------------------+


 NO tests found for module ./move/governance/. Skipped.


 NO tests found for module ./move/interchain_token/. Skipped.

Coverage report for module ./move/its/

+-------------------------+
| Move Coverage Summary   |
+-------------------------+
Module 0000000000000000000000000000000000000000000000000000000000000102::address_tracker
>>> % Module coverage: 96.77
Module 0000000000000000000000000000000000000000000000000000000000000102::coin_info
>>> % Module coverage: 19.35
Module 0000000000000000000000000000000000000000000000000000000000000102::coin_management
>>> % Module coverage: 73.68
Module 0000000000000000000000000000000000000000000000000000000000000102::token_id
>>> % Module coverage: 21.51
Module 0000000000000000000000000000000000000000000000000000000000000102::its
>>> % Module coverage: 25.46
Module 0000000000000000000000000000000000000000000000000000000000000102::discovery
>>> % Module coverage: 84.32
Module 0000000000000000000000000000000000000000000000000000000000000102::utils
>>> % Module coverage: 92.90
Module 0000000000000000000000000000000000000000000000000000000000000102::service
>>> % Module coverage: 0.00
+-------------------------+
| % Move Coverage: 40.23  |
+-------------------------+


 NO tests found for module ./move/squid/. Skipped.


 NO tests found for module ./move/test/. Skipped.
Click to see the extended report 
Coverage report for module ./move/abi/

+-------------------------+
| Move Coverage Summary   |
+-------------------------+
Module 0000000000000000000000000000000000000000000000000000000000000103::abi
	fun append_bytes
		total: 38
		covered: 35
		% coverage: 92.11
	fun append_u256
		total: 29
		covered: 29
		% coverage: 100.00
	fun decode_bytes
		total: 35
		covered: 35
		% coverage: 100.00
	fun into_bytes
		total: 4
		covered: 4
		% coverage: 100.00
	fun into_remaining_bytes
		total: 5
		covered: 0
		% coverage: 0.00
	fun new_reader
		total: 5
		covered: 5
		% coverage: 100.00
	fun new_writer
		total: 23
		covered: 23
		% coverage: 100.00
	fun read_bytes
		total: 27
		covered: 27
		% coverage: 100.00
	fun read_u256
		total: 39
		covered: 39
		% coverage: 100.00
	fun read_u8
		total: 4
		covered: 0
		% coverage: 0.00
	fun read_vector_bytes
		total: 58
		covered: 58
		% coverage: 100.00
	fun read_vector_u256
		total: 46
		covered: 46
		% coverage: 100.00
	fun skip_slot
		total: 9
		covered: 9
		% coverage: 100.00
	fun write_bytes
		total: 19
		covered: 19
		% coverage: 100.00
	fun write_u256
		total: 44
		covered: 44
		% coverage: 100.00
	fun write_u8
		total: 5
		covered: 0
		% coverage: 0.00
	fun write_vector_bytes
		total: 44
		covered: 44
		% coverage: 100.00
	fun write_vector_u256
		total: 36
		covered: 36
		% coverage: 100.00
>>> % Module coverage: 96.38
+-------------------------+
| % Move Coverage: 96.38  |
+-------------------------+

Coverage report for module ./move/axelar_gateway/

+-------------------------+
| Move Coverage Summary   |
+-------------------------+
Module 0000000000000000000000000000000000000000000000000000000000000100::weighted_signer
	fun default
		total: 10
		covered: 10
		% coverage: 100.00
	fun lt
		total: 54
		covered: 0
		% coverage: 0.00
	fun new
		total: 12
		covered: 0
		% coverage: 0.00
	fun peel
		total: 10
		covered: 0
		% coverage: 0.00
	fun pubkey
		total: 4
		covered: 0
		% coverage: 0.00
	fun weight
		total: 4
		covered: 0
		% coverage: 0.00
>>> % Module coverage: 10.64
Module 0000000000000000000000000000000000000000000000000000000000000100::bytes32
	fun default
		total: 3
		covered: 0
		% coverage: 0.00
	fun from_address
		total: 3
		covered: 0
		% coverage: 0.00
	fun from_bytes
		total: 4
		covered: 0
		% coverage: 0.00
	fun length
		total: 2
		covered: 0
		% coverage: 0.00
	fun new
		total: 3
		covered: 3
		% coverage: 100.00
	fun peel
		total: 4
		covered: 0
		% coverage: 0.00
	fun to_bytes
		total: 5
		covered: 5
		% coverage: 100.00
>>> % Module coverage: 33.33
Module 0000000000000000000000000000000000000000000000000000000000000100::weighted_signers
	fun hash
		total: 7
		covered: 0
		% coverage: 0.00
	fun nonce
		total: 4
		covered: 0
		% coverage: 0.00
	fun peel
		total: 38
		covered: 0
		% coverage: 0.00
	fun signers
		total: 4
		covered: 0
		% coverage: 0.00
	fun threshold
		total: 4
		covered: 0
		% coverage: 0.00
>>> % Module coverage: 0.00
Module 0000000000000000000000000000000000000000000000000000000000000100::proof
	fun new_signature
		total: 32
		covered: 0
		% coverage: 0.00
	fun peel
		total: 28
		covered: 0
		% coverage: 0.00
	fun peel_signature
		total: 4
		covered: 0
		% coverage: 0.00
	fun recover_pubkey
		total: 6
		covered: 0
		% coverage: 0.00
	fun signatures
		total: 3
		covered: 0
		% coverage: 0.00
	fun signers
		total: 3
		covered: 0
		% coverage: 0.00
>>> % Module coverage: 0.00
Module 0000000000000000000000000000000000000000000000000000000000000100::auth
	fun new
		total: 8
		covered: 0
		% coverage: 0.00
	fun rotate_signers
		total: 30
		covered: 0
		% coverage: 0.00
	fun setup
		total: 15
		covered: 0
		% coverage: 0.00
	fun update_rotation_timestamp
		total: 31
		covered: 0
		% coverage: 0.00
	fun validate_proof
		total: 57
		covered: 0
		% coverage: 0.00
	fun validate_signatures
		total: 111
		covered: 0
		% coverage: 0.00
	fun validate_signers
		total: 74
		covered: 0
		% coverage: 0.00
>>> % Module coverage: 0.00
Module 0000000000000000000000000000000000000000000000000000000000000100::channel
	fun consume_approved_message
		total: 20
		covered: 20
		% coverage: 100.00
	fun create_approved_message
		total: 7
		covered: 7
		% coverage: 100.00
	fun destroy
		total: 10
		covered: 10
		% coverage: 100.00
	fun id
		total: 3
		covered: 3
		% coverage: 100.00
	fun new
		total: 10
		covered: 10
		% coverage: 100.00
	fun to_address
		total: 3
		covered: 3
		% coverage: 100.00
>>> % Module coverage: 100.00
Module 0000000000000000000000000000000000000000000000000000000000000100::discovery
	fun get_transaction
		total: 16
		covered: 12
		% coverage: 75.00
	fun init
		total: 7
		covered: 0
		% coverage: 0.00
	fun new_function
		total: 5
		covered: 5
		% coverage: 100.00
	fun new_function_from_bcs
		total: 10
		covered: 10
		% coverage: 100.00
	fun new_move_call
		total: 5
		covered: 5
		% coverage: 100.00
	fun new_move_call_from_bcs
		total: 46
		covered: 42
		% coverage: 91.30
	fun new_transaction
		total: 4
		covered: 0
		% coverage: 0.00
	fun new_transaction_from_bcs
		total: 30
		covered: 0
		% coverage: 0.00
	fun package_id
		total: 11
		covered: 0
		% coverage: 0.00
	fun register_transaction
		total: 19
		covered: 14
		% coverage: 73.68
>>> % Module coverage: 57.52
Module 0000000000000000000000000000000000000000000000000000000000000100::message
	fun command_id
		total: 8
		covered: 0
		% coverage: 0.00
	fun hash
		total: 7
		covered: 0
		% coverage: 0.00
	fun message_to_command_id
		total: 14
		covered: 0
		% coverage: 0.00
	fun new
		total: 7
		covered: 0
		% coverage: 0.00
	fun peel
		total: 36
		covered: 0
		% coverage: 0.00
>>> % Module coverage: 0.00
Module 0000000000000000000000000000000000000000000000000000000000000100::gateway
	fun approve_message
		total: 25
		covered: 0
		% coverage: 0.00
	fun approve_messages
		total: 36
		covered: 0
		% coverage: 0.00
	fun call_contract
		total: 11
		covered: 0
		% coverage: 0.00
	fun data_hash
		total: 10
		covered: 0
		% coverage: 0.00
	fun init
		total: 8
		covered: 0
		% coverage: 0.00
	fun is_message_approved
		total: 20
		covered: 0
		% coverage: 0.00
	fun is_message_executed
		total: 14
		covered: 0
		% coverage: 0.00
	fun peel_messages
		total: 43
		covered: 0
		% coverage: 0.00
	fun peel_proof
		total: 19
		covered: 0
		% coverage: 0.00
	fun peel_weighted_signers
		total: 19
		covered: 0
		% coverage: 0.00
	fun rotate_signers
		total: 40
		covered: 0
		% coverage: 0.00
	fun setup
		total: 18
		covered: 0
		% coverage: 0.00
	fun take_approved_message
		total: 46
		covered: 0
		% coverage: 0.00
>>> % Module coverage: 0.00
+-------------------------+
| % Move Coverage: 13.66  |
+-------------------------+

Coverage report for module ./move/gas_service/

+-------------------------+
| Move Coverage Summary   |
+-------------------------+
Module 0000000000000000000000000000000000000000000000000000000000000105::gas_service
	fun add_gas
		total: 14
		covered: 14
		% coverage: 100.00
	fun collect_gas
		total: 12
		covered: 12
		% coverage: 100.00
	fun init
		total: 13
		covered: 13
		% coverage: 100.00
	fun pay_gas
		total: 21
		covered: 21
		% coverage: 100.00
	fun refund
		total: 13
		covered: 13
		% coverage: 100.00
>>> % Module coverage: 100.00
+-------------------------+
| % Move Coverage: 100.00  |
+-------------------------+


 NO tests found for module ./move/governance/. Skipped.


 NO tests found for module ./move/interchain_token/. Skipped.

Coverage report for module ./move/its/

+-------------------------+
| Move Coverage Summary   |
+-------------------------+
Module 0000000000000000000000000000000000000000000000000000000000000102::address_tracker
	fun get_trusted_address
		total: 15
		covered: 15
		% coverage: 100.00
	fun is_trusted_address
		total: 6
		covered: 6
		% coverage: 100.00
	fun new
		total: 4
		covered: 4
		% coverage: 100.00
	fun set_trusted_address
		total: 37
		covered: 35
		% coverage: 94.59
>>> % Module coverage: 96.77
Module 0000000000000000000000000000000000000000000000000000000000000102::coin_info
	fun decimals
		total: 4
		covered: 0
		% coverage: 0.00
	fun from_info
		total: 6
		covered: 6
		% coverage: 100.00
	fun from_metadata
		total: 10
		covered: 0
		% coverage: 0.00
	fun metadata
		total: 3
		covered: 0
		% coverage: 0.00
	fun name
		total: 4
		covered: 0
		% coverage: 0.00
	fun symbol
		total: 4
		covered: 0
		% coverage: 0.00
>>> % Module coverage: 19.35
Module 0000000000000000000000000000000000000000000000000000000000000102::coin_management
	fun add_distributor
		total: 14
		covered: 0
		% coverage: 0.00
	fun give_coin
		total: 21
		covered: 21
		% coverage: 100.00
	fun has_capability
		total: 4
		covered: 4
		% coverage: 100.00
	fun is_distributor
		total: 6
		covered: 0
		% coverage: 0.00
	fun new_locked
		total: 6
		covered: 6
		% coverage: 100.00
	fun new_with_cap
		total: 6
		covered: 6
		% coverage: 100.00
	fun take_coin
		total: 19
		covered: 19
		% coverage: 100.00
>>> % Module coverage: 73.68
Module 0000000000000000000000000000000000000000000000000000000000000102::token_id
	fun from_address
		total: 3
		covered: 3
		% coverage: 100.00
	fun from_coin_data
		total: 31
		covered: 0
		% coverage: 0.00
	fun from_info
		total: 37
		covered: 0
		% coverage: 0.00
	fun from_u256
		total: 4
		covered: 4
		% coverage: 100.00
	fun to_u256
		total: 5
		covered: 0
		% coverage: 0.00
	fun unregistered_token_id
		total: 13
		covered: 13
		% coverage: 100.00
>>> % Module coverage: 21.51
Module 0000000000000000000000000000000000000000000000000000000000000102::its
	fun add_registered_coin
		total: 14
		covered: 0
		% coverage: 0.00
	fun add_registered_coin_type
		total: 6
		covered: 6
		% coverage: 100.00
	fun add_unregistered_coin
		total: 14
		covered: 0
		% coverage: 0.00
	fun add_unregistered_coin_type
		total: 6
		covered: 6
		% coverage: 100.00
	fun channel
		total: 3
		covered: 3
		% coverage: 100.00
	fun channel_id
		total: 4
		covered: 4
		% coverage: 100.00
	fun channel_mut
		total: 3
		covered: 0
		% coverage: 0.00
	fun coin_data_mut
		total: 5
		covered: 0
		% coverage: 0.00
	fun coin_management_mut
		total: 5
		covered: 0
		% coverage: 0.00
	fun get_coin_data
		total: 15
		covered: 0
		% coverage: 0.00
	fun get_coin_info
		total: 5
		covered: 0
		% coverage: 0.00
	fun get_registered_coin_type
		total: 15
		covered: 11
		% coverage: 73.33
	fun get_trusted_address
		total: 6
		covered: 0
		% coverage: 0.00
	fun get_unregistered_coin_type
		total: 19
		covered: 15
		% coverage: 78.95
	fun init
		total: 35
		covered: 0
		% coverage: 0.00
	fun is_trusted_address
		total: 6
		covered: 0
		% coverage: 0.00
	fun relayer_discovery_id
		total: 4
		covered: 4
		% coverage: 100.00
	fun remove_registered_coin_type
		total: 5
		covered: 0
		% coverage: 0.00
	fun remove_unregistered_coin
		total: 14
		covered: 0
		% coverage: 0.00
	fun remove_unregistered_coin_type
		total: 5
		covered: 0
		% coverage: 0.00
	fun set_relayer_discovery_id
		total: 6
		covered: 6
		% coverage: 100.00
	fun set_trusted_address
		total: 6
		covered: 0
		% coverage: 0.00
	fun token_decimals
		total: 5
		covered: 0
		% coverage: 0.00
	fun token_name
		total: 5
		covered: 0
		% coverage: 0.00
	fun token_symbol
		total: 5
		covered: 0
		% coverage: 0.00
>>> % Module coverage: 25.46
Module 0000000000000000000000000000000000000000000000000000000000000102::discovery
	fun get_call_info
		total: 30
		covered: 26
		% coverage: 86.67
	fun get_deploy_interchain_token_tx
		total: 48
		covered: 48
		% coverage: 100.00
	fun get_interchain_transfer_info
		total: 33
		covered: 0
		% coverage: 0.00
	fun get_interchain_transfer_tx
		total: 85
		covered: 85
		% coverage: 100.00
	fun register_transaction
		total: 40
		covered: 40
		% coverage: 100.00
>>> % Module coverage: 84.32
Module 0000000000000000000000000000000000000000000000000000000000000102::utils
	fun decode_metadata
		total: 41
		covered: 41
		% coverage: 100.00
	fun get_module_from_symbol
		total: 84
		covered: 84
		% coverage: 100.00
	fun hash_coin_info
		total: 13
		covered: 0
		% coverage: 0.00
	fun is_lowercase
		total: 15
		covered: 15
		% coverage: 100.00
	fun is_number
		total: 15
		covered: 15
		% coverage: 100.00
	fun is_uppercase
		total: 15
		covered: 15
		% coverage: 100.00
>>> % Module coverage: 92.90
Module 0000000000000000000000000000000000000000000000000000000000000102::service
	fun burn_as_distributor
		total: 21
		covered: 0
		% coverage: 0.00
	fun decode_approved_message
		total: 21
		covered: 0
		% coverage: 0.00
	fun deploy_remote_interchain_token
		total: 43
		covered: 0
		% coverage: 0.00
	fun give_unregistered_coin
		total: 61
		covered: 0
		% coverage: 0.00
	fun interchain_transfer
		total: 40
		covered: 0
		% coverage: 0.00
	fun mint_as_distributor
		total: 26
		covered: 0
		% coverage: 0.00
	fun receive_deploy_interchain_token
		total: 64
		covered: 0
		% coverage: 0.00
	fun receive_interchain_transfer
		total: 56
		covered: 0
		% coverage: 0.00
	fun receive_interchain_transfer_with_data
		total: 75
		covered: 0
		% coverage: 0.00
	fun register_coin
		total: 13
		covered: 0
		% coverage: 0.00
	fun send_payload
		total: 13
		covered: 0
		% coverage: 0.00
	fun set_trusted_addresses
		total: 77
		covered: 0
		% coverage: 0.00
>>> % Module coverage: 0.00
+-------------------------+
| % Move Coverage: 40.23  |
+-------------------------+


 NO tests found for module ./move/squid/. Skipped.


 NO tests found for module ./move/test/. Skipped.

@milapsheth milapsheth changed the title refactor(SUI): 2024 syntax update refactor(move): 2024 syntax update Jun 4, 2024
milapsheth
milapsheth reviewed Jun 4, 2024
View reviewed changes
move/abi/sources/abi.move
@@ -149,7 +149,7 @@ module abi::abi {
while (i < 32) {
let exp = ((31 - i) * 8 as u8);
let byte = (var >> exp & 255 as u8);
*self.bytes.borrow_mut(i + pos) = byte;
*&mut self.bytes[i + pos] = byte;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lol

move/its/sources/discovery.move
@@ -42,7 +42,7 @@ module its::discovery {
public fun register_transaction(self: &mut ITS, discovery: &mut RelayerDiscovery) {
self.set_relayer_discovery_id(discovery);
let mut arg = vector[0];
vector::append(&mut arg, bcs::to_bytes(&object::id(self)));
arg.append(bcs::to_bytes(&object::id(self)));
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
arg.append(bcs::to_bytes(&object::id(self)));
arg.append(object::id(self).to_bytes());

move/its/sources/discovery.move
@@ -88,7 +88,7 @@ module its::discovery {

if (data.is_empty()) {
let mut arg = vector[0];
vector::append(&mut arg, address::to_bytes(object::id_address(self)));
arg.append(address::to_bytes(object::id_address(self)));
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
arg.append(address::to_bytes(object::id_address(self)));
arg.append(object::id_address(self).to_bytes());

move/its/sources/discovery.move
@@ -137,7 +137,7 @@ module its::discovery {

fun get_deploy_interchain_token_tx(self: &ITS, reader: &mut AbiReader): Transaction {
let mut arg = vector[0];
vector::append(&mut arg, address::to_bytes(object::id_address(self)));
arg.append(address::to_bytes(object::id_address(self)));
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same everywhere

move/its/sources/its.move
@@ -138,7 +138,7 @@ module its::its {
}

public(package) fun coin_data_mut<T>(self: &mut ITS, token_id: TokenId): &mut CoinData<T> {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

some of these mut functions aren't needed anymore since you can borrow_mut directly. For e.g. this helper is only used in the above method, and you can use the &mut ... there directly

move/its/sources/its.move
@@ -138,7 +138,7 @@ module its::its {
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Look into #[syntax(index)]. See example for a table here
https://github.com/MystenLabs/sui/blob/main/crates/sui-framework/packages/sui-framework/sources/table.move#L56

MystenLabs/sui#14062

move/its/sources/token_id.move
@@ -90,7 +90,7 @@ module its::token_id {
let coin_info = coin_info::from_info<String>(name, symbol, decimals);
let mut vec = address::to_bytes(address::from_u256(PREFIX_SUI_TOKEN_ID));
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same

move/test/sources/test/test.move
@@ -35,7 +35,7 @@ module test::test {
let mut arg = vector::singleton<u8>(2);
arguments.push_back(arg);
arg = vector::singleton<u8>(0);
vector::append(&mut arg, address::to_bytes(object::id_address(singleton)));
arg.append(address::to_bytes(object::id_address(singleton)));
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same

@milapsheth milapsheth merged commit c5cc91d into main Jun 4, 2024
4 checks passed
@milapsheth milapsheth deleted the refactor/2024-syntax branch June 4, 2024 06:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@milapsheth milapsheth milapsheth approved these changes

Assignees

@re1ro re1ro

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@re1ro @milapsheth